DGtal  0.9.3beta
Public Member Functions | Private Member Functions | Private Attributes | Friends
boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator Class Reference

#include <DGtal/graph/DigitalSurfaceBoostGraphInterface.h>

Inheritance diagram for boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator:
[legend]
Collaboration diagram for boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator:
[legend]

Public Member Functions

 edge_iterator ()
 
 edge_iterator (ConstAlias< Adapted > graph, const vertex_iterator &itB, const vertex_iterator &itE)
 

Private Member Functions

const Arcdereference () const
 
bool equal (const edge_iterator &other) const
 
void increment ()
 

Private Attributes

const AdaptedmyGraph
 
std::pair< vertex_iterator, vertex_iteratormyVertexRange
 
std::pair< out_edge_iterator, out_edge_iterator > myOutEdgeRange
 

Friends

class iterator_core_access
 

Detailed Description

template<class TDigitalSurfaceContainer>
class boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator

Iterator for visiting all edges of the graph. We use an iterator facade to create a STL-compliant iterator with as little effort as possible.

Note
The difficulty is that DGtal graphs do not provide iterators for visiting edges or adjacent vertices, but merely provide a method that outputs them. Therefore, this iterator mixes a vertex_iterator (to visit all vertices) and a local out_edge_iterator (to visit all out edges of each vertex). This is for instance used by function edges, which returns a pair of edge_iterator. A potential problem is that the user may have called twice edges, and may wish to compare iterators obtained by two different calls. Here, edges are constructed on the fly, hence iterators may not point on the same container even if the values are the same.
typedef typename DigitalSurface<...> G;
typedef typename graph_traits<G>::edge_iterator edge_iterator;
G g(...);
std::pair<edge_iterator,edge_iterator> vp1 = boost::edges( g );
std::pair<edge_iterator,edge_iterator> vp2 = boost::edges( g );

In this case, vp1 and vp2 are not pointing on the same structure, hence the address pointed by vp1 is different from the address pointed by vp2. They are then not comparable a priori. The edge_iterator is written so that vp1 (.first or .second) and vp2 (.first or .second) are comparable, using value comparison and out-of-range check.

Definition at line 329 of file DigitalSurfaceBoostGraphInterface.h.

Constructor & Destructor Documentation

template<class TDigitalSurfaceContainer >
boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator::edge_iterator ( )
template<class TDigitalSurfaceContainer >
boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator::edge_iterator ( ConstAlias< Adapted graph,
const vertex_iterator itB,
const vertex_iterator itE 
)

Member Function Documentation

template<class TDigitalSurfaceContainer >
const Arc& boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator::dereference ( ) const
private
template<class TDigitalSurfaceContainer >
bool boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator::equal ( const edge_iterator other) const
private
template<class TDigitalSurfaceContainer >
void boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator::increment ( )
private

Friends And Related Function Documentation

template<class TDigitalSurfaceContainer >
friend class iterator_core_access
friend

Definition at line 349 of file DigitalSurfaceBoostGraphInterface.h.

Field Documentation

template<class TDigitalSurfaceContainer >
const Adapted* boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator::myGraph
private

Definition at line 345 of file DigitalSurfaceBoostGraphInterface.h.

template<class TDigitalSurfaceContainer >
std::pair< out_edge_iterator, out_edge_iterator > boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator::myOutEdgeRange
private

Definition at line 347 of file DigitalSurfaceBoostGraphInterface.h.

template<class TDigitalSurfaceContainer >
std::pair< vertex_iterator, vertex_iterator > boost::graph_traits< DGtal::DigitalSurface< TDigitalSurfaceContainer > >::edge_iterator::myVertexRange
private

Definition at line 346 of file DigitalSurfaceBoostGraphInterface.h.


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