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

The graph external property map class, which maps each element in a container to a property. More...

Public Member Functions

 graph_external_property_map (C &c, Functor f)
 Constructor, which takes the container and functor as parameters and sets them as data members.
 
 graph_external_property_map (C &c)
 Constructor which takes the container and sets it as a data member. No functor is given, so a default one of type Functor is used.
 
template<typename Object , typename Functor2 >
void apply (Object o, Functor2 f2)
 Applies an alternate functor to the specified object. More...
 
template<typename Object >
void put (Object o, property_value_type c)
 Assigns a property to the specified object. More...
 
template<typename Object >
property_value_type get (Object o)
 Returns the property of a given object. More...
 
void reset ()
 Resets the properties of each object in the container to a default property.
 

Public Types

typedef Functor::value_type property_value_type
 

Protected Attributes

C * m_c
 
Functor m_f
 

Detailed Description

template<class G, class C, class Functor = ident_prop_func< typename C::value_type>>
class stapl::sequential::graph_external_property_map< G, C, Functor >

The graph external property map class, which maps each element in a container to a property.

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

Member Function Documentation

◆ apply()

template<class G, class C, class Functor = ident_prop_func< typename C::value_type>>
template<typename Object , typename Functor2 >
void stapl::sequential::graph_external_property_map< G, C, Functor >::apply ( Object  o,
Functor2  f2 
)

Applies an alternate functor to the specified object.

Parameters
oThe object to apply the alternate functor to.
f2The alternate functor.

◆ put()

template<class G, class C, class Functor = ident_prop_func< typename C::value_type>>
template<typename Object >
void stapl::sequential::graph_external_property_map< G, C, Functor >::put ( Object  o,
property_value_type  c 
)

Assigns a property to the specified object.

Parameters
oThe object to assign a property to.
vThe property to assign.

◆ get()

template<class G, class C, class Functor = ident_prop_func< typename C::value_type>>
template<typename Object >
property_value_type stapl::sequential::graph_external_property_map< G, C, Functor >::get ( Object  o)

Returns the property of a given object.

Parameters
oThe object whose property will be returned.

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