CDynamicArray< T >模板类参考


详细描述

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.

在文件DynamicArray.h27行定义。

继承图,类CDynamicArray< T >
Inheritance graph
[图例]

所有成员的列表。

公有成员

 CDynamicArray (int32_t p_resize_granularity=128)
virtual ~CDynamicArray ()
int32_t set_granularity (int32_t g)
int32_t get_array_size ()
int32_t get_num_elements () const
get_element (int32_t index) const
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)
int32_t find_element (T element)
bool delete_element (int32_t idx)
bool resize_array (int32_t n)
T * get_array ()
void set_array (T *p_array, int32_t p_num_elements, int32_t array_size)
void clear_array ()
operator[] (int32_t index) const
CDynamicArray< T > & operator= (CDynamicArray< T > &orig)
virtual const char * get_name () const

保护属性

int32_t resize_granularity
T * array
int32_t num_elements
int32_t last_element_idx

构造及析构函数文档

CDynamicArray ( int32_t  p_resize_granularity = 128  ) 

constructor

参数:
p_resize_granularity resize granularity

在文件DynamicArray.h34行定义。

virtual ~CDynamicArray (  )  [virtual]

在文件DynamicArray.h46行定义。


成员函数文档

bool append_element ( element  ) 

append array element to the end of array

参数:
element element to append
返回:
if setting was successful

在文件DynamicArray.h166行定义。

void clear_array (  ) 

clear the array (with zeros)

在文件DynamicArray.h275行定义。

bool delete_element ( int32_t  idx  ) 

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

参数:
idx index
返回:
if deleting was successful

在文件DynamicArray.h200行定义。

int32_t find_element ( element  ) 

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

参数:
element element to search for
返回:
index of element or -1

在文件DynamicArray.h177行定义。

T* get_array (  ) 

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 !

返回:
the array

在文件DynamicArray.h255行定义。

int32_t get_array_size (  ) 

get array size (including granularity buffer)

返回:
total array size (including granularity buffer)

在文件DynamicArray.h64行定义。

T get_element ( int32_t  index  )  const

get array element at index

(does NOT do bounds checking)

参数:
index index
返回:
array element at index

在文件DynamicArray.h85行定义。

T get_element_safe ( int32_t  index  )  const

get array element at index

(does bounds checking)

参数:
index index
返回:
array element at index

在文件DynamicArray.h97行定义。

virtual const char* get_name (  )  const [virtual]
返回:
object name

实现了CSGObject

在文件DynamicArray.h311行定义。

int32_t get_num_elements (  )  const

get number of elements

返回:
number of elements

在文件DynamicArray.h73行定义。

bool insert_element ( element,
int32_t  index 
)

insert array element at index

参数:
element element to insert
index index
返回:
if setting was successful

在文件DynamicArray.h145行定义。

CDynamicArray<T>& operator= ( CDynamicArray< T > &  orig  ) 

operator overload for array assignment

参数:
orig original array
返回:
new array

在文件DynamicArray.h300行定义。

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

参数:
index index
返回:
element at index

在文件DynamicArray.h290行定义。

bool resize_array ( int32_t  n  ) 

resize the array

参数:
n new size
返回:
if resizing was successful

在文件DynamicArray.h224行定义。

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

set the array pointer and free previously allocated memory

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

在文件DynamicArray.h266行定义。

bool set_element ( element,
int32_t  index 
)

set array element at index

参数:
element element to set
index index
返回:
if setting was successful

在文件DynamicArray.h113行定义。

int32_t set_granularity ( int32_t  g  ) 

set the resize granularity

参数:
g new granularity
返回:
what has been set (minimum is 128)

在文件DynamicArray.h53行定义。


成员数据文档

T* array [protected]

memory for dynamic array

在文件DynamicArray.h318行定义。

int32_t last_element_idx [protected]

the element in the array that has largest index

在文件DynamicArray.h324行定义。

int32_t num_elements [protected]

the number of potentially used elements in array

在文件DynamicArray.h321行定义。

int32_t resize_granularity [protected]

shrink/grow step size

在文件DynamicArray.h315行定义。


该类的文档由以下文件生成:

SHOGUN Machine Learning Toolbox - Documentation