GraphAdjIterC<class NodeT,class EdgeT>

Developer Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

GraphAdjC

Methods:

GraphAdjIterC(const GraphAdjIterC<NodeT,EdgeT> & Another): Copy constructor.
const GraphAdjIterC<NodeT,EdgeT> & operator=(const GraphAdjIterC<NodeT,EdgeT> & Oth): Assigment.
EdgeT & Data(void): Access data.
const EdgeT & Data(void) const: Constant access to data.
NodeT & Node1Data(void): Get data from node 1.
NodeT & Node2Data(void): Get data from node 2.
NodeT & SourceData(void): Data from source node.
NodeT & TargetData(void): Data from target node.
GraphNodeIterC<NodeT,EdgeT> Node1(void): Get a node from an undirected graph
GraphNodeIterC<NodeT,EdgeT> Node2(void): Get a node from an undirected graph
GraphNodeIterC<NodeT,EdgeT> Node(void): See GraphAdjC::Node()
GraphNodeIterC<NodeT,EdgeT> OtherNode(void): See GraphAdjC::OtherNode()
GraphNodeHC<NodeT,EdgeT> NodeH(void): See GraphAdjC::Node()
GraphNodeHC<NodeT,EdgeT> OtherNodeH(void): See GraphAdjC::OtherNode()
GraphNodeIterC<NodeT,EdgeT> Source(void): Get source node.
GraphNodeIterC<NodeT,EdgeT> Target(void): Get target node.
GraphNodeHC<NodeT,EdgeT> SourceH(): Get source node handle.
GraphNodeHC<NodeT,EdgeT> TargetH(): Get target node handle.
GraphEdgeIterC<NodeT,EdgeT> Edge(void): Get associated edge.
void First()
void Last()
void Next()
void Prev()
void NextCrc()
void PrevCrc()
void Nth(LongIntT n)
void RelNth(LongIntT n)
BaseDListC::ListSizeT Size() const
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.
GraphNodeDatC<NodeT,EdgeT> & SourceRep(void): Get source node.
GraphNodeDatC<NodeT,EdgeT> & TargetRep(void): Get target node repre.
GraphAdjIterC(const IntrDLIterC<GraphAdjRepC> & iter,BaseGraphC & grph)
GraphAdjIterC(IntrDListC<GraphAdjRepC> & list,BaseGraphC & grph): Creates the graph adjacency iterator from the iterator of adjacency and the graph which the iterator belongs to.
GraphAdjIterC(const GraphAdjC & Adj): Constructor from base GraphAdjC.

#include "amma/BoGraph.hh"

const GraphEdgeRepC & EdgeRep() const: Returns the edge which is connected to this graph adjacency.
GraphEdgeRepC & EdgeRep(): Returns the edge which is connected to this graph adjacency.
const GraphNodeRepC & SourceRep() const: Returns the source node of the edge which is connected to this graph adjacency.
GraphNodeRepC & SourceRep(): Returns the source node of the edge which is connected to this graph adjacency.
const GraphNodeRepC & TargetRep() const: Returns the target node of the edge which is connected to this graph adjacency.
GraphNodeRepC & TargetRep(): Returns the target node of the edge which is connected to this graph adjacency.
const GraphNodeRepC & Node1Rep() const: Returns the first node of the edge which is connected to this graph adjacency.
GraphNodeRepC & Node1Rep(): Returns the first node of the edge which is connected to this graph adjacency.
const GraphNodeRepC & Node2Rep() const: Returns the second node of the edge which is connected to this graph adjacency.
GraphNodeRepC & Node2Rep(): Returns the second node of the edge which is connected to this graph adjacency.
GraphEdgeC Edge(): Returns the edge which is connected to this graph adjacency.
GraphNodeC Node(): Returns the node which is the owner of the list to which this graph adjacency belongs to.
GraphNodeC OtherNode(): Returns the node which is not the owner of the list to which this graph adjacency belongs to.
GraphAdjC & OtherAdj(): Moves to the graph adjacency of the other node.
GraphEdgeRepC::MarkerT EdgeMarker() const: Returns the marker of the edge related to this adjacency.
GraphEdgeRepC::MarkerT OtherNodeMarker() const: Returns the marker of the other node related to this adjacency. 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(const GraphAdjC & adj): Sets the unvalid adjacency iterator to be the copy of the iterator 'adj'.
BaseGraphC & Graph(): Returns the whole graph.

#include "amma/InDLIter.hh"

IntrDLIterC<GraphAdjRepC> Copy() const: Copy constructor.
const IntrDLIterC<GraphAdjRepC> & operator=(const IntrDLIterC<GraphAdjRepC> & it): Assingment. This iterator will point to the same list element as the iterator 'it'. Access to the object items. ---------------------------
const IntrDLIterC<GraphAdjRepC> & 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<GraphAdjRepC> & 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<GraphAdjRepC> & iter): Sets the unvalid list iterator to be the copy of the iterator 'iter'.

#include "amma/BIDLIter.hh"

const GraphAdjRepC & Data() const: Access to the constant object contained in the list element.
GraphAdjRepC & 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<GraphAdjRepC> & First(): Sets the iterator to point to the first element of the list.
BaseIntrDLIterC<GraphAdjRepC> & Last(): Sets the iterator to point to the last element of the list.
BaseIntrDLIterC<GraphAdjRepC> & Next(): Moves the iterator to the successor of the element.
BaseIntrDLIterC<GraphAdjRepC> & Prev(): Moves the iterator to the predecessor of the element.
BaseIntrDLIterC<GraphAdjRepC> & 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<GraphAdjRepC> & 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<GraphAdjRepC> & 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<GraphAdjRepC> & 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<GraphAdjRepC> & LinkBef(GraphAdjRepC * data): Inserts the new element containing 'data' before the element pointed to by this iterator. This iterator is returned.
const BaseIntrDLIterC<GraphAdjRepC> & LinkAft(GraphAdjRepC * data): Inserts the new element containing 'data' after the element pointed to by this iterator. This iterator is returned.
const BaseIntrDLIterC<GraphAdjRepC> & MoveBef(BaseIntrDLIterC<GraphAdjRepC> & 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<GraphAdjRepC> & MoveAft(BaseIntrDLIterC<GraphAdjRepC> & 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<GraphAdjRepC> & MoveBef(IntrDListC<GraphAdjRepC> & 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<GraphAdjRepC> & MoveAft(IntrDListC<GraphAdjRepC> & list): All elements of the 'list' are moved before the element pointed to by this iterator. The 'list' will be empty after this operation.
GraphAdjRepC * UnlinkMoveNext(): Unlinks the element pointed to by this iterator and moves iterator to the next element.
GraphAdjRepC * 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<GraphAdjRepC> & 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<GraphAdjRepC> & iter): Sets the unvalid list iterator to be the copy of the iterator 'iter'.
BaseIntrDLIterC<GraphAdjRepC> Copy() const: Copy constructor.
const BaseIntrDLIterC<GraphAdjRepC> & operator=(const BaseIntrDLIterC<GraphAdjRepC> & it): Assingment. This iterator will point to the same list element as the iterator 'it'.
const BaseIntrDLIterC<GraphAdjRepC> & DLIter() const: Self-identification. The function returns this object.

#include "amma/BICDLIte.hh"

const GraphAdjRepC & Data() const: Access to the constant object contained in the list element.
const IntrDListC<GraphAdjRepC> & List() const: Returns the list whose element is pointed to by this iterator. ------------ Predicates -------------------------------------
BooleanT operator==(const BaseIntrConstDLIterC<GraphAdjRepC> & it) const: Returns TRUE if both iterators point to the same list element.
BooleanT operator!=(const BaseIntrConstDLIterC<GraphAdjRepC> & 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<GraphAdjRepC> & First(): Sets the iterator to point to the first element of the list.
BaseIntrConstDLIterC<GraphAdjRepC> & Last(): Sets the iterator to point to the last element of the list.
BaseIntrConstDLIterC<GraphAdjRepC> & Next(): Moves the iterator to the successor of the element.
BaseIntrConstDLIterC<GraphAdjRepC> & Prev(): Moves the iterator to the predecessor of the element.
BaseIntrConstDLIterC<GraphAdjRepC> & 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<GraphAdjRepC> & 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<GraphAdjRepC> & 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<GraphAdjRepC> & 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<GraphAdjRepC> & 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<GraphAdjRepC> & 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<GraphAdjRepC> & list,GraphAdjRepC * data): Sets the iterator to point to the element 'data' that belongs to the 'list'.
const BaseIntrConstDLIterC<GraphAdjRepC> & operator=(const BaseIntrConstDLIterC<GraphAdjRepC> & it): Assingment. This iterator will point to the same list element as the iterator 'it'.
const BaseIntrConstDLIterC<GraphAdjRepC> & DLIter() const: Self-identification. The function returns this object.
const BaseIntrConstDLIterC<GraphAdjRepC> & LinkBef(GraphAdjRepC * data): Inserts the new element containing 'data' before the element pointed to by this iterator. This iterator is returned.
const BaseIntrConstDLIterC<GraphAdjRepC> & LinkAft(GraphAdjRepC * data): Inserts the new element containing 'data' after the element pointed to by this iterator. This iterator is returned.
const BaseIntrConstDLIterC<GraphAdjRepC> & MoveBef(BaseIntrConstDLIterC<GraphAdjRepC> & 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<GraphAdjRepC> & MoveAft(BaseIntrConstDLIterC<GraphAdjRepC> & 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<GraphAdjRepC> & MoveBef(IntrDListC<GraphAdjRepC> & 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<GraphAdjRepC> & MoveAft(IntrDListC<GraphAdjRepC> & list): All elements of the 'list' are moved before the element pointed to by this iterator. The 'list' will be empty after this operation.
GraphAdjRepC * UnlinkMoveNext(): Unlink the element pointed to by this iterator and moves iterator to the next element.
GraphAdjRepC * Unlink(): Unlink the element pointed to by this iterator and moves iterator to the previous element.
ostream & operator<<(ostream & s,const BaseIntrConstDLIterC<GraphAdjRepC> & elm)

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

GraphAdjIterC<class NodeT,class EdgeT>

Adjacency iterator.

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