#120: - API/core/view/view_like transition from .md to .rst

kokkos · Aug 29, 2022 · 7e85651 · 7e85651
1 parent 90b5ff2
commit 7e85651
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 9 deletions.
diff --git a/docs/source/API/core/view/view_like.md b/docs/source/API/core/view/view_like.md
diff --git a/docs/source/API/core/view/view_like.rst b/docs/source/API/core/view/view_like.rst
@@ -0,0 +1,11 @@
+View-like Types
+===============
+
+View-like types are loosely defined as the set of class templates that behave like `Kokkos::View <view.html>`__ from an interface perspective. There is not a full formal definition of what this means yet, which means there is no way for users to add to this list in a way that the new class is recognized by Kokkos facilities operating on View-like things. In Kokkos these class templates are considered View-like:
+
+* `Kokkos::View <view.html>`_
+* `Kokkos::DynRankView <../../containers/DynRankView.html>`_
+* `Kokkos::OffsetView <../../containers/Offset-View.html>`_
+* `Kokkos::DynamicView <../../containers/DynamicView.html>`_
+
+Notably, `Kokkos::DualView <../../containers/DualView.html>`_ and `Kokkos::ScatterView <../../containers/ScatterView.html>`_ are **not** included in this category.