Documentation
¶
Overview ¶
Package bag provides multiset data structures for vote collection and counting. This is the canonical bag implementation for all Lux packages. Import from: github.com/luxfi/consensus/types/bag
Index ¶
- type Bag
- func (b *Bag[T]) Add(elts ...T)
- func (b *Bag[T]) AddCount(elt T, count int)
- func (b *Bag[T]) Clone() Bag[T]
- func (b *Bag[T]) Count(elt T) int
- func (b *Bag[T]) Equals(other Bag[T]) bool
- func (b *Bag[T]) Filter(filterFunc func(T) bool) Bag[T]
- func (b *Bag[_]) Len() int
- func (b *Bag[T]) List() []T
- func (b *Bag[T]) Mode() (T, int)
- func (b *Bag[T]) PrefixedString(prefix string) string
- func (b *Bag[T]) Remove(elt T)
- func (b *Bag[_]) SetThreshold(threshold int)
- func (b *Bag[T]) Split(splitFunc func(T) bool) [2]Bag[T]
- func (b *Bag[_]) String() string
- func (b *Bag[T]) Threshold() set.Set[T]
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bag ¶
type Bag[T comparable] struct { // contains filtered or unexported fields }
Bag is a multiset for tracking votes and consensus state. It provides threshold tracking for consensus algorithms.
func (*Bag[T]) Add ¶
func (b *Bag[T]) Add(elts ...T)
Add increases the number of times each element has been seen by one.
func (*Bag[T]) AddCount ¶
AddCount increases the number of times the element has been seen by [count]. If [count] <= 0 this is a no-op.
func (*Bag[T]) Filter ¶
Filter returns a bag with the elements of this bag that return true for [filterFunc], along with their counts. For example, if X is in this bag with count 5, and filterFunc(X) returns true, then the returned bag contains X with count 5.
func (*Bag[T]) List ¶
func (b *Bag[T]) List() []T
List returns a list of unique elements that have been added. The returned list doesn't have duplicates.
func (*Bag[T]) Mode ¶
Mode returns the most common element in the bag and the count of that element. If there's a tie, any of the tied element may be returned.
func (*Bag[T]) PrefixedString ¶
PrefixedString returns a string representation with a prefix on each line
func (*Bag[_]) SetThreshold ¶
SetThreshold sets the number of times an element must be added to be contained in the threshold set. This is critical for consensus voting algorithms.
func (*Bag[T]) Split ¶
Split returns: 1. A bag containing the elements of this bag that return false for [splitFunc]. 2. A bag containing the elements of this bag that return true for [splitFunc]. Counts are preserved in the returned bags. For example, if X is in this bag with count 5, and splitFunc(X) is false, then the first returned bag has X in it with count 5.
Source Files