set

README

set

Basic set implemented with generics.

Authors

• Christophe Lambin

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Documentation

Index

• type Set
  • func Create[T cmp.Ordered](values ...T) Set[T]
  • func Difference[T cmp.Ordered](setA, setB Set[T]) Set[T]
  • func Intersection[T cmp.Ordered](setA, setB Set[T]) Set[T]
  • func New[T cmp.Ordered](values ...T) Set[T]
  • func Union[T cmp.Ordered](setA, setB Set[T]) Set[T]
  • func (s Set[T]) Add(value ...T)
  • func (s Set[T]) Clone() Set[T]
  • func (s Set[T]) Contains(value T) bool
  • func (s Set[T]) Copy() Set[T]
  • func (s Set[T]) Equals(other Set[T]) bool
  • func (s Set[T]) List() []T
  • func (s Set[T]) ListOrdered() []T
  • func (s Set[T]) Remove(value ...T)

Types

type Set

type Set[T cmp.Ordered] map[T]struct{}

Set holds a set of unique values

func Create

func Create[T cmp.Ordered](values ...T) Set[T]

Create creates a new set containing the optional values Deprecated: use New() instead.

func Difference

func Difference[T cmp.Ordered](setA, setB Set[T]) Set[T]

Difference returns a new set holding the values from setA that don't exist in setB

func Intersection

func Intersection[T cmp.Ordered](setA, setB Set[T]) Set[T]

Intersection returns a new set containing the values that exist in both setA and setB

func New

func New[T cmp.Ordered](values ...T) Set[T]

New creates a new set containing the optional values

func Union

func Union[T cmp.Ordered](setA, setB Set[T]) Set[T]

Union returns a new set containing the values from setA and setB

func (Set[T]) Add

func (s Set[T]) Add(value ...T)

Add adds value to the set

func (Set[T]) Clone

func (s Set[T]) Clone() Set[T]

Clone returns a copy of the set

func (Set[T]) Contains

func (s Set[T]) Contains(value T) bool

Contains returns true if the set contains value

func (Set[T]) Copy

func (s Set[T]) Copy() Set[T]

Copy returns a copy of the set Deprecated: use Clone() instead.

func (Set[T]) Equals

func (s Set[T]) Equals(other Set[T]) bool

Equals returns true if both sets contain the same values

func (Set[T]) List

func (s Set[T]) List() []T

List returns all values present in the set. Order is not guaranteed. If ListOrdered() if required.

func (Set[T]) ListOrdered

func (s Set[T]) ListOrdered() []T

ListOrdered returns all values present in the set, in order

func (Set[T]) Remove

func (s Set[T]) Remove(value ...T)

Remove deletes value from the set, if present