//@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 #include namespace Test { namespace stdalgos { namespace TeamAdjacentFind { namespace KE = Kokkos::Experimental; template struct IsEqualFunctor { KOKKOS_INLINE_FUNCTION constexpr bool operator()(const ValueType& lhs, const ValueType& rhs) const { return lhs == rhs; } }; template struct TestFunctorA { DataViewType m_dataView; DistancesViewType m_distancesView; IntraTeamSentinelView m_intraTeamSentinelView; int m_apiPick; BinaryPredType m_binaryPred; TestFunctorA(const DataViewType dataView, const DistancesViewType distancesView, const IntraTeamSentinelView intraTeamSentinelView, int apiPick, BinaryPredType binaryPred) : m_dataView(dataView), m_distancesView(distancesView), m_intraTeamSentinelView(intraTeamSentinelView), m_apiPick(apiPick), m_binaryPred(binaryPred) {} template KOKKOS_INLINE_FUNCTION void operator()(const MemberType& member) const { const auto myRowIndex = member.league_rank(); auto myRowViewFrom = Kokkos::subview(m_dataView, myRowIndex, Kokkos::ALL()); ptrdiff_t resultDist = 0; switch (m_apiPick) { case 0: { const auto it = KE::adjacent_find(member, KE::cbegin(myRowViewFrom), KE::cend(myRowViewFrom)); resultDist = KE::distance(KE::cbegin(myRowViewFrom), it); Kokkos::single(Kokkos::PerTeam(member), [=, *this]() { m_distancesView(myRowIndex) = resultDist; }); break; } case 1: { const auto it = KE::adjacent_find(member, myRowViewFrom); resultDist = KE::distance(KE::begin(myRowViewFrom), it); Kokkos::single(Kokkos::PerTeam(member), [=, *this]() { m_distancesView(myRowIndex) = resultDist; }); break; } case 2: { const auto it = KE::adjacent_find(member, KE::cbegin(myRowViewFrom), KE::cend(myRowViewFrom), m_binaryPred); resultDist = KE::distance(KE::cbegin(myRowViewFrom), it); Kokkos::single(Kokkos::PerTeam(member), [=, *this]() { m_distancesView(myRowIndex) = resultDist; }); break; } case 3: { const auto it = KE::adjacent_find(member, myRowViewFrom, m_binaryPred); resultDist = KE::distance(KE::begin(myRowViewFrom), it); Kokkos::single(Kokkos::PerTeam(member), [=, *this]() { m_distancesView(myRowIndex) = resultDist; }); break; } } // store result of checking if all members have their local // values matching the one stored in m_distancesView member.team_barrier(); const bool intraTeamCheck = team_members_have_matching_result( member, resultDist, m_distancesView(myRowIndex)); Kokkos::single(Kokkos::PerTeam(member), [=, *this]() { m_intraTeamSentinelView(myRowIndex) = intraTeamCheck; }); } }; template void test_A(const bool ensureAdjacentFindCanFind, std::size_t numTeams, std::size_t numCols, int apiId) { /* description: use a rank-2 view randomly filled with values, and run a team-level adjacent_find */ // ----------------------------------------------- // prepare data // ----------------------------------------------- // create a view in the memory space associated with default exespace // with as many rows as the number of teams and fill it with random // values from an arbitrary range. constexpr ValueType lowerBound = 5; constexpr ValueType upperBound = 523; const auto bounds = make_bounds(lowerBound, upperBound); auto [dataView, dataViewBeforeOp_h] = create_random_view_and_host_clone( LayoutTag{}, numTeams, numCols, bounds, "dataView"); // If ensureAdjacentFindCanFind == true ensure there are two consecutive equal // elements in each row // dataView might not deep copyable (e.g. strided layout) so to prepare it // correctly, we make a new view that is for sure deep copyable, modify it on // the host, deep copy to device and then launch a kernel to copy to dataView auto dataView_dc = create_deep_copyable_compatible_view_with_same_extent(dataView); auto dataView_dc_h = create_mirror_view(Kokkos::HostSpace(), dataView_dc); if (ensureAdjacentFindCanFind && numCols > 1) { for (std::size_t i = 0; i < numTeams; ++i) { const auto j = numCols / 2; dataView_dc_h(i, j - 1) = dataView_dc_h(i, j); } } // copy to dataView_dc and then to dataView Kokkos::deep_copy(dataView_dc, dataView_dc_h); CopyFunctorRank2 cpFun(dataView_dc, dataView); Kokkos::parallel_for("copy", dataView.extent(0) * dataView.extent(1), cpFun); // ----------------------------------------------- // launch kokkos kernel // ----------------------------------------------- using space_t = Kokkos::DefaultExecutionSpace; Kokkos::TeamPolicy policy(numTeams, Kokkos::AUTO()); // adjacent_find returns an iterator so to verify that it is correct // each team stores the distance of the returned iterator from the beginning // of the interval that team operates on and then we check that these // distances match the std result Kokkos::View distancesView("distancesView", numTeams); // sentinel to check if all members of the team compute the same result Kokkos::View intraTeamSentinelView("intraTeamSameResult", numTeams); // use CTAD for functor IsEqualFunctor binaryPred; TestFunctorA fnc(dataView, distancesView, intraTeamSentinelView, apiId, binaryPred); Kokkos::parallel_for(policy, fnc); // ----------------------------------------------- // run cpp-std kernel and check // ----------------------------------------------- auto distancesView_h = create_host_space_copy(distancesView); auto intraTeamSentinelView_h = create_host_space_copy(intraTeamSentinelView); for (std::size_t i = 0; i < dataView.extent(0); ++i) { auto rowFrom = Kokkos::subview(dataView_dc_h, i, Kokkos::ALL()); const auto rowFromBegin = KE::cbegin(rowFrom); const auto rowFromEnd = KE::cend(rowFrom); const std::size_t beginEndDist = KE::distance(rowFromBegin, rowFromEnd); ASSERT_TRUE(intraTeamSentinelView_h(i)); switch (apiId) { case 0: case 1: { const auto it = std::adjacent_find(rowFromBegin, rowFromEnd); const std::size_t stdDistance = KE::distance(rowFromBegin, it); ASSERT_EQ(stdDistance, distancesView_h(i)); if (numCols == 1) { ASSERT_EQ(distancesView_h(i), beginEndDist); } else if (ensureAdjacentFindCanFind) { EXPECT_NE(distancesView_h(i), beginEndDist); } break; } case 2: case 3: { const auto it = std::adjacent_find(rowFromBegin, rowFromEnd, binaryPred); const std::size_t stdDistance = KE::distance(rowFromBegin, it); ASSERT_EQ(stdDistance, distancesView_h(i)); if (numCols == 1) { ASSERT_EQ(distancesView_h(i), beginEndDist); } else if (ensureAdjacentFindCanFind) { EXPECT_NE(distancesView_h(i), beginEndDist); } break; } } } } template void run_all_scenarios(const bool ensureAdjacentFindCanFind) { for (int numTeams : teamSizesToTest) { for (const auto& numCols : {1, 2, 13, 101, 1444, 8153}) { for (int apiId : {0, 1, 2, 3}) { test_A(ensureAdjacentFindCanFind, numTeams, numCols, apiId); } } } } TEST(std_algorithms_adjacent_find_team_test, two_consecutive_equal_elements_exist) { constexpr bool ensureAdjacentFindCanFind = true; run_all_scenarios(ensureAdjacentFindCanFind); run_all_scenarios(ensureAdjacentFindCanFind); run_all_scenarios(ensureAdjacentFindCanFind); } TEST(std_algorithms_adjacent_find_team_test, two_consecutive_equal_elements_might_exist) { constexpr bool ensureAdjacentFindCanFind = false; run_all_scenarios(ensureAdjacentFindCanFind); run_all_scenarios(ensureAdjacentFindCanFind); run_all_scenarios(ensureAdjacentFindCanFind); } } // namespace TeamAdjacentFind } // namespace stdalgos } // namespace Test