autodiff 0.7.0

An automatic differentiation library
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

use super::F;
use cgmath::{AbsDiffEq, RelativeEq, UlpsEq};
use num_traits::Zero;

impl<V: PartialEq + AbsDiffEq<Epsilon = V>, D: PartialEq + Zero> AbsDiffEq for F<V, D> {
    type Epsilon = Self;
    fn default_epsilon() -> Self::Epsilon {
        F::cst(V::default_epsilon())
    }
    fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool {
        self.x.abs_diff_eq(&other.x, epsilon.x)
    }
}
impl<V: PartialEq + RelativeEq<Epsilon = V>, D: PartialEq + Zero> RelativeEq for F<V, D> {
    fn default_max_relative() -> Self::Epsilon {
        F::cst(V::default_max_relative())
    }

    fn relative_eq(
        &self,
        other: &Self,
        epsilon: Self::Epsilon,
        max_relative: Self::Epsilon,
    ) -> bool {
        self.x.relative_eq(&other.x, epsilon.x, max_relative.x)
    }
}
impl<V: PartialEq + UlpsEq<Epsilon = V>, D: PartialEq + Zero> UlpsEq for F<V, D> {
    fn default_max_ulps() -> u32 {
        V::default_max_ulps()
    }
    fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool {
        self.x.ulps_eq(&other.x, epsilon.x, max_ulps)
    }
}

#[cfg(test)]
mod tests {
    use crate::{F, F1};
    use cgmath::{BaseFloat, Matrix3, Vector3};
    // Generic multiply. This tests that F works with cgmath scalar types
    fn mul<T: BaseFloat>(m: Matrix3<T>, v: Vector3<T>) -> Vector3<T> {
        m * v
    }

    #[test]
    fn mtx_mul() {
        let data = [
            [F1::cst(1.0), F1::cst(2.0), F1::cst(3.0)],
            [F1::cst(4.0), F1::cst(5.0), F1::cst(6.0)],
            [F1::cst(7.0), F1::cst(8.0), F1::cst(9.0)],
        ];
        let mtx = Matrix3::from(data);
        let v = Vector3::from([F1::var(1.0); 3]);
        assert_eq!(
            mul(mtx, v),
            Vector3::from([
                F { x: 12.0, dx: 12.0 },
                F { x: 15.0, dx: 15.0 },
                F { x: 18.0, dx: 18.0 }
            ])
        );
    }
}