stapl::sequential::const_bgl_vertex_reference< BaseReference, BGLGraph > Class Template Reference

BGL vertex reference wrapper. More...

Public Member Functions
	const_bgl_vertex_reference (BaseReference _ref, const BGLGraph *_graph)
	Initializes a vertex. More...
size_t	descriptor () const
	Returns the vertex descriptor of this edge. More...
const property_type &	property ()
	Returns a reference to the vertex property. More...
const_out_edge_iterator	begin ()
	Returns an iterator pointing to the begin of all the out edges of this vertex. More...
const_out_edge_iterator	end ()
	Returns an iterator pointing to the end of all the out edges of this vertex. More...
size_t	size (void) const
	Returns the out degree of this vertex. More...
adj_edge_view	edges () const
	Returns a view on the edges of this vertex. More...

Public Types
typedef boost::property_map< BGLGraph, boost::vertex_name_t >::type::value_type	vertex_descriptor
typedef std::iterator_traits< BaseReference >::value_type	value_type
typedef boost::property_map< BGLGraph, boost::vertex_user_property_t >::type::value_type	property_type
typedef bgl_ve_view< const_out_edge_iterator >	adj_edge_view

Protected Attributes
BaseReference	m_ref
const BGLGraph *	m_graph

Detailed Description

template<typename BaseReference, typename BGLGraph>
class stapl::sequential::const_bgl_vertex_reference< BaseReference, BGLGraph >

BGL vertex reference wrapper.

Template Parameters

BaseReference	Type of the BGL vertex.
BGLGraph	Type of the boost graph.

Constructor & Destructor Documentation

const_bgl_vertex_reference()

template<typename BaseReference , typename BGLGraph >

stapl::sequential::const_bgl_vertex_reference< BaseReference, BGLGraph >::const_bgl_vertex_reference	(	BaseReference	_ref,
		const BGLGraph *	_graph
	)

Initializes a vertex.

Parameters

_ref	The BGL vertex to be wrapped.
_graph	The graph which contains the vertex.

Member Function Documentation

descriptor()

template<typename BaseReference , typename BGLGraph >

size_t stapl::sequential::const_bgl_vertex_reference< BaseReference, BGLGraph >::descriptor

(

void

)

const

Returns the vertex descriptor of this edge.

property()

template<typename BaseReference , typename BGLGraph >

const property_type& stapl::sequential::const_bgl_vertex_reference< BaseReference, BGLGraph >::property

(

void

)

Returns a reference to the vertex property.

begin()

template<typename BaseReference , typename BGLGraph >

const_out_edge_iterator stapl::sequential::const_bgl_vertex_reference< BaseReference, BGLGraph >::begin

(

void

)

Returns an iterator pointing to the begin of all the out edges of this vertex.

end()

template<typename BaseReference , typename BGLGraph >

const_out_edge_iterator stapl::sequential::const_bgl_vertex_reference< BaseReference, BGLGraph >::end

(

void

)

Returns an iterator pointing to the end of all the out edges of this vertex.

size()

template<typename BaseReference , typename BGLGraph >

size_t stapl::sequential::const_bgl_vertex_reference< BaseReference, BGLGraph >::size

(

void

)

const

Returns the out degree of this vertex.

edges()

template<typename BaseReference , typename BGLGraph >

adj_edge_view stapl::sequential::const_bgl_vertex_reference< BaseReference, BGLGraph >::edges

(

void

)

const

Returns a view on the edges of this vertex.

---

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

• bgl_core_graph.h