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

The vertex property map class, which maps a set of vertices to a set of properties. More...

Public Member Functions

 vertex_property_map (G &g, Functor f)
 Constructor for the vertex_property_map class. Takes in a graph and a functor, and stores them as data members.
 
 vertex_property_map (G &g)
 Constructor for the vertex_property_map class. No functor is specified, so a default functor of type Functor is used.
 
template<typename Vertex , typename Functor2 >
void apply (Vertex v, Functor2 f2)
 Applies an alternate functor to a vertex in the map. More...
 
template<typename Vertex >
void put (Vertex v, property_value_type c)
 Changes the property of a vertex to the provided property. More...
 
template<typename Vertex >
property_value_type get (Vertex v)
 Returns the property of a given vertex. More...
 
void reset ()
 Resets the properties of all vertices in the graph 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::vertex_property>>
class stapl::sequential::vertex_property_map< G, Functor >

The vertex property map class, which maps a set of vertices to a set of properties.

Template Parameters
GThe graph class for the property map.
FunctorThe functor for the property map, which extracts a sub-property from a property class.

Member Function Documentation

◆ apply()

template<class G , class Functor = ident_prop_func<typename G::vertex_property>>
template<typename Vertex , typename Functor2 >
void stapl::sequential::vertex_property_map< G, Functor >::apply ( Vertex  v,
Functor2  f2 
)

Applies an alternate functor to a vertex in the map.

Parameters
vThe vertex to apply the functor to.
f2The alternate functor.

◆ put()

template<class G , class Functor = ident_prop_func<typename G::vertex_property>>
template<typename Vertex >
void stapl::sequential::vertex_property_map< G, Functor >::put ( Vertex  v,
property_value_type  c 
)

Changes the property of a vertex to the provided property.

Parameters
vThe desired vertex.
cThe new property to assign to v.

◆ get()

template<class G , class Functor = ident_prop_func<typename G::vertex_property>>
template<typename Vertex >
property_value_type stapl::sequential::vertex_property_map< G, Functor >::get ( Vertex  v)

Returns the property of a given vertex.

Parameters
vThe vertex whose property will be returned.

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