STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types
stapl::sequential::edge_reference< BaseIterator > Class Template Reference

Class to provide a reference to an edge object.Provides the interface of a graph edge. This is the type returned when a adj/edge iterator is dereferenced. More...

Public Member Functions

 edge_reference (BaseIterator ref)
 Create an edge reference based on the provided iterator.
 
edge_descriptor descriptor () const
 Return the descriptor of the edge.
 
vertex_descriptor source () const
 Return the vertex descriptor of the source vertex of the edge.
 
vertex_descriptor target () const
 Return the vertex descriptor of the target vertex of the edge.
 
edge_id_type id () const
 Return the ID of the edge.
 
property_reference property () const
 Return the property of the edge.
 

Public Types

typedef std::iterator_traits< BaseIterator >::value_type::edge_descriptor_type edge_descriptor
 
typedef std::iterator_traits< BaseIterator >::value_type::property_type property_type
 
typedef _hei< reference >::type & property_reference
 
typedef edge_descriptor::vertex_descriptor vertex_descriptor
 
typedef edge_descriptor::edge_id_type edge_id_type
 

Detailed Description

template<class BaseIterator>
class stapl::sequential::edge_reference< BaseIterator >

Class to provide a reference to an edge object.

Provides the interface of a graph edge. This is the type returned when a adj/edge iterator is dereferenced.

Template Parameters
BaseIteratorThe type of the edge iterator.

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