mpi_address(3openmpi) [osx man page]

MPI_Address(3OpenMPI)													     MPI_Address(3OpenMPI)

NAME

       MPI_Address - Gets the address of a location in memory -- use of this routine is deprecated.

SYNTAX

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

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

INPUT PARAMETER

       location  Location in caller memory (choice).

OUTPUT PARAMETERS

       address	 Address of location (integer).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

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

       This deprecated routine is not available in C++.

       The address of a location in memory can be found by invoking this function. Returns the (byte) address of location.

       Example: Using MPI_Address for an array.

       REAL A(100,100)
	  INTEGER I1, I2, DIFF
	  CALL MPI_ADDRESS(A(1,1), I1, IERROR)
	  CALL MPI_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

       This  routine  is  provided  for  both  Fortran and C programmers and may be useful when writing portable code. In the current release, the
       address returned by this routine will be the same as that produced by the C & operator.

       C users may be tempted to avoid using MPI_Address and rely on the availability of the address operator &.   Note,  however,  that  &  cast-
       expression  is a pointer, not an address.  ANSI C does not require that the value of a pointer (or the pointer cast to int) be the absolute
       address of the object pointed at although this is commonly the case. Furthermore, referencing may not have a unique definition on  machines
       with a segmented address space. The use of MPI_Address to "reference" C variables guarantees portability to such machines as well.

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

Check Out this Related Man Page

MPI_Add_error_string(3OpenMPI)											    MPI_Add_error_string(3OpenMPI)

NAME

       MPI_Add_error_string - Associates a string with an error code or class

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Add_error_string(int errorcode, char *string)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_ADD_ERROR_STRING(ERRORCODE, STRING, IERROR)
	    INTEGER	   ERRORCODE, IERROR
	    CHARACTER*(*)  STRING

C++ Syntax
       #include <mpi.h>
       void MPI::Add_error_string(int errorcode, const char* string)

INPUT PARAMETERS

       errorcode     MPI error class, or an error code returned by an MPI routine (integer).

       string	     Text that corresponds to the error code or class (string).

OUTPUT PARAMETER

       IERROR	     Fortran only: Error status (integer).

DESCRIPTION

       This  routine  associates an error string with an error code or class. Calling MPI_Add_error_string for an error code or class that already
       has an associated error string will replace the old string with the new one. It is erroneous to	call  MPI_Add_error_string  for  an  error
       value  not  generated  via  MPI_Add_error_class	or  MPI_Add_error_code	(e.g.,	an  error  code  or  class  with  a value not greater than
       MPI_LAST_ERRCODE).

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_Add_error_class
       MPI_Add_error_code
       MPI_Error_class
       MPI_Error_string

Open MPI 1.2							  September 2006				    MPI_Add_error_string(3OpenMPI)

Linux and UNIX Man Pages

mpi_address(3openmpi) [osx man page]

Check Out this Related Man Page