mpi_get_address(3openmpi) [osx man page]

MPI_Get_address(3OpenMPI)												 MPI_Get_address(3OpenMPI)

NAME

       MPI_Get_address - Gets the address of a location in memory.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Get_address(void *location, MPI_Aint *address)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_GET_ADDRESS(LOCATION, ADDRESS, IERROR)
	    <type> LOCATION(*)
	    INTEGER   ADDRESS, IERROR

C++ Syntax
       #include <mpi.h>
       MPI::Aint MPI::Get_address(void* location)

INPUT PARAMETERS

       location  Location in caller memory (choice).

OUTPUT PARAMETERS

       address	 Address of location (integer).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Get_address returns the byte address of a location in memory.

       Example: Using MPI_Get_address for an array.

       EAL A(100,100)
	  INTEGER I1, I2, DIFF
	  CALL MPI_GET_ADDRESS(A(1,1), I1, IERROR)
	  CALL MPI_GET_ADDRESS(A(10,10), I2, IERROR)
	  DIFF = I2 - I1
       ! The value of DIFF is 909*sizeofreal; the values of I1 and I2 are
       ! implementation dependent.

NOTES

       Current	Fortran  MPI  codes  will run unmodified and will port to any system. However, they may fail if addresses larger than 2^32 - 1 are
       used in the program. New codes should be written so that they use the new functions. This provides  compatibility  with	C/C++  and  avoids
       errors  on  64-bit  architectures. However, such newly written codes may need to be (slightly) rewritten to port to old Fortran 77 environ-
       ments that do not support KIND declarations.

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_Get_address(3OpenMPI)

MPI_Get_address(3)						      LAM/MPI							MPI_Get_address(3)

NAME

       MPI_Get_address -  obtain the address of a location in caller memory

SYNOPSIS

       #include <mpi.h>
       int
       MPI_Get_address(void *loc, MPI_Aint *addr)

INPUT PARAMETER

       loc    - location in caller memory

OUTPUT PARAMETER

       addr   - address of location

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

       If an error occurs in an MPI function, the current MPI error handler is called to handle it.  By default, this error handler aborts the MPI
       job.  The error handler may be changed with MPI_Errhandler_set ; the predefined error handler MPI_ERRORS_RETURN may be used to cause  error
       values  to  be  returned  (in  C and Fortran; this error handler is less useful in with the C++ MPI bindings.  The predefined error handler
       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value needs to be recovered).  Note that MPI does not guarantee that an MPI
       program can continue past an error.

       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.  The C++ bindings for MPI do not return error values; instead, error values are communicated by throwing  exceptions	of
       type MPI::Exception (but not by default).  Exceptions are only thrown if the error value is not MPI::SUCCESS
	.

       Note  that  if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return upon an error, there will be no way to recover
       what the actual error value was.
       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.  This is typically a NULL pointer	or
	      other such error.

SEE ALSO

       MPI_Type_create_hvector(3), MPI_Type_create_hindexed(3), MPI_Type_create_struct(3)

MORE INFORMATION

       For  more  information,	please	see the official MPI Forum web site, which contains the text of both the MPI-1 and MPI-2 standards.  These
       documents contain detailed information about each MPI function (most of which is not duplicated in these man pages).

       http://www.mpi-forum.org/

LOCATION

       getaddress.c

LAM
/MPI 6.5.8							    11/10/2002							MPI_Get_address(3)