kamping::plugin::reproducible_reduce::ReproducibleCommunicator< T, Communicator > Class Template Reference

Communicator that can reproducibly reduce an array of a fixed size according to a binary tree scheme. More...

#include <reproducible_reduce.hpp>

Public Member Functions
	ReproducibleCommunicator (Communicator const &comm, std::map< size_t, size_t > const start_indices, size_t const region_begin, size_t const region_size)
	Create a new reproducible communicator.
template<typename... Args>
T const	reproducible_reduce (Args... args)
	Reproducible reduction according to pre-initialized scheme. The following parameters are required:

Detailed Description

template<typename T, typename Communicator>
class kamping::plugin::reproducible_reduce::ReproducibleCommunicator< T, Communicator >

Communicator that can reproducibly reduce an array of a fixed size according to a binary tree scheme.

Template Parameters

T	Type of the elements that are to be reduced.
DefaultContainerType	Container type of the original communicator.

Constructor & Destructor Documentation

ReproducibleCommunicator()

template<typename T , typename Communicator >

kamping::plugin::reproducible_reduce::ReproducibleCommunicator< T, Communicator >::ReproducibleCommunicator ( Communicator const & comm, std::map< size_t, size_t > const start_indices, size_t const region_begin, size_t const region_size )

inline

Create a new reproducible communicator.

Template Parameters

Comm	Type of the communicator.

Parameters

comm	Underlying communicator to transport messages.
start_indices	Map from global array indices onto ranks on which they are held. Must have no gaps, start at index 0 and contain a sentinel element at the end.
region_begin	Index of the first element that is held locally.
region_size	Number of elements assigned to the current rank.

Member Function Documentation

reproducible_reduce()

template<typename T , typename Communicator >

template<typename... Args>

T const kamping::plugin::reproducible_reduce::ReproducibleCommunicator< T, Communicator >::reproducible_reduce ( Args... args )

inline

Reproducible reduction according to pre-initialized scheme. The following parameters are required:

• kamping::send_buf() containing the local elements that are reduced. This buffer has to match the size specified during creation of the ReproducibleCommunicator.
• kamping::op() wrapping the operation to apply to the input.

Parameters

args	All required arguments as described above.

Returns

Final reduction result obtained by applying the operation in a fixed order to all input elements across PEs.

---

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

• include/kamping/plugin/reproducible_reduce.hpp