CList< T >模板类参考


详细描述

template<class T>
class shogun::CList< T >

Class List implements a doubly connected list for low-level-objects.

For higher level objects pointers should be used. The list supports calling delete() of an object that is to be removed from the list.

在文件List.h54行定义。

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

所有成员的列表。

公有成员

 CList (bool p_delete_data=false)
virtual ~CList ()
int32_t get_num_elements ()
get_first_element ()
get_last_element ()
get_next_element ()
get_previous_element ()
get_current_element ()
bool append_element (T data)
bool append_element_at_listend (T data)
bool insert_element (T data)
delete_element (void)
virtual const char * get_name () const
thread safe list access functions



get_first_element (CListElement< T > *&p_current)
get_last_element (CListElement< T > *&p_current)
get_next_element (CListElement< T > *&p_current)
get_previous_element (CListElement< T > *&p_current)
get_current_element (CListElement< T > *&p_current)

构造及析构函数文档

CList ( bool  p_delete_data = false  ) 

constructor

参数:
p_delete_data if data shall be deleted

在文件List.h61行定义。

virtual ~CList (  )  [virtual]

在文件List.h71行定义。


成员函数文档

bool append_element ( data  ) 

append element AFTER the current element

参数:
data data element to append
返回:
if appending was successful

在文件List.h276行定义。

bool append_element_at_listend ( data  ) 

append at end of list

参数:
data data element to append
返回:
if appending was successful

在文件List.h319行定义。

T delete_element ( void   ) 

erases current element the new current element is the successor of the former current element

返回:
the elements data - if available - is returned else NULL

在文件List.h382行定义。

T get_current_element ( CListElement< T > *&  p_current  ) 

get current element in list

参数:
p_current current list element
返回:
current element in list or NULL if not available

在文件List.h258行定义。

T get_current_element (  ) 

get current element in list

返回:
current element in list or NULL if not available

在文件List.h165行定义。

T get_first_element ( CListElement< T > *&  p_current  ) 

go to first element in list and return it

参数:
p_current current list element
返回:
first element in list or NULL if list is empty

在文件List.h186行定义。

T get_first_element (  ) 

go to first element in list and return it

返回:
first element in list or NULL if list is empty

在文件List.h97行定义。

T get_last_element ( CListElement< T > *&  p_current  ) 

go to last element in list and return it

参数:
p_current current list element
返回:
last element in list or NULL if list is empty

在文件List.h204行定义。

T get_last_element (  ) 

go to last element in list and return it

返回:
last element in list or NULL if list is empty

在文件List.h114行定义。

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

实现了CSGObject

在文件List.h421行定义。

T get_next_element ( CListElement< T > *&  p_current  ) 

go to next element in list and return it

参数:
p_current current list element
返回:
next element in list or NULL if list is empty

在文件List.h222行定义。

T get_next_element (  ) 

go to next element in list and return it

返回:
next element in list or NULL if list is empty

在文件List.h131行定义。

int32_t get_num_elements (  ) 

get number of elements in list

返回:
number of elements in list

在文件List.h91行定义。

T get_previous_element ( CListElement< T > *&  p_current  ) 

go to previous element in list and return it

参数:
p_current current list element
返回:
previous element in list or NULL if list is empty

在文件List.h240行定义。

T get_previous_element (  ) 

go to previous element in list and return it

返回:
previous element in list or NULL if list is empty

在文件List.h148行定义。

bool insert_element ( data  ) 

insert element BEFORE the current element

参数:
data data element to insert
返回:
if inserting was successful

在文件List.h333行定义。


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

SHOGUN Machine Learning Toolbox - Documentation