Document completion queries for execution spaces

kokkos · May 18, 2023 · 4437abe · 4437abe
1 parent 207db07
commit 4437abe
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/source/API/core/execution_spaces.rst b/docs/source/API/core/execution_spaces.rst
@@ -313,6 +313,8 @@ Functions
 
 * ``const char* name() const;``: *Returns* the label of the execution space instance.
 
+* ``bool is_running() const;``: *Returns* whether the execution space has completed all kernels submitted to it or if any of the kernels submitted are still running.
+
 * ``bool in_parallel() const;``: *Returns* a value convertible to ``bool`` indicating whether the caller is executing as part of a Kokkos parallel pattern. *Note:* as currently implemented, there is no guarantee that ``true`` means the caller is necessarily executing as part of a pattern on the particular instance |ExecutionSpaceConcept|_; just *some* instance of |ExecutionSpaceConcept|_. This may be strengthened in the future.
 
 * ``int concurrency() const;`` *Returns* the maximum amount of concurrently executing work items in a parallel setting, i.e. the maximum number of threads utilized by an execution space instance.