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

The Graph Edge with edge property storage for an undirected graph.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_impl and the property. The property of the edge for undirected graphs is stored as a pointer and shared between two sister edges, because edges will always be added in pairs and they will have to have the same property. More...

Public Member Functions

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

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
 

Protected Member Functions

void clear ()
 Deletes the property of this edge.
 

Protected Attributes

edge_descriptor_type m_ed
 The edge descriptor for this edge.
 
property_typem_property
 The property of this edge.
 

Friends

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

Detailed Description

template<class VertexDescriptor, class Property>
class stapl::sequential::undirected_graph_edge_property< VertexDescriptor, Property >

The Graph Edge with edge property storage for an undirected graph.

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_impl and the property. The property of the edge for undirected graphs is stored as a pointer and shared between two sister edges, because edges will always be added in pairs and they will have to have the same property.

Constructor & Destructor Documentation

◆ undirected_graph_edge_property()

template<class VertexDescriptor , class Property >
stapl::sequential::undirected_graph_edge_property< VertexDescriptor, Property >::undirected_graph_edge_property ( edge_descriptor_type  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<class VertexDescriptor , class Property >
this_type reverse ( this_type const &  other)
friend

Reverses the edge descriptor of an edge.

Parameters
otherThe edge to reverse.
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: