|
Developer Documentation |
|
Centre for Vision, Speech & Signal Processing |
Comments:
GfSetsC is a list whose elements are of class GfSetC
Parent Classes:
Methods:
- GfSetsC()
-
Creates an empty set of GF sets.
- GfSetsC(const StringC & filename)
-
Creates the *.gf sets from the input file 'filename'.
- GfSetsC(istream & from)
-
Creates the *.gf sets from the input stream 'from'.
- void SaveAs(ostream & outF)
-
Saves the sets into the output stream 'outF'.
- int GetSetNum(const StringC & id)
-
Returns the number of sets.
- const GfSetC & GetSet(const StringC & id)
-
Returns the first set which name is 'id'.
- BooleanT IsSet(const StringC & id)
-
Returns TRUE if a set with 'id' exists.
- ostream & operator<<(ostream & s,const GfSetsC & sets)
-
- DListC<GfSetC> Copy() const
-
Create a copy of this list.
- const DListC<GfSetC> & operator=(const DListC<GfSetC> & 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<GfSetC> & Body()
-
- DListC<GfSetC> Tail(BaseBodyConstDLIterC<GfSetC> & 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<GfSetC> Head(BaseBodyConstDLIterC<GfSetC> & 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<GfSetC> & list) const
-
Returns TRUE if both lists represent the same list.
- BooleanT operator!=(const DListC<GfSetC> & 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 GfSetC & First() const
-
Returns the first element of the constant list.
- GfSetC & First()
-
Returns the first element of the list.
- const GfSetC & Last() const
-
Returns the last element of the constant list.
- GfSetC & Last()
-
Returns the last element of the constant list.
- const GfSetC & operator[](IndexT i) const
-
Returns the i-th element of the constant list.
The first element has the index 0.
- GfSetC & operator[](IndexT i)
-
Returns the i-th element of the list.
The first element has the index 0.
Elementary changes in the list
------------------------------
- DListC<GfSetC> & InsFirst(const GfSetC & data)
-
Inserts the new element at the beginning of the list.
Returns the reference to the changed list.
- DListC<GfSetC> & InsLast(const GfSetC & data)
-
Inserts the new element at the end of the list.
Returns the pointer to the list.
- DListC<GfSetC> & DelFirst()
-
Deletes the first element of the list.
Returns the reference to the list.
- DListC<GfSetC> & DelLast()
-
Deletes the last element of the list.
Returns the reference to the list.
- GfSetC GetFirst()
-
Removes the first element from the list.
Returns that removed element.
- GfSetC GetLast()
-
Removes the last element from the list.
Returns that removed element.
- DListC<GfSetC> & MakeFirst(BaseBodyConstDLIterC<GfSetC> & 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<GfSetC> & MakeLast(BaseBodyConstDLIterC<GfSetC> & 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<GfSetC> & MoveFirst(BaseBodyConstDLIterC<GfSetC> & 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<GfSetC> & MoveLast(BaseBodyConstDLIterC<GfSetC> & 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<GfSetC> & MoveFirst(DListC<GfSetC> & list)
-
Moves the whole 'list' to the beginning of this list.
The 'list' will be empty after the operation. Returns this list.
- DListC<GfSetC> & MoveLast(DListC<GfSetC> & list)
-
Moves the whole 'list' to the end of this list.
The 'list' will be empty after the operation. Returns this list.
- const DListC<GfSetC> & operator+=(const DListC<GfSetC> & 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<GfSetC> & operator+=(const GfSetC & list)
-
Concatenation an element.
This is just an alias for InsLast().
Returns this list.
- DListC<GfSetC> & Reverse()
-
Reverses the list. Returns the list.
- DListC<GfSetC> & Empty()
-
All elements of the list will be destroyed.
- int LessOrEqualDefault(const GfSetC & el1,const GfSetC & el2)
-
- void MergeSort(DListC<GfSetC>::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<GfSetC>::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:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001
|