rustad 0.0.0

A rust 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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230

// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
// SPDX-FileCopyrightText: Bradley M. Bell <bradbell@seanet.com>
// SPDX-FileContributor: 2025 Bradley M. Bell
//
//! Evaluate the Mul operators
//!
//! Link to [parent module](super)
//!
//! * V : see [doc_generic_v](crate::doc_generic_v)
//! * E : see [doc_generic_e](crate::adfn::doc_generic_e)
//!
//! * [op::id](crate::op::id)
//!     * MUL_CV_OP : constant * variable
//!     * MUL_VC_OP : variable * constant
//!     * MUL_VV_OP : variable * variable
//!
//! * arg
//!     * arg\[0\]:  Variable or constant index of left operand.
//!     * arg\[1\]:  Variable or constant index of right operand.
// --------------------------------------------------------------------------
// use
//
use crate::op::binary;
use crate::tape::sealed::ThisThreadTape;
use crate::IndexT;
use crate::ad::AD;
use crate::op::info::OpInfo;
use crate::op::id::{
    MUL_CV_OP,
    MUL_VC_OP,
    MUL_VV_OP,
};
#[cfg(doc)]
use crate::op::info::{
        ForwardOne,
        ReverseOne,
};
// -------------------------------------------------------------------------
// rust_src
// -------------------------------------------------------------------------
// mul_cv_rust_src
// mul_vc_rust_src
// mul_vv_rust_src
binary::binary_rust_src!(Mul, *);
// -------------------------------------------------------------------------
// forward_0
// -------------------------------------------------------------------------
// mul_cv_forward_0
// mul_vc_forward_0
// mul_vv_forward_0
binary::eval_binary_forward_0!(Mul, *);
// ---------------------------------------------------------------------------
// forward_1
// ---------------------------------------------------------------------------
//
// mul_cv_forward_1
/// first order forward for constant * variable; see [ForwardOne]
fn mul_cv_forward_1 <V, E>(
    _var_zero  :   &Vec<E>     ,
    var_one    :   &mut Vec<E> ,
    con        :   &Vec<V>     ,
    _flag      :   &Vec<bool>  ,
    arg        :   &[IndexT]   ,
    res        :       usize   )
where
    for<'a> &'a V : std::ops::Mul<&'a E, Output = E> ,
{
    debug_assert!( arg.len() == 2);
    let lhs = arg[0] as usize;
    let rhs = arg[1] as usize;
    var_one[ res ] = &con[lhs] * &var_one[rhs];
}
//
// mul_vc_forward_1
/// first order forward for variable * constant; see [ForwardOne]
fn mul_vc_forward_1 <V, E>(
    _var_zero  :   &Vec<E>     ,
    var_one    :   &mut Vec<E> ,
    con        :   &Vec<V>     ,
    _flag      :   &Vec<bool>  ,
    arg        :   &[IndexT]   ,
    res        :       usize   )
where
    for<'a> &'a E : std::ops::Mul<&'a V, Output = E> ,
{
    debug_assert!( arg.len() == 2);
    let lhs = arg[0] as usize;
    let rhs = arg[1] as usize;
    var_one[ res ] = &var_one[lhs] * &con[rhs];
}
//
// mul_vv_forward_1
/// first order forward for variable * variable; see [ForwardOne]
fn mul_vv_forward_1 <V, E>(
    var_zero   :   &Vec<E>     ,
    var_one    :   &mut Vec<E> ,
    _con       :   &Vec<V>     ,
    _flag      :   &Vec<bool>  ,
    arg        :   &[IndexT]   ,
    res        :       usize   )
where
    for<'a> &'a E : std::ops::Add<&'a E, Output = E> ,
    for<'a> &'a E : std::ops::Mul<&'a E, Output = E> ,
{
    debug_assert!( arg.len() == 2);
    let lhs = arg[0] as usize;
    let rhs = arg[1] as usize;
    let term1    = &var_zero[lhs]  * &var_one[rhs];
    let term2    = &var_one[lhs]   * &var_zero[rhs];
    var_one[res] = &term1 + &term2;
}
// ---------------------------------------------------------------------------
// reverse_1
// ---------------------------------------------------------------------------
//
// mul_cv_reverse_1
/// first order reverse for constant * variable; see [ReverseOne]
fn mul_cv_reverse_1 <V, E>(
    _var_zero  :   &Vec<E>     ,
    var_one    :   &mut Vec<E> ,
    con        :   &Vec<V>     ,
    _flag      :   &Vec<bool>  ,
    arg        :   &[IndexT]   ,
    res        :       usize   )
where
    for<'a> E : std::ops::AddAssign<&'a E> ,
    for<'a> &'a E : std::ops::Mul<&'a V, Output = E> ,
{
    debug_assert!( arg.len() == 2);
    let lhs = arg[0] as usize;
    let rhs = arg[1] as usize;
    let term      = &var_one[res] * &con[lhs];
    var_one[rhs] += &term;
}
//
// mul_vc_reverse_1
/// first order reverse for variable * constant; see [ReverseOne]
fn mul_vc_reverse_1 <V, E>(
    _var_zero  :   &Vec<E>     ,
    var_one    :   &mut Vec<E> ,
    con        :   &Vec<V>     ,
    _flag      :   &Vec<bool>  ,
    arg        :   &[IndexT]   ,
    res        :       usize   )
where
    for<'a> E : std::ops::AddAssign<&'a E> ,
    for<'a> &'a E : std::ops::Mul<&'a V, Output = E> ,
{
    debug_assert!( arg.len() == 2);
    let lhs = arg[0] as usize;
    let rhs = arg[1] as usize;
    let term      = &var_one[res] * &con[rhs];
    var_one[lhs] += &term;
}
//
// mul_vv_reverse_1
/// first order reverse for variable * variable; see [ReverseOne]
fn mul_vv_reverse_1 <V, E>(
    var_zero   :   &Vec<E>     ,
    var_one    :   &mut Vec<E> ,
    _con       :   &Vec<V>     ,
    _flag      :   &Vec<bool>  ,
    arg        :   &[IndexT]   ,
    res        :       usize   )
where
    for<'a> E : std::ops::AddAssign<&'a E> ,
    for<'a> &'a E : std::ops::Mul<&'a E, Output = E> ,
{
    debug_assert!( arg.len() == 2);
    let lhs = arg[0] as usize;
    let rhs = arg[1] as usize;
    //
    let term      = &var_one[res] * &var_zero[rhs];
    var_one[lhs] += &term;
    //
    let term      = &var_one[res] * &var_zero[lhs];
    var_one[rhs] += &term;
}
// ---------------------------------------------------------------------------
// set_op_info
/// Set the operator information for all the Mul operators.
///
/// * op_info_vec :
/// The map from [op::id](crate::op::id) to operator information.
/// The the map results for MUL_CV_OP, MUL_VC_OP, and MUL_VV_OP are set.
pub fn set_op_info<V>( op_info_vec : &mut Vec< OpInfo<V> > )
where
    for<'a> V : std::ops::AddAssign<&'a V> ,
    //
    for<'a> &'a V : std::ops::Add<&'a AD<V>, Output = AD<V> > ,
    for<'a> &'a V : std::ops::Add<&'a V, Output = V> ,
    //
    for<'a> &'a V : std::ops::Mul<&'a AD<V>, Output = AD<V> > ,
    for<'a> &'a V : std::ops::Mul<&'a V, Output = V> ,
    V             : Clone + ThisThreadTape ,
{
    op_info_vec[MUL_CV_OP as usize] = OpInfo{
        name              : "mul_cv",
        forward_0_value   : mul_cv_forward_0::<V, V>,
        forward_0_ad      : mul_cv_forward_0::<V, AD<V> >,
        forward_1_value   : mul_cv_forward_1::<V, V>,
        forward_1_ad      : mul_cv_forward_1::<V, AD<V> >,
        reverse_1_value   : mul_cv_reverse_1::<V, V>,
        reverse_1_ad      : mul_cv_reverse_1::<V, AD<V> >,
        arg_var_index     : binary::binary_cv_arg_var_index,
        rust_src          : mul_cv_rust_src,
    };
    op_info_vec[MUL_VC_OP as usize] = OpInfo{
        name              : "mul_vc",
        forward_0_value   : mul_vc_forward_0::<V, V>,
        forward_0_ad      : mul_vc_forward_0::<V, AD<V> >,
        forward_1_value   : mul_vc_forward_1::<V, V>,
        forward_1_ad      : mul_vc_forward_1::<V, AD<V> >,
        reverse_1_value   : mul_vc_reverse_1::<V, V>,
        reverse_1_ad      : mul_vc_reverse_1::<V, AD<V> >,
        arg_var_index     : binary::binary_vc_arg_var_index,
        rust_src          : mul_vc_rust_src,
    };
    op_info_vec[MUL_VV_OP as usize] = OpInfo{
        name              : "mul_vv",
        forward_0_value   : mul_vv_forward_0::<V, V>,
        forward_0_ad      : mul_vv_forward_0::<V, AD<V> >,
        forward_1_value   : mul_vv_forward_1::<V, V>,
        forward_1_ad      : mul_vv_forward_1::<V, AD<V> >,
        reverse_1_value   : mul_vv_reverse_1::<V, V>,
        reverse_1_ad      : mul_vv_reverse_1::<V, AD<V> >,
        arg_var_index     : binary::binary_vv_arg_var_index,
        rust_src          : mul_vv_rust_src,
    };
}