README
¶
GoSet
🏆 goset is a generic Go implementation of the Set data structure
Inspired by Python's set, this project uses Go 1.18+ generics to implement all the methods you ever wanted for a Set of items!
📌 Install
go get github.com/amit7itz/goset@v1
🤓 Usage
Import:
import "github.com/amit7itz/goset"
Initialize:
// create an empty Set of integers
emptySet := goset.NewSet[int]()
// create a Set of strings with items
mySet := goset.NewSet[string]("c", "d")
// create a Set of strings from a slice
lettersSet := goset.FromSlice([]string{"a", "b", "c", "d"})
Use:
mySet.Add("c", "d", "e", "f", "g")
mySet.Discard("g")
println(mySet.String())
// Set[string]{"c", "d", "e", "f"}
intersectionSet := mySet.Intersection(lettersSet)
// Set[string]{"c", "d"}
unionSet := mySet.Union(lettersSet)
// Set[string]{"a", "b", "c", "d", "e", "f"}
naturals := goset.NewSet[int](1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
primes := goset.NewSet[int](2, 3, 5, 7)
primes.IsSubset(naturals)
// true
primes.Contains(8)
// false
items := primes.Items()
// []int{2, 3, 5, 7}
Set works on any comparable object, so you can use it also for structs!
(But don't use it for structs with pointer fields, it will hurt)
type Person struct {
Name string
}
peopleSet := goset.NewSet(Person{Name: "Amit"}, Person{Name: "Amit"})
println(peopleSet.Len())
// 1
📖 Spec
Full documentation at GoDoc: https://godoc.org/github.com/amit7itz/goset
Constructors:
- NewSet
- FromSlice
Methods:
- Add
- Contains
- Copy
- Discard
- For
- ForWithBreak
- IsEmpty
- Items
- Len
- Pop
- Remove
- String
- Difference
- Equal
- Intersection
- IsDisjoint
- IsSubset
- IsSuperset
- SymmetricDifference
- Union
- Update
🤝 Contributing
Open source is awesome! Feel free to fork the project, open issues, and request new features!
🖋️ Authors
- Amit Itzkovitch
💫 Show your support
If you liked it then you should have put a ⭐ on it! (And let your friends know, so they can enjoy it too!)
Documentation
¶
Index ¶
- type Set
- func (s *Set[T]) Add(items ...T)
- func (s *Set[T]) Contains(item T) bool
- func (s *Set[T]) Copy() *Set[T]
- func (s *Set[T]) Difference(others ...*Set[T]) *Set[T]
- func (s *Set[T]) Discard(items ...T)
- func (s *Set[T]) Equal(other *Set[T]) bool
- func (s *Set[T]) For(f func(item T))
- func (s *Set[T]) ForWithBreak(f func(item T) bool)
- func (s *Set[T]) Intersection(others ...*Set[T]) *Set[T]
- func (s *Set[T]) IsDisjoint(other *Set[T]) bool
- func (s *Set[T]) IsEmpty() bool
- func (s *Set[T]) IsSubset(other *Set[T]) bool
- func (s *Set[T]) IsSuperset(other *Set[T]) bool
- func (s *Set[T]) Items() []T
- func (s *Set[T]) Len() int
- func (s *Set[T]) MarshalJSON() ([]byte, error)
- func (s *Set[T]) Pop() (T, error)
- func (s *Set[T]) Remove(item T) error
- func (s *Set[T]) String() string
- func (s *Set[T]) SymmetricDifference(other *Set[T]) *Set[T]
- func (s *Set[T]) Union(others ...*Set[T]) *Set[T]
- func (s *Set[T]) UnmarshalJSON(b []byte) error
- func (s *Set[T]) Update(others ...*Set[T])
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Set ¶
type Set[T comparable] struct { // contains filtered or unexported fields }
Set represents a set data structure. You should not call it directly, use NewSet() or FromSlice()
func FromSlice ¶
func FromSlice[T comparable](slice []T) *Set[T]
FromSlice returns a new Set with all the items of the slice.
func NewSet ¶
func NewSet[T comparable](items ...T) *Set[T]
NewSet returns a new Set of the given items
func (*Set[T]) Difference ¶
Difference returns a new Set of all the items in the current Set that are not in any of the others
func (*Set[T]) Discard ¶
func (s *Set[T]) Discard(items ...T)
Discard removes item(s) from the Set if exist See also: Remove()
func (*Set[T]) Equal ¶
Equal returns whether the current Set contains the same items as the other one
func (*Set[T]) For ¶ added in v1.1.0
func (s *Set[T]) For(f func(item T))
For runs a function on all the items in the Set
func (*Set[T]) ForWithBreak ¶ added in v1.1.0
ForWithBreak runs a function on all the items in the store if f returns false, the iteration stops
func (*Set[T]) Intersection ¶
Intersection returns a new Set with the common items of the current set and all others.
func (*Set[T]) IsDisjoint ¶
IsDisjoint returns whether the two Sets have no item in common
func (*Set[T]) IsSubset ¶
IsSubset returns whether all the items of the current set exist in the other one
func (*Set[T]) IsSuperset ¶
IsSuperset returns whether all the items of the other set exist in the current one
func (*Set[T]) MarshalJSON ¶ added in v1.2.0
func (*Set[T]) Pop ¶
Pop removes an arbitrary item from the Set and returns it. Returns error if the Set is empty
func (*Set[T]) Remove ¶
Remove removes a single item from the Set. Returns error if the item is not in the Set See also: Discard()
func (*Set[T]) SymmetricDifference ¶
SymmetricDifference returns all the items that exist in only one of the Sets
Source Files
Directories