STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types | Protected Attributes
stapl::sequential::bgl_vertex_reference< BaseReference, BGLGraph > Class Template Reference

BGL vertex reference wrapper. More...

Public Member Functions

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

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< out_edge_iteratoradj_edge_view
 

Protected Attributes

BaseReference m_ref
 
BGLGraph * m_graph
 

Detailed Description

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

BGL vertex reference wrapper.

Template Parameters
BaseReferenceType of the BGL vertex.
BGLGraphType of the boost graph.

Constructor & Destructor Documentation

◆ bgl_vertex_reference()

template<typename BaseReference , typename BGLGraph >
stapl::sequential::bgl_vertex_reference< BaseReference, BGLGraph >::bgl_vertex_reference ( BaseReference  _ref,
BGLGraph *  _graph 
)

Initializes a vertex.

Parameters
_refThe BGL vertex to be wrapped.
_graphThe graph which contains the vertex.

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