MPI_Type_free(3OpenMPI)MPI_Type_free(3OpenMPI)NAME
MPI_Type_free - Frees a data type.
SYNTAX C Syntax
#include <mpi.h>
int MPI_Type_free(MPI_Ddatatype *datatype)
Fortran Syntax
INCLUDE 'mpif.h'
MPI_TYPE_FREE(DATATYPE, IERROR)
INTEGER DATATYPE, IERROR
C++ Syntax
#include <mpi.h>
void Datatype::Free()
INPUT /OUTPUT PARAMETER
datatype Datatype that is freed (handle).
OUTPUT PARAMETER
IERROR Fortran only: Error status (integer).
DESCRIPTION
Marks the datatype object associated with datatype for de-allocation and sets datatype to MPI_DATATYPE_NULL. Any communication that is cur-
rently using this datatype will complete normally. Derived datatypes that were defined from the freed datatype are not affected.
Freeing a datatype does not affect any other datatype that was built from the freed datatype. The system behaves as if input datatype argu-
ments to derived datatype constructors are passed by value.
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_Type_free(3OpenMPI)
Check Out this Related Man Page
MPI_Type_match_size(3OpenMPI)MPI_Type_match_size(3OpenMPI)NAME
MPI_Type_match_size - Returns an MPI datatype of a given type and size
SYNTAX C Syntax
#include <mpi.h>
int MPI_Type_match_size(int typeclass, int size,
MPI_Datatype *type)
Fortran Syntax
INCLUDE 'mpif.h'
MPI_TYPE_MATCH_SIZE(TYPECLASS, SIZE, TYPE, IERROR)
INTEGER TYPECLASS, SIZE, TYPE, IERROR
C++ Syntax
#include <mpi.h>
static MPI::Datatype MPI::Match_size(int typeclass, int size)
INPUT PARAMETERS
typeclass Generic type specifier (integer).
size Size, in bytes, of representation (integer).
OUTPUT PARAMETERS
type Datatype with correct type and size (handle).
IERROR Fortran only: Error status (integer).
DESCRIPTION
The function returns an MPI datatype matching a local variable of type (typeclass, size). The returned type is a reference (handle) to a
predefined named datatype, not a duplicate. This type cannot be freed.
The value of typeclass may be set to one of MPI_TYPECLASS_REAL, MPI_TYPECLASS_INTEGER, or MPI_TYPECLASS_COMPLEX, corresponding to the
desired datatype.
MPI_type_match_size can be used to obtain a size-specific type that matches a Fortran numeric intrinsic type: first call MPI_Sizeof to com-
pute the variable size, then call MPI_Type_match_size to find a suitable datatype. In C and C++, use the sizeof builtin instead of
MPI_Sizeof.
It is erroneous to specify a size not supported by the compiler.
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.
See the MPI man page for a full list of MPI error codes.
SEE ALSO
MPI_Sizeof
MPI_Type_get_extent
Open MPI 1.2 September 2006 MPI_Type_match_size(3OpenMPI)