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::edge_descriptor_impl< VertexDescriptor > Class Template Reference

Implementation of the edge descriptor. More...

Public Member Functions

 edge_descriptor_impl (vertex_descriptor const &s, vertex_descriptor const &t, edge_id_type eid=INVALID_VALUE)
 
vertex_descriptor source (void) const noexcept
 
vertex_descriptor target (void) const noexcept
 
edge_id_type id (void) const noexcept
 
void display (void) const
 
bool operator== (edge_descriptor_impl const &other) const noexcept
 
bool operator!= (edge_descriptor_impl const &other) const noexcept
 

Public Types

typedef VertexDescriptor vertex_descriptor
 
typedef size_t edge_id_type
 

Protected Attributes

vertex_descriptor m_source
 The vertex descriptor of the source vertex for this edge.
 
vertex_descriptor m_target
 The vertex descriptor of the target vertex for this edge.
 
edge_id_type m_id
 The unique id for this edge. More...
 

Friends

edge_descriptor_impl reverse (edge_descriptor_impl const &t)
 Reverses the edge descriptor. More...
 

Detailed Description

template<class VertexDescriptor>
class stapl::edge_descriptor_impl< VertexDescriptor >

Implementation of the edge descriptor.

Template Parameters
VertexDescriptorThe type of the vertex descriptor.

Friends And Related Function Documentation

◆ reverse

template<class VertexDescriptor>
edge_descriptor_impl reverse ( edge_descriptor_impl< VertexDescriptor > const &  t)
friend

Reverses the edge descriptor.

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

Member Data Documentation

◆ m_id

template<class VertexDescriptor>
edge_id_type stapl::edge_descriptor_impl< VertexDescriptor >::m_id
protected

The unique id for this edge.

This differentiates between multiple edges between the same source and target vertices.


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