MPITypelb(3OpenMPI) MPITypelb(3OpenMPI)

NAME
       MMPPIITTyyppeellbb  -  Returns the lower bound of a data type. This may differ
       from zero if the type was constructed using MPILB. Use of this routine
       is deprecated.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPITypelb(MPIDatatype datatype, MPIAint *displacement)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPITYPELB(DATATYPE, DISPLACEMENT, IERROR)
            INTEGER   DATATYPE, DISPLACEMENT, IERROR



IINNPPUUTT PPAARRAAMMEETTEERR
       datatype  Datatype (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       displacement
                 Displacement  of lower bound from origin, in bytes (integer).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       Note that use of this routine is deprecated as  of  MPI-2.  Please  use
       MPITypegetextent instead.

       This deprecated routine is not available in C++.

       MPITypelb returns the lower bound of a data type.

       The  "pseudo-datatypes,"  MPILB and MPIUB, can be used, respectively,
       to mark the lower bound (or the  upper  bound)  of  a  datatype.  These
       pseudo-datatypes occupy no space (extent (MPILB) = extent (MPIUB) =0.
       They do not affect the size or count of a datatype, and do  not  affect
       the  context  of a message created with this datatype. However, they do
       affect the definition of the  extent  of  a  datatype  and,  therefore,
       affect the outcome of a replication of this datatype by a datatype con-
       structor.

       In general, if

           Typemap = {(type0, disp0), ..., (type(n-1), disp(n-1)}

       then the lower bound of Typemap is defined to be

                         (min(j) disp(j)                          if no entry has
           lb(Typemap) = (                                        basic type lb
                         (min(j) {disp(j) such that type(j) = lb} otherwise

       Similarly, the upper bound of Typemap is defined to be

                         (max(j) disp(j) + sizeof((type(j)) + e   if no entry has
           ub(Typemap) = (                                        basic type ub
                         (max(j) {disp(j) such that type(j) = ub} otherwise

       Then

           extent(Typemap) = ub(Typemap) - lb(Typemap)

       If type(i) requires alignment to a byte address that is a  multiple  of
       k(i),  then  e  is  the  least  nonnegative  increment  needed to round
       extent(Typemap) to the next multiple of max(i) k(i).


EERRRROORRSS
       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::ERRORSTHROWEXCEPTIONS, 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
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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.


SEE ALSO
       MPITypegetextent




Open MPI 1.2                    September 2006           MPITypelb(3OpenMPI)