|
User Documentation |
|
Centre for Vision, Speech & Signal Processing |
Parent Classes:
Methods:
- StringListC()
-
Default constructor
- StringListC(const StringListC & oth)
-
Copy constructor
- StringListC(const DListC<StringC> & alist)
-
Constructor
- StringListC(const StringC & str,const char * delim = " \n\t\0")
-
Constructor that tokenises string into string list
- StringListC(const StringC & str,BooleanT fullParse,const char * delim = " \n\t\0")
-
Constructor that tokenises string into string list
If full parse is enabled double quotes are respected,
and escaping with '\' is supported.
- const StringListC & operator+=(const StringListC & list)
-
Concatenation.
The operator moves the whole 'list to the end
of this list. The 'list' will be EMPTY after the operation.
The arg is only constant so that 'list' may be a tempory without
causing warnings.
Returns this list.
- IndexT CasePos(const StringC & str) const
-
finds position of string in list - case insensitive
- StringC Cat(const StringC & sep = " ") const
-
concatenates string list into a single string
- DListC<StringC> Copy() const
-
Create a copy of this list.
- const DListC<StringC> & operator=(const DListC<StringC> & l)
-
Both this list and the list 'l' will be the same list.
The old list will be emptied if there is no other references to it.
- BodyDListC<StringC> & Body()
-
- DListC<StringC> Tail(BaseBodyConstDLIterC<StringC> & ptr)
-
Splits the list into two parts.
This list will contain the beginning
of the original list. The function returns the second part
of the original list including the element 'ptr'.
- DListC<StringC> Head(BaseBodyConstDLIterC<StringC> & ptr)
-
Splits the list into two parts.
This list will contain the second part
of the original list including the element 'ptr'.
The function returns the list containing the beginning of the original
list.
Status functions
----------------
- BaseDListC::ListSizeT Size() const
-
Returns the length of a list. It does not check the counter overflow.
- BooleanT operator==(const DListC<StringC> & list) const
-
Returns TRUE if both lists represent the same list.
- BooleanT operator!=(const DListC<StringC> & list) const
-
Returns TRUE if both lists are independent.
- BooleanT IsEmpty() const
-
Returns TRUE if the list is empty.
- void ConsistencyCheck(LongIntT stopSize = 30000) const
-
Checks the list if all links are valid.
If the counter of elements
during the checking overflows the number 'stopSize', the function
exits with error.
Access to the elements
----------------------
- const StringC & First() const
-
Returns the first element of the constant list.
- StringC & First()
-
Returns the first element of the list.
- const StringC & Last() const
-
Returns the last element of the constant list.
- StringC & Last()
-
Returns the last element of the constant list.
- const StringC & operator[](IndexT i) const
-
Returns the i-th element of the constant list.
The first element has the index 0.
- StringC & operator[](IndexT i)
-
Returns the i-th element of the list.
The first element has the index 0.
Elementary changes in the list
------------------------------
- DListC<StringC> & InsFirst(const StringC & data)
-
Inserts the new element at the beginning of the list.
Returns the reference to the changed list.
- DListC<StringC> & InsLast(const StringC & data)
-
Inserts the new element at the end of the list.
Returns the pointer to the list.
- DListC<StringC> & DelFirst()
-
Deletes the first element of the list.
Returns the reference to the list.
- DListC<StringC> & DelLast()
-
Deletes the last element of the list.
Returns the reference to the list.
- StringC GetFirst()
-
Removes the first element from the list.
Returns that removed element.
- StringC GetLast()
-
Removes the last element from the list.
Returns that removed element.
- DListC<StringC> & MakeFirst(BaseBodyConstDLIterC<StringC> & ptr)
-
Moves the head of the list to be the predeccessor of the element pointed to be 'ptr'.
The iterator 'ptr' must belong to this list.
Returns the reference to the list.
- DListC<StringC> & MakeLast(BaseBodyConstDLIterC<StringC> & ptr)
-
Moves the head of the list to be the successor of the element pointed to by 'ptr'.
The iterator 'ptr' must belong to this list.
Returns the reference to the list.
- DListC<StringC> & MoveFirst(BaseBodyConstDLIterC<StringC> & ptr)
-
Moves the list element pointed to by 'ptr' into the list as the first element.
The pointed list element need not to be
the element of this list, but it cannot be the head of any list.
Returns this list.
- DListC<StringC> & MoveLast(BaseBodyConstDLIterC<StringC> & ptr)
-
Moves the list element, which 'ptr' points to, into the list as the last element.
The pointed list element need not to be
the element of this list, but it cannot be the head of any list.
Returns this list.
Transformations of lists
------------------------
- DListC<StringC> & MoveFirst(DListC<StringC> & list)
-
Moves the whole 'list' to the beginning of this list.
The 'list' will be empty after the operation. Returns this list.
- DListC<StringC> & MoveLast(DListC<StringC> & list)
-
Moves the whole 'list' to the end of this list.
The 'list' will be empty after the operation. Returns this list.
- const DListC<StringC> & operator+=(const DListC<StringC> & list)
-
Concatenation.
The operator moves the whole 'list to the end
of this list. The 'list' will be EMPTY after the operation.
The arg is only constant so that 'list' may be a tempory without
causing warnings.
Returns this list.
- const DListC<StringC> & operator+=(const StringC & list)
-
Concatenation an element.
This is just an alias for InsLast().
Returns this list.
- DListC<StringC> & Reverse()
-
Reverses the list. Returns the list.
- DListC<StringC> & Empty()
-
All elements of the list will be destroyed.
- int LessOrEqualDefault(const StringC & el1,const StringC & el2)
-
- void MergeSort(DListC<StringC>::LessOrEqualFuncT func)
-
Sorts the list according to order defined by the comparing function 'LessOrEqual'.
The default function uses the > operator of the class to do the sort.
If no such operator exists one will be created that prints an
error message then aborts the code.
- void BubbleSort(DListC<StringC>::LessOrEqualFuncT func)
-
Sorts the list according to order defined by the comparing function 'LessOrEqual'.
The default function uses the > operator of the class to do the sort.
If no such operator exists one will be created that prints an
error message then aborts the code.
- UIntT Hash() const
-
Get a hash value unique to this list.
it does not depend in anyway on the contents of the list.
|
Programmer:Bill Christmas, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001
|