From e780b2e36f2e3b7ed2995c8229e7ffab052377dc Mon Sep 17 00:00:00 2001 From: antoinemeyer5 Date: Sat, 14 Jan 2023 14:39:33 +0100 Subject: [PATCH] kokkos#120: API/core/builtinreducers/ValLocScalar transition from .md to .rst init --- .../API/core/builtinreducers/ValLocScalar.md | 37 --------------- .../API/core/builtinreducers/ValLocScalar.rst | 46 +++++++++++++++++++ 2 files changed, 46 insertions(+), 37 deletions(-) delete mode 100644 docs/source/API/core/builtinreducers/ValLocScalar.md create mode 100644 docs/source/API/core/builtinreducers/ValLocScalar.rst diff --git a/docs/source/API/core/builtinreducers/ValLocScalar.md b/docs/source/API/core/builtinreducers/ValLocScalar.md deleted file mode 100644 index 784aae84e..000000000 --- a/docs/source/API/core/builtinreducers/ValLocScalar.md +++ /dev/null @@ -1,37 +0,0 @@ -# `ValLocScalar` - -Template class for storing a value plus index for min/max location reducers. Should be accessed via `::value_type` defined for particular reducer. - -Header File: `Kokkos_Core.hpp` - -Usage: -```c++ -MaxLoc::value_type result; -parallel_reduce(N,Functor,MaxLoc(result)); -T resultValue = result.val; -I resultIndex = result.loc; -``` - -## Synopsis - -```c++ -template -struct ValLocScalar{ - Scalar val; - Index loc; - - void operator = (const ValLocScalar& rhs); -}; -``` - -## Public Members - -### Variables - - * `val`: Scalar Value. - * `loc`: Scalar index. - -### Assignment operators - - * `void operator = (const ValLocScalar& rhs);` - assign `val` and `loc` from `rhs`; diff --git a/docs/source/API/core/builtinreducers/ValLocScalar.rst b/docs/source/API/core/builtinreducers/ValLocScalar.rst new file mode 100644 index 000000000..2dd37c391 --- /dev/null +++ b/docs/source/API/core/builtinreducers/ValLocScalar.rst @@ -0,0 +1,46 @@ +``ValLocScalar`` +================ + +.. role::cpp(code) + :language: cpp + +Template class for storing a value plus index for min/max location reducers. Should be accessed via ``::value_type`` defined for particular reducer. + +Header File: ```` + +Usage +----- + +.. code-block:: cpp + + MaxLoc::value_type result; + parallel_reduce(N,Functor,MaxLoc(result)); + T resultValue = result.val; + I resultIndex = result.loc; + +Synopsis +-------- + +.. code-block:: cpp + + template + struct ValLocScalar{ + Scalar val; + Index loc; + + void operator = (const ValLocScalar& rhs); + }; + +Public Members +-------------- + +Variables +~~~~~~~~~ + +* ``val``: Scalar Value. +* ``loc``: Scalar index. + +Assignment operators +~~~~~~~~~~~~~~~~~~~~ + +* ``void operator = (const ValLocScalar& rhs);`` assign ``val`` and ``loc`` from ``rhs``;