Unix/Linux Go Back    

RedHat 9 (Linux i386) - man page for mpi_waitany (redhat section 3)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)

MPI_Waitany(3)				     LAM/MPI				   MPI_Waitany(3)

       MPI_Waitany -  Waits for any specified send or receive to complete

       #include <mpi.h>
       int MPI_Waitany(int count, MPI_Request *reqs, int *index,
	 MPI_Status *stat)

       count  - list length (integer)
       reqs   - array of requests (array of handles)

       index  -  index	of  handle  for  operation  that  completed (integer).	In the range 0 to
	       .  In Fortran, the range is 1 to count
       stat   - status object (Status), or the MPI constant MPI_STATUS_IGNORE

       If all of the requests are MPI_REQUEST_NULL , then index is returned  as  MPI_UNDEFINED	,
       and stat is returned as an empty status.

       For  send  operations,  the  only use of status is for MPI_Test_cancelled in the case that
       there is an error, in which case the MPI_ERROR field of status will be set.

       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argu-
       ment 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.

       If  an  error occurs in an MPI function, the current MPI error handler is called to handle
       it.  By default, this error handler aborts the MPI job.	The error handler may be  changed
       with  MPI_Errhandler_set  ;  the predefined error handler MPI_ERRORS_RETURN may be used to
       cause error values to be returned (in C and Fortran; this error handler is less useful  in
       with  the  C++  MPI  bindings.	The predefined error handler MPI::ERRORS_THROW_EXCEPTIONS
       should be used in C++ if the error value needs to be recovered).  Note that MPI	does  not
       guarantee that an MPI program can continue past an error.

       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.  The C++ bindings for
       MPI  do not return error values; instead, error values are communicated by throwing excep-
       tions of type MPI::Exception (but not by default).  Exceptions  are  only  thrown  if  the
       error value is not MPI::SUCCESS

       Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return
       upon an error, there will be no way to recover what the actual error value was.
	      - No error; MPI routine completed successfully.
	      - Invalid MPI_Request ; either null  or,	MPI_REQUEST_NULL  ,  in  the  case  of	a
	      MPI_Start or MPI_Startall , not a persistent request.
	      - Invalid count argument.  Count arguments must be non-negative; a count of zero is
	      often valid.
	      - Invalid argument.  Some argument is invalid and is not identified by  a  specific
	      error class.  This is typically a NULL pointer or other such error.

       For  more information, please see the official MPI Forum web site, which contains the text
       of both the MPI-1 and MPI-2 standards.  These documents contain detailed information about
       each MPI function (most of which is not duplicated in these man pages).


       The  LAM  Team  would  like the thank the MPICH Team for the handy program to generate man
       pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sowing/sowing.tar.gz ), the  initial  for-
       matting, and some initial text for most of the MPI-1 man pages.


LAM/MPI 6.5.8				    11/10/2002				   MPI_Waitany(3)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums

All times are GMT -4. The time now is 12:13 AM.