sets

Documentation

Overview

Package sets contains set data structures.

Index

• type Hash
  • func NewHash[T comparable](initialValues ...T) *Hash[T]
  • func (s *Hash[T]) Add(elements ...T)
  • func (s *Hash[T]) Has(element T) bool
  • func (s *Hash[T]) Size() int
• type SizeLimited
  • func NewSizeLimited[T comparable](capacity int) *SizeLimited[T]
  • func (s *SizeLimited[T]) Add(element T)
  • func (s *SizeLimited[T]) ForEach(callback func(element T) bool)
• type Sorted
  • func NewSorted[T constraints.Ordered]() *Sorted[T]
  • func (s *Sorted[T]) Add(elements ...T)
  • func (s *Sorted[T]) Clear()
  • func (s *Sorted[T]) Delete(element T)
  • func (s *Sorted[T]) ForEach(callback func(element T) bool)
  • func (s *Sorted[T]) Has(element T) bool
  • func (s *Sorted[T]) Size() int
  • func (s *Sorted[T]) ToSlice() []T

Types

type Hash

type Hash[T comparable] struct {
	// contains filtered or unexported fields
}

A Hash is a set implemented via a map.

func NewHash

func NewHash[T comparable](initialValues ...T) *Hash[T]

NewHash creates a new Hash set.

func (*Hash[T]) Add

func (s *Hash[T]) Add(elements ...T)

Add adds a value to the set.

func (*Hash[T]) Has

func (s *Hash[T]) Has(element T) bool

Has returns true if the element is in the set.

func (*Hash[T]) Size

func (s *Hash[T]) Size() int

Size returns the size of the set.

type SizeLimited

type SizeLimited[T comparable] struct {
	// contains filtered or unexported fields
}

A SizeLimited is a Set which is limited to a given size. Once the capacity is reached an element will be removed at random.

func NewSizeLimited

func NewSizeLimited[T comparable](capacity int) *SizeLimited[T]

NewSizeLimited create a new SizeLimited.

func (*SizeLimited[T]) Add

func (s *SizeLimited[T]) Add(element T)

Add adds an element to the set.

func (*SizeLimited[T]) ForEach

func (s *SizeLimited[T]) ForEach(callback func(element T) bool)

ForEach iterates over all the elements in the set.

type Sorted

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

A Sorted is a set with sorted iteration.

func NewSorted

func NewSorted[T constraints.Ordered]() *Sorted[T]

NewSorted creates a new sorted string set.

func (*Sorted[T]) Add

func (s *Sorted[T]) Add(elements ...T)

Add adds a string to the set.

func (*Sorted[T]) Clear

func (s *Sorted[T]) Clear()

Clear clears the set.

func (*Sorted[T]) Delete

func (s *Sorted[T]) Delete(element T)

Delete deletes an element from the set.

func (*Sorted[T]) ForEach

func (s *Sorted[T]) ForEach(callback func(element T) bool)

ForEach iterates over the set in ascending order.

func (*Sorted[T]) Has

func (s *Sorted[T]) Has(element T) bool

Has returns true if the element is in the set.

func (*Sorted[T]) Size

func (s *Sorted[T]) Size() int

Size returns the size of the set.

func (*Sorted[T]) ToSlice

func (s *Sorted[T]) ToSlice() []T

ToSlice returns a slice of all the elements in the set.