CDynamicArray< T > Class Template Reference

---

Detailed Description

template<class T>
class shogun::CDynamicArray< T >

Template Dynamic array class that creates an array that can be used like a list or an array.

It grows and shrinks dynamically, while elements can be accessed via index. It is performance tuned for simple types like float etc. and for hi-level objects only stores pointers, which are not automagically SG_REF'd/deleted.

Definition at line 28 of file DynamicArray.h.

Inheritance diagram for CDynamicArray< T >:

List of all members.

Public Member Functions
	CDynamicArray (int32_t p_resize_granularity=128)
virtual	~CDynamicArray ()
int32_t	set_granularity (int32_t g)
int32_t	get_array_size (void)
int32_t	get_num_elements (void) const
T	get_element (int32_t index) const
T	get_element_safe (int32_t index) const
bool	set_element (T element, int32_t index)
bool	insert_element (T element, int32_t index)
bool	append_element (T element)
void	push_back (T element)
void	pop_back (void)
T	back (void)
int32_t	find_element (T element)
bool	delete_element (int32_t idx)
bool	resize_array (int32_t n)
T *	get_array (void)
void	set_array (T *p_array, int32_t p_num_elements, int32_t array_size)
void	clear_array (void)
T	operator[] (int32_t index) const
CDynamicArray< T > &	operator= (CDynamicArray< T > &orig)
virtual const char *	get_name () const

---

Constructor & Destructor Documentation

CDynamicArray

(

int32_t

p_resize_granularity = 128

)

constructor

Parameters:

p_resize_granularity

resize granularity

Definition at line 37 of file DynamicArray.h.

virtual ~CDynamicArray

(

)

[virtual]

Definition at line 53 of file DynamicArray.h.

---

Member Function Documentation

bool append_element

(

T

element

)

append array element to the end of array

Parameters:

element

element to append

Returns:

if setting was successful

Definition at line 120 of file DynamicArray.h.

T back

(

void

)

STD::VECTOR compatible. Return array element at the end of array.

Returns:

element at the end of array

Definition at line 142 of file DynamicArray.h.

void clear_array

(

void

)

clear the array (with zeros)

Definition at line 192 of file DynamicArray.h.

bool delete_element

(

int32_t

idx

)

delete array element at idx (does not call delete[] or the like)

Parameters:

idx

index

Returns:

if deleting was successful

Definition at line 160 of file DynamicArray.h.

int32_t find_element

(

T

element

)

find first occurence of array element and return its index or -1 if not available

Parameters:

element

element to search for

Returns:

index of element or -1

Definition at line 151 of file DynamicArray.h.

T* get_array

(

void

)

get the array call get_array just before messing with it DO NOT call any [],resize/delete functions after get_array(), the pointer may become invalid !

Returns:

the array

Definition at line 178 of file DynamicArray.h.

int32_t get_array_size

(

void

)

get array size (including granularity buffer)

Returns:

total array size (including granularity buffer)

Definition at line 67 of file DynamicArray.h.

T get_element

(

int32_t

index

)

const

get array element at index

(does NOT do bounds checking)

Parameters:

index

index

Returns:

array element at index

Definition at line 84 of file DynamicArray.h.

T get_element_safe

(

int32_t

index

)

const

get array element at index

(does bounds checking)

Parameters:

index

index

Returns:

array element at index

Definition at line 94 of file DynamicArray.h.

virtual const char* get_name

(

void

)

const [virtual]

Returns:

object name

Implements CSGObject.

Definition at line 219 of file DynamicArray.h.

int32_t get_num_elements

(

void

)

const

get number of elements

Returns:

number of elements

Definition at line 74 of file DynamicArray.h.

bool insert_element	(	T	element,
		int32_t	index
	)

insert array element at index

Parameters:

	element	element to insert
	index	index

Returns:

if setting was successful

Definition at line 112 of file DynamicArray.h.

CDynamicArray<T>& operator=

(

CDynamicArray< T > &

orig

)

operator overload for array assignment

Parameters:

orig

original array

Returns:

new array

Definition at line 212 of file DynamicArray.h.

T operator[]

(

int32_t

index

)

const

operator overload for array read only access use set_element() for write access (will also make the array dynamically grow)

DOES NOT DO ANY BOUNDS CHECKING

Parameters:

index

index

Returns:

element at index

Definition at line 204 of file DynamicArray.h.

void pop_back

(

void

)

STD::VECTOR compatible. Delete array element at the end of array.

Definition at line 134 of file DynamicArray.h.

void push_back

(

T

element

)

STD::VECTOR compatible. Append array element to the end of array.

Parameters:

element

element to append

Definition at line 128 of file DynamicArray.h.

bool resize_array

(

int32_t

n

)

resize the array

Parameters:

n

new size

Returns:

if resizing was successful

Definition at line 168 of file DynamicArray.h.

void set_array	(	T *	p_array,
		int32_t	p_num_elements,
		int32_t	array_size
	)

set the array pointer and free previously allocated memory

Parameters:

	p_array	new array
	p_num_elements	last element index + 1
	array_size	number of elements in array

Definition at line 187 of file DynamicArray.h.

bool set_element	(	T	element,
		int32_t	index
	)

set array element at index

Parameters:

	element	element to set
	index	index

Returns:

if setting was successful

Definition at line 103 of file DynamicArray.h.

int32_t set_granularity

(

int32_t

g

)

set the resize granularity

Parameters:

g

new granularity

Returns:

what has been set (minimum is 128)

Definition at line 60 of file DynamicArray.h.

---

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

• DynamicArray.h