aghalg

Documentation

Overview

Package aghalg contains common generic algorithms and data structures.

TODO(a.garipov): Move parts of this into golibs.

Index

• func CoalesceSlice[E any, S []E](values ...S) (res S)
• type NullBool
  • func BoolToNullBool(cond bool) (nb NullBool)
  • func (nb NullBool) MarshalJSON() (b []byte, err error)
  • func (nb NullBool) String() (s string)
  • func (nb *NullBool) UnmarshalJSON(b []byte) (err error)
• type RingBuffer
  • func NewRingBuffer[T any](size uint) (rb *RingBuffer[T])
  • func (rb *RingBuffer[T]) Append(e T)
  • func (rb *RingBuffer[T]) Clear()
  • func (rb *RingBuffer[T]) Len() (l uint)
  • func (rb *RingBuffer[T]) Range(cb func(T) (cont bool))
  • func (rb *RingBuffer[T]) ReverseRange(cb func(T) (cont bool))
• type SortedMap
  • func NewSortedMap[K comparable, V any](cmp func(a, b K) (res int)) SortedMap[K, V]
  • func (m *SortedMap[K, V]) Clear()
  • func (m *SortedMap[K, V]) Del(key K)
  • func (m *SortedMap[K, V]) Get(key K) (val V, ok bool)
  • func (m *SortedMap[K, V]) Range(cb func(K, V) (cont bool))
  • func (m *SortedMap[K, V]) Set(key K, val V)
• type UniqChecker
  • func (uc UniqChecker[T]) Add(elems ...T)
  • func (uc UniqChecker[T]) Merge(other UniqChecker[T]) (merged UniqChecker[T])
  • func (uc UniqChecker[T]) Validate() (err error)

Functions

func CoalesceSlice

func CoalesceSlice[E any, S []E](values ...S) (res S)

CoalesceSlice returns the first non-zero value. It is named after function COALESCE in SQL. If values or all its elements are empty, it returns nil.

Types

type NullBool

type NullBool uint8

NullBool is a nullable boolean. Use these in JSON requests and responses instead of pointers to bool.

const (
	NBNull NullBool = iota
	NBTrue
	NBFalse
)

NullBool values

func BoolToNullBool

func BoolToNullBool(cond bool) (nb NullBool)

BoolToNullBool converts a bool into a NullBool.

func (NullBool) MarshalJSON

func (nb NullBool) MarshalJSON() (b []byte, err error)

MarshalJSON implements the json.Marshaler interface for NullBool.

func (NullBool) String

func (nb NullBool) String() (s string)

String implements the fmt.Stringer interface for NullBool.

func (*NullBool) UnmarshalJSON

func (nb *NullBool) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implements the json.Unmarshaler interface for *NullBool.

type RingBuffer

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

RingBuffer is the implementation of ring buffer data structure.

func NewRingBuffer

func NewRingBuffer[T any](size uint) (rb *RingBuffer[T])

NewRingBuffer initializes the new instance of ring buffer. size must be greater or equal to zero.

func (*RingBuffer[T]) Append

func (rb *RingBuffer[T]) Append(e T)

Append appends an element to the buffer.

func (*RingBuffer[T]) Clear

func (rb *RingBuffer[T]) Clear()

Clear clears the buffer.

func (*RingBuffer[T]) Len

func (rb *RingBuffer[T]) Len() (l uint)

Len returns a length of the buffer.

func (*RingBuffer[T]) Range

func (rb *RingBuffer[T]) Range(cb func(T) (cont bool))

Range calls cb for each element of the buffer. If cb returns false it stops.

func (*RingBuffer[T]) ReverseRange

func (rb *RingBuffer[T]) ReverseRange(cb func(T) (cont bool))

ReverseRange calls cb for each element of the buffer in reverse order. If cb returns false it stops.

type SortedMap

type SortedMap[K comparable, V any] struct {
	// contains filtered or unexported fields
}

SortedMap is a map that keeps elements in order with internal sorting function. Must be initialised by the NewSortedMap.

func NewSortedMap

func NewSortedMap[K comparable, V any](cmp func(a, b K) (res int)) SortedMap[K, V]

NewSortedMap initializes the new instance of sorted map. cmp is a sort function to keep elements in order.

TODO(s.chzhen): Use cmp.Compare in Go 1.21.

func (*SortedMap[K, V]) Clear

func (m *SortedMap[K, V]) Clear()

Clear removes all elements from the sorted map.

func (*SortedMap[K, V]) Del

func (m *SortedMap[K, V]) Del(key K)

Del removes the value by key from the sorted map.

func (*SortedMap[K, V]) Get

func (m *SortedMap[K, V]) Get(key K) (val V, ok bool)

Get returns val by key from the sorted map.

func (*SortedMap[K, V]) Range

func (m *SortedMap[K, V]) Range(cb func(K, V) (cont bool))

Range calls cb for each element of the map, sorted by m.cmp. If cb returns false it stops.

func (*SortedMap[K, V]) Set

func (m *SortedMap[K, V]) Set(key K, val V)

Set adds val with key to the sorted map. It panics if the m is nil.

type UniqChecker

type UniqChecker[T constraints.Ordered] map[T]int64

UniqChecker allows validating uniqueness of comparable items.

TODO(a.garipov): The Ordered constraint is only really necessary in Validate. Consider ways of making this constraint comparable instead.

func (UniqChecker[T]) Add

func (uc UniqChecker[T]) Add(elems ...T)

Add adds a value to the validator. v must not be nil.

func (UniqChecker[T]) Merge

func (uc UniqChecker[T]) Merge(other UniqChecker[T]) (merged UniqChecker[T])

Merge returns a checker containing data from both uc and other.

func (UniqChecker[T]) Validate

func (uc UniqChecker[T]) Validate() (err error)

Validate returns an error enumerating all elements that aren't unique.