|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
<HTML>
|
|
Packit Service |
c5cf8c |
<HEAD>
|
|
Packit Service |
c5cf8c |
<META NAME="GENERATOR" CONTENT="DOCTEXT">
|
|
Packit Service |
c5cf8c |
<TITLE>MPI_Rget_accumulate</TITLE>
|
|
Packit Service |
c5cf8c |
</HEAD>
|
|
Packit Service |
c5cf8c |
<BODY BGCOLOR="FFFFFF">
|
|
Packit Service |
c5cf8c |
MPI_Rget_accumulate
|
|
Packit Service |
c5cf8c |
Perform an atomic, one-sided read-and-accumulate operation and return a request handle for the operation.
|
|
Packit Service |
c5cf8c |
Synopsis
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
int MPI_Rget_accumulate(const void *origin_addr, int origin_count,
|
|
Packit Service |
c5cf8c |
MPI_Datatype origin_datatype, void *result_addr, int result_count,
|
|
Packit Service |
c5cf8c |
MPI_Datatype result_datatype, int target_rank, MPI_Aint target_disp,
|
|
Packit Service |
c5cf8c |
int target_count, MPI_Datatype target_datatype, MPI_Op op, MPI_Win win,
|
|
Packit Service |
c5cf8c |
MPI_Request * request)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
<tt>MPI_Rget_accumulate</tt> is similar to <tt>MPI_Get_accumulate</tt>, except that it allocates
|
|
Packit Service |
c5cf8c |
a communication request object and associates it with the request handle (the
|
|
Packit Service |
c5cf8c |
argument request) that can be used to wait or test for completion. The
|
|
Packit Service |
c5cf8c |
completion of an <tt>MPI_Rget_accumulate</tt> operation indicates that the data is
|
|
Packit Service |
c5cf8c |
available in the result buffer and the origin buffer is free to be updated. It
|
|
Packit Service |
c5cf8c |
does not indicate that the operation has been completed at the target window.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Input Parameters
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
origin_addr initial address of buffer (choice)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
origin_count number of entries in buffer (nonnegative integer)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
origin_datatype datatype of each buffer entry (handle)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
result_addr initial address of result buffer (choice)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
result_count number of entries in result buffer (non-negative integer)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
result_datatype datatype of each entry in result buffer (handle)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
target_rank rank of target (nonnegative integer)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
target_disp displacement from start of window to beginning of target
|
|
Packit Service |
c5cf8c |
buffer (nonnegative integer)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
target_count number of entries in target buffer (nonnegative integer)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
target_datatype datatype of each entry in target buffer (handle)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
op predefined reduce operation (handle)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
win window object (handle)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Output Parameters
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
request RMA request (handle)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Notes
|
|
Packit Service |
c5cf8c |
This operations is atomic with respect to other "accumulate" operations.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
The get and accumulate steps are executed atomically for each basic element in
|
|
Packit Service |
c5cf8c |
the datatype (see MPI 3.0 Section 11.7 for details). The predefined operation
|
|
Packit Service |
c5cf8c |
<tt>MPI_REPLACE</tt> provides fetch-and-set behavior.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
The basic components of both the origin and target datatype must be the same
|
|
Packit Service |
c5cf8c |
predefined datatype (e.g., all <tt>MPI_INT</tt> or all <tt>MPI_DOUBLE_PRECISION</tt>).
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Notes for Fortran
|
|
Packit Service |
c5cf8c |
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
|
|
Packit Service |
c5cf8c |
an additional argument <tt>ierr</tt> at the end of the argument list. <tt>ierr
|
|
Packit Service |
c5cf8c |
</tt>is an integer and has the same meaning as the return value of the routine
|
|
Packit Service |
c5cf8c |
in C. In Fortran, MPI routines are subroutines, and are invoked with the
|
|
Packit Service |
c5cf8c |
<tt>call</tt> statement.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
|
|
Packit Service |
c5cf8c |
</tt>in Fortran.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Errors
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
|
|
Packit Service |
c5cf8c |
C routines as the value of the function and Fortran routines in the last
|
|
Packit Service |
c5cf8c |
argument. Before the value is returned, the current MPI error handler is
|
|
Packit Service |
c5cf8c |
called. By default, this error handler aborts the MPI job. The error handler
|
|
Packit Service |
c5cf8c |
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
|
|
Packit Service |
c5cf8c |
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
|
|
Packit Service |
c5cf8c |
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
|
|
Packit Service |
c5cf8c |
its use is deprecated. The predefined error handler
|
|
Packit Service |
c5cf8c |
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
|
|
Packit Service |
c5cf8c |
Note that MPI does not guarentee that an MPI program can continue past
|
|
Packit Service |
c5cf8c |
an error; however, MPI implementations will attempt to continue whenever
|
|
Packit Service |
c5cf8c |
possible.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_SUCCESS No error; MPI routine completed successfully.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_ARG Invalid argument. Some argument is invalid and is not
|
|
Packit Service |
c5cf8c |
identified by a specific error class (e.g., <tt>MPI_ERR_RANK</tt>).
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_COUNT Invalid count argument. Count arguments must be
|
|
Packit Service |
c5cf8c |
non-negative; a count of zero is often valid.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_RANK Invalid source or destination rank. Ranks must be between
|
|
Packit Service |
c5cf8c |
zero and the size of the communicator minus one; ranks in a receive
|
|
Packit Service |
c5cf8c |
(<tt>MPI_Recv</tt>, <tt>MPI_Irecv</tt>, <tt>MPI_Sendrecv</tt>, etc.) may also be <tt>MPI_ANY_SOURCE</tt>.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_TYPE Invalid datatype argument. Additionally, this error can
|
|
Packit Service |
c5cf8c |
occur if an uncommitted MPI_Datatype (see <tt>MPI_Type_commit</tt>) is used
|
|
Packit Service |
c5cf8c |
in a communication call.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_WIN Invalid MPI window object
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
See Also
|
|
Packit Service |
c5cf8c |
MPI_Get_accumulate MPI_Fetch_and_op
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
</BODY></HTML>
|