Statistiques
| Révision :

root / man / man3 / HPL_recv.3 @ 1

Historique | Voir | Annoter | Télécharger (1,36 ko)

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