1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
//@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_ALGORITHMS_UNITTESTS_TEST_SORT_CUSTOM_COMP_HPP
#define KOKKOS_ALGORITHMS_UNITTESTS_TEST_SORT_CUSTOM_COMP_HPP
#include <gtest/gtest.h>
#include <Kokkos_Core.hpp>
#include <Kokkos_Macros.hpp>
#ifdef KOKKOS_ENABLE_EXPERIMENTAL_CXX20_MODULES
import kokkos.random;
import kokkos.sort;
#else
#include <Kokkos_Random.hpp>
#include <Kokkos_Sort.hpp>
#endif
#include <TestStdAlgorithmsCommon.hpp>
#if defined(KOKKOS_ENABLE_ONEDPL)
#define KOKKOS_IMPL_ONEDPL_VERSION \
ONEDPL_VERSION_MAJOR * 10000 + ONEDPL_VERSION_MINOR * 100 + \
ONEDPL_VERSION_PATCH
#define KOKKOS_IMPL_ONEDPL_VERSION_GREATER_EQUAL(MAJOR, MINOR, PATCH) \
(KOKKOS_IMPL_ONEDPL_VERSION >= ((MAJOR)*10000 + (MINOR)*100 + (PATCH)))
#endif
#ifndef KOKKOS_IMPL_ONEDPL_VERSION_GREATER_EQUAL
#define KOKKOS_IMPL_ONEDPL_VERSION_GREATER_EQUAL(MAJOR, MINOR, PATH) 0
#endif
namespace {
namespace SortWithComp {
template <class ExecutionSpace, class LayoutTagType, class ValueType>
auto create_random_view_and_host_clone(
LayoutTagType LayoutTag, std::size_t n,
Kokkos::pair<ValueType, ValueType> bounds, const std::string& label,
std::size_t seedIn = 12371) {
using namespace ::Test::stdalgos;
using mem_space = typename ExecutionSpace::memory_space;
auto dataView = create_view<ValueType, mem_space>(LayoutTag, n, label);
// dataView might not be deep copyable (e.g. strided layout) so to
// randomize it, 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);
// randomly fill the view
Kokkos::Random_XorShift64_Pool<Kokkos::DefaultHostExecutionSpace> pool(
seedIn);
Kokkos::fill_random(dataView_dc_h, pool, bounds.first, bounds.second);
// copy to dataView_dc and then to dataView
Kokkos::deep_copy(dataView_dc, dataView_dc_h);
// use CTAD
CopyFunctor F1(dataView_dc, dataView);
Kokkos::RangePolicy<ExecutionSpace> policy(0, dataView.extent(0));
Kokkos::parallel_for("copy", policy, F1);
return std::make_pair(dataView, dataView_dc_h);
}
template <class T>
struct MyComp {
#if !defined(KOKKOS_ENABLE_ONEDPL) || \
KOKKOS_IMPL_ONEDPL_VERSION_GREATER_EQUAL(2022, 8, 0)
// Make sure that the comparator isn't device copyable, this caused problems
// with SYCL/oneDPL
Kokkos::View<T*> dummy;
#endif
KOKKOS_FUNCTION
bool operator()(T a, T b) const {
// we return a>b on purpose here, rather than doing a<b
return a > b;
}
};
// clang-format off
template <class ExecutionSpace, class Tag, class ValueType>
void run_all_scenarios(int api)
{
using comp_t = MyComp<ValueType>;
const std::vector<std::size_t> my_scenarios = {0, 1, 2, 9, 1003, 51513};
for (std::size_t N : my_scenarios)
{
auto [dataView, dataViewBeforeOp_h] = create_random_view_and_host_clone<ExecutionSpace>(
Tag{}, N, Kokkos::pair<ValueType, ValueType>{-1045, 565},
"dataView");
namespace KE = Kokkos::Experimental;
if (api == 0) {
Kokkos::sort(dataView, comp_t{});
std::sort(KE::begin(dataViewBeforeOp_h), KE::end(dataViewBeforeOp_h),
comp_t{});
}
else if (api == 1) {
auto exespace = ExecutionSpace();
Kokkos::sort(exespace, dataView, comp_t{});
std::sort(KE::begin(dataViewBeforeOp_h), KE::end(dataViewBeforeOp_h),
comp_t{});
exespace.fence();
}
auto dataView_h = Test::stdalgos::create_host_space_copy(dataView);
Test::stdalgos::compare_views(dataViewBeforeOp_h, dataView_h);
// To actually check that Kokkos::sort used the custom
// comparator MyComp, we should have a result in non-ascending order.
// We can verify this by running std::is_sorted and if that returns
// false, then it means everything ran as expected.
// Note: std::is_sorted returns true for ranges of length one,
// so this check makes sense only when N >= 2.
if (N >= 2){
ASSERT_FALSE(std::is_sorted( KE::cbegin(dataView_h), KE::cend(dataView_h)));
}
}
}
TEST(TEST_CATEGORY, SortWithCustomComparator) {
using ExeSpace = TEST_EXECSPACE;
using namespace ::Test::stdalgos;
for (int api = 0; api < 2; api++) {
run_all_scenarios<ExeSpace, DynamicTag, int>(api);
run_all_scenarios<ExeSpace, DynamicTag, double>(api);
run_all_scenarios<ExeSpace, DynamicLayoutLeftTag, int>(api);
run_all_scenarios<ExeSpace, DynamicLayoutLeftTag, double>(api);
run_all_scenarios<ExeSpace, DynamicLayoutRightTag, int>(api);
run_all_scenarios<ExeSpace, DynamicLayoutRightTag, double>(api);
run_all_scenarios<ExeSpace, StridedThreeTag, int>(api);
run_all_scenarios<ExeSpace, StridedThreeTag, double>(api);
}
}
} // namespace SortWithComp
} // namespace anonym
#undef KOKKOS_IMPL_ONEDPL_VERSION
#undef KOKKOS_IMPL_ONEDPL_VERSION_GREATER_EQUAL
#endif
|
