1MPI_Accumulate(3) LAM/MPI MPI_Accumulate(3)
2
6 MPI_Accumulate - Accumulates data into a window
7
9 #include <mpi.h>
10 int MPI_Accumulate(void *orgaddr, int orgcnt, MPI_Datatype orgtype, int rank,
11 MPI_Aint targdisp, int targcnt, MPI_Datatype targtype,
12 MPI_Op op, MPI_Win win)
13
15 orgaddr
16 - initial address of buffer (choice)
17 orgcnt - number of entries in buffer (nonnegative integer)
18 orgtype
19 - datatype of each buffer entry (handle)
20 rank - rank of target (nonnegative integer)
21 targdisp
22 - displacement from start of window to beginning of target buf‐
23 fer (nonnegative integer)
24 targtype
25 - datatype of each entry in target buffer (handle)
26 op - reduce operation (handle)
27 win - window object (handle)
28
31 MPI_PUT is a special case of MPI_ACCUMULATE, with the operation
32 MPI_REPLACE. Note, however, that MPI_PUT and MPI_ACCUMULATE have dif‐
33 ferent constraints on concurrent updates. ( End of advice to users.)
34
37 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
38 an additional argument ierr at the end of the argument list. ierr is
39 an integer and has the same meaning as the return value of the routine
40 in C. In Fortran, MPI routines are subroutines, and are invoked with
41 the call statement.
42 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
44 Fortran.
45
48 If an error occurs in an MPI function, the current MPI error handler is
49 called to handle it. By default, this error handler aborts the MPI
50 job. The error handler may be changed with MPI_Errhandler_set ; the
51 predefined error handler MPI_ERRORS_RETURN may be used to cause error
52 values to be returned (in C and Fortran; this error handler is less
53 useful in with the C++ MPI bindings. The predefined error handler
54 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
55 needs to be recovered). Note that MPI does not guarantee that an MPI
56 program can continue past an error.
57 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
59 value; C routines as the value of the function and Fortran routines in
60 the last argument. The C++ bindings for MPI do not return error val‐
61 ues; instead, error values are communicated by throwing exceptions of
62 type MPI::Exception (but not by default). Exceptions are only thrown
63 if the error value is not MPI::SUCCESS .
64 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
67 functions will return upon an error, there will be no way to recover
68 what the actual error value was.
69 MPI_SUCCESS
70 - No error; MPI routine completed successfully.
71 MPI_ERR_WIN
72 - Invalid window. A common error is to use a null window in a
73 call.
74 MPI_ERR_TYPE
75 - Invalid datatype argument. May be an uncommitted MPI_Datatype
76 (see MPI_Type_commit ).
77 MPI_ERR_EPOCH
78 - This error indicates than an operation has been attempted on a
79 "closed" window. Certain one-sided operations can only be per‐
80 formed on windows whose epoch has been started with
81 MPI_Win_start.
82 MPI_ERR_INTERN
83 - An internal error has been detected. This is fatal. Please
84 send a bug report to the LAM mailing list (see http://www.lam-
85 mpi.org/contact.php ).
86 MPI_ERR_TYPENOTSUP
87 - Type not supported for this operation. This typically applies
88 to either reduction operations (for which only a limited combi‐
89 nation of datatypes and operations are defined, see MPI-1, sec‐
90 tion 4.9.2) or one-sided operations where the actions on spe‐
91 cific datatpyes have not been implemented yet.
92
95 MPI_Put(3), MPI_Get(3), MPI_Win_create(3), MPI_Win_start(3),
96 MPI_Win_complete(3), MPI_Win_fence(3), MPI_Win_free(3),
97 MPI_Win_get_group(3), MPI_Win_get_group(3), MPI_Win_wait(3)
98
101 For more information, please see the official MPI Forum web site, which
102 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
103 ments contain detailed information about each MPI function (most of
104 which is not duplicated in these man pages).
105 http://www.mpi-forum.org/
107
111 accumulate.c
112LAM/MPI 7.1.2 2/23/2006 MPI_Accumulate(3)