Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_status_set_cancelled(3openmpi) [osx man page]

MPI_Status_set_cancelled(3OpenMPI)										MPI_Status_set_cancelled(3OpenMPI)

NAME
MPI_Status_set_cancelled - Sets status to indicate a request has been canceled. SYNTAX
C Syntax #include <mpi.h> int MPI_Status_set_cancelled(MPI_Status *status, int flag) Fortran Syntax INCLUDE 'mpif.h' MPI_STATUS_SET_CANCELLED(STATUS, FLAG, IERROR) INTEGER STATUS(MPI_STATUS_SIZE), IERROR LOGICAL FLAG C++ Syntax #include <mpi.h> void MPI::Status::Set_cancelled(bool flag) INPUT
/OUTPUT PARAMETER status Status with which to associate cancel flag (status). INPUT PARAMETER
flag If true, indicates request was canceled (logical). OUTPUT PARAMETER
IERROR Fortran only: Error status (integer). DESCRIPTION
If flag is set to true, then a subsequent call to MPI_Test_cancelled(status, flag) will also return flag = true; otherwise it will return false. NOTES
Users are advised not to reuse the status fields for values other than those for which they were intended. Doing so may lead to unexpected results when using the status object. For example, calling MPI_Get_elements may cause an error if the value is out of range, or it may be impossible to detect such an error. The extra_state argument provided with a generalized request can be used to return information that does not logically belong in status. Furthermore, modifying the values in a status set internally by MPI, such as MPI_Recv, may lead to unpredictable results and is strongly discouraged. ERRORS
Almost 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_Status_set_cancelled(3OpenMPI)

Check Out this Related Man Page

MPI_File_write_ordered_end(3OpenMPI)									      MPI_File_write_ordered_end(3OpenMPI)

NAME
MPI_File_write_ordered_end - Writes a file at a location specified by a shared file pointer; ending part of a split collective routine (blocking). SYNTAX
C Syntax #include <mpi.h> int MPI_File_write_ordered_end(MPI_File fh, void *buf, MPI_Status *status) Fortran Syntax INCLUDE 'mpif.h' MPI_FILE_WRITE_ORDERED_END(FH, BUF, STATUS, IERROR) <type> BUF(*) INTEGER FH, STATUS(MPI_STATUS_SIZE), IERROR C++ Syntax #include <mpi.h> void MPI::File::Write_ordered_end(const void* buf, MPI::Status& status) void MPI::File::Write_ordered_end(const void* buf) INPUT
/OUTPUT PARAMETER fh File handle (handle). INPUT PARAMETER
buf Initial address of buffer (choice). OUTPUT PARAMETERS
status Status object (status). IERROR Fortran only: Error status (integer). DESCRIPTION
MPI_File_write_ordered_end is the ending part of a split collective routine that must be called by all processes in the communicator group associated with the file handle fh. MPI_File_write_ordered_end returns the number of elements written into the file associated with fh in status. NOTES
All the nonblocking collective routines for data access are "split" into two routines, each with _begin or _end as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. ERRORS
Almost 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. For MPI I/O function errors, the default error handler is set to MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error. Open MPI 1.2 September 2006 MPI_File_write_ordered_end(3OpenMPI)
Man Page