root / man / man3 / HPL_recv.3
Historique | Voir | Annoter | Télécharger (1,36 ko)
| 1 |
.TH HPL_recv 3 "September 10, 2008" "HPL 2.0" "HPL Library Functions" |
|---|---|
| 2 |
.SH NAME |
| 3 |
HPL_recv \- Receive a message. |
| 4 |
.SH SYNOPSIS |
| 5 |
\fB\&#include "hpl.h"\fR |
| 6 |
|
| 7 |
\fB\&int\fR |
| 8 |
\fB\&HPL_recv(\fR |
| 9 |
\fB\&double *\fR |
| 10 |
\fI\&RBUF\fR, |
| 11 |
\fB\&int\fR |
| 12 |
\fI\&RCOUNT\fR, |
| 13 |
\fB\&int\fR |
| 14 |
\fI\&SRC\fR, |
| 15 |
\fB\&int\fR |
| 16 |
\fI\&RTAG\fR, |
| 17 |
\fB\&MPI_Comm\fR |
| 18 |
\fI\&COMM\fR |
| 19 |
\fB\&);\fR |
| 20 |
.SH DESCRIPTION |
| 21 |
\fB\&HPL_recv\fR |
| 22 |
is a simple wrapper around MPI_Recv. Its main purpose is |
| 23 |
to allow for some experimentation / tuning of this simple routine. |
| 24 |
Successful completion is indicated by the returned error code |
| 25 |
HPL_SUCCESS. In the case of messages of length less than or equal to |
| 26 |
zero, this function returns immediately. |
| 27 |
.SH ARGUMENTS |
| 28 |
.TP 8 |
| 29 |
RBUF (local output) double * |
| 30 |
On entry, RBUF specifies the starting address of buffer to be |
| 31 |
received. |
| 32 |
.TP 8 |
| 33 |
RCOUNT (local input) int |
| 34 |
On entry, RCOUNT specifies the number of double precision |
| 35 |
entries in RBUF. RCOUNT must be at least zero. |
| 36 |
.TP 8 |
| 37 |
SRC (local input) int |
| 38 |
On entry, SRC specifies the rank of the sending process in |
| 39 |
the communication space defined by COMM. |
| 40 |
.TP 8 |
| 41 |
RTAG (local input) int |
| 42 |
On entry, STAG specifies the message tag to be used for this |
| 43 |
communication operation. |
| 44 |
.TP 8 |
| 45 |
COMM (local input) MPI_Comm |
| 46 |
The MPI communicator identifying the communication space. |
| 47 |
.SH SEE ALSO |
| 48 |
.BR HPL_send \ (3), |
| 49 |
.BR HPL_sendrecv \ (3). |