autodj 0.5.3

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
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183

//! Generic data structure which implements [`Dual`]

use std::{
    borrow::BorrowMut,
    fmt::{Display, LowerExp},
    ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Neg, Sub, SubAssign},
};

use crate::fluid::{display_impl, lower_exp_impl, Dual, Grad, Value};

/// Default generic [`Dual`] implementor: a struct with two fields
#[derive(Clone, Debug, PartialEq, PartialOrd, Default, Hash)]
pub struct DualNumber<N, D>
where
    N: Value,
    D: Grad<N>,
{
    /// actual value
    value: N,
    /// derivatives (dual components)
    dual: D,
}

impl<N, D> Neg for DualNumber<N, D>
where
    N: Value,
    D: Grad<N>,
{
    type Output = Self;

    fn neg(self) -> Self::Output {
        self.neg_impl()
    }
}

impl<N, D> SubAssign for DualNumber<N, D>
where
    N: Value,
    D: Grad<N>,
{
    fn sub_assign(&mut self, rhs: Self) {
        let _unused = self.sub_assign_impl(&rhs);
    }
}

impl<N, D> MulAssign for DualNumber<N, D>
where
    N: Value,
    D: Grad<N>,
{
    fn mul_assign(&mut self, rhs: Self) {
        let _unused = self.mul_assign_impl(&rhs);
    }
}

impl<N, D> DivAssign for DualNumber<N, D>
where
    N: Value,
    D: Grad<N>,
{
    fn div_assign(&mut self, rhs: Self) {
        let _unused = self.div_assign_impl(&rhs);
    }
}

impl<N, D> AddAssign for DualNumber<N, D>
where
    N: Value,
    D: Grad<N>,
{
    fn add_assign(&mut self, rhs: Self) {
        let _unused = self.add_assign_impl(&rhs);
    }
}

impl<N, D> Div for DualNumber<N, D>
where
    N: Value,
    D: Grad<N>,
{
    type Output = Self;
    fn div(self, rhs: Self) -> Self::Output {
        self.div_impl(&rhs)
    }
}

impl<N, D> Sub for DualNumber<N, D>
where
    N: Value,
    D: Grad<N>,
{
    type Output = Self;
    fn sub(self, rhs: Self) -> Self::Output {
        self.sub_impl(&rhs)
    }
}

impl<N, D> Mul for DualNumber<N, D>
where
    N: Value,
    D: Grad<N>,
{
    type Output = Self;
    fn mul(self, rhs: Self) -> Self::Output {
        self.mul_impl(&rhs)
    }
}

impl<N, D> Add for DualNumber<N, D>
where
    N: Value,
    D: Grad<N>,
{
    type Output = Self;

    fn add(self, rhs: Self) -> Self::Output {
        self.add_impl(&rhs)
    }
}

impl<N, D> Dual for DualNumber<N, D>
where
    N: Value,
    D: Grad<N>,
{
    type Value = N;

    fn value(&self) -> &Self::Value {
        &self.value
    }

    fn value_mut(&mut self) -> &mut Self::Value {
        self.value.borrow_mut()
    }

    type Grad = D;

    fn dual(&self) -> &Self::Grad {
        &self.dual
    }

    fn dual_mut(&mut self) -> &mut Self::Grad {
        self.dual.borrow_mut()
    }

    fn new(real: Self::Value, dual: Self::Grad) -> Self {
        Self { value: real, dual }
    }

    fn decompose(self) -> (Self::Value, Self::Grad) {
        (self.value, self.dual)
    }
}

impl<V: Value, G: Grad<V>> From<V> for DualNumber<V, G> {
    fn from(value: V) -> Self {
        Self::parameter(value)
    }
}

impl<V: Value + Display, G: Grad<V> + Display> Display for DualNumber<V, G> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        display_impl(self, f)
    }
}

impl<V: Value + LowerExp, G: Grad<V> + LowerExp> LowerExp for DualNumber<V, G> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        lower_exp_impl(self, f)
    }
}

impl<N, D> Copy for DualNumber<N, D>
where
    N: Value + Copy,
    D: Grad<N> + Copy,
{
}

pub mod array;
pub mod single;
pub mod sparse;
pub mod vector;