mpi_irsend(3openmpi) [osx man page]

MPI_Irsend(3OpenMPI)													      MPI_Irsend(3OpenMPI)

NAME

       MPI_Irsend - Starts a ready-mode nonblocking send.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Irsend(void *buf, int count, MPI_Datatype datatype, int dest,
	    int tag, MPI_Comm comm, MPI_Request *request)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_IRSEND(BUF, COUNT, DATATYPE, DEST, TAG, COMM, REQUEST, IERROR)
	    <type>    BUF(*)
	    INTEGER   COUNT, DATATYPE, DEST, TAG, COMM, REQUEST, IERROR

C++ Syntax
       #include <mpi.h>
       Request Comm::Irsend(const void* buf, int count, const
	    Datatype& datatype, int dest, int tag) const

INPUT PARAMETERS

       buf	 Initial address of send buffer (choice).

       count	 Number of elements in send buffer (integer).

       datatype  Datatype of each send buffer element (handle).

       dest	 Rank of destination (integer).

       tag	 Message tag (integer).

       comm	 Communicator (handle).

OUTPUT PARAMETERS

       request	 Communication request (handle).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Irsend  starts  a  ready-mode  nonblocking  send.  Nonblocking  calls allocate a communication request object and associate it with the
       request handle (the argument request). The request can be used later to query the status of the communication or to wait  for  its  comple-
       tion.

       A  nonblocking  send call indicates that the system may start copying data out of the send buffer. The sender should not access any part of
       the send buffer after a nonblocking send operation is called, until the send completes.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions  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.

       Before the error value is returned, the current MPI error handler is 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.

SEE ALSO

       MPI_Rsend

Open MPI 1.2							  September 2006					      MPI_Irsend(3OpenMPI)

Check Out this Related Man Page

MPI_Send_init(3OpenMPI) 												   MPI_Send_init(3OpenMPI)

NAME

       MPI_Send_init - Builds a handle for a standard send.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Send_init(void *buf, int count, MPI_Datatype datatype,
	    int dest, int tag, MPI_Comm comm, MPI_Request *request)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_SEND_INIT(BUF, COUNT, DATATYPE, DEST, TAG, COMM, REQUEST,
		 IERROR)
	    <type>    BUF(*)
	    INTEGER   REQUEST, COUNT, DATATYPE, DEST, TAG
	    INTEGER   COMM, REQUEST, IERROR

C++ Syntax
       #include <mpi.h>
       Prequest Comm::Send_init(const void* buf, int count, const
	    Datatype& datatype, int dest, int tag) const

INPUT PARAMETERS

       buf	 Initial address of send buffer (choice).

       count	 Number of elements to send (integer).

       datatype  Type of each element (handle).

       dest	 Rank of destination (integer).

       tag	 Message tag (integer).

       comm	 Communicator (handle).

OUTPUT PARAMETERS

       request	 Communication request (handle).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       Creates a persistent communication request for a standard mode send operation, and binds to it all the arguments of a send operation.

       A communication (send or receive) that uses a persistent request is initiated by the function MPI_Start or MPI_Startall.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions 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.

       Before  the error value is returned, the current MPI error handler is 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.

SEE ALSO

       MPI_Bsend_init
       MPI_Ssend_init
       MPI_Rsend_init
       MPI_Recv_init
       MPI_Start
       MPI_Startall
       MPI_Request_free

Open MPI 1.2							  September 2006					   MPI_Send_init(3OpenMPI)

Linux and UNIX Man Pages

mpi_irsend(3openmpi) [osx man page]

Check Out this Related Man Page