Documentation
¶
Overview ¶
Package set contains set types.
Index ¶
- type Handle
- type HandleSet
- type IntSet
- func (s *IntSet[T]) Add(e T)
- func (s *IntSet[T]) AddSeq(seq iter.Seq[T])
- func (s IntSet[T]) Clone() IntSet[T]
- func (s IntSet[T]) Contains(e T) bool
- func (s *IntSet[T]) Delete(e T)
- func (s *IntSet[T]) DeleteSeq(seq iter.Seq[T])
- func (s IntSet[T]) Equal(other IntSet[T]) bool
- func (s IntSet[T]) Len() int
- func (s IntSet[T]) Values() iter.Seq[T]
- type Set
- func (s Set[T]) Add(e T)
- func (s Set[T]) AddSet(es Set[T])
- func (s Set[T]) AddSlice(es []T)
- func (s Set[T]) Clone() Set[T]
- func (s Set[T]) Contains(e T) bool
- func (s Set[T]) Delete(e T)
- func (s Set[T]) Equal(other Set[T]) bool
- func (s Set[T]) Len() int
- func (s *Set[T]) Make()
- func (s Set[T]) MarshalJSON() ([]byte, error)
- func (s Set[T]) Slice() []T
- func (s *Set[T]) UnmarshalJSON(buf []byte) error
- type Slice
- type SmallSet
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Handle ¶
type Handle struct {
// contains filtered or unexported fields
}
Handle is an opaque comparable value that's used as the map key in a HandleSet.
type HandleSet ¶
HandleSet is a set of T.
It is not safe for concurrent use.
func (*HandleSet[T]) Add ¶
Add adds the element (map value) e to the set.
It returns a new handle (map key) with which e can be removed, using a map delete or the HandleSet.Delete method.
type IntSet ¶
type IntSet[T constraints.Integer] struct { // contains filtered or unexported fields }
IntSet is a set optimized for integer values close to zero or set of integers that are close in value.
func IntsOf ¶
func IntsOf[T constraints.Integer](slice ...T) IntSet[T]
IntsOf constructs an IntSet with the provided elements.
func (*IntSet[T]) Add ¶
func (s *IntSet[T]) Add(e T)
Add adds e to the set.
When storing a IntSet in a map as a value type, it is important to re-assign the map entry after calling Add or Delete, as the IntSet's representation may change.
func (*IntSet[T]) Delete ¶
func (s *IntSet[T]) Delete(e T)
Delete removes e from the set.
When storing a IntSet in a map as a value type, it is important to re-assign the map entry after calling Add or Delete, as the IntSet's representation may change.
type Set ¶
type Set[T comparable] map[T]struct{}
Set is a set of T.
func Of ¶
func Of[T comparable](slice ...T) Set[T]
Of returns a new set constructed from the elements in slice.
func SetOf ¶
func SetOf[T comparable](slice []T) Set[T]
SetOf returns a new set constructed from the elements in slice.
func (*Set[T]) Make ¶
func (s *Set[T]) Make()
Make lazily initializes the map pointed to by s to be non-nil.
func (Set[T]) MarshalJSON ¶
func (Set[T]) Slice ¶
func (s Set[T]) Slice() []T
Slice returns the elements of the set as a slice. The elements will not be in any particular order.
func (*Set[T]) UnmarshalJSON ¶
type Slice ¶
type Slice[T comparable] struct { // contains filtered or unexported fields }
Slice is a set of elements tracked in a slice of unique elements.
func (*Slice[T]) Add ¶
func (ss *Slice[T]) Add(vs ...T)
Add adds each element in vs to the set. The amortized cost is O(1) per element.
type SmallSet ¶
type SmallSet[T comparable] struct { // contains filtered or unexported fields }
SmallSet is a set that is optimized for reducing memory overhead when the expected size of the set is 0 or 1 elements.
The zero value of SmallSet is a usable empty set.
When storing a SmallSet in a map as a value type, it is important to re-assign the map entry after calling Add or Delete, as the SmallSet's representation may change.
Copying a SmallSet by value may alias the previous value. Use the Clone method to create a new SmallSet with the same contents.
func (*SmallSet[T]) Add ¶
func (s *SmallSet[T]) Add(e T)
Add adds e to the set.
When storing a SmallSet in a map as a value type, it is important to re-assign the map entry after calling Add or Delete, as the SmallSet's representation may change.
func (*SmallSet[T]) Delete ¶
func (s *SmallSet[T]) Delete(e T)
Delete removes e from the set.
When storing a SmallSet in a map as a value type, it is important to re-assign the map entry after calling Add or Delete, as the SmallSet's representation may change.
func (SmallSet[T]) SoleElement ¶
SoleElement returns the single value in the set, if the set has exactly one element.
If the set is empty or has more than one element, ok will be false and e will be the zero value of T.
Source Files