mpi_type_get_extent(3openmpi) [osx man page]

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++ func-
       tions  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)

MPI_Type_get_extent(3)							MPI						    MPI_Type_get_extent(3)

NAME

       MPI_Type_get_extent -  Get the lower bound and extent for a Datatype

SYNOPSIS

       int MPI_Type_get_extent(MPI_Datatype datatype, MPI_Aint *lb, MPI_Aint *extent)

INPUT PARAMETER

       datatype
	      - datatype to get information on (handle)

OUTPUT PARAMETERS

       lb     - lower bound of datatype (address integer)
       extent - extent of datatype (address integer)

THREAD AND INTERRUPT SAFETY

       This  routine  is  both	thread- and interrupt-safe.  This means that this routine may safely be used by multiple threads and from within a
       signal handler.

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.   ierr
       is  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 INTEGER in 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_Comm_set_errhandler	(for  communicators),  MPI_File_set_errhandler	(for  files),  and
       MPI_Win_set_errhandler  (for  RMA  windows).   The  MPI-1 routine MPI_Errhandler_set may be used but its use is deprecated.  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; however, MPI implementations will attempt to continue whenever possible.

       MPI_SUCCESS
	      - No error; MPI routine completed successfully.
       MPI_ERR_ARG
	      - Invalid argument.  Some argument is invalid and is not identified by a specific error class (e.g., MPI_ERR_RANK ).
       MPI_ERR_TYPE
	      - Invalid datatype argument.  May be an uncommitted MPI_Datatype (see MPI_Type_commit ).

LOCATION

       type_get_extent.c

								     7/29/2010						    MPI_Type_get_extent(3)