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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
//! Transmission forward model adapter for fitting.
//!
//! Wraps the physics `forward_model` function into a `FitModel` trait object
//! that the LM optimizer can call. The fit parameters are the areal densities
//! (thicknesses) of each isotope in the sample.
use std::cell::{Cell, RefCell};
use std::rc::Rc;
use std::sync::Arc;
use nereids_endf::resonance::ResonanceData;
use nereids_physics::transmission::{self, InstrumentParams, SampleParams};
use crate::error::FittingError;
use crate::lm::{FitModel, FlatMatrix};
/// Transmission model backed by precomputed broadened cross-sections.
///
/// The expensive physics steps (resonance → σ(E), Doppler broadening,
/// resolution broadening) are computed once and stored. Each `evaluate()`
/// call performs only the Beer-Lambert step:
///
/// T(E) = exp(−Σᵢ nᵢ · σ_D,i(E))
///
/// which is O(N_energy) instead of O(N_energy × N_resonances). For a
/// 128×128 spatial map this is ~100–1000× faster than `TransmissionFitModel`.
///
/// Construct via `nereids_physics::transmission::broadened_cross_sections`,
/// then wrap in `Arc` so the same precomputed data is shared read-only
/// across all rayon worker threads.
pub struct PrecomputedTransmissionModel {
/// Broadened cross-sections σ_D(E) per isotope, shape \[n_isotopes\]\[n_energies\].
pub cross_sections: Arc<Vec<Vec<f64>>>,
/// Mapping: `params[density_indices[i]]` is the density of isotope `i`.
///
/// Wrapped in `Arc` so that parallel pixel loops can share one copy
/// via cheap reference-count increments instead of deep-cloning per pixel.
///
/// Kept `pub` (not `pub(crate)`) because the Python bindings
/// (`nereids-python`) construct and access this field directly.
pub density_indices: Arc<Vec<usize>>,
}
impl FitModel for PrecomputedTransmissionModel {
fn evaluate(&self, params: &[f64]) -> Result<Vec<f64>, FittingError> {
if self.cross_sections.is_empty() {
return Err(FittingError::InvalidConfig(
"PrecomputedTransmissionModel.cross_sections must not be empty".into(),
));
}
let n_e = self.cross_sections[0].len();
let mut neg_opt = vec![0.0f64; n_e];
// #109.1: No density > 0 guard — let Beer-Lambert handle all densities
// naturally. exp(−n·σ) is well-defined for negative n (gives T > 1,
// which is unphysical but the optimizer will reject it via chi2
// increase). Removing the guard makes evaluate() consistent with
// the analytical Jacobian, which always computes ∂T/∂n = −σ·T
// regardless of the sign of n.
for (i, xs) in self.cross_sections.iter().enumerate() {
let density = params[self.density_indices[i]];
for (j, &sigma) in xs.iter().enumerate() {
neg_opt[j] -= density * sigma;
}
}
Ok(neg_opt.iter().map(|&d| d.exp()).collect())
}
/// Analytical Jacobian for the Beer-Lambert transmission model.
///
/// T(E) = exp(-Σᵢ nᵢ · σᵢ(E))
/// ∂T/∂nᵢ = -σᵢ(E) · T(E)
///
/// Costs O(N_energy × N_isotopes) with zero extra evaluate() calls,
/// because T(E) is already in `y_current` from the LM loop.
/// This eliminates N_free extra evaluate() calls per LM iteration
/// compared to finite-difference Jacobians.
fn analytical_jacobian(
&self,
_params: &[f64],
free_param_indices: &[usize],
y_current: &[f64],
) -> Option<FlatMatrix> {
let n_e = y_current.len();
let n_free = free_param_indices.len();
// For each free parameter, sum the cross-sections of every isotope
// tied to that parameter index. The Beer-Lambert derivative is:
// ∂T/∂n_fp = -T(E) · Σ_{iso: density_indices[iso]==fp_idx} σ_iso(E)
// Using only the first match (via .position) would give the wrong
// gradient whenever multiple isotopes share one density parameter.
let fp_xs_sums: Vec<Vec<f64>> = free_param_indices
.iter()
.map(|&fp_idx| {
let mut sum = vec![0.0f64; n_e];
for (iso, &di) in self.density_indices.iter().enumerate() {
if di == fp_idx {
for (j, &sigma) in self.cross_sections[iso].iter().enumerate() {
sum[j] += sigma;
}
}
}
sum
})
.collect();
// jacobian.get(i, j) = ∂T(E_i)/∂params[free_param_indices[j]]
// = -(Σ σ_iso(E_i)) · T(E_i) (Beer-Lambert derivative)
let mut jacobian = FlatMatrix::zeros(n_e, n_free);
for i in 0..n_e {
for (j, xs_sum) in fp_xs_sums.iter().enumerate() {
*jacobian.get_mut(i, j) = -xs_sum[i] * y_current[i];
}
}
Some(jacobian)
}
}
/// Forward model for fitting isotopic areal densities from transmission data.
///
/// The model computes T(E) for a set of isotopes with variable areal densities.
/// Each isotope's resonance data and the energy grid are fixed; only the
/// areal densities are adjusted during fitting.
///
/// Optionally, the sample temperature can also be fitted by setting
/// `temperature_index` to the parameter slot holding the temperature value.
/// When `temperature_index` is `Some(idx)`, the Doppler broadening kernel
/// is recomputed at `params[idx]` when the temperature changes (cached
/// across calls at the same temperature), and the analytical Jacobian
/// provides density columns directly plus a single FD column for temperature.
///
/// `instrument` uses `Arc` so that parallel pixel loops (e.g. in `sparse.rs`)
/// can share one copy of a potentially large tabulated resolution kernel
/// via cheap reference-count increments instead of deep-cloning per pixel.
pub struct TransmissionFitModel {
/// Energy grid (eV), ascending.
energies: Vec<f64>,
/// Resonance data for each isotope.
resonance_data: Vec<ResonanceData>,
/// Sample temperature in Kelvin (used when `temperature_index` is `None`).
temperature_k: f64,
/// Optional instrument resolution parameters (Arc-shared for parallel use).
instrument: Option<Arc<InstrumentParams>>,
/// Index mapping: which `params` indices correspond to areal densities.
/// params[density_indices[i]] = areal density of isotope i.
///
/// Uses `Vec<usize>` (not `Arc<Vec<usize>>`) because `TransmissionFitModel`
/// is constructed fresh per pixel (via `fit_spectrum`) and never shared
/// across threads. `PrecomputedTransmissionModel` uses `Arc<Vec<usize>>`
/// for its density_indices because it _is_ shared across rayon workers.
density_indices: Vec<usize>,
/// If `Some(idx)`, `params[idx]` is treated as the sample temperature (K)
/// and included as a free parameter in the fit. The Doppler broadening
/// kernel is recomputed at each `evaluate()` call.
temperature_index: Option<usize>,
/// Cached unbroadened (Reich-Moore) cross-sections, computed once in
/// `new()` when `temperature_index` is `Some`. Eliminates redundant
/// O(N_energy × N_resonances) computation on every `evaluate()` call.
/// Wrapped in `Arc` so `spatial_map` can share a single allocation across
/// all per-pixel `TransmissionFitModel` instances without deep cloning.
base_xs: Option<Arc<Vec<Vec<f64>>>>,
/// Cached broadened cross-sections from the last `evaluate()` call.
/// Used by `analytical_jacobian()` to provide density columns without
/// rebroadening. Interior mutability via `RefCell` is needed because
/// `FitModel::evaluate` takes `&self`. Safe because `TransmissionFitModel`
/// is constructed per-pixel and never shared across threads.
cached_broadened_xs: RefCell<Option<Rc<Vec<Vec<f64>>>>>,
/// Temperature at which `cached_broadened_xs` was computed.
/// `Cell` is sufficient because `f64` is `Copy`.
cached_temperature: Cell<f64>,
}
impl TransmissionFitModel {
/// Create a validated `TransmissionFitModel`.
///
/// When `external_base_xs` is `Some`, uses those precomputed unbroadened
/// cross-sections instead of computing them (expensive Reich-Moore).
/// `spatial_map` precomputes once for all pixels and passes them here.
///
/// # Errors
/// Returns `FittingError::InvalidConfig` if `temperature_index` overlaps
/// with `density_indices`, or if `external_base_xs` has a mismatched shape.
pub fn new(
energies: Vec<f64>,
resonance_data: Vec<ResonanceData>,
temperature_k: f64,
instrument: Option<Arc<InstrumentParams>>,
density_indices: Vec<usize>,
temperature_index: Option<usize>,
external_base_xs: Option<Arc<Vec<Vec<f64>>>>,
) -> Result<Self, FittingError> {
if let Some(ti) = temperature_index
&& density_indices.contains(&ti)
{
return Err(FittingError::InvalidConfig(
"temperature_index must not overlap with density_indices".into(),
));
}
// Validate external base XS shape before accepting.
if let Some(ref xs) = external_base_xs {
if xs.len() != resonance_data.len() {
return Err(FittingError::InvalidConfig(format!(
"external_base_xs has {} isotopes but resonance_data has {}",
xs.len(),
resonance_data.len(),
)));
}
for (i, row) in xs.iter().enumerate() {
if row.len() != energies.len() {
return Err(FittingError::InvalidConfig(format!(
"external_base_xs[{i}] has {} energies but expected {}",
row.len(),
energies.len(),
)));
}
}
}
let base_xs = match external_base_xs {
Some(xs) => Some(xs),
None if temperature_index.is_some() => Some(Arc::new(
transmission::unbroadened_cross_sections(&energies, &resonance_data, None)
.map_err(|e| {
FittingError::InvalidConfig(format!(
"failed to compute unbroadened cross-sections: {e}"
))
})?,
)),
None => None,
};
Ok(Self {
energies,
resonance_data,
temperature_k,
instrument,
density_indices,
temperature_index,
base_xs,
cached_broadened_xs: RefCell::new(None),
cached_temperature: Cell::new(f64::NAN),
})
}
}
impl FitModel for TransmissionFitModel {
fn evaluate(&self, params: &[f64]) -> Result<Vec<f64>, FittingError> {
debug_assert!(
self.density_indices.iter().all(|&i| i < params.len()),
"density_indices out of bounds for params (len={})",
params.len(),
);
debug_assert!(
self.temperature_index.is_none_or(|i| i < params.len()),
"temperature_index out of bounds for params (len={})",
params.len(),
);
let temperature_k = match self.temperature_index {
Some(idx) => params[idx],
None => self.temperature_k,
};
if let Some(ref base_xs) = self.base_xs {
// Fast path: reuse cached unbroadened XS, only redo Doppler + Beer-Lambert.
// Validate temperature (same rules as SampleParams::new in the slow path)
// so the optimizer can't silently evaluate an unphysical model.
if !temperature_k.is_finite() || temperature_k < 0.0 {
return Err(FittingError::EvaluationFailed(format!(
"Invalid temperature: {temperature_k} K (must be finite and non-negative)"
)));
}
// Compute broadened XS (or reuse cache if temperature unchanged).
// Caching avoids redundant Doppler broadening on rejected LM steps
// (same T, different lambda) and enables analytical_jacobian() to
// read the broadened σ for density columns.
let broadened_xs = if (temperature_k - self.cached_temperature.get()).abs() < 1e-15 {
Rc::clone(self.cached_broadened_xs.borrow().as_ref().unwrap())
} else {
let xs = Rc::new(
transmission::broadened_cross_sections_from_base(
&self.energies,
base_xs,
&self.resonance_data,
temperature_k,
self.instrument.as_deref(),
)
.map_err(|e| FittingError::EvaluationFailed(e.to_string()))?,
);
*self.cached_broadened_xs.borrow_mut() = Some(Rc::clone(&xs));
self.cached_temperature.set(temperature_k);
xs
};
// Beer-Lambert: T(E) = exp(-Σᵢ nᵢ · σᵢ(E))
let n_e = self.energies.len();
let mut neg_opt = vec![0.0f64; n_e];
for (i, xs) in broadened_xs.iter().enumerate() {
let density = params[self.density_indices[i]];
for (j, &sigma) in xs.iter().enumerate() {
neg_opt[j] -= density * sigma;
}
}
Ok(neg_opt.iter().map(|&d| d.exp()).collect())
} else {
// Original path: full forward model (no temperature fitting).
let isotopes: Vec<(ResonanceData, f64)> = self
.resonance_data
.iter()
.zip(self.density_indices.iter())
.map(|(rd, &idx): (&ResonanceData, &usize)| (rd.clone(), params[idx]))
.collect();
let sample = SampleParams::new(temperature_k, isotopes)
.map_err(|e| FittingError::EvaluationFailed(e.to_string()))?;
transmission::forward_model(&self.energies, &sample, self.instrument.as_deref())
.map_err(|e| FittingError::EvaluationFailed(e.to_string()))
}
}
/// Analytical Jacobian for the transmission model with temperature fitting.
///
/// When `base_xs` is available (temperature fitting path):
/// - **Density columns**: `∂T/∂nᵢ = -σᵢ(E)·T(E)` using cached broadened XS
/// from the most recent `evaluate()` call. Same formula as
/// `PrecomputedTransmissionModel`, zero extra broadening calls.
/// - **Temperature column**: single forward finite-difference perturbation
/// at T+dT. Requires one extra `broadened_cross_sections_from_base()`
/// call, which is dramatically cheaper than the N_free calls the LM
/// solver would make with a full FD Jacobian.
///
/// Returns `None` for the no-base_xs path (full forward model), which
/// falls back to finite-difference in the LM solver.
fn analytical_jacobian(
&self,
params: &[f64],
free_param_indices: &[usize],
y_current: &[f64],
) -> Option<FlatMatrix> {
// Only provide analytical Jacobian when base_xs is available
// (temperature-fitting fast path with cached broadened XS).
let base_xs = self.base_xs.as_ref()?;
let cached_xs = self.cached_broadened_xs.borrow();
let broadened_xs = cached_xs.as_ref()?;
// Guard: verify the cache matches the current parameter temperature.
// After a rejected LM trial step, evaluate() may have updated the cache
// to the trial temperature while the solver reverted params to the
// accepted point. Using stale XS would give an incorrect Jacobian.
if let Some(ti) = self.temperature_index {
let param_temp = params[ti];
if (param_temp - self.cached_temperature.get()).abs() > 1e-15 {
// Cache is stale — fall back to finite-difference Jacobian.
return None;
}
}
let n_e = y_current.len();
let n_free = free_param_indices.len();
let mut jacobian = FlatMatrix::zeros(n_e, n_free);
// Identify which free parameter column is the temperature (if any).
let temp_col = self
.temperature_index
.and_then(|ti| free_param_indices.iter().position(|&fp| fp == ti));
// ── Density columns: ∂T/∂nᵢ = -σᵢ(E)·T(E) ──
// Same formula as PrecomputedTransmissionModel::analytical_jacobian.
for (col, &fp_idx) in free_param_indices.iter().enumerate() {
if temp_col == Some(col) {
continue; // temperature column handled below
}
// Sum cross-sections of all isotopes tied to this free parameter.
let mut sigma_sum = vec![0.0f64; n_e];
for (iso, &di) in self.density_indices.iter().enumerate() {
if di == fp_idx {
for (j, &sigma) in broadened_xs[iso].iter().enumerate() {
sigma_sum[j] += sigma;
}
}
}
for i in 0..n_e {
*jacobian.get_mut(i, col) = -sigma_sum[i] * y_current[i];
}
}
// ── Temperature column: forward FD at T+dT ──
if let Some(col) = temp_col {
let temperature_k = self.cached_temperature.get();
let dt = 1e-6 * (1.0 + temperature_k.abs());
let t_perturbed = temperature_k + dt;
let xs_perturbed = transmission::broadened_cross_sections_from_base(
&self.energies,
base_xs,
&self.resonance_data,
t_perturbed,
self.instrument.as_deref(),
)
.ok()?;
// Beer-Lambert at perturbed temperature with current densities.
let mut neg_opt = vec![0.0f64; n_e];
for (iso, xs) in xs_perturbed.iter().enumerate() {
let density = params[self.density_indices[iso]];
for (j, &sigma) in xs.iter().enumerate() {
neg_opt[j] -= density * sigma;
}
}
let y_perturbed: Vec<f64> = neg_opt.iter().map(|&d| d.exp()).collect();
for i in 0..n_e {
*jacobian.get_mut(i, col) = (y_perturbed[i] - y_current[i]) / dt;
}
}
Some(jacobian)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::lm::{self, FitModel, LmConfig};
use crate::parameters::{FitParameter, ParameterSet};
use nereids_core::types::Isotope;
use nereids_endf::resonance::{LGroup, Resonance, ResonanceFormalism, ResonanceRange};
// ── PrecomputedTransmissionModel ─────────────────────────────────────────
/// Verify Beer-Lambert: T(E) = exp(-Σᵢ nᵢ·σᵢ(E)).
#[test]
fn precomputed_evaluate_matches_beer_lambert() {
let xs = Arc::new(vec![
vec![1.0, 2.0, 3.0], // isotope 0
vec![0.5, 0.5, 0.5], // isotope 1
]);
let model = PrecomputedTransmissionModel {
cross_sections: xs,
density_indices: Arc::new(vec![0, 1]),
};
let params = [0.2f64, 0.4f64];
let y = model.evaluate(¶ms).unwrap();
let expected: Vec<f64> = (0..3)
.map(|i| {
let s0 = [1.0, 2.0, 3.0][i];
let s1 = [0.5, 0.5, 0.5][i];
(-params[0] * s0 - params[1] * s1).exp()
})
.collect();
assert_eq!(y.len(), 3);
for (yi, ei) in y.iter().zip(expected.iter()) {
assert!(
(yi - ei).abs() < 1e-12,
"evaluate mismatch: got {yi}, expected {ei}"
);
}
}
/// Analytical Jacobian ∂T/∂nᵢ = -σᵢ(E)·T(E) must match central-difference FD.
#[test]
fn precomputed_analytical_jacobian_matches_finite_difference() {
let xs = Arc::new(vec![
vec![1.0, 2.0, 3.0], // isotope 0
vec![0.5, 0.5, 0.5], // isotope 1
]);
let model = PrecomputedTransmissionModel {
cross_sections: xs,
density_indices: Arc::new(vec![0, 1]),
};
let params = [0.2f64, 0.4f64];
let y = model.evaluate(¶ms).unwrap();
let free = vec![0usize, 1usize];
let jac = model
.analytical_jacobian(¶ms, &free, &y)
.expect("analytical_jacobian should return Some(_)");
assert_eq!(jac.nrows, 3); // n_energies
assert_eq!(jac.ncols, 2); // n_free_params
// Central-difference reference.
let h = 1e-6f64;
for (col, &p_idx) in free.iter().enumerate() {
let mut p_plus = params;
let mut p_minus = params;
p_plus[p_idx] += h;
p_minus[p_idx] -= h;
let y_plus = model.evaluate(&p_plus).unwrap();
let y_minus = model.evaluate(&p_minus).unwrap();
for i in 0..3 {
let fd = (y_plus[i] - y_minus[i]) / (2.0 * h);
let ana = jac.get(i, col);
assert!(
(fd - ana).abs() < 1e-6,
"Jacobian mismatch (row {i}, col {col}): FD={fd:.8}, analytical={ana:.8}"
);
}
}
}
/// When two isotopes share a density parameter, the Jacobian column must
/// equal -T(E) * (σ₀(E) + σ₁(E)), not just the first isotope's σ.
#[test]
fn precomputed_jacobian_tied_parameters_sums_both_isotopes() {
// Two isotopes mapped to the same density parameter (index 0).
let xs = Arc::new(vec![
vec![1.0, 2.0, 3.0], // isotope 0
vec![0.5, 1.0, 1.5], // isotope 1 — tied to same param
]);
let model = PrecomputedTransmissionModel {
cross_sections: xs,
density_indices: Arc::new(vec![0, 0]), // both isotopes share param[0]
};
let params = [0.1f64];
let y = model.evaluate(¶ms).unwrap();
let free = vec![0usize];
let jac = model
.analytical_jacobian(¶ms, &free, &y)
.expect("analytical_jacobian should return Some(_)");
// Expected: ∂T/∂n = -T(E) * (σ₀(E) + σ₁(E))
for i in 0..3 {
let sigma_sum = [1.0, 2.0, 3.0][i] + [0.5, 1.0, 1.5][i];
let expected = -y[i] * sigma_sum;
assert!(
(jac.get(i, 0) - expected).abs() < 1e-12,
"Tied Jacobian mismatch at E[{i}]: got {}, expected {expected}",
jac.get(i, 0)
);
}
}
// ── TransmissionFitModel ─────────────────────────────────────────────────
fn u238_single_resonance() -> ResonanceData {
ResonanceData {
isotope: Isotope::new(92, 238).unwrap(),
za: 92238,
awr: 236.006,
ranges: vec![ResonanceRange {
energy_low: 1e-5,
energy_high: 1e4,
resolved: true,
formalism: ResonanceFormalism::ReichMoore,
target_spin: 0.0,
scattering_radius: 9.4285,
naps: 1,
l_groups: vec![LGroup {
l: 0,
awr: 236.006,
apl: 0.0,
qx: 0.0,
lrx: 0,
resonances: vec![Resonance {
energy: 6.674,
j: 0.5,
gn: 1.493e-3,
gg: 23.0e-3,
gfa: 0.0,
gfb: 0.0,
}],
}],
rml: None,
urr: None,
ap_table: None,
r_external: vec![],
}],
}
}
#[test]
fn test_recover_single_isotope_thickness() {
let data = u238_single_resonance();
let true_thickness = 0.0005;
// Generate synthetic data
let energies: Vec<f64> = (0..201).map(|i| 1.0 + (i as f64) * 0.05).collect();
let model =
TransmissionFitModel::new(energies.clone(), vec![data], 0.0, None, vec![0], None, None)
.unwrap();
let y_obs = model.evaluate(&[true_thickness]).unwrap();
let sigma = vec![0.01; y_obs.len()]; // 1% uncertainty
let mut params = ParameterSet::new(vec![
FitParameter::non_negative("thickness", 0.001), // initial guess 2× off
]);
let result =
lm::levenberg_marquardt(&model, &y_obs, &sigma, &mut params, &LmConfig::default())
.unwrap();
assert!(result.converged, "Fit did not converge");
let fitted = result.params[0];
assert!(
(fitted - true_thickness).abs() / true_thickness < 0.01,
"Fitted thickness = {}, true = {}, error = {:.1}%",
fitted,
true_thickness,
(fitted - true_thickness).abs() / true_thickness * 100.0,
);
}
#[test]
fn test_recover_two_isotope_thicknesses() {
let u238 = u238_single_resonance();
// Second isotope with resonance at 20 eV
let other = ResonanceData {
isotope: Isotope::new(1, 10).unwrap(),
za: 1010,
awr: 10.0,
ranges: vec![ResonanceRange {
energy_low: 0.0,
energy_high: 100.0,
resolved: true,
formalism: ResonanceFormalism::ReichMoore,
target_spin: 0.0,
scattering_radius: 5.0,
naps: 1,
l_groups: vec![LGroup {
l: 0,
awr: 10.0,
apl: 5.0,
qx: 0.0,
lrx: 0,
resonances: vec![Resonance {
energy: 20.0,
j: 0.5,
gn: 0.1,
gg: 0.05,
gfa: 0.0,
gfb: 0.0,
}],
}],
rml: None,
urr: None,
ap_table: None,
r_external: vec![],
}],
};
let true_t1 = 0.0003;
let true_t2 = 0.0001;
let energies: Vec<f64> = (0..301).map(|i| 1.0 + (i as f64) * 0.1).collect();
let model = TransmissionFitModel::new(
energies.clone(),
vec![u238, other],
0.0,
None,
vec![0, 1],
None,
None,
)
.unwrap();
let y_obs = model.evaluate(&[true_t1, true_t2]).unwrap();
let sigma = vec![0.01; y_obs.len()];
let mut params = ParameterSet::new(vec![
FitParameter::non_negative("U-238 thickness", 0.001),
FitParameter::non_negative("Other thickness", 0.001),
]);
let result =
lm::levenberg_marquardt(&model, &y_obs, &sigma, &mut params, &LmConfig::default())
.unwrap();
assert!(
result.converged,
"Fit did not converge after {} iterations",
result.iterations
);
let (fit_t1, fit_t2) = (result.params[0], result.params[1]);
assert!(
(fit_t1 - true_t1).abs() / true_t1 < 0.05,
"U-238: fitted={}, true={}, error={:.1}%",
fit_t1,
true_t1,
(fit_t1 - true_t1).abs() / true_t1 * 100.0,
);
assert!(
(fit_t2 - true_t2).abs() / true_t2 < 0.05,
"Other: fitted={}, true={}, error={:.1}%",
fit_t2,
true_t2,
(fit_t2 - true_t2).abs() / true_t2 * 100.0,
);
}
// ── Temperature fitting ──────────────────────────────────────────────────
/// Verify that temperature_index makes evaluate() read T from the
/// parameter vector instead of the fixed `temperature_k` field.
#[test]
fn temperature_index_overrides_fixed_temperature() {
let data = u238_single_resonance();
let energies: Vec<f64> = (0..201).map(|i| 1.0 + (i as f64) * 0.05).collect();
// Model with fixed temperature = 0 K but temperature_index pointing
// to params[1].
let model = TransmissionFitModel::new(
energies.clone(),
vec![data.clone()],
0.0,
None,
vec![0],
Some(1),
None,
)
.unwrap();
// Model with fixed temperature = 300 K (no temperature_index).
let model_fixed = TransmissionFitModel::new(
energies.clone(),
vec![data],
300.0,
None,
vec![0],
None,
None,
)
.unwrap();
let density = 0.0005;
let y_via_index = model.evaluate(&[density, 300.0]).unwrap();
let y_via_fixed = model_fixed.evaluate(&[density]).unwrap();
for (a, b) in y_via_index.iter().zip(y_via_fixed.iter()) {
assert!(
(a - b).abs() < 1e-12,
"temperature_index path disagrees with fixed path: {} vs {}",
a,
b
);
}
}
/// Recover temperature from Doppler-broadened synthetic data.
///
/// Generates transmission at T_true with known density, then fits both
/// density and temperature simultaneously.
#[test]
fn test_recover_temperature() {
let data = u238_single_resonance();
let true_density = 0.0005;
let true_temp = 300.0; // K
// Energy grid around the 6.674 eV resonance.
let energies: Vec<f64> = (0..401).map(|i| 4.0 + (i as f64) * 0.025).collect();
// Generate synthetic data at the true temperature.
let model = TransmissionFitModel::new(
energies.clone(),
vec![data],
0.0, // ignored — temperature_index is set
None,
vec![0],
Some(1), // params[1] = temperature
None,
)
.unwrap();
let mut y_obs = model.evaluate(&[true_density, true_temp]).unwrap();
// Add tiny deterministic noise so reduced_chi2 stays positive.
// Without noise, the analytical Jacobian converges to exact parameters,
// yielding chi2 ≈ 0, which makes covariance ≈ 0 and uncertainty NaN.
for (i, y) in y_obs.iter_mut().enumerate() {
*y *= 1.0 + 1e-5 * ((i % 7) as f64 - 3.0);
}
let sigma = vec![0.005; y_obs.len()];
// Fit with initial guesses offset from truth.
let mut params = ParameterSet::new(vec![
FitParameter::non_negative("density", 0.001),
FitParameter {
name: "temperature_k".into(),
value: 200.0, // initial guess 100 K off
lower: 1.0,
upper: 2000.0,
fixed: false,
},
]);
let config = LmConfig {
max_iter: 200,
..LmConfig::default()
};
let result = lm::levenberg_marquardt(&model, &y_obs, &sigma, &mut params, &config).unwrap();
assert!(
result.converged,
"Temperature fit did not converge after {} iterations",
result.iterations
);
let fit_density = result.params[0];
let fit_temp = result.params[1];
// Tiny deterministic noise (max ±3e-5): optimizer should converge to within 0.1%.
assert!(
(fit_density - true_density).abs() / true_density < 0.001,
"Density: fitted={}, true={}, error={:.1}%",
fit_density,
true_density,
(fit_density - true_density).abs() / true_density * 100.0,
);
assert!(
(fit_temp - true_temp).abs() / true_temp < 0.001,
"Temperature: fitted={:.1} K, true={:.1} K, error={:.1}%",
fit_temp,
true_temp,
(fit_temp - true_temp).abs() / true_temp * 100.0,
);
// Verify uncertainty is reported.
let unc = result
.uncertainties
.expect("uncertainties should be available");
assert!(
unc.len() == 2,
"expected 2 uncertainties, got {}",
unc.len()
);
assert!(
unc[1] > 0.0 && unc[1].is_finite(),
"temperature uncertainty should be positive and finite, got {}",
unc[1]
);
}
/// Analytical Jacobian for TransmissionFitModel (with temperature) must
/// agree with central-difference finite-difference Jacobian.
///
/// This validates both the density columns (∂T/∂nᵢ = -σᵢ·T) and the
/// temperature column (forward FD at T+dT).
#[test]
fn transmission_fit_model_analytical_jacobian_matches_fd() {
let data = u238_single_resonance();
let energies: Vec<f64> = (0..201).map(|i| 1.0 + (i as f64) * 0.05).collect();
let model = TransmissionFitModel::new(
energies,
vec![data],
0.0,
None,
vec![0],
Some(1), // params[1] = temperature
None,
)
.unwrap();
let params = [0.0005f64, 300.0f64]; // density, temperature
let y = model.evaluate(¶ms).unwrap();
let free = vec![0usize, 1usize];
let jac = model
.analytical_jacobian(¶ms, &free, &y)
.expect("analytical_jacobian should return Some(_)");
assert_eq!(jac.nrows, y.len());
assert_eq!(jac.ncols, 2);
// Central-difference reference.
let h = 1e-6f64;
for (col, &p_idx) in free.iter().enumerate() {
let mut p_plus = params;
let mut p_minus = params;
p_plus[p_idx] += h * (1.0 + params[p_idx].abs());
p_minus[p_idx] -= h * (1.0 + params[p_idx].abs());
let y_plus = model.evaluate(&p_plus).unwrap();
let y_minus = model.evaluate(&p_minus).unwrap();
let actual_2h = p_plus[p_idx] - p_minus[p_idx];
for i in 0..y.len() {
let fd = (y_plus[i] - y_minus[i]) / actual_2h;
let ana = jac.get(i, col);
let err = (fd - ana).abs();
// Use a meaningful floor: when both FD and analytical values
// are below 1e-10, relative error comparisons are dominated
// by floating-point noise and are not physically meaningful.
//
// The floor was raised from 1e-15 to 1e-10 alongside the
// B=S_l boundary condition fix in the Reich-Moore U-matrix.
// That fix shifted near-zero cross-section values from
// O(1e-15) to O(1e-10), making the old floor too tight for
// floating-point comparison at those magnitudes.
let scale = fd.abs().max(ana.abs()).max(1e-10);
assert!(
err / scale < 0.01,
"Jacobian mismatch (row {i}, col {col}): FD={fd:.8}, analytical={ana:.8}, \
rel_err={:.4}",
err / scale,
);
}
}
}
/// Verify that the broadened-XS cache avoids redundant recomputation.
/// Calling evaluate() twice with the same temperature should produce
/// identical results and reuse the cache.
#[test]
fn transmission_fit_model_cache_reuse() {
let data = u238_single_resonance();
let energies: Vec<f64> = (0..201).map(|i| 1.0 + (i as f64) * 0.05).collect();
let model =
TransmissionFitModel::new(energies, vec![data], 0.0, None, vec![0], Some(1), None)
.unwrap();
// First call populates the cache.
let y1 = model.evaluate(&[0.0005, 300.0]).unwrap();
assert!(model.cached_broadened_xs.borrow().is_some());
assert!((model.cached_temperature.get() - 300.0).abs() < 1e-15);
// Second call with same temperature but different density should
// reuse cached broadened XS (no rebroadening).
let y2 = model.evaluate(&[0.001, 300.0]).unwrap();
assert!((model.cached_temperature.get() - 300.0).abs() < 1e-15);
// Results must differ (different density) but cache temperature unchanged.
assert!(
(y1[100] - y2[100]).abs() > 1e-10,
"different densities should produce different transmission"
);
// Change temperature — cache should update.
let _y3 = model.evaluate(&[0.0005, 600.0]).unwrap();
assert!((model.cached_temperature.get() - 600.0).abs() < 1e-15);
}
}