root / man / man3 / HPL_sdrv.3 @ 1
Historique | Voir | Annoter | Télécharger (1,85 ko)
| 1 |
.TH HPL_sdrv 3 "September 10, 2008" "HPL 2.0" "HPL Library Functions" |
|---|---|
| 2 |
.SH NAME |
| 3 |
HPL_sdrv \- Send and receive a message. |
| 4 |
.SH SYNOPSIS |
| 5 |
\fB\&#include "hpl.h"\fR |
| 6 |
|
| 7 |
\fB\&int\fR |
| 8 |
\fB\&HPL_sdrv(\fR |
| 9 |
\fB\&double *\fR |
| 10 |
\fI\&SBUF\fR, |
| 11 |
\fB\&int\fR |
| 12 |
\fI\&SCOUNT\fR, |
| 13 |
\fB\&int\fR |
| 14 |
\fI\&STAG\fR, |
| 15 |
\fB\&double *\fR |
| 16 |
\fI\&RBUF\fR, |
| 17 |
\fB\&int\fR |
| 18 |
\fI\&RCOUNT\fR, |
| 19 |
\fB\&int\fR |
| 20 |
\fI\&RTAG\fR, |
| 21 |
\fB\&int\fR |
| 22 |
\fI\&PARTNER\fR, |
| 23 |
\fB\&MPI_Comm\fR |
| 24 |
\fI\&COMM\fR |
| 25 |
\fB\&);\fR |
| 26 |
.SH DESCRIPTION |
| 27 |
\fB\&HPL_sdrv\fR |
| 28 |
is a simple wrapper around MPI_Sendrecv. Its main purpose is |
| 29 |
to allow for some experimentation and tuning of this simple function. |
| 30 |
Messages of length less than or equal to zero are not sent nor |
| 31 |
received. Successful completion is indicated by the returned error |
| 32 |
code HPL_SUCCESS. |
| 33 |
.SH ARGUMENTS |
| 34 |
.TP 8 |
| 35 |
SBUF (local input) double * |
| 36 |
On entry, SBUF specifies the starting address of buffer to be |
| 37 |
sent. |
| 38 |
.TP 8 |
| 39 |
SCOUNT (local input) int |
| 40 |
On entry, SCOUNT specifies the number of double precision |
| 41 |
entries in SBUF. SCOUNT must be at least zero. |
| 42 |
.TP 8 |
| 43 |
STAG (local input) int |
| 44 |
On entry, STAG specifies the message tag to be used for the |
| 45 |
sending communication operation. |
| 46 |
.TP 8 |
| 47 |
RBUF (local output) double * |
| 48 |
On entry, RBUF specifies the starting address of buffer to be |
| 49 |
received. |
| 50 |
.TP 8 |
| 51 |
RCOUNT (local input) int |
| 52 |
On entry, RCOUNT specifies the number of double precision |
| 53 |
entries in RBUF. RCOUNT must be at least zero. |
| 54 |
.TP 8 |
| 55 |
RTAG (local input) int |
| 56 |
On entry, RTAG specifies the message tag to be used for the |
| 57 |
receiving communication operation. |
| 58 |
.TP 8 |
| 59 |
PARTNER (local input) int |
| 60 |
On entry, PARTNER specifies the rank of the collaborative |
| 61 |
process in the communication space defined by COMM. |
| 62 |
.TP 8 |
| 63 |
COMM (local input) MPI_Comm |
| 64 |
The MPI communicator identifying the communication space. |
| 65 |
.SH SEE ALSO |
| 66 |
.BR HPL_send \ (3), |
| 67 |
.BR HPL_recv \ (3). |