Merge pull request #369 from masterleinad/document_kokkos_printf

Add documentation for Kokkos::printf
kokkos · Jul 10, 2023 · c271f96 · c271f96
2 parents 04f40b3 + c3126d0
commit c271f96
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/docs/source/API/core/Utilities.rst b/docs/source/API/core/Utilities.rst
@@ -7,6 +7,7 @@ Utilities
    ./utilities/abort
    ./utilities/all
    ./utilities/complex
+   ./utilities/printf
    ./utilities/timer
    ./utilities/device_id
    ./utilities/num_threads

diff --git a/docs/source/API/core/printf.rst b/docs/source/API/core/printf.rst
@@ -0,0 +1,16 @@
+``Kokkos::printf``
+=================
+
+.. role:: cppkokkos(code)
+    :language: cppkokkos
+
+Defined in header ``<Kokkos_Core.hpp>``
+
+.. code-block:: cpp
+
+    template <typename... Args>
+    KOKKOS_FUNCTION void printf(const char* format, Args... args);
+
+Prints the data specified in ``format`` and ``args...`` to ``stdout``.
+The behavior is analogous to ``std::printf``, but the return type is ``void``
+to ensure a consistent behavior across backends.