bitset

README

bitset

This is a simple implementation of a bitset.

Documentation

Index

• type Binary
• type Bitset
• type Inspect
• type Size
• type Value

Types

type Binary

type Binary[V Value, S Bitset[V]] interface {
	And(b S) (aAndB S) // self
	Or(b S) (aOrB S)   // self
}

Binary are chainable binary operations over bitsets of the same type. these functions are not expected to modify A or B, and S is also meant to conform to Binary[V, S Bitset[V]]

type Bitset

type Bitset[V Value] interface {
	Get(index V) bool

	Set(indices ...V)
	Unset(indices ...V)

	Clear()
}

Basic functionality of a bitset implementation

type Inspect

type Inspect[V Value] interface {
	Size
	Pop() uint
}

Population count & size. TODO: move 'Pop' to Bitset proper?

type Size

type Size interface {
	// int and not uint for consistency's sake :(
	Len() int
	Cap() int
}

Size-related inspection referring to the underlying bitset data storage

type Value

type Value interface {
	constraints.Unsigned |
		~rune // this is int32, but no runes are actually negative.
}