-
Notifications
You must be signed in to change notification settings - Fork 0
/
set.go
239 lines (202 loc) · 4.85 KB
/
set.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
package hashset
import (
"github.com/golanglibs/gocollections/generic"
"github.com/golanglibs/gocollections/set"
)
var placeholder interface{} = nil
/*
A hash set that uses native go map under the hood. It implements Seter and Collectioner.
Set is not thread safe
*/
type Set[K comparable] struct {
container map[K]interface{}
}
/*
Creates an instance of Set with given elements and returns pointer to the instance.
If no elements are given, an empty set is created.
Elements must be comparable
*/
func New[K comparable](elements ...K) Set[K] {
size := len(elements)
container := make(map[K]interface{}, size)
if size > 0 {
for _, element := range elements {
container[element] = placeholder
}
}
return Set[K]{
container: container,
}
}
/*
Creates an instance of Set with given collection and returns pointer to the instance.
Elements must be comparable
*/
func NewFromCollection[K comparable](c generic.Collectioner[K]) Set[K] {
size := c.Size()
container := make(map[K]interface{}, size)
if size > 0 {
c.ForEach(func(element *K) {
container[*element] = placeholder
})
}
return Set[K]{
container: container,
}
}
/*
Gets the length of the Set.
Implements Seter.Size and Collectioner.Size
*/
func (s *Set[K]) Size() int {
return len(s.container)
}
/*
Returns true if the Set is empty.
Implements Seter.Empty and Collectioner.Empty
*/
func (s *Set[K]) Empty() bool {
return len(s.container) == 0
}
/*
Adds the given element to the Set.
If the element does not exist in the Set, Add will add the given element and return true.
If the element already exists in the Set, Add will not add the given element and return false.
Implements Seter.Add and Collectioner.Add
*/
func (s *Set[K]) Add(element K) bool {
if _, hasElement := s.container[element]; hasElement {
return false
}
s.container[element] = placeholder
return true
}
/*
Removes the given element from the Set.
If the given element is found, Remove will delete the element from the Set and return true.
If the given element to remove is not found in the Set, then Remove will return false.
Implements Seter.Remove and Collectioner.Remove
*/
func (s *Set[K]) Remove(element K) bool {
if _, hasElement := s.container[element]; !hasElement {
return false
}
delete(s.container, element)
return true
}
/*
Returns true when the given element exists in the Set.
Implements Seter.Contains and Collectioner.Contains
*/
func (s *Set[K]) Contains(element K) bool {
if _, hasElement := s.container[element]; hasElement {
return true
}
return false
}
/*
Returns true when the given Set has the equal members as the current Set
Implements Seter.Equals
*/
func (s *Set[K]) Equals(set set.Seter[K]) bool {
if s.Size() != set.Size() {
return false
}
for k := range s.container {
if !set.Contains(k) {
return false
}
}
return true
}
/*
Returns true when the given Set has common members with the current Set.
Implements Seter.Intersects
*/
func (s *Set[K]) Intersects(set set.Seter[K]) bool {
for k := range s.container {
if set.Contains(k) {
return true
}
}
return false
}
/*
Returns a new instance of Set with the common members between the current Set and the given Set.
Implements Seter.GetIntersection
*/
func (s *Set[K]) GetIntersection(set set.Seter[K]) set.Seter[K] {
intersection := &Set[K]{
container: make(map[K]interface{}),
}
for k := range s.container {
if set.Contains(k) {
intersection.Add(k)
}
}
return intersection
}
/*
Returns a new instance of Set with all the members of both the current Set and the given Set.
Implements Seter.GetUnion
*/
func (s *Set[K]) GetUnion(set set.Seter[K]) set.Seter[K] {
union := &Set[K]{
container: make(map[K]interface{}),
}
for k := range s.container {
union.Add(k)
}
set.ForEach(func(member *K) {
union.Add(*member)
})
return union
}
/*
Returns true if the current Set contains all the members of the given Set.
Implements Seter.IsSupersetOf
*/
func (s *Set[K]) IsSupersetOf(set set.Seter[K]) bool {
if s.Size() < set.Size() {
return false
}
isSuperset := true
set.ForEach(func(member *K) {
if !s.Contains(*member) {
isSuperset = false
}
})
return isSuperset
}
/*
Returns true if the given Set has all the members of the current Set.
Implements Seter.IsSubsetOf
*/
func (s *Set[K]) IsSubsetOf(set set.Seter[K]) bool {
if s.Size() > set.Size() {
return false
}
for k := range s.container {
if !set.Contains(k) {
return false
}
}
return true
}
/*
Clears the current Set so it becomes empty. Under the hood, a new instance of builtin map is assigned as the
new internal container
Implements Seter.Clear
*/
func (s *Set[K]) Clear() {
s.container = make(map[K]interface{})
}
/*
Iterates through each element in the Set and executes the given "do" function on each element.
Implements Seter.ForEach and Collectioner.ForEach
*/
func (s *Set[K]) ForEach(do func(*K)) {
for k := range s.container {
do(&k)
}
}