This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

MPI_Type_get_extent(3OpenMPI)                                                  MPI_Type_get_extent(3OpenMPI)



NAME
       MPI_Type_get_extent - Returns the lower bound and extent of a data type.


SYNTAX
C Syntax
       #include <mpi.h>
       int MPI_Type_get_extent(MPI_Datatype datatype, MPI_Aint *lb,
            MPI_Aint *extent)


Fortran Syntax (see FORTRAN 77 NOTES)
       INCLUDE 'mpif.h'
       MPI_TYPE_GET_EXTENT(DATATYPE, LB, EXTENT, IERROR)
            INTEGER   DATATYPE, IERROR
            INTEGER(KIND=MPI_ADDRESS_KIND) LB, EXTENT


C++ Syntax
       #include <mpi.h>
       void MPI::Datatype::Get_extent(MPI::Aint& lb, MPI::Aint& extent)
            const


INPUT PARAMETER
       datatype  Data type (handle).


OUTPUT PARAMETERS
       lb        Lower bound of data type (integer).

       extent    Data type extent (integer).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPI_Type_get_extent returns the lower bound and the extent of datatype.


NOTE
       Use  of  MPI_Type_get_extent is strongly recommended over the old MPI-1 functions MPI_Type_extent and
       MPI_Type_lb.


FORTRAN 77 NOTES
       The MPI standard prescribes portable Fortran syntax for the LB and EXTENT arguments only for  Fortran
       90. FORTRAN 77 users may use the non-portable syntax

            INTEGER*MPI_ADDRESS_KIND LB
       or
            INTEGER*MPI_ADDRESS_KIND EXTENT

       where  MPI_ADDRESS_KIND  is a constant defined in mpif.h and gives the length of the declared integer
       in bytes.


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.





Open MPI 1.2                                   September 2006                  MPI_Type_get_extent(3OpenMPI)