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

Adding bitwise reproducibility documentation #403

Merged
merged 5 commits into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
16 changes: 16 additions & 0 deletions docs/bitwise-repro.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. meta::
:description: rocThrust documentation and API reference
:keywords: rocThrust, ROCm, API, reference, data type, support

.. _bitwise-repro:

******************************************
Bitwise reproducibility
******************************************

With the exception of the below functions, all rocThrust API functions are bitwise reproducible - that is, given identical inputs, the function will return the exact same result in repeated invocations.

* scan (inclusive & exclusive)
* scan_by_key (inclusive & exclusive)
* reduce_by_key
* transform_scan
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ The documentation is structured as follows:
.. grid-item-card:: API reference

* :ref:`data-type-support`
* :ref:`bitwise-repro`
* :ref:`api-reference`
* :ref:`genindex`

Expand Down
1 change: 1 addition & 0 deletions docs/sphinx/_toc.yml.in
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ subtrees:
- caption: API reference
entries:
- file: data-type-support
- file: bitwise-repro
- file: cpp_api

- caption: About
Expand Down