MPI_Type_commit(3)

NAME
MPI_Type_commit - Finish initializing a type

SYNOPSIS
#include <mpi.h>
int MPI_Type_commit(MPI_Datatype *datatype);

#include <pmpi.h>
int PMPI_Type_commit(MPI_Datatype *datatype);

#include <mpi.h>
void MPI::Datatype::Commit(void);

INCLUDE 'mpif.h'
MPI_TYPE_COMMIT(datatype, ierr)
INTEGER datatype, ierr

INPUT PARAMETER
datatype
    - type (handle)

DESCRIPTION
The MPI_Type_commit() function is used to finish initializing a type, datatype so that it may be used in MPI message-passing functions. Prior to this, datatype may only be used with other MPI type creation functions. This function internally optimizes the layout of the datatype so that a minimal number of contiguous memory segments are transferred by message passing routines. It is an error to try to commit a type more than once, or to commit a pre-defined MPI type. PMPI_Type_commit() is the profiling version of this function.

ERRORS
All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable. In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.
MPI_SUCCESS
    - No error;
MPI_ERR_PENDING
    - Pending exception;
MPI_ERR_TYPE
    - Invalid type;
MPI_ERR_INTERN
    - Out of Memory, couldn't commit type.

SEE ALSO
MPI_Type_free(3), MPI_Type_struct(3), MPI_Type_create_struct(3), MPI_Type_contiguous(3), MPI_Type_indexed(3), MPI_Type_hindexed(3), MPI_Type_create_hindexed(3), MPI_Type_vector(3), MPI_Type_hvector(3), MPI_Type_create_hvector(3)