Skip to content

Commit

Permalink
#5635: Update documentation to cover new overloads for parallel_scan
Browse files Browse the repository at this point in the history
  • Loading branch information
thearusable committed Jul 28, 2023
1 parent ca5d2c4 commit 9b16d3e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/API/core/parallel-dispatch/parallel_scan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ Parameters:
* ExecPolicy: An *ExecutionPolicy* which defines iteration space and other execution properties. Valid policies are:

- ``IntegerType``: defines a 1D iteration range, starting from 0 and going to a count.
- `RangePolicy <../policies/RangePolicy.html>`_: defines a 1D iteration range.
- `RangePolicy <../policies/RangePolicy.html>`_: defines a 1D iteration range.
- `TeamThreadRange <../policies/TeamThreadRange.html>`_: defined a 1D iteration range to be executed through thread parallelization dividing the range over the threads of the team.
- `ThreadVectorRange <../policies/ThreadVectorRange.html>`_: defines a 1D iteration range to be executed through vector parallelization dividing the threads within a team. Only valid inside a parallel region executed through a ``TeamPolicy`` or a ``TaskTeam``.
* FunctorType: A valid functor with (at minimum) an ``operator()`` with a matching signature for the ``ExecPolicy`` combined with the reduced type.
* ReturnType: a POD type with ``operator +=`` and ``operator =``, or a ``Kokkos::View``.
Expand Down
2 changes: 2 additions & 0 deletions docs/source/API/core/policies/TeamThreadRange.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Usage
parallel_for(TeamThreadRange(team,range), [=] (int i) {...});
parallel_reduce(TeamThreadRange(team,begin,end),
[=] (int i, double& lsum) {...},sum);
parallel_scan(TeamThreadRange(team,begin,end),
[=] (lint i, double& lsum, bool final) {...},sum);
TeamThreadRange is a `nested execution policy <./NestedPolicies.html>`_ used inside hierarchical parallelism. In contrast to global policies, the public interface for nested policies is implemented as functions, in order to enable implicit templating on the execution space type via the team handle.

Expand Down

0 comments on commit 9b16d3e

Please sign in to comment.