usearch 2.7.2 → 2.7.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/.github/workflows/Dockerfile.libs +4 -6
  2. package/.github/workflows/prerelease.yml +4 -1
  3. package/.github/workflows/release.yml +8 -28
  4. package/.github/workflows/update_version.sh +1 -0
  5. package/CITATION.cff +2 -2
  6. package/CMakeLists.txt +1 -1
  7. package/Cargo.toml +1 -1
  8. package/README.md +4 -4
  9. package/binding.gyp +1 -1
  10. package/build.gradle +20 -5
  11. package/conanfile.py +1 -1
  12. package/csharp/nuget/nuget-package.props +1 -1
  13. package/docs/compilation.md +0 -2
  14. package/golang/README.md +0 -1
  15. package/include/usearch/index.hpp +1 -1
  16. package/include/usearch/index_plugins.hpp +119 -243
  17. package/javascript/lib.cpp +4 -3
  18. package/package.json +1 -1
  19. package/simsimd/.github/workflows/prerelease.yml +33 -58
  20. package/simsimd/.github/workflows/release.yml +22 -9
  21. package/simsimd/.github/workflows/update_version.sh +3 -1
  22. package/simsimd/.releaserc +9 -1
  23. package/simsimd/.vscode/launch.json +3 -0
  24. package/simsimd/.vscode/settings.json +15 -2
  25. package/simsimd/.vscode/tasks.json +2 -2
  26. package/simsimd/CMakeLists.txt +36 -55
  27. package/simsimd/README.md +163 -109
  28. package/simsimd/binding.gyp +18 -0
  29. package/simsimd/cpp/bench.cxx +187 -0
  30. package/simsimd/go.mod +3 -0
  31. package/simsimd/golang/bench_test.go +40 -0
  32. package/simsimd/golang/simsimd.go +47 -0
  33. package/simsimd/golang/unit_test.go +40 -0
  34. package/simsimd/include/simsimd/binary.h +186 -0
  35. package/simsimd/include/simsimd/probability.h +645 -0
  36. package/simsimd/include/simsimd/simsimd.h +335 -575
  37. package/simsimd/include/simsimd/spatial.h +924 -0
  38. package/simsimd/include/simsimd/types.h +196 -0
  39. package/simsimd/javascript/bench.js +117 -0
  40. package/simsimd/javascript/lib.c +102 -0
  41. package/simsimd/javascript/simsimd.js +45 -0
  42. package/simsimd/javascript/test.js +29 -0
  43. package/simsimd/package.json +31 -2
  44. package/simsimd/pyproject.toml +5 -6
  45. package/simsimd/python/bench.ipynb +187 -0
  46. package/simsimd/python/bench.py +268 -0
  47. package/simsimd/python/lib.c +453 -72
  48. package/simsimd/python/test.py +167 -35
  49. package/simsimd/setup.py +51 -8
  50. package/wasmer.toml +1 -1
  51. package/simsimd/bench.cxx +0 -137
  52. package/simsimd/include/simsimd/simsimd_bio.h +0 -54
  53. package/simsimd/include/simsimd/simsimd_chem.h +0 -167
  54. package/simsimd/include/simsimd/simsimd_text.h +0 -92
  55. package/simsimd/python/run.sh +0 -1
  56. package/simsimd/python/test.c +0 -109
@@ -0,0 +1,645 @@
1
+ /**
2
+ * @brief SIMD-accelerated Similarity Measures for Probability Distributions.
3
+ * @author Ash Vardanian
4
+ * @date October 20, 2023
5
+ *
6
+ * Contains:
7
+ * - Kullback-Leibler divergence
8
+ * - Jensen–Shannon divergence
9
+ *
10
+ * For datatypes:
11
+ * - 32-bit floating point numbers
12
+ * - 16-bit floating point numbers
13
+ *
14
+ * For hardware architectures:
15
+ * - Arm (NEON, SVE)
16
+ * - x86 (AVX2, AVX512)
17
+ *
18
+ * x86 intrinsics: https://www.intel.com/content/www/us/en/docs/intrinsics-guide/
19
+ * Arm intrinsics: https://developer.arm.com/architectures/instruction-sets/intrinsics/
20
+ */
21
+
22
+ #pragma once
23
+ #include "types.h"
24
+
25
+ #define SIMSIMD_MAKE_KL(name, input_type, accumulator_type, converter, epsilon) \
26
+ inline static simsimd_f32_t simsimd_##name##_##input_type##_kl( \
27
+ simsimd_##input_type##_t const* a, simsimd_##input_type##_t const* b, simsimd_size_t n) { \
28
+ simsimd_##accumulator_type##_t d = 0; \
29
+ for (simsimd_size_t i = 0; i != n; ++i) { \
30
+ simsimd_##accumulator_type##_t ai = converter(a[i]); \
31
+ simsimd_##accumulator_type##_t bi = converter(b[i]); \
32
+ d += ai * SIMSIMD_LOG((ai + epsilon) / (bi + epsilon)); \
33
+ } \
34
+ return d; \
35
+ }
36
+
37
+ #define SIMSIMD_MAKE_JS(name, input_type, accumulator_type, converter, epsilon) \
38
+ inline static simsimd_f32_t simsimd_##name##_##input_type##_js( \
39
+ simsimd_##input_type##_t const* a, simsimd_##input_type##_t const* b, simsimd_size_t n) { \
40
+ simsimd_##accumulator_type##_t d = 0; \
41
+ for (simsimd_size_t i = 0; i != n; ++i) { \
42
+ simsimd_##accumulator_type##_t ai = converter(a[i]); \
43
+ simsimd_##accumulator_type##_t bi = converter(b[i]); \
44
+ simsimd_##accumulator_type##_t mi = (ai + bi) / 2; \
45
+ d += ai * SIMSIMD_LOG((ai + epsilon) / (mi + epsilon)); \
46
+ d += bi * SIMSIMD_LOG((bi + epsilon) / (mi + epsilon)); \
47
+ } \
48
+ return d / 2; \
49
+ }
50
+
51
+ #ifdef __cplusplus
52
+ extern "C" {
53
+ #endif
54
+
55
+ SIMSIMD_MAKE_KL(serial, f32, f32, SIMSIMD_IDENTIFY, 1e-6) // simsimd_serial_f32_kl
56
+ SIMSIMD_MAKE_JS(serial, f32, f32, SIMSIMD_IDENTIFY, 1e-6) // simsimd_serial_f32_js
57
+
58
+ SIMSIMD_MAKE_KL(serial, f16, f32, SIMSIMD_UNCOMPRESS_F16, 1e-3) // simsimd_serial_f16_kl
59
+ SIMSIMD_MAKE_JS(serial, f16, f32, SIMSIMD_UNCOMPRESS_F16, 1e-3) // simsimd_serial_f16_js
60
+
61
+ SIMSIMD_MAKE_KL(accurate, f32, f64, SIMSIMD_IDENTIFY, 1e-6) // simsimd_accurate_f32_kl
62
+ SIMSIMD_MAKE_JS(accurate, f32, f64, SIMSIMD_IDENTIFY, 1e-6) // simsimd_accurate_f32_js
63
+
64
+ SIMSIMD_MAKE_KL(accurate, f16, f64, SIMSIMD_UNCOMPRESS_F16, 1e-6) // simsimd_accurate_f16_kl
65
+ SIMSIMD_MAKE_JS(accurate, f16, f64, SIMSIMD_UNCOMPRESS_F16, 1e-6) // simsimd_accurate_f16_js
66
+
67
+ #if SIMSIMD_TARGET_ARM
68
+ #if SIMSIMD_TARGET_ARM_NEON
69
+
70
+ /*
71
+ * @file arm_neon_f32.h
72
+ * @brief Arm NEON implementation of the most common similarity metrics for 32-bit floating point numbers.
73
+ * @author Ash Vardanian
74
+ *
75
+ * - Implements: Kullback-Leibler and Jensen–Shannon divergence.
76
+ * - Uses `f32` for storage and `f32` for accumulation.
77
+ * - Requires compiler capabilities: +simd.
78
+ */
79
+
80
+ __attribute__((target("+simd"))) //
81
+ inline static float32x4_t
82
+ simsimd_neon_f32_log(float32x4_t x) {
83
+ float32x4_t a = vmlaq_f32(vdupq_n_f32(-2.29561495781f), vdupq_n_f32(5.17591238022f), x);
84
+ float32x4_t b = vmlaq_f32(vdupq_n_f32(-5.68692588806f), vdupq_n_f32(0.844007015228f), x);
85
+ float32x4_t c = vmlaq_f32(vdupq_n_f32(-2.47071170807f), vdupq_n_f32(4.58445882797f), x);
86
+ float32x4_t d = vmlaq_f32(vdupq_n_f32(-0.165253549814f), vdupq_n_f32(0.0141278216615f), x);
87
+ float32x4_t x2 = vmulq_f32(x, x);
88
+ float32x4_t x4 = vmulq_f32(x2, x2);
89
+ return vmlaq_f32(vmlaq_f32(a, b, x2), vmlaq_f32(c, d, x2), x4);
90
+ }
91
+
92
+ __attribute__((target("+simd"))) //
93
+ inline static simsimd_f32_t
94
+ simsimd_neon_f32_kl(simsimd_f32_t const* a, simsimd_f32_t const* b, simsimd_size_t n) {
95
+ float32x4_t sum_vec = vdupq_n_f32(0);
96
+ simsimd_f32_t epsilon = 1e-6;
97
+ float32x4_t epsilon_vec = vdupq_n_f32(epsilon);
98
+ simsimd_size_t i = 0;
99
+ for (; i + 4 <= n; i += 4) {
100
+ float32x4_t a_vec = vld1q_f32(a + i);
101
+ float32x4_t b_vec = vld1q_f32(b + i);
102
+ float32x4_t ratio_vec = vdivq_f32(vaddq_f32(a_vec, epsilon_vec), vaddq_f32(b_vec, epsilon_vec));
103
+ float32x4_t log_ratio_vec = simsimd_neon_f32_log(ratio_vec);
104
+ float32x4_t prod_vec = vmulq_f32(a_vec, log_ratio_vec);
105
+ sum_vec = vaddq_f32(sum_vec, prod_vec);
106
+ }
107
+ simsimd_f32_t sum = vaddvq_f32(sum_vec);
108
+ for (; i < n; ++i)
109
+ sum += a[i] * SIMSIMD_LOG((a[i] + epsilon) / (b[i] + epsilon));
110
+ return sum;
111
+ }
112
+
113
+ __attribute__((target("+simd"))) inline static simsimd_f32_t
114
+ simsimd_neon_f32_js(simsimd_f32_t const* a, simsimd_f32_t const* b, simsimd_size_t n) {
115
+ float32x4_t sum_vec = vdupq_n_f32(0);
116
+ simsimd_f32_t epsilon = 1e-6;
117
+ float32x4_t epsilon_vec = vdupq_n_f32(epsilon);
118
+ simsimd_size_t i = 0;
119
+ for (; i + 4 <= n; i += 4) {
120
+ float32x4_t a_vec = vld1q_f32(a + i);
121
+ float32x4_t b_vec = vld1q_f32(b + i);
122
+ float32x4_t m_vec = vaddq_f32(a_vec, b_vec); // M = P + Q
123
+ float32x4_t ratio_a_vec = vdivq_f32(vaddq_f32(a_vec, epsilon_vec), vaddq_f32(m_vec, epsilon_vec));
124
+ float32x4_t ratio_b_vec = vdivq_f32(vaddq_f32(b_vec, epsilon_vec), vaddq_f32(m_vec, epsilon_vec));
125
+ float32x4_t log_ratio_a_vec = simsimd_neon_f32_log(ratio_a_vec);
126
+ float32x4_t log_ratio_b_vec = simsimd_neon_f32_log(ratio_b_vec);
127
+ float32x4_t prod_a_vec = vmulq_f32(a_vec, log_ratio_a_vec);
128
+ float32x4_t prod_b_vec = vmulq_f32(b_vec, log_ratio_b_vec);
129
+ sum_vec = vaddq_f32(sum_vec, vaddq_f32(prod_a_vec, prod_b_vec));
130
+ }
131
+ simsimd_f32_t sum = vaddvq_f32(sum_vec);
132
+ for (; i < n; ++i) {
133
+ simsimd_f32_t mi = a[i] + b[i];
134
+ sum += a[i] * SIMSIMD_LOG((a[i] + epsilon) / (mi + epsilon));
135
+ sum += b[i] * SIMSIMD_LOG((b[i] + epsilon) / (mi + epsilon));
136
+ }
137
+ return sum / 2;
138
+ }
139
+
140
+ /*
141
+ * @file arm_neon_f16.h
142
+ * @brief Arm NEON implementation of the most common similarity metrics for 16-bit floating point numbers.
143
+ * @author Ash Vardanian
144
+ *
145
+ * - Implements: Kullback-Leibler and Jensen–Shannon divergence.
146
+ * - Uses `f16` for storage and `f32` for accumulation, as the 16-bit FMA may not always be available.
147
+ * - Requires compiler capabilities: +simd+fp16.
148
+ */
149
+
150
+ __attribute__((target("+simd+fp16"))) //
151
+ inline static simsimd_f32_t
152
+ simsimd_neon_f16_kl(simsimd_f16_t const* a, simsimd_f16_t const* b, simsimd_size_t n) {
153
+ float32x4_t sum_vec = vdupq_n_f32(0);
154
+ simsimd_f32_t epsilon = 1e-3;
155
+ float32x4_t epsilon_vec = vdupq_n_f32(epsilon);
156
+ simsimd_size_t i = 0;
157
+ for (; i + 4 <= n; i += 4) {
158
+ float32x4_t a_vec = vcvt_f32_f16(vld1_f16((float16_t const*)a + i));
159
+ float32x4_t b_vec = vcvt_f32_f16(vld1_f16((float16_t const*)b + i));
160
+ float32x4_t ratio_vec = vdivq_f32(vaddq_f32(a_vec, epsilon_vec), vaddq_f32(b_vec, epsilon_vec));
161
+ float32x4_t log_ratio_vec = simsimd_neon_f32_log(ratio_vec);
162
+ float32x4_t prod_vec = vmulq_f32(a_vec, log_ratio_vec);
163
+ sum_vec = vaddq_f32(sum_vec, prod_vec);
164
+ }
165
+ simsimd_f32_t sum = vaddvq_f32(sum_vec);
166
+ for (; i < n; ++i)
167
+ sum += SIMSIMD_UNCOMPRESS_F16(a[i]) *
168
+ SIMSIMD_LOG((SIMSIMD_UNCOMPRESS_F16(a[i]) + epsilon) / (SIMSIMD_UNCOMPRESS_F16(b[i]) + epsilon));
169
+ return sum;
170
+ }
171
+
172
+ __attribute__((target("+simd+fp16"))) //
173
+ inline static simsimd_f32_t
174
+ simsimd_neon_f16_js(simsimd_f16_t const* a, simsimd_f16_t const* b, simsimd_size_t n) {
175
+ float32x4_t sum_vec = vdupq_n_f32(0);
176
+ simsimd_f32_t epsilon = 1e-3;
177
+ float32x4_t epsilon_vec = vdupq_n_f32(epsilon);
178
+ simsimd_size_t i = 0;
179
+ for (; i + 4 <= n; i += 4) {
180
+ float32x4_t a_vec = vcvt_f32_f16(vld1_f16((float16_t const*)a + i));
181
+ float32x4_t b_vec = vcvt_f32_f16(vld1_f16((float16_t const*)b + i));
182
+ float32x4_t m_vec = vaddq_f32(a_vec, b_vec); // M = P + Q
183
+ float32x4_t ratio_a_vec = vdivq_f32(vaddq_f32(a_vec, epsilon_vec), vaddq_f32(m_vec, epsilon_vec));
184
+ float32x4_t ratio_b_vec = vdivq_f32(vaddq_f32(b_vec, epsilon_vec), vaddq_f32(m_vec, epsilon_vec));
185
+ float32x4_t log_ratio_a_vec = simsimd_neon_f32_log(ratio_a_vec);
186
+ float32x4_t log_ratio_b_vec = simsimd_neon_f32_log(ratio_b_vec);
187
+ float32x4_t prod_a_vec = vmulq_f32(a_vec, log_ratio_a_vec);
188
+ float32x4_t prod_b_vec = vmulq_f32(b_vec, log_ratio_b_vec);
189
+ sum_vec = vaddq_f32(sum_vec, vaddq_f32(prod_a_vec, prod_b_vec));
190
+ }
191
+ simsimd_f32_t sum = vaddvq_f32(sum_vec);
192
+ for (; i < n; ++i) {
193
+ simsimd_f32_t ai = SIMSIMD_UNCOMPRESS_F16(a[i]);
194
+ simsimd_f32_t bi = SIMSIMD_UNCOMPRESS_F16(b[i]);
195
+ simsimd_f32_t mi = ai + bi;
196
+ sum += a[i] * SIMSIMD_LOG((a[i] + epsilon) / (mi + epsilon));
197
+ sum += b[i] * SIMSIMD_LOG((b[i] + epsilon) / (mi + epsilon));
198
+ }
199
+ return sum / 2;
200
+ }
201
+
202
+ #endif // SIMSIMD_TARGET_ARM_NEON
203
+ #endif // SIMSIMD_TARGET_ARM
204
+
205
+ #if SIMSIMD_TARGET_X86 && 0
206
+ #if SIMSIMD_TARGET_X86_AVX2
207
+
208
+ /*
209
+ * @file x86_avx2_f16.h
210
+ * @brief x86 AVX2 implementation of the most common similarity metrics for 16-bit floating point numbers.
211
+ * @author Ash Vardanian
212
+ *
213
+ * - Implements: L2 squared, inner product, cosine similarity.
214
+ * - As AVX2 doesn't support masked loads of 16-bit words, implementations have a separate `for`-loop for tails.
215
+ * - Uses `f16` for both storage and `f32` for accumulation.
216
+ * - Requires compiler capabilities: avx2, f16c, fma.
217
+ */
218
+
219
+ __attribute__((target("avx2,f16c,fma"))) //
220
+ inline static simsimd_f32_t
221
+ simsimd_avx2_f16_kl(simsimd_f16_t const* a, simsimd_f16_t const* b, simsimd_size_t n) {
222
+ __m256 d2_vec = _mm256_set1_ps(0);
223
+ simsimd_size_t i = 0;
224
+ for (; i + 8 <= n; i += 8) {
225
+ __m256 a_vec = _mm256_cvtph_ps(_mm_loadu_si128((__m128i const*)(a + i)));
226
+ __m256 b_vec = _mm256_cvtph_ps(_mm_loadu_si128((__m128i const*)(b + i)));
227
+ __m256 d_vec = _mm256_sub_ps(a_vec, b_vec);
228
+ d2_vec = _mm256_fmadd_ps(d_vec, d_vec, d2_vec);
229
+ }
230
+
231
+ d2_vec = _mm256_add_ps(_mm256_permute2f128_ps(d2_vec, d2_vec, 1), d2_vec);
232
+ d2_vec = _mm256_hadd_ps(d2_vec, d2_vec);
233
+ d2_vec = _mm256_hadd_ps(d2_vec, d2_vec);
234
+
235
+ simsimd_f32_t result;
236
+ _mm_store_ss(&result, _mm256_castps256_ps128(d2_vec));
237
+
238
+ // Accumulate the tail:
239
+ for (; i < n; ++i) {
240
+ simsimd_f32_t n = SIMSIMD_UNCOMPRESS_F16(a[i]) - SIMSIMD_UNCOMPRESS_F16(b[i]);
241
+ result += n * n;
242
+ }
243
+ return result;
244
+ }
245
+
246
+ __attribute__((target("avx2,f16c,fma"))) //
247
+ inline static simsimd_f32_t
248
+ simsimd_avx2_f16_js(simsimd_f16_t const* a, simsimd_f16_t const* b, simsimd_size_t n) {
249
+ __m256 ab_vec = _mm256_set1_ps(0);
250
+ simsimd_size_t i = 0;
251
+ for (; i + 8 <= n; i += 8) {
252
+ __m256 a_vec = _mm256_cvtph_ps(_mm_loadu_si128((__m128i const*)(a + i)));
253
+ __m256 b_vec = _mm256_cvtph_ps(_mm_loadu_si128((__m128i const*)(b + i)));
254
+ ab_vec = _mm256_fmadd_ps(a_vec, b_vec, ab_vec);
255
+ }
256
+
257
+ ab_vec = _mm256_add_ps(_mm256_permute2f128_ps(ab_vec, ab_vec, 1), ab_vec);
258
+ ab_vec = _mm256_hadd_ps(ab_vec, ab_vec);
259
+ ab_vec = _mm256_hadd_ps(ab_vec, ab_vec);
260
+
261
+ simsimd_f32_t result;
262
+ _mm_store_ss(&result, _mm256_castps256_ps128(ab_vec));
263
+
264
+ // Accumulate the tail:
265
+ for (; i < n; ++i)
266
+ result += SIMSIMD_UNCOMPRESS_F16(a[i]) * SIMSIMD_UNCOMPRESS_F16(b[i]);
267
+ return 1 - result;
268
+ }
269
+ __attribute__((target("avx2,f16c,fma"))) //
270
+ inline static simsimd_f32_t
271
+ simsimd_avx2_f16_cos(simsimd_f16_t const* a, simsimd_f16_t const* b, simsimd_size_t n) {
272
+
273
+ __m256 ab_vec = _mm256_set1_ps(0), a2_vec = _mm256_set1_ps(0), b2_vec = _mm256_set1_ps(0);
274
+ simsimd_size_t i = 0;
275
+ for (; i + 8 <= n; i += 8) {
276
+ __m256 a_vec = _mm256_cvtph_ps(_mm_loadu_si128((__m128i const*)(a + i)));
277
+ __m256 b_vec = _mm256_cvtph_ps(_mm_loadu_si128((__m128i const*)(b + i)));
278
+ ab_vec = _mm256_fmadd_ps(a_vec, b_vec, ab_vec);
279
+ a2_vec = _mm256_fmadd_ps(a_vec, a_vec, a2_vec);
280
+ b2_vec = _mm256_fmadd_ps(b_vec, b_vec, b2_vec);
281
+ }
282
+
283
+ ab_vec = _mm256_add_ps(_mm256_permute2f128_ps(ab_vec, ab_vec, 1), ab_vec);
284
+ ab_vec = _mm256_hadd_ps(ab_vec, ab_vec);
285
+ ab_vec = _mm256_hadd_ps(ab_vec, ab_vec);
286
+
287
+ a2_vec = _mm256_add_ps(_mm256_permute2f128_ps(a2_vec, a2_vec, 1), a2_vec);
288
+ a2_vec = _mm256_hadd_ps(a2_vec, a2_vec);
289
+ a2_vec = _mm256_hadd_ps(a2_vec, a2_vec);
290
+
291
+ b2_vec = _mm256_add_ps(_mm256_permute2f128_ps(b2_vec, b2_vec, 1), b2_vec);
292
+ b2_vec = _mm256_hadd_ps(b2_vec, b2_vec);
293
+ b2_vec = _mm256_hadd_ps(b2_vec, b2_vec);
294
+
295
+ simsimd_f32_t ab, a2, b2;
296
+ _mm_store_ss(&ab, _mm256_castps256_ps128(ab_vec));
297
+ _mm_store_ss(&a2, _mm256_castps256_ps128(a2_vec));
298
+ _mm_store_ss(&b2, _mm256_castps256_ps128(b2_vec));
299
+
300
+ // Accumulate the tail:
301
+ for (; i < n; ++i) {
302
+ simsimd_f32_t ai = SIMSIMD_UNCOMPRESS_F16(a[i]), bi = SIMSIMD_UNCOMPRESS_F16(b[i]);
303
+ ab += ai * bi, a2 += ai * ai, b2 += bi * bi;
304
+ }
305
+
306
+ // Replace simsimd_approximate_inverse_square_root with `rsqrtss`
307
+ __m128 a2_sqrt_recjs = _mm_rsqrt_ss(_mm_set_ss((float)a2));
308
+ __m128 b2_sqrt_recjs = _mm_rsqrt_ss(_mm_set_ss((float)b2));
309
+ __m128 result = _mm_mul_ss(a2_sqrt_recjs, b2_sqrt_recjs); // Multjsly the recjsrocal square roots
310
+ result = _mm_mul_ss(result, _mm_set_ss((float)ab)); // Multjsly by ab
311
+ result = _mm_sub_ss(_mm_set_ss(1.0f), result); // Subtract from 1
312
+ return ab != 0 ? _mm_cvtss_f32(result) : 1; // Extract the final result
313
+ }
314
+
315
+ /*
316
+ * @file x86_avx2_i8.h
317
+ * @brief x86 AVX2 implementation of the most common similarity metrics for 8-bit signed integral numbers.
318
+ * @author Ash Vardanian
319
+ *
320
+ * - Implements: L2 squared, cosine similarity, inner product (same as cosine).
321
+ * - As AVX2 doesn't support masked loads of 16-bit words, implementations have a separate `for`-loop for tails.
322
+ * - Uses `i8` for storage, `i16` for multjslication, and `i32` for accumulation, if no better option is available.
323
+ * - Requires compiler capabilities: avx2.
324
+ */
325
+
326
+ __attribute__((target("avx2"))) //
327
+ inline static simsimd_f32_t
328
+ simsimd_avx2_i8_kl(simsimd_i8_t const* a, simsimd_i8_t const* b, simsimd_size_t n) {
329
+
330
+ __m256i d2_high_vec = _mm256_setzero_si256();
331
+ __m256i d2_low_vec = _mm256_setzero_si256();
332
+
333
+ simsimd_size_t i = 0;
334
+ for (; i + 32 <= n; i += 32) {
335
+ __m256i a_vec = _mm256_loadu_si256((__m256i const*)(a + i));
336
+ __m256i b_vec = _mm256_loadu_si256((__m256i const*)(b + i));
337
+
338
+ // Sign extend int8 to int16
339
+ __m256i a_low = _mm256_cvtepi8_epi16(_mm256_castsi256_si128(a_vec));
340
+ __m256i a_high = _mm256_cvtepi8_epi16(_mm256_extracti128_si256(a_vec, 1));
341
+ __m256i b_low = _mm256_cvtepi8_epi16(_mm256_castsi256_si128(b_vec));
342
+ __m256i b_high = _mm256_cvtepi8_epi16(_mm256_extracti128_si256(b_vec, 1));
343
+
344
+ // Subtract and multjsly
345
+ __m256i d_low = _mm256_sub_epi16(a_low, b_low);
346
+ __m256i d_high = _mm256_sub_epi16(a_high, b_high);
347
+ __m256i d2_low_part = _mm256_madd_epi16(d_low, d_low);
348
+ __m256i d2_high_part = _mm256_madd_epi16(d_high, d_high);
349
+
350
+ // Accumulate into int32 vectors
351
+ d2_low_vec = _mm256_add_epi32(d2_low_vec, d2_low_part);
352
+ d2_high_vec = _mm256_add_epi32(d2_high_vec, d2_high_part);
353
+ }
354
+
355
+ // Accumulate the 32-bit integers from `d2_high_vec` and `d2_low_vec`
356
+ __m256i d2_vec = _mm256_add_epi32(d2_low_vec, d2_high_vec);
357
+ __m128i d2_sum = _mm_add_epi32(_mm256_extracti128_si256(d2_vec, 0), _mm256_extracti128_si256(d2_vec, 1));
358
+ d2_sum = _mm_hadd_epi32(d2_sum, d2_sum);
359
+ d2_sum = _mm_hadd_epi32(d2_sum, d2_sum);
360
+ int d2 = _mm_extract_epi32(d2_sum, 0);
361
+
362
+ // Take care of the tail:
363
+ for (; i < n; ++i) {
364
+ int n = a[i] - b[i];
365
+ d2 += n * n;
366
+ }
367
+
368
+ return (simsimd_f32_t)d2;
369
+ }
370
+ __attribute__((target("avx2"))) //
371
+ inline static simsimd_f32_t
372
+ simsimd_avx2_i8_cos(simsimd_i8_t const* a, simsimd_i8_t const* b, simsimd_size_t n) {
373
+
374
+ __m256i ab_high_vec = _mm256_setzero_si256();
375
+ __m256i ab_low_vec = _mm256_setzero_si256();
376
+ __m256i a2_high_vec = _mm256_setzero_si256();
377
+ __m256i a2_low_vec = _mm256_setzero_si256();
378
+ __m256i b2_high_vec = _mm256_setzero_si256();
379
+ __m256i b2_low_vec = _mm256_setzero_si256();
380
+
381
+ simsimd_size_t i = 0;
382
+ for (; i + 32 <= n; i += 32) {
383
+ __m256i a_vec = _mm256_loadu_si256((__m256i const*)(a + i));
384
+ __m256i b_vec = _mm256_loadu_si256((__m256i const*)(b + i));
385
+
386
+ // Unpack int8 to int32
387
+ __m256i a_low = _mm256_cvtepi8_epi32(_mm256_castsi256_si128(a_vec));
388
+ __m256i a_high = _mm256_cvtepi8_epi32(_mm256_extracti128_si256(a_vec, 1));
389
+ __m256i b_low = _mm256_cvtepi8_epi32(_mm256_castsi256_si128(b_vec));
390
+ __m256i b_high = _mm256_cvtepi8_epi32(_mm256_extracti128_si256(b_vec, 1));
391
+
392
+ // Multjsly and accumulate
393
+ ab_low_vec = _mm256_add_epi32(ab_low_vec, _mm256_mullo_epi32(a_low, b_low));
394
+ ab_high_vec = _mm256_add_epi32(ab_high_vec, _mm256_mullo_epi32(a_high, b_high));
395
+ a2_low_vec = _mm256_add_epi32(a2_low_vec, _mm256_mullo_epi32(a_low, a_low));
396
+ a2_high_vec = _mm256_add_epi32(a2_high_vec, _mm256_mullo_epi32(a_high, a_high));
397
+ b2_low_vec = _mm256_add_epi32(b2_low_vec, _mm256_mullo_epi32(b_low, b_low));
398
+ b2_high_vec = _mm256_add_epi32(b2_high_vec, _mm256_mullo_epi32(b_high, b_high));
399
+ }
400
+
401
+ // Horizontal sum across the 256-bit register
402
+ __m256i ab_vec = _mm256_add_epi32(ab_low_vec, ab_high_vec);
403
+ __m128i ab_sum = _mm_add_epi32(_mm256_extracti128_si256(ab_vec, 0), _mm256_extracti128_si256(ab_vec, 1));
404
+ ab_sum = _mm_hadd_epi32(ab_sum, ab_sum);
405
+ ab_sum = _mm_hadd_epi32(ab_sum, ab_sum);
406
+
407
+ __m256i a2_vec = _mm256_add_epi32(a2_low_vec, a2_high_vec);
408
+ __m128i a2_sum = _mm_add_epi32(_mm256_extracti128_si256(a2_vec, 0), _mm256_extracti128_si256(a2_vec, 1));
409
+ a2_sum = _mm_hadd_epi32(a2_sum, a2_sum);
410
+ a2_sum = _mm_hadd_epi32(a2_sum, a2_sum);
411
+
412
+ __m256i b2_vec = _mm256_add_epi32(b2_low_vec, b2_high_vec);
413
+ __m128i b2_sum = _mm_add_epi32(_mm256_extracti128_si256(b2_vec, 0), _mm256_extracti128_si256(b2_vec, 1));
414
+ b2_sum = _mm_hadd_epi32(b2_sum, b2_sum);
415
+ b2_sum = _mm_hadd_epi32(b2_sum, b2_sum);
416
+
417
+ // Further reduce to a single sum for each vector
418
+ int ab = _mm_extract_epi32(ab_sum, 0);
419
+ int a2 = _mm_extract_epi32(a2_sum, 0);
420
+ int b2 = _mm_extract_epi32(b2_sum, 0);
421
+
422
+ // Take care of the tail:
423
+ for (; i < n; ++i) {
424
+ int ai = a[i], bi = b[i];
425
+ ab += ai * bi, a2 += ai * ai, b2 += bi * bi;
426
+ }
427
+
428
+ // Replace simsimd_approximate_inverse_square_root with `rsqrtss`
429
+ __m128 a2_sqrt_recjs = _mm_rsqrt_ss(_mm_set_ss((float)a2));
430
+ __m128 b2_sqrt_recjs = _mm_rsqrt_ss(_mm_set_ss((float)b2));
431
+ __m128 result = _mm_mul_ss(a2_sqrt_recjs, b2_sqrt_recjs); // Multjsly the recjsrocal square roots
432
+ result = _mm_mul_ss(result, _mm_set_ss((float)ab)); // Multjsly by ab
433
+ result = _mm_sub_ss(_mm_set_ss(1.0f), result); // Subtract from 1
434
+ return ab != 0 ? _mm_cvtss_f32(result) : 1; // Extract the final result
435
+ }
436
+
437
+ __attribute__((target("avx2"))) //
438
+ inline static simsimd_f32_t
439
+ simsimd_avx2_i8_js(simsimd_i8_t const* a, simsimd_i8_t const* b, simsimd_size_t n) {
440
+ return simsimd_avx2_i8_cos(a, b, n);
441
+ }
442
+
443
+ #endif // SIMSIMD_TARGET_X86_AVX2
444
+
445
+ #if SIMSIMD_TARGET_X86_AVX512
446
+
447
+ /*
448
+ * @file x86_avx512_f32.h
449
+ * @brief x86 AVX-512 implementation of the most common similarity metrics for 32-bit floating point numbers.
450
+ * @author Ash Vardanian
451
+ *
452
+ * - Implements: L2 squared, inner product, cosine similarity.
453
+ * - Uses `f32` for storage and `f32` for accumulation.
454
+ * - Requires compiler capabilities: avx512f, avx512vl.
455
+ */
456
+
457
+ __attribute__((target("avx512f,avx512vl"))) //
458
+ inline static simsimd_f32_t
459
+ simsimd_avx512_f32_kl(simsimd_f32_t const* a, simsimd_f32_t const* b, simsimd_size_t n) {
460
+ __m512 d2_vec = _mm512_set1_ps(0);
461
+ for (simsimd_size_t i = 0; i < n; i += 16) {
462
+ __mmask16 mask = n - i >= 16 ? 0xFFFF : ((1u << (n - i)) - 1u);
463
+ __m512 a_vec = _mm512_maskz_loadu_ps(mask, a + i);
464
+ __m512 b_vec = _mm512_maskz_loadu_ps(mask, b + i);
465
+ __m512 d_vec = _mm512_sub_ps(a_vec, b_vec);
466
+ d2_vec = _mm512_fmadd_ps(d_vec, d_vec, d2_vec);
467
+ }
468
+ return _mm512_reduce_add_ps(d2_vec);
469
+ }
470
+
471
+ __attribute__((target("avx512f,avx512vl"))) //
472
+ inline static simsimd_f32_t
473
+ simsimd_avx512_f32_js(simsimd_f32_t const* a, simsimd_f32_t const* b, simsimd_size_t n) {
474
+ __m512 ab_vec = _mm512_set1_ps(0);
475
+ for (simsimd_size_t i = 0; i < n; i += 16) {
476
+ __mmask16 mask = n - i >= 16 ? 0xFFFF : ((1u << (n - i)) - 1u);
477
+ __m512 a_vec = _mm512_maskz_loadu_ps(mask, a + i);
478
+ __m512 b_vec = _mm512_maskz_loadu_ps(mask, b + i);
479
+ ab_vec = _mm512_fmadd_ps(a_vec, b_vec, ab_vec);
480
+ }
481
+ return 1 - _mm512_reduce_add_ps(ab_vec);
482
+ }
483
+
484
+ __attribute__((target("avx512f,avx512vl"))) //
485
+ inline static simsimd_f32_t
486
+ simsimd_avx512_f32_cos(simsimd_f32_t const* a, simsimd_f32_t const* b, simsimd_size_t n) {
487
+ __m512 ab_vec = _mm512_set1_ps(0);
488
+ __m512 a2_vec = _mm512_set1_ps(0);
489
+ __m512 b2_vec = _mm512_set1_ps(0);
490
+
491
+ for (simsimd_size_t i = 0; i < n; i += 16) {
492
+ __mmask16 mask = n - i >= 16 ? 0xFFFF : ((1u << (n - i)) - 1u);
493
+ __m512 a_vec = _mm512_maskz_loadu_ps(mask, a + i);
494
+ __m512 b_vec = _mm512_maskz_loadu_ps(mask, b + i);
495
+ ab_vec = _mm512_fmadd_ps(a_vec, b_vec, ab_vec);
496
+ a2_vec = _mm512_fmadd_ps(a_vec, a_vec, a2_vec);
497
+ b2_vec = _mm512_fmadd_ps(b_vec, b_vec, b2_vec);
498
+ }
499
+
500
+ simsimd_f32_t ab = _mm512_reduce_add_ps(ab_vec);
501
+ simsimd_f32_t a2 = _mm512_reduce_add_ps(a2_vec);
502
+ simsimd_f32_t b2 = _mm512_reduce_add_ps(b2_vec);
503
+
504
+ __m128d a2_b2 = _mm_set_pd((double)a2, (double)b2);
505
+ __m128d rsqrts = _mm_mask_rsqrt14_pd(_mm_setzero_pd(), 0xFF, a2_b2);
506
+ double rsqrts_array[2];
507
+ _mm_storeu_pd(rsqrts_array, rsqrts);
508
+ return ab != 0 ? 1 - ab * rsqrts_array[0] * rsqrts_array[1] : 1;
509
+ }
510
+
511
+ /*
512
+ * @file x86_avx512_f16.h
513
+ * @brief x86 AVX-512 implementation of the most common similarity metrics for 16-bit floating point numbers.
514
+ * @author Ash Vardanian
515
+ *
516
+ * - Implements: L2 squared, inner product, cosine similarity.
517
+ * - Uses `_mm512_maskz_loadu_epi16` intrinsics to perform masked unaligned loads.
518
+ * - Uses `f16` for both storage and accumulation, assuming it's resolution is enough for average case.
519
+ * - Requires compiler capabilities: avx512fp16, avx512f, avx512vl.
520
+ */
521
+
522
+ __attribute__((target("avx512fp16,avx512vl,avx512f"))) //
523
+ inline static simsimd_f32_t
524
+ simsimd_avx512_f16_kl(simsimd_f16_t const* a, simsimd_f16_t const* b, simsimd_size_t n) {
525
+ __m512h d2_vec = _mm512_set1_ph(0);
526
+ for (simsimd_size_t i = 0; i < n; i += 32) {
527
+ __mmask32 mask = n - i >= 32 ? 0xFFFFFFFF : ((1u << (n - i)) - 1u);
528
+ __m512i a_vec = _mm512_maskz_loadu_epi16(mask, a + i);
529
+ __m512i b_vec = _mm512_maskz_loadu_epi16(mask, b + i);
530
+ __m512h d_vec = _mm512_sub_ph(_mm512_castsi512_ph(a_vec), _mm512_castsi512_ph(b_vec));
531
+ d2_vec = _mm512_fmadd_ph(d_vec, d_vec, d2_vec);
532
+ }
533
+ return _mm512_reduce_add_ph(d2_vec);
534
+ }
535
+
536
+ __attribute__((target("avx512fp16,avx512vl,avx512f"))) //
537
+ inline static simsimd_f32_t
538
+ simsimd_avx512_f16_js(simsimd_f16_t const* a, simsimd_f16_t const* b, simsimd_size_t n) {
539
+ __m512h ab_vec = _mm512_set1_ph(0);
540
+ simsimd_size_t i = 0;
541
+
542
+ for (simsimd_size_t i = 0; i < n; i += 32) {
543
+ __mmask32 mask = n - i >= 32 ? 0xFFFFFFFF : ((1u << (n - i)) - 1u);
544
+ __m512i a_vec = _mm512_maskz_loadu_epi16(mask, a + i);
545
+ __m512i b_vec = _mm512_maskz_loadu_epi16(mask, b + i);
546
+ ab_vec = _mm512_fmadd_ph(_mm512_castsi512_ph(a_vec), _mm512_castsi512_ph(b_vec), ab_vec);
547
+ }
548
+ return 1 - _mm512_reduce_add_ph(ab_vec);
549
+ }
550
+
551
+ __attribute__((target("avx512fp16,avx512vl,avx512f"))) //
552
+ inline static simsimd_f32_t
553
+ simsimd_avx512_f16_cos(simsimd_f16_t const* a, simsimd_f16_t const* b, simsimd_size_t n) {
554
+ __m512h ab_vec = _mm512_set1_ph(0);
555
+ __m512h a2_vec = _mm512_set1_ph(0);
556
+ __m512h b2_vec = _mm512_set1_ph(0);
557
+
558
+ for (simsimd_size_t i = 0; i < n; i += 32) {
559
+ __mmask32 mask = n - i >= 32 ? 0xFFFFFFFF : ((1u << (n - i)) - 1u);
560
+ __m512i a_vec = _mm512_maskz_loadu_epi16(mask, a + i);
561
+ __m512i b_vec = _mm512_maskz_loadu_epi16(mask, b + i);
562
+ ab_vec = _mm512_fmadd_ph(_mm512_castsi512_ph(a_vec), _mm512_castsi512_ph(b_vec), ab_vec);
563
+ a2_vec = _mm512_fmadd_ph(_mm512_castsi512_ph(a_vec), _mm512_castsi512_ph(a_vec), a2_vec);
564
+ b2_vec = _mm512_fmadd_ph(_mm512_castsi512_ph(b_vec), _mm512_castsi512_ph(b_vec), b2_vec);
565
+ }
566
+
567
+ simsimd_f32_t ab = _mm512_reduce_add_ph(ab_vec);
568
+ simsimd_f32_t a2 = _mm512_reduce_add_ph(a2_vec);
569
+ simsimd_f32_t b2 = _mm512_reduce_add_ph(b2_vec);
570
+
571
+ __m128d a2_b2 = _mm_set_pd((double)a2, (double)b2);
572
+ __m128d rsqrts = _mm_mask_rsqrt14_pd(_mm_setzero_pd(), 0xFF, a2_b2);
573
+ double rsqrts_array[2];
574
+ _mm_storeu_pd(rsqrts_array, rsqrts);
575
+ return ab != 0 ? 1 - ab * rsqrts_array[0] * rsqrts_array[1] : 1;
576
+ }
577
+
578
+ /*
579
+ * @file x86_avx512_i8.h
580
+ * @brief x86 AVX-512 implementation of the most common similarity metrics for 8-bit integers.
581
+ * @author Ash Vardanian
582
+ *
583
+ * - Implements: L2 squared, cosine similarity, inner product (same as cosine).
584
+ * - Uses `_mm512_maskz_loadu_epi16` intrinsics to perform masked unaligned loads.
585
+ * - Uses `i8` for storage, `i16` for multjslication, and `i32` for accumulation, if no better option is available.
586
+ * - Requires compiler capabilities: avx512f, avx512vl, avx512bw.
587
+ */
588
+
589
+ __attribute__((target("avx512vl,avx512f,avx512bw"))) //
590
+ inline static simsimd_f32_t
591
+ simsimd_avx512_i8_kl(simsimd_i8_t const* a, simsimd_i8_t const* b, simsimd_size_t n) {
592
+ __m512i d2_i32s_vec = _mm512_setzero_si512();
593
+
594
+ for (simsimd_size_t i = 0; i < n; i += 32) {
595
+ __mmask32 mask = n - i >= 32 ? 0xFFFFFFFF : ((1u << (n - i)) - 1u);
596
+ __m512i a_vec = _mm512_cvtepi8_epi16(_mm256_maskz_loadu_epi8(mask, a + i)); // Load 8-bit integers
597
+ __m512i b_vec = _mm512_cvtepi8_epi16(_mm256_maskz_loadu_epi8(mask, b + i)); // Load 8-bit integers
598
+ __m512i d_i16s_vec = _mm512_sub_epi16(a_vec, b_vec);
599
+ d2_i32s_vec = _mm512_add_epi32(d2_i32s_vec, _mm512_madd_epi16(d_i16s_vec, d_i16s_vec));
600
+ }
601
+
602
+ return _mm512_reduce_add_epi32(d2_i32s_vec);
603
+ }
604
+
605
+ __attribute__((target("avx512vl,avx512f,avx512bw"))) //
606
+ inline static simsimd_f32_t
607
+ simsimd_avx512_i8_cos(simsimd_i8_t const* a, simsimd_i8_t const* b, simsimd_size_t n) {
608
+ __m512i ab_i32s_vec = _mm512_setzero_si512();
609
+ __m512i a2_i32s_vec = _mm512_setzero_si512();
610
+ __m512i b2_i32s_vec = _mm512_setzero_si512();
611
+ simsimd_size_t i = 0;
612
+
613
+ for (simsimd_size_t i = 0; i < n; i += 32) {
614
+ __mmask32 mask = n - i >= 32 ? 0xFFFFFFFF : ((1u << (n - i)) - 1u);
615
+ __m512i a_vec = _mm512_cvtepi8_epi16(_mm256_maskz_loadu_epi8(mask, a + i)); // Load 8-bit integers
616
+ __m512i b_vec = _mm512_cvtepi8_epi16(_mm256_maskz_loadu_epi8(mask, b + i)); // Load 8-bit integers
617
+
618
+ ab_i32s_vec = _mm512_add_epi32(ab_i32s_vec, _mm512_madd_epi16(a_vec, b_vec));
619
+ a2_i32s_vec = _mm512_add_epi32(a2_i32s_vec, _mm512_madd_epi16(a_vec, a_vec));
620
+ b2_i32s_vec = _mm512_add_epi32(b2_i32s_vec, _mm512_madd_epi16(b_vec, b_vec));
621
+ }
622
+
623
+ int ab = _mm512_reduce_add_epi32(ab_i32s_vec);
624
+ int a2 = _mm512_reduce_add_epi32(a2_i32s_vec);
625
+ int b2 = _mm512_reduce_add_epi32(b2_i32s_vec);
626
+
627
+ __m128d a2_b2 = _mm_set_pd((double)a2, (double)b2);
628
+ __m128d rsqrts = _mm_mask_rsqrt14_pd(_mm_setzero_pd(), 0xFF, a2_b2);
629
+ double rsqrts_array[2];
630
+ _mm_storeu_pd(rsqrts_array, rsqrts);
631
+ return ab != 0 ? 1 - ab * rsqrts_array[0] * rsqrts_array[1] : 1;
632
+ }
633
+
634
+ __attribute__((target("avx512vl,avx512f,avx512bw"))) //
635
+ inline static simsimd_f32_t
636
+ simsimd_avx512_i8_js(simsimd_i8_t const* a, simsimd_i8_t const* b, simsimd_size_t n) {
637
+ return simsimd_avx512_i8_cos(a, b, n);
638
+ }
639
+
640
+ #endif // SIMSIMD_TARGET_X86_AVX512
641
+ #endif // SIMSIMD_TARGET_X86
642
+
643
+ #ifdef __cplusplus
644
+ }
645
+ #endif