Blame www/www3/MPI_Testany.html

Packit Service c5cf8c
Packit Service c5cf8c
<HTML>
Packit Service c5cf8c
<HEAD>
Packit Service c5cf8c
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit Service c5cf8c
<TITLE>MPI_Testany</TITLE>
Packit Service c5cf8c
</HEAD>
Packit Service c5cf8c
<BODY BGCOLOR="FFFFFF">
Packit Service c5cf8c

MPI_Testany

Packit Service c5cf8c
Tests for completion of any previdously initiated requests 
Packit Service c5cf8c

Synopsis

Packit Service c5cf8c
Packit Service c5cf8c
int MPI_Testany(int count, MPI_Request array_of_requests[], int *indx,
Packit Service c5cf8c
                int *flag, MPI_Status * status)
Packit Service c5cf8c
Packit Service c5cf8c

Input Parameters

Packit Service c5cf8c
Packit Service c5cf8c
count
list length (integer)
Packit Service c5cf8c
Packit Service c5cf8c
array_of_requests
array of requests (array of handles)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Output Parameters

Packit Service c5cf8c
Packit Service c5cf8c
indx
index of operation that completed, or <tt>MPI_UNDEFINED</tt> if none
Packit Service c5cf8c
completed (integer)
Packit Service c5cf8c
Packit Service c5cf8c
flag
true if one of the operations is complete (logical)
Packit Service c5cf8c
Packit Service c5cf8c
status
status object (Status). May be <tt>MPI_STATUS_IGNORE</tt>.
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Notes

Packit Service c5cf8c

Packit Service c5cf8c
While it is possible to list a request handle more than once in the
Packit Service c5cf8c
<tt>array_of_requests</tt>, such an action is considered erroneous and may cause the
Packit Service c5cf8c
program to unexecpectedly terminate or produce incorrect results.
Packit Service c5cf8c

Packit Service c5cf8c

Thread and Interrupt Safety

Packit Service c5cf8c

Packit Service c5cf8c
This routine is thread-safe.  This means that this routine may be
Packit Service c5cf8c
safely used by multiple threads without the need for any user-provided
Packit Service c5cf8c
thread locks.  However, the routine is not interrupt safe.  Typically,
Packit Service c5cf8c
this is due to the use of memory allocation routines such as <tt>malloc
Packit Service c5cf8c
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
Packit Service c5cf8c

Packit Service c5cf8c

Notes on the MPI_Status argument

Packit Service c5cf8c

Packit Service c5cf8c
The <tt>MPI_ERROR</tt> field of the status return is only set if
Packit Service c5cf8c
the return from the MPI routine is <tt>MPI_ERR_IN_STATUS</tt>.  That error class
Packit Service c5cf8c
is only returned by the routines that take an array of status arguments
Packit Service c5cf8c
(<tt>MPI_Testall</tt>, <tt>MPI_Testsome</tt>, <tt>MPI_Waitall</tt>, and <tt>MPI_Waitsome</tt>).  In
Packit Service c5cf8c
all other cases, the value of the <tt>MPI_ERROR</tt> field in the status is
Packit Service c5cf8c
unchanged.  See section 3.2.5 in the MPI-1.1 specification for the
Packit Service c5cf8c
exact text.
Packit Service c5cf8c

Packit Service c5cf8c
For send operations, the only use of status is for <tt>MPI_Test_cancelled</tt> or
Packit Service c5cf8c
in the case that there is an error in one of the four routines that
Packit Service c5cf8c
may return the error class <tt>MPI_ERR_IN_STATUS</tt>, in which case the
Packit Service c5cf8c
<tt>MPI_ERROR</tt> field of status will be set.  In that case, the value
Packit Service c5cf8c
will be set to <tt>MPI_SUCCESS</tt> for any send or receive operation that completed
Packit Service c5cf8c
successfully, or <tt>MPI_ERR_PENDING</tt> for any operation which has neither
Packit Service c5cf8c
failed nor completed.
Packit Service c5cf8c

Packit Service c5cf8c

Notes for Fortran

Packit Service c5cf8c
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
Packit Service c5cf8c
an additional argument <tt>ierr</tt> at the end of the argument list.  <tt>ierr
Packit Service c5cf8c
</tt>is an integer and has the same meaning as the return value of the routine
Packit Service c5cf8c
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
Packit Service c5cf8c
<tt>call</tt> statement.
Packit Service c5cf8c

Packit Service c5cf8c
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
Packit Service c5cf8c
</tt>in Fortran.
Packit Service c5cf8c

Packit Service c5cf8c

Errors

Packit Service c5cf8c

Packit Service c5cf8c
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
Packit Service c5cf8c
C routines as the value of the function and Fortran routines in the last
Packit Service c5cf8c
argument.  Before the value is returned, the current MPI error handler is
Packit Service c5cf8c
called.  By default, this error handler aborts the MPI job.  The error handler
Packit Service c5cf8c
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
Packit Service c5cf8c
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
Packit Service c5cf8c
RMA windows).  The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
Packit Service c5cf8c
its use is deprecated.  The predefined error handler
Packit Service c5cf8c
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Packit Service c5cf8c
Note that MPI does not guarentee that an MPI program can continue past
Packit Service c5cf8c
an error; however, MPI implementations will attempt to continue whenever
Packit Service c5cf8c
possible.
Packit Service c5cf8c

Packit Service c5cf8c
Packit Service c5cf8c
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit Service c5cf8c
Packit Service c5cf8c
</BODY></HTML>