README
¶
bitset
This package implements a bitset in Go. By a bitset, I mean a structure that encodes true/false values as 1/0 inside bytes. Eight boolean values should be accomodated by one byte using this structure.
To allow for large bitsets, the constructor asks for a number of bits you wish to contain, and then constructs a []byte with size suitable to hold this number.
Values are encoded in a little endian fashion: in a single bytes, bits would be indexes as 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0. Callers need not concern themselves with this implementation detail: getting, setting and unsetting bits is done through functions.
There are three main functions:
SetBitN(n) which sets the bit at position n to 1 (true)
UnsetBitN(n) which sets the bit at position n to 0 (false)
GetBitN(n) which gets the bit as position n and returns it as a bool (1 = true, 0 = false)
For those wishing to visualize the layout of bits, a convenience function called DumpBitSet is provided.
Documentation
¶
Overview ¶
Package bitset implements getting and setting of true/false values within bytes.
Index ¶
Constants ¶
const (
WIDTH = 8
)
According to the Go spec, byte = uint8, so we set our byte width to 8 here
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BitSet ¶
type BitSet struct {
// contains filtered or unexported fields
}
BitSet is simply an array of bytes large enough to contain the number of bits the user requests. Values are encoded in a little endian fashion: in a single bytes, bits would be indexes as 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0. Callers need not concern themselves with this implementation detail: getting, setting and unsetting bits is done through functions.
func (*BitSet) DumpBitSet ¶
DumpBitSet will return a string form of the BitSet.
func (*BitSet) GetBitN ¶
GetBitN will read bit n as either true (1) or false (0). Error if n is not indexable in this BitSet.
Source Files