CList< T > Class Template Reference

List of all members.


Detailed Description

template<class T>
class CList< T >

doubly connected list for low-level-objects. use pointers to higher-level objects

Definition at line 47 of file List.h.


Public Member Functions

 CList (bool p_delete_data=false)
 ~CList ()
int get_num_elements ()
get_first_element ()
get_last_element ()
get_next_element ()
get_previous_element ()
get_current_element ()
bool append_element (T data)
bool insert_element (T data)
delete_element (void)
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)

Constructor & Destructor Documentation

template<class T>
CList< T >::CList ( bool  p_delete_data = false  ) 

constructor

Parameters:
p_delete_data if data shall be deleted

Definition at line 54 of file List.h.

template<class T>
CList< T >::~CList (  ) 

Definition at line 64 of file List.h.


Member Function Documentation

template<class T>
int CList< T >::get_num_elements (  ) 

get number of elements in list

Returns:
number of elements in list

Definition at line 83 of file List.h.

template<class T>
T CList< T >::get_first_element (  ) 

go to first element in list and return it

Returns:
first element in list or NULL if list is empty

Definition at line 89 of file List.h.

template<class T>
T CList< T >::get_last_element (  ) 

go to last element in list and return it

Returns:
last element in list or NULL if list is empty

Definition at line 104 of file List.h.

template<class T>
T CList< T >::get_next_element (  ) 

go to next element in list and return it

Returns:
next element in list or NULL if list is empty

Definition at line 119 of file List.h.

template<class T>
T CList< T >::get_previous_element (  ) 

go to previous element in list and return it

Returns:
previous element in list or NULL if list is empty

Definition at line 134 of file List.h.

template<class T>
T CList< T >::get_current_element (  ) 

get current element in list

Returns:
current element in list or NULL if not available

Definition at line 149 of file List.h.

template<class T>
T CList< T >::get_first_element ( CListElement< T > *&  p_current  ) 

go to first element in list and return it

Parameters:
p_current current list element
Returns:
first element in list or NULL if list is empty

Definition at line 166 of file List.h.

template<class T>
T CList< T >::get_last_element ( CListElement< T > *&  p_current  ) 

go to last element in list and return it

Parameters:
p_current current list element
Returns:
last element in list or NULL if list is empty

Definition at line 182 of file List.h.

template<class T>
T CList< T >::get_next_element ( CListElement< T > *&  p_current  ) 

go to next element in list and return it

Parameters:
p_current current list element
Returns:
next element in list or NULL if list is empty

Definition at line 198 of file List.h.

template<class T>
T CList< T >::get_previous_element ( CListElement< T > *&  p_current  ) 

go to previous element in list and return it

Parameters:
p_current current list element
Returns:
previous element in list or NULL if list is empty

Definition at line 214 of file List.h.

template<class T>
T CList< T >::get_current_element ( CListElement< T > *&  p_current  ) 

get current element in list

Parameters:
p_current current list element
Returns:
current element in list or NULL if not available

Definition at line 230 of file List.h.

template<class T>
bool CList< T >::append_element ( data  ) 

append element AFTER the current element

Parameters:
data data element to append
Returns:
if appending was successful

Definition at line 244 of file List.h.

template<class T>
bool CList< T >::insert_element ( data  ) 

insert element BEFORE the current element

Parameters:
data data element to insert
Returns:
if inserting was successful

Definition at line 281 of file List.h.

template<class T>
T CList< T >::delete_element ( void   ) 

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

Returns:
the elements data - if available - is returned else NULL

Definition at line 327 of file List.h.


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

SHOGUN Machine Learning Toolbox - Documentation