This is the documentation for Enlighten.
class Geo GeoAutoReleaseArray
template<typename T>
class Geo::GeoAutoReleaseArray
Adaptor to allow storing of IGeoReleasable pointers in a container (calls Release() on each pointer upon array destruction)
Functions
Name | Description |
|---|---|
Destructor calls destructor on all elements in the array and frees the memory. | |
Non constant access to final entry. | |
Constant access to final entry. | |
Return iterator similar to vector::begin() | |
Return iterator similar to vector::begin() | |
Remove all elements from the array. | |
Remove all elements from the array. | |
Returns true if the array contains x. | |
Insert an element at the specified index, elements already in the array at that index and above are shuffled up. | |
Add the specified element to the end of the array. | |
Fast version of push that doesn't do any checking in release. | |
Inserts elem at index, and moves whatever is currently at the index to the end of the array, thus not preserving order or existing indices. | |
Return iterator similar to vector::end() | |
Return iterator similar to vector::end() | |
Constant access to final entry. | |
Non constant access to final entry. | |
Construct an empty array with the default capacity. | |
Construct a copy of the specified array - The compiler must be able to resolve T = CompatT. | |
Construct a copy of the specified array - The compiler must be able to resolve T = CompatT. | |
Construct with the specified value replicated numCopies times. | |
Move constructor. | |
Construct a copy of the specified array. | |
Construct an empty array with the default capacity. | |
Remove all elements from the array. | |
Give access to the internal array. | |
Remove all elements from the array. | |
Returns the number of array entries available at the moment. | |
Memory used for array storage. | |
Return the number of array entries currently in use. | |
Common initialisation code called by all constructors. | |
Insert an element at the specified index, elements already in the array at that index and above are shuffled up. | |
Insert an element at the specified index, elements already in the array at that index and above are shuffled up. | |
Inserts elem at index, and moves whatever is currently at the index to the end of the array, thus not preserving order or existing indices. | |
Inserts elem at index, and moves whatever is currently at the index to the end of the array, thus not preserving order or existing indices. | |
Returns true if the array is empty. | |
Returns true if the array is full. | |
Constant array access. | |
Non constant array access. | |
Assignment operator. | |
Assignment operator - The compiler must be able to resolve T = CompatT. | |
Move assignment operator. | |
Remove the element with the highest index (if there is one) | |
Fast version of pop that doesn't do any checking in release. | |
Add the specified element to the end of the array. | |
Add the specified element to the end of the array. | |
Fast version of push that doesn't do any checking in release. | |
Fast version of push that doesn't do any checking in release. | |
Remove the element at the specified index, elements at higher indices are shuffled down. | |
Moves the end of the array into the element to be removed, thus not preserving order or existing indices. | |
Resize the array. | |
Resize the array. | |
Ensure sufficient capacity for Resize operations. | |
Change the array's capacity, reallocating memory if the new capacity is different to the current capacity. | |
Swap the contents of two arrays. |
Typedefs
Name | Description |
|---|---|
const T * const_iterator | The simplest possible const_iterator type (a raw pointer). |
T * iterator | The simplest possible iterator type (a raw pointer). |
T ValueType | Alias for our storage type. |
Variables
Geo::GeoArray< T >::~GeoArray
public: ~GeoArray()
Destructor calls destructor on all elements in the array and frees the memory.
ValueType& Geo::GeoArray< T >::Back
public: ValueType & Back()
Non constant access to final entry.
const ValueType& Geo::GeoArray< T >::Back
public: const ValueType & Back() const
Constant access to final entry.
ValueType* Geo::GeoArray< T >::Begin
public: ValueType * Begin()
Return iterator similar to vector::begin()
const ValueType* Geo::GeoArray< T >::Begin
public: const ValueType * Begin() const
Return iterator similar to vector::begin()
void Geo::GeoArray< T >::Clear
public: void Clear()
Remove all elements from the array.
The capacity of the array remains unchanged, which means that no memory is deallocated.
void Geo::GeoAutoReleaseArray< T >::Clear
public: void Clear()
Remove all elements from the array.
bool Geo::GeoArray< T >::Contains
public: bool Contains
(
const T & x
) const
Returns true if the array contains x.
void Geo::GeoArray< T >::Emplace
public: void Emplace
(
s32 index,
U && elem
)
Insert an element at the specified index, elements already in the array at that index and above are shuffled up.
bool Geo::GeoArray< T >::EmplaceBack
public: bool EmplaceBack
(
U && elem
)
Add the specified element to the end of the array.
void Geo::GeoArray< T >::EmplaceBackFast
protected: void EmplaceBackFast
(
U && elem
)
Fast version of push that doesn't do any checking in release.
void Geo::GeoArray< T >::EmplaceFast
public: void EmplaceFast
(
s32 index,
U && elem
)
Inserts elem at index, and moves whatever is currently at the index to the end of the array, thus not preserving order or existing indices.
ValueType* Geo::GeoArray< T >::End
public: ValueType * End()
Return iterator similar to vector::end()
const ValueType* Geo::GeoArray< T >::End
public: const ValueType * End() const
Return iterator similar to vector::end()
const ValueType& Geo::GeoArray< T >::Front
public: const ValueType & Front() const
Constant access to final entry.
ValueType& Geo::GeoArray< T >::Front
public: ValueType & Front()
Non constant access to final entry.
Geo::GeoArray< T >::GeoArray
public: GeoArray
(
s32 initCapacity
)
Construct an empty array with the default capacity.
Geo::GeoArray< T >::GeoArray
public: GeoArray
(
const GeoArray< CompatT > & srcArray
)
Construct a copy of the specified array - The compiler must be able to resolve T = CompatT.
Geo::GeoArray< T >::GeoArray
public: GeoArray
(
const CompatT * srcArray,
s32 length
)
Construct a copy of the specified array - The compiler must be able to resolve T = CompatT.
Geo::GeoArray< T >::GeoArray
public: GeoArray
(
s32 numCopies,
const T & value
)
Construct with the specified value replicated numCopies times.
Geo::GeoArray< T >::GeoArray
public: GeoArray
(
GeoArray && srcArray
)
Move constructor.
Geo::GeoArray< T >::GeoArray
public: GeoArray
(
const GeoArray & srcArray
)
Construct a copy of the specified array.
Geo::GeoAutoReleaseArray< T >::GeoAutoReleaseArray
public: GeoAutoReleaseArray
(
s32 initCapacity
)
Construct an empty array with the default capacity.
const ValueType* Geo::GeoArray< T >::GetArray
public: const ValueType * GetArray() const
Remove all elements from the array.
The capacity of the array remains unchanged, which means that no memory is deallocated.
ValueType* Geo::GeoArray< T >::GetArray
public: ValueType * GetArray()
Give access to the internal array.
const ValueType* Geo::GeoArray< T >::GetArrayConst
public: const ValueType * GetArrayConst() const
Remove all elements from the array.
The capacity of the array remains unchanged, which means that no memory is deallocated.
s32 Geo::GeoArray< T >::GetCapacity
public: s32 GetCapacity() const
Returns the number of array entries available at the moment.
s32 Geo::GeoArray< T >::GetMemoryUsage
public: s32 GetMemoryUsage() const
Memory used for array storage.
s32 Geo::GeoArray< T >::GetSize
public: s32 GetSize() const
Return the number of array entries currently in use.
bool Geo::GeoArray< T >::Init
protected: bool Init
(
s32 initCapacity
)
Common initialisation code called by all constructors.