MILIST< _LIT > Class Template Reference

#include <mi32/milist.h>

Inheritance diagram for MILIST< _LIT >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

CONST_ITERATOR Begin () const
ITERATOR Begin ()
void Clear ()
bool Contains (const _LIT &item) const
CONST_ITERATOR End () const
ITERATOR End ()
ITERATOR Find (const _LIT &item)
CONST_ITERATOR Find (const _LIT &item) const
_LIT & GetBack ()
const _LIT & GetBack () const
_LIT & GetFront ()
const _LIT & GetFront () const
_LIT & GetIndexed (int index)
const _LIT & GetIndexed (int index) const
INT32 GetNumItems () const
_LIT & Insert (ITERATOR p, const _LIT &item)
bool IsEmpty () const
bool IsEqual (const MILIST< _LIT > &rhs) const
void Lower (ITERATOR it)
void Merge (MILIST< _LIT > &other)
 MILIST (const MILIST< _LIT > &rhs)
 MILIST ()
void MoveToBack (ITERATOR it)
void MoveToFront (ITERATOR it)
MILIST< _LIT > & operator= (const MILIST< _LIT > &rhs)
void PopBack ()
void PopFront ()
_LIT & PushBack (const _LIT &item)
_LIT & PushFront (const _LIT &item)
void Raise (ITERATOR it)
void Remove (ITERATOR start, ITERATOR end)
void Remove (ITERATOR it)
void RemoveDuplicates ()
void RemovePos (int pos)
void Reverse ()
CONST_ITERATOR ReverseBegin () const
ITERATOR ReverseBegin ()
CONST_ITERATOR ReverseEnd () const
ITERATOR ReverseEnd ()
void Sort (bool(*PredFunc)(const _LIT &lhs, const _LIT &rhs))
template<class _Pr1> void Sort (_Pr1 _Pr)
void Sort ()
 ~MILIST ()

template<class _LIT>
class MILIST< _LIT >


Constructor & Destructor Documentation

template<class _LIT>
MILIST< _LIT >::MILIST  )  [inline]
 

Constructor for an empty list.

Deliberate MmAllocC instead of new

Definition at line 227 of file milist.h.

template<class _LIT>
MILIST< _LIT >::MILIST const MILIST< _LIT > &  rhs  )  [inline]
 

Copy constructor.

Deliberate MmAllocC instead of new

Definition at line 234 of file milist.h.

template<class _LIT>
MILIST< _LIT >::~MILIST  )  [inline]
 

Destructor.

Definition at line 245 of file milist.h.


Member Function Documentation

template<class _LIT>
CONST_ITERATOR MILIST< _LIT >::Begin  )  const [inline]
 

Return a CONST_ITERATOR that refers to the beginning of the list.

Definition at line 269 of file milist.h.

template<class _LIT>
ITERATOR MILIST< _LIT >::Begin  )  [inline]
 

Return an ITERATOR that refers to the beginning of the list.

Definition at line 265 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::Clear  )  [inline]
 

Remove all entries from the list.

Definition at line 273 of file milist.h.

template<class _LIT>
bool MILIST< _LIT >::Contains const _LIT &  item  )  const [inline]
 

Determine if specified item is contained in list.

This does a linear search of the list, so consider efficiency implications when using. List item must support equality comparison operator.

Definition at line 279 of file milist.h.

template<class _LIT>
CONST_ITERATOR MILIST< _LIT >::End  )  const [inline]
 

Return a CONST_ITERATOR that refers to the end of the list, not a valid list item.

Definition at line 317 of file milist.h.

template<class _LIT>
ITERATOR MILIST< _LIT >::End  )  [inline]
 

Return an ITERATOR that refers to the end of the list, not a valid list item.

Definition at line 313 of file milist.h.

template<class _LIT>
ITERATOR MILIST< _LIT >::Find const _LIT &  item  )  [inline]
 

Find item in list (non-const).

Returns:
ITERATOR for item, will reference End() if not found.

Definition at line 302 of file milist.h.

template<class _LIT>
CONST_ITERATOR MILIST< _LIT >::Find const _LIT &  item  )  const [inline]
 

Find item in list.

Returns:
CONST_ITERATOR for item, will reference End() if not found.

Definition at line 290 of file milist.h.

template<class _LIT>
_LIT& MILIST< _LIT >::GetBack  )  [inline]
 

Return a reference to a _LIT item from the front of the list.

Definition at line 325 of file milist.h.

template<class _LIT>
const _LIT& MILIST< _LIT >::GetBack  )  const [inline]
 

Return a reference to a const _LIT item from the front of the list.

Definition at line 321 of file milist.h.

template<class _LIT>
_LIT& MILIST< _LIT >::GetFront  )  [inline]
 

Return a reference to a _LIT item from the front of the list.

Definition at line 333 of file milist.h.

template<class _LIT>
const _LIT& MILIST< _LIT >::GetFront  )  const [inline]
 

Return a reference to a const _LIT item from the front of the list.

Definition at line 329 of file milist.h.

template<class _LIT>
_LIT& MILIST< _LIT >::GetIndexed int  index  )  [inline]
 

Get item at specified index.

Note that this will iterate through the list to the specified index and thus should be used with care.

Definition at line 350 of file milist.h.

template<class _LIT>
const _LIT& MILIST< _LIT >::GetIndexed int  index  )  const [inline]
 

Get item at specified index.

Note that this will iterate through the list to the specified index and thus should be used with care.

Definition at line 339 of file milist.h.

template<class _LIT>
INT32 MILIST< _LIT >::GetNumItems  )  const [inline]
 

Return the number of items in the list.

Definition at line 359 of file milist.h.

template<class _LIT>
_LIT& MILIST< _LIT >::Insert ITERATOR  p,
const _LIT &  item
[inline]
 

Insert an item into the place BEFORE the iterator.

Returns:
Reference to new item in list (not same as 'item' parameter as will be copied).

Definition at line 364 of file milist.h.

template<class _LIT>
bool MILIST< _LIT >::IsEmpty  )  const [inline]
 

Determine if any list entries exist.

Definition at line 379 of file milist.h.

template<class _LIT>
bool MILIST< _LIT >::IsEqual const MILIST< _LIT > &  rhs  )  const [inline]
 

Determine equality with another list of same type.

Definition at line 383 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::Lower ITERATOR  it  )  [inline]
 

Moves the item referenced by the iterator toward the beginning of the list.

Definition at line 394 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::Merge MILIST< _LIT > &  other  )  [inline]
 

Merge two lists together, the list copied from is cleared, does not sort.

Definition at line 405 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::MoveToBack ITERATOR  it  )  [inline]
 

Moves the item referenced by the iterator to the back of the list.

Definition at line 430 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::MoveToFront ITERATOR  it  )  [inline]
 

Moves the item referenced by the iterator to the front of the list.

Definition at line 439 of file milist.h.

template<class _LIT>
MILIST<_LIT>& MILIST< _LIT >::operator= const MILIST< _LIT > &  rhs  )  [inline]
 

Assignment operator.

Definition at line 252 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::PopBack  )  [inline]
 

Remove the last item from the list.

Definition at line 464 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::PopFront  )  [inline]
 

Remove an item from the beginning of the list.

Definition at line 454 of file milist.h.

template<class _LIT>
_LIT& MILIST< _LIT >::PushBack const _LIT &  item  )  [inline]
 

Insert an item on the end of the list.

Returns:
Reference to new item in list (not same as 'item' parameter as will be copied).

Definition at line 459 of file milist.h.

template<class _LIT>
_LIT& MILIST< _LIT >::PushFront const _LIT &  item  )  [inline]
 

Insert an item at the beginning of the list.

Returns:
Reference to new item in list (not same as 'item' parameter as will be copied).

Definition at line 449 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::Raise ITERATOR  it  )  [inline]
 

Moves the item referenced by the iterator toward the end of the list.

Definition at line 468 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::Remove ITERATOR  start,
ITERATOR  end
[inline]
 

Remove a range of items from the list.

Parameters:
start  Iterator for first item to remove
end  Ending item, exclusive, will not be removed

Definition at line 488 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::Remove ITERATOR  it  )  [inline]
 

Remove item specified by ITERATOR from the list.

Do not use the specified iterator after using this method as it will be invalid.

Definition at line 480 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::RemoveDuplicates  )  [inline]
 

Remove duplicate entries.

Definition at line 498 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::RemovePos int  pos  )  [inline]
 

Remove item at specified position.

Parameters:
pos  Position starting at 0 for beginning of list

Definition at line 516 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::Reverse  )  [inline]
 

Reverse order of items in list.

Definition at line 526 of file milist.h.

template<class _LIT>
CONST_ITERATOR MILIST< _LIT >::ReverseBegin  )  const [inline]
 

Return a CONST_ITERATOR that refers to the end of the list.

Definition at line 543 of file milist.h.

template<class _LIT>
ITERATOR MILIST< _LIT >::ReverseBegin  )  [inline]
 

Return an ITERATOR that refers to the end of the list.

Definition at line 539 of file milist.h.

template<class _LIT>
CONST_ITERATOR MILIST< _LIT >::ReverseEnd  )  const [inline]
 

Return a CONST_ITERATOR that refers to the end of the list, not a valid list item.

Definition at line 551 of file milist.h.

template<class _LIT>
ITERATOR MILIST< _LIT >::ReverseEnd  )  [inline]
 

Return an ITERATOR that refers to the end of the list, not a valid list item.

Definition at line 547 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::Sort bool(*  PredFunc)(const _LIT &lhs, const _LIT &rhs)  )  [inline]
 

Sort the list in operator< () order.

Definition at line 601 of file milist.h.

template<class _LIT>
template<class _Pr1>
void MILIST< _LIT >::Sort _Pr1  _Pr  )  [inline]
 

Sort the list in operator< () order.

Definition at line 560 of file milist.h.

template<class _LIT>
void MILIST< _LIT >::Sort  )  [inline]
 

Sort the list in operator< () order.

Definition at line 555 of file milist.h.


The documentation for this class was generated from the following file:
Generated on Wed May 31 15:28:52 2006 for TNTsdk by  doxygen 1.3.8-20040913