stapl::sequential::bgl_edge_descriptor_adaptor< BGLGraph > Class Template Reference

STAPL adaptor for the BGL edge descriptor. More...

Public Member Functions
	bgl_edge_descriptor_adaptor (vertex_descriptor _s, vertex_descriptor _t)
	Initializes the edge descriptor adaptor with a source and a target. More...
	bgl_edge_descriptor_adaptor (vertex_descriptor _s, vertex_descriptor _t, size_t)
	Initializes the edge descriptor adaptor with a source and a target. More...
	bgl_edge_descriptor_adaptor (const bgl_edge_descriptor &_ed, size_t _eid=INVALID_VALUE, BGLGraph *_g=NULL)
	Initializes the edge descriptor adaptor with a BGL edge descriptor, an optional edge id and a graph. More...
edge_descriptor	descriptor (void) const
	Returns the edge descriptor of this adaptor.
vertex_descriptor	source (void) const
	Returns the source vertex of the edge descriptor of this adaptor.
vertex_descriptor	target (void) const
	Returns the target vertex of the edge descriptor of this adaptor.
size_t	id (void) const
	Returns the ID of the edge descriptor of this adaptor.
void	display () const
	Prints informations about the edge descriptor.

Public Types
typedef boost::property_map< BGLGraph, boost::vertex_name_t >::type::value_type	vertex_descriptor
typedef bgl_edge_descriptor_adaptor< BGLGraph >	edge_descriptor

Friends
template<class G >
class	bgl_graph

Detailed Description

template<class BGLGraph>
class stapl::sequential::bgl_edge_descriptor_adaptor< BGLGraph >

STAPL adaptor for the BGL edge descriptor.

Template Parameters

BGLGraph

Type of the boost graph.

Constructor & Destructor Documentation

bgl_edge_descriptor_adaptor() [1/3]

template<class BGLGraph >

stapl::sequential::bgl_edge_descriptor_adaptor< BGLGraph >::bgl_edge_descriptor_adaptor	(	vertex_descriptor	_s,
		vertex_descriptor	_t
	)

Initializes the edge descriptor adaptor with a source and a target.

Parameters

_s,_t

The source and target vertices.

bgl_edge_descriptor_adaptor() [2/3]

template<class BGLGraph >

stapl::sequential::bgl_edge_descriptor_adaptor< BGLGraph >::bgl_edge_descriptor_adaptor	(	vertex_descriptor	_s,
		vertex_descriptor	_t,
		size_t
	)

Initializes the edge descriptor adaptor with a source and a target.

Parameters

_s,_t

The source and target vertices.

bgl_edge_descriptor_adaptor() [3/3]

template<class BGLGraph >

stapl::sequential::bgl_edge_descriptor_adaptor< BGLGraph >::bgl_edge_descriptor_adaptor	(	const bgl_edge_descriptor &	_ed,
		size_t	_eid = INVALID_VALUE,
		BGLGraph *	_g = NULL
	)

Initializes the edge descriptor adaptor with a BGL edge descriptor, an optional edge id and a graph.

Parameters

_ed	A BGL edge descriptor.
_eid	An edge ID, by default it is an INVALID_VALUE
_g	A pointer to the graph. By default points to NULL.

---

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

• bgl_core_graph.h