STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types | Protected Attributes | Friends
stapl::graph_accessor< Container > Class Template Reference

accessor for vertices of a graph. More...

Public Member Functions

 graph_accessor (null_reference const &)
 
 graph_accessor (graph_accessor const &other)
 
 graph_accessor (container_type *container, index_type const &index)
 
property_reference property (void)
 
property_reference property (void) const
 
const_property_reference const_property (void) const
 
value_type ref (void) const
 Provide a copy of the underlying variable this accessor provides access for, to apply functors below. More...
 
bool is_local (void) const
 
Container & container (void) const
 
rmi_handle::reference const & handle (void) const
 
bool container_pointer_valid (void) const
 
template<typename Class , typename... Args>
void invoke (void(Class::*const memberFuncPtr)(Args...), typename std::decay< Args >::type const &... args) const
 
template<typename Class , typename Rtn , typename... Args>
Rtn invoke (Rtn(Class::*const memberFuncPtr)(Args...), typename std::decay< Args >::type const &... args) const
 
template<typename Class , typename Rtn , typename... Args>
Rtn const_invoke (Rtn(Class::*const memberFuncPtr)(Args...) const, typename std::decay< Args >::type const &... args) const
 
bool is_null () const
 Returns whether or not this is a null accessor.
 
index_type index () const
 Return the index of the reference.
 
value_type read () const
 Read the reference by returning a copy of the value in the container at the index.
 
template<typename T >
void write (T &&val) const
 Write the reference by setting the value in the container at the index to a given value. More...
 
template<typename F >
void apply_set (const F &f) const
 Applies an arbitrary functor to the reference element. More...
 
template<typename F >
boost::result_of< F(value_type)>::type apply_get (F const &f) const
 Applies an arbitrary functor to the reference element and returns the result. More...
 
bool element_pointer_valid (void) const
 
container_traits< Container >::value_type & element (void) const
 

Public Types

typedef Container container_type
 
typedef container_traits< Container >::gid_type index_type
 
typedef container_traits< Container >::value_type value_type
 
typedef property_reference_constructor< typename container_type::vertex_property, container_type, index_type > referencer_t
 
typedef referencer_t::result_type property_reference
 
typedef const_property_reference_constructor< typename container_type::vertex_property, container_type, index_type > const_referencer_t
 
typedef const_referencer_t::result_type const_property_reference
 

Protected Attributes

p_object_pointer_wrapper< Container > m_container
 
index_type m_index
 

Friends

template<typename Derived , typename A , typename C , typename D >
class iterator_facade
 
class accessor_core_access
 

Detailed Description

template<typename Container>
class stapl::graph_accessor< Container >

accessor for vertices of a graph.

Template Parameters
ContainerType of the pGraph container.

Member Function Documentation

◆ ref()

template<typename Container >
value_type stapl::graph_accessor< Container >::ref ( void  ) const

Provide a copy of the underlying variable this accessor provides access for, to apply functors below.

◆ container()

template<typename Container >
Container& stapl::container_accessor< Container >::container ( void  ) const
inherited

◆ write()

template<typename Container >
template<typename T >
void stapl::container_accessor< Container >::write ( T &&  val) const
inherited

Write the reference by setting the value in the container at the index to a given value.

Parameters
valAn element that can be convertible to the reference's value_type that is to be written

◆ apply_set()

template<typename Container >
template<typename F >
void stapl::container_accessor< Container >::apply_set ( const F &  f) const
inherited

Applies an arbitrary functor to the reference element.

Parameters
fFunctor to apply. The function object's function operator must be declared const.
Returns
Result of applying the functor to the element

◆ apply_get()

template<typename Container >
template<typename F >
boost::result_of<F(value_type)>::type stapl::container_accessor< Container >::apply_get ( F const &  f) const
inherited

Applies an arbitrary functor to the reference element and returns the result.

Parameters
fFunctor to apply. The function object must export a nested trait for result_type and its function operator must be declared const.
Returns
Result of applying the functor to the element

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