scir-core 0.3.2

SciR core utilities: numeric tolerances, complex helpers, and shared test macros for the SciR ecosystem (SciPy rebuilt for Rust).
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

//! Core utilities for SciR.
//!
//! This crate provides shared numeric helpers and the `assert_close!` macro
//! used across SciR crates to compare floating‑point (real/complex) values
//! within absolute/relative tolerances.

#![deny(missing_docs)]

use ndarray::Array1;
use num_complex::Complex64;

/// Assert that two scalars are close within absolute (`atol`) and relative (`rtol`) tolerances.
///
/// # Examples
/// ```
/// scir_core::assert_close_scalar(1.0, 1.0 + 1e-9, 1e-8, 1e-8);
/// ```
pub fn assert_close_scalar(left: f64, right: f64, atol: f64, rtol: f64) {
    let diff = (left - right).abs();
    let tol = atol + rtol * right.abs();
    assert!(
        diff <= tol,
        "expected |{left} - {right}| <= {tol}, got {diff}"
    );
}

/// Assert that two `&[f64]` slices are elementwise close within tolerances.
///
/// # Examples
/// ```
/// let a = [1.0, 2.0, 3.0];
/// let b = [1.0 + 1e-9, 2.0, 3.0];
/// scir_core::assert_close_slice(&a, &b, 1e-8, 1e-8);
/// ```
pub fn assert_close_slice(left: &[f64], right: &[f64], atol: f64, rtol: f64) {
    assert_eq!(left.len(), right.len(), "length mismatch");
    for (l, r) in left.iter().zip(right.iter()) {
        assert_close_scalar(*l, *r, atol, rtol);
    }
}

/// Assert that two `&[Complex64]` slices are elementwise close within tolerances (by magnitude).
///
/// # Examples
/// ```
/// use num_complex::Complex64;
/// let a = [Complex64::new(1.0, 0.0)];
/// let b = [Complex64::new(1.0 + 1e-12, 1e-12)];
/// scir_core::assert_close_complex_slice(&a, &b, 1e-8, 1e-8);
/// ```
pub fn assert_close_complex_slice(left: &[Complex64], right: &[Complex64], atol: f64, rtol: f64) {
    assert_eq!(left.len(), right.len(), "length mismatch");
    for (l, r) in left.iter().zip(right.iter()) {
        let diff = (*l - *r).norm();
        let tol = atol + r.norm() * rtol;
        assert!(diff <= tol, "expected |{l:?} - {r:?}| <= {tol}, got {diff}");
    }
}

/// Assert that two `Array1<f64>` are elementwise close within tolerances.
///
/// # Examples
/// ```
/// use ndarray::Array1;
/// let a = Array1::from_vec(vec![1.0, 2.0]);
/// let b = Array1::from_vec(vec![1.0 + 1e-9, 2.0]);
/// scir_core::assert_close_array1(&a, &b, 1e-8, 1e-8);
/// ```
pub fn assert_close_array1(left: &Array1<f64>, right: &Array1<f64>, atol: f64, rtol: f64) {
    assert_eq!(left.len(), right.len(), "length mismatch");
    for (l, r) in left.iter().zip(right.iter()) {
        assert_close_scalar(*l, *r, atol, rtol);
    }
}

/// Assert that two `Array1<Complex64>` are elementwise close within tolerances (by magnitude).
///
/// # Examples
/// ```
/// use ndarray::Array1;
/// use num_complex::Complex64;
/// let a = Array1::from_vec(vec![Complex64::new(1.0, 0.0)]);
/// let b = Array1::from_vec(vec![Complex64::new(1.0 + 1e-12, 1e-12)]);
/// scir_core::assert_close_complex_array1(&a, &b, 1e-8, 1e-8);
/// ```
pub fn assert_close_complex_array1(
    left: &Array1<Complex64>,
    right: &Array1<Complex64>,
    atol: f64,
    rtol: f64,
) {
    assert_eq!(left.len(), right.len(), "length mismatch");
    for (l, r) in left.iter().zip(right.iter()) {
        let diff = (*l - *r).norm();
        let tol = atol + r.norm() * rtol;
        assert!(diff <= tol, "expected |{l:?} - {r:?}| <= {tol}, got {diff}");
    }
}

/// Assert numeric closeness with a flexible interface (scalars, slices, arrays, real/complex).
///
/// Examples:
/// - `assert_close!(a, b, atol = 1e-8, rtol = 1e-8);`
/// - `assert_close!(&xs, &ys, slice, tol = 1e-9);`
/// - `assert_close!(&xa, &ya, complex_array, atol = 1e-9, rtol = 1e-9);`
#[macro_export]
macro_rules! assert_close {
    ($left:expr, $right:expr, atol = $atol:expr, rtol = $rtol:expr) => {{
        $crate::assert_close_scalar($left as f64, $right as f64, $atol, $rtol);
    }};
    ($left:expr, $right:expr, tol = $tol:expr) => {{
        $crate::assert_close_scalar($left as f64, $right as f64, $tol, 0.0);
    }};
    ($left:expr, $right:expr, slice, atol = $atol:expr, rtol = $rtol:expr) => {{
        $crate::assert_close_slice($left, $right, $atol, $rtol);
    }};
    ($left:expr, $right:expr, slice, tol = $tol:expr) => {{
        $crate::assert_close_slice($left, $right, $tol, 0.0);
    }};
    ($left:expr, $right:expr, complex_slice, atol = $atol:expr, rtol = $rtol:expr) => {{
        $crate::assert_close_complex_slice($left, $right, $atol, $rtol);
    }};
    ($left:expr, $right:expr, complex_slice, tol = $tol:expr) => {{
        $crate::assert_close_complex_slice($left, $right, $tol, 0.0);
    }};
    ($left:expr, $right:expr, array, atol = $atol:expr, rtol = $rtol:expr) => {{
        $crate::assert_close_array1($left, $right, $atol, $rtol);
    }};
    ($left:expr, $right:expr, array, tol = $tol:expr) => {{
        $crate::assert_close_array1($left, $right, $tol, 0.0);
    }};
    ($left:expr, $right:expr, complex_array, atol = $atol:expr, rtol = $rtol:expr) => {{
        $crate::assert_close_complex_array1($left, $right, $atol, $rtol);
    }};
    ($left:expr, $right:expr, complex_array, tol = $tol:expr) => {{
        $crate::assert_close_complex_array1($left, $right, $tol, 0.0);
    }};
}

#[cfg(test)]
mod tests {
    use super::*;
    use ndarray::Array1;
    use num_complex::Complex64;

    #[test]
    fn macro_works() {
        assert_close!(1.0, 1.0 + 1e-9, atol = 1e-8, rtol = 1e-8);
        assert_close!(1.0f32, 1.0f32 + 1e-6, tol = 1e-5);
    }

    #[test]
    fn slice_macro() {
        let a = [1.0, 2.0, 3.0];
        let b = [1.0 + 1e-9, 2.0 - 1e-9, 3.0];
        assert_close!(&a, &b, slice, atol = 1e-8, rtol = 1e-8);
    }

    #[test]
    fn complex_slice_macro() {
        let a = [Complex64::new(1.0, 2.0), Complex64::new(0.5, -0.5)];
        let b = [Complex64::new(1.0, 2.0 + 1e-9), Complex64::new(0.5, -0.5)];
        assert_close!(&a, &b, complex_slice, tol = 1e-8);
    }

    #[test]
    fn array_macro() {
        let a = Array1::from_vec(vec![1.0, 2.0, 3.0]);
        let b = Array1::from_vec(vec![1.0 + 1e-9, 2.0 - 1e-9, 3.0]);
        assert_close!(&a, &b, array, atol = 1e-8, rtol = 1e-8);
    }

    #[test]
    fn complex_array_macro() {
        let a = Array1::from_vec(vec![Complex64::new(1.0, 2.0), Complex64::new(0.5, -0.5)]);
        let b = Array1::from_vec(vec![
            Complex64::new(1.0, 2.0 + 1e-9),
            Complex64::new(0.5, -0.5),
        ]);
        assert_close!(&a, &b, complex_array, tol = 1e-8);
    }
}