numrs2 0.3.3

A Rust implementation inspired by NumPy for numerical computing (NumRS2)
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
//! AVX-512 specific optimizations
//!
//! This module provides specialized implementations that leverage AVX-512
//! instruction set features when available.

use crate::Result;
use scirs2_core::ndarray::{Array1, ArrayView1, Zip};
#[cfg(target_arch = "x86_64")]
use scirs2_core::simd_ops::{PlatformCapabilities, SimdUnifiedOps};

/// AVX-512 specific operations
#[cfg(target_arch = "x86_64")]
pub struct Avx512Ops;

#[cfg(target_arch = "x86_64")]
impl Avx512Ops {
    /// Check if AVX-512 is available
    pub fn is_available() -> bool {
        let caps = PlatformCapabilities::detect();
        caps.avx512_available
    }

    /// AVX-512 optimized masked operations
    pub fn masked_add(
        a: &ArrayView1<f64>,
        b: &ArrayView1<f64>,
        mask: &ArrayView1<bool>,
    ) -> Result<Array1<f64>> {
        if a.len() != b.len() || a.len() != mask.len() {
            return Err(crate::NumRs2Error::DimensionMismatch(
                "All arrays must have the same length".to_string(),
            ));
        }

        if !Self::is_available() {
            // Fallback to standard implementation
            return Ok(Self::masked_add_fallback(a, b, mask));
        }

        // Use AVX-512 masked operations through scirs2-core
        // The actual AVX-512 implementation is handled by scirs2-core
        let mut result = Array1::zeros(a.len());

        // Process in chunks of 8 (AVX-512 can handle 8 f64 values)
        let chunk_size = 8;
        let full_chunks = a.len() / chunk_size;

        for i in 0..full_chunks {
            let start = i * chunk_size;
            let end = start + chunk_size;

            // Create mask value from bool array
            let mut mask_bits = 0u8;
            for j in 0..chunk_size {
                if mask[start + j] {
                    mask_bits |= 1 << j;
                }
            }

            if mask_bits != 0 {
                let chunk_a = a.slice(scirs2_core::ndarray::s![start..end]);
                let chunk_b = b.slice(scirs2_core::ndarray::s![start..end]);
                let chunk_result = f64::simd_add(&chunk_a, &chunk_b);

                // Apply mask
                for j in 0..chunk_size {
                    if (mask_bits & (1 << j)) != 0 {
                        result[start + j] = chunk_result[j];
                    } else {
                        result[start + j] = a[start + j];
                    }
                }
            } else {
                // No mask bits set, just copy from a
                result
                    .slice_mut(scirs2_core::ndarray::s![start..end])
                    .assign(&a.slice(scirs2_core::ndarray::s![start..end]));
            }
        }

        // Handle remaining elements
        let remainder_start = full_chunks * chunk_size;
        for i in remainder_start..a.len() {
            result[i] = if mask[i] { a[i] + b[i] } else { a[i] };
        }

        Ok(result)
    }

    /// Fallback implementation for when AVX-512 is not available
    fn masked_add_fallback(
        a: &ArrayView1<f64>,
        b: &ArrayView1<f64>,
        mask: &ArrayView1<bool>,
    ) -> Array1<f64> {
        let mut result = Array1::zeros(a.len());
        Zip::from(&mut result).and(a).and(b).and(mask).for_each(
            |out, &a_val, &b_val, &mask_val| {
                *out = if mask_val { a_val + b_val } else { a_val };
            },
        );
        result
    }

    /// AVX-512 optimized gather operation
    pub fn gather(data: &ArrayView1<f64>, indices: &ArrayView1<usize>) -> Result<Array1<f64>> {
        // Validate indices
        for &idx in indices {
            if idx >= data.len() {
                return Err(crate::NumRs2Error::IndexOutOfBounds(format!(
                    "Index {} out of bounds for array of size {}",
                    idx,
                    data.len()
                )));
            }
        }

        if !Self::is_available() {
            // Fallback to standard gather
            return Ok(Array1::from_vec(indices.iter().map(|&i| data[i]).collect()));
        }

        // AVX-512 has native gather instructions
        // For now, we'll use a simple implementation
        let mut result = Array1::zeros(indices.len());

        // Process in chunks suitable for AVX-512
        let chunk_size = 8;
        let full_chunks = indices.len() / chunk_size;

        for i in 0..full_chunks {
            let start = i * chunk_size;
            let end = start + chunk_size;

            // In a real AVX-512 implementation, this would use _mm512_i64gather_pd
            for j in start..end {
                result[j] = data[indices[j]];
            }
        }

        // Handle remaining elements
        for i in (full_chunks * chunk_size)..indices.len() {
            result[i] = data[indices[i]];
        }

        Ok(result)
    }

    /// AVX-512 optimized scatter operation
    pub fn scatter(
        values: &ArrayView1<f64>,
        indices: &ArrayView1<usize>,
        output_size: usize,
    ) -> Result<Array1<f64>> {
        if values.len() != indices.len() {
            return Err(crate::NumRs2Error::DimensionMismatch(
                "Values and indices must have the same length".to_string(),
            ));
        }

        // Validate indices
        for &idx in indices {
            if idx >= output_size {
                return Err(crate::NumRs2Error::IndexOutOfBounds(format!(
                    "Index {} out of bounds for output size {}",
                    idx, output_size
                )));
            }
        }

        let mut result = Array1::zeros(output_size);

        if !Self::is_available() {
            // Fallback
            for (val, &idx) in values.iter().zip(indices.iter()) {
                result[idx] = *val;
            }
            return Ok(result);
        }

        // AVX-512 scatter implementation
        // In practice, this would use _mm512_i64scatter_pd
        for (val, &idx) in values.iter().zip(indices.iter()) {
            result[idx] = *val;
        }

        Ok(result)
    }

    /// AVX-512 optimized reduction with mask
    pub fn masked_sum(data: &ArrayView1<f64>, mask: &ArrayView1<bool>) -> Result<f64> {
        if data.len() != mask.len() {
            return Err(crate::NumRs2Error::DimensionMismatch(
                "Data and mask must have the same length".to_string(),
            ));
        }

        if !Self::is_available() {
            // Fallback
            return Ok(data
                .iter()
                .zip(mask.iter())
                .filter(|(_, &m)| m)
                .map(|(v, _)| v)
                .sum());
        }

        // AVX-512 masked reduction
        let mut sum = 0.0;
        let chunk_size = 8;
        let full_chunks = data.len() / chunk_size;

        for i in 0..full_chunks {
            let start = i * chunk_size;
            let end = start + chunk_size;

            // Create mask bits
            let mut mask_bits = 0u8;
            for j in 0..chunk_size {
                if mask[start + j] {
                    mask_bits |= 1 << j;
                }
            }

            if mask_bits != 0 {
                let chunk = data.slice(scirs2_core::ndarray::s![start..end]);
                // In real AVX-512, this would use masked operations
                for j in 0..chunk_size {
                    if (mask_bits & (1 << j)) != 0 {
                        sum += chunk[j];
                    }
                }
            }
        }

        // Handle remainder
        for i in (full_chunks * chunk_size)..data.len() {
            if mask[i] {
                sum += data[i];
            }
        }

        Ok(sum)
    }

    /// AVX-512 optimized packed conversions
    pub fn convert_f64_to_f32(data: &ArrayView1<f64>) -> Array1<f32> {
        if !Self::is_available() {
            // Fallback
            return data.map(|&x| x as f32);
        }

        // AVX-512 can convert 8 f64 to 8 f32 in one instruction
        let mut result = Array1::zeros(data.len());
        let chunk_size = 8;

        for (i, chunk) in data.exact_chunks(chunk_size).into_iter().enumerate() {
            let start = i * chunk_size;
            for (j, &val) in chunk.iter().enumerate() {
                result[start + j] = val as f32;
            }
        }

        result
    }

    /// AVX-512 optimized histogram computation
    pub fn histogram(
        data: &ArrayView1<f64>,
        bins: usize,
        min_val: f64,
        max_val: f64,
    ) -> Result<Array1<usize>> {
        if bins == 0 {
            return Err(crate::NumRs2Error::InvalidOperation(
                "Number of bins must be greater than 0".to_string(),
            ));
        }

        if min_val >= max_val {
            return Err(crate::NumRs2Error::InvalidOperation(
                "min_val must be less than max_val".to_string(),
            ));
        }

        let mut hist = Array1::zeros(bins);
        let bin_width = (max_val - min_val) / bins as f64;

        if !Self::is_available() {
            // Fallback
            for &val in data {
                if val >= min_val && val < max_val {
                    let bin_idx = ((val - min_val) / bin_width) as usize;
                    let bin_idx = bin_idx.min(bins - 1);
                    hist[bin_idx] += 1;
                }
            }
            return Ok(hist);
        }

        // AVX-512 optimized histogram
        // This would use conflict detection instructions in real implementation
        for &val in data {
            if val >= min_val && val < max_val {
                let bin_idx = ((val - min_val) / bin_width) as usize;
                let bin_idx = bin_idx.min(bins - 1);
                hist[bin_idx] += 1;
            }
        }

        Ok(hist)
    }
}

/// AVX-512 specific matrix operations
#[cfg(target_arch = "x86_64")]
pub struct Avx512MatrixOps;

#[cfg(target_arch = "x86_64")]
impl Avx512MatrixOps {
    /// AVX-512 optimized matrix transpose for 8x8 blocks
    pub fn transpose_8x8_block(input: &[f64; 64], output: &mut [f64; 64]) {
        if !Avx512Ops::is_available() {
            // Fallback to scalar transpose
            for i in 0..8 {
                for j in 0..8 {
                    output[j * 8 + i] = input[i * 8 + j];
                }
            }
            return;
        }

        // In real AVX-512 implementation, this would use
        // _mm512_unpacklo_pd and _mm512_unpackhi_pd instructions
        // for efficient in-register transpose
        for i in 0..8 {
            for j in 0..8 {
                output[j * 8 + i] = input[i * 8 + j];
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    #[cfg(target_arch = "x86_64")]
    fn test_masked_add() {
        let a = Array1::from_vec(vec![1.0, 2.0, 3.0, 4.0, 5.0]);
        let b = Array1::from_vec(vec![10.0, 20.0, 30.0, 40.0, 50.0]);
        let mask = Array1::from_vec(vec![true, false, true, false, true]);

        let result = Avx512Ops::masked_add(&a.view(), &b.view(), &mask.view())
            .expect("masked_add should succeed for equal length arrays");

        assert_eq!(result[0], 11.0); // masked
        assert_eq!(result[1], 2.0); // not masked
        assert_eq!(result[2], 33.0); // masked
        assert_eq!(result[3], 4.0); // not masked
        assert_eq!(result[4], 55.0); // masked
    }

    #[test]
    #[cfg(target_arch = "x86_64")]
    fn test_gather() {
        let data = Array1::from_vec(vec![10.0, 20.0, 30.0, 40.0, 50.0]);
        let indices = Array1::from_vec(vec![4, 2, 0, 3, 1]);

        let result = Avx512Ops::gather(&data.view(), &indices.view())
            .expect("gather should succeed for valid indices");

        assert_eq!(result[0], 50.0);
        assert_eq!(result[1], 30.0);
        assert_eq!(result[2], 10.0);
        assert_eq!(result[3], 40.0);
        assert_eq!(result[4], 20.0);
    }

    #[test]
    #[cfg(target_arch = "x86_64")]
    fn test_scatter() {
        let values = Array1::from_vec(vec![100.0, 200.0, 300.0]);
        let indices = Array1::from_vec(vec![2, 0, 4]);

        let result = Avx512Ops::scatter(&values.view(), &indices.view(), 5)
            .expect("scatter should succeed for valid indices");

        assert_eq!(result[0], 200.0);
        assert_eq!(result[1], 0.0);
        assert_eq!(result[2], 100.0);
        assert_eq!(result[3], 0.0);
        assert_eq!(result[4], 300.0);
    }

    #[test]
    #[cfg(target_arch = "x86_64")]
    fn test_histogram() {
        let data = Array1::from_vec(vec![0.5, 1.5, 2.5, 3.5, 4.5, 0.2, 1.8, 2.2, 3.8, 4.2]);

        let hist = Avx512Ops::histogram(&data.view(), 5, 0.0, 5.0)
            .expect("histogram should succeed for valid parameters");

        assert_eq!(hist[0], 2); // 0.5, 0.2
        assert_eq!(hist[1], 2); // 1.5, 1.8
        assert_eq!(hist[2], 2); // 2.5, 2.2
        assert_eq!(hist[3], 2); // 3.5, 3.8
        assert_eq!(hist[4], 2); // 4.5, 4.2
    }
}