Query: mpi_test_cancelled
OS: osx
Section: 3openmpi
Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar
MPI_Test_cancelled(3OpenMPI) MPI_Test_cancelled(3OpenMPI)NAMEMPI_Test_cancelled - Tests whether a request was canceled.SYNTAXC Syntax #include <mpi.h> int MPI_Test_cancelled(MPI_Status *status, int *flag) Fortran Syntax INCLUDE 'mpif.h' MPI_TEST_CANCELLED(STATUS, FLAG, IERROR) LOGICAL FLAG INTEGER STATUS(MPI_STATUS_SIZE), IERROR C++ Syntax #include <mpi.h> bool Status::Is_cancelled() constINPUT PARAMETERstatus Status object (status).OUTPUT PARAMETERSflag True if operation was cancelled (logical). IERROR Fortran only: Error status (integer).DESCRIPTIONReturns flag = true if the communication associated with the status object was canceled successfully. In such a case, all other fields of status (such as count or tag) are undefined. Otherwise, returns flag = false. If a receive operation might be canceled, one should call MPI_Test_cancelled first, to check whether the operation was canceled, before checking on the other fields of the return status.NOTESCancel can be an expensive operation that should be used only exceptionally.ERRORSAlmost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func- tions 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. Before the error value is returned, the current MPI error handler is called. 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. Open MPI 1.2 September 2006 MPI_Test_cancelled(3OpenMPI)
Related Man Pages |
---|
mpi_errhandler_free(3openmpi) - osx |
mpi_finalized(3openmpi) - osx |
mpi_initialized(3openmpi) - osx |
mpi_test_cancelled(3openmpi) - osx |
mpi_win_get_errhandler(3openmpi) - osx |
Similar Topics in the Unix Linux Community |
---|
MPI C++ in a nested loop |