GraphNodeIterC<class NodeT,class EdgeT>

Developer Documentation

Centre for Vision, Speech & Signal Processing

Comments:
Iterates through all the nodes in a graph.

Parent Classes:

GraphNodeC

Methods:

GraphNodeIterC(GraphTC<NodeT,EdgeT> & AGraph): Constructor.
GraphNodeIterC(): Default constructor.
GraphNodeIterC(const GraphNodeIterC<NodeT,EdgeT> & Another)
~GraphNodeIterC(): Destructor.
const GraphNodeIterC<NodeT,EdgeT> & operator=(const GraphNodeIterC<NodeT,EdgeT> & Oth): Assigment.
BooleanT operator==(const GraphNodeIterC<NodeT,EdgeT> & Oth) const: Comparison.
BooleanT operator!=(const GraphNodeIterC<NodeT,EdgeT> & Oth) const: Comparison.
NodeT & Data(void): Access data.
const NodeT & Data(void) const: Access data.
GraphAdjIterC<NodeT,EdgeT> 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.
GraphAdjIterC<NodeT,EdgeT> 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.
void First()
void Last()
void Next()
void Prev()
void NextCrc()
void PrevCrc()
void Nth(LongIntT n)
void RelNth(LongIntT n)
BooleanT IsValid() const: TBD. Tempory solution !! While IsValid is protected.
BaseDListC::ListSizeT Size() const
void Invalidate(): Invalidate handle, IsValid() will return false after this call until the handle is assigmed to another node.
void Del(): Unlinks edge from the graph and deletes it. The iterator will point to the previous edge in the graph edge list.
void DelMoveNext(): Unlinks edge from the graph and deletes it. The iterator will point to the next edge in the graph edge list.
BooleanT IsNodeValid() const
BooleanT IsIterValid() const
GraphNodeC & BaseNodeIter(): Access to the base graph node iterator. Use ONLY for implementing new base graph operations/iteratiors.
const GraphNodeC & BaseNodeIter() const: Access to the base graph node iterator. Use ONLY for implementing new base graph operations/iterators.
GraphNodeIterC(const GraphNodeC & aNode): Construct from a base node iterator.
GraphNodeIterC(GraphNodeRepC & aNode,BaseGraphC & bg): Construct from a base node iterator.
GraphNodeDatC<NodeT,EdgeT> & NodeDat(): Get a node rep.
const GraphNodeDatC<NodeT,EdgeT> & NodeDat() const: Get a node rep.

#include "amma/BoGraph.hh"

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.
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'.
BaseGraphC & Graph(): Returns the whole graph.

#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'.
BaseIntrDLIterC<GraphNodeRepC> Copy() const: Copy constructor.
const BaseIntrDLIterC<GraphNodeRepC> & operator=(const BaseIntrDLIterC<GraphNodeRepC> & it): Assingment. This iterator will point to the same list element as the iterator 'it'.
const BaseIntrDLIterC<GraphNodeRepC> & DLIter() const: Self-identification. The function returns this object.

#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.
void Set(IntrDListC<GraphNodeRepC> & list,GraphNodeRepC * data): Sets the iterator to point to the element 'data' that belongs to the 'list'.
const BaseIntrConstDLIterC<GraphNodeRepC> & operator=(const BaseIntrConstDLIterC<GraphNodeRepC> & it): Assingment. This iterator will point to the same list element as the iterator 'it'.
const BaseIntrConstDLIterC<GraphNodeRepC> & DLIter() const: Self-identification. The function returns this object.
const BaseIntrConstDLIterC<GraphNodeRepC> & LinkBef(GraphNodeRepC * data): Inserts the new element containing 'data' before the element pointed to by this iterator. This iterator is returned.
const BaseIntrConstDLIterC<GraphNodeRepC> & LinkAft(GraphNodeRepC * data): Inserts the new element containing 'data' after the element pointed to by this iterator. This iterator is returned.
const BaseIntrConstDLIterC<GraphNodeRepC> & MoveBef(BaseIntrConstDLIterC<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 BaseIntrConstDLIterC<GraphNodeRepC> & MoveAft(BaseIntrConstDLIterC<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 BaseIntrConstDLIterC<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 BaseIntrConstDLIterC<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(): Unlink the element pointed to by this iterator and moves iterator to the next element.
GraphNodeRepC * Unlink(): Unlink the element pointed to by this iterator and moves iterator to the previous element.
ostream & operator<<(ostream & s,const BaseIntrConstDLIterC<GraphNodeRepC> & elm)

Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

GraphNodeIterC<class NodeT,class EdgeT>

Node iterator.

include	"amma/GraphNode.hh"
User Level:	Default
Library:	Mgraph
Example:	exBiHash.cc
Section:	Containers.Graphs
In Scope:	std