NAME

MPI_Type_get_true_extent - Returns the true extent of a type in bytes

SYNOPSIS

#include <mpi.h> 
int MPI_Type_get_true_extent(MPI_Datatype datatype , MPI_Aint *true_lb , MPI_Aint *true_extent ); 
#include <pmpi.h> 
int PMPI_Type_get_true_extent(MPI_Datatype datatype , MPI_Aint *true_lb , MPI_Aint *true_extent ); 

INPUT PARAMETER

datatype - type (handle)

OUTPUT PARAMETERS

true_lb - offset of the true lower bound of the type (integer).

true_extent - true extent of the type (integer).

DESCRIPTION

The MPI_Type_get_true_extent() function is used to determine the true extent of a type datatype . This function will return the region of memory actually affected by a read or write of the data described by this type. This is described by the true lower bound, true_lb , and true extent, true_extent . These differ from the "effective" lower bound and extent of the type because a type may contain MPI_UB or MPI_LB which alter the effective values.

This function is useful because it allows one to allocate a buffer large enough to hold all the data of a type without having to pack it with the MPI_Pack() function.

PMPI_Type_get_true_extent() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this 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.

MPI_SUCCESS - No error;

MPI_ERR_TYPE - Invalid data type;

MPI_ERR_ARG - Invalid pointer.

SEE ALSO

MPI_Pack (3) MPI_Type_size (3) MPI_Type_ub (3) MPI_Type_lb (3) MPI_Type_extent (3) MPI_Type_free (3) MPI_Type_commit (3)

• Lockless
• MPI Documentation
• MPI_Type_get_true_extent