MPI_Type_free

Frees the datatype

Synopsis

#include "mpi.h"
int MPI_Type_free ( MPI_Datatype *datatype )

Input Parameter

datatype: datatype that is freed (handle)

Predefined types

The MPI standard states that (in Opaque Objects)

MPI provides certain predefined opaque objects and predefined, static handles
to these objects. Such objects may not be destroyed.

Thus, it is an error to free a predefined datatype. The same section makes it clear that it is an error to free a null datatype.

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. ierris 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 INTEGERin 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_Errhandler_set; 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.

MPI_SUCCESS: No error; MPI routine completed successfully.

MPI_ERR_TYPE: Invalid datatype argument. May be an uncommitted MPI_Datatype (see MPI_Type_commit).

MPI_ERR_ARG: Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., MPI_ERR_RANK).

Location:type_free.c