kamping::Status Class Reference

Wrapper for MPI_Status. More...

#include <status.hpp>

Public Member Functions
	Status ()
	Construct a status object. Note that all values are undefined until passed to a communication function.
	Status (MPI_Status status)
	Construct a status object from a given MPI_Status.
int	source_signed () const
size_t	source () const
int	tag () const
int	count_signed (MPI_Datatype data_type) const
template<typename DataType >
int	count_signed () const
size_t	count (MPI_Datatype data_type) const
template<typename DataType >
size_t	count () const
MPI_Status &	native ()
MPI_Status const &	native () const

Detailed Description

Wrapper for MPI_Status.

Constructor & Destructor Documentation

Status()

kamping::Status::Status ( MPI_Status status )

inline

Construct a status object from a given MPI_Status.

Parameters

status

The status.

Member Function Documentation

count() [1/2]

template<typename DataType >

size_t kamping::Status::count ( ) const

inline

Template Parameters

DataType

The datatype.

Returns

The number of top-level elements received for the given type DataType.

count() [2/2]

size_t kamping::Status::count ( MPI_Datatype data_type ) const

inline

Parameters

data_type

The datatype.

Returns

The number of top-level elements received for the given type DataType.

count_signed() [1/2]

template<typename DataType >

int kamping::Status::count_signed ( ) const

inline

Template Parameters

DataType

The datatype.

Returns

The number of top-level elements received for the given type DataType.

count_signed() [2/2]

int kamping::Status::count_signed ( MPI_Datatype data_type ) const

inline

Parameters

data_type

The datatype.

Returns

The number of top-level elements received for the given type DataType.

native() [1/2]

MPI_Status & kamping::Status::native ( )

inline

Returns

A reference to the underlying native MPI_Status.

native() [2/2]

MPI_Status const & kamping::Status::native ( ) const

inline

Returns

A reference to the underlying native MPI_Status.

source()

size_t kamping::Status::source ( ) const

inline

Returns

The source rank. May be undefined.

source_signed()

int kamping::Status::source_signed ( ) const

inline

Returns

The source rank. May be undefined.

tag()

int kamping::Status::tag ( ) const

inline

Returns

The tag. May be undefined.

---

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

• include/kamping/status.hpp