#include <DGtal/graph/DigitalSurfaceBoostGraphInterface.h>

Data Structures
class	adjacency_iterator

class	edge_iterator

class	out_edge_iterator

Public Types
typedef DGtal::DigitalSurface< TDigitalSurfaceContainer >	Adapted
	the adapted DGtal graph class. More...

typedef undirected_tag	directed_category
	the graph is undirected. More...

typedef DigitalSurface_graph_traversal_category	traversal_category
	the graph satisfies AdjacencyListGraph and VertexListGraph concepts. More...

typedef disallow_parallel_edge_tag	edge_parallel_category
	the graph does not allow parallel edges. More...

typedef Adapted::Size	vertices_size_type
	the type for counting vertices More...

typedef Adapted::Size	edges_size_type
	the type for counting edges More...

typedef Adapted::Size	degree_size_type
	the type for counting out or in edges More...

typedef Adapted::Vertex	Vertex
	Vertex type. More...

typedef Vertex	vertex_descriptor
	Vertex type. More...

typedef Adapted::Arc	Arc
	(oriented) edge type More...

typedef Arc	edge_descriptor
	(oriented) edge type More...

typedef Adapted::ConstIterator	vertex_iterator

typedef std::vector< vertex_descriptor >	AdjacentVertexContainer
	This is the intermediate data structure that is used for visiting adjacent vertices. More...

typedef Adapted::ArcRange	OutEdgeContainer
	This is the intermediate data structure that is used for storing out edges. More...

Static Public Member Functions
static vertex_descriptor	null_vertex ()

Detailed Description

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

Defines the boost graph traits for any kind of digital surface (see DGtal::DigitalSurface). With these definitions, a DGtal::DigitalSurface is a model of VertexListGraphConcept, AdjacencyGraphConcept, IncidenceGraphConcept, EdgeListGraphConcept. You may use DGtal::DigitalSurface as is in BOOST graph algorithms (see http://www.boost.org/doc/libs/1_52_0/libs/graph/doc/table_of_contents.html).

The difficult part is that models of DGtal::CUndirectedSimpleGraph (like DGtal::DigitalSurface) are only required to provide vertex iterators that are models of SinglePassIterator. Furthermore, no edge iterators are required, only the list of adjacent vertices. Therefore, most of the work is to create iterators over edges that are "persistent", i.e. models of MultiPassInputIterator (very similar to ForwardIterator).

Remarks: Note that, for now, vertex iterators are taken as is from the DGtal::DigitalSurface container. Hence, they must be models of MultiPassInputIterator. This is the case for containers DGtal::SetOfSurfels, DGtal::DigitalSetBoundary, DGtal::ImplicitDigitalSurface, DGtal::ExplicitDigitalSurface. This is not the case of containers DGtal::LightImplicitDigitalSurface and DGtal::LightExplicitDigitalSurface.

Template Parameters

TDigitalSurfaceContainer the container chosen for the digital surface. Should work with DGtal::DigitalSetBoundary, DGtal::SetOfSurfels, DGtal::ExplicitDigitalSurface, DGtal::ImplicitDigitalSurface. DGtal::LightImplicitDigitalSurface and DGtal::LightExplicitDigitalSurface containers may not work since their vertex iterator is not multipass.

Definition at line 93 of file DigitalSurfaceBoostGraphInterface.h.