SHOGUN v0.9.0
公有成员
CDynamicArrayPtr类参考

详细描述

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.

在文件DynamicArrayPtr.h28行定义。

继承图,类CDynamicArrayPtr
Inheritance graph
[图例]

所有成员的列表。

公有成员

 CDynamicArrayPtr (int32_t p_resize_granularity=128)
virtual ~CDynamicArrayPtr ()
int32_t set_granularity (int32_t g)
int32_t get_array_size (void)
int32_t get_num_elements (void) const
CSGObjectget_element (int32_t index) const
CSGObjectget_element_safe (int32_t index) const
bool set_element (CSGObject *element, int32_t index)
bool insert_element (CSGObject *element, int32_t index)
bool append_element (CSGObject *element)
void push_back (CSGObject *element)
void pop_back (void)
CSGObjectback (void)
int32_t find_element (CSGObject *element)
bool delete_element (int32_t idx)
bool resize_array (int32_t n)
CSGObject ** get_array (void)
void set_array (CSGObject **p_array, int32_t p_num_elements, int32_t array_size)
void clear_array (void)
CSGObjectoperator[] (int32_t index) const
CDynamicArrayPtroperator= (CDynamicArrayPtr &orig)
virtual const char * get_name () const

构造及析构函数文档

CDynamicArrayPtr ( int32_t  p_resize_granularity = 128)

constructor

参数:
p_resize_granularityresize granularity

在文件DynamicArrayPtr.h37行定义。

virtual ~CDynamicArrayPtr ( ) [virtual]

在文件DynamicArrayPtr.h51行定义。


成员函数文档

bool append_element ( CSGObject element)

append array element to the end of array

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

在文件DynamicArrayPtr.h118行定义。

CSGObject* back ( void  )

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

返回:
element at the end of array

在文件DynamicArrayPtr.h140行定义。

void clear_array ( void  )

clear the array (with zeros)

在文件DynamicArrayPtr.h191行定义。

bool delete_element ( int32_t  idx)

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

参数:
idxindex
返回:
if deleting was successful

在文件DynamicArrayPtr.h158行定义。

int32_t find_element ( CSGObject element)

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

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

在文件DynamicArrayPtr.h149行定义。

CSGObject** 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 !

返回:
the array

在文件DynamicArrayPtr.h176行定义。

int32_t get_array_size ( void  )

get array size (including granularity buffer)

返回:
total array size (including granularity buffer)

在文件DynamicArrayPtr.h65行定义。

CSGObject* get_element ( int32_t  index) const

get array element at index

(does NOT do bounds checking)

参数:
indexindex
返回:
array element at index

在文件DynamicArrayPtr.h82行定义。

CSGObject* get_element_safe ( int32_t  index) const

get array element at index

(does bounds checking)

参数:
indexindex
返回:
array element at index

在文件DynamicArrayPtr.h92行定义。

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

实现了CSGObject

在文件DynamicArrayPtr.h218行定义。

int32_t get_num_elements ( void  ) const

get number of elements

返回:
number of elements

在文件DynamicArrayPtr.h72行定义。

bool insert_element ( CSGObject element,
int32_t  index 
)

insert array element at index

参数:
elementelement to insert
indexindex
返回:
if setting was successful

在文件DynamicArrayPtr.h110行定义。

CDynamicArrayPtr& operator= ( CDynamicArrayPtr orig)

operator overload for array assignment

参数:
origoriginal array
返回:
new array

在文件DynamicArrayPtr.h211行定义。

CSGObject* 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

参数:
indexindex
返回:
element at index

在文件DynamicArrayPtr.h203行定义。

void pop_back ( void  )

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

在文件DynamicArrayPtr.h132行定义。

void push_back ( CSGObject element)

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

参数:
elementelement to append

在文件DynamicArrayPtr.h126行定义。

bool resize_array ( int32_t  n)

resize the array

参数:
nnew size
返回:
if resizing was successful

在文件DynamicArrayPtr.h166行定义。

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

set the array pointer and free previously allocated memory

参数:
p_arraynew array
p_num_elementslast element index + 1
array_sizenumber of elements in array

在文件DynamicArrayPtr.h185行定义。

bool set_element ( CSGObject element,
int32_t  index 
)

set array element at index

参数:
elementelement to set
indexindex
返回:
if setting was successful

在文件DynamicArrayPtr.h101行定义。

int32_t set_granularity ( int32_t  g)

set the resize granularity

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

在文件DynamicArrayPtr.h58行定义。


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

SHOGUN Machine Learning Toolbox - Documentation