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

Responsible for storing and communicating intermediate results between PEs. More...

#include <reproducible_reduce.hpp>

Public Member Functions
	MessageBuffer (Communicator const &comm)
	Construct a new message buffer utilizing the given communicator comm.
void	receive (int const source_rank)
	Receive a message from another PE and store its contents.
void	flush (void)
	Asynchronously send locally stored intermediate results.
void	wait (void)
	Wait until the message dispatched by flush() is actually sent and clear any stored values.
void	put (int const target_rank, size_t const index, T const value)
	Store an intermediate result inside the message buffer for eventual transmission to its destination.
T const	get (int const source_rank, size_t const index)
	Get the intermediate result with the specified index from source_rank.

Detailed Description

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

Responsible for storing and communicating intermediate results between PEs.

Template Parameters

T	Type of the stored values.
Communicator	Type of the underlying communicator.

Constructor & Destructor Documentation

MessageBuffer()

template<typename T , typename Communicator >

kamping::plugin::reproducible_reduce::MessageBuffer< T, Communicator >::MessageBuffer ( Communicator const & comm )

inline

Construct a new message buffer utilizing the given communicator comm.

Parameters

comm	Underlying communicator used to send the messages.

Member Function Documentation

flush()

template<typename T , typename Communicator >

void kamping::plugin::reproducible_reduce::MessageBuffer< T, Communicator >::flush ( void )

inline

Asynchronously send locally stored intermediate results.

If there are none, no message is dispatched.

get()

template<typename T , typename Communicator >

T const kamping::plugin::reproducible_reduce::MessageBuffer< T, Communicator >::get ( int const source_rank, size_t const index )

inline

Get the intermediate result with the specified index from source_rank.

If the value has been received beforehand, it is immediately returned. Otherwise the method blocks until the message from source_rank containing the value arrives.

Parameters

source_rank	Rank of the PE that holds the desired intermediate result.
index	Global index of the intermediate result.

put()

template<typename T , typename Communicator >

void kamping::plugin::reproducible_reduce::MessageBuffer< T, Communicator >::put ( int const target_rank, size_t const index, T const value )

inline

Store an intermediate result inside the message buffer for eventual transmission to its destination.

Triggers a send if

1. the target rank of the currently stored values does not coincide with target_rank or
2. the message buffer is already full
3. the message buffer is full after adding value

Parameters

target_rank	Rank of the PE which requires the value for further processing.
index	Global index of the value being sent.
value	Actual value that must be sent.

receive()

template<typename T , typename Communicator >

void kamping::plugin::reproducible_reduce::MessageBuffer< T, Communicator >::receive ( int const source_rank )

inline

Receive a message from another PE and store its contents.

Parameters

source_rank

Rank of the sender.

---

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

• include/kamping/plugin/reproducible_reduce.hpp