This is the documentation for Enlighten.

class Geo GeoBitArray

class Geo::GeoBitArray

A simple bit array wrapper, stored in an array of u32s.

Functions

Name Description
~GeoBitArray()

Basic destructor.

ClearAllItems()

Clear all bits.

ClearItem(s32)

Clear a bit.

ClearUp()

Delete any memory to reset to initial empty state.

ComputeBitArrayLength(s32)

Compute the length of the s32 array that numItems will require.

CountNumBitsSet()

Count and return the number of bits set.

GeoBitArray()

Default constructor.

GeoBitArray(const GeoBitArray &)

Copy constructor.

GetBitArray()

Read-write access to the bit array itself.

GetBitArray()

Read-only access to the bit array itself.

GetNumItems()

Read-only access to num items.

Initialise(s32)

(Re-)Construct a zeroed bit array for numItems.

operator=(const GeoBitArray &)

Assignment from another GeoBitArray.

SetItem(s32)

Set a bit.

TestItem(s32)

Test whether a bit has been set.


Geo::GeoBitArray::~GeoBitArray


public: ~GeoBitArray()


Basic destructor.


void Geo::GeoBitArray::ClearAllItems


public: void ClearAllItems()


Clear all bits.


void Geo::GeoBitArray::ClearItem


public: void ClearItem
(
    s32 itemIdx
)


Clear a bit.


void Geo::GeoBitArray::ClearUp


public: void ClearUp()


Delete any memory to reset to initial empty state.


static s32 Geo::GeoBitArray::ComputeBitArrayLength


public: s32 ComputeBitArrayLength
(
    s32 numItems
)


Compute the length of the s32 array that numItems will require.


s32 Geo::GeoBitArray::CountNumBitsSet


public: s32 CountNumBitsSet() const


Count and return the number of bits set.


Geo::GeoBitArray::GeoBitArray


public: GeoBitArray()


Default constructor.


Geo::GeoBitArray::GeoBitArray


public: GeoBitArray
(
    const GeoBitArray & bitArray
)


Copy constructor.


u32* Geo::GeoBitArray::GetBitArray


public: u32 * GetBitArray()


Read-write access to the bit array itself.


const u32* Geo::GeoBitArray::GetBitArray


public: const u32 * GetBitArray() const


Read-only access to the bit array itself.


s32 Geo::GeoBitArray::GetNumItems


public: s32 GetNumItems() const


Read-only access to num items.


bool Geo::GeoBitArray::Initialise


public: bool Initialise
(
    s32 numItems
)


(Re-)Construct a zeroed bit array for numItems.

'numItems' can be zero but not negative.

Returns

False only if the mem alloc fails.


GeoBitArray& Geo::GeoBitArray::operator=


public: GeoBitArray & operator=
(
    const GeoBitArray & bitArray
)


Assignment from another GeoBitArray.


void Geo::GeoBitArray::SetItem


public: void SetItem
(
    s32 itemIdx
)


Set a bit.


bool Geo::GeoBitArray::TestItem


public: bool TestItem
(
    s32 itemIdx
) const


Test whether a bit has been set.