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

The Graph Edge with edge property storage. More...

Public Member Functions

 graph_property_edge (edge_descriptor_type const &ed, property_type const &p)
 Creates an edge for the graph with the given descriptor and property. More...
 
property_reference property (void) noexcept
 
const_property_reference property (void) const noexcept
 
edge_descriptor_type descriptor (void) const noexcept
 
edge_id_type id (void) const noexcept
 
vertex_descriptor source (void) const noexcept
 
vertex_descriptor target (void) const noexcept
 

Public Types

typedef VertexDescriptor vertex_descriptor
 
typedef edge_descriptor_impl< vertex_descriptor > edge_descriptor_type
 
typedef edge_descriptor_type::edge_id_type edge_id_type
 
typedef Property property_type
 
typedef Propertyproperty_reference
 
typedef Property const & const_property_reference
 

Protected Attributes

edge_descriptor_type m_ed
 The edge descriptor for this edge.
 
property_type m_property
 The property of this edge.
 

Friends

graph_property_edge reverse (graph_property_edge const &other)
 Reverses the edge descriptor of an edge. More...
 

Detailed Description

template<typename VertexDescriptor, typename Property>
class stapl::sequential::graph_property_edge< VertexDescriptor, Property >

The Graph Edge with edge property storage.

If the graph uses no_property for the edge property type, then the graph edge contains just the edge_descriptor_impl. If the graph is with properties then the edge contains an edge_descriptor and the property.

Constructor & Destructor Documentation

◆ graph_property_edge()

template<typename VertexDescriptor , typename Property >
stapl::sequential::graph_property_edge< VertexDescriptor, Property >::graph_property_edge ( edge_descriptor_type const &  ed,
property_type const &  p 
)

Creates an edge for the graph with the given descriptor and property.

Parameters
edThe descriptor of this edge.
pThe property of this edge.

Friends And Related Function Documentation

◆ reverse

template<typename VertexDescriptor , typename Property >
graph_property_edge reverse ( graph_property_edge< VertexDescriptor, Property > const &  other)
friend

Reverses the edge descriptor of an edge.

Parameters
edThe edge.
Returns
An edge with the same property and id as the input edge, but with source and target descriptors switched.

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