conspire 0.7.2

The Rust interface to conspire.
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

mod eq;
mod error;
mod fd;
mod fd_eq;

#[cfg(test)]
mod test;

pub use self::{eq::AssertEq, error::AssertionError, fd::FiniteDifference, fd_eq::AssertFd};

use self::eq::{zero_impl, zero_within_tols_impl};
use crate::{
    ABS_TOL, EPSILON, REL_TOL,
    math::{Scalar, Tensor},
};
use std::fmt::Display;

/// Specifies tolerances used by [`AssertEq`] functionalities.
pub struct Assert {
    pub abs_tol: Scalar,
    pub rel_tol: Scalar,
    pub fd_tol: Scalar,
}

impl Default for Assert {
    fn default() -> Self {
        Self {
            abs_tol: ABS_TOL,
            rel_tol: REL_TOL,
            fd_tol: 3.0 * EPSILON,
        }
    }
}

impl Assert {
    /// Asserts exact equality.
    pub fn eq<T, Rhs>(a: T, b: Rhs) -> Result<(), AssertionError>
    where
        T: AssertEq<Rhs>,
    {
        T::eq(a, b)
    }
    /// Asserts equality within `self.abs_tol` and `self.rel_tol`.
    pub fn eq_within_tols<T, Rhs>(&self, a: T, b: Rhs) -> Result<(), AssertionError>
    where
        T: AssertEq<Rhs>,
    {
        T::eq_within_tols(self, a, b)
    }
    /// Asserts finite-difference equality within `self.fd_tol`.
    pub fn eq_within_fd_tol<T, Rhs>(&self, a: T, b: Rhs) -> Result<(), AssertionError>
    where
        T: AssertFd<Rhs>,
    {
        T::eq_within_fd_tol(self, a, b)
    }
    /// Asserts exact equality with zero.
    pub fn zero<T>(a: &T) -> Result<(), AssertionError>
    where
        T: Display + Tensor,
    {
        zero_impl(a)
    }
    /// Asserts equality with zero within `self.abs_tol` and `self.rel_tol`.
    pub fn zero_within_tols<T>(&self, a: &T) -> Result<(), AssertionError>
    where
        T: Display + Tensor,
    {
        zero_within_tols_impl(self, a)
    }
}