summaryrefslogtreecommitdiffstats
path: root/third_party/highway/hwy/contrib/sort/vqsort.h
blob: 95c140d1403c3bb2fc01f9c79fac9ae5fe44b8cc (plain)
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
// Copyright 2022 Google LLC
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Interface to vectorized quicksort with dynamic dispatch.
// Blog post: https://tinyurl.com/vqsort-blog
// Paper with measurements: https://arxiv.org/abs/2205.05982
//
// To ensure the overhead of using wide vectors (e.g. AVX2 or AVX-512) is
// worthwhile, we recommend using this code for sorting arrays whose size is at
// least 512 KiB.

#ifndef HIGHWAY_HWY_CONTRIB_SORT_VQSORT_H_
#define HIGHWAY_HWY_CONTRIB_SORT_VQSORT_H_

#include "hwy/base.h"

namespace hwy {

// Tag arguments that determine the sort order.
struct SortAscending {
  constexpr bool IsAscending() const { return true; }
};
struct SortDescending {
  constexpr bool IsAscending() const { return false; }
};

// Vectorized Quicksort: sorts keys[0, n). Dispatches to the best available
// instruction set and does not allocate memory.
// Uses about 1.2 KiB stack plus an internal 3-word TLS cache for random state.
HWY_CONTRIB_DLLEXPORT void VQSort(uint16_t* HWY_RESTRICT keys, size_t n,
                                  SortAscending);
HWY_CONTRIB_DLLEXPORT void VQSort(uint16_t* HWY_RESTRICT keys, size_t n,
                                  SortDescending);
HWY_CONTRIB_DLLEXPORT void VQSort(uint32_t* HWY_RESTRICT keys, size_t n,
                                  SortAscending);
HWY_CONTRIB_DLLEXPORT void VQSort(uint32_t* HWY_RESTRICT keys, size_t n,
                                  SortDescending);
HWY_CONTRIB_DLLEXPORT void VQSort(uint64_t* HWY_RESTRICT keys, size_t n,
                                  SortAscending);
HWY_CONTRIB_DLLEXPORT void VQSort(uint64_t* HWY_RESTRICT keys, size_t n,
                                  SortDescending);
HWY_CONTRIB_DLLEXPORT void VQSort(int16_t* HWY_RESTRICT keys, size_t n,
                                  SortAscending);
HWY_CONTRIB_DLLEXPORT void VQSort(int16_t* HWY_RESTRICT keys, size_t n,
                                  SortDescending);
HWY_CONTRIB_DLLEXPORT void VQSort(int32_t* HWY_RESTRICT keys, size_t n,
                                  SortAscending);
HWY_CONTRIB_DLLEXPORT void VQSort(int32_t* HWY_RESTRICT keys, size_t n,
                                  SortDescending);
HWY_CONTRIB_DLLEXPORT void VQSort(int64_t* HWY_RESTRICT keys, size_t n,
                                  SortAscending);
HWY_CONTRIB_DLLEXPORT void VQSort(int64_t* HWY_RESTRICT keys, size_t n,
                                  SortDescending);
HWY_CONTRIB_DLLEXPORT void VQSort(float* HWY_RESTRICT keys, size_t n,
                                  SortAscending);
HWY_CONTRIB_DLLEXPORT void VQSort(float* HWY_RESTRICT keys, size_t n,
                                  SortDescending);
HWY_CONTRIB_DLLEXPORT void VQSort(double* HWY_RESTRICT keys, size_t n,
                                  SortAscending);
HWY_CONTRIB_DLLEXPORT void VQSort(double* HWY_RESTRICT keys, size_t n,
                                  SortDescending);
HWY_CONTRIB_DLLEXPORT void VQSort(uint128_t* HWY_RESTRICT keys, size_t n,
                                  SortAscending);
HWY_CONTRIB_DLLEXPORT void VQSort(uint128_t* HWY_RESTRICT keys, size_t n,
                                  SortDescending);
HWY_CONTRIB_DLLEXPORT void VQSort(K64V64* HWY_RESTRICT keys, size_t n,
                                  SortAscending);
HWY_CONTRIB_DLLEXPORT void VQSort(K64V64* HWY_RESTRICT keys, size_t n,
                                  SortDescending);
HWY_CONTRIB_DLLEXPORT void VQSort(K32V32* HWY_RESTRICT keys, size_t n,
                                  SortAscending);
HWY_CONTRIB_DLLEXPORT void VQSort(K32V32* HWY_RESTRICT keys, size_t n,
                                  SortDescending);

// User-level caching is no longer required, so this class is no longer
// beneficial. We recommend using the simpler VQSort() interface instead, and
// retain this class only for compatibility. It now just calls VQSort.
class HWY_CONTRIB_DLLEXPORT Sorter {
 public:
  Sorter() {}
  ~Sorter() {}

  // Move-only
  Sorter(const Sorter&) = delete;
  Sorter& operator=(const Sorter&) = delete;
  Sorter(Sorter&& /*other*/) {}
  Sorter& operator=(Sorter&& /*other*/) { return *this; }

  void operator()(uint16_t* HWY_RESTRICT keys, size_t n,
                  SortAscending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(uint16_t* HWY_RESTRICT keys, size_t n,
                  SortDescending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(uint32_t* HWY_RESTRICT keys, size_t n,
                  SortAscending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(uint32_t* HWY_RESTRICT keys, size_t n,
                  SortDescending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(uint64_t* HWY_RESTRICT keys, size_t n,
                  SortAscending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(uint64_t* HWY_RESTRICT keys, size_t n,
                  SortDescending tag) const {
    VQSort(keys, n, tag);
  }

  void operator()(int16_t* HWY_RESTRICT keys, size_t n,
                  SortAscending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(int16_t* HWY_RESTRICT keys, size_t n,
                  SortDescending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(int32_t* HWY_RESTRICT keys, size_t n,
                  SortAscending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(int32_t* HWY_RESTRICT keys, size_t n,
                  SortDescending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(int64_t* HWY_RESTRICT keys, size_t n,
                  SortAscending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(int64_t* HWY_RESTRICT keys, size_t n,
                  SortDescending tag) const {
    VQSort(keys, n, tag);
  }

  void operator()(float* HWY_RESTRICT keys, size_t n, SortAscending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(float* HWY_RESTRICT keys, size_t n,
                  SortDescending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(double* HWY_RESTRICT keys, size_t n,
                  SortAscending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(double* HWY_RESTRICT keys, size_t n,
                  SortDescending tag) const {
    VQSort(keys, n, tag);
  }

  void operator()(uint128_t* HWY_RESTRICT keys, size_t n,
                  SortAscending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(uint128_t* HWY_RESTRICT keys, size_t n,
                  SortDescending tag) const {
    VQSort(keys, n, tag);
  }

  void operator()(K64V64* HWY_RESTRICT keys, size_t n,
                  SortAscending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(K64V64* HWY_RESTRICT keys, size_t n,
                  SortDescending tag) const {
    VQSort(keys, n, tag);
  }

  void operator()(K32V32* HWY_RESTRICT keys, size_t n,
                  SortAscending tag) const {
    VQSort(keys, n, tag);
  }
  void operator()(K32V32* HWY_RESTRICT keys, size_t n,
                  SortDescending tag) const {
    VQSort(keys, n, tag);
  }

  // Unused
  static void Fill24Bytes(const void*, size_t, void*) {}
  static bool HaveFloat64() { return false; }

 private:
  void Delete() {}

  template <typename T>
  T* Get() const {
    return nullptr;
  }

#if HWY_COMPILER_CLANG
  HWY_DIAGNOSTICS(push)
  HWY_DIAGNOSTICS_OFF(disable : 4700, ignored "-Wunused-private-field")
#endif
  void* unused_ = nullptr;
#if HWY_COMPILER_CLANG
  HWY_DIAGNOSTICS(pop)
#endif
};

// Internal use only
HWY_CONTRIB_DLLEXPORT uint64_t* GetGeneratorState();

}  // namespace hwy

#endif  // HIGHWAY_HWY_CONTRIB_SORT_VQSORT_H_