[private]Represents the vertices and edges for a list of geometries. More...

#include <GeometryGraph.h>

Public Types
using	vertex_properties = VertexProperties
	Vertex properties type. More...

using	edge_properties = EdgeProperties
	Edge properties type. More...

typedef boost::adjacency_list< boost::listS, boost::listS, boost::bidirectionalS, vertex_properties, edge_properties >	graph_t
	the wrapped graphEdgeProperties More...

typedef boost::graph_traits< graph_t >::vertex_descriptor	vertex_descriptor
	Vertex descriptor type from boost graph. More...

typedef boost::graph_traits< graph_t >::edge_descriptor	edge_descriptor
	Edge descriptor type from boost graph. More...

typedef boost::graph_traits< graph_t >::vertex_iterator	vertex_iterator
	Vertex iterator type. More...

typedef boost::graph_traits< graph_t >::edge_iterator	edge_iterator
	Edge iterator type. More...

using	directed_edge_descriptor = std::pair< edge_descriptor, EdgeDirection >
	An edge descriptor, with a direction. More...

typedef boost::graph_traits< graph_t >::in_edge_iterator	in_edge_iterator
	Incoming edge iterator type. More...

typedef boost::graph_traits< graph_t >::out_edge_iterator	out_edge_iterator
	Outgoing edge iterator type. More...

Public Member Functions
size_t	numVertices () const
	Returns the number of vertices. More...

std::pair< vertex_iterator, vertex_iterator >	vertices () const
	Return vertex iterator pair. More...

vertex_descriptor	addVertex (const vertex_properties &properties=vertex_properties())
	Add a vertex to the graph. More...

void	removeVertex (const vertex_descriptor &vertex)
	Remove a vertex (and all its adjacent edges) More...

size_t	numEdges () const
	Returns the number of edges. More...

std::pair< edge_iterator, edge_iterator >	edges () const
	Return edge iterator pair. More...

edge_descriptor	addEdge (const vertex_descriptor &source, const vertex_descriptor &target, const EdgeProperties &properties=EdgeProperties())
	Add an Edge to the Graph. More...

vertex_descriptor	source (const edge_descriptor &edge) const
	Get the source vertex for an edge. More...

vertex_descriptor	source (const edge_descriptor &edge, const EdgeDirection &direction) const
	Get the source vertex for an edge with direction. More...

vertex_descriptor	source (const directed_edge_descriptor &edge) const
	Get the source vertex for a directed edge. More...

vertex_descriptor	target (const edge_descriptor &edge) const
	Get the target vertex for an edge. More...

vertex_descriptor	target (const edge_descriptor &edge, const EdgeDirection &direction) const
	Get the target vertex for an edge with direction. More...

vertex_descriptor	target (const directed_edge_descriptor &edge) const
	Get the target vertex for a directed edge. More...

void	removeEdge (const edge_descriptor &edge)
	Remove an edge. More...

std::vector< directed_edge_descriptor >	edges (const vertex_descriptor &a, const vertex_descriptor &b) const
	Get edges from a to b and from b to a. More...

size_t	degree (const vertex_descriptor &vertex) const
	Returns the degree of a vertex. More...

std::vector< edge_descriptor >	inEdges (const vertex_descriptor &vertex)
	Get in edges for a vertex. More...

std::vector< edge_descriptor >	outEdges (const vertex_descriptor &vertex) const
	Get out edges for a vertex. More...

std::vector< directed_edge_descriptor >	inOutEdges (const vertex_descriptor &vertex) const
	Get in/out edges for a vertex. More...

std::set< vertex_descriptor >	adjacentVertices (const vertex_descriptor &vertex, bool withReverseDirection=true)
	Returns the list of the adjacent vertices using both DIRECT and REVERSE direction. More...

bool	areOpposite (const edge_descriptor &a, const edge_descriptor &b) const
	Indicates if edges are opposite. More...

bool	areParallel (const edge_descriptor &a, const edge_descriptor &b) const
	Indicates if edges are parallel. More...

void	reverse (std::vector< edge_descriptor > &edges)
	Revert the order of a list of edges. More...

const vertex_properties &	operator[] (const vertex_descriptor &vertex) const
	Returns the VertexProperties attached to a Vertex. More...

vertex_properties &	operator[] (const vertex_descriptor &vertex)
	Returns the VertexProperties attached to a Vertex. More...

const edge_properties &	operator[] (const edge_descriptor &edge) const
	Returns the EdgeProperties attached to an Edge. More...

edge_properties &	operator[] (const edge_descriptor &edge)
	Returns the EdgeProperties attached to an Edge. More...

graph_t &	graph ()
	Returns the wrapped boost::graph. More...

const graph_t &	graph () const
	Returns the wrapped boost::graph. More...

	operator graph_t & (void)
	implicit cast to the wrapped boost graph in order to keep boost graph interface More...

	operator const graph_t & (void) const
	implicit cast to the wrapped boost graph in order to keep boost graph interface More...

Detailed Description

template<typename VertexProperties, typename EdgeProperties>
class SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >

[private]Represents the vertices and edges for a list of geometries.

A boost::adjancency_list is wrapped in order to be able to annex some information and to provide basic functionalities.

Warning: duplicate matching is performed in GeometryGraphBuilder (allows to modify position once it's done)

Member Typedef Documentation

template<typename VertexProperties , typename EdgeProperties >

using SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::directed_edge_descriptor = std::pair<edge_descriptor, EdgeDirection>

An edge descriptor, with a direction.

From the vertex point of view, out edges are DIRECT, in edges are REVERSE.

template<typename VertexProperties , typename EdgeProperties >

typedef boost::graph_traits<graph_t>::edge_descriptor SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::edge_descriptor

Edge descriptor type from boost graph.

template<typename VertexProperties , typename EdgeProperties >

typedef boost::graph_traits<graph_t>::edge_iterator SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::edge_iterator

Edge iterator type.

template<typename VertexProperties , typename EdgeProperties >

using SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::edge_properties = EdgeProperties

Edge properties type.

template<typename VertexProperties , typename EdgeProperties >

typedef boost::adjacency_list< boost::listS, boost::listS, boost::bidirectionalS, vertex_properties, edge_properties> SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::graph_t

the wrapped graphEdgeProperties

template<typename VertexProperties , typename EdgeProperties >

typedef boost::graph_traits<graph_t>::in_edge_iterator SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::in_edge_iterator

Incoming edge iterator type.

template<typename VertexProperties , typename EdgeProperties >

typedef boost::graph_traits<graph_t>::out_edge_iterator SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::out_edge_iterator

Outgoing edge iterator type.

template<typename VertexProperties , typename EdgeProperties >

typedef boost::graph_traits<graph_t>::vertex_descriptor SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::vertex_descriptor

Vertex descriptor type from boost graph.

template<typename VertexProperties , typename EdgeProperties >

typedef boost::graph_traits<graph_t>::vertex_iterator SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::vertex_iterator

Vertex iterator type.

template<typename VertexProperties , typename EdgeProperties >

using SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::vertex_properties = VertexProperties

Vertex properties type.

Member Function Documentation

template<typename VertexProperties , typename EdgeProperties >

edge_descriptor SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::addEdge	(	const vertex_descriptor &	source,
		const vertex_descriptor &	target,
		const EdgeProperties &	properties = `EdgeProperties()`
	)

inline

Add an Edge to the Graph.

Parameters

source	The source vertex descriptor
target	The target vertex descriptor
properties	The properties for the new edge

Returns: The identifier of the edge

template<typename VertexProperties , typename EdgeProperties >

vertex_descriptor SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::addVertex ( const vertex_properties & properties = vertex_properties() )

inline

Add a vertex to the graph.

Parameters

properties The properties for the new vertex

Returns: The identifier of the vertex

template<typename VertexProperties , typename EdgeProperties >

std::set<vertex_descriptor> SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::adjacentVertices	(	const vertex_descriptor &	vertex,
		bool	withReverseDirection = `true`
	)

inline

Returns the list of the adjacent vertices using both DIRECT and REVERSE direction.

Parameters

vertex	Input vertex
withReverseDirection	Indicates if in_edges are used

Returns: Set of adjacent vertex descriptors

template<typename VertexProperties , typename EdgeProperties >

bool SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::areOpposite	(	const edge_descriptor &	a,
		const edge_descriptor &	b
	)		const

inline

Indicates if edges are opposite.

Parameters

a	First edge descriptor
b	Second edge descriptor

Returns: True if edges are opposite

template<typename VertexProperties , typename EdgeProperties >

bool SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::areParallel	(	const edge_descriptor &	a,
		const edge_descriptor &	b
	)		const

inline

Indicates if edges are parallel.

Parameters

a	First edge descriptor
b	Second edge descriptor

Returns: True if edges are parallel

template<typename VertexProperties , typename EdgeProperties >

size_t SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::degree ( const vertex_descriptor & vertex ) const

inline

Returns the degree of a vertex.

Parameters

vertex The vertex descriptor

Returns: The degree of the vertex

template<typename VertexProperties , typename EdgeProperties >

std::pair<edge_iterator, edge_iterator> SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::edges ( ) const

inline

Return edge iterator pair.

Returns: Pair of edge iterators (begin, end)

typename GeometryGraph<V,E>::edge_iterator it, end ;
for ( boost::tie( it, end ) = g.edges(); it != end; ++it ){
                typename GeometryGraph<V,E>::edge_descriptor edge = *it ;
                std::cout << g.source(edge) << "," << g.target(edge) << std::endl;
}

template<typename VertexProperties , typename EdgeProperties >

std::vector<directed_edge_descriptor> SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::edges	(	const vertex_descriptor &	a,
		const vertex_descriptor &	b
	)		const

inline

Get edges from a to b and from b to a.

Parameters

a	First vertex descriptor
b	Second vertex descriptor

Returns: Vector of directed edge descriptors connecting the vertices

template<typename VertexProperties , typename EdgeProperties >

graph_t& SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::graph ( )

inline

Returns the wrapped boost::graph.

Returns: Reference to the underlying graph

template<typename VertexProperties , typename EdgeProperties >

const graph_t& SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::graph ( ) const

inline

Returns the wrapped boost::graph.

Returns: Const reference to the underlying graph

template<typename VertexProperties , typename EdgeProperties >

std::vector<edge_descriptor> SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::inEdges ( const vertex_descriptor & vertex )

inline

Get in edges for a vertex.

Parameters

vertex The vertex descriptor

Returns: Vector of incoming edge descriptors

template<typename VertexProperties , typename EdgeProperties >

std::vector<directed_edge_descriptor> SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::inOutEdges ( const vertex_descriptor & vertex ) const

inline

Get in/out edges for a vertex.

Parameters

vertex The vertex descriptor

Returns: Vector of directed edge descriptors (in and out edges)

template<typename VertexProperties , typename EdgeProperties >

size_t SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::numEdges ( ) const

inline

Returns the number of edges.

Returns: The number of edges in the graph

template<typename VertexProperties , typename EdgeProperties >

size_t SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::numVertices ( ) const

inline

Returns the number of vertices.

Returns: The number of vertices in the graph

template<typename VertexProperties , typename EdgeProperties >

SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::operator const graph_t & ( void ) const

inline

implicit cast to the wrapped boost graph in order to keep boost graph interface

template<typename VertexProperties , typename EdgeProperties >

SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::operator graph_t & ( void )

inline

implicit cast to the wrapped boost graph in order to keep boost graph interface

template<typename VertexProperties , typename EdgeProperties >

const vertex_properties& SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::operator[] ( const vertex_descriptor & vertex ) const

inline

Returns the VertexProperties attached to a Vertex.

Parameters

vertex The vertex descriptor

Returns: Const reference to vertex properties

template<typename VertexProperties , typename EdgeProperties >

vertex_properties& SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::operator[] ( const vertex_descriptor & vertex )

inline

Returns the VertexProperties attached to a Vertex.

Parameters

vertex The vertex descriptor

Returns: Reference to vertex properties

template<typename VertexProperties , typename EdgeProperties >

const edge_properties& SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::operator[] ( const edge_descriptor & edge ) const

inline

Returns the EdgeProperties attached to an Edge.

Parameters

edge	The edge descriptor

Returns: Const reference to edge properties

template<typename VertexProperties , typename EdgeProperties >

edge_properties& SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::operator[] ( const edge_descriptor & edge )

inline

Returns the EdgeProperties attached to an Edge.

Parameters

edge	The edge descriptor

Returns: Reference to edge properties

template<typename VertexProperties , typename EdgeProperties >

std::vector<edge_descriptor> SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::outEdges ( const vertex_descriptor & vertex ) const

inline

Get out edges for a vertex.

Parameters

vertex The vertex descriptor

Returns: Vector of outgoing edge descriptors

template<typename VertexProperties , typename EdgeProperties >

void SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::removeEdge ( const edge_descriptor & edge )

inline

Remove an edge.

Parameters

edge	The edge descriptor to remove

template<typename VertexProperties , typename EdgeProperties >

void SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::removeVertex ( const vertex_descriptor & vertex )

inline

Remove a vertex (and all its adjacent edges)

Parameters

vertex The vertex descriptor to remove

template<typename VertexProperties , typename EdgeProperties >

void SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::reverse ( std::vector< edge_descriptor > & edges )

inline

Revert the order of a list of edges.

Old edges are removed from the graph, new ones are created.

Parameters

edges Vector of edge descriptors to reverse

Warning: properties are kept but oriented one (left face, right face, etc.) are lost.

template<typename VertexProperties , typename EdgeProperties >

vertex_descriptor SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::source ( const edge_descriptor & edge ) const

inline

Get the source vertex for an edge.

Parameters

edge	The edge descriptor

Returns: The source vertex descriptor

template<typename VertexProperties , typename EdgeProperties >

vertex_descriptor SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::source	(	const edge_descriptor &	edge,
		const EdgeDirection &	direction
	)		const

inline

Get the source vertex for an edge with direction.

Parameters

edge	The edge descriptor
direction	The edge direction

Returns: The source vertex descriptor

template<typename VertexProperties , typename EdgeProperties >

vertex_descriptor SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::source ( const directed_edge_descriptor & edge ) const

inline

Get the source vertex for a directed edge.

Parameters

edge	The directed edge descriptor

Returns: The source vertex descriptor

template<typename VertexProperties , typename EdgeProperties >

vertex_descriptor SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::target ( const edge_descriptor & edge ) const

inline

Get the target vertex for an edge.

Parameters

edge	The edge descriptor

Returns: The target vertex descriptor

template<typename VertexProperties , typename EdgeProperties >

vertex_descriptor SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::target	(	const edge_descriptor &	edge,
		const EdgeDirection &	direction
	)		const

inline

Get the target vertex for an edge with direction.

Parameters

edge	The edge descriptor
direction	The edge direction

Returns: The target vertex descriptor

template<typename VertexProperties , typename EdgeProperties >

vertex_descriptor SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::target ( const directed_edge_descriptor & edge ) const

inline

Get the target vertex for a directed edge.

Parameters

edge	The directed edge descriptor

Returns: The target vertex descriptor

template<typename VertexProperties , typename EdgeProperties >

std::pair<vertex_iterator, vertex_iterator> SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >::vertices ( ) const

inline

Return vertex iterator pair.

Returns: Pair of vertex iterators (begin, end)

typename GeometryGraph<V,E>::vertex_iterator it, end ;
for ( boost::tie( it, end ) = g.vertices(); it != end; ++it ){
                typename GeometryGraph<V,E>::vertex_descriptor vertex = *it ;
                std::cout << g[ vertex ].coordinate << std::endl;
}

Public Types

Public Member Functions

Detailed Description

template<typename VertexProperties, typename EdgeProperties> class SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >

Member Typedef Documentation

Member Function Documentation

template<typename VertexProperties, typename EdgeProperties>
class SFCGAL::graph::GeometryGraphT< VertexProperties, EdgeProperties >