cardinality

type CommutativeDuplex64 ¶ added in v0.4.0

type CommutativeDuplex64 struct {
	// contains filtered or unexported fields
}

func NewCommutativeDuplex64() *CommutativeDuplex64

func (s *CommutativeDuplex64) AndInto(duplex Duplex[uint64])

func (s *CommutativeDuplex64) Cardinality() uint64

func (s *CommutativeDuplex64) Contains(value uint64) bool

func (s *CommutativeDuplex64) Each(delegate func(value uint64) bool)

func (s *CommutativeDuplex64) Or(duplex ...Duplex[uint64])

func (s *CommutativeDuplex64) OrAll(other *CommutativeDuplex64)

func (s *CommutativeDuplex64) OrInto(duplex Duplex[uint64])

func (s *CommutativeDuplex64) Slice() []uint64

type Duplex ¶

type Duplex[T uint32 | uint64] interface {
	Provider[T]

	Xor(other Provider[T])
	And(other Provider[T])
	AndNot(other Provider[T])
	Remove(value T)
	Slice() []T
	Contains(value T) bool
	Each(delegate func(value T) bool)
	CheckedAdd(value T) bool
	Clone() Duplex[T]
}

Duplex is a two-way cardinality provider that allows a user to retrieve encoded values back out of the provider. This interface is suitable for algorithms that behave similar to bitvectors.

func NewBitmap32() Duplex[uint32]

func NewBitmap32With(values ...uint32) Duplex[uint32]

func NewBitmap64() Duplex[uint64]

func NewBitmap64With(values ...uint64) Duplex[uint64]

func ThreadSafeDuplex[T uint32 | uint64](provider Duplex[T]) Duplex[T]

type DuplexConstructor ¶

type DuplexConstructor[T uint32 | uint64] func() Duplex[T]

type Iterator ¶

type Iterator[T uint32 | uint64] interface {
	HasNext() bool
	Next() T
}

Iterator allows enumeration of a duplex cardinality provider without requiring the allocation of the provider's set.

type Provider ¶

type Provider[T uint32 | uint64] interface {
	Add(value ...T)
	Or(other Provider[T])
	Clear()
	Cardinality() uint64
}

Provider describes the most basic functionality of a cardinality provider algorithm: adding elements to the provider and producing the cardinality of those elements.

func CloneProvider[T uint32 | uint64](provider Provider[T]) Provider[T]

func NewBitmap32Provider() Provider[uint32]

func NewBitmap64Provider() Provider[uint64]

func NewHyperLogLog32Provider() Provider[uint32]

func NewHyperLogLog64Provider() Provider[uint64]

type ProviderConstructor ¶

type ProviderConstructor[T uint32 | uint64] func() Provider[T]

type Simplex ¶

type Simplex[T uint32 | uint64] interface {
	Provider[T]

	Clone() Simplex[T]
}

Simplex is a one-way cardinality provider that does not allow a user to retrieve encoded values back out of the provider. This interface is suitable for algorithms such as HyperLogLog which utilizes a hash function to merge identifiers into the cardinality provider.

func NewHyperLogLog32() Simplex[uint32]

func NewHyperLogLog64() Simplex[uint64]

func ThreadSafeSimplex[T uint32 | uint64](provider Simplex[T]) Simplex[T]

type SimplexConstructor ¶

type SimplexConstructor[T uint32 | uint64] func() Simplex[T]