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-atomics-atomic_load from md to rst #301

Merged
merged 3 commits into from
Mar 3, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
28 changes: 0 additions & 28 deletions docs/source/API/core/atomics/atomic_load.md

This file was deleted.

30 changes: 30 additions & 0 deletions docs/source/API/core/atomics/atomic_load.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
``atomic_load``
===============

.. role:: cppkokkos(code)
:language: cppkokkos

Header File: ``<Kokkos_Core.hpp>``

Usage
-----

.. code-block:: cpp

value = atomic_load(ptr_to_value);

Atomically reads the value at the address given by ``ptr_to_value``.

Synopsis
--------

.. cppkokkos:function:: template<class T> T atomic_load(T* const ptr_to_value);

Description
-----------

.. cppkokkos:function:: template<class T> T atomic_load(T* const ptr_to_value);

* Atomically executes ``value = *ptr_to_value; return value;``.
- ``ptr_to_value``: address of the to be updated value.
- ``value``: value at address ``ptr_to_value``.