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::const_dpg_vertex_reference< BaseReference, UserProperty > Class Template Reference

Class to provide a const reference to a vertex object for the directed_preds_graph.Provides the interface of a graph vertex, with additional functionality for working with predecessors. This is the type returned when a const vertex iterator is dereferenced. More...

Public Member Functions

 const_dpg_vertex_reference (BaseReference ref)
 Create a vertex reference based on the provided iterator.
 
user_property_type const & property () const
 Return the user property. This provides transparent access to the user property from the actual property stored in the graph.
 
predlist_type const & predecessors () const
 Return the predecessors of this vertex.
 
vertex_descriptor descriptor () const
 Return the descriptor of the vertex.
 
property_reference property ()
 Return the property of the vertex.
 
adj_edge_iterator begin ()
 Return the beginning of the vertex's edgelist.
 
adj_edge_iterator end ()
 Return the end of the vertex's edgelist.
 
size_t size (void) const
 Return the size of the vertex's edgelist.
 
adj_edges_type edges () const
 Return a view over the vertex's edgelist.
 

Public Types

typedef internal_value_type::vertex_descriptor vertex_descriptor
 
typedef internal_value_type::property_type property_type
 
typedef _hei_it< reference >::iterator adj_edge_iterator
 
typedef ve_view< edgelist_type, adj_edge_iterator > adj_edge_view
 
typedef _hei_usr_prop< reference >::user_property_type user_property_type
 
typedef property_type::predlist_type predlist_type
 
typedef _hei< reference >::type & property_reference
 
typedef ve_view< edgelist_type, adj_edge_iterator > adj_edges_type
 

Protected Attributes

BaseReference m_ref
 

Detailed Description

template<typename BaseReference, typename UserProperty>
class stapl::sequential::const_dpg_vertex_reference< BaseReference, UserProperty >

Class to provide a const reference to a vertex object for the directed_preds_graph.

Provides the interface of a graph vertex, with additional functionality for working with predecessors. This is the type returned when a const vertex iterator is dereferenced.

Template Parameters
BaseReferenceThe type of the base vertex iterator.
UserPropertyThe type of the user vertex property.

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