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

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

Adding compiled files

File size: 3.5 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Startall 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Startall\fP \- Starts a collection of requests.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Startall(int \fIcount\fP, MPI_Request\fI *array_of_requests\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_STARTALL(\fICOUNT, ARRAY_OF_REQUESTS, IERROR\fP)
18        INTEGER \fICOUNT, ARRAY_OF_REQUESTS(*), IERROR\fP
19
20.SH C++ Syntax
21.nf
22#include <mpi.h>
23static void Prequest::Startall(int \fIcount\fP, Prequest \fIarray_of_requests\fP[])
24
25.SH INPUT PARAMETER
26.ft R
27.TP 1i
28count
29List length (integer).
30
31.SH INPUT/OUTPUT PARAMETER
32.ft R
33.TP 1i
34array_of_requests
35Array of requests (array of handle).
36
37.SH OUTPUT PARAMETER
38.ft R
39.TP 1i
40IERROR
41Fortran only: Error status (integer).
42
43.SH DESCRIPTION
44.ft R
45Starts all communications associated with requests in array_of_requests. A call to  MPI_Startall(count, array_of_requests) has the same effect as calls to MPI_Start (&array_of_requests[i]), executed for i=0 ,..., count-1, in some arbitrary order. 
46.sp
47A communication started with a call to MPI_Start or MPI_Startall is completed by a call to MPI_Wait, MPI_Test, or one of the derived functions MPI_Waitany, MPI_Testany, MPI_Waitall, MPI_Testall, MPI_Waitsome, MPI_Testsome (these are described in Section 3.7.5 of the MPI-1 Standard, "Multiple Completions"). The request becomes inactive after successful completion by such a call. The request is not deallocated, and it can be activated anew by another MPI_Start or MPI_Startall call.
48.sp
49A persistent request is deallocated by a call to MPI_Request_free (see Section 3.7.3  of the MPI-1 Standard, "Communication Completion"). 
50.sp
51The call to MPI_Request_free can occur at any point in the program after the persistent request was created. However, the request will be deallocated only after it becomes inactive. Active receive requests should not be freed. Otherwise, it will not be possible to check that the receive has completed. It is preferable, in general, to free requests when they are inactive. If this rule is followed, then the persistent communication request functions will be invoked in a sequence of the form,
52.br
53.sp
54    Create (Start Complete)* Free
55.br
56.sp
57where * indicates zero or more repetitions. If the same communication object is used in several concurrent threads, it is the user's responsibility to coordinate calls so that the correct sequence is obeyed.
58.sp
59A send operation initiated with MPI_Start can be matched with any receive operation and, likewise, a receive operation initiated with MPI_Start can receive messages generated by any send operation.
60
61.SH ERRORS
62Almost 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
64Before the error value is returned, the current MPI error handler is
65called. 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
67.SH SEE ALSO
68.ft R
69.sp
70MPI_Bsend_init
71.br
72MPI_Rsend_init
73.br
74MPI_Send_init
75.br
76MPI_Ssend_init
77.br
78MPI_Recv_init
79.br
80MPI_Start
81.br
82MPI_Request_free
83
84
Note: See TracBrowser for help on using the repository browser.