|
« Return to documentation listing
Table of Contents
MPI_Type_free - Frees a data type.
#include <mpi.h>
int MPI_Type_free(MPI_Datatype *datatype)
INCLUDE ’mpif.h’
MPI_TYPE_FREE(DATATYPE, IERROR)
INTEGER DATATYPE, IERROR
#include <mpi.h>
void Datatype::Free()
- datatype
- Datatype that is freed (handle).
- IERROR
- Fortran only: Error status (integer).
Marks
the datatype object associated with datatype for de-allocation and sets
datatype to MPI_DATATYPE_NULL. Any communication that is currently 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 arguments to derived datatype constructors are passed
by value.
Almost all MPI routines return an error value; C routines
as the value of the function and Fortran routines in the last argument.
C++ functions 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.
Table of Contents
« Return to documentation listing
|
