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

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

Adding compiled files

File size: 2.0 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Ssend 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Ssend\fP \- Standard synchronous send.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Ssend(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
17INCLUDE 'mpif.h'
18MPI_SSEND(\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>
25void Comm::Ssend(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
31buf
32Initial address of send buffer (choice).
33.TP 1i
34count
35Number of elements in send buffer (nonnegative integer).
36.TP 1i
37datatype
38Datatype of each send buffer element (handle).
39.TP 1i
40dest
41Rank of destination (integer).
42.TP 1i
43tag
44Message tag (integer).
45.TP 1i
46comm
47Communicator (handle).
48
49.SH OUTPUT PARAMETER
50.ft R
51.TP 1i
52IERROR
53Fortran only: Error status (integer).
54
55.SH DESCRIPTION
56.ft R
57MPI_Ssend performs a synchronous-mode, blocking send. See the MPI-1 Standard for more detailed information about such sends.
58
59.SH ERRORS
60Almost 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.
61.sp
62Before the error value is returned, the current MPI error handler is
63called. 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. 
64
Note: See TracBrowser for help on using the repository browser.