Ginkgo: gko::experimental::mpi::status Struct Reference

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
gko::experimental::mpi::status Struct Reference

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

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

## Public Member Functions
| status ()
| The default constructor.
MPI_Status * | get ()
| Get a pointer to the underlying MPI_Status object.
template<typename T>
int | get_count (const T *data) const
| Get the count of the number of elements received by the communication call.

## 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

  T | The datatype of the object that was received.

Parameters

  data | The data object of type T that was received.

Returns
  the count

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

- ginkgo/core/base/mpi.hpp