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

The edge property map that maps each edge in a set to an edge property. More...

Public Member Functions

 edge_property_map (G &g, Functor f)
 A constructor for the edge property map, where the graph and the functor are specified and stored as data members.
 
 edge_property_map (G &g)
 A constructor for the edge property map where the functor is not specified. A default functor of type Functor is used.
 
template<typename Edge , typename Functor2 >
void apply (Edge e, Functor2 f2)
 Applies an alternate functor to an edge in the map. More...
 
template<typename Edge >
void put (Edge e, property_value_type c)
 Changes the property of an edge to the provided property. More...
 
template<typename Edge >
property_value_type get (Edge e)
 Returns the property of a given edge. More...
 
void reset ()
 Resets the properties of each edge to a default property.
 

Public Types

typedef Functor::value_type property_value_type
 

Detailed Description

template<class G, class Functor = ident_prop_func<typename G::edge_property>>
class stapl::sequential::edge_property_map< G, Functor >

The edge property map that maps each edge in a set to an edge property.

Template Parameters
GThe graph for the property map.
FunctorThe functor class for the property map.

Member Function Documentation

◆ apply()

template<class G , class Functor = ident_prop_func<typename G::edge_property>>
template<typename Edge , typename Functor2 >
void stapl::sequential::edge_property_map< G, Functor >::apply ( Edge  e,
Functor2  f2 
)

Applies an alternate functor to an edge in the map.

Parameters
eThe edge to apply the alternate functor to.
f2The alternate functor.

◆ put()

template<class G , class Functor = ident_prop_func<typename G::edge_property>>
template<typename Edge >
void stapl::sequential::edge_property_map< G, Functor >::put ( Edge  e,
property_value_type  c 
)

Changes the property of an edge to the provided property.

Parameters
eThe desired edge.
cThe new property to assign to e.

◆ get()

template<class G , class Functor = ident_prop_func<typename G::edge_property>>
template<typename Edge >
property_value_type stapl::sequential::edge_property_map< G, Functor >::get ( Edge  e)

Returns the property of a given edge.

Parameters
eThe edge whose property will be returned.

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