1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
.. _mpi_test_cancelled:
MPI_Test_cancelled
==================
.. include_body
:ref:`MPI_Test_cancelled` |mdash| Tests whether a request was canceled.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Test_cancelled(const MPI_Status *status, int *flag)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_TEST_CANCELLED(STATUS, FLAG, IERROR)
LOGICAL FLAG
INTEGER STATUS(MPI_STATUS_SIZE), IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Test_cancelled(status, flag, ierror)
TYPE(MPI_Status), INTENT(IN) :: status
LOGICAL, INTENT(OUT) :: flag
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT PARAMETER
---------------
* ``status``: Status object (status).
OUTPUT PARAMETERS
-----------------
* ``flag``: True if operation was cancelled (logical).
* ``ierror``: Fortran only: Error status (integer).
DESCRIPTION
-----------
Returns *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 :ref:`MPI_Test_cancelled` first, to check whether the operation was
canceled, before checking on the other fields of the return status.
NOTES
-----
Cancel can be an expensive operation that should be used only
exceptionally.
ERRORS
------
.. include:: ./ERRORS.rst
|
