bitarray

README

bitarray

BitArray is an efficient implementation of an array of bits (boolean array).

The implementation is based on an array of 64bit integers.

The interface offers all binary operators.

Documentation

Index

• Constants
• type BitArray
  • func New(size int) *BitArray
  • func (b *BitArray) All() *BitArray
  • func (b *BitArray) And(w *BitArray) *BitArray
  • func (b *BitArray) Clone() *BitArray
  • func (b *BitArray) Count() int
  • func (b *BitArray) Equal(w *BitArray) bool
  • func (b *BitArray) Get(index int) uint64
  • func (b *BitArray) Inverse() *BitArray
  • func (b *BitArray) Is(pos int) bool
  • func (b *BitArray) Minus(w *BitArray) *BitArray
  • func (b *BitArray) None() *BitArray
  • func (b *BitArray) Or(w *BitArray) *BitArray
  • func (b *BitArray) Set(index int) *BitArray
  • func (b *BitArray) ShiftLeft(times int) *BitArray
  • func (b *BitArray) ShiftRight(times int) *BitArray
  • func (b *BitArray) Size() int
  • func (b *BitArray) String() string
  • func (b *BitArray) StringBreak(breakLine int) string
  • func (b *BitArray) Xor(w *BitArray) *BitArray

Constants

const (
	INTSIZE = 64
)

Types

type BitArray

type BitArray struct {
	// contains filtered or unexported fields
}

func New

func New(size int) *BitArray

New returns a *BitArray with the provided size.

func (*BitArray) All

func (b *BitArray) All() *BitArray

All returns a bit array with all bits set to 1. It does not change the receiver.

func (*BitArray) And

func (b *BitArray) And(w *BitArray) *BitArray

And performs the and boolean operator on all bits. Also on the ones outside the size area.

func (*BitArray) Clone

func (b *BitArray) Clone() *BitArray

Clone creates a copy of the original bit array. It does not change the receiver.

func (*BitArray) Count

func (b *BitArray) Count() int

Count returns the number of 1 bits in the array. It sets all the bits outside the size to 0.

func (*BitArray) Equal

func (b *BitArray) Equal(w *BitArray) bool

Equal is a deep equality comparison.

func (*BitArray) Get

func (b *BitArray) Get(index int) uint64

Get returns the pos value of the bit array. It does not change the receiver.

func (*BitArray) Inverse

func (b *BitArray) Inverse() *BitArray

Inverse inverses all bits. Also the ones outside the size area.

func (*BitArray) Is

func (b *BitArray) Is(pos int) bool

Is checks if the pos bit of the bit array is 1. It does not change the receiver.

func (*BitArray) Minus

func (b *BitArray) Minus(w *BitArray) *BitArray

Minus performs the minus boolean operator on all bits. Also on the ones outside the size area.

func (*BitArray) None

func (b *BitArray) None() *BitArray

None sets all bits to 0.

func (*BitArray) Or

func (b *BitArray) Or(w *BitArray) *BitArray

Or performs the or boolean operator on all bits. Also on the ones outside the size area.

func (*BitArray) Set

func (b *BitArray) Set(index int) *BitArray

Set changes the pos bit to 1 and returns the array.

func (*BitArray) ShiftLeft

func (b *BitArray) ShiftLeft(times int) *BitArray

ShiftLeft shifts all bits times to the left. The parameter times cannot be greater than 64.

func (*BitArray) ShiftRight

func (b *BitArray) ShiftRight(times int) *BitArray

ShiftLeft shifts all bits times to the right. The parameter times cannot be greater than 64.

func (*BitArray) Size

func (b *BitArray) Size() int

Size returns the size of the bit array.

func (*BitArray) String

func (b *BitArray) String() string

String returns a string of all bits organized in 64 bits

func (*BitArray) StringBreak

func (b *BitArray) StringBreak(breakLine int) string

StringBreak returns a string of all bits inside the range organized in breakLine number of bits

func (*BitArray) Xor

func (b *BitArray) Xor(w *BitArray) *BitArray

Xor performs the xor boolean operator on all bits. Also on the ones outside the size area.