sparse

Documentation

Overview

package sparse implements a generic sparse array with popcount compression.

Index

• type Array
  • func (s *Array[T]) DeleteAt(i uint) (T, bool)
  • func (s *Array[T]) Get(i uint) (val T, ok bool)
  • func (s *Array[T]) InsertAt(i uint, val T) (exists bool)
  • func (s *Array[T]) Len() int
  • func (s *Array[T]) MustGet(i uint) T
  • func (s *Array[T]) UpdateAt(i uint, cb func(T, bool) T) (newVal T, wasPresent bool)

Types

type Array

type Array[T any] struct {
	bitset.BitSet
	Items []T
}

Array, a generic implementation of a sparse array with popcount compression and payload T.

func (*Array[T]) DeleteAt

func (s *Array[T]) DeleteAt(i uint) (T, bool)

DeleteAt, delete a value at i from the sparse array.

func (*Array[T]) Get

func (s *Array[T]) Get(i uint) (val T, ok bool)

Get the value at i from sparse array.

func (*Array[T]) InsertAt

func (s *Array[T]) InsertAt(i uint, val T) (exists bool)

InsertAt a value at i into the sparse array. If the value already exists, overwrite it with val and return true.

func (*Array[T]) Len

func (s *Array[T]) Len() int

Len returns the number of items in sparse array.

func (*Array[T]) MustGet

func (s *Array[T]) MustGet(i uint) T

MustGet, use it only after a successful test or the behavior is undefined, maybe it panics.

func (*Array[T]) UpdateAt

func (s *Array[T]) UpdateAt(i uint, cb func(T, bool) T) (newVal T, wasPresent bool)

UpdateAt or set the value at i via callback. The new value is returned and true if the val was already present.