Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MPI_Raccumulate(3)		      MPI		    MPI_Raccumulate(3)

NAME
       MPI_Raccumulate -  Accumulate data into the target process using	remote
       memory access and return	a request handle for the operation.

SYNOPSIS
       int MPI_Raccumulate(const void *origin_addr, int	origin_count, MPI_Datatype
			  origin_datatype, int target_rank, MPI_Aint
			  target_disp, int target_count, MPI_Datatype
			  target_datatype, MPI_Op op, MPI_Win win,
			  MPI_Request *request)

       MPI_Raccumulate is similar to MPI_Accumulate , except that it allocates
       a  communication	request	object and associates it with the request han-
       dle (the	argument request) that can be used to wait or test for comple-
       tion.   The  completion	of an MPI_Raccumulate operation	indicates that
       the origin buffer is free to be updated.	It does	not indicate that  the
       operation has completed at the target window.

INPUT PARAMETERS
       origin_addr
	      -	initial	address	of buffer (choice)
       origin_count
	      -	number of entries in buffer (nonnegative integer)
       origin_datatype
	      -	datatype of each buffer	entry (handle)
       target_rank
	      -	rank of	target (nonnegative integer)
       target_disp
	      -	 displacement from start of window to beginning	of target buf-
	      fer (nonnegative integer)
       target_count
	      -	number of entries in target buffer (nonnegative	integer)
       target_datatype
	      -	datatype of each entry in target buffer	(handle)
       op     -	predefined reduce operation (handle)
       win    -	window object (handle)

OUTPUT PARAMETERS
       request
	      -	RMA request (handle)

NOTES
       The basic components of both the	origin and target datatype must	be the
       same predefined datatype	(e.g., all MPI_INT or all MPI_DOUBLE_PRECISION
       ).

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 com-
       municators), MPI_File_set_errhandler (for files),  and  MPI_Win_set_er-
       rhandler	 (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 when-
       ever possible.

       MPI_SUCCESS
	      -	No error; MPI routine completed	successfully.
       MPI_ERR_ARG
	      -	Invalid	argument.  Some	argument is invalid and	is not identi-
	      fied by a	specific error class (e.g., MPI_ERR_RANK ).
       MPI_ERR_COUNT
	      -	Invalid	count argument.	 Count arguments must be non-negative;
	      a	count of zero is often valid.
       MPI_ERR_RANK
	      -	Invalid	source or destination rank.   Ranks  must  be  between
	      zero  and	the size of the	communicator minus one;	ranks in a re-
	      ceive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also  be
	      MPI_ANY_SOURCE .

       MPI_ERR_TYPE
	      -	Invalid	datatype argument.  Additionally, this error can occur
	      if an uncommitted	MPI_Datatype (see MPI_Type_commit ) is used in
	      a	communication call.
       MPI_ERR_WIN
	      -	Invalid	MPI window object

SEE ALSO
       MPI_Accumulate

				   11/9/2015		    MPI_Raccumulate(3)

NAME | SYNOPSIS | INPUT PARAMETERS | OUTPUT PARAMETERS | NOTES | NOTES FOR FORTRAN | ERRORS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=MPI_Raccumulate&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help