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

Internal property map to access vertex properties stored on graph vertices. More...

Public Member Functions

 graph_internal_property_map (view_type &graph)
 
 graph_internal_property_map (view_type &graph, Functor f)
 
template<typename Vertex , typename Functor2 >
void apply (Vertex v, Functor2 f2)
 Applies the specified functor to the property associated with the provided vertex. More...
 
template<typename Vertex >
void put (Vertex v, value_type c)
 Sets the property associated with the provided vertex to the provided value. More...
 
template<typename Vertex >
value_type get (Vertex v)
 Returns the property associated with the provided vertex. More...
 
void reset ()
 Not used. Provided for compatibility.
 
view_type * get_view ()
 
view_type & view () const
 
bool is_local () const
 

Public Types

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

Detailed Description

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

Internal property map to access vertex properties stored on graph vertices.

Template Parameters
PGThe graph view.
FunctorFunctor to extract the desired property from the vertex 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 Vertex , typename Functor2 >
void stapl::graph_internal_property_map< PG, Functor >::apply ( Vertex  v,
Functor2  f2 
)

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

Parameters
vThe vertex associated with the property. Can either be a vertex object/proxy/reference or a vertex descriptor.
f2The functor to apply.

◆ put()

template<class PG , class Functor >
template<typename Vertex >
void stapl::graph_internal_property_map< PG, Functor >::put ( Vertex  v,
value_type  c 
)

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

Parameters
vThe vertex associated with the property. Can either be a vertex object/proxy/reference or a vertex descriptor.
cThe value of the property.

◆ get()

template<class PG , class Functor >
template<typename Vertex >
value_type stapl::graph_internal_property_map< PG, Functor >::get ( Vertex  v)

Returns the property associated with the provided vertex.

Parameters
vThe vertex associated with the property. Can either be a vertex object/proxy/reference or a vertex descriptor.
Returns
The value of the property.

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