numeris 0.5.5

Pure-Rust numerical algorithms library — high performance with SIMD support while also supporting no-std for embedded and WASM targets.
Documentation
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
//! AVX-accelerated f64 kernels for x86_64.
//!
//! AVX provides 256-bit registers → 4×f64 lanes.
//! Only compiled when `target_feature = "avx"` is enabled
//! (e.g. via `-C target-cpu=native` on Haswell+).

#[cfg(target_arch = "x86_64")]
use core::arch::x86_64::*;

/// Dot product of two f64 slices using AVX.
///
/// Uses 4 independent accumulators (16 f64 per iteration) to hide
/// multiply-add latency.
#[inline]
pub fn dot(a: &[f64], b: &[f64]) -> f64 {
    debug_assert_eq!(a.len(), b.len());
    let n = a.len();
    let chunks = n / 16; // 4 accumulators × 4 lanes

    unsafe {
        let ap = a.as_ptr();
        let bp = b.as_ptr();

        let mut acc0 = _mm256_setzero_pd();
        let mut acc1 = _mm256_setzero_pd();
        let mut acc2 = _mm256_setzero_pd();
        let mut acc3 = _mm256_setzero_pd();

        for i in 0..chunks {
            let off = i * 16;
            acc0 = _mm256_add_pd(acc0, _mm256_mul_pd(_mm256_loadu_pd(ap.add(off)), _mm256_loadu_pd(bp.add(off))));
            acc1 = _mm256_add_pd(acc1, _mm256_mul_pd(_mm256_loadu_pd(ap.add(off + 4)), _mm256_loadu_pd(bp.add(off + 4))));
            acc2 = _mm256_add_pd(acc2, _mm256_mul_pd(_mm256_loadu_pd(ap.add(off + 8)), _mm256_loadu_pd(bp.add(off + 8))));
            acc3 = _mm256_add_pd(acc3, _mm256_mul_pd(_mm256_loadu_pd(ap.add(off + 12)), _mm256_loadu_pd(bp.add(off + 12))));
        }

        acc0 = _mm256_add_pd(acc0, acc1);
        acc2 = _mm256_add_pd(acc2, acc3);
        acc0 = _mm256_add_pd(acc0, acc2);
        // Horizontal sum: [a, b, c, d] → a+b+c+d
        let hi128 = _mm256_extractf128_pd(acc0, 1);
        let lo128 = _mm256_castpd256_pd128(acc0);
        let sum128 = _mm_add_pd(hi128, lo128);
        let hi64 = _mm_unpackhi_pd(sum128, sum128);
        let result = _mm_add_sd(sum128, hi64);
        let mut sum = _mm_cvtsd_f64(result);

        // Remainder: up to 15 elements — handle quads then scalar
        let tail = chunks * 16;
        let remaining = n - tail;
        let rem_quads = remaining / 4;
        let mut acc_rem = _mm256_setzero_pd();
        for i in 0..rem_quads {
            let off = tail + i * 4;
            acc_rem = _mm256_add_pd(acc_rem, _mm256_mul_pd(_mm256_loadu_pd(ap.add(off)), _mm256_loadu_pd(bp.add(off))));
        }
        let rhi = _mm256_extractf128_pd(acc_rem, 1);
        let rlo = _mm256_castpd256_pd128(acc_rem);
        let rs = _mm_add_pd(rhi, rlo);
        let rh = _mm_unpackhi_pd(rs, rs);
        sum += _mm_cvtsd_f64(_mm_add_sd(rs, rh));

        let scalar_start = tail + rem_quads * 4;
        for i in scalar_start..n {
            sum += a[i] * b[i];
        }
        sum
    }
}

/// Matrix multiply C += A * B using AVX with register-blocked micro-kernel.
///
/// Uses an MR×NR (8×4) register-blocked micro-kernel that accumulates the full
/// k-sum in 8 AVX registers before writing back to C, reducing memory traffic
/// from O(m·n·p) to O(m·p) stores. Technique inspired by nano-gemm
/// (Sarah Quinones, <https://github.com/sarah-quinones/nano-gemm>).
///
/// `a` is m×n, `b` is n×p, `c` is m×p (column-major flat slices).
/// Column-major indexing: element (row, col) is at `col * nrows + row`.
#[inline]
pub fn matmul(a: &[f64], b: &[f64], c: &mut [f64], m: usize, n: usize, p: usize) {
    debug_assert_eq!(a.len(), m * n);
    debug_assert_eq!(b.len(), n * p);
    debug_assert_eq!(c.len(), m * p);

    const MR: usize = 8; // 2 __m256d registers × 4 f64 lanes
    const NR: usize = 4;
    const KC: usize = 256;

    let m_full = (m / MR) * MR;
    let p_full = (p / NR) * NR;

    let mut kb = 0;
    while kb < n {
        let k_end = (kb + KC).min(n);

        // Interior: full MR×NR tiles, register-blocked
        for jb in 0..p_full / NR {
            let j0 = jb * NR;
            for ib in 0..m_full / MR {
                let i0 = ib * MR;
                unsafe { microkernel_8x4(a, b, c, m, n, i0, j0, kb, k_end); }
            }
        }

        // Bottom edge: rows m_full..m, cols 0..p_full
        // Handle quads of remaining rows with 4×NR mini-kernel (1 __m256d per col)
        let mut i0 = m_full;
        while i0 + 4 <= m {
            for jb in 0..p_full / NR {
                let j0 = jb * NR;
                unsafe { microkernel_4x4(a, b, c, m, n, i0, j0, kb, k_end); }
            }
            i0 += 4;
        }
        // Handle remaining pairs with 2×NR using SSE2-width
        while i0 + 2 <= m {
            for jb in 0..p_full / NR {
                let j0 = jb * NR;
                unsafe { microkernel_2x4(a, b, c, m, n, i0, j0, kb, k_end); }
            }
            i0 += 2;
        }
        // Scalar tail: single remaining row
        if i0 < m {
            for j in 0..p_full {
                for k in kb..k_end {
                    c[j * m + i0] += a[k * m + i0] * b[j * n + k];
                }
            }
        }

        // Right edge: cols p_full..p, all rows (SIMD j-k-i on inner loop)
        let i_simd = m / 4;
        let i_tail = i_simd * 4;
        for j in p_full..p {
            for k in kb..k_end {
                let b_kj = b[j * n + k];
                let a_col = k * m;
                let c_col = j * m;
                unsafe {
                    let vb = _mm256_set1_pd(b_kj);
                    for i in 0..i_simd {
                        let offset = i * 4;
                        let vc = _mm256_loadu_pd(c.as_ptr().add(c_col + offset));
                        let va = _mm256_loadu_pd(a.as_ptr().add(a_col + offset));
                        let result = _mm256_add_pd(vc, _mm256_mul_pd(va, vb));
                        _mm256_storeu_pd(c.as_mut_ptr().add(c_col + offset), result);
                    }
                }
                for i in i_tail..m {
                    c[c_col + i] += a[a_col + i] * b_kj;
                }
            }
        }

        kb += KC;
    }
}

/// Register-blocked 8×4 micro-kernel: accumulates C[i0..i0+8, j0..j0+4] in
/// 8 AVX registers across the k-loop, writing C only once.
#[inline(always)]
unsafe fn microkernel_8x4(
    a: &[f64], b: &[f64], c: &mut [f64],
    m: usize, n: usize, i0: usize, j0: usize,
    k_start: usize, k_end: usize,
) {
    unsafe {
        let a_ptr = a.as_ptr();
        let b_ptr = b.as_ptr();

        // 8 accumulator registers: 2 vectors × 4 columns
        let mut acc00 = _mm256_setzero_pd();
        let mut acc10 = _mm256_setzero_pd();
        let mut acc01 = _mm256_setzero_pd();
        let mut acc11 = _mm256_setzero_pd();
        let mut acc02 = _mm256_setzero_pd();
        let mut acc12 = _mm256_setzero_pd();
        let mut acc03 = _mm256_setzero_pd();
        let mut acc13 = _mm256_setzero_pd();

        for k in k_start..k_end {
            let a_off = k * m + i0;
            let a0 = _mm256_loadu_pd(a_ptr.add(a_off));
            let a1 = _mm256_loadu_pd(a_ptr.add(a_off + 4));

            let b0 = _mm256_set1_pd(*b_ptr.add(j0 * n + k));
            acc00 = _mm256_add_pd(acc00, _mm256_mul_pd(a0, b0));
            acc10 = _mm256_add_pd(acc10, _mm256_mul_pd(a1, b0));

            let b1 = _mm256_set1_pd(*b_ptr.add((j0 + 1) * n + k));
            acc01 = _mm256_add_pd(acc01, _mm256_mul_pd(a0, b1));
            acc11 = _mm256_add_pd(acc11, _mm256_mul_pd(a1, b1));

            let b2 = _mm256_set1_pd(*b_ptr.add((j0 + 2) * n + k));
            acc02 = _mm256_add_pd(acc02, _mm256_mul_pd(a0, b2));
            acc12 = _mm256_add_pd(acc12, _mm256_mul_pd(a1, b2));

            let b3 = _mm256_set1_pd(*b_ptr.add((j0 + 3) * n + k));
            acc03 = _mm256_add_pd(acc03, _mm256_mul_pd(a0, b3));
            acc13 = _mm256_add_pd(acc13, _mm256_mul_pd(a1, b3));
        }

        // Write back: C += acc
        let c_ptr = c.as_mut_ptr();

        let off0 = j0 * m + i0;
        _mm256_storeu_pd(c_ptr.add(off0), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off0)), acc00));
        _mm256_storeu_pd(c_ptr.add(off0 + 4), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off0 + 4)), acc10));

        let off1 = (j0 + 1) * m + i0;
        _mm256_storeu_pd(c_ptr.add(off1), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off1)), acc01));
        _mm256_storeu_pd(c_ptr.add(off1 + 4), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off1 + 4)), acc11));

        let off2 = (j0 + 2) * m + i0;
        _mm256_storeu_pd(c_ptr.add(off2), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off2)), acc02));
        _mm256_storeu_pd(c_ptr.add(off2 + 4), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off2 + 4)), acc12));

        let off3 = (j0 + 3) * m + i0;
        _mm256_storeu_pd(c_ptr.add(off3), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off3)), acc03));
        _mm256_storeu_pd(c_ptr.add(off3 + 4), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off3 + 4)), acc13));
    }
}

/// Register-blocked 4×4 mini-kernel for bottom-edge rows (1 __m256d per column).
#[inline(always)]
unsafe fn microkernel_4x4(
    a: &[f64], b: &[f64], c: &mut [f64],
    m: usize, n: usize, i0: usize, j0: usize,
    k_start: usize, k_end: usize,
) {
    unsafe {
        let a_ptr = a.as_ptr();
        let b_ptr = b.as_ptr();

        let mut acc0 = _mm256_setzero_pd();
        let mut acc1 = _mm256_setzero_pd();
        let mut acc2 = _mm256_setzero_pd();
        let mut acc3 = _mm256_setzero_pd();

        for k in k_start..k_end {
            let a0 = _mm256_loadu_pd(a_ptr.add(k * m + i0));

            acc0 = _mm256_add_pd(acc0, _mm256_mul_pd(a0, _mm256_set1_pd(*b_ptr.add(j0 * n + k))));
            acc1 = _mm256_add_pd(acc1, _mm256_mul_pd(a0, _mm256_set1_pd(*b_ptr.add((j0 + 1) * n + k))));
            acc2 = _mm256_add_pd(acc2, _mm256_mul_pd(a0, _mm256_set1_pd(*b_ptr.add((j0 + 2) * n + k))));
            acc3 = _mm256_add_pd(acc3, _mm256_mul_pd(a0, _mm256_set1_pd(*b_ptr.add((j0 + 3) * n + k))));
        }

        let c_ptr = c.as_mut_ptr();
        let off0 = j0 * m + i0;
        _mm256_storeu_pd(c_ptr.add(off0), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off0)), acc0));
        let off1 = (j0 + 1) * m + i0;
        _mm256_storeu_pd(c_ptr.add(off1), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off1)), acc1));
        let off2 = (j0 + 2) * m + i0;
        _mm256_storeu_pd(c_ptr.add(off2), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off2)), acc2));
        let off3 = (j0 + 3) * m + i0;
        _mm256_storeu_pd(c_ptr.add(off3), _mm256_add_pd(_mm256_loadu_pd(c_ptr.add(off3)), acc3));
    }
}

/// Register-blocked 2×4 mini-kernel for bottom-edge rows (1 __m128d per column).
#[inline(always)]
unsafe fn microkernel_2x4(
    a: &[f64], b: &[f64], c: &mut [f64],
    m: usize, n: usize, i0: usize, j0: usize,
    k_start: usize, k_end: usize,
) {
    unsafe {
        let a_ptr = a.as_ptr();
        let b_ptr = b.as_ptr();

        let mut acc0 = _mm_setzero_pd();
        let mut acc1 = _mm_setzero_pd();
        let mut acc2 = _mm_setzero_pd();
        let mut acc3 = _mm_setzero_pd();

        for k in k_start..k_end {
            let a0 = _mm_loadu_pd(a_ptr.add(k * m + i0));

            acc0 = _mm_add_pd(acc0, _mm_mul_pd(a0, _mm_set1_pd(*b_ptr.add(j0 * n + k))));
            acc1 = _mm_add_pd(acc1, _mm_mul_pd(a0, _mm_set1_pd(*b_ptr.add((j0 + 1) * n + k))));
            acc2 = _mm_add_pd(acc2, _mm_mul_pd(a0, _mm_set1_pd(*b_ptr.add((j0 + 2) * n + k))));
            acc3 = _mm_add_pd(acc3, _mm_mul_pd(a0, _mm_set1_pd(*b_ptr.add((j0 + 3) * n + k))));
        }

        let c_ptr = c.as_mut_ptr();
        let off0 = j0 * m + i0;
        _mm_storeu_pd(c_ptr.add(off0), _mm_add_pd(_mm_loadu_pd(c_ptr.add(off0)), acc0));
        let off1 = (j0 + 1) * m + i0;
        _mm_storeu_pd(c_ptr.add(off1), _mm_add_pd(_mm_loadu_pd(c_ptr.add(off1)), acc1));
        let off2 = (j0 + 2) * m + i0;
        _mm_storeu_pd(c_ptr.add(off2), _mm_add_pd(_mm_loadu_pd(c_ptr.add(off2)), acc2));
        let off3 = (j0 + 3) * m + i0;
        _mm_storeu_pd(c_ptr.add(off3), _mm_add_pd(_mm_loadu_pd(c_ptr.add(off3)), acc3));
    }
}

/// Element-wise addition: out[i] = a[i] + b[i].
#[inline]
pub fn add_slices(a: &[f64], b: &[f64], out: &mut [f64]) {
    debug_assert_eq!(a.len(), b.len());
    debug_assert_eq!(a.len(), out.len());
    let n = a.len();
    let chunks = n / 4;

    unsafe {
        for i in 0..chunks {
            let offset = i * 4;
            let va = _mm256_loadu_pd(a.as_ptr().add(offset));
            let vb = _mm256_loadu_pd(b.as_ptr().add(offset));
            _mm256_storeu_pd(out.as_mut_ptr().add(offset), _mm256_add_pd(va, vb));
        }
    }

    let tail = chunks * 4;
    for i in tail..n {
        out[i] = a[i] + b[i];
    }
}

/// Element-wise subtraction: out[i] = a[i] - b[i].
#[inline]
pub fn sub_slices(a: &[f64], b: &[f64], out: &mut [f64]) {
    debug_assert_eq!(a.len(), b.len());
    debug_assert_eq!(a.len(), out.len());
    let n = a.len();
    let chunks = n / 4;

    unsafe {
        for i in 0..chunks {
            let offset = i * 4;
            let va = _mm256_loadu_pd(a.as_ptr().add(offset));
            let vb = _mm256_loadu_pd(b.as_ptr().add(offset));
            _mm256_storeu_pd(out.as_mut_ptr().add(offset), _mm256_sub_pd(va, vb));
        }
    }

    let tail = chunks * 4;
    for i in tail..n {
        out[i] = a[i] - b[i];
    }
}

/// Scalar multiplication: out[i] = a[i] * scalar.
#[inline]
pub fn scale_slices(a: &[f64], scalar: f64, out: &mut [f64]) {
    debug_assert_eq!(a.len(), out.len());
    let n = a.len();
    let chunks = n / 4;

    unsafe {
        let vs = _mm256_set1_pd(scalar);
        for i in 0..chunks {
            let offset = i * 4;
            let va = _mm256_loadu_pd(a.as_ptr().add(offset));
            _mm256_storeu_pd(out.as_mut_ptr().add(offset), _mm256_mul_pd(va, vs));
        }
    }

    let tail = chunks * 4;
    for i in tail..n {
        out[i] = a[i] * scalar;
    }
}

/// AXPY: y[i] -= alpha * x[i].
#[inline]
pub fn axpy_neg(y: &mut [f64], alpha: f64, x: &[f64]) {
    debug_assert_eq!(y.len(), x.len());
    let n = y.len();
    let chunks = n / 4;

    unsafe {
        let va = _mm256_set1_pd(alpha);
        for i in 0..chunks {
            let offset = i * 4;
            let vy = _mm256_loadu_pd(y.as_ptr().add(offset));
            let vx = _mm256_loadu_pd(x.as_ptr().add(offset));
            let result = _mm256_sub_pd(vy, _mm256_mul_pd(va, vx));
            _mm256_storeu_pd(y.as_mut_ptr().add(offset), result);
        }
    }

    let tail = chunks * 4;
    for i in tail..n {
        y[i] -= alpha * x[i];
    }
}

/// AXPY: y[i] += alpha * x[i].
#[inline]
pub fn axpy_pos(y: &mut [f64], alpha: f64, x: &[f64]) {
    debug_assert_eq!(y.len(), x.len());
    let n = y.len();
    let chunks = n / 4;

    unsafe {
        let va = _mm256_set1_pd(alpha);
        for i in 0..chunks {
            let offset = i * 4;
            let vy = _mm256_loadu_pd(y.as_ptr().add(offset));
            let vx = _mm256_loadu_pd(x.as_ptr().add(offset));
            let result = _mm256_add_pd(vy, _mm256_mul_pd(va, vx));
            _mm256_storeu_pd(y.as_mut_ptr().add(offset), result);
        }
    }

    let tail = chunks * 4;
    for i in tail..n {
        y[i] += alpha * x[i];
    }
}