# BitArray¶

from panda3d.core import BitArray

class BitArray

A dynamic array with an unlimited number of bits.

This is similar to a BitMask, except it appears to contain an infinite number of bits. You can use it very much as you would use a BitMask.

Inheritance diagram

__and__(other: BitArray)BitArray
__eq__(other: BitArray)bool
__iand__(other: BitArray)BitArray
__ilshift__(shift: int)BitArray
__init__()
__init__(param0: BitArray)
__init__(init_value: int)
__init__(from: SparseArray)
__ior__(other: BitArray)BitArray
__irshift__(shift: int)BitArray
__ixor__(other: BitArray)BitArray
__lt__(other: BitArray)bool
__ne__(other: BitArray)bool
__or__(other: BitArray)BitArray
__rshift__(shift: int)BitArray
__xor__(other: BitArray)BitArray
static allOff()BitArray

Returns a BitArray whose bits are all off.

static allOn()BitArray

Returns a BitArray with an infinite array of bits, all on.

static bit(index: int)BitArray

Returns a BitArray with only the indicated bit on.

clear()None

Sets all the bits in the BitArray off.

clearBit(index: int)None

Sets the nth bit off. If n >= getNumBits(), this automatically extends the array.

clearRange(low_bit: int, size: int)None

Sets the indicated range of bits off.

compareTo(other: BitArray)int

Returns a number less than zero if this BitArray sorts before the indicated other BitArray, greater than zero if it sorts after, or 0 if they are equivalent. This is based on the same ordering defined by operator <.

extract(low_bit: int, size: int)int

Returns a word that represents only the indicated range of bits within this BitArray, shifted to the least-significant position. size must be <= getNumBitsPerWord().

getBit(index: int)bool

Returns true if the nth bit is set, false if it is cleared. It is valid for n to increase beyond getNumBits(), but the return value getNumBits() will always be the same.

static getClassType()TypeHandle
getHighestBits()bool

Returns true if the infinite set of bits beyond getNumBits() are all on, or false of they are all off.

getHighestOffBit()int

Returns the index of the highest 0 bit in the array. Returns -1 if there are no 0 bits or if there an infinite number of 1 bits.

getHighestOnBit()int

Returns the index of the highest 1 bit in the array. Returns -1 if there are no 1 bits or if there an infinite number of 1 bits.

getLowestOffBit()int

Returns the index of the lowest 0 bit in the array. Returns -1 if there are no 0 bits.

getLowestOnBit()int

Returns the index of the lowest 1 bit in the array. Returns -1 if there are no 1 bits.

static getMaxNumBits()int
getNextHigherDifferentBit(low_bit: int)int

Returns the index of the next bit in the array, above low_bit, whose value is different that the value of low_bit. Returns low_bit again if all bits higher than low_bit have the same value.

This can be used to quickly iterate through all of the bits in the array.

getNumBits()int

Returns the current number of possibly different bits in this array. There are actually an infinite number of bits, but every bit higher than this bit will have the same value, either 0 or 1 (see getHighestBits()).

This number may grow and/or shrink automatically as needed.

static getNumBitsPerWord()int
getNumOffBits()int

Returns the number of bits that are set to 0 in the array. Returns -1 if there are an infinite number of 0 bits.

getNumOnBits()int

Returns the number of bits that are set to 1 in the array. Returns -1 if there are an infinite number of 1 bits.

getNumWords()int

Returns the number of possibly-unique words stored in the array.

getWord(n: int) → MaskType

Returns the nth word in the array. It is valid for n to be greater than getNumWords(), but the return value beyond getNumWords() will always be the same.

hasAllOf(low_bit: int, size: int)bool

Returns true if all bits in the indicated range are set, false otherwise.

hasAnyOf(low_bit: int, size: int)bool

Returns true if any bit in the indicated range is set, false otherwise.

hasBitsInCommon(other: BitArray)bool

Returns true if this BitArray has any “one” bits in common with the other one, false otherwise.

This is equivalent to (array & other) != 0, but may be faster.

static hasMaxNumBits()bool
invertInPlace()None

Inverts all the bits in the BitArray. This is equivalent to array = ~array.

isAllOn()bool

Returns true if the entire bitmask is one, false otherwise.

isZero()bool

Returns true if the entire bitmask is zero, false otherwise.

static lowerOn(on_bits: int)BitArray

Returns a BitArray whose lower on_bits bits are on.

operator(shift: int)BitArray
operator(shift: int)BitArray
output(out: ostream)None

Writes the BitArray out as a hex number. For a BitArray, this is always the same as outputHex(); it’s too confusing for the output format to change back and forth at runtime.

outputBinary(out: ostream, spaces_every: int)None

Writes the BitArray out as a binary number, with spaces every four bits.

outputHex(out: ostream, spaces_every: int)None

Writes the BitArray out as a hexadecimal number, with spaces every four digits.

static range(low_bit: int, size: int)BitArray

Returns a BitArray whose size bits, beginning at low_bit, are on.

setBit(index: int)None

Sets the nth bit on. If n >= getNumBits(), this automatically extends the array.

setBitTo(index: int, value: bool)None

Sets the nth bit either on or off, according to the indicated bool value.

setRange(low_bit: int, size: int)None

Sets the indicated range of bits on.

setRangeTo(value: bool, low_bit: int, size: int)None

Sets the indicated range of bits to either on or off.

setWord(n: int, value: int)None

Replaces the nth word in the array. If n >= getNumWords(), this automatically extends the array.

store(value: int, low_bit: int, size: int)None

Stores the indicated word into the indicated range of bits with this BitArray.

write(out: ostream, indent_level: int)None

Writes the BitArray out as a binary or a hex number, according to the number of bits.