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::vertex_reference< BaseIterator > Class Template Reference

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

Public Member Functions

 vertex_reference (BaseIterator ref)
 Create a vertex reference based on the provided iterator.
 
 vertex_reference (vertex_reference const &other)
 
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< reference >::type & property_reference
 
typedef _hei_it< reference >::iterator adj_edge_iterator
 
typedef ve_view< edgelist_type, adj_edge_iterator > adj_edges_type
 

Protected Attributes

BaseIterator m_ref
 

Detailed Description

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

Class to provide a reference to a vertex object.

Provides the interface of a graph vertex. This is the type returned when a vertex iterator is dereferenced.

Template Parameters
BaseIteratorThe type of the vertex iterator.

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