sgm::Graph_Interface::Edge_iterator Class Reference

#include <Graph_Interface.hh>

Public Member Functions
	Edge_iterator ()
	Default construction. More...
	Edge_iterator (const OutEdge_iterator &curEdge, const OutEdge_iterator &edgeEnd, const IndexType &toIndex)
bool	operator!= (const Edge_iterator &it) const
const EdgeDescriptor &	operator* () const
Edge_iterator &	operator++ ()
	Prefix increment (++I) to next element. More...
Edge_iterator	operator++ (int)
	Postfix increment (I++) to next element. More...
const EdgeDescriptor *const	operator-> () const
bool	operator== (const Edge_iterator &it) const

Protected Attributes
OutEdge_iterator	curEdge
	The OutEdge_iterator used to enumerate the edges. More...
OutEdge_iterator	edgeEnd
	The OutEdge_iterator marking the end of the enumeration. More...
const size_t	toIndex
	The targeted index of the edges to be reported. More...

Detailed Description

Generic constant iterator class to enumerate the edges between two nodes. It uses the OutEdge_iterator interface to perform the enumeration. For each edge an EdgeDescriptor is provided.

Definition at line 160 of file Graph_Interface.hh.

Constructor & Destructor Documentation

sgm::Graph_Interface::Edge_iterator::Edge_iterator

(

)

sgm::Graph_Interface::Edge_iterator::Edge_iterator	(	const OutEdge_iterator &	curEdge,
		const OutEdge_iterator &	edgeEnd,
		const IndexType &	toIndex
	)

Construction from data

Parameters

curEdge	the begin of the outEdges to iterator
edgeEnd	the end of the outEdges to iterator
toIndex	the targeted index of the edges to be reported

Member Function Documentation

bool sgm::Graph_Interface::Edge_iterator::operator!=

(

const Edge_iterator &

it

)

const

Inequality comparison

Returns

true if both iterators are NOT pointing to the same edge

const EdgeDescriptor& sgm::Graph_Interface::Edge_iterator::operator*

(

)

const

access to the descriptive data of the current edge

Returns

the current edge data

Edge_iterator& sgm::Graph_Interface::Edge_iterator::operator++

(

)

Edge_iterator sgm::Graph_Interface::Edge_iterator::operator++

(

int

)

const EdgeDescriptor* const sgm::Graph_Interface::Edge_iterator::operator->

(

)

const

access to the descriptive data of the current edge

Returns

the current edge data

bool sgm::Graph_Interface::Edge_iterator::operator==

(

const Edge_iterator &

it

)

const

Equality comparison

Returns

true if both iterators are pointing to the same edge

Field Documentation

OutEdge_iterator sgm::Graph_Interface::Edge_iterator::curEdge

protected

Definition at line 164 of file Graph_Interface.hh.

OutEdge_iterator sgm::Graph_Interface::Edge_iterator::edgeEnd

protected

Definition at line 166 of file Graph_Interface.hh.

const size_t sgm::Graph_Interface::Edge_iterator::toIndex

protected

Definition at line 168 of file Graph_Interface.hh.

---

The documentation for this class was generated from the following file:

• src/sgm/Graph_Interface.hh