1MPI_Rsend(3)                        LAM/MPI                       MPI_Rsend(3)
2
3
4

NAME

6       MPI_Rsend -  Basic ready send
7

SYNOPSIS

9       #include <mpi.h>
10       int MPI_Rsend(void *buf, int count, MPI_Datatype dtype,
11                     int dest, int tag, MPI_Comm comm)
12

INPUT PARAMETERS

14       buf    - initial address of send buffer (choice)
15       count  - number of elements in send buffer (nonnegative integer)
16       dtype  - datatype of each send buffer element (handle)
17       dest   - rank of destination (integer)
18       tag    - message tag (integer)
19       comm   - communicator (handle)
20
21

NOTES FOR FORTRAN

23       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
24       an additional argument ierr at the end of the argument list.   ierr  is
25       an  integer and has the same meaning as the return value of the routine
26       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
27       the call statement.
28
29       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
30       Fortran.
31
32

ERRORS

34       If an error occurs in an MPI function, the current MPI error handler is
35       called  to  handle  it.   By default, this error handler aborts the MPI
36       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
37       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
38       values to be returned (in C and Fortran; this  error  handler  is  less
39       useful  in  with  the  C++  MPI bindings.  The predefined error handler
40       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
41       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
42       program can continue past an error.
43
44       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
45       value;  C routines as the value of the function and Fortran routines in
46       the last argument.  The C++ bindings for MPI do not return  error  val‐
47       ues;  instead,  error values are communicated by throwing exceptions of
48       type MPI::Exception (but not by default).  Exceptions are  only  thrown
49       if the error value is not MPI::SUCCESS .
50
51
52       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
53       functions will return upon an error, there will be no  way  to  recover
54       what the actual error value was.
55       MPI_SUCCESS
56              - No error; MPI routine completed successfully.
57       MPI_ERR_COMM
58              -  Invalid communicator.  A common error is to use a null commu‐
59              nicator in a call (not even allowed in MPI_Comm_rank ).
60       MPI_ERR_COUNT
61              - Invalid count argument.  Count arguments must be non-negative;
62              a count of zero is often valid.
63       MPI_ERR_TYPE
64              - Invalid datatype argument.  May be an uncommitted MPI_Datatype
65              (see MPI_Type_commit ).
66       MPI_ERR_TAG
67              - Invalid tag argument.  Tags must be non-negative;  tags  in  a
68              receive  ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.)  may also
69              be MPI_ANY_TAG .  The largest tag value is available through the
70              the attribute MPI_TAG_UB .
71
72       MPI_ERR_RANK
73              -  Invalid  source  or  destination rank.  Ranks must be between
74              zero and the size of the communicator  minus  one;  ranks  in  a
75              receive  (  MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
76              be MPI_ANY_SOURCE .
77
78
79

MORE INFORMATION

81       For more information, please see the official MPI Forum web site, which
82       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
83       ments contain detailed information about each  MPI  function  (most  of
84       which is not duplicated in these man pages).
85
86       http://www.mpi-forum.org/
87
88
89

ACKNOWLEDGEMENTS

91       The  LAM Team would like the thank the MPICH Team for the handy program
92       to generate man pages  ("doctext"  from  ftp://ftp.mcs.anl.gov/pub/sow‐
93       ing/sowing.tar.gz  ), the initial formatting, and some initial text for
94       most of the MPI-1 man pages.
95

LOCATION

97       rsend.c
98
99
100
101LAM/MPI 7.1.2                      2/23/2006                      MPI_Rsend(3)
Impressum