STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Friends
stapl::operations::gettable< Derived > Class Template Reference

Operations class for container distributions that provides get_element. More...

Public Member Functions

value_type get_element (gid_type const &gid) const
 Return a copy of the element at a specific GID. Note that this is a blocking operation. More...
 
future< value_typeget_element_split (gid_type const &gid)
 Return a future of the element at a specific GID. This is a non-blocking operation. More...
 

Friends

class migratable< Derived >
 

Detailed Description

template<typename Derived>
class stapl::operations::gettable< Derived >

Operations class for container distributions that provides get_element.

Uses the CRTP pattern. Requires that the base container has a get_element method that takes a single GID.

Template Parameters
DerivedThe most derived distribution class

Member Function Documentation

◆ get_element()

template<typename Derived>
value_type stapl::operations::gettable< Derived >::get_element ( gid_type const &  gid) const

Return a copy of the element at a specific GID. Note that this is a blocking operation.

Parameters
gidGID of the element to retrieve
Returns
Copy of the element at gid

◆ get_element_split()

template<typename Derived>
future<value_type> stapl::operations::gettable< Derived >::get_element_split ( gid_type const &  gid)

Return a future of the element at a specific GID. This is a non-blocking operation.

Parameters
gidGID of the element to retrieve
Returns
Future of the element at gid

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