stapl::operations::base< Distribution > Struct Template Reference

Operations class for container distributions that provides basic functionality for standard containers including getting, setting and applying. More...

Public Member Functions
void	set_element (gid_type const &gid, value_type const &val)
	Update the element at a GID by replacing it with a given value. More...
void	set_elements (gid_type gid, SourceView &&source_view)
	Update a range of contiguous elements in the container, starting at gid. A total of view.size() elements will be updated with the values in view. More...
void	set_elements (gid_type gid, View &&view)
	Signature of set_elements used when underlying base container is not supported. Fall back to iterative use of set_element.
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_type >	get_element_split (gid_type const &gid)
	Return a future of the element at a specific GID. This is a non-blocking operation. More...
void	apply_set (gid_type const &gid, Functor const &f)
	Apply a function object to the element with the given GID. More...
void	unordered_apply_set (gid_type const &gid, Functor &&f)
	Apply a function object to the element with the given GID, disregarding RMI causal ordering. More...
void	unordered_apply (gid_type const &gid, Functor &&f)
	Apply a function object to the element with the given GID, passing along the distribution pointer and disregarding RMI causal ordering. More...
boost::result_of< Functor(value_type &)>::type	apply_get (gid_type const &gid, Functor const &f)
	Apply a function object to the element with the given GID and return the result. More...
boost::result_of< Functor(value_type &)>::type	apply_get (gid_type const &gid, Functor const &f) const
	Apply a function object to the element with the given GID and return the result. More...

Detailed Description

template<typename Distribution>
struct stapl::operations::base< Distribution >

Operations class for container distributions that provides basic functionality for standard containers including getting, setting and applying.

Uses the CRTP pattern.

Template Parameters

Derived

The most derived distribution class

Member Function Documentation

set_element()

void stapl::operations::settable< Distribution >::set_element ( gid_type const &  gid, value_type const &  val  )

inherited

Update the element at a GID by replacing it with a given value.

Parameters

gid	GID of the element to replace
val	The new value for the element

set_elements()

void stapl::operations::settable< Distribution >::set_elements ( gid_type  gid, SourceView &&  source_view  )

inherited

Update a range of contiguous elements in the container, starting at gid. A total of view.size() elements will be updated with the values in view.

Note

Implementation assumes partition::try_get_domain will not fail if partition::contained_in succeeds.

get_element()

value_type stapl::operations::gettable< Distribution >::get_element ( gid_type const &  gid ) const

inherited

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

Parameters

gid	GID of the element to retrieve

Returns

Copy of the element at gid

get_element_split()

future<value_type> stapl::operations::gettable< Distribution >::get_element_split ( gid_type const &  gid )

inherited

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

Parameters

gid	GID of the element to retrieve

Returns

Future of the element at gid

apply_set()

void stapl::operations::applyable< Distribution >::apply_set ( gid_type const &  gid, Functor const &  f  )

inherited

Apply a function object to the element with the given GID.

Parameters

gid	GID of the element for which we want to apply the function object.
f	Function object to apply to the element.

Warning

The function operator of f has to be const qualified.

unordered_apply_set()

void stapl::operations::applyable< Distribution >::unordered_apply_set ( gid_type const &  gid, Functor &&  f  )

inherited

Apply a function object to the element with the given GID, disregarding RMI causal ordering.

Parameters

gid	GID of the element for which we want to apply the function object.
f	Function object to apply to the element.

Warning

The function operator of f has to be const qualified.

unordered_apply()

void stapl::operations::applyable< Distribution >::unordered_apply ( gid_type const &  gid, Functor &&  f  )

inherited

Apply a function object to the element with the given GID, passing along the distribution pointer and disregarding RMI causal ordering.

Parameters

gid	GID of the element for which we want to apply the function object.
f	Function object to apply to the element.

Warning

The function operator of f has to be const qualified.

apply_get() [1/2]

boost::result_of<Functor(value_type&)>::type stapl::operations::applyable< Distribution >::apply_get ( gid_type const &  gid, Functor const &  f  )

inherited

Apply a function object to the element with the given GID and return the result.

Parameters

gid	GID of the element for which we want to apply the function object and return the result.
f	Function object to apply to the element.

Returns

The result of applying f to the element.

Warning

This function assumes that the Functor reflects a public type result_type and that the invocation of its function operator returns a value that is convertible to result_type. The function operator of f has to be const qualified.

apply_get() [2/2]

boost::result_of<Functor(value_type&)>::type stapl::operations::applyable< Distribution >::apply_get ( gid_type const &  gid, Functor const &  f  ) const

inherited

Apply a function object to the element with the given GID and return the result.

Parameters

gid	GID of the element for which we want to apply the function object and return the result.
f	Function object to apply to the element.

Returns

The result of applying f to the element.

Warning

This function assumes that the Functor reflects a public type result_type and that the invocation of its function operator returns a value that is convertible to result_type. The function operator of f has to be const qualified.

---

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

• base.hpp