mpi_status_set_elements(3openmpi) [osx man page]

MPI_Status_set_elements(3OpenMPI)										 MPI_Status_set_elements(3OpenMPI)

NAME

       MPI_Status_set_elements - Modifies opaque part of status to allow 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)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_STATUS_SET_ELEMENTS(STATUS, DATATYPE, COUNT, IERROR)
	    INTEGER   STATUS(MPI_STATUS_SIZE), DATATYPE, COUNT, IERROR

C++ Syntax
       #include <mpi.h>
       void MPI::Status::Set_elements(const MPI::Datatype& datatype, int count)

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

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

       A subsequent call to MPI_Get_count(status, datatype, count) or to MPI_Get_elements(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 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 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  MPI_Recv,  may  lead	to
       unpredictable results and is strongly discouraged.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception  mechanism
       will be used to throw an MPI:Exception object.

       Before  the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for
       I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN  may	be
       used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

Open MPI 1.2							  September 2006				 MPI_Status_set_elements(3OpenMPI)

Check Out this Related Man Page

MPI_Get_elements(3)							MPI						       MPI_Get_elements(3)

NAME

       MPI_Get_elements -  Returns the number of basic elements in a datatype

SYNOPSIS

       int MPI_Get_elements(MPI_Status *status, MPI_Datatype datatype, int *elements)

INPUT PARAMETERS

       status - return status of receive operation (Status)
       datatype
	      - datatype used by receive operation (handle)

OUTPUT PARAMETER

       count  - number of received basic elements (integer)

NOTES

       If  the size of the datatype is zero and the amount of data returned as determined by status is also zero, this routine will return a count
       of zero.  This is consistent with a clarification made by the MPI Forum.

NOTES FOR FORTRAN

       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument  list.   ierr
       is  an integer and has the same meaning as the return value of the routine in C.  In Fortran, MPI routines are subroutines, and are invoked
       with the call statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran.

ERRORS

       All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the function and Fortran  routines	in
       the  last  argument.  Before the value is returned, the current MPI error handler is called.  By default, this error handler aborts the MPI
       job.  The error handler may  be	changed  with  MPI_Comm_set_errhandler	(for  communicators),  MPI_File_set_errhandler	(for  files),  and
       MPI_Win_set_errhandler  (for  RMA  windows).   The  MPI-1 routine MPI_Errhandler_set may be used but its use is deprecated.  The predefined
       error handler MPI_ERRORS_RETURN may be used to cause error values to be returned.  Note that MPI does not guarentee that an MPI program can
       continue past an error; however, MPI implementations will attempt to continue whenever possible.

       MPI_SUCCESS
	      - No error; MPI routine completed successfully.

LOCATION

       get_elements.c

								     4/8/2011						       MPI_Get_elements(3)

Linux and UNIX Man Pages

mpi_status_set_elements(3openmpi) [osx man page]

Check Out this Related Man Page