mpi_type_lb(3openmpi) [osx man page]

MPI_Type_lb(3OpenMPI)													     MPI_Type_lb(3OpenMPI)

NAME

       MPI_Type_lb  - Returns the lower bound of a data type. This may differ from zero if the type was constructed using MPI_LB. Use of this rou-
       tine is deprecated.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Type_lb(MPI_Datatype datatype, MPI_Aint *displacement)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_TYPE_LB(DATATYPE, DISPLACEMENT, IERROR)
	    INTEGER   DATATYPE, DISPLACEMENT, IERROR

INPUT PARAMETER

       datatype  Datatype (handle).

OUTPUT PARAMETERS

       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 MPI_Type_get_extent instead.

       This deprecated routine is not available in C++.

       MPI_Type_lb returns the lower bound of a data type.

       The "pseudo-datatypes," MPI_LB and MPI_UB, can be used, respectively, to mark the lower bound (or the upper bound)  of  a  datatype.  These
       pseudo-datatypes  occupy  no  space  (extent  (MPI_LB) = extent (MPI_UB) =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,  there-
       fore, affect the outcome of a replication of this datatype by a datatype constructor.

       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).

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.

SEE ALSO

       MPI_Type_get_extent

Open MPI 1.2							  September 2006					     MPI_Type_lb(3OpenMPI)

Check Out this Related Man Page

MPI_Type_lb(3)								MPI							    MPI_Type_lb(3)

NAME

       MPI_Type_lb -  Returns the lower-bound of a datatype

SYNOPSIS

       int MPI_Type_lb(MPI_Datatype datatype, MPI_Aint *displacement)

INPUT PARAMETERS

       datatype
	      - datatype (handle)

OUTPUT PARAMETER

       displacement
	      - displacement of lower bound from origin, in bytes (address integer)

DEPRECATED FUNCTION

       The  MPI-2  standard  deprecated a number of routines because MPI-2 provides better versions.  This routine is one of those that was depre-
       cated.  The routine may continue to be used, but new code should use  the  replacement  routine.   The  replacement  for  this  routine	is
       MPI_Type_Get_extent .

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_TYPE
	      - Invalid datatype argument.  May be an uncommitted MPI_Datatype (see MPI_Type_commit ).
       MPI_ERR_ARG
	      - Invalid argument.  Some argument is invalid and is not identified by a specific error class (e.g., MPI_ERR_RANK ).

LOCATION

       type_lb.c

								     8/6/2010							    MPI_Type_lb(3)

Linux and UNIX Man Pages

mpi_type_lb(3openmpi) [osx man page]

Check Out this Related Man Page