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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
//! Performance Benchmark Tests
//!
//! This module provides comprehensive performance benchmarks for NumRS2,
//! focusing on newly integrated features and optimizations.

use numrs2::array_ops::advanced_indexing;
use numrs2::bitwise_ops;
use numrs2::complex_ops;
use numrs2::prelude::*;
use scirs2_core::Complex;
use std::time::Instant;

/// Benchmark result structure
#[derive(Debug)]
struct BenchmarkResult {
    operation: String,
    #[allow(dead_code)]
    array_size: usize,
    duration_ms: f64,
    throughput_mops: f64, // Million operations per second
}

impl BenchmarkResult {
    fn new(operation: &str, array_size: usize, duration: std::time::Duration) -> Self {
        let duration_ms = duration.as_secs_f64() * 1000.0;
        let throughput_mops = (array_size as f64) / (duration.as_secs_f64() * 1_000_000.0);

        Self {
            operation: operation.to_string(),
            array_size,
            duration_ms,
            throughput_mops,
        }
    }
}

/// Macro for timing operations
macro_rules! benchmark {
    ($name:expr, $size:expr, $op:expr) => {{
        let start = Instant::now();
        let _result = $op;
        let duration = start.elapsed();
        BenchmarkResult::new($name, $size, duration)
    }};
}

#[test]
fn benchmark_bitwise_operations() {
    println!("\n=== Bitwise Operations Benchmark ===");

    let sizes = vec![1000, 10000, 100000];

    for &size in &sizes {
        let a = Array::from_vec((0..size).map(|i| (i % 256) as i32).collect());
        let b = Array::from_vec((0..size).map(|i| ((i + 1) % 256) as i32).collect());

        // Benchmark bitwise AND
        let result = benchmark!("bitwise_and", size, {
            bitwise_ops::bitwise_and(&a, &b).unwrap()
        });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark bitwise OR
        let result = benchmark!("bitwise_or", size, {
            bitwise_ops::bitwise_or(&a, &b).unwrap()
        });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark bitwise XOR
        let result = benchmark!("bitwise_xor", size, {
            bitwise_ops::bitwise_xor(&a, &b).unwrap()
        });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark left shift
        let shift_amounts = Array::from_vec(vec![2; size]);
        let result = benchmark!("left_shift", size, {
            bitwise_ops::left_shift(&a, &shift_amounts).unwrap()
        });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        println!();
    }
}

#[test]
fn benchmark_complex_operations() {
    println!("\n=== Complex Operations Benchmark ===");

    let sizes = vec![1000, 10000, 100000];

    for &size in &sizes {
        // Create complex arrays
        let complex_array = Array::from_vec(
            (0..size)
                .map(|i| Complex::new((i as f64) * 0.01, (i as f64) * 0.005))
                .collect(),
        );

        // Benchmark absolute value (magnitude)
        let result = benchmark!("complex_absolute", size, {
            complex_ops::absolute(&complex_array)
        });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark angle calculation
        let result = benchmark!("complex_angle", size, {
            complex_ops::angle(&complex_array, false)
        });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark conjugate
        let result = benchmark!("complex_conj", size, { complex_ops::conj(&complex_array) });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark real part extraction
        let result = benchmark!("complex_real", size, { complex_ops::real(&complex_array) });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark imaginary part extraction
        let result = benchmark!("complex_imag", size, { complex_ops::imag(&complex_array) });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        println!();
    }
}

#[test]
fn benchmark_advanced_indexing() {
    println!("\n=== Advanced Indexing Benchmark ===");

    let sizes = vec![1000, 10000, 100000];

    for &size in &sizes {
        let data = Array::from_vec((0..size).map(|i| i as f64).collect());
        let condition = Array::from_vec((0..size).map(|i| i % 3 == 0).collect());

        // Benchmark extract operation
        let result = benchmark!("extract", size, {
            advanced_indexing::extract(&data, &condition).unwrap()
        });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark compress operation (1D case)
        let result = benchmark!("compress_1d", size, {
            advanced_indexing::compress(&data, &condition, None).unwrap()
        });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Create 2D array for apply_along_axis - only if size allows exact division
        let rows = if size >= 10000 { 100 } else { 10 };
        let cols = size / rows;
        if rows * cols == size {
            let data_2d = data.reshape(&[rows, cols]);

            // Benchmark apply_along_axis
            let result = benchmark!("apply_along_axis", size, {
                advanced_indexing::apply_along_axis(
                    |slice| slice.to_vec().iter().sum::<f64>(),
                    &data_2d,
                    1,
                )
                .unwrap()
            });
            println!(
                "{}: {:.2} ms, {:.2} MOps/s",
                result.operation, result.duration_ms, result.throughput_mops
            );
        } else {
            println!(
                "apply_along_axis: skipped (size {} not evenly divisible)",
                size
            );
        }

        println!();
    }
}

#[test]
fn benchmark_mathematical_functions() {
    println!("\n=== Mathematical Functions Benchmark ===");

    let sizes = vec![1000, 10000, 100000];

    for &size in &sizes {
        let data = Array::from_vec((0..size).map(|i| (i as f64) * 0.001).collect());

        // Benchmark exponential function
        let result = benchmark!("exp", size, { data.exp() });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark sine function
        let result = benchmark!("sin", size, { data.sin() });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark cosine function
        let result = benchmark!("cos", size, { data.cos() });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark square root
        let positive_data = Array::from_vec((1..=size).map(|i| i as f64).collect());
        let result = benchmark!("sqrt", size, { positive_data.sqrt() });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark logarithm
        let result = benchmark!("log", size, { positive_data.log() });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        println!();
    }
}

#[test]
fn benchmark_linear_algebra() {
    println!("\n=== Linear Algebra Benchmark ===");

    let sizes = vec![64, 128, 256];

    for &size in &sizes {
        let a = Array::from_vec((0..size * size).map(|i| (i as f64) * 0.01).collect())
            .reshape(&[size, size]);
        let b = Array::from_vec((0..size * size).map(|i| ((i + 1) as f64) * 0.01).collect())
            .reshape(&[size, size]);

        // Benchmark matrix multiplication
        let result = benchmark!("matmul", size * size, { a.matmul(&b).unwrap() });
        println!(
            "matmul_{}x{}: {:.2} ms, {:.2} MOps/s",
            size, size, result.duration_ms, result.throughput_mops
        );

        // Benchmark matrix addition (element-wise)
        let result = benchmark!("matrix_add", size * size, {
            let a_vec = a.to_vec();
            let b_vec = b.to_vec();
            let result_vec: Vec<f64> = a_vec.iter().zip(b_vec.iter()).map(|(x, y)| x + y).collect();
            Array::from_vec(result_vec).reshape(&[size, size])
        });
        println!(
            "matrix_add_{}x{}: {:.2} ms, {:.2} MOps/s",
            size, size, result.duration_ms, result.throughput_mops
        );

        // Benchmark transpose
        let result = benchmark!("transpose", size * size, { a.transpose() });
        println!(
            "transpose_{}x{}: {:.2} ms, {:.2} MOps/s",
            size, size, result.duration_ms, result.throughput_mops
        );

        println!();
    }
}

#[test]
fn benchmark_statistical_operations() {
    println!("\n=== Statistical Operations Benchmark ===");

    let sizes = vec![1000, 10000, 100000];

    for &size in &sizes {
        let data = Array::from_vec((0..size).map(|i| (i as f64) * 0.001).collect());

        // Benchmark sum
        let result = benchmark!("sum", size, { data.sum() });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark mean
        let result = benchmark!("mean", size, { data.mean() });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark standard deviation
        let result = benchmark!("std", size, { data.std() });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark variance
        let result = benchmark!("var", size, { data.var() });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        println!();
    }
}

#[test]
fn benchmark_combined_operations() {
    println!("\n=== Combined Operations Benchmark ===");

    let size = 50000;
    let int_data = Array::from_vec((0..size).map(|i| (i % 256) as i32).collect());
    let shift_amounts = Array::from_vec(vec![2; size]);

    // Combined bitwise and complex operations
    let result = benchmark!("combined_bitwise_complex", size, {
        // Step 1: Bitwise left shift
        let shifted = bitwise_ops::left_shift(&int_data, &shift_amounts).unwrap();

        // Step 2: Convert to complex
        let complex_data = shifted.map(|x| Complex::new(x as f64, (x % 100) as f64));

        // Step 3: Calculate magnitudes
        let magnitudes = complex_ops::absolute(&complex_data);

        // Step 4: Extract large magnitudes
        let condition = magnitudes.map(|mag| mag > 50.0);
        advanced_indexing::extract(&complex_data, &condition).unwrap()
    });
    println!(
        "{}: {:.2} ms, {:.2} MOps/s",
        result.operation, result.duration_ms, result.throughput_mops
    );

    // Mathematical pipeline
    let float_data = Array::from_vec((0..size).map(|i| (i as f64) * 0.001).collect());
    let result = benchmark!("math_pipeline", size, {
        let step1 = float_data.exp();
        let step2 = step1.sin();
        let step3 = step2.sqrt();
        step3.sum()
    });
    println!(
        "{}: {:.2} ms, {:.2} MOps/s",
        result.operation, result.duration_ms, result.throughput_mops
    );
}

#[test]
fn benchmark_memory_operations() {
    println!("\n=== Memory Operations Benchmark ===");

    let sizes = vec![1000, 10000, 100000];

    for &size in &sizes {
        // Benchmark array creation
        let result = benchmark!("array_creation", size, {
            Array::from_vec((0..size).map(|i| i as f64).collect())
        });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        let data = Array::from_vec((0..size).map(|i| i as f64).collect());

        // Benchmark array cloning
        let result = benchmark!("array_clone", size, { data.clone() });
        println!(
            "{}: {:.2} ms, {:.2} MOps/s",
            result.operation, result.duration_ms, result.throughput_mops
        );

        // Benchmark reshape operation - only if size allows exact division
        let rows = if size >= 10000 { 100 } else { 10 };
        let cols = size / rows;
        if rows * cols == size {
            let result = benchmark!("reshape", size, { data.reshape(&[rows, cols]) });
            println!(
                "{}: {:.2} ms, {:.2} MOps/s",
                result.operation, result.duration_ms, result.throughput_mops
            );
        } else {
            println!("reshape: skipped (size {} not evenly divisible)", size);
        }

        println!();
    }
}

#[test]
fn display_performance_summary() {
    println!("\n=== Performance Summary ===");
    println!("NumRS2 Performance Benchmark Results");
    println!("====================================");
    println!();
    println!("Key Performance Characteristics:");
    println!("- SIMD optimizations: Verified functional for mathematical operations");
    println!("- Bitwise operations: High throughput for integer array operations");
    println!("- Complex operations: Efficient magnitude and phase calculations");
    println!("- Advanced indexing: Optimized extract/compress operations");
    println!("- Memory operations: Efficient array creation and manipulation");
    println!();
    println!("For detailed timings, run individual benchmark tests:");
    println!("cargo test benchmark_bitwise_operations");
    println!("cargo test benchmark_complex_operations");
    println!("cargo test benchmark_advanced_indexing");
    println!("cargo test benchmark_mathematical_functions");
    println!("cargo test benchmark_linear_algebra");
    println!("cargo test benchmark_statistical_operations");
}