hashset

Documentation

Overview

Package hashset implements a set backed by a hash table.

Structure is not thread safe.

References: http://en.wikipedia.org/wiki/Set_%28abstract_data_type%29

Index

• type Set
  • func New[T comparable](values ...T) *Set[T]
  • func (set *Set[T]) Add(items ...T)
  • func (set *Set[T]) Clear()
  • func (set *Set[T]) Contains(items ...T) bool
  • func (set *Set[T]) Difference(another *Set[T]) *Set[T]
  • func (set *Set[T]) Empty() bool
  • func (set *Set[T]) FromJSON(data []byte) error
  • func (set *Set[T]) Intersection(another *Set[T]) *Set[T]
  • func (set *Set[T]) MarshalJSON() ([]byte, error)
  • func (set *Set[T]) Remove(items ...T)
  • func (set *Set[T]) Size() int
  • func (set *Set[T]) String() string
  • func (set *Set[T]) ToJSON() ([]byte, error)
  • func (set *Set[T]) Union(another *Set[T]) *Set[T]
  • func (set *Set[T]) UnmarshalJSON(bytes []byte) error
  • func (set *Set[T]) Values() []T

Types

type Set

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

Set holds elements in go's native map

func New

func New[T comparable](values ...T) *Set[T]

New instantiates a new empty set and adds the passed values, if any, to the set

func (*Set[T]) Add

func (set *Set[T]) Add(items ...T)

Add adds the items (one or more) to the set.

func (*Set[T]) Clear

func (set *Set[T]) Clear()

Clear clears all values in the set.

func (*Set[T]) Contains

func (set *Set[T]) Contains(items ...T) bool

Contains check if items (one or more) are present in the set. All items have to be present in the set for the method to return true. Returns true if no arguments are passed at all, i.e. set is always superset of empty set.

func (*Set[T]) Difference

func (set *Set[T]) Difference(another *Set[T]) *Set[T]

Difference returns the difference between two sets. The new set consists of all elements that are in "set" but not in "another". Ref: https://proofwiki.org/wiki/Definition:Set_Difference

func (*Set[T]) Empty

func (set *Set[T]) Empty() bool

Empty returns true if set does not contain any elements.

func (*Set[T]) FromJSON

func (set *Set[T]) FromJSON(data []byte) error

FromJSON populates the set from the input JSON representation.

func (*Set[T]) Intersection

func (set *Set[T]) Intersection(another *Set[T]) *Set[T]

Intersection returns the intersection between two sets. The new set consists of all elements that are both in "set" and "another". Ref: https://en.wikipedia.org/wiki/Intersection_(set_theory)

func (*Set[T]) MarshalJSON

func (set *Set[T]) MarshalJSON() ([]byte, error)

MarshalJSON @implements json.Marshaler

func (*Set[T]) Remove

func (set *Set[T]) Remove(items ...T)

Remove removes the items (one or more) from the set.

func (*Set[T]) Size

func (set *Set[T]) Size() int

Size returns number of elements within the set.

func (*Set[T]) String

func (set *Set[T]) String() string

String returns a string representation of container

func (*Set[T]) ToJSON

func (set *Set[T]) ToJSON() ([]byte, error)

ToJSON outputs the JSON representation of the set.

func (*Set[T]) Union

func (set *Set[T]) Union(another *Set[T]) *Set[T]

Union returns the union of two sets. The new set consists of all elements that are in "set" or "another" (possibly both). Ref: https://en.wikipedia.org/wiki/Union_(set_theory)

func (*Set[T]) UnmarshalJSON

func (set *Set[T]) UnmarshalJSON(bytes []byte) error

UnmarshalJSON @implements json.Unmarshaler

func (*Set[T]) Values

func (set *Set[T]) Values() []T

Values returns all items in the set.