MILIST< _LIT > Class Template Reference
#include <mi32/milist.h>
Classes | |
| class | CONST_ITERATOR |
| Const iterator class. More... | |
| class | ITERATOR |
| struct | LISTITEM |
Public Member Functions | |
| MILIST (const MILIST< _LIT > &rhs) | |
| MILIST () | |
| ~MILIST () | |
| CONST_ITERATOR | Begin () const |
| ITERATOR | Begin () |
| void | Clear () |
| bool | Contains (const _LIT &item) const |
| ITERATOR | CopyIterator (CONST_ITERATOR it) |
| CONST_ITERATOR | End () const |
| ITERATOR | End () |
| void | Exchange (MILIST< _LIT > &other) |
| void | Extract (MILIST< _LIT > &other, ITERATOR &it) |
| 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 |
| bool | HasSameValues (const MILIST< _LIT > &rhs) const |
| _LIT & | Insert (ITERATOR it, const _LIT &item) |
| _LIT & | InsertAfter (ITERATOR it, const _LIT &item) |
| _LIT & | InsertBefore (ITERATOR it, const _LIT &item) |
| bool | IsEmpty () const |
| bool | IsEqual (const MILIST< _LIT > &rhs) const |
| void | Lower (int pos) |
| void | Lower (ITERATOR it) |
| void | Merge (MILIST< _LIT > &other) |
| 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 (int pos) |
| void | Raise (ITERATOR it) |
| void | Remove (ITERATOR start, ITERATOR end) |
| void | Remove (ITERATOR it) |
| void | RemoveDuplicates () |
| void | RemoveMatching (const _LIT &item) |
| 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 () |
template<typename _LIT>
class MILIST< _LIT >
Constructor & Destructor Documentation
Constructor for an empty list.
Deliberate MmAllocC instead of new
Copy constructor.
Deliberate MmAllocC instead of new
Member Function Documentation
| CONST_ITERATOR MILIST< _LIT >::Begin | ( | ) | const [inline] |
Return a CONST_ITERATOR that refers to the beginning of the list.
Return an ITERATOR that refers to the beginning of the list.
| void MILIST< _LIT >::Clear | ( | ) | [inline] |
Remove all entries from the list.
| 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.
| ITERATOR MILIST< _LIT >::CopyIterator | ( | CONST_ITERATOR | it | ) | [inline] |
Copy CONST_ITERATOR to (non-const) ITERATOR.
This requires caller to have non-const access to the list itself.
| CONST_ITERATOR MILIST< _LIT >::End | ( | ) | const [inline] |
Return a CONST_ITERATOR that refers to the end of the list, not a valid list item.
Return an ITERATOR that refers to the end of the list, not a valid list item.
Exchange list with another.
| void MILIST< _LIT >::Extract | ( | MILIST< _LIT > & | other, | |
| ITERATOR & | it | |||
| ) | [inline] |
Extract item from another list, placing at end of this list.
- Parameters:
-
other List to extract from, must not be current list it Item in other list to extract, must not be at end of other list.
| 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.
| _LIT& MILIST< _LIT >::GetBack | ( | ) | [inline] |
Return a reference to a _LIT item from the front of the list.
| const _LIT& MILIST< _LIT >::GetBack | ( | ) | const [inline] |
Return a reference to a const _LIT item from the front of the list.
| _LIT& MILIST< _LIT >::GetFront | ( | ) | [inline] |
Return a reference to a _LIT item from the front of the list.
| const _LIT& MILIST< _LIT >::GetFront | ( | ) | const [inline] |
Return a reference to a const _LIT item from the front of the list.
| _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.
| 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.
Return the number of items in the list.
| bool MILIST< _LIT >::HasSameValues | ( | const MILIST< _LIT > & | rhs | ) | const [inline] |
Determine equality with another list of same type, regardless of the item order.
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).
| _LIT& MILIST< _LIT >::InsertAfter | ( | ITERATOR | it, | |
| const _LIT & | item | |||
| ) | [inline] |
Insert an item into list after specified iterator.
- Returns:
- Reference to new item in list (not same as 'item' parameter as will be copied).
| _LIT& MILIST< _LIT >::InsertBefore | ( | ITERATOR | it, | |
| const _LIT & | item | |||
| ) | [inline] |
Insert an item into list before specified iterator.
- Returns:
- Reference to new item in list (not same as 'item' parameter as will be copied).
| bool MILIST< _LIT >::IsEmpty | ( | ) | const [inline] |
Determine if any list entries exist.
Determine equality with another list of same type.
| void MILIST< _LIT >::Lower | ( | int | pos | ) | [inline] |
Moves the item referenced by the iterator toward the beginning of the list.
Moves the item referenced by the iterator toward the beginning of the list.
Merge two lists together, the list copied from is cleared, does not sort.
Moves the item referenced by the iterator to the back of the list.
Moves the item referenced by the iterator to the front of the list.
| MILIST<_LIT>& MILIST< _LIT >::operator= | ( | const MILIST< _LIT > & | rhs | ) | [inline] |
Assignment operator.
| void MILIST< _LIT >::PopBack | ( | ) | [inline] |
Remove the last item from the list.
| void MILIST< _LIT >::PopFront | ( | ) | [inline] |
Remove an item from the beginning of the list.
| _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).
| _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).
| void MILIST< _LIT >::Raise | ( | int | pos | ) | [inline] |
Moves the item referenced by the iterator toward the beginning of the list.
Moves the item referenced by the iterator toward the end of the list.
Remove a range of items from the list.
- Parameters:
-
start Iterator for first item to remove end Ending item, exclusive, will not be removed
Remove item specified by ITERATOR from the list.
Do not use the specified iterator after using this method as it will be invalid.
| void MILIST< _LIT >::RemoveDuplicates | ( | ) | [inline] |
Remove duplicate entries.
| void MILIST< _LIT >::RemoveMatching | ( | const _LIT & | item | ) | [inline] |
Remove matching item(s).
| void MILIST< _LIT >::RemovePos | ( | int | pos | ) | [inline] |
Remove item at specified position.
- Parameters:
-
pos Position starting at 0 for beginning of list
| void MILIST< _LIT >::Reverse | ( | ) | [inline] |
Reverse order of items in list.
| CONST_ITERATOR MILIST< _LIT >::ReverseBegin | ( | ) | const [inline] |
Return a CONST_ITERATOR that refers to the end of the list.
Return an ITERATOR that refers to the end of the list.
| CONST_ITERATOR MILIST< _LIT >::ReverseEnd | ( | ) | const [inline] |
Return a CONST_ITERATOR that refers to the end of the list, not a valid list item.
Return an ITERATOR that refers to the end of the list, not a valid list item.
| void MILIST< _LIT >::Sort | ( | bool(*)(const _LIT &lhs, const _LIT &rhs) | PredFunc | ) | [inline] |
Sort the list in operator< () order.
Sort the list in operator< () order.
| void MILIST< _LIT >::Sort | ( | ) | [inline] |
Sort the list in operator< () order.
The documentation for this class was generated from the following file:
- mi32/milist.h
