Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MPI_Testany(3)			      MPI			MPI_Testany(3)

NAME
       MPI_Testany  -	Tests for completion of	any previdously	initiated  re-
       quests

SYNOPSIS
       int MPI_Testany(int count, MPI_Request array_of_requests[], int *index,
		      int *flag, MPI_Status *status)

INPUT PARAMETERS
       count  -	list length (integer)
       array_of_requests
	      -	array of requests (array of handles)

OUTPUT PARAMETERS
       index  -	index of operation that	completed, or  MPI_UNDEFINED  if  none
	      completed	(integer)
       flag   -	true if	one of the operations is complete (logical)
       status -	status object (Status).	 May be	MPI_STATUS_IGNORE .

NOTES
       While it	is possible to list a request handle more than once in the ar-
       ray_of_requests , such an action	is considered erroneous	and may	 cause
       the program to unexecpectedly terminate or produce incorrect results.

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

NOTES ON THE MPI_STATUS	ARGUMENT
       The MPI_ERROR field of the status return	is only	set if the return from
       the  MPI	 routine  is MPI_ERR_IN_STATUS .  That error class is only re-
       turned by the routines  that  take  an  array  of  status  arguments  (
       MPI_Testall  , MPI_Testsome , MPI_Waitall , and MPI_Waitsome ).	In all
       other cases, the	value of the MPI_ERROR field  in  the  status  is  un-
       changed.	  See section 3.2.5 in the MPI-1.1 specification for the exact
       text.

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

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

       All MPI objects (e.g., MPI_Datatype , MPI_Comm )	are of type INTEGER in
       Fortran.

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

       MPI_SUCCESS
	      -	No error; MPI routine completed	successfully.

LOCATION
       src/mpi/pt2pt/testany.c

				   9/20/2012			MPI_Testany(3)

NAME | SYNOPSIS | INPUT PARAMETERS | OUTPUT PARAMETERS | NOTES | THREAD AND INTERRUPT SAFETY | NOTES ON THE MPI_STATUS ARGUMENT | NOTES FOR FORTRAN | ERRORS | LOCATION

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=MPI_Testany&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help