bitutils

Documentation

Index

• func ClearBit(b []byte, i int)
• func MakeBitVector(numberBits int) []byte
• func MinimalByteSliceLength(n int) int
• func ReadBit(b []byte, idx int) int
• func SetBit(b []byte, i int)
• func WriteBit(b []byte, i int, value int)

Functions

func ClearBit

func ClearBit(b []byte, i int)

ClearBit clears the bit at index `i` in the byte slice `b`, i.e. it assigns value 0 to the bit. The function panics, if the byte slice is too short.

func MakeBitVector

func MakeBitVector(numberBits int) []byte

MakeBitVector allocates a byte slice of minimal size that can hold numberBits.

func MinimalByteSliceLength

func MinimalByteSliceLength(n int) int

MinimalByteSliceLength returns the minimal length of a byte slice that can store n bits.

func ReadBit

func ReadBit(b []byte, idx int) int

ReadBit returns the bit at index `idx` in the byte array `b` (big endian) The function panics, if the byte slice is too short.

func SetBit

func SetBit(b []byte, i int)

SetBit sets the bit at index `i` in the byte array `b`, i.e. it assigns value 1 to the bit. The function panics, if the byte slice is too short.

func WriteBit

func WriteBit(b []byte, i int, value int)

WriteBit assigns value `v` to the bit at index `i` in the byte array `b`. The function panics, if the byte slice is too short. We follow the common convention of converting between integer and boolean/bit values:

• int value == 0 <=> false <=> bit 0
• int value != 0 <=> true <=> bit 1