source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Ssend_init.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files
File size: 2.3 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Ssend_init 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Ssend_init\fP \- Builds a handle for a synchronous send.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Ssend_init(void *\fIbuf\fP, int\fI count\fP, MPI_Datatype\fI datatype\fP,
13        int\fI dest\fP, int\fI tag\fP, MPI_Comm\fI comm\fP, MPI_Request\fI *request\fP)
14
15.SH Fortran Syntax
16.nf
17INCLUDE 'mpif.h'
18MPI_SSEND_INIT(\fIBUF, COUNT, DATATYPE, DEST, TAG, COMM, REQUEST,
19                IERROR\fP)
20        <type>  \fIBUF\fP(*)
21        INTEGER \fICOUNT, DATATYPE, DEST, TAG, COMM, REQUEST, IERROR\fP
22
23.SH C++ Syntax
24.nf
25#include <mpi.h>
26Prequest Comm::Ssend_init(const void* \fIbuf\fP, int \fIcount\fP, const
27        Datatype& \fIdatatype\fP, int \fIdest\fP, int \fItag\fP) const
28
29.SH INPUT PARAMETERS
30.ft R
31.TP 1i
32buf
33Initial address of send buffer (choice).
34.TP 1i
35count
36Number of elements to send (integer).
37.TP 1i
38datatype
39Type of each element (handle).
40.TP 1i
41dest
42Rank of destination (integer).
43.TP 1i
44tag
45Message tag (integer).
46.TP 1i
47comm
48Communicator (handle).
49
50.SH OUTPUT PARAMETERS
51.ft R
52.TP 1i
53request
54Communication request (handle).
55.ft R
56.TP 1i
57IERROR
58Fortran only: Error status (integer).
59
60.SH DESCRIPTION
61.ft R
62Creates a persistent communication object for a synchronous mode send operation, and binds to it all the arguments of a send operation. 
63.sp
64A communication (send or receive) that uses a persistent request is initiated by the function MPI_Start.
65
66.SH ERRORS
67Almost 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.
68.sp
69Before the error value is returned, the current MPI error handler is
70called. 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. 
71
72.SH SEE ALSO
73.ft R
74.sp
75MPI_Bsend_init
76.br
77MPI_Send_init
78.br
79MPI_Rsend_init
80.br
81MPI_Recv_init
82.br
83MPI_Start
84.br
85MPI_Startall
86.br
87MPI_Ssend
88
89
Note: See TracBrowser for help on using the repository browser.