SparseArray

from panda3d.core import SparseArray
class SparseArray

Bases: DTOOL_SUPER_BASE

This class records a set of integers, where each integer is either present or not present in the set.

It is similar in principle and in interface to a BitArray (which can be thought of as a set of integers, one integer corresponding to each different bit position), but the SparseArray is implemented as a list of min/max subrange lists, rather than as a bitmask.

This makes it particularly efficient for storing sets which consist of large sections of consecutively included or consecutively excluded elements, with arbitrarily large integers, but particularly inefficient for doing boolean operations such as & or |.

Also, unlike BitArray, the SparseArray can store negative integers.

Inheritance diagram

Inheritance diagram of SparseArray

__init__(*args, **kwargs)
allOff()

C++ Interface: all_off()

/**

  • Returns a SparseArray whose bits are all off.

*/

allOn()

C++ Interface: all_on()

/**

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

*/

all_off()

C++ Interface: all_off()

/**

  • Returns a SparseArray whose bits are all off.

*/

all_on()

C++ Interface: all_on()

/**

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

*/

bit()

C++ Interface: bit(int index)

/**

  • Returns a SparseArray with only the indicated bit on.

*/

clear()

C++ Interface: clear(const SparseArray self)

/**

  • Sets all the bits in the SparseArray off.

*/

clearBit()

C++ Interface: clear_bit(const SparseArray self, int index)

/**

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

  • the array.

*/

clearRange()

C++ Interface: clear_range(const SparseArray self, int low_bit, int size)

/**

  • Sets the indicated range of bits off.

*/

clear_bit()

C++ Interface: clear_bit(const SparseArray self, int index)

/**

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

  • the array.

*/

clear_range()

C++ Interface: clear_range(const SparseArray self, int low_bit, int size)

/**

  • Sets the indicated range of bits off.

*/

compareTo()

C++ Interface: compare_to(SparseArray self, const SparseArray other)

/**

  • Returns a number less than zero if this SparseArray sorts before the

  • indicated other SparseArray, greater than zero if it sorts after, or 0 if

  • they are equivalent. This is based on the same ordering defined by

  • operator <.

*/

compare_to()

C++ Interface: compare_to(SparseArray self, const SparseArray other)

/**

  • Returns a number less than zero if this SparseArray sorts before the

  • indicated other SparseArray, greater than zero if it sorts after, or 0 if

  • they are equivalent. This is based on the same ordering defined by

  • operator <.

*/

getBit()

C++ Interface: get_bit(SparseArray self, 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.

*/

getClassType()

C++ Interface: get_class_type()

getHighestBits()

C++ Interface: get_highest_bits(SparseArray self)

/**

  • Returns true if the infinite set of bits beyond get_num_bits() are all on,

  • or false of they are all off.

*/

getHighestOffBit()

C++ Interface: get_highest_off_bit(SparseArray self)

/**

  • 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()

C++ Interface: get_highest_on_bit(SparseArray self)

/**

  • 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()

C++ Interface: get_lowest_off_bit(SparseArray self)

/**

  • Returns the index of the lowest 0 bit in the array. Returns -1 if there

  • are no 0 bits or if there are an infinite number of 1 bits.

*/

getLowestOnBit()

C++ Interface: get_lowest_on_bit(SparseArray self)

/**

  • Returns the index of the lowest 1 bit in the array. Returns -1 if there

  • are no 1 bits and 0 if there are an infinite number of 1 bits.

*/

getMaxNumBits()

C++ Interface: get_max_num_bits()

/**

  • If get_max_num_bits() returned true, this method may be called to return

  • the maximum number of bits that may be stored in this structure. It is an

  • error to call this if get_max_num_bits() return false.

  • It is always an error to call this method. The SparseArray has no maximum

  • number of bits. This method is defined so generic programming algorithms

  • can use BitMask or SparseArray interchangeably.

*/

getNextHigherDifferentBit()

C++ Interface: get_next_higher_different_bit(SparseArray self, 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.

*/

getNumBits()

C++ Interface: get_num_bits(SparseArray self)

/**

  • 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.

*/

getNumOffBits()

C++ Interface: get_num_off_bits(SparseArray self)

/**

  • 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()

C++ Interface: get_num_on_bits(SparseArray self)

/**

  • Returns the number of bits that are set to 1 in the array. Returns -1 if

  • there are an infinite number of 1 bits.

*/

getNumSubranges()

C++ Interface: get_num_subranges(SparseArray self)

/**

  • Returns the number of separate subranges stored in the SparseArray. You

  • can use this limit to iterate through the subranges, calling

  • get_subrange_begin() and get_subrange_end() for each one.

  • Also see is_inverse().

*/

getSubrangeBegin()

C++ Interface: get_subrange_begin(SparseArray self, int n)

/**

  • Returns the first numeric element in the nth subrange.

  • Also see is_inverse().

*/

getSubrangeEnd()

C++ Interface: get_subrange_end(SparseArray self, int n)

/**

  • Returns the last numeric element, plus one, in the nth subrange.

  • Also see is_inverse().

*/

get_bit()

C++ Interface: get_bit(SparseArray self, 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.

*/

get_class_type()

C++ Interface: get_class_type()

get_highest_bits()

C++ Interface: get_highest_bits(SparseArray self)

/**

  • Returns true if the infinite set of bits beyond get_num_bits() are all on,

  • or false of they are all off.

*/

get_highest_off_bit()

C++ Interface: get_highest_off_bit(SparseArray self)

/**

  • 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.

*/

get_highest_on_bit()

C++ Interface: get_highest_on_bit(SparseArray self)

/**

  • 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.

*/

get_lowest_off_bit()

C++ Interface: get_lowest_off_bit(SparseArray self)

/**

  • Returns the index of the lowest 0 bit in the array. Returns -1 if there

  • are no 0 bits or if there are an infinite number of 1 bits.

*/

get_lowest_on_bit()

C++ Interface: get_lowest_on_bit(SparseArray self)

/**

  • Returns the index of the lowest 1 bit in the array. Returns -1 if there

  • are no 1 bits and 0 if there are an infinite number of 1 bits.

*/

get_max_num_bits()

C++ Interface: get_max_num_bits()

/**

  • If get_max_num_bits() returned true, this method may be called to return

  • the maximum number of bits that may be stored in this structure. It is an

  • error to call this if get_max_num_bits() return false.

  • It is always an error to call this method. The SparseArray has no maximum

  • number of bits. This method is defined so generic programming algorithms

  • can use BitMask or SparseArray interchangeably.

*/

get_next_higher_different_bit()

C++ Interface: get_next_higher_different_bit(SparseArray self, 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.

*/

get_num_bits()

C++ Interface: get_num_bits(SparseArray self)

/**

  • 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.

*/

get_num_off_bits()

C++ Interface: get_num_off_bits(SparseArray self)

/**

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

  • there are an infinite number of 0 bits.

*/

get_num_on_bits()

C++ Interface: get_num_on_bits(SparseArray self)

/**

  • Returns the number of bits that are set to 1 in the array. Returns -1 if

  • there are an infinite number of 1 bits.

*/

get_num_subranges()

C++ Interface: get_num_subranges(SparseArray self)

/**

  • Returns the number of separate subranges stored in the SparseArray. You

  • can use this limit to iterate through the subranges, calling

  • get_subrange_begin() and get_subrange_end() for each one.

  • Also see is_inverse().

*/

get_subrange_begin()

C++ Interface: get_subrange_begin(SparseArray self, int n)

/**

  • Returns the first numeric element in the nth subrange.

  • Also see is_inverse().

*/

get_subrange_end()

C++ Interface: get_subrange_end(SparseArray self, int n)

/**

  • Returns the last numeric element, plus one, in the nth subrange.

  • Also see is_inverse().

*/

hasAllOf()

C++ Interface: has_all_of(SparseArray self, int low_bit, int size)

/**

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

*/

hasAnyOf()

C++ Interface: has_any_of(SparseArray self, int low_bit, int size)

/**

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

*/

hasBitsInCommon()

C++ Interface: has_bits_in_common(SparseArray self, const SparseArray other)

/**

  • Returns true if this SparseArray has any “one” bits in common with the

  • other one, false otherwise.

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

*/

hasMaxNumBits()

C++ Interface: has_max_num_bits()

/**

  • Returns true if there is a maximum number of bits that may be stored in

  • this structure, false otherwise. If this returns true, the number may be

  • queried in get_max_num_bits().

  • This method always returns false. The SparseArray has no maximum number of

  • bits. This method is defined so generic programming algorithms can use

  • BitMask or SparseArray interchangeably.

*/

has_all_of()

C++ Interface: has_all_of(SparseArray self, int low_bit, int size)

/**

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

*/

has_any_of()

C++ Interface: has_any_of(SparseArray self, int low_bit, int size)

/**

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

*/

has_bits_in_common()

C++ Interface: has_bits_in_common(SparseArray self, const SparseArray other)

/**

  • Returns true if this SparseArray has any “one” bits in common with the

  • other one, false otherwise.

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

*/

has_max_num_bits()

C++ Interface: has_max_num_bits()

/**

  • Returns true if there is a maximum number of bits that may be stored in

  • this structure, false otherwise. If this returns true, the number may be

  • queried in get_max_num_bits().

  • This method always returns false. The SparseArray has no maximum number of

  • bits. This method is defined so generic programming algorithms can use

  • BitMask or SparseArray interchangeably.

*/

invertInPlace()

C++ Interface: invert_in_place(const SparseArray self)

/**

  • Inverts all the bits in the SparseArray. This is equivalent to array =

  • ~array.

*/

invert_in_place()

C++ Interface: invert_in_place(const SparseArray self)

/**

  • Inverts all the bits in the SparseArray. This is equivalent to array =

  • ~array.

*/

isAllOn()

C++ Interface: is_all_on(SparseArray self)

/**

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

*/

isInverse()

C++ Interface: is_inverse(SparseArray self)

/**

  • If this is true, the SparseArray is actually defined as a list of subranges

  • of integers that are not in the set. If this is false (the default),

  • then the subranges define the integers that are in the set. This affects

  • the interpretation of the values returned by iterating through

  • get_num_subranges().

*/

isZero()

C++ Interface: is_zero(SparseArray self)

/**

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

*/

is_all_on()

C++ Interface: is_all_on(SparseArray self)

/**

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

*/

is_inverse()

C++ Interface: is_inverse(SparseArray self)

/**

  • If this is true, the SparseArray is actually defined as a list of subranges

  • of integers that are not in the set. If this is false (the default),

  • then the subranges define the integers that are in the set. This affects

  • the interpretation of the values returned by iterating through

  • get_num_subranges().

*/

is_zero()

C++ Interface: is_zero(SparseArray self)

/**

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

*/

lowerOn()

C++ Interface: lower_on(int on_bits)

/**

  • Returns a SparseArray whose lower on_bits bits are on.

*/

lower_on()

C++ Interface: lower_on(int on_bits)

/**

  • Returns a SparseArray whose lower on_bits bits are on.

*/

output()

C++ Interface: output(SparseArray self, ostream out)

/**

*/

range()

C++ Interface: range(int low_bit, int size)

/**

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

*/

setBit()

C++ Interface: set_bit(const SparseArray self, int index)

/**

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

  • the array.

*/

setBitTo()

C++ Interface: set_bit_to(const SparseArray self, int index, bool value)

/**

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

*/

setRange()

C++ Interface: set_range(const SparseArray self, int low_bit, int size)

/**

  • Sets the indicated range of bits on.

*/

setRangeTo()

C++ Interface: set_range_to(const SparseArray self, bool value, int low_bit, int size)

/**

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

*/

set_bit()

C++ Interface: set_bit(const SparseArray self, int index)

/**

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

  • the array.

*/

set_bit_to()

C++ Interface: set_bit_to(const SparseArray self, int index, bool value)

/**

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

*/

set_range()

C++ Interface: set_range(const SparseArray self, int low_bit, int size)

/**

  • Sets the indicated range of bits on.

*/

set_range_to()

C++ Interface: set_range_to(const SparseArray self, bool value, int low_bit, int size)

/**

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

*/