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
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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
//! Error function SIMD tests: erf, erfc, erfinv, erfcinv

use scirs2_core::ndarray::{array, Array1};
#[cfg(feature = "random")]
use scirs2_core::random::{thread_rng, Distribution, Uniform};

// =============================================================================
// =============================================================================
// Phase 45: Error Function Tests
// =============================================================================

use scirs2_core::ndarray_ext::elementwise::{erf_simd, erfc_simd};

/// Test erf(0) = 0
#[test]
fn test_erf_simd_f64_at_zero() {
    let x = array![0.0_f64];
    let result = erf_simd(&x.view());
    assert!(
        result[0].abs() < 1e-15,
        "erf(0) should be 0, got {}",
        result[0]
    );
}

/// Test erf(1) ≈ 0.8427007929497148
#[test]
fn test_erf_simd_f64_at_one() {
    let x = array![1.0_f64];
    let result = erf_simd(&x.view());
    let expected = 0.8427007929497148_f64;
    // A&S approximation has max error ~1.5e-7
    assert!(
        (result[0] - expected).abs() < 2e-6,
        "erf(1) should be {}, got {}",
        expected,
        result[0]
    );
}

/// Test erf is an odd function: erf(-x) = -erf(x)
#[test]
fn test_erf_simd_f64_odd_function() {
    let x_pos = array![0.5_f64, 1.0, 1.5, 2.0, 3.0];
    let x_neg = array![-0.5_f64, -1.0, -1.5, -2.0, -3.0];
    let result_pos = erf_simd(&x_pos.view());
    let result_neg = erf_simd(&x_neg.view());

    for i in 0..5 {
        assert!(
            (result_pos[i] + result_neg[i]).abs() < 1e-14,
            "erf({}) should equal -erf({}): {} vs {}",
            x_pos[i],
            x_neg[i],
            result_pos[i],
            result_neg[i]
        );
    }
}

/// Test erf approaches 1 for large positive x
#[test]
fn test_erf_simd_f64_large_positive() {
    let x = array![3.0_f64, 4.0, 5.0, 6.0];
    let result = erf_simd(&x.view());

    // erf(3) ≈ 0.99998, erf(4+) is very close to 1
    for i in 0..4 {
        assert!(
            (result[i] - 1.0).abs() < 1e-4,
            "erf({}) should be close to 1, got {}",
            x[i],
            result[i]
        );
    }
}

/// Test erf approaches -1 for large negative x
#[test]
fn test_erf_simd_f64_large_negative() {
    let x = array![-3.0_f64, -4.0, -5.0, -6.0];
    let result = erf_simd(&x.view());

    // erf(-3) ≈ -0.99998, erf(-4-) is very close to -1
    for i in 0..4 {
        assert!(
            (result[i] + 1.0).abs() < 1e-4,
            "erf({}) should be close to -1, got {}",
            x[i],
            result[i]
        );
    }
}

/// Test known values of erf
#[test]
fn test_erf_simd_f64_known_values() {
    // Known values from reference tables
    let x = array![0.5_f64, 1.0, 1.5, 2.0];
    let expected = [
        0.5204998778130465_f64, // erf(0.5)
        0.8427007929497148_f64, // erf(1.0)
        0.9661051464753108_f64, // erf(1.5)
        0.9953222650189527_f64, // erf(2.0)
    ];
    let result = erf_simd(&x.view());

    // A&S approximation has max error ~1.5e-7
    for i in 0..4 {
        assert!(
            (result[i] - expected[i]).abs() < 2e-6,
            "erf({}) should be {}, got {}",
            x[i],
            expected[i],
            result[i]
        );
    }
}

/// Test erf for very small x (linear regime)
#[test]
fn test_erf_simd_f64_small_values() {
    // For very small x, erf(x) ≈ 2x/√π
    let two_over_sqrt_pi = 2.0 / std::f64::consts::PI.sqrt();
    let x = array![1e-10_f64, 1e-8, 1e-6];
    let result = erf_simd(&x.view());

    for i in 0..3 {
        let expected = x[i] * two_over_sqrt_pi;
        assert!(
            (result[i] - expected).abs() / expected.abs() < 1e-10,
            "erf({}) should be approximately {}, got {}",
            x[i],
            expected,
            result[i]
        );
    }
}

/// Test erf(infinity) = 1
#[test]
fn test_erf_simd_f64_infinity() {
    let x = array![f64::INFINITY, f64::NEG_INFINITY];
    let result = erf_simd(&x.view());

    assert!(
        (result[0] - 1.0).abs() < 1e-10,
        "erf(∞) should be 1, got {}",
        result[0]
    );
    assert!(
        (result[1] + 1.0).abs() < 1e-10,
        "erf(-∞) should be -1, got {}",
        result[1]
    );
}

/// Test erf(NaN) = NaN
#[test]
fn test_erf_simd_f64_nan() {
    let x = array![f64::NAN];
    let result = erf_simd(&x.view());
    assert!(result[0].is_nan(), "erf(NaN) should be NaN");
}

/// Test erf f32 version
#[test]
fn test_erf_simd_f32_basic() {
    let x = array![0.0_f32, 1.0, 2.0, -1.0];
    let result = erf_simd(&x.view());

    assert!(
        result[0].abs() < 1e-7,
        "erf(0) should be 0, got {}",
        result[0]
    );
    assert!(
        (result[1] - 0.8427008_f32).abs() < 1e-5,
        "erf(1) should be ~0.8427, got {}",
        result[1]
    );
    assert!(
        (result[3] + 0.8427008_f32).abs() < 1e-5,
        "erf(-1) should be ~-0.8427, got {}",
        result[3]
    );
}

/// Test empty input for erf
#[test]
fn test_erf_simd_empty() {
    let x = array![] as Array1<f64>;
    let result = erf_simd(&x.view());
    assert!(result.is_empty(), "erf of empty array should be empty");
}

/// Test large array for erf (performance)
#[test]
fn test_erf_simd_large_array() {
    let n = 10000;
    let x: Array1<f64> = Array1::linspace(-3.0, 3.0, n);
    let result = erf_simd(&x.view());

    assert_eq!(result.len(), n);
    // Check bounds: -1 <= erf(x) <= 1
    for val in result.iter() {
        assert!(
            *val >= -1.0 - 1e-10 && *val <= 1.0 + 1e-10,
            "erf should be in [-1, 1], got {}",
            val
        );
    }
}

// =============================================================================
// Complementary Error Function (erfc) Tests
// =============================================================================

/// Test erfc(0) = 1
#[test]
fn test_erfc_simd_f64_at_zero() {
    let x = array![0.0_f64];
    let result = erfc_simd(&x.view());
    assert!(
        (result[0] - 1.0).abs() < 1e-15,
        "erfc(0) should be 1, got {}",
        result[0]
    );
}

/// Test erfc(1) ≈ 0.1572992070502852
#[test]
fn test_erfc_simd_f64_at_one() {
    let x = array![1.0_f64];
    let result = erfc_simd(&x.view());
    let expected = 0.1572992070502852_f64;
    // A&S approximation has max error ~1.5e-7
    assert!(
        (result[0] - expected).abs() < 2e-6,
        "erfc(1) should be {}, got {}",
        expected,
        result[0]
    );
}

/// Test erfc(-x) = 2 - erfc(x) (reflection property)
#[test]
fn test_erfc_simd_f64_reflection() {
    let x_pos = array![0.5_f64, 1.0, 1.5, 2.0];
    let x_neg = array![-0.5_f64, -1.0, -1.5, -2.0];
    let result_pos = erfc_simd(&x_pos.view());
    let result_neg = erfc_simd(&x_neg.view());

    for i in 0..4 {
        assert!(
            (result_neg[i] - (2.0 - result_pos[i])).abs() < 1e-14,
            "erfc({}) should equal 2 - erfc({}): {} vs {}",
            x_neg[i],
            x_pos[i],
            result_neg[i],
            2.0 - result_pos[i]
        );
    }
}

/// Test erfc approaches 0 for large positive x
#[test]
fn test_erfc_simd_f64_large_positive() {
    let x = array![3.0_f64, 4.0, 5.0, 6.0];
    let result = erfc_simd(&x.view());

    // erfc(3) ≈ 2.2e-5, erfc(4+) is very close to 0
    for i in 0..4 {
        assert!(
            result[i] < 1e-4,
            "erfc({}) should be close to 0, got {}",
            x[i],
            result[i]
        );
    }
}

/// Test erfc approaches 2 for large negative x
#[test]
fn test_erfc_simd_f64_large_negative() {
    let x = array![-3.0_f64, -4.0, -5.0, -6.0];
    let result = erfc_simd(&x.view());

    // erfc(-3) ≈ 1.99998, erfc(-4-) is very close to 2
    for i in 0..4 {
        assert!(
            (result[i] - 2.0).abs() < 1e-4,
            "erfc({}) should be close to 2, got {}",
            x[i],
            result[i]
        );
    }
}

/// Test consistency: erfc(x) = 1 - erf(x)
#[test]
fn test_erfc_simd_f64_consistency_with_erf() {
    let x = array![0.0_f64, 0.5, 1.0, 1.5, 2.0, -0.5, -1.0];
    let erf_result = erf_simd(&x.view());
    let erfc_result = erfc_simd(&x.view());

    for i in 0..x.len() {
        let expected = 1.0 - erf_result[i];
        assert!(
            (erfc_result[i] - expected).abs() < 1e-14,
            "erfc({}) should equal 1 - erf({}): got {} vs {}",
            x[i],
            x[i],
            erfc_result[i],
            expected
        );
    }
}

/// Test erfc(infinity) = 0, erfc(-infinity) = 2
#[test]
fn test_erfc_simd_f64_infinity() {
    let x = array![f64::INFINITY, f64::NEG_INFINITY];
    let result = erfc_simd(&x.view());

    assert!(
        result[0].abs() < 1e-10,
        "erfc(∞) should be 0, got {}",
        result[0]
    );
    assert!(
        (result[1] - 2.0).abs() < 1e-10,
        "erfc(-∞) should be 2, got {}",
        result[1]
    );
}

/// Test erfc(NaN) = NaN
#[test]
fn test_erfc_simd_f64_nan() {
    let x = array![f64::NAN];
    let result = erfc_simd(&x.view());
    assert!(result[0].is_nan(), "erfc(NaN) should be NaN");
}

/// Test erfc f32 version
#[test]
fn test_erfc_simd_f32_basic() {
    let x = array![0.0_f32, 1.0, 2.0];
    let result = erfc_simd(&x.view());

    assert!(
        (result[0] - 1.0).abs() < 1e-7,
        "erfc(0) should be 1, got {}",
        result[0]
    );
    assert!(
        (result[1] - 0.157299_f32).abs() < 1e-5,
        "erfc(1) should be ~0.157, got {}",
        result[1]
    );
}

/// Test empty input for erfc
#[test]
fn test_erfc_simd_empty() {
    let x = array![] as Array1<f64>;
    let result = erfc_simd(&x.view());
    assert!(result.is_empty(), "erfc of empty array should be empty");
}

/// Test normal distribution CDF using erf
/// Φ(x) = 0.5 * (1 + erf(x/√2))
#[test]
fn test_erf_simd_normal_cdf() {
    let sqrt_2 = std::f64::consts::SQRT_2;
    let x = array![0.0_f64, 1.0, -1.0, 2.0, -2.0];
    let x_scaled: Array1<f64> = x.mapv(|v| v / sqrt_2);
    let erf_result = erf_simd(&x_scaled.view());
    let cdf: Array1<f64> = erf_result.mapv(|v| 0.5 * (1.0 + v));

    // Known CDF values for standard normal
    let expected_cdf = [
        0.5_f64,              // Φ(0) = 0.5
        0.8413447460685429,   // Φ(1) ≈ 0.8413
        0.15865525393145707,  // Φ(-1) ≈ 0.1587
        0.9772498680518208,   // Φ(2) ≈ 0.9772
        0.022750131948179195, // Φ(-2) ≈ 0.0228
    ];

    for i in 0..5 {
        assert!(
            (cdf[i] - expected_cdf[i]).abs() < 1e-6,
            "Φ({}) should be {}, got {}",
            x[i],
            expected_cdf[i],
            cdf[i]
        );
    }
}

// =============================================================================
// Phase 46: Inverse Error Function Tests
// =============================================================================

use scirs2_core::ndarray_ext::elementwise::{erfcinv_simd, erfinv_simd};

/// Test erfinv(0) = 0
#[test]
fn test_erfinv_simd_f64_at_zero() {
    let y = array![0.0_f64];
    let result = erfinv_simd(&y.view());
    assert!(
        result[0].abs() < 1e-15,
        "erfinv(0) should be 0, got {}",
        result[0]
    );
}

/// Test erfinv is the inverse of erf: erf(erfinv(y)) = y
#[test]
fn test_erfinv_simd_f64_inverse_property() {
    let y = array![0.0_f64, 0.1, 0.3, 0.5, 0.7, 0.9, -0.3, -0.7];
    let x = erfinv_simd(&y.view());
    let y_back = erf_simd(&x.view());

    for i in 0..y.len() {
        assert!(
            (y[i] - y_back[i]).abs() < 1e-10,
            "erf(erfinv({})) should be {}, got {}",
            y[i],
            y[i],
            y_back[i]
        );
    }
}

/// Test erfinv is odd: erfinv(-y) = -erfinv(y)
#[test]
fn test_erfinv_simd_f64_odd_function() {
    let y_pos = array![0.1_f64, 0.3, 0.5, 0.7, 0.9];
    let y_neg = array![-0.1_f64, -0.3, -0.5, -0.7, -0.9];
    let result_pos = erfinv_simd(&y_pos.view());
    let result_neg = erfinv_simd(&y_neg.view());

    for i in 0..5 {
        assert!(
            (result_pos[i] + result_neg[i]).abs() < 1e-12,
            "erfinv({}) should equal -erfinv({}): {} vs {}",
            y_pos[i],
            y_neg[i],
            result_pos[i],
            result_neg[i]
        );
    }
}

/// Test erfinv at boundaries: erfinv(1) = ∞, erfinv(-1) = -∞
#[test]
fn test_erfinv_simd_f64_boundaries() {
    let y = array![1.0_f64, -1.0];
    let result = erfinv_simd(&y.view());

    assert!(
        result[0].is_infinite() && result[0] > 0.0,
        "erfinv(1) should be ∞, got {}",
        result[0]
    );
    assert!(
        result[1].is_infinite() && result[1] < 0.0,
        "erfinv(-1) should be -∞, got {}",
        result[1]
    );
}

/// Test erfinv outside domain returns NaN
#[test]
fn test_erfinv_simd_f64_outside_domain() {
    let y = array![1.5_f64, -1.5, 2.0, -3.0];
    let result = erfinv_simd(&y.view());

    for i in 0..4 {
        assert!(
            result[i].is_nan(),
            "erfinv({}) should be NaN, got {}",
            y[i],
            result[i]
        );
    }
}

/// Test erfinv(NaN) = NaN
#[test]
fn test_erfinv_simd_f64_nan() {
    let y = array![f64::NAN];
    let result = erfinv_simd(&y.view());
    assert!(result[0].is_nan(), "erfinv(NaN) should be NaN");
}

/// Test erfinv f32 version
#[test]
fn test_erfinv_simd_f32_basic() {
    let y = array![0.0_f32, 0.5, -0.5];
    let result = erfinv_simd(&y.view());

    assert!(
        result[0].abs() < 1e-7,
        "erfinv(0) should be 0, got {}",
        result[0]
    );
    // Verify inverse property for f32
    let y_back = erf_simd(&result.view());
    for i in 0..3 {
        assert!(
            (y[i] - y_back[i]).abs() < 1e-5,
            "erf(erfinv({})) should be {}, got {}",
            y[i],
            y[i],
            y_back[i]
        );
    }
}

/// Test empty input for erfinv
#[test]
fn test_erfinv_simd_empty() {
    let y = array![] as Array1<f64>;
    let result = erfinv_simd(&y.view());
    assert!(result.is_empty(), "erfinv of empty array should be empty");
}

/// Test large array for erfinv (performance)
#[test]
fn test_erfinv_simd_large_array() {
    let n = 10000;
    let y: Array1<f64> = Array1::linspace(-0.99, 0.99, n);
    let result = erfinv_simd(&y.view());

    assert_eq!(result.len(), n);
    // Verify inverse property
    let y_back = erf_simd(&result.view());
    for i in 0..n {
        assert!(
            (y[i] - y_back[i]).abs() < 1e-8,
            "erf(erfinv({})) roundtrip error too large: got {}",
            y[i],
            y_back[i]
        );
    }
}

// =============================================================================
// Inverse Complementary Error Function (erfcinv) Tests
// =============================================================================

/// Test erfcinv(1) = 0
#[test]
fn test_erfcinv_simd_f64_at_one() {
    let y = array![1.0_f64];
    let result = erfcinv_simd(&y.view());
    assert!(
        result[0].abs() < 1e-15,
        "erfcinv(1) should be 0, got {}",
        result[0]
    );
}

/// Test erfcinv is the inverse of erfc: erfc(erfcinv(y)) = y
#[test]
fn test_erfcinv_simd_f64_inverse_property() {
    let y = array![0.1_f64, 0.5, 1.0, 1.5, 1.9];
    let x = erfcinv_simd(&y.view());
    let y_back = erfc_simd(&x.view());

    for i in 0..y.len() {
        assert!(
            (y[i] - y_back[i]).abs() < 1e-10,
            "erfc(erfcinv({})) should be {}, got {}",
            y[i],
            y[i],
            y_back[i]
        );
    }
}

/// Test erfcinv at boundaries: erfcinv(0) = ∞, erfcinv(2) = -∞
#[test]
fn test_erfcinv_simd_f64_boundaries() {
    let y = array![0.0_f64, 2.0];
    let result = erfcinv_simd(&y.view());

    assert!(
        result[0].is_infinite() && result[0] > 0.0,
        "erfcinv(0) should be ∞, got {}",
        result[0]
    );
    assert!(
        result[1].is_infinite() && result[1] < 0.0,
        "erfcinv(2) should be -∞, got {}",
        result[1]
    );
}

/// Test erfcinv outside domain returns NaN
#[test]
fn test_erfcinv_simd_f64_outside_domain() {
    let y = array![-0.5_f64, 2.5, 3.0, -1.0];
    let result = erfcinv_simd(&y.view());

    for i in 0..4 {
        assert!(
            result[i].is_nan(),
            "erfcinv({}) should be NaN, got {}",
            y[i],
            result[i]
        );
    }
}

/// Test erfcinv(NaN) = NaN
#[test]
fn test_erfcinv_simd_f64_nan() {
    let y = array![f64::NAN];
    let result = erfcinv_simd(&y.view());
    assert!(result[0].is_nan(), "erfcinv(NaN) should be NaN");
}

/// Test erfcinv f32 version
#[test]
fn test_erfcinv_simd_f32_basic() {
    let y = array![1.0_f32, 0.5, 1.5];
    let result = erfcinv_simd(&y.view());

    assert!(
        result[0].abs() < 1e-6,
        "erfcinv(1) should be 0, got {}",
        result[0]
    );
    // Verify inverse property for f32
    let y_back = erfc_simd(&result.view());
    for i in 0..3 {
        assert!(
            (y[i] - y_back[i]).abs() < 1e-5,
            "erfc(erfcinv({})) should be {}, got {}",
            y[i],
            y[i],
            y_back[i]
        );
    }
}

/// Test empty input for erfcinv
#[test]
fn test_erfcinv_simd_empty() {
    let y = array![] as Array1<f64>;
    let result = erfcinv_simd(&y.view());
    assert!(result.is_empty(), "erfcinv of empty array should be empty");
}

/// Test consistency: erfcinv(y) = erfinv(1 - y)
#[test]
fn test_erfcinv_simd_f64_consistency_with_erfinv() {
    let y = array![0.5_f64, 1.0, 1.5];
    let erfcinv_result = erfcinv_simd(&y.view());
    let y_minus_one: Array1<f64> = y.mapv(|v| 1.0 - v);
    let erfinv_result = erfinv_simd(&y_minus_one.view());

    for i in 0..y.len() {
        assert!(
            (erfcinv_result[i] - erfinv_result[i]).abs() < 1e-10,
            "erfcinv({}) should equal erfinv({}): got {} vs {}",
            y[i],
            1.0 - y[i],
            erfcinv_result[i],
            erfinv_result[i]
        );
    }
}

/// Test inverse normal CDF (probit function) using erfinv
/// Φ⁻¹(p) = √2 * erfinv(2p - 1)
#[test]
fn test_erfinv_simd_inverse_normal_cdf() {
    let sqrt_2 = std::f64::consts::SQRT_2;

    // Known quantiles of standard normal
    let p = array![0.5_f64, 0.84134, 0.97725]; // Φ(0), Φ(1), Φ(2) approximately
    let expected_x = [0.0_f64, 1.0, 2.0];

    let two_p_minus_one: Array1<f64> = p.mapv(|v| 2.0 * v - 1.0);
    let erfinv_result = erfinv_simd(&two_p_minus_one.view());
    let probit: Array1<f64> = erfinv_result.mapv(|v| sqrt_2 * v);

    for i in 0..3 {
        assert!(
            (probit[i] - expected_x[i]).abs() < 0.01,
            "Φ⁻¹({}) should be approximately {}, got {}",
            p[i],
            expected_x[i],
            probit[i]
        );
    }
}