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.

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

#120: API-core-builtinreducers-ValLocScalar from md to rst #264

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 0 additions & 37 deletions docs/source/API/core/builtinreducers/ValLocScalar.md

This file was deleted.

46 changes: 46 additions & 0 deletions docs/source/API/core/builtinreducers/ValLocScalar.rst
Original file line number Diff line number Diff line change
@@ -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: ``<Kokkos_Core.hpp>``

Usage
-----

.. code-block:: cpp

MaxLoc<T,I,S>::value_type result;
parallel_reduce(N,Functor,MaxLoc<T,I,S>(result));
T resultValue = result.val;
I resultIndex = result.loc;

Synopsis
--------

.. code-block:: cpp

template<class Scalar, class Index>
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``;