Skip to content

Latest commit

 

History

History
105 lines (73 loc) · 2.99 KB

MPI_Status_set_elements.3.rst

File metadata and controls

105 lines (73 loc) · 2.99 KB
Raw

MPI_Status_set_elements

:ref:`MPI_Status_set_elements`, :ref:`MPI_Status_set_elements_x` - Modifies opaque part of status to allow :ref:`MPI_Get_elements` to return count.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Status_set_elements(MPI_Status *status, MPI_Datatype datatype, int count)
int MPI_Status_set_elements_x(MPI_Status *status, MPI_Datatype datatype, MPI_Count count)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_STATUS_SET_ELEMENTS(STATUS, DATATYPE, COUNT, IERROR)
     INTEGER STATUS(MPI_STATUS_SIZE), DATATYPE, COUNT, IERROR
MPI_STATUS_SET_ELEMENTS_X(STATUS, DATATYPE, COUNT, IERROR)
     INTEGER STATUS(MPI_STATUS_SIZE), DATATYPE
        INTEGER(KIND=MPI_COUNT_KIND) COUNT
        INTEGER IERROR

Fortran 2008 Syntax

USE mpi_f08
MPI_Status_set_elements(status, datatype, count, ierror)
     TYPE(MPI_Status), INTENT(INOUT) :: status
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     INTEGER, INTENT(IN) :: count
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror
MPI_Status_set_elements_x(status, datatype, count, ierror)
     TYPE(MPI_Status), INTENT(INOUT) :: status
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     INTEGER(KIND = MPI_COUNT_KIND), INTENT(IN) :: count
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT/OUTPUT PARAMETER

  • status: Status to associate with count (status).

INPUT PARAMETERS

  • datatype: Data type associated with count (handle).
  • count: Number of elements to associate with status (integer).

OUTPUT PARAMETER

  • ierror: Fortran only: Error status (integer).

DESCRIPTION

:ref:`MPI_Status_set_elements` modifies the opaque part of status so that a call to :ref:`MPI_Get_elements` or :ref:`MPI_Get_elements_x` will return count. :ref:`MPI_Get_count` will return a compatible value.

A subsequent call to MPI_Get_count(status, datatype, count), to MPI_Get_elements(status, datatype, count), or to MPI_Get_elements_x(status, datatype, count) must use a data-type argument that has the same type signature as the data-type argument that was used in the call to :ref:`MPI_Status_set_elements`.*

NOTES

Users are advised not to reuse the status fields for values other than those for which they were intended. Doing so may lead to unexpected results when using the status object. For example, calling :ref:`MPI_Get_elements` may cause an error if the value is out of range, or it may be impossible to detect such an error. The extra_state argument provided with a generalized request can be used to return information that does not logically belong in status. Furthermore, modifying the values in a status set internally by MPI, such as :ref:`MPI_Recv`, may lead to unpredictable results and is strongly discouraged.

ERRORS