russell_lab 1.11.0

Scientific laboratory for linear algebra and numerical mathematics
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

use super::Vector;
use crate::{array_approx_eq, AsArray1D};

/// Panics if two vectors are not approximately equal to each other
///
/// # Panics
///
/// 1. Will panic if the dimensions are different
/// 2. Will panic if NAN, INFINITY, or NEG_INFINITY is found
/// 3. Will panic if the absolute difference of components is greater than the tolerance
///
/// # Examples
///
/// ## Accepts small error
///
/// ```
/// use russell_lab::{vec_approx_eq, Vector};
///
/// fn main() {
///     let u = Vector::from(&[3.0000001, 2.0]);
///     let v = Vector::from(&[3.0,       2.0]);
///     vec_approx_eq(&u, &v, 1e-6);
/// }
/// ```
///
/// ## Panics on different value
///
/// ```should_panic
/// use russell_lab::{vec_approx_eq, Vector};
///
/// fn main() {
///     let u = Vector::from(&[3.0000001, 2.0]);
///     let v = Vector::from(&[4.0,       2.0]);
///     vec_approx_eq(&u, &v, 1e-6);
/// }
/// ```
pub fn vec_approx_eq<'a, T>(u: &Vector, v: &'a T, tol: f64)
where
    T: AsArray1D<'a, f64>,
{
    array_approx_eq(u.as_data(), v.as_slice(), tol);
}

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

#[cfg(test)]
mod tests {
    use super::vec_approx_eq;
    use crate::Vector;

    #[test]
    fn vec_approx_eq_works() {
        let u = Vector::from(&[1.0, 2.0, 3.0]);
        let v = Vector::from(&[1.0, 2.0, 3.01]);
        vec_approx_eq(&u, &v, 0.011);
    }

    #[test]
    #[should_panic(expected = "vectors are not approximately equal. diff[2] =")]
    fn vec_approx_eq_panics() {
        let u = Vector::from(&[1.0, 2.0, 3.0]);
        let v = Vector::from(&[1.0, 2.0, 3.01]);
        vec_approx_eq(&u, &v, 0.009);
    }
}