// Copyright 2017 gf Author(https://github.com/gogf/gf). All Rights Reserved. // // This Source Code Form is subject to the terms of the MIT License. // If a copy of the MIT was not distributed with this file, // You can obtain one at https://github.com/gogf/gf. // package gset import ( "strings" "github.com/gogf/gf/internal/rwmutex" "github.com/gogf/gf/util/gconv" ) type StringSet struct { mu *rwmutex.RWMutex m map[string]struct{} } // New create and returns a new set, which contains un-repeated items. // The parameter used to specify whether using set in un-concurrent-safety, // which is false in default. func NewStringSet(safe ...bool) *StringSet { return &StringSet{ m: make(map[string]struct{}), mu: rwmutex.New(safe...), } } // NewStringSetFrom returns a new set from . func NewStringSetFrom(items []string, safe ...bool) *StringSet { m := make(map[string]struct{}) for _, v := range items { m[v] = struct{}{} } return &StringSet{ m: m, mu: rwmutex.New(safe...), } } // Iterator iterates the set with given callback function , // if returns true then continue iterating; or false to stop. func (set *StringSet) Iterator(f func(v string) bool) *StringSet { set.mu.RLock() defer set.mu.RUnlock() for k, _ := range set.m { if !f(k) { break } } return set } // Add adds one or multiple items to the set. func (set *StringSet) Add(item ...string) *StringSet { set.mu.Lock() for _, v := range item { set.m[v] = struct{}{} } set.mu.Unlock() return set } // Contains checks whether the set contains . func (set *StringSet) Contains(item string) bool { set.mu.RLock() _, exists := set.m[item] set.mu.RUnlock() return exists } // Remove deletes from set. func (set *StringSet) Remove(item string) *StringSet { set.mu.Lock() delete(set.m, item) set.mu.Unlock() return set } // Size returns the size of the set. func (set *StringSet) Size() int { set.mu.RLock() l := len(set.m) set.mu.RUnlock() return l } // Clear deletes all items of the set. func (set *StringSet) Clear() *StringSet { set.mu.Lock() set.m = make(map[string]struct{}) set.mu.Unlock() return set } // Slice returns the a of items of the set as slice. func (set *StringSet) Slice() []string { set.mu.RLock() ret := make([]string, len(set.m)) i := 0 for item := range set.m { ret[i] = item i++ } set.mu.RUnlock() return ret } // Join joins items with a string . func (set *StringSet) Join(glue string) string { return strings.Join(set.Slice(), ",") } // String returns items as a string, which are joined by char ','. func (set *StringSet) String() string { return set.Join(",") } // LockFunc locks writing with callback function . func (set *StringSet) LockFunc(f func(m map[string]struct{})) { set.mu.Lock() defer set.mu.Unlock() f(set.m) } // RLockFunc locks reading with callback function . func (set *StringSet) RLockFunc(f func(m map[string]struct{})) { set.mu.RLock() defer set.mu.RUnlock() f(set.m) } // Equal checks whether the two sets equal. func (set *StringSet) Equal(other *StringSet) bool { if set == other { return true } set.mu.RLock() defer set.mu.RUnlock() other.mu.RLock() defer other.mu.RUnlock() if len(set.m) != len(other.m) { return false } for key := range set.m { if _, ok := other.m[key]; !ok { return false } } return true } // IsSubsetOf checks whether the current set is a sub-set of . func (set *StringSet) IsSubsetOf(other *StringSet) bool { if set == other { return true } set.mu.RLock() defer set.mu.RUnlock() other.mu.RLock() defer other.mu.RUnlock() for key := range set.m { if _, ok := other.m[key]; !ok { return false } } return true } // Union returns a new set which is the union of and . // Which means, all the items in are in or in . func (set *StringSet) Union(others ...*StringSet) (newSet *StringSet) { newSet = NewStringSet(true) set.mu.RLock() defer set.mu.RUnlock() for _, other := range others { if set != other { other.mu.RLock() } for k, v := range set.m { newSet.m[k] = v } if set != other { for k, v := range other.m { newSet.m[k] = v } } if set != other { other.mu.RUnlock() } } return } // Diff returns a new set which is the difference set from to . // Which means, all the items in are in but not in . func (set *StringSet) Diff(others ...*StringSet) (newSet *StringSet) { newSet = NewStringSet(true) set.mu.RLock() defer set.mu.RUnlock() for _, other := range others { if set == other { continue } other.mu.RLock() for k, v := range set.m { if _, ok := other.m[k]; !ok { newSet.m[k] = v } } other.mu.RUnlock() } return } // Intersect returns a new set which is the intersection from to . // Which means, all the items in are in and also in . func (set *StringSet) Intersect(others ...*StringSet) (newSet *StringSet) { newSet = NewStringSet(true) set.mu.RLock() defer set.mu.RUnlock() for _, other := range others { if set != other { other.mu.RLock() } for k, v := range set.m { if _, ok := other.m[k]; ok { newSet.m[k] = v } } if set != other { other.mu.RUnlock() } } return } // Complement returns a new set which is the complement from to . // Which means, all the items in are in and not in . // // It returns the difference between and // if the given set is not the full set of . func (set *StringSet) Complement(full *StringSet) (newSet *StringSet) { newSet = NewStringSet(true) set.mu.RLock() defer set.mu.RUnlock() if set != full { full.mu.RLock() defer full.mu.RUnlock() } for k, v := range full.m { if _, ok := set.m[k]; !ok { newSet.m[k] = v } } return } // Merge adds items from sets into . func (set *StringSet) Merge(others ...*StringSet) *StringSet { set.mu.Lock() defer set.mu.Unlock() for _, other := range others { if set != other { other.mu.RLock() } for k, v := range other.m { set.m[k] = v } if set != other { other.mu.RUnlock() } } return set } // Sum sums items. // Note: The items should be converted to int type, // or you'd get a result that you unexpected. func (set *StringSet) Sum() (sum int) { set.mu.RLock() defer set.mu.RUnlock() for k, _ := range set.m { sum += gconv.Int(k) } return } // Pops randomly pops an item from set. func (set *StringSet) Pop() string { set.mu.RLock() defer set.mu.RUnlock() for k, _ := range set.m { return k } return "" } // Pops randomly pops items from set. func (set *StringSet) Pops(size int) []string { set.mu.RLock() defer set.mu.RUnlock() if size > len(set.m) { size = len(set.m) } index := 0 array := make([]string, size) for k, _ := range set.m { array[index] = k index++ if index == size { break } } return array }