Panda3D
|
A dynamic array with an unlimited number of bits. More...
#include <pandadoc.hpp>
Public Types | |
enum | { num_bits_per_word = 64 } |
Public Member Functions | |
object | __getstate__ () |
__init__ () | |
__init__ (BitArray::WordType init_value) | |
__init__ (const BitArray) | |
__init__ (const SparseArray from) | |
__setstate__ (object state) | |
clear () | |
Sets all the bits in the BitArray off. More... | |
clearBit (int index) | |
Sets the nth bit off. More... | |
clearRange (int low_bit, int size) | |
Sets the indicated range of bits off. More... | |
int | compareTo (const BitArray other) |
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. More... | |
BitArray::WordType | extract (int low_bit, int size) |
Returns a word that represents only the indicated range of bits within this BitArray, shifted to the least-significant position. More... | |
bool | getBit (int index) |
Returns true if the nth bit is set, false if it is cleared. More... | |
bool | getHighestBits () |
Returns true if the infinite set of bits beyond get_num_bits() are all on, or false of they are all off. More... | |
int | getHighestOffBit () |
Returns the index of the highest 0 bit in the array. More... | |
int | getHighestOnBit () |
Returns the index of the highest 1 bit in the array. More... | |
int | getLowestOffBit () |
Returns the index of the lowest 0 bit in the array. More... | |
int | getLowestOnBit () |
Returns the index of the lowest 1 bit in the array. More... | |
int | getNextHigherDifferentBit (int low_bit) |
Returns the index of the next bit in the array, above low_bit, whose value is different that the value of low_bit. More... | |
int | getNumBits () |
Returns the current number of possibly different bits in this array. More... | |
int | getNumOffBits () |
Returns the number of bits that are set to 0 in the array. More... | |
int | getNumOnBits () |
Returns the number of bits that are set to 1 in the array. More... | |
int | getNumWords () |
Returns the number of possibly-unique words stored in the array. More... | |
BitArray::MaskType | getWord (int n) |
Returns the nth word in the array. More... | |
bool | hasAllOf (int low_bit, int size) |
Returns true if all bits in the indicated range are set, false otherwise. More... | |
bool | hasAnyOf (int low_bit, int size) |
Returns true if any bit in the indicated range is set, false otherwise. More... | |
bool | hasBitsInCommon (const BitArray other) |
Returns true if this BitArray has any "one" bits in common with the other one, false otherwise. More... | |
invertInPlace () | |
Inverts all the bits in the BitArray. More... | |
bool | isAllOn () |
Returns true if the entire bitmask is one, false otherwise. More... | |
bool | isZero () |
Returns true if the entire bitmask is zero, false otherwise. More... | |
bool | operator!= (const BitArray other) |
BitArray | operator& (const BitArray other) |
BitArray | operator&= (const BitArray other) |
bool | operator< (const BitArray other) |
BitArray | operator<< (int shift) |
BitArray | operator<<= (int shift) |
bool | operator== (const BitArray other) |
BitArray | operator>> (int shift) |
BitArray | operator>>= (int shift) |
BitArray | operator^ (const BitArray other) |
BitArray | operator^= (const BitArray other) |
BitArray | operator| (const BitArray other) |
BitArray | operator|= (const BitArray other) |
BitArray | operator~ () |
output (Ostream out) | |
Writes the BitArray out as a hex number. More... | |
outputBinary (Ostream out, int spaces_every) | |
Writes the BitArray out as a binary number, with spaces every four bits. More... | |
outputHex (Ostream out, int spaces_every) | |
Writes the BitArray out as a hexadecimal number, with spaces every four digits. More... | |
setBit (int index) | |
Sets the nth bit on. More... | |
setBitTo (int index, bool value) | |
Sets the nth bit either on or off, according to the indicated bool value. More... | |
setRange (int low_bit, int size) | |
Sets the indicated range of bits on. More... | |
setRangeTo (bool value, int low_bit, int size) | |
Sets the indicated range of bits to either on or off. More... | |
setWord (int n, BitArray::WordType value) | |
Replaces the nth word in the array. More... | |
store (BitArray::WordType value, int low_bit, int size) | |
Stores the indicated word into the indicated range of bits with this BitArray. More... | |
write (Ostream out, int indent_level) | |
Writes the BitArray out as a binary or a hex number, according to the number of bits. More... | |
Static Public Member Functions | |
static BitArray | allOff () |
Returns a BitArray whose bits are all off. More... | |
static BitArray | allOn () |
Returns a BitArray with an infinite array of bits, all on. More... | |
static BitArray | bit (int index) |
Returns a BitArray with only the indicated bit on. More... | |
static TypeHandle | getClassType () |
static int | getMaxNumBits () |
static int | getNumBitsPerWord () |
static bool | hasMaxNumBits () |
static BitArray | lowerOn (int on_bits) |
Returns a BitArray whose lower on_bits bits are on. More... | |
static BitArray | range (int low_bit, int size) |
Returns a BitArray whose size bits, beginning at low_bit, are on. More... | |
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.
object __getstate__ | ( | ) |
__init__ | ( | ) |
__init__ | ( | BitArray::WordType | init_value | ) |
__init__ | ( | const | BitArray | ) |
__init__ | ( | const SparseArray | from | ) |
__setstate__ | ( | object | state | ) |
clear | ( | ) |
Sets all the bits in the BitArray off.
clearBit | ( | int | index | ) |
Sets the nth bit off.
If n >= get_num_bits(), this automatically extends the array.
clearRange | ( | int | low_bit, |
int | size | ||
) |
Sets the indicated range of bits off.
int compareTo | ( | const BitArray | other | ) |
BitArray::WordType extract | ( | int | low_bit, |
int | size | ||
) |
Returns a word that represents only the indicated range of bits within this BitArray, shifted to the least-significant position.
size must be <= get_num_bits_per_word().
bool getBit | ( | int | index | ) |
Returns true if the nth bit is set, false if it is cleared.
It is valid for n to increase beyond get_num_bits(), but the return value get_num_bits() will always be the same.
|
static |
bool getHighestBits | ( | ) |
Returns true if the infinite set of bits beyond get_num_bits() are all on, or false of they are all off.
int getHighestOffBit | ( | ) |
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.
int getHighestOnBit | ( | ) |
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.
int getLowestOffBit | ( | ) |
Returns the index of the lowest 0 bit in the array.
Returns -1 if there are no 0 bits.
int getLowestOnBit | ( | ) |
Returns the index of the lowest 1 bit in the array.
Returns -1 if there are no 1 bits.
|
static |
int getNextHigherDifferentBit | ( | int | low_bit | ) |
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.
int getNumBits | ( | ) |
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 get_highest_bits()).
This number may grow and/or shrink automatically as needed.
|
static |
int getNumOffBits | ( | ) |
Returns the number of bits that are set to 0 in the array.
Returns -1 if there are an infinite number of 0 bits.
int getNumOnBits | ( | ) |
Returns the number of bits that are set to 1 in the array.
Returns -1 if there are an infinite number of 1 bits.
int getNumWords | ( | ) |
Returns the number of possibly-unique words stored in the array.
BitArray::MaskType getWord | ( | int | n | ) |
Returns the nth word in the array.
It is valid for n to be greater than get_num_words(), but the return value beyond get_num_words() will always be the same.
bool hasAllOf | ( | int | low_bit, |
int | size | ||
) |
Returns true if all bits in the indicated range are set, false otherwise.
bool hasAnyOf | ( | int | low_bit, |
int | size | ||
) |
Returns true if any bit in the indicated range is set, false otherwise.
bool hasBitsInCommon | ( | const BitArray | other | ) |
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 |
invertInPlace | ( | ) |
Inverts all the bits in the BitArray.
This is equivalent to array = ~array.
bool isAllOn | ( | ) |
Returns true if the entire bitmask is one, false otherwise.
bool isZero | ( | ) |
Returns true if the entire bitmask is zero, false otherwise.
bool operator!= | ( | const BitArray | other | ) |
bool operator< | ( | const BitArray | other | ) |
BitArray operator<< | ( | int | shift | ) |
BitArray operator<<= | ( | int | shift | ) |
bool operator== | ( | const BitArray | other | ) |
BitArray operator>> | ( | int | shift | ) |
BitArray operator>>= | ( | int | shift | ) |
BitArray operator~ | ( | ) |
output | ( | Ostream | out | ) |
outputBinary | ( | Ostream | out, |
int | spaces_every | ||
) |
Writes the BitArray out as a binary number, with spaces every four bits.
outputHex | ( | Ostream | out, |
int | spaces_every | ||
) |
Writes the BitArray out as a hexadecimal number, with spaces every four digits.
|
static |
Returns a BitArray whose size bits, beginning at low_bit, are on.
setBit | ( | int | index | ) |
Sets the nth bit on.
If n >= get_num_bits(), this automatically extends the array.
setBitTo | ( | int | index, |
bool | value | ||
) |
Sets the nth bit either on or off, according to the indicated bool value.
setRange | ( | int | low_bit, |
int | size | ||
) |
Sets the indicated range of bits on.
setRangeTo | ( | bool | value, |
int | low_bit, | ||
int | size | ||
) |
Sets the indicated range of bits to either on or off.
setWord | ( | int | n, |
BitArray::WordType | value | ||
) |
Replaces the nth word in the array.
If n >= get_num_words(), this automatically extends the array.
store | ( | BitArray::WordType | value, |
int | low_bit, | ||
int | size | ||
) |
Stores the indicated word into the indicated range of bits with this BitArray.