README.md
1[](https://travis-ci.org/deckarep/golang-set)
2[](https://goreportcard.com/report/github.com/deckarep/golang-set)
3[](http://godoc.org/github.com/deckarep/golang-set)
4
5## golang-set
6
7
8The missing set collection for the Go language. Until Go has sets built-in...use this.
9
10Coming from Python one of the things I miss is the superbly wonderful set collection. This is my attempt to mimic the primary features of the set from Python.
11You can of course argue that there is no need for a set in Go, otherwise the creators would have added one to the standard library. To those I say simply ignore this repository
12and carry-on and to the rest that find this useful please contribute in helping me make it better by:
13
14* Helping to make more idiomatic improvements to the code.
15* Helping to increase the performance of it. ~~(So far, no attempt has been made, but since it uses a map internally, I expect it to be mostly performant.)~~
16* Helping to make the unit-tests more robust and kick-ass.
17* Helping to fill in the [documentation.](http://godoc.org/github.com/deckarep/golang-set)
18* Simply offering feedback and suggestions. (Positive, constructive feedback is appreciated.)
19
20I have to give some credit for helping seed the idea with this post on [stackoverflow.](http://programmers.stackexchange.com/questions/177428/sets-data-structure-in-golang)
21
22*Update* - as of 3/9/2014, you can use a compile-time generic version of this package in the [gen](http://clipperhouse.github.io/gen/) framework. This framework allows you to use the golang-set in a completely generic and type-safe way by allowing you to generate a supporting .go file based on your custom types.
23
24## Features (as of 9/22/2014)
25
26* a CartesianProduct() method has been added with unit-tests: [Read more about the cartesian product](http://en.wikipedia.org/wiki/Cartesian_product)
27
28## Features (as of 9/15/2014)
29
30* a PowerSet() method has been added with unit-tests: [Read more about the Power set](http://en.wikipedia.org/wiki/Power_set)
31
32## Features (as of 4/22/2014)
33
34* One common interface to both implementations
35* Two set implementations to choose from
36 * a thread-safe implementation designed for concurrent use
37 * a non-thread-safe implementation designed for performance
38* 75 benchmarks for both implementations
39* 35 unit tests for both implementations
40* 14 concurrent tests for the thread-safe implementation
41
42
43
44Please see the unit test file for additional usage examples. The Python set documentation will also do a better job than I can of explaining how a set typically [works.](http://docs.python.org/2/library/sets.html) Please keep in mind
45however that the Python set is a built-in type and supports additional features and syntax that make it awesome.
46
47## Examples but not exhaustive:
48
49```go
50requiredClasses := mapset.NewSet()
51requiredClasses.Add("Cooking")
52requiredClasses.Add("English")
53requiredClasses.Add("Math")
54requiredClasses.Add("Biology")
55
56scienceSlice := []interface{}{"Biology", "Chemistry"}
57scienceClasses := mapset.NewSetFromSlice(scienceSlice)
58
59electiveClasses := mapset.NewSet()
60electiveClasses.Add("Welding")
61electiveClasses.Add("Music")
62electiveClasses.Add("Automotive")
63
64bonusClasses := mapset.NewSet()
65bonusClasses.Add("Go Programming")
66bonusClasses.Add("Python Programming")
67
68//Show me all the available classes I can take
69allClasses := requiredClasses.Union(scienceClasses).Union(electiveClasses).Union(bonusClasses)
70fmt.Println(allClasses) //Set{Cooking, English, Math, Chemistry, Welding, Biology, Music, Automotive, Go Programming, Python Programming}
71
72
73//Is cooking considered a science class?
74fmt.Println(scienceClasses.Contains("Cooking")) //false
75
76//Show me all classes that are not science classes, since I hate science.
77fmt.Println(allClasses.Difference(scienceClasses)) //Set{Music, Automotive, Go Programming, Python Programming, Cooking, English, Math, Welding}
78
79//Which science classes are also required classes?
80fmt.Println(scienceClasses.Intersect(requiredClasses)) //Set{Biology}
81
82//How many bonus classes do you offer?
83fmt.Println(bonusClasses.Cardinality()) //2
84
85//Do you have the following classes? Welding, Automotive and English?
86fmt.Println(allClasses.IsSuperset(mapset.NewSetFromSlice([]interface{}{"Welding", "Automotive", "English"}))) //true
87```
88
89Thanks!
90
91-Ralph
92
93[](https://bitdeli.com/free "Bitdeli Badge")
94
95[](https://github.com/igrigorik/ga-beacon)
96
){kind=link}
){kind=link}
){kind=link}