Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#5635: Update documentation to cover new overloads for parallel_scan #445

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

#5635: Update documentation to cover new overloads for parallel_scan #445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37146ae
Update documentation to cover new overloads for parallel_scan
thearusable Jul 28, 2023
6a0f23a
fix wording
fnrizzi Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/API/core/parallel-dispatch/parallel_scan.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Parameters:

- ``IntegerType``: defines a 1D iteration range, starting from 0 and going to a count.
- `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. Only valid inside a parallel region executed through a ``TeamPolicy`` or a ``TaskTeam``.
- `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
View file
Open in desktop
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