copy#

Header: <Kokkos_StdAlgorithms.hpp>

Description#

Copies the elements from a source range or rank-1 View to a destination range or rank-1 View.

Interface#

Warning

This is currently inside the Kokkos::Experimental namespace.

Overload set accepting execution space#

template <class ExecutionSpace, class InputIteratorType, class OutputIteratorType>
OutputIteratorType copy(const ExecutionSpace& exespace,                      (1)
                        InputIteratorType first_from,
                        InputIteratorType last_from,
                        OutputIteratorType first_to);

template <class ExecutionSpace, class InputIteratorType, class OutputIteratorType>
OutputIteratorType copy(const std::string& label,                            (2)
                        const ExecutionSpace& exespace,
                        InputIteratorType first_from,
                        InputIteratorType last_from,
                        OutputIteratorType first_to);
template <
  class ExecutionSpace,
  class DataType1, class... Properties1,
  class DataType2, class... Properties2
>
auto copy(const ExecutionSpace& exespace,                                    (3)
          const Kokkos::View<DataType1, Properties1...>& view_from,
          const Kokkos::View<DataType2, Properties2...>& view_to);
template <
  class ExecutionSpace,
  class DataType1, class... Properties1,
  class DataType2, class... Properties2
>
auto copy(const std::string& label, const ExecutionSpace& exespace,          (4)
          const Kokkos::View<DataType1, Properties1...>& view_from,
          const Kokkos::View<DataType2, Properties2...>& view_to);

Overload set accepting a team handle#

New in version 4.2.

template <class TeamHandleType, class InputIteratorType, class OutputIteratorType>
KOKKOS_FUNCTION
OutputIteratorType copy(const TeamHandleType& teamHandle,                    (5)
                        InputIteratorType first_from,
                        InputIteratorType last_from,
                        OutputIteratorType first_to);

template <
  class TeamHandleType, class DataType1, class... Properties1,
  class DataType2, class... Properties2>
KOKKOS_FUNCTION
auto copy(const TeamHandleType& teamHandle,                                  (6)
          const ::Kokkos::View<DataType1, Properties1...>& view_from,
          ::Kokkos::View<DataType2, Properties2...>& view_to);

Parameters and Requirements#

  • exespace: execution space instance

  • teamHandle: team handle instance given inside a parallel region when using a TeamPolicy

  • label: used to name the implementation kernels for debugging purposes

    • for 1, the default string is: “Kokkos::copy_iterator_api_default”

    • for 3, the default string is: “Kokkos::copy_view_api_default”

    • NOTE: overloads accepting a team handle do not use a label internally

  • first_from, last_from: range of elements to copy from

    • must be random access iterators

    • must represent a valid range, i.e., last_from >= first_from

    • must be accessible from exespace or from the execution space associated with the team handle

  • first_to: beginning of the range to copy to

    • must be a random access iterator and must be accessible from exespace or from the execution space associated with the team handle

  • view_from, view_to: source and destination views to copy elements from and to

    • must be rank-1, and have LayoutLeft, LayoutRight, or LayoutStride

    • must be accessible from exespace or from the execution space associated with the team handle

Return Value#

Iterator to the destination element after the last element copied.