1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
|
package bitfield
import (
"encoding/binary"
"math/bits"
)
var _ = Bitfield(Bitvector128{})
// Bitvector128 is a bitfield with a fixed defined size of 128. There is no length bit
// present in the underlying byte array.
type Bitvector128 []byte
const bitvector128ByteSize = 16
const bitvector128BitSize = bitvector128ByteSize * 8
// NewBitvector128 creates a new bitvector of size 128.
func NewBitvector128() Bitvector128 {
byteArray := [bitvector128ByteSize]byte{}
return byteArray[:]
}
// BitAt returns the bit value at the given index. If the index requested
// exceeds the number of bits in the bitvector, then this method returns false.
func (b Bitvector128) BitAt(idx uint64) bool {
// Out of bounds, must be false.
if idx >= b.Len() || len(b) != bitvector128ByteSize {
return false
}
i := uint8(1 << (idx % 8))
return b[idx/8]&i == i
}
// SetBitAt will set the bit at the given index to the given value. If the index
// requested exceeds the number of bits in the bitvector, then this method returns
// false.
func (b Bitvector128) SetBitAt(idx uint64, val bool) {
// Out of bounds, do nothing.
if idx >= b.Len() || len(b) != bitvector128ByteSize {
return
}
bit := uint8(1 << (idx % 8))
if val {
b[idx/8] |= bit
} else {
b[idx/8] &^= bit
}
}
// Len returns the number of bits in the bitvector.
func (b Bitvector128) Len() uint64 {
return bitvector128BitSize
}
// Count returns the number of 1s in the bitvector.
func (b Bitvector128) Count() uint64 {
if len(b) == 0 {
return 0
}
c := 0
for i, bt := range b {
if i >= bitvector128ByteSize {
break
}
c += bits.OnesCount8(bt)
}
return uint64(c)
}
// Bytes returns the bytes data representing the Bitvector128.
func (b Bitvector128) Bytes() []byte {
if len(b) == 0 {
return []byte{}
}
ln := min(len(b), bitvector128ByteSize)
ret := make([]byte, ln)
copy(ret, b[:ln])
return ret[:]
}
// Shift bitvector by i. If i >= 0, perform left shift, otherwise right shift.
func (b Bitvector128) Shift(i int) {
if len(b) == 0 {
return
}
// Shifting greater than 128 bits is pointless and can have unexpected behavior.
if i > bitvector128BitSize {
i = bitvector128BitSize
} else if i < -bitvector128BitSize {
i = -bitvector128BitSize
}
if i >= 0 {
num := binary.BigEndian.Uint64(b)
num <<= uint8(i)
binary.BigEndian.PutUint64(b, num)
} else {
num := binary.BigEndian.Uint64(b)
num >>= uint8(i * -1)
binary.BigEndian.PutUint64(b, num)
}
}
// BitIndices returns the list of indices that are set to 1.
func (b Bitvector128) BitIndices() []int {
indices := make([]int, 0, bitvector128BitSize)
for i, bt := range b {
if i >= bitvector128ByteSize {
break
}
for j := 0; j < 8; j++ {
bit := byte(1 << uint(j))
if bt&bit == bit {
indices = append(indices, i*8+j)
}
}
}
return indices
}
// Contains returns true if the bitlist contains all of the bits from the provided argument
// bitlist. This method will return an error if bitlists are not the same length.
func (b Bitvector128) Contains(c Bitvector128) (bool, error) {
if b.Len() != c.Len() {
return false, ErrBitvectorDifferentLength
}
// To ensure all of the bits in c are present in b, we iterate over every byte, combine
// the byte from b and c, then XOR them against b. If the result of this is non-zero, then we
// are assured that a byte in c had bits not present in b.
for i := 0; i < len(b); i++ {
if b[i]^(b[i]|c[i]) != 0 {
return false, nil
}
}
return true, nil
}
// Overlaps returns true if the bitlist contains one of the bits from the provided argument
// bitlist. This method will return an error if bitlists are not the same length.
func (b Bitvector128) Overlaps(c Bitvector128) (bool, error) {
lenB, lenC := b.Len(), c.Len()
if b.Len() != c.Len() {
return false, ErrBitvectorDifferentLength
}
if lenB == 0 || lenC == 0 {
return false, nil
}
// To ensure all of the bits in c are not overlapped in b, we iterate over every byte, invert b
// and xor the byte from b and c, then and it against c. If the result is non-zero, then
// we can be assured that byte in c had bits not overlapped in b.
for i := 0; i < len(b); i++ {
// If this byte is the last byte in the array, mask the length bit.
mask := uint8(0xFF)
if (^b[i]^c[i])&c[i]&mask != 0 {
return true, nil
}
}
return false, nil
}
// Or returns the OR result of the two bitfields. This method will return an error if the bitlists are not the same length.
func (b Bitvector128) Or(c Bitvector128) (Bitvector128, error) {
if b.Len() != c.Len() {
return nil, ErrBitvectorDifferentLength
}
ret := make([]byte, len(b))
for i := 0; i < len(b); i++ {
ret[i] = b[i] | c[i]
}
return ret, nil
}
|