👤
Home Man
Search
Today's Posts
Register

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:
Select Section of Man Page:
Select Man Page Repository:

RedHat 9 (Linux i386) - man page for mpi_get (redhat section 3)

MPI_Get(3)				     LAM/MPI				       MPI_Get(3)

NAME
       MPI_Get -  One Sided data fetch

SYNOPSIS
       #include <mpi.h>
       int
       MPI_Get(orgaddr, orgcnt, orgtype, rank, targdisp, targcnt, targtype, win)

       void   *orgaddr;
       int   orgcnt;
       MPI_Datatype  orgtype;
       int   rank;
       MPI_Aint  targdisp;
       int   targcnt;
       MPI_Datatype  targtype;
       MPI_Win	 win;

INPUT PARAMETERS
       orgaddr
	      - initial address of origin buffer (choice)
       orgcnt - number of entries in origin buffer (nonnegative integer)
       orgtype
	      - datatype of each entry in origin buffer (handle)
       rank   - rank of target (nonnegative integer)
       targdisp
	      - displacement from window start to the beginning of the target buffer (nonnegative
	      integer)
       targcnt
	      - number of entries in target buffer (nonnegative integer)
       targtype
	      - datatype of each entry in target buffer (handle)
       win    - window object used for communication (handle)

NOTES
       Similar to MPI_PUT, except that the direction of  data  transfer  is  reversed.	Data  are
       copied  from the target memory to the origin. The origin_datatype may not specify overlap-
       ping entries in the origin buffer. The target buffer must be contained within  the  target
       window, and the copied data must fit, without truncation, in the origin buffer.

NOTES FOR FORTRAN
       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argu-
       ment 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.

USAGE WITH IMPI EXTENSIONS
       The IMPI standard only supports MPI-1 functions.  Hence, this function  is  currently  not
       designed to operate within an IMPI job.

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 excep-
       tions 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_WIN
	      - Invalid window.  A common error is to use a null window in a call.
       MPI_ERR_RANK
	      - Invalid source or destination rank.  Ranks must be between zero and the  size  of
	      the  communicator  minus	one;  ranks  in  a  receive  (	MPI_Recv  ,  MPI_Irecv	,
	      MPI_Sendrecv , etc.) may also be MPI_ANY_SOURCE
	       .
       MPI_ERR_OTHER
	      - Other error; use MPI_Error_string to get more information about this error code.
       MPI_ERR_EPOCH
	      - This error indicates than an operation has been attempted on a	"closed"  window.
	      Certain  one-sided operations can only be performed on windows whose epoch has been
	      started with MPI_Win_start.
       MPI_ERR_INTERN
	      - An internal error has been detected.  This is fatal.  Please send a bug report to
	      the LAM mailing list (see http://www.lam-mpi.org/contact.php ).
       MPI_ERR_TYPENOTSUP
	      -  Type  not supported for this operation.  This typically applies to either reduc-
	      tion operations (for which only a limited combination of datatypes  and  operations
	      are defined, see MPI-1, section 4.9.2) or one-sided operations where the actions on
	      specific datatpyes have not been implemented yet.

SEE ALSO
       MPI_Put(3), MPI_Accumulate(3), MPI_Win_create(3),  MPI_Win_start(3),  MPI_Win_complete(3),
       MPI_Win_fence(3),     MPI_Win_free(3),	  MPI_Win_get_group(3),     MPI_Win_get_group(3),
       MPI_Win_wait(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
       get.c

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


All times are GMT -4. The time now is 06:07 PM.

Unix & Linux Forums Content Copyrightę1993-2018. All Rights Reserved.
×
UNIX.COM Login
Username:
Password:  
Show Password