status Struct Reference

status Struct Reference#

Reference API: gko::experimental::mpi::status Struct Reference
Reference API
gko::experimental::mpi::status Struct Reference

#include <ginkgo/core/base/mpi.hpp>

Public Member Functions

 status ()
 
MPI_Status * get ()
 
template<typename T >
int get_count (const T *data) const
 

Detailed Description

The status struct is a light wrapper around the MPI_Status struct.

Constructor & Destructor Documentation

◆ status()

gko::experimental::mpi::status::status ( )
inline

The default constructor. It creates an empty MPI_Status

Member Function Documentation

◆ get()

MPI_Status * gko::experimental::mpi::status::get ( )
inline

Get a pointer to the underlying MPI_Status object.

Returns
a pointer to MPI_Status object

Referenced by gko::experimental::mpi::communicator::recv(), and gko::experimental::mpi::request::wait().

◆ get_count()

template<typename T >
int gko::experimental::mpi::status::get_count ( const T *  data) const
inline

Get the count of the number of elements received by the communication call.

Template Parameters
TThe datatype of the object that was received.
Parameters
dataThe data object of type T that was received.
Returns
the count

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