[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_Rsend 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_Rsend\fP \- Ready send. |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .SH C Syntax |
---|
| 10 | .nf |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_Rsend(void *\fIbuf\fP, int\fI count\fP, MPI_Datatype\fI datatype\fP, int\fI dest\fP, |
---|
| 13 | int\fI tag\fP, MPI_Comm\fI comm\fP) |
---|
| 14 | |
---|
| 15 | .SH Fortran Syntax |
---|
| 16 | .nf |
---|
| 17 | INCLUDE 'mpif.h' |
---|
| 18 | MPI_RSEND(\fIBUF, COUNT, DATATYPE, DEST, TAG, COMM, IERROR\fP) |
---|
| 19 | <type> \fIBUF\fP(*) |
---|
| 20 | INTEGER \fICOUNT, DATATYPE, DEST, TAG, COMM, IERROR\fP |
---|
| 21 | |
---|
| 22 | .SH C++ Syntax |
---|
| 23 | .nf |
---|
| 24 | #include <mpi.h> |
---|
| 25 | void Comm::Rsend(const void* \fIbuf\fP, int \fIcount\fP, const Datatype& |
---|
| 26 | \fIdatatype\fP, int \fIdest\fP, int \fItag\fP) const |
---|
| 27 | |
---|
| 28 | .SH INPUT PARAMETERS |
---|
| 29 | .ft R |
---|
| 30 | .TP 1i |
---|
| 31 | buf |
---|
| 32 | Initial address of send buffer (choice). |
---|
| 33 | .TP 1i |
---|
| 34 | count |
---|
| 35 | Number of elements in send buffer (nonnegative integer). |
---|
| 36 | .TP 1i |
---|
| 37 | datatype |
---|
| 38 | Datatype of each send buffer element (handle). |
---|
| 39 | .TP 1i |
---|
| 40 | dest |
---|
| 41 | Rank of destination (integer). |
---|
| 42 | .TP 1i |
---|
| 43 | tag |
---|
| 44 | Message tag (integer). |
---|
| 45 | .TP 1i |
---|
| 46 | comm |
---|
| 47 | Communicator (handle). |
---|
| 48 | |
---|
| 49 | .SH OUTPUT PARAMETER |
---|
| 50 | .ft R |
---|
| 51 | .TP 1i |
---|
| 52 | IERROR |
---|
| 53 | Fortran only: Error status (integer). |
---|
| 54 | |
---|
| 55 | .SH DESCRIPTION |
---|
| 56 | .ft R |
---|
| 57 | A ready send may only be called if the user can guarantee that a receive is |
---|
| 58 | already posted. It is an error if the receive is not posted before the |
---|
| 59 | ready send is called. |
---|
| 60 | |
---|
| 61 | .SH ERRORS |
---|
| 62 | Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object. |
---|
| 63 | .sp |
---|
| 64 | Before the error value is returned, the current MPI error handler is |
---|
| 65 | called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error. |
---|
| 66 | |
---|