Skip to content

Update deep_copy documentation to reflect allowed usage #845

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.

Sign up for GitHub

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

Merged
masterleinad merged 1 commit into from
Jun 3, 2026
Merged

Update deep_copy documentation to reflect allowed usage #845

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 6 additions & 4 deletions docs/source/API/core/view/deep_copy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,15 @@ Requirements

* If ``src`` and ``dest`` are `Kokkos::View <view.html>`_ s, then all the following are true:

- ``std::is_same<ViewDest::non_const_value_type, ViewSrc::non_const_value_type>::value == true``

- ``src.rank == dest.rank`` (or, for ``Kokkos::DynRankView`` , ``src.rank() == dest.rank()`` )
- ``src.rank() == dest.rank()``

- For all ``k`` in ``[0, dest.rank)`` ``dest.extent(k) == src.extent(k)`` (or the same as ``dest.rank()``)

- ``src.span_is_contiguous() && dest.span_is_contiguous() && std::is_same<ViewDest::array_layout,ViewSrc::array_layout>::value``, *or* there exists an `ExecutionSpace <../execution_spaces.html>`_ ``copy_space`` (either given or defaulted) such that both ``SpaceAccessibility<copy_space, ViewDest::memory_space>::accessible == true`` and ``SpaceAccessibility<copy_space,ViewSrc::memory_space>::accessible == true``.
- One of the following set of conditions must be true:

- Either ``std::is_assignable_v<ViewSrc::value_type, DestView::value_type>`` and there exists an `ExecutionSpace <../execution_spaces.html>`_ ``copy_space`` (either given or defaulted) such that both ``SpaceAccessibility<copy_space, ViewDest::memory_space>::accessible == true`` and ``SpaceAccessibility<copy_space,ViewSrc::memory_space>::accessible == true``.

- Or ``src.span_is_contiguous() && dest.span_is_contiguous()``, ``std::is_same_v<ViewDest::array_layout,ViewSrc::array_layout>``, and ``std::is_same_v<DestView::value_type, SrcView::non_const_value_type>``.

* If ``src`` is a `Kokkos::View <view.html>`_ and ``dest`` is a scalar, then ``src.rank == 0`` is true.

Expand Down
Loading