Skip to content

Commit

Permalink
favor link to common template arguments page over copy of the table i…
Browse files Browse the repository at this point in the history 
…n many `ExecutionPolicies` (#553)

* ditched table copy in the individual policy pages for a link to the general page

* typo correction
  • Loading branch information
@JBludau
JBludau authored Jul 30, 2024
1 parent 65223d5 commit e87218b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 39 deletions.
23 changes: 4 additions & 19 deletions docs/source/API/core/policies/MDRangePolicy.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,25 +29,10 @@ Interface
Parameters
----------

Common Arguments for all Execution Policies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Execution Policies generally accept compile time arguments via template parameters and runtime parameters via constructor arguments or setter functions.
* Template arguments can be given in arbitrary order.

+----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Argument | Options | Purpose |
+================+============================================================================+=========================================================================================================================================================+
| ExecutionSpace | ``Serial``, ``OpenMP``, ``Threads``, ``Cuda``, ``HIP``, ``SYCL``, ``HPX`` | Specify the Execution Space to execute the kernel in. Defaults to ``Kokkos::DefaultExecutionSpace``. |
+----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Schedule | ``Schedule<Dynamic>``, ``Schedule<Static>`` | Specify scheduling policy for work items. ``Dynamic`` scheduling is implemented through a work stealing queue. Default is machine and backend specific. |
+----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| IndexType | ``IndexType<int>`` | Specify integer type to be used for traversing the iteration space. Defaults to ``int64_t``. |
+----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| LaunchBounds | ``LaunchBounds<MaxThreads, MinBlocks>`` | Specifies hints to to the compiler about CUDA/HIP launch bounds. |
+----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| WorkTag | ``SomeClass`` | Specify the work tag type used to call the functor operator. Any arbitrary type defaults to ``void``. |
+----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
General Template Aguments
~~~~~~~~~~~~~~~~~~~~~~~~~

Valid template arguments for ``MDRangePolicy`` are described `here <../Execution-Policies.html#common-arguments-for-all-execution-policies>`_

Required Arguments Specific to MDRangePolicy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
5 changes: 5 additions & 0 deletions docs/source/API/core/policies/NestedPolicies.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ List

|
General Template Aguments
~~~~~~~~~~~~~~~~~~~~~~~~~

Valid template arguments are described `here <../Execution-Policies.html#common-arguments-for-all-execution-policies>`_

Usage
~~~~~

Expand Down
24 changes: 4 additions & 20 deletions docs/source/API/core/policies/RangePolicy.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,26 +84,10 @@ Synopsis
Parameters
----------

Common Arguments for all Execution Policies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Execution Policies generally accept compile time arguments via template parameters and runtime parameters via constructor arguments or setter functions.

* Template arguments can be given in arbitrary order.

+-------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Argument | Options | Purpose |
+===================+===========================================================================+=========================================================================================================================================================+
| ExecutionSpace | ``Serial``, ``OpenMP``, ``Threads``, ``Cuda``, ``HIP``, ``SYCL``, ``HPX`` | Specify the Execution Space to execute the kernel in. Defaults to ``Kokkos::DefaultExecutionSpace``. |
+-------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Schedule | ``Schedule<Dynamic>``, ``Schedule<Static>`` | Specify scheduling policy for work items. ``Dynamic`` scheduling is implemented through a work stealing queue. Default is machine and backend specific. |
+-------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| IndexType | ``IndexType<int>`` | Specify integer type to be used for traversing the iteration space. Defaults to ``int64_t``. |
+-------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| LaunchBounds | ``LaunchBounds<MaxThreads, MinBlocks>`` | Specifies hints to to the compiler about CUDA/HIP launch bounds. |
+-------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| WorkTag | ``SomeClass`` | Specify the work tag type used to call the functor operator. Any arbitrary type defaults to ``void``. |
+-------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
General Template Aguments
~~~~~~~~~~~~~~~~~~~~~~~~~

Valid template arguments for ``RangePolicy`` are described `here <../Execution-Policies.html#common-arguments-for-all-execution-policies>`_

Public Class Members
--------------------
Expand Down

0 comments on commit e87218b

Please sign in to comment.