root / man / man3 / HPL_all_reduce.3
Historique | Voir | Annoter | Télécharger (1,33 ko)
| 1 |
.TH HPL_all_reduce 3 "September 10, 2008" "HPL 2.0" "HPL Library Functions" |
|---|---|
| 2 |
.SH NAME |
| 3 |
HPL_all_reduce \- All reduce operation. |
| 4 |
.SH SYNOPSIS |
| 5 |
\fB\&#include "hpl.h"\fR |
| 6 |
|
| 7 |
\fB\&int\fR |
| 8 |
\fB\&HPL_all_reduce(\fR |
| 9 |
\fB\&void *\fR |
| 10 |
\fI\&BUFFER\fR, |
| 11 |
\fB\&const int\fR |
| 12 |
\fI\&COUNT\fR, |
| 13 |
\fB\&const HPL_T_TYPE\fR |
| 14 |
\fI\&DTYPE\fR, |
| 15 |
\fB\&const HPL_T_OP \fR |
| 16 |
\fI\&OP\fR, |
| 17 |
\fB\&MPI_Comm\fR |
| 18 |
\fI\&COMM\fR |
| 19 |
\fB\&);\fR |
| 20 |
.SH DESCRIPTION |
| 21 |
\fB\&HPL_all_reduce\fR |
| 22 |
performs a global reduce operation across all |
| 23 |
processes of a group leaving the results on all processes. |
| 24 |
.SH ARGUMENTS |
| 25 |
.TP 8 |
| 26 |
BUFFER (local input/global out void * |
| 27 |
On entry, BUFFER points to the buffer to be combined. On |
| 28 |
exit, this array contains the combined data and is identical |
| 29 |
on all processes in the group. |
| 30 |
.TP 8 |
| 31 |
COUNT (global input) const int |
| 32 |
On entry, COUNT indicates the number of entries in BUFFER. |
| 33 |
COUNT must be at least zero. |
| 34 |
.TP 8 |
| 35 |
DTYPE (global input) const HPL_T_TYPE |
| 36 |
On entry, DTYPE specifies the type of the buffers operands. |
| 37 |
.TP 8 |
| 38 |
OP (global input) const HPL_T_OP |
| 39 |
On entry, OP is a pointer to the local combine function. |
| 40 |
.TP 8 |
| 41 |
COMM (global/local input) MPI_Comm |
| 42 |
The MPI communicator identifying the process collection. |
| 43 |
.SH SEE ALSO |
| 44 |
.BR HPL_broadcast \ (3), |
| 45 |
.BR HPL_reduce \ (3), |
| 46 |
.BR HPL_barrier \ (3), |
| 47 |
.BR HPL_min \ (3), |
| 48 |
.BR HPL_max \ (3), |
| 49 |
.BR HPL_sum \ (3). |