Skip to content

Commit 5769809

Browse files
committed
ScatterView.rst: provide basic description and operators
1 parent 7529e8d commit 5769809

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/source/API/containers/ScatterView.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@
66

77
Header File: ``<Kokkos_ScatterView.hpp>``
88

9-
.. _parallelReduce: ../core/parallel-dispatch/parallel_reduce.html
9+
Description
10+
-----------
11+
`Kokkos View-based <../core/view/view.html>`_ data structure that abstracts over "scatter - contribute" algorithms, where many contributors (over multiple indices) are reduced to fewer output resultants (*e.g.*, sum, product, maximum or minimum). ``ScatterView`` transparently switches between **Atomic**-, and **Data Replication**-based scatter algorithms. Typically, a ``ScatterView`` wraps an existing View.
1012

11-
.. |parallelReduce| replace:: :cpp:func:`parallel_reduce`
1213

13-
Description
14+
Interface
1415
-----------
1516

1617
.. cppkokkos:class:: template <typename DataType, int Op, typename ExecSpace, typename Layout, int contribution> ScatterView
@@ -101,13 +102,18 @@ Description
101102
:member: typedef original_view_type internal_view_type;
102103
:member: internal_view_type internal_view;
103104

105+
.. rubric:: Operations
106+
.. cppkokkos:type:: ScatterSum
107+
.. cppkokkos:type:: ScatterProd
108+
.. cppkokkos:type:: ScatterMax
109+
.. cppkokkos:type:: ScatterMin
104110
105111
.. rubric:: Free Functions
106112

107113
.. cppkokkos:function:: contribute(View<DT1, VP...>& dest, Kokkos::Experimental::ScatterView<DT2, LY, ES, OP, CT, DP> const& src)
108114
109115
convenience function to perform final reduction of ScatterView
110-
results into a resultant View; may be called following |parallelReduce|_.
116+
results into a resultant View; may be called following `parallel_reduce <../core/parallel-dispatch/parallel_reduce.html>`_ .
111117

112118

113119
Example

0 commit comments

Comments
 (0)