NAME¶
MPI_Type_size - Returns the number of bytes occupied by entries in a data
type.
SYNTAX¶
C Syntax¶
#include <mpi.h>
int MPI_Type_size(MPI_Datatype datatype, int *size)
Fortran Syntax¶
INCLUDE 'mpif.h'
MPI_TYPE_SIZE( DATATYPE, SIZE, IERROR)
INTEGER DATATYPE, SIZE, IERROR
C++ Syntax¶
#include <mpi.h>
int Datatype::Get_size() const
- datatype
- Datatype (handle).
OUTPUT PARAMETERS¶
- size
- Datatype size (integer).
- IERROR
- Fortran only: Error status (integer).
DESCRIPTION¶
MPI_Type_size returns the total size, in bytes, of the entries in the type
signature associated with datatype; i.e., the total size of the data in a
message that would be created with this datatype. Entries that occur multiple
times in the datatype are counted with their multiplicity.
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++ 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.