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

External property map to store vertex properties. More...

Public Member Functions

 graph_external_property_map (PG const &, view_type const &props)
 Creates an external vertex property map for the given graph using the provided view as storage. More...
 
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) const
 Returns the property associated with the provided vertex. More...
 
bool is_local () const
 
void reset ()
 Not used. Provided for compatibility.
 

Public Types

typedef PG::vertex_descriptor vertex_descriptor
 
typedef PG::vertex_reference vertex_reference
 
typedef PG::reference reference
 
typedef Property value_type
 
typedef View view_type
 

Detailed Description

template<class PG, class Property, class View>
class stapl::graph_external_property_map< PG, Property, View >

External property map to store vertex properties.

Template Parameters
PGThe graph view.
PropertyProperty type of the vertex.
ViewType of the view for storing external properties.

Constructor & Destructor Documentation

◆ graph_external_property_map()

template<class PG , class Property , class View >
stapl::graph_external_property_map< PG, Property, View >::graph_external_property_map ( PG const &  ,
view_type const &  props 
)

Creates an external vertex property map for the given graph using the provided view as storage.

Parameters
PGThe graph view.
propsThe external view where properties will be stored.

Member Function Documentation

◆ apply()

template<class PG , class Property , class View >
template<typename Vertex , typename Functor2 >
void stapl::graph_external_property_map< PG, Property, View >::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 Property , class View >
template<typename Vertex >
void stapl::graph_external_property_map< PG, Property, View >::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 Property , class View >
template<typename Vertex >
value_type stapl::graph_external_property_map< PG, Property, View >::get ( Vertex  v) const

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: