Irrlicht 3D Engine
irr::core::array< T, TAlloc > Class Template Reference

Self reallocating template array (like stl vector) with additional features. More...

#include <irrArray.h>

Public Types

typedef TAlloc allocator_type
 
typedef u32 size_type
 
typedef T value_type
 

Public Member Functions

 array ()
 Default constructor for empty array. More...
 
 array (u32 start_count)
 Constructs an array and allocates an initial chunk of memory. More...
 
 array (const array< T, TAlloc > &other)
 Copy constructor. More...
 
 ~array ()
 Destructor. More...
 
u32 allocated_size () const
 Get amount of memory allocated. More...
 
s32 binary_search (const T &element)
 Performs a binary search for an element, returns -1 if not found. More...
 
s32 binary_search (const T &element) const
 Performs a binary search for an element if possible, returns -1 if not found. More...
 
s32 binary_search (const T &element, s32 left, s32 right) const
 Performs a binary search for an element, returns -1 if not found. More...
 
s32 binary_search_multi (const T &element, s32 &last)
 
void clear ()
 Clears the array and deletes all allocated memory. More...
 
const T * const_pointer () const
 Gets a const pointer to the array. More...
 
bool empty () const
 Check if array is empty. More...
 
void erase (u32 index)
 Erases an element from the array. More...
 
void erase (u32 index, s32 count)
 Erases some elements from the array. More...
 
T & getLast ()
 Gets last element. More...
 
const T & getLast () const
 Gets last element. More...
 
void insert (const T &element, u32 index=0)
 Insert item into array at specified position. More...
 
s32 linear_reverse_search (const T &element) const
 Finds an element in linear time, which is very slow. More...
 
s32 linear_search (const T &element) const
 Finds an element in linear time, which is very slow. More...
 
bool operator != (const array< T, TAlloc > &other) const
 Inequality operator. More...
 
T & operator [] (u32 index)
 Direct access operator. More...
 
const T & operator [] (u32 index) const
 Direct const access operator. More...
 
const array< T, TAlloc > & operator= (const array< T, TAlloc > &other)
 Assignment operator. More...
 
bool operator== (const array< T, TAlloc > &other) const
 Equality operator. More...
 
T * pointer ()
 Gets a pointer to the array. More...
 
void push_back (const T &element)
 Adds an element at back of array. More...
 
void push_front (const T &element)
 Adds an element at the front of the array. More...
 
void reallocate (u32 new_size, bool canShrink=true)
 Reallocates the array, make it bigger or smaller. More...
 
void set_free_when_destroyed (bool f)
 Sets if the array should delete the memory it uses upon destruction. More...
 
void set_pointer (T *newPointer, u32 size, bool _is_sorted=false, bool _free_when_destroyed=true)
 Sets pointer to new array, using this as new workspace. More...
 
void set_sorted (bool _is_sorted)
 Sets if the array is sorted. More...
 
void set_used (u32 usedNow)
 Sets the size of the array and allocates new elements if necessary. More...
 
void setAllocStrategy (eAllocStrategy newStrategy=ALLOC_STRATEGY_DOUBLE)
 set a new allocation strategy More...
 
u32 size () const
 Get number of occupied elements of the array. More...
 
void sort ()
 Sorts the array using heapsort. More...
 
void swap (array< T, TAlloc > &other)
 Swap the content of this array container with the content of another array. More...
 

Detailed Description

template<class T, typename TAlloc = irrAllocator<T>>
class irr::core::array< T, TAlloc >

Self reallocating template array (like stl vector) with additional features.

Some features are: Heap sorting, binary search methods, easier debugging.

Definition at line 22 of file irrArray.h.

Member Typedef Documentation

◆ allocator_type

template<class T, typename TAlloc = irrAllocator<T>>
typedef TAlloc irr::core::array< T, TAlloc >::allocator_type

Definition at line 607 of file irrArray.h.

◆ size_type

template<class T, typename TAlloc = irrAllocator<T>>
typedef u32 irr::core::array< T, TAlloc >::size_type

Definition at line 609 of file irrArray.h.

◆ value_type

template<class T, typename TAlloc = irrAllocator<T>>
typedef T irr::core::array< T, TAlloc >::value_type

Definition at line 608 of file irrArray.h.

Constructor & Destructor Documentation

◆ array() [1/3]

template<class T, typename TAlloc = irrAllocator<T>>
irr::core::array< T, TAlloc >::array ( )
inline

Default constructor for empty array.

Definition at line 28 of file irrArray.h.

◆ array() [2/3]

template<class T, typename TAlloc = irrAllocator<T>>
irr::core::array< T, TAlloc >::array ( u32  start_count)
inlineexplicit

Constructs an array and allocates an initial chunk of memory.

Parameters
start_countAmount of elements to pre-allocate.

Definition at line 36 of file irrArray.h.

◆ array() [3/3]

template<class T, typename TAlloc = irrAllocator<T>>
irr::core::array< T, TAlloc >::array ( const array< T, TAlloc > &  other)
inline

Copy constructor.

Definition at line 45 of file irrArray.h.

◆ ~array()

template<class T, typename TAlloc = irrAllocator<T>>
irr::core::array< T, TAlloc >::~array ( )
inline

Destructor.

Frees allocated memory, if set_free_when_destroyed was not set to false by the user before.

Definition at line 54 of file irrArray.h.

Member Function Documentation

◆ allocated_size()

template<class T, typename TAlloc = irrAllocator<T>>
u32 irr::core::array< T, TAlloc >::allocated_size ( ) const
inline

Get amount of memory allocated.

Returns
Amount of memory allocated. The amount of bytes allocated would be allocated_size() * sizeof(ElementTypeUsed);

Definition at line 373 of file irrArray.h.

◆ binary_search() [1/3]

template<class T, typename TAlloc = irrAllocator<T>>
s32 irr::core::array< T, TAlloc >::binary_search ( const T &  element)
inline

Performs a binary search for an element, returns -1 if not found.

The array will be sorted before the binary search if it is not already sorted. Caution is advised! Be careful not to call this on unsorted const arrays, or the slower method will be used.

Parameters
elementElement to search for.
Returns
Position of the searched element if it was found, otherwise -1 is returned.

Definition at line 405 of file irrArray.h.

Referenced by irr::core::array< u16 >::binary_search(), and irr::core::array< u16 >::binary_search_multi().

◆ binary_search() [2/3]

template<class T, typename TAlloc = irrAllocator<T>>
s32 irr::core::array< T, TAlloc >::binary_search ( const T &  element) const
inline

Performs a binary search for an element if possible, returns -1 if not found.

This method is for const arrays and so cannot call sort(), if the array is not sorted then linear_search will be used instead. Potentially very slow!

Parameters
elementElement to search for.
Returns
Position of the searched element if it was found, otherwise -1 is returned.

Definition at line 418 of file irrArray.h.

◆ binary_search() [3/3]

template<class T, typename TAlloc = irrAllocator<T>>
s32 irr::core::array< T, TAlloc >::binary_search ( const T &  element,
s32  left,
s32  right 
) const
inline

Performs a binary search for an element, returns -1 if not found.

Parameters
elementElement to search for.
leftFirst left index
rightLast right index.
Returns
Position of the searched element if it was found, otherwise -1 is returned.

Definition at line 433 of file irrArray.h.

◆ binary_search_multi()

template<class T, typename TAlloc = irrAllocator<T>>
s32 irr::core::array< T, TAlloc >::binary_search_multi ( const T &  element,
s32 last 
)
inline

Performs a binary search for an element, returns -1 if not found. it is used for searching a multiset The array will be sorted before the binary search if it is not already sorted.

Parameters
elementElement to search for.
&lastreturn lastIndex of equal elements
Returns
Position of the first searched element if it was found, otherwise -1 is returned.

Definition at line 471 of file irrArray.h.

◆ clear()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::clear ( )
inline

◆ const_pointer()

template<class T, typename TAlloc = irrAllocator<T>>
const T* irr::core::array< T, TAlloc >::const_pointer ( ) const
inline

◆ empty()

template<class T, typename TAlloc = irrAllocator<T>>
bool irr::core::array< T, TAlloc >::empty ( ) const
inline

Check if array is empty.

Returns
True if the array is empty false if not.

Definition at line 381 of file irrArray.h.

Referenced by irr::scene::SSharedMeshBuffer::recalculateBoundingBox(), and irr::scene::CMeshBuffer< T >::recalculateBoundingBox().

◆ erase() [1/2]

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::erase ( u32  index)
inline

Erases an element from the array.

May be slow, because all elements following after the erased element have to be copied.

Parameters
indexIndex of element to be erased.

Definition at line 532 of file irrArray.h.

◆ erase() [2/2]

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::erase ( u32  index,
s32  count 
)
inline

Erases some elements from the array.

May be slow, because all elements following after the erased element have to be copied.

Parameters
indexIndex of the first element to be erased.
countAmount of elements to be erased.

Definition at line 553 of file irrArray.h.

◆ getLast() [1/2]

template<class T, typename TAlloc = irrAllocator<T>>
T& irr::core::array< T, TAlloc >::getLast ( )
inline

Gets last element.

Definition at line 329 of file irrArray.h.

◆ getLast() [2/2]

template<class T, typename TAlloc = irrAllocator<T>>
const T& irr::core::array< T, TAlloc >::getLast ( ) const
inline

Gets last element.

Definition at line 338 of file irrArray.h.

◆ insert()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::insert ( const T &  element,
u32  index = 0 
)
inline

Insert item into array at specified position.

Parameters
elementElement to be inserted
indexWhere position to insert the new element.

Definition at line 132 of file irrArray.h.

Referenced by irr::core::array< u16 >::push_back(), and irr::core::array< u16 >::push_front().

◆ linear_reverse_search()

template<class T, typename TAlloc = irrAllocator<T>>
s32 irr::core::array< T, TAlloc >::linear_reverse_search ( const T &  element) const
inline

Finds an element in linear time, which is very slow.

Use binary_search for faster finding. Only works if ==operator is implemented.

Parameters
elementElement to search for.
Returns
Position of the searched element if it was found, otherwise -1 is returned.

Definition at line 518 of file irrArray.h.

◆ linear_search()

template<class T, typename TAlloc = irrAllocator<T>>
s32 irr::core::array< T, TAlloc >::linear_search ( const T &  element) const
inline

Finds an element in linear time, which is very slow.

Use binary_search for faster finding. Only works if ==operator is implemented.

Parameters
elementElement to search for.
Returns
Position of the searched element if it was found, otherwise -1 is returned.

Definition at line 502 of file irrArray.h.

Referenced by irr::core::array< u16 >::binary_search().

◆ operator !=()

template<class T, typename TAlloc = irrAllocator<T>>
bool irr::core::array< T, TAlloc >::operator != ( const array< T, TAlloc > &  other) const
inline

Inequality operator.

Definition at line 304 of file irrArray.h.

◆ operator []() [1/2]

template<class T, typename TAlloc = irrAllocator<T>>
T& irr::core::array< T, TAlloc >::operator [] ( u32  index)
inline

Direct access operator.

Definition at line 311 of file irrArray.h.

◆ operator []() [2/2]

template<class T, typename TAlloc = irrAllocator<T>>
const T& irr::core::array< T, TAlloc >::operator [] ( u32  index) const
inline

Direct const access operator.

Definition at line 320 of file irrArray.h.

◆ operator=()

template<class T, typename TAlloc = irrAllocator<T>>
const array<T, TAlloc>& irr::core::array< T, TAlloc >::operator= ( const array< T, TAlloc > &  other)
inline

Assignment operator.

Definition at line 263 of file irrArray.h.

◆ operator==()

template<class T, typename TAlloc = irrAllocator<T>>
bool irr::core::array< T, TAlloc >::operator== ( const array< T, TAlloc > &  other) const
inline

Equality operator.

Definition at line 291 of file irrArray.h.

◆ pointer()

template<class T, typename TAlloc = irrAllocator<T>>
T* irr::core::array< T, TAlloc >::pointer ( )
inline

◆ push_back()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::push_back ( const T &  element)
inline

Adds an element at back of array.

If the array is too small to add this new element it is made bigger.

Parameters
elementElement to add at the back of the array.

Definition at line 111 of file irrArray.h.

Referenced by irr::scene::CMeshBuffer< T >::append(), irr::scene::quake3::getAsStringList(), irr::scene::quake3::getTextures(), and irr::video::IRenderTarget::setTexture().

◆ push_front()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::push_front ( const T &  element)
inline

Adds an element at the front of the array.

If the array is to small to add this new element, the array is made bigger. Please note that this is slow, because the whole array needs to be copied for this.

Parameters
elementElement to add at the back of the array.

Definition at line 122 of file irrArray.h.

◆ reallocate()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::reallocate ( u32  new_size,
bool  canShrink = true 
)
inline

Reallocates the array, make it bigger or smaller.

Parameters
new_sizeNew size of array.
canShrinkSpecifies whether the array is reallocated even if enough space is available. Setting this flag to false can speed up array usage, but may use more memory than required by the data.

Definition at line 66 of file irrArray.h.

Referenced by irr::scene::CMeshBuffer< T >::append(), irr::core::array< u16 >::array(), irr::core::array< u16 >::insert(), and irr::core::array< u16 >::set_used().

◆ set_free_when_destroyed()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::set_free_when_destroyed ( bool  f)
inline

Sets if the array should delete the memory it uses upon destruction.

Also clear and set_pointer will only delete the (original) memory area if this flag is set to true, which is also the default. The methods reallocate, set_used, push_back, push_front, insert, and erase will still try to deallocate the original memory, which might cause troubles depending on the intended use of the memory area.

Parameters
fIf true, the array frees the allocated memory in its destructor, otherwise not. The default is true.

Definition at line 243 of file irrArray.h.

◆ set_pointer()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::set_pointer ( T *  newPointer,
u32  size,
bool  _is_sorted = false,
bool  _free_when_destroyed = true 
)
inline

Sets pointer to new array, using this as new workspace.

Make sure that set_free_when_destroyed is used properly.

Parameters
newPointerPointer to new array of elements.
sizeSize of the new array.
_is_sortedFlag which tells whether the new array is already sorted.
_free_when_destroyedSets whether the new memory area shall be freed by the array upon destruction, or if this will be up to the user application.

Definition at line 224 of file irrArray.h.

◆ set_sorted()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::set_sorted ( bool  _is_sorted)
inline

Sets if the array is sorted.

Definition at line 580 of file irrArray.h.

◆ set_used()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::set_used ( u32  usedNow)
inline

Sets the size of the array and allocates new elements if necessary.

Please note: This is only secure when using it with simple types, because no default constructor will be called for the added elements.

Parameters
usedNowAmount of elements now used.

Definition at line 253 of file irrArray.h.

◆ setAllocStrategy()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::setAllocStrategy ( eAllocStrategy  newStrategy = ALLOC_STRATEGY_DOUBLE)
inline

set a new allocation strategy

if the maximum size of the array is unknown, you can define how big the allocation should happen.

Parameters
newStrategyNew strategy to apply to this array.

Definition at line 102 of file irrArray.h.

◆ size()

◆ sort()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::sort ( )
inline

Sorts the array using heapsort.

There is no additional memory waste and the algorithm performs O(n*log n) in worst case.

Definition at line 390 of file irrArray.h.

Referenced by irr::core::array< u16 >::binary_search(), and irr::core::array< u16 >::binary_search_multi().

◆ swap()

template<class T, typename TAlloc = irrAllocator<T>>
void irr::core::array< T, TAlloc >::swap ( array< T, TAlloc > &  other)
inline

Swap the content of this array container with the content of another array.

Afterward this object will contain the content of the other object and the other object will contain the content of this object.

Parameters
otherSwap content with this object

Definition at line 590 of file irrArray.h.


The documentation for this class was generated from the following file: