echidna 0.9.0

A high-performance automatic differentiation library 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

//! The [`Scalar`] trait for writing AD-generic numeric code.
//!
//! Functions written as `fn f<T: Scalar>(x: T) -> T` work transparently with plain
//! `f64`, `Dual<f64>`, `Reverse<f64>`, `BReverse<f64>`, and `Taylor<f64, K>`.

use std::fmt::{Debug, Display};

use num_traits::FromPrimitive;

use crate::dual::Dual;
use crate::dual_vec::DualVec;
use crate::float::Float;
use crate::reverse::Reverse;
use crate::tape::TapeThreadLocal;

/// The central trait for AD-generic numeric code.
///
/// Implement functions as `fn foo<T: Scalar>(x: T) -> T` and they work
/// with plain `f64`, `Dual<f64>`, and `Reverse<f64>`.
pub trait Scalar:
    num_traits::Float
    + num_traits::FloatConst
    + FromPrimitive
    + Copy
    + Default
    + Debug
    + Display
    + Send
    + 'static
{
    /// The underlying primitive float type.
    type Float: Float;

    /// Lift a plain float to this scalar (constant — zero derivative).
    fn from_f(val: Self::Float) -> Self;

    /// Extract the primal value.
    fn value(&self) -> Self::Float;
}

impl Scalar for f32 {
    type Float = f32;

    #[inline]
    fn from_f(val: f32) -> Self {
        val
    }

    #[inline]
    fn value(&self) -> f32 {
        *self
    }
}

impl Scalar for f64 {
    type Float = f64;

    #[inline]
    fn from_f(val: f64) -> Self {
        val
    }

    #[inline]
    fn value(&self) -> f64 {
        *self
    }
}

impl<F: Float> Scalar for Dual<F> {
    type Float = F;

    #[inline]
    fn from_f(val: F) -> Self {
        Dual::constant(val)
    }

    #[inline]
    fn value(&self) -> F {
        self.re
    }
}

impl<F: Float, const N: usize> Scalar for DualVec<F, N> {
    type Float = F;

    #[inline]
    fn from_f(val: F) -> Self {
        DualVec::constant(val)
    }

    #[inline]
    fn value(&self) -> F {
        self.re
    }
}

impl<F: Float + TapeThreadLocal> Scalar for Reverse<F> {
    type Float = F;

    #[inline]
    fn from_f(val: F) -> Self {
        Reverse::constant(val)
    }

    #[inline]
    fn value(&self) -> F {
        self.value
    }
}

#[cfg(feature = "taylor")]
impl<F: Float, const K: usize> Scalar for crate::taylor::Taylor<F, K> {
    type Float = F;

    #[inline]
    fn from_f(val: F) -> Self {
        crate::taylor::Taylor::constant(val)
    }

    #[inline]
    fn value(&self) -> F {
        self.coeffs[0]
    }
}

#[cfg(feature = "taylor")]
impl<F: Float + crate::taylor_dyn::TaylorArenaLocal> Scalar for crate::taylor_dyn::TaylorDyn<F> {
    type Float = F;

    #[inline]
    fn from_f(val: F) -> Self {
        crate::taylor_dyn::TaylorDyn::constant(val)
    }

    #[inline]
    fn value(&self) -> F {
        self.value
    }
}

#[cfg(feature = "laurent")]
impl<F: Float, const K: usize> Scalar for crate::laurent::Laurent<F, K> {
    type Float = F;

    #[inline]
    fn from_f(val: F) -> Self {
        crate::laurent::Laurent::constant(val)
    }

    #[inline]
    fn value(&self) -> F {
        crate::laurent::Laurent::value(self)
    }
}

#[cfg(feature = "bytecode")]
impl<F: Float + crate::bytecode_tape::BtapeThreadLocal> Scalar for crate::breverse::BReverse<F> {
    type Float = F;

    #[inline]
    fn from_f(val: F) -> Self {
        crate::breverse::BReverse::constant(val)
    }

    #[inline]
    fn value(&self) -> F {
        self.value
    }
}