User Documentation
Centre for Vision, Speech & Signal Processing
DEVELOP IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
GraphNodeC::GraphNodeC(BaseGraphC &)
GraphNodeC::GraphNodeC(const GraphNodeC &)
GraphNodeC::operator==(const GraphNodeC &) const
GraphNodeC::Hash(void) const
GraphNodeC::NodeRep(void)
GraphNodeC::NodeRep(void) const
GraphNodeC::In(void)
GraphNodeC::Out(void)
GraphNodeC::Marker(void)
GraphNodeC::Marker(void) const
GraphNodeC::Del(void)
GraphNodeC::GraphNodeC(void)
GraphNodeC::LateItemSet(BaseGraphC &)
GraphNodeC::LateItemSet(const GraphNodeC &)
IntrDLIterC::Copy(void) const
IntrDLIterC::operator=(const IntrDLIterC &)
IntrDLIterC::DLIter(void) const
IntrDLIterC::LateItemSet(IntrDListC &)
IntrDLIterC::LateItemSet(const IntrDLIterC &)
BaseIntrDLIterC::Data(void) const
BaseIntrDLIterC::Data(void)
BaseIntrDLIterC::First(void)
BaseIntrDLIterC::Last(void)
BaseIntrDLIterC::Next(void)
BaseIntrDLIterC::Prev(void)
BaseIntrDLIterC::NextCrc(void)
BaseIntrDLIterC::PrevCrc(void)
BaseIntrDLIterC::Nth(LongIntT)
BaseIntrDLIterC::RelNth(LongIntT)
BaseIntrDLIterC::LinkBef(DataC *)
BaseIntrDLIterC::LinkAft(DataC *)
BaseIntrDLIterC::MoveBef(BaseIntrDLIterC &)
BaseIntrDLIterC::MoveAft(BaseIntrDLIterC &)
BaseIntrDLIterC::MoveBef(IntrDListC &)
BaseIntrDLIterC::MoveAft(IntrDListC &)
BaseIntrDLIterC::UnlinkMoveNext(void)
BaseIntrDLIterC::Unlink(void)
BaseIntrDLIterC::LateItemSet(IntrDListC &)
BaseIntrDLIterC::LateItemSet(const BaseIntrDLIterC &)
BaseIntrConstDLIterC::Data(void) const
BaseIntrConstDLIterC::List(void) const
BaseIntrConstDLIterC::operator==(const BaseIntrConstDLIterC &) const
BaseIntrConstDLIterC::operator!=(const BaseIntrConstDLIterC &) const
BaseIntrConstDLIterC::IsFirst(void) const
BaseIntrConstDLIterC::IsLast(void) const
BaseIntrConstDLIterC::IsElm(void) const
BaseIntrConstDLIterC::First(void)
BaseIntrConstDLIterC::Last(void)
BaseIntrConstDLIterC::Next(void)
BaseIntrConstDLIterC::Prev(void)
BaseIntrConstDLIterC::NextCrc(void)
BaseIntrConstDLIterC::PrevCrc(void)
BaseIntrConstDLIterC::Nth(LongIntT)
BaseIntrConstDLIterC::RelNth(LongIntT)
BaseIntrConstDLIterC::Index(void) const
BaseIntrConstDLIterC::LateItemSet(IntrDListC &)
BaseIntrConstDLIterC::LateItemSet(const BaseIntrConstDLIterC &)
BaseIntrConstDLIterC::IsValid(void) const
GraphNodeC
 
The class GraphNodeC is the iterator of the list of graph nodes.
 
include "amma/BoGraph.hh"
User Level:Default
Library:Mgraph
Example:exBiHash.cc
Section:Containers.Graphs
In Scope:std

Comments:
Futhermore, the class provides access to the graph elements which are in the neighbourhood of the node.

Parent Classes: Derived Classes: Variables:
Methods:
GraphNodeC(BaseGraphC & graph)
Creates the node iterator of the 'graph'. The iterator will point to the first node in the node list of the graph.

GraphNodeC(const GraphNodeC & node)
Copy constructor.

BooleanT operator==(const GraphNodeC & Oth) const
True when both iterators are pointing at the same node.

UIntT Hash(void) const
Returns a hash value for the current node.

GraphNodeRepC & NodeRep()
Returns the node.

const GraphNodeRepC & NodeRep() const
Returns the node.

GraphAdjC In()
Returns the iterator that is set to the first item of the list of the graph adjacencies in which this node is the target node.

GraphAdjC Out()
Returns the iterator that is set to the first item of the list of the graph adjacencies in which this node is the source node.

GraphNodeRepC::MarkerT & Marker()
Access to the marker of this node.

GraphNodeRepC::MarkerT Marker() const
Returns the marker of this node.

void Del()
Unlinks the node from the graph and deletes it. The iterator will point to the previous node in the graph node list. Array item constructors. ------------------------ ATTENTION! The following member functions can be used only for initialization of arrays. This constructor is provided because of trouble with an array of objects. The present ANSI C++ does not enable to pass any constructor of array elements different from a defaut constructor. The extension of GNU g++ compiler is not supported by other compiler. The constructor should be used only for such purposes. If this limitation of C++ is removed, the constructor will be obsolete.

GraphNodeC()
The default constructor used by constructors of arrays. It constructs the unvalid object which must be initialized by the member function LateItemSet().

void LateItemSet(BaseGraphC & graph)
Sets the unvalid graph node iterator. The iterator will point to the first node in the node list of the 'graph'.

void LateItemSet(const GraphNodeC & node)
Sets the unvalid node iterator to be the copy of the iterator 'node'.

#include "amma/InDLIter.hh"
IntrDLIterC<GraphNodeRepC> Copy() const
Copy constructor.

const IntrDLIterC<GraphNodeRepC> & operator=(const IntrDLIterC<GraphNodeRepC> & it)
Assingment. This iterator will point to the same list element as the iterator 'it'. Access to the object items. ---------------------------

const IntrDLIterC<GraphNodeRepC> & DLIter() const
Self-identification. The function returns this object. Array item constructors. ------------------------ ATTENTION! The following member functions can be used only for initialization of arrays. This constructor is provided because of trouble with an array of objects. The present ANSI C++ does not enable to pass any constructor of array elements different from a defaut constructor. The extension of GNU g++ compiler is not supported by other compiler. The constructor should be used only for such purposes. If this limitation of C++ is removed, the constructor will be obsolete.

void LateItemSet(IntrDListC<GraphNodeRepC> & list)
Sets the unvalid list iterator. The iterator will point to the first item of the 'list', if there is any, otherwise to the head of the list.

void LateItemSet(const IntrDLIterC<GraphNodeRepC> & iter)
Sets the unvalid list iterator to be the copy of the iterator 'iter'.

#include "amma/BIDLIter.hh"
const GraphNodeRepC & Data() const
Access to the constant object contained in the list element.

GraphNodeRepC & Data()
Access to the object contained in the list element. BE CAREFUL. You must not change the links of created chains. Positioning the iterator. -------------------------

BaseIntrDLIterC<GraphNodeRepC> & First()
Sets the iterator to point to the first element of the list.

BaseIntrDLIterC<GraphNodeRepC> & Last()
Sets the iterator to point to the last element of the list.

BaseIntrDLIterC<GraphNodeRepC> & Next()
Moves the iterator to the successor of the element.

BaseIntrDLIterC<GraphNodeRepC> & Prev()
Moves the iterator to the predecessor of the element.

BaseIntrDLIterC<GraphNodeRepC> & NextCrc()
Moves the iterator to the successor of the element. If the result element is not a proper element of the list the iterator is moved to the first element.

BaseIntrDLIterC<GraphNodeRepC> & PrevCrc()
Moves the iterator to the predecessor of the element. If the result element is not a proper element of the list the iterator is moved to the last element.

BaseIntrDLIterC<GraphNodeRepC> & Nth(LongIntT n)
Sets to the n-th element of the list. The index 'n' can be negative. The first element of the list has the index 0, the last element has the index -1. It does not skip the head of the list.

BaseIntrDLIterC<GraphNodeRepC> & RelNth(LongIntT n)
Moves to the n-th element from the current element. The index 'n' can be positive, zero, or negative. Particularly, the n = 0 means no move, n = 1 means the move to the next element, and n = -1 means the move to the previous element. Link / Unlink / Delete. -----------------------

const BaseIntrDLIterC<GraphNodeRepC> & LinkBef(GraphNodeRepC * data)
Inserts the new element containing 'data' before the element pointed to by this iterator. This iterator is returned.

const BaseIntrDLIterC<GraphNodeRepC> & LinkAft(GraphNodeRepC * data)
Inserts the new element containing 'data' after the element pointed to by this iterator. This iterator is returned.

const BaseIntrDLIterC<GraphNodeRepC> & MoveBef(BaseIntrDLIterC<GraphNodeRepC> & iter)
The element pointed to by 'iter' is moved before the element pointed to by this iterator. This iterator will point to the same element as before. The iterator 'iter' will point to the previous element in the original list.

const BaseIntrDLIterC<GraphNodeRepC> & MoveAft(BaseIntrDLIterC<GraphNodeRepC> & iter)
The element pointed to by 'iter' is moved after the element pointed to by this iterator. This iterator will point to the same element as before. The iterator 'iter' will point to the previous element in the original list.

const BaseIntrDLIterC<GraphNodeRepC> & MoveBef(IntrDListC<GraphNodeRepC> & list)
All elements of the 'list' are moved before the element pointed to by this iterator. The 'list' will be empty after this operation.

const BaseIntrDLIterC<GraphNodeRepC> & MoveAft(IntrDListC<GraphNodeRepC> & list)
All elements of the 'list' are moved before the element pointed to by this iterator. The 'list' will be empty after this operation.

GraphNodeRepC * UnlinkMoveNext()
Unlinks the element pointed to by this iterator and moves iterator to the next element.

GraphNodeRepC * Unlink()
Unlinks the element pointed to by this iterator and moves iterator to the previous element. Array item constructors. ------------------------ ATTENTION! The following member functions can be used only for initialization of arrays. This constructor is provided because of trouble with an array of objects. The present ANSI C++ does not enable to pass any constructor of array elements different from a defaut constructor. The extension of GNU g++ compiler is not supported by other compiler. The constructor should be used only for such purposes. If this limitation of C++ is removed, the constructor will be obsolete.

void LateItemSet(IntrDListC<GraphNodeRepC> & list)
Sets the unvalid list iterator. The iterator will point to the first item of the 'list', if there is any, otherwise to the head of the list.

void LateItemSet(const BaseIntrDLIterC<GraphNodeRepC> & iter)
Sets the unvalid list iterator to be the copy of the iterator 'iter'.

#include "amma/BICDLIte.hh"
const GraphNodeRepC & Data() const
Access to the constant object contained in the list element.

const IntrDListC<GraphNodeRepC> & List() const
Returns the list whose element is pointed to by this iterator. ------------ Predicates -------------------------------------

BooleanT operator==(const BaseIntrConstDLIterC<GraphNodeRepC> & it) const
Returns TRUE if both iterators point to the same list element.

BooleanT operator!=(const BaseIntrConstDLIterC<GraphNodeRepC> & it) const
Returns TRUE if this iterators points to a different list element than the iterator 'it'.

BooleanT IsFirst() const
Returns TRUE if the pointed element is the first in a list.

BooleanT IsLast() const
Returns TRUE if the pointed element is the last one in a list.

BooleanT IsElm() const
Returns TRUE if the pointed an proper element (not a head) of a list. ----------- Positioning the iterator -----------------------------

BaseIntrConstDLIterC<GraphNodeRepC> & First()
Sets the iterator to point to the first element of the list.

BaseIntrConstDLIterC<GraphNodeRepC> & Last()
Sets the iterator to point to the last element of the list.

BaseIntrConstDLIterC<GraphNodeRepC> & Next()
Moves the iterator to the successor of the element.

BaseIntrConstDLIterC<GraphNodeRepC> & Prev()
Moves the iterator to the predecessor of the element.

BaseIntrConstDLIterC<GraphNodeRepC> & NextCrc()
Moves the iterator to the successor of the element. If the result element is not a proper element of the list the iterator is moved to the first element.

BaseIntrConstDLIterC<GraphNodeRepC> & PrevCrc()
Moves the iterator to the predecessor of the element. If the result element is not a proper element of the list the iterator is moved to the last element.

BaseIntrConstDLIterC<GraphNodeRepC> & Nth(LongIntT n)
Sets to the n-th element of the list. The index 'n' can be negative. The first element of the list has the index 0, the last element has the index -1. It does not skip the head of the list.

BaseIntrConstDLIterC<GraphNodeRepC> & RelNth(LongIntT n)
Moves to the n-th element from the current element. The index 'n' can be positive, zero, or negative. Particularly, the n = 0 means no move, n = 1 means the move to the next element, and n = -1 means the move to the previous element.

LongIntT Index() const
Returns the offset of an element from the first element. Particularly, it returns 0 if the iterator points to the first element, it returns -1 if element is the head of the list, and it returns -2 if the element is not contained in the list. The function does not check counter overflow. Array item constructors. ------------------------ ATTENTION! The following member functions can be used only for initialization of arrays. This constructor is provided because of trouble with an array of objects. The present ANSI C++ does not enable to pass any constructor of array elements different from a defaut constructor. The extension of GNU g++ compiler is not supported by other compiler. The constructor should be used only for such purposes. If this limitation of C++ is removed, the constructor will be obsolete.

void LateItemSet(IntrDListC<GraphNodeRepC> & list)
Sets the unvalid list iterator. The iterator will point to the first item of the 'list', if there is any, otherwise to the head of the list.

void LateItemSet(const BaseIntrConstDLIterC<GraphNodeRepC> & iter)
Sets the unvalid list iterator to be the copy of the iterator 'iter'.

BooleanT IsValid() const
Returns TRUE if the iterator was not constructed by the default constructor.


Programmer:Radek Marik, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001