aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/gopkg.in/fatih/set.v0/set_ts.go
blob: 50f532565befb06d9af6020ed8759385916e4a7e (plain) (blame)
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
package set

import (
    "sync"
)

// Set defines a thread safe set data structure.
type Set struct {
    set
    l sync.RWMutex // we name it because we don't want to expose it
}

// New creates and initialize a new Set. It's accept a variable number of
// arguments to populate the initial set. If nothing passed a Set with zero
// size is created.
func New(items ...interface{}) *Set {
    s := &Set{}
    s.m = make(map[interface{}]struct{})

    // Ensure interface compliance
    var _ Interface = s

    s.Add(items...)
    return s
}

// New creates and initalizes a new Set interface. It accepts a variable
// number of arguments to populate the initial set. If nothing is passed a
// zero size Set based on the struct is created.
func (s *Set) New(items ...interface{}) Interface {
    return New(items...)
}

// Add includes the specified items (one or more) to the set. The underlying
// Set s is modified. If passed nothing it silently returns.
func (s *Set) Add(items ...interface{}) {
    if len(items) == 0 {
        return
    }

    s.l.Lock()
    defer s.l.Unlock()

    for _, item := range items {
        s.m[item] = keyExists
    }
}

// Remove deletes the specified items from the set.  The underlying Set s is
// modified. If passed nothing it silently returns.
func (s *Set) Remove(items ...interface{}) {
    if len(items) == 0 {
        return
    }

    s.l.Lock()
    defer s.l.Unlock()

    for _, item := range items {
        delete(s.m, item)
    }
}

// Pop  deletes and return an item from the set. The underlying Set s is
// modified. If set is empty, nil is returned.
func (s *Set) Pop() interface{} {
    s.l.RLock()
    for item := range s.m {
        s.l.RUnlock()
        s.l.Lock()
        delete(s.m, item)
        s.l.Unlock()
        return item
    }
    s.l.RUnlock()
    return nil
}

// Has looks for the existence of items passed. It returns false if nothing is
// passed. For multiple items it returns true only if all of  the items exist.
func (s *Set) Has(items ...interface{}) bool {
    // assume checked for empty item, which not exist
    if len(items) == 0 {
        return false
    }

    s.l.RLock()
    defer s.l.RUnlock()

    has := true
    for _, item := range items {
        if _, has = s.m[item]; !has {
            break
        }
    }
    return has
}

// Size returns the number of items in a set.
func (s *Set) Size() int {
    s.l.RLock()
    defer s.l.RUnlock()

    l := len(s.m)
    return l
}

// Clear removes all items from the set.
func (s *Set) Clear() {
    s.l.Lock()
    defer s.l.Unlock()

    s.m = make(map[interface{}]struct{})
}

// IsEqual test whether s and t are the same in size and have the same items.
func (s *Set) IsEqual(t Interface) bool {
    s.l.RLock()
    defer s.l.RUnlock()

    // Force locking only if given set is threadsafe.
    if conv, ok := t.(*Set); ok {
        conv.l.RLock()
        defer conv.l.RUnlock()
    }

    // return false if they are no the same size
    if sameSize := len(s.m) == t.Size(); !sameSize {
        return false
    }

    equal := true
    t.Each(func(item interface{}) bool {
        _, equal = s.m[item]
        return equal // if false, Each() will end
    })

    return equal
}

// IsSubset tests whether t is a subset of s.
func (s *Set) IsSubset(t Interface) (subset bool) {
    s.l.RLock()
    defer s.l.RUnlock()

    subset = true

    t.Each(func(item interface{}) bool {
        _, subset = s.m[item]
        return subset
    })

    return
}

// Each traverses the items in the Set, calling the provided function for each
// set member. Traversal will continue until all items in the Set have been
// visited, or if the closure returns false.
func (s *Set) Each(f func(item interface{}) bool) {
    s.l.RLock()
    defer s.l.RUnlock()

    for item := range s.m {
        if !f(item) {
            break
        }
    }
}

// List returns a slice of all items. There is also StringSlice() and
// IntSlice() methods for returning slices of type string or int.
func (s *Set) List() []interface{} {
    s.l.RLock()
    defer s.l.RUnlock()

    list := make([]interface{}, 0, len(s.m))

    for item := range s.m {
        list = append(list, item)
    }

    return list
}

// Copy returns a new Set with a copy of s.
func (s *Set) Copy() Interface {
    return New(s.List()...)
}

// Merge is like Union, however it modifies the current set it's applied on
// with the given t set.
func (s *Set) Merge(t Interface) {
    s.l.Lock()
    defer s.l.Unlock()

    t.Each(func(item interface{}) bool {
        s.m[item] = keyExists
        return true
    })
}