TopGit tracks scylladb/go-set on GitHub as part of the Backend family. The project has 814 stars. Type-safe, zero-allocation sets for Go
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Package set is a type-safe, zero-allocation port of the excellent package fatih/set. It contains sets for most of the basic types and you can generate sets for your own types with ease.
The library exposes a number of top level factory functions that can be used to create a specific instances of the set type you want to use. For example to create a set to store int you could do like this:
import "github.com/scylladb/go-set"
s := set.NewIntSet()
// use the set...
Usage
In every subpackage Set is the main set structure that holds all the data and methods used to working with the set.
func Difference
func Difference(set1 *Set, sets ...*Set) *Set
Difference returns a new set which contains items which are in in the first set
but not in the others.
func Intersection
func Intersection(sets ...*Set) *Set
Intersection returns a new set which contains items that only exist in all given
sets.
func New
func New(ts ...T) *Set
New creates and initializes a new Set.
func NewWithSize
func NewWithSize(size int) *Set
NewWithSize creates a new Set and gives make map a size hint.
func SymmetricDifference
func SymmetricDifference(s *Set, t *Set) *Set
SymmetricDifference returns a new set which s is the difference of items which
are in one of either, but not in both.
func Union
func Union(sets ...*Set) *Set
Union is the merger of multiple sets. It returns a new set with all the elements
present in all the sets that are passed.
func (*Set) Add
func (s *Set) Add(items ...T)
Add includes the specified items (one or more) to the Set. The underlying Set s
is modified. If passed nothing it silently returns.
func (*Set) Clear
func (s *Set) Clear()
Clear removes all items from the Set.
func (*Set) Copy
func (s *Set) Copy() *Set
Copy returns a new Set with a copy of s.
func (*Set) Each
func (s *Set) Each(f func(item T) bool)
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 (*Set) Has
func (s *Set) Has(items ...T) bool
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 (*Set) IsEmpty
func (s *Set) IsEmpty() bool
IsEmpty reports whether the Set is empty.
func (*Set) IsEqual
func (s *Set) IsEqual(t *Set) bool
IsEqual test whether s and t are the same in size and have the same items.
func (*Set) IsSubset
func (s *Set) IsSubset(t *Set) bool
IsSubset tests whether t is a subset of s.
func (*Set) IsSuperset
func (s *Set) IsSuperset(t *Set) bool
IsSuperset tests whether t is a superset of s.
func (*Set) List
func (s *Set) List() []T
List returns a slice of all items. There is also StringSlice() and IntSlice()
methods for returning slices of type string or int.
func (*Set) Merge
func (s *Set) Merge(t *Set)
Merge is like Union, however it modifies the current Set it's applied on with
the given t Set.
func (*Set) Pop
func (s *Set) Pop() T
Pop deletes and returns an item from the Set. The underlying Set s is modified.
If Set is empty, the zero value is returned.
func (*Set) Pop2
func (s *Set) Pop2() (T, bool)
Pop2 tries to delete and return an item from the Set. The underlying Set s is modified.
The second value is a bool that is true if the item existed in the set, and false if not.
If Set is empty, the zero value and false are returned.
func (*Set) Remove
func (s *Set) Remove(items ...T)
Remove deletes the specified items from the Set. The underlying Set s is
modified. If passed nothing it silently returns.
func (*Set) Separate
func (s *Set) Separate(t *Set)
Separate removes the Set items containing in t from Set s. Please aware that
it's not the opposite of Merge.
func (*Set) Size
func (s *Set) Size() int
Size returns the number of items in a Set.
func (*Set) String
func (s *Set) String() string
String returns a string representation of s
Performance
The improvement in performance by using concrete types over interface{} is notable. Below you will find benchmark results comparing type-safe sets to fatih/set counterparts for string, int64, int32, float64 and float32 on a local machine, Intel(R) Core(TM) i7-7500U CPU @ 2.70GHz.
For code generation we use Google go_generics tool that we forked to provide bazel-free installation, to install run:
go get -u github.com/mmatczuk/go_generics/cmd/go_generics
Once you have go_generics installed properly you can regenerate the code using go generate in the top level directory.
Your custom types
If you have types that you would like to use but the are not amenable for inclusion in this library you can simply generate code on your own and put it in your package.
For example, to generate a set for SomeType in package sometypeset call:
./gen_set.sh SomeType sometypeset
this would generate a new directory sometypeset in current working directory.
If you think your addition belongs here we are open to accept pull requests.
License
Copyright (C) 2018 ScyllaDB
This project is distributed under the Apache 2.0 license. See the LICENSE file for details.
It contains software from:
github.com/fatih/set, licensed under the MIT license
No homepage URL was recorded for scylladb/go-set in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
How does scylladb/go-set compare to other Backend projects?
scylladb/go-set is tracked by TopGit in the Backend category, with 814 GitHub stars and written in Go. Browse the Backend topic page on TopGit to compare it against similar projects by stars and activity.
How many stars does scylladb/go-set have?
scylladb/go-set has 814 GitHub stars — refresh the page for the live number, or check github.com/scylladb/go-set. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is scylladb/go-set open source?
Yes — scylladb/go-set ships under the Apache-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/scylladb/go-set.
What else is in the Backend space?
scylladb/go-set is tracked by TopGit under the Backend category, alongside 3 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What is scylladb/go-set?
scylladb/go-set (scylladb/go-set) is a Go project on GitHub. From the project's own README: Type-safe, zero-allocation sets for Go
Where do I read more about scylladb/go-set?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/scylladb/go-set is the definitive source.
Read full README in the tab above.
Still deciding about go-set?
One click hands the question to an AI along with this page — see what it says about go-set.