conspire/math/tensor/
test.rs

1use super::{Tensor, TensorError, TensorRank0};
2use crate::{ABS_TOL, REL_TOL, defeat_message};
3use std::{
4    cmp::PartialEq,
5    fmt::{self, Debug, Display, Formatter},
6};
7
8#[cfg(test)]
9use crate::EPSILON;
10
11#[cfg(test)]
12use super::{
13    TensorArray,
14    rank_1::{TensorRank1, list::TensorRank1List},
15};
16
17#[cfg(test)]
18pub trait ErrorTensor {
19    fn error_fd(&self, comparator: &Self, epsilon: &TensorRank0) -> Option<(bool, usize)>;
20}
21
22pub fn assert_eq<'a, T>(value_1: &'a T, value_2: &'a T) -> Result<(), TestError>
23where
24    T: Display + PartialEq,
25{
26    if value_1 == value_2 {
27        Ok(())
28    } else {
29        Err(TestError {
30            message: format!(
31                "\n\x1b[1;91mAssertion `left == right` failed.\n\x1b[0;91m  left: {value_1}\n right: {value_2}\x1b[0m"
32            ),
33        })
34    }
35}
36
37#[cfg(test)]
38pub fn assert_eq_from_fd<'a, T>(value: &'a T, value_fd: &'a T) -> Result<(), TestError>
39where
40    T: Display + ErrorTensor + Tensor,
41{
42    if let Some((failed, count)) = value.error_fd(value_fd, &(3.0 * EPSILON)) {
43        if failed {
44            let abs = value.sub_abs(value_fd);
45            let rel = value.sub_rel(value_fd);
46            Err(TestError {
47                message: format!(
48                    "\n\x1b[1;91mAssertion `left ≈= right` failed in {count} places.\n\x1b[0;91m  left: {value}\n right: {value_fd}\n   abs: {abs}\n   rel: {rel}\x1b[0m"
49                ),
50            })
51        } else {
52            println!(
53                "Warning: \n\x1b[1;93mAssertion `left ≈= right` was weak in {count} places.\x1b[0m"
54            );
55            Ok(())
56        }
57    } else {
58        Ok(())
59    }
60}
61
62pub fn assert_eq_within<'a, T>(
63    value_1: &'a T,
64    value_2: &'a T,
65    tol_abs: &TensorRank0,
66    tol_rel: &TensorRank0,
67) -> Result<(), TestError>
68where
69    T: Display + Tensor,
70{
71    if let Some(count) = value_1.error_count(value_2, tol_abs, tol_rel) {
72        let abs = value_1.sub_abs(value_2);
73        let rel = value_1.sub_rel(value_2);
74        Err(TestError {
75            message: format!(
76                "\n\x1b[1;91mAssertion `left ≈= right` failed in {count} places.\n\x1b[0;91m  left: {value_1}\n right: {value_2}\n   abs: {abs}\n   rel: {rel}\x1b[0m"
77            ),
78        })
79    } else {
80        Ok(())
81    }
82}
83
84pub fn assert_eq_within_tols<'a, T>(value_1: &'a T, value_2: &'a T) -> Result<(), TestError>
85where
86    T: Display + Tensor,
87{
88    assert_eq_within(value_1, value_2, &ABS_TOL, &REL_TOL)
89}
90
91pub struct TestError {
92    pub message: String,
93}
94
95impl Debug for TestError {
96    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
97        write!(
98            f,
99            "{}\n\x1b[0;2;31m{}\x1b[0m\n",
100            self.message,
101            defeat_message()
102        )
103    }
104}
105
106impl From<TensorError> for TestError {
107    fn from(error: TensorError) -> TestError {
108        Self {
109            message: error.to_string(),
110        }
111    }
112}
113
114#[test]
115#[should_panic(expected = "Assertion `left == right` failed.")]
116fn assert_eq_fail() {
117    assert_eq(&0.0, &1.0).unwrap()
118}
119
120#[test]
121#[should_panic(expected = "Assertion `left ≈= right` failed in 2 places.")]
122fn assert_eq_from_fd_fail() {
123    assert_eq_from_fd(
124        &TensorRank1::<3, 1>::new([1.0, 2.0, 3.0]),
125        &TensorRank1::<3, 1>::new([3.0, 2.0, 1.0]),
126    )
127    .unwrap()
128}
129
130#[test]
131fn assert_eq_from_fd_success() -> Result<(), TestError> {
132    assert_eq_from_fd(
133        &TensorRank1::<3, 1>::new([1.0, 2.0, 3.0]),
134        &TensorRank1::<3, 1>::new([1.0, 2.0, 3.0]),
135    )
136}
137
138#[test]
139fn assert_eq_from_fd_weak() -> Result<(), TestError> {
140    assert_eq_from_fd(
141        &TensorRank1List::<1, 1, 1>::new([[EPSILON * 1.01]]),
142        &TensorRank1List::<1, 1, 1>::new([[EPSILON * 1.02]]),
143    )
144}
145
146#[test]
147#[should_panic(expected = "Assertion `left ≈= right` failed in 2 places.")]
148fn assert_eq_within_tols_fail() {
149    assert_eq_within_tols(
150        &TensorRank1::<3, 1>::new([1.0, 2.0, 3.0]),
151        &TensorRank1::<3, 1>::new([3.0, 2.0, 1.0]),
152    )
153    .unwrap()
154}
conspire/math/tensor/test.rs

conspire/math/tensor/
test.rs
