mapset

Documentation

Index

• type Iterator
  • func (it Iterator[T]) Get() T
  • func (it Iterator[T]) Move()
  • func (it Iterator[T]) Remove()
  • func (it Iterator[T]) Valid() bool
• type Set
  • func FromMap[T any](m maps.Map[T, empty]) Set[T]
  • func NewHashSet[T comparable]() Set[T]
  • func NewTreeSet[T cmp.Ordered]() Set[T]
  • func (s Set[T]) Add(value T)
  • func (s Set[T]) Clear()
  • func (s Set[T]) Clone() sets.Set[T]
  • func (s Set[T]) Contains(value T) bool
  • func (s Set[T]) Iterator() iter.Iterator[T]
  • func (s Set[T]) Map() maps.Map[T, empty]
  • func (s Set[T]) Remove(value T)
  • func (s Set[T]) SetIterator() sets.Iterator[T]
  • func (s Set[T]) Size() int
  • func (s Set[T]) Stream(yield func(T) bool)

Types

type Iterator

type Iterator[T any] struct {
	// contains filtered or unexported fields
}

Iterator is an iterator over a set.

func (Iterator[T]) Get

func (it Iterator[T]) Get() T

Get returns the current element.

func (Iterator[T]) Move

func (it Iterator[T]) Move()

Move moves the iterator to the next element.

func (Iterator[T]) Remove

func (it Iterator[T]) Remove()

Remove removes the current element from the set.

func (Iterator[T]) Valid

func (it Iterator[T]) Valid() bool

Valid returns true if the iterator is pointing to a valid element.

type Set

type Set[T any] struct {
	// contains filtered or unexported fields
}

Set is a set implementation based on maps. Keys are elements of the set, and values are empty structs.

func FromMap

func FromMap[T any](m maps.Map[T, empty]) Set[T]

FromMap creates a new set from a map.

func NewHashSet

func NewHashSet[T comparable]() Set[T]

NewHashSet creates a new hash set for comparable types.

func NewTreeSet

func NewTreeSet[T cmp.Ordered]() Set[T]

NewTreeSet creates a new tree set for ordered types.

func (Set[T]) Add

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

Add adds a value to the set.

func (Set[T]) Clear

func (s Set[T]) Clear()

Clear removes all elements from the set.

func (Set[T]) Clone

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

Clone returns a shallow copy of the set.

func (Set[T]) Contains

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

Contains returns true if the set contains the value.

func (Set[T]) Iterator

func (s Set[T]) Iterator() iter.Iterator[T]

Iterator returns an iter.Iterator over the set.

func (Set[T]) Map

func (s Set[T]) Map() maps.Map[T, empty]

Map returns the underlying map.

func (Set[T]) Remove

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

Remove removes a value from the set.

func (Set[T]) SetIterator

func (s Set[T]) SetIterator() sets.Iterator[T]

SetIterator returns an iterator over the set.

func (Set[T]) Size

func (s Set[T]) Size() int

Size returns the number of elements in the set.

func (Set[T]) Stream

func (s Set[T]) Stream(yield func(T) bool)

Stream streams the elements of the Set.