echidna 0.15.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
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

//! Phase 5 structural-assertion regression tests.
//!
//! Each fix here turns a silent-wrong behavior into a loud panic or
//! `Result::Err`. The tests verify the assertion fires on the problem
//! input shape, and (for the non-assert items) that the happy path
//! still works.

#![cfg(feature = "bytecode")]

use echidna::{BReverse, BytecodeTape};
use std::sync::Arc;

// A constant-derivative custom op used by the custom-op rejection tests below
// (`taylor_grad`, `ode_taylor_step`, `third_order_hvvp`). `jacobian_forward`
// itself now supports custom ops exactly via `CustomOp::eval_dual` — its
// positive coverage lives in `tests/custom_primitives.rs`.
struct Scale;
impl echidna::CustomOp<f64> for Scale {
    fn eval(&self, a: f64, _b: f64) -> f64 {
        2.0 * a
    }
    fn partials(&self, _a: f64, _b: f64, _r: f64) -> (f64, f64) {
        (2.0, 0.0)
    }
}

// ── hessian / hvp reject multi-output tapes ─────────────────────────

fn rosenbrock_multi(x: &[BReverse<f64>]) -> Vec<BReverse<f64>> {
    let r0 = x[0] * x[0];
    let r1 = x[1] * x[1];
    vec![r0, r1]
}

#[test]
#[should_panic(expected = "scalar-output")]
fn hessian_rejects_multi_output_tape() {
    let (tape, _) = echidna::record_multi(rosenbrock_multi, &[1.0_f64, 2.0]);
    let _ = tape.hessian(&[1.0_f64, 2.0]);
}

#[test]
#[should_panic(expected = "scalar-output")]
fn hvp_rejects_multi_output_tape() {
    let (tape, _) = echidna::record_multi(rosenbrock_multi, &[1.0_f64, 2.0]);
    let _ = tape.hvp(&[1.0_f64, 2.0], &[1.0, 0.0]);
}

#[test]
#[should_panic(expected = "scalar-output")]
fn hessian_vec_rejects_multi_output_tape() {
    let (tape, _) = echidna::record_multi(rosenbrock_multi, &[1.0_f64, 2.0]);
    let _ = tape.hessian_vec::<2>(&[1.0_f64, 2.0]);
}

// Sanity: scalar-output tapes still work.
#[test]
fn hessian_on_scalar_output_still_works() {
    let (tape, _) = echidna::record(
        |x: &[BReverse<f64>]| x[0] * x[0] + x[1] * x[1],
        &[1.0_f64, 2.0],
    );
    let (_val, _grad, h) = tape.hessian(&[1.0_f64, 2.0]);
    assert_eq!(h.len(), 2);
    // H of x² + y² is diag(2, 2).
    assert!((h[0][0] - 2.0).abs() < 1e-12);
    assert!((h[1][1] - 2.0).abs() < 1e-12);
}

// ── M15: taylor_grad / ode_taylor_step reject custom ops ────────────

#[cfg(feature = "taylor")]
#[test]
#[should_panic(expected = "custom ops")]
fn taylor_grad_rejects_custom_ops() {
    let x = [1.0_f64];
    let mut tape = BytecodeTape::with_capacity(10);
    let handle = tape.register_custom(Arc::new(Scale));
    let idx = tape.new_input(x[0]);
    let input = BReverse::from_tape(x[0], idx);
    let output = {
        let _guard = echidna::bytecode_tape::BtapeGuard::new(&mut tape);
        input.custom_unary(handle, 2.0 * x[0])
    };
    tape.set_output(output.index());
    let _ = tape.taylor_grad::<3>(&x, &[1.0]);
}

#[cfg(feature = "taylor")]
#[test]
#[should_panic(expected = "custom ops")]
fn ode_taylor_step_rejects_custom_ops() {
    let x = [1.0_f64];
    let mut tape = BytecodeTape::with_capacity(10);
    let handle = tape.register_custom(Arc::new(Scale));
    let idx = tape.new_input(x[0]);
    let input = BReverse::from_tape(x[0], idx);
    let output = {
        let _guard = echidna::bytecode_tape::BtapeGuard::new(&mut tape);
        input.custom_unary(handle, 2.0 * x[0])
    };
    tape.set_output(output.index());
    tape.set_outputs(&[output.index()]);
    let _ = tape.ode_taylor_step::<3>(&x);
}

// ── M25: stde_gpu rejects multi-output tapes ─────────────────────────
//
// These tests would require a GPU backend to exercise; the check fires at
// runtime in `laplacian_gpu` when passed a multi-output tape. Covered
// structurally by the source-level check (tape.num_outputs != 1 → Err).

// ── third_order_hvvp: reject custom ops and multi-output tapes ───────
//
// Like `hessian_vec`, the nested-dual sweep linearizes custom ops, so 2nd/3rd
// order through them is only first-order-accurate; and it seeds the single
// `output_index`, so a multi-output tape silently gets one output's tensor.

#[test]
#[should_panic(expected = "custom ops")]
fn third_order_hvvp_rejects_custom_ops() {
    let x = [1.0_f64];
    let mut tape = BytecodeTape::with_capacity(10);
    let handle = tape.register_custom(Arc::new(Scale));
    let idx = tape.new_input(x[0]);
    let input = BReverse::from_tape(x[0], idx);
    let output = {
        let _guard = echidna::bytecode_tape::BtapeGuard::new(&mut tape);
        input.custom_unary(handle, 2.0 * x[0])
    };
    tape.set_output(output.index());
    let _ = tape.third_order_hvvp(&x, &[1.0], &[1.0]);
}

#[test]
#[should_panic(expected = "scalar-output")]
fn third_order_hvvp_rejects_multi_output_tape() {
    let (tape, _) = echidna::record_multi(rosenbrock_multi, &[1.0_f64, 2.0]);
    let _ = tape.third_order_hvvp(&[1.0_f64, 2.0], &[1.0, 0.0], &[0.0, 1.0]);
}

// ── sparse-Hessian family rejects multi-output tapes ─────────────────
//
// Mirrors the dense `hessian`/`hvp`/`hessian_vec` scalar-output guard.

#[test]
#[should_panic(expected = "scalar-output")]
fn sparse_hessian_rejects_multi_output_tape() {
    let (tape, _) = echidna::record_multi(rosenbrock_multi, &[1.0_f64, 2.0]);
    let _ = tape.sparse_hessian(&[1.0_f64, 2.0]);
}

#[cfg(feature = "parallel")]
#[test]
#[should_panic(expected = "scalar-output")]
fn sparse_hessian_par_rejects_multi_output_tape() {
    let (tape, _) = echidna::record_multi(rosenbrock_multi, &[1.0_f64, 2.0]);
    let _ = tape.sparse_hessian_par(&[1.0_f64, 2.0]);
}

#[cfg(feature = "parallel")]
#[test]
#[should_panic(expected = "scalar-output")]
fn hessian_par_rejects_multi_output_tape() {
    let (tape, _) = echidna::record_multi(rosenbrock_multi, &[1.0_f64, 2.0]);
    let _ = tape.hessian_par(&[1.0_f64, 2.0]);
}

// Sanity: scalar-output sparse Hessian still works.
#[test]
fn sparse_hessian_on_scalar_output_still_works() {
    let (tape, _) = echidna::record(
        |x: &[BReverse<f64>]| x[0] * x[0] + x[1] * x[1],
        &[1.0_f64, 2.0],
    );
    let (_val, _grad, _pattern, h) = tape.sparse_hessian(&[1.0_f64, 2.0]);
    // H of x² + y² is diag(2, 2); the two diagonal entries are present.
    assert!(h.iter().any(|&v| (v - 2.0).abs() < 1e-12));
}

// ── Thread-local active-pointer guards ──
//
// Both tape families share one reentrance/null-check mechanism; these pin
// its two panic paths per family (nothing else in the suite attempts a
// reentrant access or a guardless one).

#[test]
#[should_panic(expected = "No active tape")]
fn with_active_tape_without_guard_panics() {
    echidna::tape::with_active_tape::<f64, _>(|_| ());
}

#[test]
#[should_panic(expected = "No active bytecode tape")]
fn with_active_btape_without_guard_panics() {
    echidna::bytecode_tape::with_active_btape::<f64, _>(|_| ());
}

#[test]
#[should_panic(expected = "reentrant with_active_tape")]
fn reentrant_with_active_tape_panics() {
    use echidna::tape::{with_active_tape, Tape, TapeGuard};
    let mut tape: Tape<f64> = Tape::new();
    let _guard = TapeGuard::new(&mut tape);
    with_active_tape::<f64, _>(|_| {
        with_active_tape::<f64, _>(|_| ());
    });
}

#[test]
#[should_panic(expected = "reentrant with_active_btape")]
fn reentrant_with_active_btape_panics() {
    use echidna::bytecode_tape::{with_active_btape, BtapeGuard};
    let mut tape: BytecodeTape<f64> = BytecodeTape::new();
    let _guard = BtapeGuard::new(&mut tape);
    with_active_btape::<f64, _>(|_| {
        with_active_btape::<f64, _>(|_| ());
    });
}