From a8db189c3ce283a875c7582058557582ed52c37b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20Wr=C3=B3bel?= Date: Mon, 29 Aug 2022 15:49:41 +0200 Subject: [PATCH] #120: - API/core/view/view_alloc transition from .md to .rst --- docs/source/API/core/view/view_alloc.md | 52 --------------------- docs/source/API/core/view/view_alloc.rst | 58 ++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 52 deletions(-) delete mode 100644 docs/source/API/core/view/view_alloc.md create mode 100644 docs/source/API/core/view/view_alloc.rst diff --git a/docs/source/API/core/view/view_alloc.md b/docs/source/API/core/view/view_alloc.md deleted file mode 100644 index 70c178f7a..000000000 --- a/docs/source/API/core/view/view_alloc.md +++ /dev/null @@ -1,52 +0,0 @@ -# `view_alloc()` - -Header File: `Kokkos_View.hpp` - -Usage: -```c++ - Kokkos::view_alloc(exec_space, Kokkos::WithoutInitializing, "ViewString"); - Kokkos::view_wrap(pointer_to_wrapping_memory); -``` - -Create View allocation parameter bundle from argument list. Valid argument list members are: - * label as `C`-string or `std::string` - * memory space instance of the `View::memory_space` type - * execution space instance able to access `View::memory_space` - * `Kokkos::WithoutInitializing` to bypass initialization - * `Kokkos::AllowPadding` to allow allocation to pad dimensions for memory alignment - * a pointer to create an unmanaged View wrapping that pointer - -## Synopsis - -```c++ -template -**implementation-detail** -view_alloc(Args const&... args); - -template -KOKKOS_FUNCTION -**implementation-detail** -view_wrap(Args const&... args); -``` - -## Description - -* ```c++ - template - **implementation-detail** - view_alloc(Args const&... args); - ``` - Create View allocation parameter bundle from argument list. - - Restrictions: - * `args`: Cannot contain a pointer to memory. - -* ```c++ - template - **implementation-detail** - view_alloc(Args const&... args); - ``` - Create View allocation parameter bundle from argument list. - - Restrictions: - * `args`: Can only be a pointer to memory. diff --git a/docs/source/API/core/view/view_alloc.rst b/docs/source/API/core/view/view_alloc.rst new file mode 100644 index 000000000..dedc79143 --- /dev/null +++ b/docs/source/API/core/view/view_alloc.rst @@ -0,0 +1,58 @@ +``view_alloc()`` +================ + +.. role:: cpp(code) + :language: cpp + +Header File: ``Kokkos_View.hpp`` + +Usage: + +.. code-block:: cpp + + Kokkos::view_alloc(exec_space, Kokkos::WithoutInitializing, "ViewString"); + Kokkos::view_wrap(pointer_to_wrapping_memory); + +Create View allocation parameter bundle from argument list. Valid argument list members are: + +* label as :cpp:`C`\ -string or :cpp:`std::string` +* memory space instance of the :cpp:`View::memory_space` type +* execution space instance able to access :cpp:`View::memory_space` +* :cpp:`Kokkos::WithoutInitializing` to bypass initialization +* :cpp:`Kokkos::AllowPadding` to allow allocation to pad dimensions for memory alignment +* a pointer to create an unmanaged View wrapping that pointer + +Synopsis +-------- + +.. cpp:function:: template \ + **implementation-detail** \ + view_alloc(Args const&... args); + +.. cpp:function:: template \ + KOKKOS_FUNCTION \ + **implementation-detail** \ + view_wrap(Args const&... args); + +Description +----------- + +.. cpp:function:: template \ + **implementation-detail** \ + view_alloc(Args const&... args); + + Create View allocation parameter bundle from argument list. + + Restrictions: + + * ``args``\ : Cannot contain a pointer to memory. + +.. cpp:function:: template \ + **implementation-detail** \ + view_alloc(Args const&... args); + + Create View allocation parameter bundle from argument list. + + Restrictions: + + * ``args``\ : Can only be a pointer to memory.