Synopsis
int MPI_Type_match_size(int typeclass, int size, MPI_Datatype *datatype)
Input Parameters
- typeclass
-
generic type specifier (integer)
- size
-
size, in bytes, of representation (integer)
Output Parameters
- datatype
-
datatype with correct type, size (handle)
Description
MPI_Type_match_size returns a predefined MPI datatype that matches a local variable of a specified typeclass and size in bytes.
The typeclass argument is one of MPI_TYPECLASS_REAL, MPI_TYPECLASS_INTEGER, or MPI_TYPECLASS_COMPLEX. This function returns a reference to one of the predefined named datatypes, not a duplicate. The returned datatype cannot be freed. It is erroneous to specify a size not supported by the compiler.
Notes
typeclass is one of MPI_TYPECLASS_REAL, MPI_TYPECLASS_INTEGER and
MPI_TYPECLASS_COMPLEX, corresponding to the desired typeclass.
The function returns an MPI datatype matching a local variable of type
(typeclass, size).
Thread and Interrupt Safety
This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.
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 guarantee 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.
-
MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., 'MPI_ERR_RANK').
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.