//@HEADER // ************************************************************************ // // Kokkos v. 4.0 // Copyright (2022) National Technology & Engineering // Solutions of Sandia, LLC (NTESS). // // Under the terms of Contract DE-NA0003525 with NTESS, // the U.S. Government retains certain rights in this software. // // Part of Kokkos, under the Apache License v2.0 with LLVM Exceptions. // See https://kokkos.org/LICENSE for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //@HEADER #ifndef KOKKOS_STD_ALGORITHMS_TRANSFORM_REDUCE_HPP #define KOKKOS_STD_ALGORITHMS_TRANSFORM_REDUCE_HPP #include "impl/Kokkos_TransformReduce.hpp" #include "Kokkos_BeginEnd.hpp" namespace Kokkos { namespace Experimental { // // overload set accepting execution space // // ---------------------------- // overload set1: // no custom functors passed, so equivalent to // transform_reduce(first1, last1, first2, init, plus<>(), multiplies<>()); // ---------------------------- template ::value, int> = 0> ValueType transform_reduce(const ExecutionSpace& ex, IteratorType1 first1, IteratorType1 last1, IteratorType2 first2, ValueType init_reduction_value) { return Impl::transform_reduce_default_functors_exespace_impl( "Kokkos::transform_reduce_default_functors_iterator_api", ex, first1, last1, first2, std::move(init_reduction_value)); } template ::value, int> = 0> ValueType transform_reduce(const std::string& label, const ExecutionSpace& ex, IteratorType1 first1, IteratorType1 last1, IteratorType2 first2, ValueType init_reduction_value) { return Impl::transform_reduce_default_functors_exespace_impl( label, ex, first1, last1, first2, std::move(init_reduction_value)); } // overload1 accepting views template ::value, int> = 0> ValueType transform_reduce( const ExecutionSpace& ex, const ::Kokkos::View& first_view, const ::Kokkos::View& second_view, ValueType init_reduction_value) { namespace KE = ::Kokkos::Experimental; Impl::static_assert_is_admissible_to_kokkos_std_algorithms(first_view); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(second_view); return Impl::transform_reduce_default_functors_exespace_impl( "Kokkos::transform_reduce_default_functors_iterator_api", ex, KE::cbegin(first_view), KE::cend(first_view), KE::cbegin(second_view), std::move(init_reduction_value)); } template ::value, int> = 0> ValueType transform_reduce( const std::string& label, const ExecutionSpace& ex, const ::Kokkos::View& first_view, const ::Kokkos::View& second_view, ValueType init_reduction_value) { namespace KE = ::Kokkos::Experimental; Impl::static_assert_is_admissible_to_kokkos_std_algorithms(first_view); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(second_view); return Impl::transform_reduce_default_functors_exespace_impl( label, ex, KE::cbegin(first_view), KE::cend(first_view), KE::cbegin(second_view), std::move(init_reduction_value)); } // // overload set2: // accepts a custom transform and joiner functor // // Note the std refers to the arg BinaryReductionOp // but in the Kokkos naming convention, it corresponds // to a "joiner" that knows how to join two values // NOTE: "joiner/transformer" need to be commutative. // https://en.cppreference.com/w/cpp/algorithm/transform_reduce // api accepting iterators template < typename ExecutionSpace, typename IteratorType1, typename IteratorType2, typename ValueType, typename BinaryJoinerType, typename BinaryTransform, std::enable_if_t<::Kokkos::is_execution_space::value, int> = 0> ValueType transform_reduce(const ExecutionSpace& ex, IteratorType1 first1, IteratorType1 last1, IteratorType2 first2, ValueType init_reduction_value, BinaryJoinerType joiner, BinaryTransform transformer) { static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); return Impl::transform_reduce_custom_functors_exespace_impl( "Kokkos::transform_reduce_custom_functors_iterator_api", ex, first1, last1, first2, std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } template < typename ExecutionSpace, typename IteratorType1, typename IteratorType2, typename ValueType, typename BinaryJoinerType, typename BinaryTransform, std::enable_if_t<::Kokkos::is_execution_space::value, int> = 0> ValueType transform_reduce(const std::string& label, const ExecutionSpace& ex, IteratorType1 first1, IteratorType1 last1, IteratorType2 first2, ValueType init_reduction_value, BinaryJoinerType joiner, BinaryTransform transformer) { static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); return Impl::transform_reduce_custom_functors_exespace_impl( label, ex, first1, last1, first2, std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } // accepting views template ::value, int> = 0> ValueType transform_reduce( const ExecutionSpace& ex, const ::Kokkos::View& first_view, const ::Kokkos::View& second_view, ValueType init_reduction_value, BinaryJoinerType joiner, BinaryTransform transformer) { namespace KE = ::Kokkos::Experimental; static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(first_view); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(second_view); return Impl::transform_reduce_custom_functors_exespace_impl( "Kokkos::transform_reduce_custom_functors_view_api", ex, KE::cbegin(first_view), KE::cend(first_view), KE::cbegin(second_view), std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } template ::value, int> = 0> ValueType transform_reduce( const std::string& label, const ExecutionSpace& ex, const ::Kokkos::View& first_view, const ::Kokkos::View& second_view, ValueType init_reduction_value, BinaryJoinerType joiner, BinaryTransform transformer) { namespace KE = ::Kokkos::Experimental; static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(first_view); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(second_view); return Impl::transform_reduce_custom_functors_exespace_impl( label, ex, KE::cbegin(first_view), KE::cend(first_view), KE::cbegin(second_view), std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } // // overload set3: // // accepting iterators template ::value && is_execution_space::value, int> = 0> ValueType transform_reduce(const ExecutionSpace& ex, IteratorType first1, IteratorType last1, ValueType init_reduction_value, BinaryJoinerType joiner, UnaryTransform transformer) { static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); return Impl::transform_reduce_custom_functors_exespace_impl( "Kokkos::transform_reduce_custom_functors_iterator_api", ex, first1, last1, std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } template ::value && is_execution_space::value, int> = 0> ValueType transform_reduce(const std::string& label, const ExecutionSpace& ex, IteratorType first1, IteratorType last1, ValueType init_reduction_value, BinaryJoinerType joiner, UnaryTransform transformer) { static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); return Impl::transform_reduce_custom_functors_exespace_impl( label, ex, first1, last1, std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } // accepting views template < typename ExecutionSpace, typename DataType, typename... Properties, typename ValueType, typename BinaryJoinerType, typename UnaryTransform, std::enable_if_t<::Kokkos::is_execution_space::value, int> = 0> ValueType transform_reduce(const ExecutionSpace& ex, const ::Kokkos::View& view, ValueType init_reduction_value, BinaryJoinerType joiner, UnaryTransform transformer) { namespace KE = ::Kokkos::Experimental; static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(view); return Impl::transform_reduce_custom_functors_exespace_impl( "Kokkos::transform_reduce_custom_functors_view_api", ex, KE::cbegin(view), KE::cend(view), std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } template < typename ExecutionSpace, typename DataType, typename... Properties, typename ValueType, typename BinaryJoinerType, typename UnaryTransform, std::enable_if_t<::Kokkos::is_execution_space::value, int> = 0> ValueType transform_reduce(const std::string& label, const ExecutionSpace& ex, const ::Kokkos::View& view, ValueType init_reduction_value, BinaryJoinerType joiner, UnaryTransform transformer) { namespace KE = ::Kokkos::Experimental; static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(view); return Impl::transform_reduce_custom_functors_exespace_impl( label, ex, KE::cbegin(view), KE::cend(view), std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } // // overload set accepting a team handle // Note: for now omit the overloads accepting a label // since they cause issues on device because of the string allocation. // // ---------------------------- // overload set1: // no custom functors passed, so equivalent to // transform_reduce(first1, last1, first2, init, plus<>(), multiplies<>()); // ---------------------------- template < typename TeamHandleType, typename IteratorType1, typename IteratorType2, typename ValueType, std::enable_if_t<::Kokkos::is_team_handle::value, int> = 0> KOKKOS_FUNCTION ValueType transform_reduce(const TeamHandleType& teamHandle, IteratorType1 first1, IteratorType1 last1, IteratorType2 first2, ValueType init_reduction_value) { return Impl::transform_reduce_default_functors_team_impl( teamHandle, first1, last1, first2, std::move(init_reduction_value)); } // overload1 accepting views template < typename TeamHandleType, typename DataType1, typename... Properties1, typename DataType2, typename... Properties2, typename ValueType, std::enable_if_t<::Kokkos::is_team_handle::value, int> = 0> KOKKOS_FUNCTION ValueType transform_reduce(const TeamHandleType& teamHandle, const ::Kokkos::View& first_view, const ::Kokkos::View& second_view, ValueType init_reduction_value) { namespace KE = ::Kokkos::Experimental; Impl::static_assert_is_admissible_to_kokkos_std_algorithms(first_view); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(second_view); return Impl::transform_reduce_default_functors_team_impl( teamHandle, KE::cbegin(first_view), KE::cend(first_view), KE::cbegin(second_view), std::move(init_reduction_value)); } // // overload set2: // accepts a custom transform and joiner functor // // Note the std refers to the arg BinaryReductionOp // but in the Kokkos naming convention, it corresponds // to a "joiner" that knows how to join two values // NOTE: "joiner/transformer" need to be commutative. // https://en.cppreference.com/w/cpp/algorithm/transform_reduce // api accepting iterators template < typename TeamHandleType, typename IteratorType1, typename IteratorType2, typename ValueType, typename BinaryJoinerType, typename BinaryTransform, std::enable_if_t<::Kokkos::is_team_handle::value, int> = 0> KOKKOS_FUNCTION ValueType transform_reduce( const TeamHandleType& teamHandle, IteratorType1 first1, IteratorType1 last1, IteratorType2 first2, ValueType init_reduction_value, BinaryJoinerType joiner, BinaryTransform transformer) { static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); return Impl::transform_reduce_custom_functors_team_impl( teamHandle, first1, last1, first2, std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } // accepting views template < typename TeamHandleType, typename DataType1, typename... Properties1, typename DataType2, typename... Properties2, typename ValueType, typename BinaryJoinerType, typename BinaryTransform, std::enable_if_t<::Kokkos::is_team_handle::value, int> = 0> KOKKOS_FUNCTION ValueType transform_reduce(const TeamHandleType& teamHandle, const ::Kokkos::View& first_view, const ::Kokkos::View& second_view, ValueType init_reduction_value, BinaryJoinerType joiner, BinaryTransform transformer) { namespace KE = ::Kokkos::Experimental; static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(first_view); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(second_view); return Impl::transform_reduce_custom_functors_team_impl( teamHandle, KE::cbegin(first_view), KE::cend(first_view), KE::cbegin(second_view), std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } // // overload set3: // // accepting iterators template ::value && is_team_handle::value, int> = 0> KOKKOS_FUNCTION ValueType transform_reduce(const TeamHandleType& teamHandle, IteratorType first1, IteratorType last1, ValueType init_reduction_value, BinaryJoinerType joiner, UnaryTransform transformer) { static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); return Impl::transform_reduce_custom_functors_team_impl( teamHandle, first1, last1, std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } // accepting views template < typename TeamHandleType, typename DataType, typename... Properties, typename ValueType, typename BinaryJoinerType, typename UnaryTransform, std::enable_if_t<::Kokkos::is_team_handle::value, int> = 0> KOKKOS_FUNCTION ValueType transform_reduce(const TeamHandleType& teamHandle, const ::Kokkos::View& view, ValueType init_reduction_value, BinaryJoinerType joiner, UnaryTransform transformer) { namespace KE = ::Kokkos::Experimental; static_assert(std::is_move_constructible::value, "ValueType must be move constructible."); Impl::static_assert_is_admissible_to_kokkos_std_algorithms(view); return Impl::transform_reduce_custom_functors_team_impl( teamHandle, KE::cbegin(view), KE::cend(view), std::move(init_reduction_value), std::move(joiner), std::move(transformer)); } } // namespace Experimental } // namespace Kokkos #endif