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

Internal property map to access edge properties stored on graph edges. More...

Public Member Functions

 graph_edge_property_map (view_type &graph)
 
 graph_edge_property_map (view_type &graph, Functor f)
 
template<typename Edge , typename Functor2 >
void apply (Edge &e, Functor2 f2)
 Applies the specified functor to the property associated with the provided edge. More...
 
template<typename Edge >
void put (Edge &e, value_type c)
 Sets the property associated with the provided edge to the provided value. More...
 
template<typename Edge >
value_type get (Edge const &e)
 Returns the property associated with the provided edge. More...
 
void reset ()
 Not used. Provided for compatibility.
 

Public Types

typedef PG::reference reference
 
typedef PG view_type
 
typedef Functor::value_type value_type
 

Detailed Description

template<class PG, class Functor>
class stapl::graph_edge_property_map< PG, Functor >

Internal property map to access edge properties stored on graph edges.

Template Parameters
PGThe graph view.
FunctorFunctor to extract the desired property from the edge property.

Functor is used to extract a sub-property from a property class. It should have following methods: . typedef value_type; . value_type get(Property p); . void put(Property p, value_type c); . apply(Property p, functor f);

Member Function Documentation

◆ apply()

template<class PG , class Functor >
template<typename Edge , typename Functor2 >
void stapl::graph_edge_property_map< PG, Functor >::apply ( Edge &  e,
Functor2  f2 
)

Applies the specified functor to the property associated with the provided edge.

Parameters
eThe edge associated with the property. Can either be an edge object/proxy/reference or an edge descriptor.
f2The functor to apply. This should work for edge descriptors also.

◆ put()

template<class PG , class Functor >
template<typename Edge >
void stapl::graph_edge_property_map< PG, Functor >::put ( Edge &  e,
value_type  c 
)

Sets the property associated with the provided edge to the provided value.

Parameters
eThe edge associated with the property. Can either be an edge object/proxy/reference or an edge descriptor.
cThe value of the property. This should work for edge descriptors also.

◆ get()

template<class PG , class Functor >
template<typename Edge >
value_type stapl::graph_edge_property_map< PG, Functor >::get ( Edge const &  e)

Returns the property associated with the provided edge.

Parameters
eThe edge associated with the property. Can either be an edge object/proxy/reference or an edge descriptor.
Returns
The value of the property. This should work for edge descriptors also.

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