scirs2-core 0.4.3

Core utilities and common functionality for SciRS2 (scirs2-core)
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
//! NEON-optimized matrix operations for mobile platforms
//!
//! Optimized GEMM (General Matrix Multiply) and GEMV (General Matrix-Vector)
//! operations using ARM NEON intrinsics, with special focus on mobile battery
//! efficiency and cache optimization.

#[cfg(target_arch = "aarch64")]
use std::arch::aarch64::*;

/// NEON-optimized matrix-vector multiplication (GEMV) for f32
///
/// Computes y = alpha * A * x + beta * y
/// where A is m x n matrix in row-major format
///
/// # Safety
///
/// Caller must ensure the CPU supports NEON instructions (aarch64).
/// The slices `a` (length >= m*n), `x` (length >= n), and `y` (length >= m)
/// must be valid for reading/writing respectively.
#[cfg(target_arch = "aarch64")]
#[target_feature(enable = "neon")]
pub unsafe fn neon_gemv_f32_impl(
    m: usize,
    n: usize,
    alpha: f32,
    a: &[f32],
    x: &[f32],
    beta: f32,
    y: &mut [f32],
) {
    let valpha = vdupq_n_f32(alpha);
    let vbeta = vdupq_n_f32(beta);

    for i in 0..m {
        let row_offset = i * n;
        let mut sum = vdupq_n_f32(0.0);
        let mut j = 0;

        // NEON vectorized loop - process 4 elements at a time
        while j + 4 <= n {
            let va = vld1q_f32(a.as_ptr().add(row_offset + j));
            let vx = vld1q_f32(x.as_ptr().add(j));
            sum = vfmaq_f32(sum, va, vx);
            j += 4;
        }

        // Horizontal reduction
        let mut dot = vaddvq_f32(sum);

        // Scalar remainder
        while j < n {
            dot += a[row_offset + j] * x[j];
            j += 1;
        }

        // y[i] = alpha * dot + beta * y[i]
        y[i] = alpha * dot + beta * y[i];
    }
}

pub fn neon_gemv_f32(
    m: usize,
    n: usize,
    alpha: f32,
    a: &[f32],
    x: &[f32],
    beta: f32,
    y: &mut [f32],
) {
    #[cfg(target_arch = "aarch64")]
    {
        if std::arch::is_aarch64_feature_detected!("neon") {
            unsafe { neon_gemv_f32_impl(m, n, alpha, a, x, beta, y) }
        } else {
            fallback_gemv_f32(m, n, alpha, a, x, beta, y)
        }
    }
    #[cfg(not(target_arch = "aarch64"))]
    {
        fallback_gemv_f32(m, n, alpha, a, x, beta, y)
    }
}

/// NEON-optimized matrix-vector multiplication (GEMV) for f64
///
/// # Safety
///
/// Caller must ensure the CPU supports NEON instructions (aarch64).
/// The slices `a` (length >= m*n), `x` (length >= n), and `y` (length >= m)
/// must be valid for reading/writing respectively.
#[cfg(target_arch = "aarch64")]
#[target_feature(enable = "neon")]
pub unsafe fn neon_gemv_f64_impl(
    m: usize,
    n: usize,
    alpha: f64,
    a: &[f64],
    x: &[f64],
    beta: f64,
    y: &mut [f64],
) {
    for i in 0..m {
        let row_offset = i * n;
        let mut sum = vdupq_n_f64(0.0);
        let mut j = 0;

        // NEON vectorized loop - process 2 elements at a time
        while j + 2 <= n {
            let va = vld1q_f64(a.as_ptr().add(row_offset + j));
            let vx = vld1q_f64(x.as_ptr().add(j));
            sum = vfmaq_f64(sum, va, vx);
            j += 2;
        }

        // Horizontal reduction
        let mut dot = vaddvq_f64(sum);

        // Scalar remainder
        while j < n {
            dot += a[row_offset + j] * x[j];
            j += 1;
        }

        y[i] = alpha * dot + beta * y[i];
    }
}

pub fn neon_gemv_f64(
    m: usize,
    n: usize,
    alpha: f64,
    a: &[f64],
    x: &[f64],
    beta: f64,
    y: &mut [f64],
) {
    #[cfg(target_arch = "aarch64")]
    {
        if std::arch::is_aarch64_feature_detected!("neon") {
            unsafe { neon_gemv_f64_impl(m, n, alpha, a, x, beta, y) }
        } else {
            fallback_gemv_f64(m, n, alpha, a, x, beta, y)
        }
    }
    #[cfg(not(target_arch = "aarch64"))]
    {
        fallback_gemv_f64(m, n, alpha, a, x, beta, y)
    }
}

/// NEON-optimized matrix-matrix multiplication (GEMM) for f32
///
/// Computes C = alpha * A * B + beta * C
/// where A is m x k, B is k x n, C is m x n (all row-major)
///
/// Uses micro-kernel approach optimized for mobile cache hierarchies
///
/// # Safety
///
/// Caller must ensure the CPU supports NEON instructions (aarch64).
/// The slices `a` (length >= m*k), `b` (length >= k*n), and `c` (length >= m*n)
/// must be valid for reading/writing respectively.
#[cfg(target_arch = "aarch64")]
#[target_feature(enable = "neon")]
pub unsafe fn neon_gemm_f32_impl(
    m: usize,
    n: usize,
    k: usize,
    alpha: f32,
    a: &[f32],
    b: &[f32],
    beta: f32,
    c: &mut [f32],
) {
    // Mobile-optimized block sizes (conservative for battery efficiency)
    const MC: usize = 64; // Rows of A to process at once
    const NC: usize = 256; // Columns of B to process at once
    const KC: usize = 128; // Common dimension blocking

    for jc in (0..n).step_by(NC) {
        let nc = (jc + NC).min(n) - jc;

        for pc in (0..k).step_by(KC) {
            let kc = (pc + KC).min(k) - pc;

            for ic in (0..m).step_by(MC) {
                let mc = (ic + MC).min(m) - ic;

                // Micro-kernel: optimized inner loops
                for i in 0..mc {
                    for j in 0..nc {
                        let mut sum = vdupq_n_f32(0.0);
                        let mut p = 0;

                        // Vectorized inner product
                        while p + 4 <= kc {
                            let va = vld1q_f32(a.as_ptr().add((ic + i) * k + pc + p));
                            let vb = vld1q_f32(b.as_ptr().add((pc + p) * n + jc + j));
                            sum = vfmaq_f32(sum, va, vb);
                            p += 4;
                        }

                        let mut dot = vaddvq_f32(sum);

                        // Scalar remainder
                        while p < kc {
                            dot += a[(ic + i) * k + pc + p] * b[(pc + p) * n + jc + j];
                            p += 1;
                        }

                        let c_idx = (ic + i) * n + jc + j;
                        if pc == 0 {
                            c[c_idx] = alpha * dot + beta * c[c_idx];
                        } else {
                            c[c_idx] += alpha * dot;
                        }
                    }
                }
            }
        }
    }
}

pub fn neon_gemm_f32(
    m: usize,
    n: usize,
    k: usize,
    alpha: f32,
    a: &[f32],
    b: &[f32],
    beta: f32,
    c: &mut [f32],
) {
    #[cfg(target_arch = "aarch64")]
    {
        if std::arch::is_aarch64_feature_detected!("neon") {
            unsafe { neon_gemm_f32_impl(m, n, k, alpha, a, b, beta, c) }
        } else {
            fallback_gemm_f32(m, n, k, alpha, a, b, beta, c)
        }
    }
    #[cfg(not(target_arch = "aarch64"))]
    {
        fallback_gemm_f32(m, n, k, alpha, a, b, beta, c)
    }
}

/// NEON-optimized matrix-matrix multiplication (GEMM) for f64
///
/// # Safety
///
/// Caller must ensure the CPU supports NEON instructions (aarch64).
/// The slices `a` (length >= m*k), `b` (length >= k*n), and `c` (length >= m*n)
/// must be valid for reading/writing respectively.
#[cfg(target_arch = "aarch64")]
#[target_feature(enable = "neon")]
pub unsafe fn neon_gemm_f64_impl(
    m: usize,
    n: usize,
    k: usize,
    alpha: f64,
    a: &[f64],
    b: &[f64],
    beta: f64,
    c: &mut [f64],
) {
    const MC: usize = 32;
    const NC: usize = 128;
    const KC: usize = 64;

    for jc in (0..n).step_by(NC) {
        let nc = (jc + NC).min(n) - jc;

        for pc in (0..k).step_by(KC) {
            let kc = (pc + KC).min(k) - pc;

            for ic in (0..m).step_by(MC) {
                let mc = (ic + MC).min(m) - ic;

                for i in 0..mc {
                    for j in 0..nc {
                        let mut sum = vdupq_n_f64(0.0);
                        let mut p = 0;

                        while p + 2 <= kc {
                            let va = vld1q_f64(a.as_ptr().add((ic + i) * k + pc + p));
                            let vb = vld1q_f64(b.as_ptr().add((pc + p) * n + jc + j));
                            sum = vfmaq_f64(sum, va, vb);
                            p += 2;
                        }

                        let mut dot = vaddvq_f64(sum);

                        while p < kc {
                            dot += a[(ic + i) * k + pc + p] * b[(pc + p) * n + jc + j];
                            p += 1;
                        }

                        let c_idx = (ic + i) * n + jc + j;
                        if pc == 0 {
                            c[c_idx] = alpha * dot + beta * c[c_idx];
                        } else {
                            c[c_idx] += alpha * dot;
                        }
                    }
                }
            }
        }
    }
}

pub fn neon_gemm_f64(
    m: usize,
    n: usize,
    k: usize,
    alpha: f64,
    a: &[f64],
    b: &[f64],
    beta: f64,
    c: &mut [f64],
) {
    #[cfg(target_arch = "aarch64")]
    {
        if std::arch::is_aarch64_feature_detected!("neon") {
            unsafe { neon_gemm_f64_impl(m, n, k, alpha, a, b, beta, c) }
        } else {
            fallback_gemm_f64(m, n, k, alpha, a, b, beta, c)
        }
    }
    #[cfg(not(target_arch = "aarch64"))]
    {
        fallback_gemm_f64(m, n, k, alpha, a, b, beta, c)
    }
}

// Fallback implementations
fn fallback_gemv_f32(
    m: usize,
    n: usize,
    alpha: f32,
    a: &[f32],
    x: &[f32],
    beta: f32,
    y: &mut [f32],
) {
    for i in 0..m {
        let mut sum = 0.0;
        for j in 0..n {
            sum += a[i * n + j] * x[j];
        }
        y[i] = alpha * sum + beta * y[i];
    }
}

fn fallback_gemv_f64(
    m: usize,
    n: usize,
    alpha: f64,
    a: &[f64],
    x: &[f64],
    beta: f64,
    y: &mut [f64],
) {
    for i in 0..m {
        let mut sum = 0.0;
        for j in 0..n {
            sum += a[i * n + j] * x[j];
        }
        y[i] = alpha * sum + beta * y[i];
    }
}

fn fallback_gemm_f32(
    m: usize,
    n: usize,
    k: usize,
    alpha: f32,
    a: &[f32],
    b: &[f32],
    beta: f32,
    c: &mut [f32],
) {
    for i in 0..m {
        for j in 0..n {
            let mut sum = 0.0;
            for p in 0..k {
                sum += a[i * k + p] * b[p * n + j];
            }
            c[i * n + j] = alpha * sum + beta * c[i * n + j];
        }
    }
}

fn fallback_gemm_f64(
    m: usize,
    n: usize,
    k: usize,
    alpha: f64,
    a: &[f64],
    b: &[f64],
    beta: f64,
    c: &mut [f64],
) {
    for i in 0..m {
        for j in 0..n {
            let mut sum = 0.0;
            for p in 0..k {
                sum += a[i * k + p] * b[p * n + j];
            }
            c[i * n + j] = alpha * sum + beta * c[i * n + j];
        }
    }
}