Skip to main content

gam_models/
multinomial.rs

1//! Penalized multinomial-logit (softmax) GLM driver — fixed-λ inner solve.
2//!
3//! This is the principled vector-response companion to the scalar PIRLS path:
4//! the inner-loop Newton solver for a multi-class GAM at fixed smoothing
5//! parameters λ, using the canonical multinomial-logit likelihood
6//! ([`MultinomialLogitLikelihood`]) and the existing dense block-Fisher
7//! assembly in [`gam_solve::pirls::dense_block_xtwx`] /
8//! [`gam_solve::pirls::dense_block_xtwy`].
9//!
10//! # What this module does
11//!
12//! Solve, for the reference-coded multinomial-logit GAM with `K` classes and
13//! design matrix `X ∈ ℝ^{N×P}`,
14//!
15//! ```text
16//!     β̂ = argmin_β { − log L(β) + ½ Σ_{a=0}^{K-2} λ_a · β_a^T S β_a }
17//! ```
18//!
19//! where `β = [β_0; β_1; …; β_{K-2}]` is the stacked coefficient vector in
20//! output-major order (`β_a ∈ ℝ^P` is the coefficient block for class `a`),
21//! `S ∈ ℝ^{P×P}` is the smoothing penalty matrix (shared across classes,
22//! replicated as `I_{K-1} ⊗ S` over the full parameter space), and `λ_a` is
23//! a per-class smoothing parameter.
24//!
25//! The likelihood uses class `K - 1` as the reference (`η_{K-1} ≡ 0`), so the
26//! softmax gauge is fixed at the η level and no additional sum-to-zero
27//! projection is required.
28//!
29//! # Layering
30//!
31//! * **Fixed-λ inner solve** — [`fit_penalized_multinomial`] is the canonical
32//!   coefficient-space Newton solver at *given* smoothing parameters `λ`,
33//!   built on the shared [`crate::penalized_vector_glm`] engine.
34//!
35//! * **REML / LAML smoothing-parameter selection** — [`fit_penalized_multinomial_formula`]
36//!   routes through [`crate::custom_family::fit_custom_family_with_rho_prior`]
37//!   so the per-active-class `λ_a` are selected by the outer REML/LAML loop;
38//!   the caller's `init_lambda` is only a warm-start seed. The multinomial
39//!   [`crate::multinomial_reml::MultinomialFamily`] `CustomFamily`
40//!   impl calls the fixed-λ math above as its inner solve at each ρ trial and
41//!   supplies the dense per-row Hessian block for the outer trace terms.
42//!
43//! * **Formula → design integration** — `build_formula_design_for_multinomial`
44//!   parses the Wilkinson formula and assembles `X` and the per-term `S`
45//!   blocks; the `fit_multinomial_formula_pyfunc` FFI shim wires the Python
46//!   `gamfit.fit(..., family='multinomial')` entry straight to this path.
47//!
48//! # Convergence
49//!
50//! The damped-Newton-with-backtracking scaffold lives once in the shared
51//! [`crate::penalized_vector_glm`] engine: at each iteration the
52//! assembled penalized Hessian `H + I_{K-1} ⊗ (λ_a S)` is factored via faer's
53//! symmetric-PD-with-fallback path, the full Newton step `δ = −H^{-1} ∇F` is
54//! computed, and accepted with step halving if the objective fails to decrease
55//! (up to a small backtracking budget). The convergence test is the relative
56//! coefficient step norm `‖δ‖ / (1 + ‖β‖) ≤ tol`, matching the existing pyffi
57//! reference path. This module is the softmax adapter over that engine: it
58//! supplies the dense `(K-1)×(K-1)` Fisher block, the residual, and the
59//! log-likelihood through [`MultinomialLogitLikelihood`], and owns the
60//! class-count / simplex preconditions. The independent-binomial sibling
61//! [`crate::binomial_multi`] is the same engine with a row-diagonal
62//! Fisher block instead.
63
64use crate::custom_family::{
65    BlockwiseFitOptions, ParameterBlockState, PenaltyMatrix, fit_custom_family_with_rho_prior,
66};
67use crate::multinomial_reml::MultinomialFamily;
68use crate::penalized_vector_glm::{PenalizedVectorGlmInputs, fit_penalized_vector_glm};
69use crate::vector_response::{MultinomialLogitLikelihood, validate_multinomial_simplex};
70use gam_terms::inference::formula_dsl::parse_formula;
71use crate::model_types::EstimationError;
72use crate::fit_orchestration::{
73    FitConfig, build_termspec_with_geometry_and_overrides, resolved_resource_policy,
74};
75use gam_terms::smooth::{
76    PenaltyBlockInfo, TermCollectionDesign, TermCollectionSpec, build_term_collection_design,
77};
78use crate::fit_orchestration::drivers::freeze_term_collection_from_design;
79use gam_terms::term_builder::resolve_role_col;
80use gam_problem::ResponseColumnKind;
81use gam_data::ColumnKindTag;
82use gam_data::EncodedDataset;
83use gam_runtime::resource::ProblemHints;
84use ndarray::{Array1, Array2, ArrayView1, ArrayView2, ArrayView3};
85use serde::{Deserialize, Serialize};
86use std::sync::Arc;
87
88/// Solver-only numerical stabilization floor for the formula-driven
89/// multinomial REML inner solve (gam#747).
90///
91/// Installed with [`RidgePolicy::solver_only`](gam_problem::RidgePolicy::solver_only)
92/// so it stabilizes the inner joint-Newton **linear solve** but never enters
93/// the REML objective, the penalty log-determinant, or the Laplace Hessian.
94///
95/// What it does: the multinomial smoothing penalties are rank-deficient by
96/// design (each smooth carries an unpenalized polynomial null space) and the
97/// formula may add a fully unpenalized parametric term (`x3` / `body_mass`). On
98/// near-separable hard labels the softmax curvature is ill-conditioned along
99/// those directions, so the bare Newton step `H⁻¹∇` is huge. Lifting the
100/// smallest Hessian eigenvalue to `δ` bounds the step (`‖(H+δI)⁻¹∇‖ ≤ ‖∇‖/δ`),
101/// keeping the screening iterates finite without poisoning the softmax with
102/// `inf − inf = NaN`.
103///
104/// What it deliberately does NOT do: it adds no `½·δ·‖β‖²` term to the
105/// objective and no `δ`-shift to the REML log-determinant. The earlier
106/// `explicit_stabilization_pospart` policy folded both into the criterion,
107/// which made `1e-4` a fixed-λ Gaussian prior that shrank every identified
108/// coefficient off the MLE and biased smoothing-parameter selection — a value
109/// that had to be tuned *between* under-stabilization (NaN seeds) and
110/// over-shrinkage (lost VGAM match). As a solver-only floor that tradeoff is
111/// gone: the over-shrinkage failure mode cannot occur (nothing is shrunk), the
112/// optimized objective is the true penalized REML criterion, and the floor
113/// only has to be large enough to keep the linear algebra finite.
114///
115/// The separation defect (#753) is no longer this floor's job. If the
116/// multinomial MLE is genuinely at infinity for an unpenalized/null-space
117/// direction (complete/quasi-complete separation), no solver floor makes that
118/// direction's estimate finite. The formula REML path arms the full-span
119/// Jeffreys/Firth correction CONDITIONALLY — only on separation evidence (see
120/// [`multinomial_formula_separation_evidence`] and the two-attempt logic in
121/// [`fit_penalized_multinomial_formula`]) — so an interior, well-identified fit
122/// optimizes the unbiased penalized-REML criterion with no Firth shrinkage
123/// toward the uniform simplex, while a (quasi-)separated geometry gets the
124/// proper prior that is the only thing able to bound its penalty-null
125/// directions (#715 real-data arm). The bare fixed-λ inner driver
126/// [`fit_penalized_multinomial`] (no outer REML, no Jeffreys term) surfaces the
127/// explicit `MultinomialSeparationDetected` diagnostic for the path that has no
128/// proper prior to lean on.
129const MULTINOMIAL_FORMULA_RIDGE_FLOOR: f64 = 1.0e-4;
130
131/// Inner joint-Newton KKT tolerance for the multinomial formula path.
132///
133/// The softmax Fisher weight `W = diag(p) − ppᵀ` collapses on saturated rows,
134/// so near-separable fits (penguins, #715) reach the OBJECTIVE's f64 noise
135/// floor before the default `inner_tol = 1e-6` KKT target: measured on the
136/// penguins arm (standardized columns), the trust region collapses to 1e-12
137/// with per-attempt objective changes of ~+2e-9 on |obj| ≈ 1e2 (≈ 1e-11
138/// relative — pure rounding) while the KKT residual plateaus at 2.8e-5–9.4e-5
139/// against a scaled tolerance of ~1.9e-5. Demanding a residual below the
140/// floating-point noise floor is certifiable-never: every eval is rejected by
141/// the stall guard and the whole fit fails. `1e-5` certifies the measured
142/// plateaus while still resolving β to ~1e-6 in the relevant metric — the
143/// LAML criterion consumes β̂ with error O(residual²/curvature), far below
144/// any quantity the outer ρ-search can read.
145const MULTINOMIAL_FORMULA_INNER_TOL: f64 = 1.0e-5;
146
147/// Formula-adapter penalty calibration for multinomial softmax REML.
148///
149/// The term builder's normalized penalties are calibrated on single-response
150/// Gaussian-style score curvature. A reference-coded softmax class block sees
151/// per-row active-class Fisher diagonal `p_a(1-p_a)` plus negative cross-class
152/// coupling. At the neutral simplex (`p_k = 1/K`) the active diagonal is
153/// `(K-1)/K²`, so the binary-logit calibration is `2·(K-1)/K² = 1/2` and the
154/// three-class calibration is `4/9` rather than the historical hard-coded
155/// `1/2`. Making the scale a function of `K` keeps the physical smoothness
156/// prior tied to the likelihood curvature instead of over-penalizing every
157/// class as the simplex gains categories.
158fn multinomial_formula_penalty_scale(n_classes: usize) -> f64 {
159    let k = n_classes.max(2) as f64;
160    2.0 * (k - 1.0) / (k * k)
161}
162
163/// Largest smoothing-parameter dimension where exact dense outer curvature is
164/// still worth paying for multinomial formula fits.
165///
166/// `D = (K - 1) * n_penalties`. Medium-size loaded models use exact curvature
167/// so the optimizer does not wander into over-smoothed lambda caps on
168/// near-boundary softmax surfaces. The threshold was originally calibrated at
169/// `D <= 6` when each `s()` term carried ONE penalty; the double-penalty
170/// migration (wiggliness + null-space shrinkage per term, mgcv `select=TRUE`
171/// semantics) doubled `D` for the SAME models, silently flipping the
172/// reference formula fits (2 smooths, K = 3: old `D = 4`, now `D = 8`) onto
173/// the gradient-only route — where the #715 quality arm showed every
174/// wiggliness ρ driven onto the ±10 box bound (smooths collapsed toward their
175/// polynomial null space, truth-RMSE behind VGAM). `12 = 2 × 6` preserves the
176/// original classification boundary under the doubled penalty count while
177/// keeping the four-smooth penguin species quality fixture on the exact ARC
178/// path: that model is `D = 16`, and first-order BFGS can cycle along the
179/// near-separable lambda-to-zero ridge until the wall-clock budget expires
180/// (#1082). ARC observes the same exact curvature and can halt through the
181/// bound-aware cost-stall guard once the REML surface stops making useful
182/// progress.
183const MULTINOMIAL_EXACT_OUTER_HESSIAN_MAX_DIM: usize = 16;
184
185fn multinomial_formula_use_outer_hessian(total_rho_dim: usize) -> bool {
186    total_rho_dim <= MULTINOMIAL_EXACT_OUTER_HESSIAN_MAX_DIM
187}
188
189/// Logit magnitude beyond which fitted probabilities are saturated at ordinary
190/// double precision diagnostic scale. The bare fixed-λ driver has no outer REML
191/// state and still uses this threshold to reject a non-converged saturated
192/// iterate as a separation artifact. The formula REML path does not use this as
193/// a Firth trigger: with smoothing parameters selected, a finite saturated
194/// surface can be the valid near-separated optimum that should be scored
195/// directly.
196const MULTINOMIAL_SEPARATION_ETA_THRESHOLD: f64 = 25.0;
197
198/// Calibrated convergence tolerance for the OUTER REML/LAML smoothing-parameter
199/// search on the formula multinomial path. Matches the primary GLM REML outer
200/// (`solver::fit_orchestration::materialize` uses `tol = 1e-7`, mirrored by the
201/// `LOG_LAMBDA_TOL` / `KKT_TOL_*` constants across the REML stack): tight enough
202/// that the selected λ reaches the genuine REML optimum (the recovered
203/// probability surface matches the mature reference), loose enough that the
204/// optimizer does not grind surface-irrelevant ρ digits down to the inner KKT
205/// scale (the #1082 wall-clock overrun). The caller's `tol` is floored at this
206/// value for the OUTER loop, while it continues to drive the INNER joint-Newton
207/// KKT target unchanged.
208const MULTINOMIAL_OUTER_REML_TOL: f64 = 1e-7;
209
210/// The first multinomial formula solve is a separation probe: it is accepted
211/// when the unbiased REML criterion converges to a finite interior iterate.
212/// Near-separable data such as the penguin fixture otherwise spend the caller's
213/// full outer budget on an iterate that is discarded before the Firth/Jeffreys
214/// refit. Keep enough iterations for ordinary interior fits to certify quickly,
215/// but hand slow/non-interior probes to the proper-prior refit promptly.
216const MULTINOMIAL_UNBIASED_PROBE_OUTER_MAX_ITER: usize = 20;
217
218/// Per-observation softmax Fisher-information scale for the λ-floor units.
219///
220/// The penalty enters the criterion as `½ λ βᵀ S β` with a Frobenius-normalized
221/// `S` (`‖S‖_F = 1`, see the term-builder calibration referenced by
222/// [`multinomial_formula_penalty_scale`]), so the ridge `λ S` is directly
223/// comparable to data Fisher information. One observation contributes softmax
224/// information `p(1−p)` in a class's logit direction, which is bounded by the
225/// logistic peak `p(1−p) ≤ ¼` at `p = ½`. Using this maximal per-observation
226/// information as the unit makes the floor's strength interpretable as a count
227/// of equivalent **pseudo-observations** of prior: a ridge that equals
228/// `τ · ¼ · ‖S‖_F` carries the same logit-direction curvature as `τ` real rows
229/// sitting at the most-informative point of the likelihood. This scale is
230/// `K`-independent on purpose — the `K`-dependence of the softmax block
231/// curvature already lives in the penalty matrix via
232/// [`multinomial_formula_penalty_scale`], so the floor (a bound on the
233/// multiplier of that already-scaled penalty) must not double-count it.
234const MULTINOMIAL_FORMULA_FISHER_INFO_PER_OBS: f64 = 0.25;
235
236/// Target prior strength of the λ-floor, in pseudo-observations, for a
237/// WELL-SUPPORTED class. The floor holds the unbiased REML optimizer off the
238/// zero-penalty boundary (where a boundary-overfit smooth or a Firth switch on
239/// finite data would otherwise be accepted) with a prior worth a fixed small
240/// fraction of one observation. `8e-4` pseudo-observations reproduces the
241/// previously fixture-calibrated large-support floor `τ · ¼ = 2e-4` exactly at
242/// the calibration point, now expressed as an effective-prior-strength rather
243/// than a tuned λ value.
244const MULTINOMIAL_FORMULA_PRIOR_PSEUDO_OBS: f64 = 8.0e-4;
245
246/// Reference class support `n_ref`: the effective sample size per class at which
247/// the data Fisher information `n_c · I₁` is large enough that the floor sits at
248/// its well-supported value. Below `n_ref` the per-class data information shrinks
249/// like `n_c`, so to keep the floor's prior from vanishing *relative to* that
250/// shrinking data the effective pseudo-observation count is scaled up by
251/// `n_ref / n_c` (the prior is held to a fixed fraction of the data information,
252/// not a fixed absolute λ). At `n_c = n_ref` the scale is exactly 1.
253const MULTINOMIAL_FORMULA_SPARSE_REFERENCE_SUPPORT: f64 = 50.0;
254
255/// Cap on the floor's prior strength in the very-sparse limit, in
256/// pseudo-observations. As `n_c → 0` the `n_ref / n_c` scaling diverges; the cap
257/// holds the prior at `4e-3` pseudo-observations (`τ_max · ¼ = 1e-3` at the
258/// calibration point, the previously-tuned strong-floor value) so the floor
259/// stays a proper prior rather than a hard constraint that would dominate the
260/// likelihood for a handful-of-rows class.
261const MULTINOMIAL_FORMULA_SPARSE_PRIOR_PSEUDO_OBS_MAX: f64 = 4.0e-3;
262
263/// Continuous, Fisher-information-scaled lower λ floor for the formula path,
264/// derived from the minority class's effective sample size `n_c`.
265///
266/// # Derivation (effective-prior-strength / Fisher geometry)
267///
268/// The penalty `½ λ βᵀ S β` with `‖S‖_F = 1` adds curvature `λ` to the class
269/// logit direction; one observation adds at most `I₁ = ¼` there. So a floor that
270/// sets `λ_floor = τ_eff · I₁` gives the smooth a prior worth `τ_eff`
271/// pseudo-observations. We want a fixed *absolute* prior `τ` for a well-supported
272/// class, but for a minority class with only `n_c` effective observations the
273/// data information in its block is `n_c · I₁`; holding the prior to a fixed
274/// *fraction* of that shrinking data information requires
275///
276/// ```text
277///     τ_eff(n_c) = τ · max(1, n_ref / n_c),   clamped to [τ, τ_max]
278///     λ_floor(n_c) = τ_eff(n_c) · I₁
279/// ```
280///
281/// This is the *same* `base · max(1, c0/c)` envelope as before — but `base`,
282/// `sparse`, and `c0` are no longer fixture-tuned magic numbers: `base = τ·I₁`,
283/// `sparse = τ_max·I₁`, and `c0 = n_ref` are an effective-prior-strength of
284/// `τ`/`τ_max` pseudo-observations against the maximal per-observation softmax
285/// information `I₁ = ¼`. Properties preserved by construction:
286///   * reduces EXACTLY to `τ·I₁` for well-supported classes (`n_c ≥ n_ref`);
287///   * reduces EXACTLY to `τ_max·I₁` for very sparse classes
288///     (`n_c ≤ n_ref·τ/τ_max`, here `n_c ≤ 10`);
289///   * interpolates monotonically and continuously between them in the middle —
290///     no cliff at `n_c = n_ref`.
291/// At the calibration point the endpoints equal the previous `2e-4` / `1e-3`, so
292/// fixtures whose smallest class has `n_c ≥ 50` (penguins, the vgam softmax
293/// arms) are unaffected — they sit at `τ·I₁ = 2e-4` exactly as before.
294fn multinomial_formula_min_lambda(y_one_hot: ArrayView2<'_, f64>) -> f64 {
295    let base = MULTINOMIAL_FORMULA_PRIOR_PSEUDO_OBS * MULTINOMIAL_FORMULA_FISHER_INFO_PER_OBS;
296    let sparse =
297        MULTINOMIAL_FORMULA_SPARSE_PRIOR_PSEUDO_OBS_MAX * MULTINOMIAL_FORMULA_FISHER_INFO_PER_OBS;
298    let min_class_count = (0..y_one_hot.ncols())
299        .map(|class| y_one_hot.column(class).sum())
300        .fold(f64::INFINITY, f64::min);
301    if !min_class_count.is_finite() || min_class_count <= 0.0 {
302        return base;
303    }
304    // Effective pseudo-observation prior strength: held to a fixed fraction of
305    // the shrinking per-class data information once n_c falls below n_ref.
306    let pseudo_obs_scale =
307        (MULTINOMIAL_FORMULA_SPARSE_REFERENCE_SUPPORT / min_class_count).max(1.0);
308    (base * pseudo_obs_scale).clamp(base, sparse)
309}
310
311fn max_abs_eta_location(eta: ArrayView2<'_, f64>) -> (f64, usize, usize) {
312    let mut best = (0.0_f64, 0usize, 0usize);
313    for ((row, active_class), &value) in eta.indexed_iter() {
314        let abs = value.abs();
315        if abs > best.0 {
316            best = (abs, row, active_class);
317        }
318    }
319    best
320}
321
322/// Separation gate for the REML/LAML **formula** path.
323///
324/// Unlike the bare fixed-λ driver [`fit_penalized_multinomial`] (which has no
325/// outer REML state and so must reject a saturated, non-converged iterate as a
326/// separation artifact at the [`MULTINOMIAL_SEPARATION_ETA_THRESHOLD`] logit
327/// magnitude), the formula path can return a finite saturated mode after the
328/// coupled outer optimizer has selected smoothing parameters. A `|η| >= 25`
329/// gate is therefore wrong here: the penguins arm can legitimately have large
330/// fitted logits while still producing finite probabilities and a usable REML
331/// mode.
332///
333/// Only a genuinely NON-FINITE `η` (a NaN/Inf blow-up in the inner linear
334/// algebra) is a real formula-path failure. A finite, even saturated, `η` is
335/// accepted so the truth-recovery / match-or-beat bars are evaluated against the
336/// actual fitted surface instead of an adapter diagnostic.
337fn multinomial_formula_separation_diagnostic(
338    inner_cycles: usize,
339    outer_iterations: usize,
340    block_states: &[ParameterBlockState],
341) -> Option<EstimationError> {
342    let mut nonfinite: Option<(f64, usize, usize)> = None;
343    for (active_class, state) in block_states.iter().enumerate() {
344        for (row, &value) in state.eta.iter().enumerate() {
345            if !value.is_finite() {
346                nonfinite = Some((value, row, active_class));
347                break;
348            }
349        }
350        if nonfinite.is_some() {
351            break;
352        }
353    }
354    nonfinite.map(|(value, row_index, active_class_index)| {
355        EstimationError::MultinomialSeparationDetected {
356            iteration: inner_cycles.max(outer_iterations),
357            max_abs_eta: value.abs(),
358            active_class_index,
359            row_index,
360        }
361    })
362}
363
364/// Separation EVIDENCE gate for the conditional Firth/Jeffreys engagement on
365/// the formula REML path (#715 / #753).
366///
367/// The structural mathematics (#715 issue thread): for any coefficient
368/// direction `v` with `S v = 0` (a penalty-null direction — intercept, a
369/// smooth's polynomial null component, an unpenalized parametric term), the
370/// penalized joint Hessian satisfies `(H + S_λ) v = H v` for EVERY smoothing
371/// parameter ρ. When the data (quasi-)separate, the softmax Fisher weight
372/// `W = diag(p) − p pᵀ → 0` on the saturated rows, so `H v = JᵀWJ v → 0` along
373/// the penalty-null directions those rows support: `(H + S_λ) v ≈ 0` for every
374/// ρ — NO λ can repair it, the inner Newton can never certify a KKT point
375/// there, and every outer REML startup seed is rejected (the penguins
376/// real-data arm). The only principled cure is a PROPER prior on that
377/// quotient-null subspace — the Jeffreys/Firth term `Φ = ½ log|ZᵀHZ|`, whose
378/// Gauss–Newton curvature supplies the missing `O(1)` bound.
379///
380/// But the Firth prior is not free on interior data: unconditionally armed, it
381/// shrinks fitted class probabilities toward the uniform simplex `1/K`
382/// (an `O(1/n)` pull that the synthetic match-or-beat arm of #715 measured as
383/// a real truth-RMSE loss vs the unbiased criterion). So the formula path
384/// engages it ONLY on separation evidence, mirroring the #753 "diagnose, then
385/// arm" split:
386///
387/// * a NON-FINITE logit — the inner linear algebra blew up along an unbounded
388///   direction.
389///
390/// Returns `Some(description)` naming the witnessing logit when evidence is
391/// found, `None` for a finite fit (which is then accepted as-is, with zero
392/// Firth bias). A FAILED unbiased solve (`Err` from the rho-prior driver, e.g.
393/// "no startup seed passed") is the second evidence form and is handled
394/// directly at the call site in [`fit_penalized_multinomial_formula`].
395fn multinomial_formula_separation_evidence(block_states: &[ParameterBlockState]) -> Option<String> {
396    for (active_class, state) in block_states.iter().enumerate() {
397        for (row, &value) in state.eta.iter().enumerate() {
398            if !value.is_finite() {
399                return Some(format!(
400                    "non-finite logit eta[row {row}, active class {active_class}] = {value}"
401                ));
402            }
403        }
404    }
405    None
406}
407
408/// Extra evidence used only for a NON-CONVERGED capped unbiased probe.
409///
410/// A converged finite saturated formula fit is still a valid optimum and must be
411/// scored without Firth bias. A capped probe that failed to converge while it
412/// already carries separation-scale logits is different: spending the full
413/// unbiased outer budget on the same lambda-to-zero surface is the #1082
414/// timeout. Route that case straight to the proper-prior refit.
415fn multinomial_formula_unresolved_probe_separation_evidence(
416    block_states: &[ParameterBlockState],
417) -> Option<String> {
418    if let Some(evidence) = multinomial_formula_separation_evidence(block_states) {
419        return Some(evidence);
420    }
421
422    let mut best = (0.0_f64, 0usize, 0usize);
423    for (active_class, state) in block_states.iter().enumerate() {
424        for (row, &value) in state.eta.iter().enumerate() {
425            let abs = value.abs();
426            if abs > best.0 {
427                best = (abs, row, active_class);
428            }
429        }
430    }
431    if best.0 >= MULTINOMIAL_SEPARATION_ETA_THRESHOLD {
432        Some(format!(
433            "separation-scale finite logit |eta[row {}, active class {}]| = {:.3e} \
434             after capped unbiased probe",
435            best.1, best.2, best.0
436        ))
437    } else {
438        None
439    }
440}
441
442/// Inputs to [`fit_penalized_multinomial`].
443///
444/// The penalty matrix `S` is shared across classes; per-class smoothing
445/// parameters `lambdas` (length `K - 1`) scale `S` independently for each
446/// active class. The full block-replicated penalty is `diag_a(λ_a) ⊗ S`,
447/// which is exactly what [`gam_solve::arrow_schur::KroneckerPenaltyOp`]
448/// expresses in matrix-free form when this driver is later lifted into the
449/// arrow-Schur loop.
450#[derive(Debug, Clone)]
451pub struct MultinomialFitInputs<'a> {
452    /// Design matrix `X ∈ ℝ^{N×P}` (one row per observation).
453    pub design: ArrayView2<'a, f64>,
454    /// Categorical response `Y ∈ ℝ^{N×K}`. Each row must be a point on the
455    /// probability simplex (`y_c ≥ 0`, `Σ_c y_c = 1`): a one-hot indicator for
456    /// hard classification, or a label-smoothed probability vector. Rows whose
457    /// mass departs from 1 are rejected — the softmax residual gradient and
458    /// Fisher block are the derivatives of `Σ_c y_c log p_c` only under the
459    /// simplex constraint (see `validate_multinomial_simplex`).
460    pub y_one_hot: ArrayView2<'a, f64>,
461    /// Shared smoothing penalty `S ∈ ℝ^{P×P}` (symmetric, PSD).
462    pub penalty: ArrayView2<'a, f64>,
463    /// Per-active-class smoothing parameter `λ_a` (length `K - 1`).
464    pub lambdas: ArrayView1<'a, f64>,
465    /// Optional per-row weights (length `N`); `None` ⇒ uniform 1.0.
466    pub row_weights: Option<ArrayView1<'a, f64>>,
467    /// Optional per-row Fisher-block override, shape `(N, K-1, K-1)` in the
468    /// active-class gauge (the reference class `K-1` is dropped). When `Some`,
469    /// each Newton step uses this block as the curvature `W` in place of the
470    /// analytic softmax Fisher `w_n (δ_ab p_a − p_a p_b)`; the gradient/residual
471    /// path stays analytic, so this is a curvature-only override (the
472    /// research escape-hatch for latent multinomial fits, issue #349). Each
473    /// per-row block must be symmetric, PSD, and finite — preconditions the
474    /// FFI boundary discharges before constructing this view.
475    pub fisher_w_override: Option<ArrayView3<'a, f64>>,
476    /// Maximum Newton iterations; recommend 50.
477    pub max_iter: usize,
478    /// Relative-step convergence tolerance; recommend 1e-7.
479    pub tol: f64,
480}
481
482/// Outputs of [`fit_penalized_multinomial`].
483#[derive(Debug, Clone)]
484pub struct MultinomialFitOutputs {
485    /// Active-class coefficient block, shape `(P, K-1)` (column `a` is `β_a`).
486    /// The reference class `K - 1` has `β_{K-1} ≡ 0` by construction and is
487    /// not stored.
488    pub coefficients_active: Array2<f64>,
489    /// Fitted probabilities, shape `(N, K)`.
490    pub fitted_probabilities: Array2<f64>,
491    /// Number of Newton iterations executed (including the final step that
492    /// satisfied the tolerance).
493    pub iterations: usize,
494    /// `true` if the relative-step test was satisfied; `false` if the
495    /// solver exhausted `max_iter`. (A non-converged solve is still
496    /// returned; the caller decides whether to escalate.)
497    pub converged: bool,
498    /// Penalized negative log-likelihood at the returned `β̂`:
499    /// `−log L(β̂) + ½ Σ_a λ_a · β̂_a^T S β̂_a`.
500    pub penalized_neg_log_likelihood: f64,
501    /// Unpenalized deviance `−2 log L(β̂)` for diagnostic reporting.
502    pub deviance: f64,
503}
504
505/// Fit a penalized multinomial-logit GAM at fixed `λ`.
506///
507/// See the module docs for the optimization problem and conventions. This
508/// function is the canonical inner solve: the outer REML/LAML loop, when
509/// added, calls this at each `ρ = log λ` trial.
510pub fn fit_penalized_multinomial(
511    inputs: MultinomialFitInputs<'_>,
512) -> Result<MultinomialFitOutputs, EstimationError> {
513    let MultinomialFitInputs {
514        design,
515        y_one_hot,
516        penalty,
517        lambdas,
518        row_weights,
519        fisher_w_override,
520        max_iter,
521        tol,
522    } = inputs;
523
524    // ──────────────────────── family-specific validation ───────────────────
525    // The shared engine re-validates the geometry common to every vector-GLM
526    // (nonempty design, penalty shape, λ finiteness/non-negativity, override
527    // `(N, M, M)` shape, finite design). The multinomial family owns the
528    // class-count contract (`K ≥ 2`, λ length `K − 1`), the per-row simplex
529    // precondition under which the softmax residual/Fisher are the exact
530    // derivatives of `Σ_c y_c log p_c`, and the row-weight check the likelihood
531    // adapter consumes.
532    let n_obs = design.nrows();
533    let (y_rows, k) = y_one_hot.dim();
534    if y_rows != n_obs {
535        crate::bail_invalid_estim!(
536            "fit_penalized_multinomial: y rows {y_rows} ≠ design rows {n_obs}"
537        );
538    }
539    if k < 2 {
540        crate::bail_invalid_estim!(
541            "fit_penalized_multinomial: need at least 2 classes (got K={k})"
542        );
543    }
544    let m = k - 1;
545    if lambdas.len() != m {
546        crate::bail_invalid_estim!(
547            "fit_penalized_multinomial: lambdas length {} ≠ K-1 = {m}",
548            lambdas.len()
549        );
550    }
551    if let Some(fw) = fisher_w_override.as_ref() {
552        if fw.dim() != (n_obs, m, m) {
553            crate::bail_invalid_estim!(
554                "fit_penalized_multinomial: fisher_w_override shape {:?} ≠ (N, K-1, K-1) = ({n_obs}, {m}, {m})",
555                fw.dim()
556            );
557        }
558    }
559    if let Some(w) = row_weights.as_ref() {
560        if w.len() != n_obs {
561            crate::bail_invalid_estim!(
562                "fit_penalized_multinomial: row_weights length {} ≠ N = {n_obs}",
563                w.len()
564            );
565        }
566        for (i, &v) in w.iter().enumerate() {
567            if !(v.is_finite() && v >= 0.0) {
568                crate::bail_invalid_estim!(
569                    "fit_penalized_multinomial: row_weights[{i}] must be finite and ≥ 0 (got {v})"
570                );
571            }
572        }
573    }
574    validate_multinomial_simplex(y_one_hot, "fit_penalized_multinomial")?;
575
576    // ────────────────────────── likelihood construction ───────────────────
577    let mut likelihood = MultinomialLogitLikelihood::with_classes(k)?;
578    if let Some(w) = row_weights.as_ref() {
579        likelihood = likelihood.with_row_weights(w.to_owned())?;
580    }
581
582    // ─────────────────── shared penalized vector-GLM solve ─────────────────
583    // The softmax Fisher block is dense across the `M = K − 1` active classes;
584    // the engine assembles the coupled `(P·M)×(P·M)` penalized Hessian, runs
585    // the damped Newton loop, and returns the converged `β̂` and `η = X β̂`.
586    let fit = fit_penalized_vector_glm(
587        PenalizedVectorGlmInputs {
588            design,
589            y: y_one_hot,
590            penalty,
591            lambdas,
592            fisher_w_override,
593            max_iter,
594            tol,
595            // #1587: production multinomial still uses the per-class Diagonal
596            // metric pending the REML per-class→per-term λ re-key that the
597            // reference-symmetric Centered metric requires (shared λ). The
598            // Centered engine path + its invariance proof land first.
599            class_penalty_metric: crate::penalized_vector_glm::ClassPenaltyMetric::Diagonal,
600        },
601        &likelihood,
602        "fit_penalized_multinomial",
603    )?;
604
605    let (max_abs_eta, row_index, active_class_index) = max_abs_eta_location(fit.eta.view());
606    if !fit.converged && max_abs_eta >= MULTINOMIAL_SEPARATION_ETA_THRESHOLD {
607        return Err(EstimationError::MultinomialSeparationDetected {
608            iteration: fit.iterations,
609            max_abs_eta,
610            active_class_index,
611            row_index,
612        });
613    }
614
615    let fitted_probabilities = likelihood.probabilities(fit.eta.view());
616
617    Ok(MultinomialFitOutputs {
618        coefficients_active: fit.coefficients,
619        fitted_probabilities,
620        iterations: fit.iterations,
621        converged: fit.converged,
622        penalized_neg_log_likelihood: -fit.log_likelihood + fit.penalty_term,
623        deviance: -2.0 * fit.log_likelihood,
624    })
625}
626
627// ---------------------------------------------------------------------------
628// Formula-driven multinomial pipeline
629// ---------------------------------------------------------------------------
630//
631// Slice A of the multinomial integration: a single public entry that takes
632// a parsed `EncodedDataset`, a Wilkinson-style formula, and a uniform initial
633// smoothing parameter, then runs the full
634//
635//     parse → termspec → design (X, S blocks) → one-hot Y → REML λ-selection
636//
637// pipeline. `fit_penalized_multinomial_formula` drives the outer REML/LAML
638// loop (via the custom-family path) to select an independent λ per (class,
639// term); `init_lambda` (default 1.0) is only the warm-start seed for every
640// block. The reference class is the last level of the categorical response
641// column as recorded in the dataset schema.
642
643/// Saved-model payload for a multinomial fit driven by a Wilkinson formula.
644///
645/// This is what the FFI returns to Python. It carries everything the Python
646/// `MultinomialModel.predict` path needs to evaluate `softmax(X_new · β)` on
647/// fresh data using the *training* basis / penalty structure (no refit on
648/// predict, no re-derivation of class levels).
649#[derive(Debug, Clone, Serialize, Deserialize)]
650pub struct MultinomialSavedModel {
651    /// The training formula, verbatim. Stored so Python's `summary()` and
652    /// any round-trip persistence path can echo what was fit.
653    pub formula: String,
654    /// Names of the *training* response levels in canonical order. The last
655    /// entry is the reference class (η = 0); the first `K - 1` carry the
656    /// active linear-predictor blocks. Class permutations are forbidden:
657    /// this list is fixed at fit time and predictions emit columns in the
658    /// same order.
659    pub class_levels: Vec<String>,
660    /// Index of the reference class within `class_levels` — currently always
661    /// `class_levels.len() - 1`, exposed as a field so future "user-pinned
662    /// reference" gauges (e.g. `family='multinomial', reference='setosa'`)
663    /// can land without changing the on-disk shape.
664    pub reference_class_index: usize,
665    /// Resolved term-collection spec used to build `X` at fit time. Replayed
666    /// on predict via [`gam_terms::smooth::build_term_collection_design`].
667    pub resolved_termspec: TermCollectionSpec,
668    /// Active-class coefficient block, shape `(P, K-1)`. Column `a` is the
669    /// coefficient vector for class `class_levels[a]`. Stored flat in
670    /// row-major order to keep the serde payload self-describing.
671    pub coefficients_flat: Vec<f64>,
672    /// `P` — coefficient count per active class. Matches the column count of
673    /// the design matrix the saved `resolved_termspec` produces.
674    pub p_per_class: usize,
675    /// Number of active classes (`K - 1`).
676    pub n_active_classes: usize,
677    /// Original training column headers, in dataset-column order. Needed at
678    /// predict time so the FFI can align a fresh `Dataset` to the training
679    /// schema before evaluating the basis.
680    pub training_headers: Vec<String>,
681    /// REML/LAML-selected smoothing parameters, one per `(active class, smooth
682    /// term)`, flattened in block-major order: all of class 0's per-term λ,
683    /// then class 1's, and so on. Per-term penalties (#561) mean each active
684    /// class block selects an *independent* λ for every smooth term, so this
685    /// vector has length `Σ_a (#terms in class a)` = `(K − 1) · #terms`. Use
686    /// [`MultinomialSavedModel::lambdas_per_block`] to segment it by class. An
687    /// unpenalized model (no smooth terms) yields an empty vector.
688    pub lambdas: Vec<f64>,
689    /// Number of smoothing parameters (smooth terms) in each active class
690    /// block, parallel to `class_levels[0..K-1]`. Segments the flat `lambdas`
691    /// vector: class `a`'s λ are `lambdas[Σ_{b<a} lambdas_per_block[b] ..][..
692    /// lambdas_per_block[a]]`. Every entry is identical in the shared-design
693    /// architecture (all classes share the same term structure), but it is
694    /// stored explicitly so consumers never have to assume that.
695    pub lambdas_per_block: Vec<usize>,
696    /// Newton iterations executed; recorded for the summary report.
697    pub iterations: usize,
698    /// `true` if the inner Newton solver hit the relative-step tolerance.
699    pub converged: bool,
700    /// Penalized negative log-likelihood at the returned `β̂`.
701    pub penalized_neg_log_likelihood: f64,
702    /// Unpenalized deviance `−2 log L(β̂)`.
703    pub deviance: f64,
704    /// Per-active-class effective degrees of freedom (hat-matrix trace),
705    /// length `K - 1`. Populated when the REML driver reports an
706    /// inference block; falls back to `None` for the legacy fixed-λ path.
707    #[serde(default)]
708    pub edf_per_class: Option<Vec<f64>>,
709    /// Joint posterior coefficient covariance `H⁻¹` (#1101), block-ordered to
710    /// match the stacked active-class coefficient vector `β = [β_0; …; β_{K-2}]`
711    /// (class `a`'s `P` coefficients occupy rows/cols `a·P .. (a+1)·P`). This is
712    /// the Laplace covariance the REML driver already computes from the factored
713    /// penalized Hessian; storing it gives the predict path delta-method
714    /// per-class probability standard errors and the summary its Wald
715    /// smooth-term tests. Flattened row-major over the `(P·M)×(P·M)` matrix.
716    /// `None` for a model fitted before covariance was surfaced.
717    #[serde(default)]
718    pub coefficient_covariance_flat: Option<Vec<f64>>,
719    /// Joint coefficient-space influence matrix `F = H⁻¹ X'WX` (#1101),
720    /// block-ordered identically to [`Self::coefficient_covariance_flat`].
721    /// Its per-term diagonal block trace is the term's effective degrees of
722    /// freedom and its `tr(F_jj)²/tr(F_jj²)` the Wood reference d.f., feeding
723    /// the rank-truncated Wald smooth-term test in `summary()`. Flattened
724    /// row-major over the `(P·M)×(P·M)` matrix. `None` when unavailable.
725    #[serde(default)]
726    pub coefficient_influence_flat: Option<Vec<f64>>,
727    /// Per-(active class, smooth term) coefficient column range and unpenalized
728    /// nullspace dimension within the `P`-wide class block (#1101). Parallel to
729    /// the smooth terms the design produced; replicated across classes by the
730    /// shared-design architecture. Drives the Wald smooth-term table in
731    /// `summary()`. Empty for a wholly parametric (no-smooth) model.
732    #[serde(default)]
733    pub smooth_term_spans: Vec<MultinomialSmoothTermSpan>,
734    /// One descriptive label per *penalty component* within a single active-class
735    /// block, parallel to that block's λ slice (i.e. length
736    /// `lambdas_per_block[0]`). The Marra–Wood double penalty (and tensor /
737    /// operator smooths) emit **more than one** penalty component — hence more
738    /// than one λ — per smooth term, so this is NOT 1:1 with
739    /// [`Self::smooth_term_spans`]: a single `s(x)` term contributes a primary
740    /// wiggliness λ labelled `s(x)` and a null-space shrinkage λ labelled
741    /// `s(x) [null space]`. The summary renderer pairs `lambdas` with these
742    /// labels component-for-component so no λ is ever dropped (#1544). Built from
743    /// the per-component term name + penalty role at fit time; empty for a
744    /// wholly parametric model or a model serialized before this field existed.
745    #[serde(default)]
746    pub lambda_labels: Vec<String>,
747}
748
749/// One smooth term's coefficient span within a class block, plus its
750/// unpenalized nullspace dimension and a display label (#1101). The Wald
751/// smooth-significance test in `summary()` slices the joint covariance /
752/// influence at `a·P + col_start .. a·P + col_end` for active class `a`.
753#[derive(Debug, Clone, Serialize, Deserialize)]
754pub struct MultinomialSmoothTermSpan {
755    /// Human-readable term label (the smooth's formula token), for the table.
756    pub label: String,
757    /// Start column of the term within the per-class `P`-wide coefficient block.
758    pub col_start: usize,
759    /// End column (exclusive) of the term within the per-class block.
760    pub col_end: usize,
761    /// Leading unpenalized (polynomial nullspace) dimension within the term.
762    pub nullspace_dim: usize,
763}
764
765/// Descriptive label for one penalty *component* (one λ) within a class block,
766/// for the `summary()` per-class λ rollup (#1544). A smooth term can emit
767/// several penalty components — the Marra–Wood double penalty splits `s(x)`
768/// into a primary wiggliness penalty and a null-space shrinkage penalty, and
769/// tensor / operator smooths emit a component per margin / differential
770/// operator — each with its own independently-selected λ. The label is the
771/// term name (from `PenaltyBlockInfo::termname`) plus a role suffix derived
772/// from the penalty's [`PenaltySource`], so each λ in the summary names both
773/// the term it smooths and the role it plays. `pen_idx` is the global penalty
774/// index, used only as a last-resort fallback label.
775fn penalty_component_label(info: Option<&PenaltyBlockInfo>, pen_idx: usize) -> String {
776    use gam_terms::basis::PenaltySource;
777    let term = info
778        .and_then(|i| i.termname.clone())
779        .unwrap_or_else(|| format!("s{pen_idx}"));
780    let role = match info.map(|i| &i.penalty.source) {
781        // The primary wiggliness penalty is the term's "main" λ; show the bare
782        // term name so the common single-penalty case reads cleanly.
783        Some(PenaltySource::Primary) | None => None,
784        Some(PenaltySource::DoublePenaltyNullspace) => Some("null space".to_string()),
785        Some(PenaltySource::OperatorMass) => Some("mass".to_string()),
786        Some(PenaltySource::OperatorTension) => Some("tension".to_string()),
787        Some(PenaltySource::OperatorStiffness) => Some("stiffness".to_string()),
788        Some(PenaltySource::OperatorRelevance { axis }) => Some(format!("axis {axis}")),
789        Some(PenaltySource::TensorMarginal { dim }) => Some(format!("margin {dim}")),
790        Some(PenaltySource::TensorSeparable { penalized_margins }) => {
791            Some(format!("separable {penalized_margins:?}"))
792        }
793        Some(PenaltySource::TensorGlobalRidge) => Some("ridge".to_string()),
794        Some(PenaltySource::Other(s)) => Some(s.clone()),
795    };
796    match role {
797        Some(role) => format!("{term} [{role}]"),
798        None => term,
799    }
800}
801
802impl MultinomialSavedModel {
803    /// Active-class coefficient block as an `(P, K-1)` `ndarray` view.
804    pub fn coefficients_active(&self) -> Array2<f64> {
805        Array2::from_shape_vec(
806            (self.p_per_class, self.n_active_classes),
807            self.coefficients_flat.clone(),
808        )
809        .expect(
810            "MultinomialSavedModel.coefficients_flat length must equal p_per_class * n_active_classes",
811        )
812    }
813
814    /// Evaluate `softmax(X · β)` at fresh data rows. `X_new` must have
815    /// `self.p_per_class` columns (i.e. it was built from the same
816    /// `resolved_termspec` as fit time). Returns an `(N_new, K)` matrix
817    /// with rows summing to 1; column order matches `self.class_levels`.
818    pub fn predict_probabilities(&self, x_new: ArrayView2<'_, f64>) -> Array2<f64> {
819        let n_new = x_new.nrows();
820        let p = self.p_per_class;
821        let m = self.n_active_classes;
822        let k = m + 1;
823        assert_eq!(
824            x_new.ncols(),
825            p,
826            "MultinomialSavedModel.predict_probabilities: X has {} cols, expected {p}",
827            x_new.ncols()
828        );
829        let beta = self.coefficients_active();
830        let mut probs = Array2::<f64>::zeros((n_new, k));
831        let mut eta_active = vec![0.0_f64; m];
832        let mut row_probs = vec![0.0_f64; k];
833        for row in 0..n_new {
834            for a in 0..m {
835                let mut v = 0.0_f64;
836                for i in 0..p {
837                    v += x_new[[row, i]] * beta[[i, a]];
838                }
839                eta_active[a] = v;
840            }
841            MultinomialLogitLikelihood::softmax_with_baseline(&eta_active, &mut row_probs);
842            for c in 0..k {
843                probs[[row, c]] = row_probs[c];
844            }
845        }
846        probs
847    }
848
849    /// Reconstruct the joint posterior covariance `H⁻¹` as a `(P·M)×(P·M)`
850    /// `ndarray`, block-ordered to match the stacked coefficient vector
851    /// `θ[a·P + i] = β[i, a]` (#1101). `None` when the model was fitted before
852    /// covariance was surfaced (legacy payload).
853    pub fn coefficient_covariance(&self) -> Option<Array2<f64>> {
854        let d = self.p_per_class.checked_mul(self.n_active_classes)?;
855        let flat = self.coefficient_covariance_flat.as_ref()?;
856        Array2::from_shape_vec((d, d), flat.clone()).ok()
857    }
858
859    /// Reconstruct the joint influence matrix `F = H⁻¹ X'WX` as a
860    /// `(P·M)×(P·M)` `ndarray`, block-ordered like
861    /// [`Self::coefficient_covariance`] (#1101). `None` when unavailable.
862    pub fn coefficient_influence(&self) -> Option<Array2<f64>> {
863        let d = self.p_per_class.checked_mul(self.n_active_classes)?;
864        let flat = self.coefficient_influence_flat.as_ref()?;
865        Array2::from_shape_vec((d, d), flat.clone()).ok()
866    }
867
868    /// Evaluate `softmax(X·β)` AND its delta-method per-class probability
869    /// standard error at fresh data rows (#1101).
870    ///
871    /// For active classes `b ∈ 0..M` the softmax Jacobian is
872    /// `∂p_c/∂η_b = p_c (δ_{cb} − p_b)`, and `∂η_b/∂β[i,a] = X[i]·δ_{ab}`, so the
873    /// gradient of class-`c` probability w.r.t. the block-ordered coefficient
874    /// vector is `g_c[a·P + i] = X[i]·p_c (δ_{ca} − p_a)` (active `a`; the
875    /// reference class `M` contributes `p_c(0 − p_a)` via every active block).
876    /// The delta-method variance is `Var(p_c) = g_cᵀ Σ g_c` with `Σ = H⁻¹` the
877    /// joint posterior covariance, and `SE(p_c) = √Var(p_c)`. Returns
878    /// `(probs (N,K), prob_se (N,K))`; `prob_se` is `None` when no covariance is
879    /// stored. The simplex `[0,1]` clamp is applied by the interval consumer, not
880    /// here (the SE itself is unclamped).
881    pub fn predict_probabilities_with_se(
882        &self,
883        x_new: ArrayView2<'_, f64>,
884    ) -> (Array2<f64>, Option<Array2<f64>>) {
885        let probs = self.predict_probabilities(x_new);
886        let Some(cov) = self.coefficient_covariance() else {
887            return (probs, None);
888        };
889        let n_new = x_new.nrows();
890        let p = self.p_per_class;
891        let m = self.n_active_classes;
892        let k = m + 1;
893        let d = p * m;
894        let mut prob_se = Array2::<f64>::zeros((n_new, k));
895        let mut grad = vec![0.0_f64; d];
896        for row in 0..n_new {
897            let prow = probs.row(row);
898            for c in 0..k {
899                let pc = prow[c];
900                // g_c[a·P + i] = X[i] · p_c · (δ_{ca} − p_a), a active.
901                for a in 0..m {
902                    let pa = prow[a];
903                    let factor = pc * (if c == a { 1.0 - pa } else { -pa });
904                    let base = a * p;
905                    for i in 0..p {
906                        grad[base + i] = x_new[[row, i]] * factor;
907                    }
908                }
909                // Var = gᵀ Σ g.
910                let mut var = 0.0_f64;
911                for r in 0..d {
912                    let gr = grad[r];
913                    if gr == 0.0 {
914                        continue;
915                    }
916                    let mut acc = 0.0_f64;
917                    for s in 0..d {
918                        acc += cov[[r, s]] * grad[s];
919                    }
920                    var += gr * acc;
921                }
922                prob_se[[row, c]] = var.max(0.0).sqrt();
923            }
924        }
925        (probs, Some(prob_se))
926    }
927
928    /// Wood (2013) rank-truncated Wald smooth-significance test per
929    /// `(active class, smooth term)` (#1101), reusing the exact scalar-summary
930    /// kernel [`gam_terms::inference::smooth_test::wood_smooth_test`]. For active
931    /// class `a` and term span `[c0, c1)` within the class block, the global
932    /// coefficient range is `a·P + c0 .. a·P + c1`; the joint covariance and
933    /// influence are sliced there. The term EDF is the influence-block trace
934    /// `tr(F_jj)` (when present) and the reference d.f. uses `tr(F_jj)²/tr(F_jj²)`,
935    /// exactly as the scalar path. The multinomial softmax is a known-dispersion
936    /// family, so the χ²_{ref_df} branch applies. Returns one row per
937    /// `(class label, term label, edf, ref_df, statistic, p_value)`; empty when
938    /// no covariance/smooth terms are available.
939    pub fn smooth_significance(&self) -> Vec<MultinomialSmoothSignificance> {
940        let mut out = Vec::new();
941        let p = self.p_per_class;
942        let m = self.n_active_classes;
943        let Some(cov) = self.coefficient_covariance() else {
944            return out;
945        };
946        if self.smooth_term_spans.is_empty() {
947            return out;
948        }
949        let beta = self.coefficients_active();
950        // Block-ordered θ = [β_0; …; β_{M-1}], θ[a·P + i] = β[i, a].
951        let d = p * m;
952        let mut theta = Array1::<f64>::zeros(d);
953        for a in 0..m {
954            for i in 0..p {
955                theta[a * p + i] = beta[[i, a]];
956            }
957        }
958        let influence = self.coefficient_influence();
959        for a in 0..m {
960            let class_label = self
961                .class_levels
962                .get(a)
963                .cloned()
964                .unwrap_or_else(|| format!("class{a}"));
965            let base = a * p;
966            for span in &self.smooth_term_spans {
967                if span.col_end > p {
968                    continue;
969                }
970                let start = base + span.col_start;
971                let end = base + span.col_end;
972                // Term EDF = tr(F_jj); without an influence matrix fall back to
973                // the block coefficient count (full-rank Wald on the span).
974                let block_len = (span.col_end - span.col_start) as f64;
975                let edf = influence
976                    .as_ref()
977                    .map(|f| (start..end).map(|i| f[[i, i]]).sum::<f64>())
978                    .filter(|v| v.is_finite() && *v > 0.0)
979                    .unwrap_or(block_len);
980                let result = gam_terms::inference::smooth_test::wood_smooth_test(
981                    gam_terms::inference::smooth_test::SmoothTestInput {
982                        beta: theta.view(),
983                        covariance: &cov,
984                        influence_matrix: influence.as_ref(),
985                        coeff_range: start..end,
986                        edf,
987                        nullspace_dim: span.nullspace_dim,
988                        residual_df: f64::INFINITY,
989                        scale: gam_terms::inference::smooth_test::SmoothTestScale::Known,
990                    },
991                );
992                if let Some(res) = result {
993                    out.push(MultinomialSmoothSignificance {
994                        class_label: class_label.clone(),
995                        term_label: span.label.clone(),
996                        edf,
997                        ref_df: res.ref_df,
998                        statistic: res.statistic,
999                        p_value: res.p_value,
1000                    });
1001                }
1002            }
1003        }
1004        out
1005    }
1006}
1007
1008/// One row of the multinomial smooth-significance table (#1101): the Wood
1009/// rank-truncated Wald test for one `(active class, smooth term)` pair.
1010#[derive(Debug, Clone)]
1011pub struct MultinomialSmoothSignificance {
1012    pub class_label: String,
1013    pub term_label: String,
1014    pub edf: f64,
1015    pub ref_df: f64,
1016    pub statistic: f64,
1017    pub p_value: f64,
1018}
1019
1020/// One-hot-encode the categorical response column and return both the
1021/// encoding and the captured level names. The level order matches the order
1022/// recorded in the dataset schema, which is the canonical (lexicographically
1023/// sorted) factor order produced by inferred-schema construction (#1319) — so
1024/// it is a deterministic function of the label *set*, independent of training
1025/// row order (no silent class permutation under a row shuffle), and matches the
1026/// R `factor()` / pandas `Categorical` convention.
1027fn one_hot_categorical_response(
1028    data: &EncodedDataset,
1029    y_col: usize,
1030    response_name: &str,
1031) -> Result<(Array2<f64>, Vec<String>), EstimationError> {
1032    let levels: Vec<String> = data
1033        .schema
1034        .columns
1035        .get(y_col)
1036        .map(|sc| sc.levels.clone())
1037        .unwrap_or_default();
1038    if levels.len() < 2 {
1039        crate::bail_invalid_estim!(
1040            "multinomial response '{response_name}' must have at least 2 categorical levels (got {})",
1041            levels.len()
1042        );
1043    }
1044    let n = data.values.nrows();
1045    let k = levels.len();
1046    let mut y_one_hot = Array2::<f64>::zeros((n, k));
1047    for row in 0..n {
1048        let encoded = data.values[[row, y_col]];
1049        if !encoded.is_finite() {
1050            crate::bail_invalid_estim!(
1051                "multinomial response '{response_name}' row {row} is non-finite ({encoded})"
1052            );
1053        }
1054        let class_idx = encoded.round() as i64;
1055        if class_idx < 0 || (class_idx as usize) >= k {
1056            crate::bail_invalid_estim!(
1057                "multinomial response '{response_name}' row {row} encoded as {encoded} \
1058                 is outside the level range 0..{k}"
1059            );
1060        }
1061        y_one_hot[[row, class_idx as usize]] = 1.0;
1062    }
1063    Ok((y_one_hot, levels))
1064}
1065
1066/// Build `(TermCollectionSpec, TermCollectionDesign)` from a formula against
1067/// a categorical-response dataset. Mirrors the early scaffolding inside
1068/// `materialize_standard` (response role resolution, geometry-aware spec
1069/// build) without touching the scalar-family resolution path — multinomial
1070/// owns its own response kind check.
1071fn build_formula_design_for_multinomial(
1072    formula: &str,
1073    data: &EncodedDataset,
1074    config: &FitConfig,
1075) -> Result<
1076    (
1077        TermCollectionSpec,
1078        TermCollectionDesign,
1079        usize,
1080        String,
1081        ResponseColumnKind,
1082    ),
1083    EstimationError,
1084> {
1085    let parsed = parse_formula(formula).map_err(|err| {
1086        EstimationError::InvalidInput(format!(
1087            "multinomial fit: failed to parse formula {formula:?}: {err}"
1088        ))
1089    })?;
1090    let col_map = data.column_map();
1091    let y_col = resolve_role_col(&col_map, &parsed.response, "response")
1092        .map_err(|err| EstimationError::InvalidInput(format!("multinomial fit: {err}")))?;
1093    let y_kind = crate::fit_orchestration::response_column_kind(data, y_col);
1094    let policy = resolved_resource_policy(config, data, ProblemHints::default());
1095    let mut inference_notes: Vec<String> = Vec::new();
1096    let spec = build_termspec_with_geometry_and_overrides(
1097        &parsed.terms,
1098        data,
1099        &col_map,
1100        &mut inference_notes,
1101        config.scale_dimensions,
1102        &policy,
1103        config.smooth_overrides.as_ref(),
1104    )
1105    .map_err(|err| {
1106        EstimationError::InvalidInput(format!("multinomial fit: build termspec: {err}"))
1107    })?;
1108    let design = build_term_collection_design(data.values.view(), &spec).map_err(|err| {
1109        EstimationError::InvalidInput(format!("multinomial fit: build design: {err}"))
1110    })?;
1111    Ok((spec, design, y_col, parsed.response, y_kind))
1112}
1113
1114fn scale_multinomial_formula_penalty(penalty: PenaltyMatrix, scale: f64) -> PenaltyMatrix {
1115    match penalty {
1116        PenaltyMatrix::Dense(matrix) => PenaltyMatrix::Dense(matrix.mapv(|v| v * scale)),
1117        PenaltyMatrix::KroneckerFactored { left, right } => PenaltyMatrix::KroneckerFactored {
1118            left: left.mapv(|v| v * scale),
1119            right,
1120        },
1121        PenaltyMatrix::Blockwise {
1122            local,
1123            col_range,
1124            total_dim,
1125        } => PenaltyMatrix::Blockwise {
1126            local: local.mapv(|v| v * scale),
1127            col_range,
1128            total_dim,
1129        },
1130        PenaltyMatrix::Labeled { label, inner } => PenaltyMatrix::Labeled {
1131            label,
1132            inner: Box::new(scale_multinomial_formula_penalty(*inner, scale)),
1133        },
1134        PenaltyMatrix::Fixed { log_lambda, inner } => PenaltyMatrix::Fixed {
1135            log_lambda,
1136            inner: Box::new(scale_multinomial_formula_penalty(*inner, scale)),
1137        },
1138    }
1139}
1140
1141/// Build a warm-started copy of `blocks` whose per-block `initial_log_lambdas`
1142/// are seeded from a previously-selected flat `log_lambdas` vector (#1082).
1143///
1144/// The flat `log_lambdas` returned by [`fit_custom_family_with_rho_prior`]
1145/// concatenates each block's penalty log-λ in block order — the same order
1146/// `build_block_specs()` emits the blocks and the same per-block penalty order
1147/// the spec carries — so it splits back across blocks by each block's penalty
1148/// count. Warm-starting the OUTER ρ-search from a prior iterate changes only the
1149/// optimizer's starting point, never the penalized objective or its optimum, so
1150/// the converged fit is identical; it just resumes near the prior iterate
1151/// instead of restarting from the cold `init_lambda` seed.
1152///
1153/// Returns `None` (caller falls back to the cold blocks) if the flat vector does
1154/// not have exactly one entry per penalty across all blocks, or carries a
1155/// non-finite value — i.e. anything that would make the seed unsafe.
1156fn warm_start_blocks_from_log_lambdas(
1157    blocks: &[crate::custom_family::ParameterBlockSpec],
1158    log_lambdas: &[f64],
1159) -> Option<Vec<crate::custom_family::ParameterBlockSpec>> {
1160    let total: usize = blocks.iter().map(|b| b.initial_log_lambdas.len()).sum();
1161    if total == 0 || log_lambdas.len() != total {
1162        return None;
1163    }
1164    if log_lambdas.iter().any(|v| !v.is_finite()) {
1165        return None;
1166    }
1167    let mut warm = blocks.to_vec();
1168    let mut offset = 0usize;
1169    for block in warm.iter_mut() {
1170        let k = block.initial_log_lambdas.len();
1171        for slot in 0..k {
1172            block.initial_log_lambdas[slot] = log_lambdas[offset + slot];
1173        }
1174        offset += k;
1175    }
1176    Some(warm)
1177}
1178
1179/// Top-level formula-driven multinomial fit.
1180///
1181/// Routes through [`fit_custom_family_with_rho_prior`] so the per-active-class
1182/// smoothing parameters `λ_a` (one per class block, shared-penalty
1183/// architecture) are selected by the outer REML/LAML loop rather than pinned
1184/// by the caller. `init_lambda` survives as a warm-start hint that seeds
1185/// every block's `initial_log_lambdas`. `max_iter` / `tol` drive the OUTER
1186/// REML/LAML smoothing-parameter search (`outer_max_iter` / `outer_tol`); the
1187/// inner joint-Newton solve runs on the framework's principled production cycle
1188/// budget at the default KKT tolerance so an ill-conditioned, LM-damped
1189/// near-simplex-boundary solve can certify a stationary point instead of being
1190/// declared non-converged after only `max_iter` cycles (#715).
1191///
1192/// The Jeffreys/Firth proper prior is engaged CONDITIONALLY: attempt 1 runs
1193/// the unbiased penalized-REML criterion; only on separation evidence (a failed
1194/// solve or a non-finite logit; see [`multinomial_formula_separation_evidence`])
1195/// is the fit re-solved once with the full-span Firth prior armed, which bounds
1196/// the penalty-null directions no smoothing parameter can (`S v = 0` ⇒
1197/// `(H + S_λ) v = H v → 0` when the softmax likelihood has no finite mode).
1198///
1199/// The categorical response column is recognised via the dataset schema
1200/// (`ColumnKindTag::Categorical`); reference class = last level. Returns a
1201/// [`MultinomialSavedModel`] that can be serialised to bytes for the Python
1202/// wrapper or used in-process for `predict_probabilities`.
1203pub fn fit_penalized_multinomial_formula(
1204    data: &EncodedDataset,
1205    formula: &str,
1206    config: &FitConfig,
1207    init_lambda: f64,
1208    max_iter: usize,
1209    tol: f64,
1210) -> Result<MultinomialSavedModel, EstimationError> {
1211    if !(init_lambda.is_finite() && init_lambda > 0.0) {
1212        crate::bail_invalid_estim!(
1213            "multinomial fit: init_lambda must be finite and > 0 (got {init_lambda})"
1214        );
1215    }
1216    let (raw_spec, design, y_col, response_name, y_kind) =
1217        build_formula_design_for_multinomial(formula, data, config)?;
1218    // Freeze the data-derived basis state (B-spline knot vectors, by-factor
1219    // level sets, spatial centers, joint-null rotations, residualization
1220    // charts) from the fit design back onto the spec. The raw geometry spec
1221    // records only *which* columns and *what kind* of basis each smooth uses;
1222    // the actual column count and basis evaluation depend on quantities the
1223    // builder derives from the training data (knot placement, the distinct
1224    // by-factor levels, etc.). Saving the raw spec made predict re-derive those
1225    // from the (smaller, differently-distributed) predict frame, so the rebuilt
1226    // design had a different column count than the fitted one — the panic
1227    // "predict design has 42 cols, saved model expects 191" for an `s(x,
1228    // by=group)` smooth-by-factor model. Every other family's persistence path
1229    // freezes the spec the same way (see `freeze_term_collection_from_design`
1230    // call sites in `main_parts`); multinomial was the lone exception.
1231    let spec = freeze_term_collection_from_design(&raw_spec, &design)?;
1232    let class_levels = match y_kind {
1233        ResponseColumnKind::Categorical { levels } => levels,
1234        ResponseColumnKind::Binary => vec!["0".to_string(), "1".to_string()],
1235        ResponseColumnKind::Numeric => {
1236            crate::bail_invalid_estim!(
1237                "multinomial fit: response '{response_name}' is numeric, not categorical; \
1238                 use family='gaussian'/'binomial'/... or convert the column to a categorical type"
1239            );
1240        }
1241    };
1242    if data.column_kinds.get(y_col) == Some(&ColumnKindTag::Binary) {
1243        // Promote to a 2-level categorical for the multinomial driver; the
1244        // caller explicitly asked for multinomial, so we route through the
1245        // K-1 = 1 active-class softmax (equivalent math to logistic).
1246    } else if data.column_kinds.get(y_col) != Some(&ColumnKindTag::Categorical) {
1247        crate::bail_invalid_estim!(
1248            "multinomial fit: response '{response_name}' must be a categorical column \
1249             (got column kind {:?})",
1250            data.column_kinds.get(y_col)
1251        );
1252    }
1253    let (y_one_hot, _) = one_hot_categorical_response(data, y_col, &response_name)?;
1254    // Build the global X dense (the design is a DesignMatrix abstraction).
1255    let mut x_dense = design
1256        .design
1257        .try_to_dense_by_chunks("multinomial fit design")
1258        .map_err(EstimationError::InvalidInput)?;
1259
1260    // ── #715 real-data conditioning: standardize unpenalized parametric
1261    // columns. Raw-unit linear covariates (penguins `body_mass_g` ~ 4e3 grams)
1262    // inflate the joint Newton information by the squared column scale (a κ(H)
1263    // multiplier of ~s² ≈ 1e7 against the intercept), which is what turns the
1264    // near-separable LM-damped inner solve into a geometric grind that
1265    // exhausts its cycle budgets — the adapter-level face of "all REML startup
1266    // seeds rejected". Because these columns are UNPENALIZED (parametric terms
1267    // carry no default ridge, #749), the affine reparameterization
1268    // `x_j ↦ (x_j − m_j)/s_j` is EXACT for the whole criterion: the optimized
1269    // REML/LAML objective, the fitted η, the selected λ, and the separation
1270    // diagnostics are all invariant — only the conditioning of `H` changes.
1271    // Fitted coefficients are mapped back to raw units at repack below, so the
1272    // saved model and the (raw-design) predict path are untouched. Penalized
1273    // columns are left alone (a penalty makes the rescaling non-equivalent),
1274    // and nothing is touched when explicit coefficient bounds/constraints
1275    // exist (those are stated in raw units).
1276    let parametric_standardization: Vec<(usize, f64, f64)> =
1277        if design.coefficient_lower_bounds.is_some() || design.linear_constraints.is_some() {
1278            Vec::new()
1279        } else {
1280            let p_total = x_dense.ncols();
1281            let mut penalized = vec![false; p_total];
1282            for bp in &design.penalties {
1283                for col in bp.col_range.clone() {
1284                    if col < p_total {
1285                        penalized[col] = true;
1286                    }
1287                }
1288            }
1289            let has_intercept = !design.intercept_range.is_empty();
1290            let n_rows = x_dense.nrows().max(1) as f64;
1291            let mut standardized = Vec::new();
1292            for (_, range) in &design.linear_ranges {
1293                for col in range.clone() {
1294                    if col >= p_total || penalized[col] {
1295                        continue;
1296                    }
1297                    let column = x_dense.column(col);
1298                    let mean = column.sum() / n_rows;
1299                    let var = column.iter().map(|v| (v - mean) * (v - mean)).sum::<f64>() / n_rows;
1300                    let scale = var.sqrt();
1301                    // Skip near-constant or degenerate columns: no conditioning to
1302                    // be gained and the back-map would divide by ~0.
1303                    if !(scale.is_finite() && scale > 1e-8 * (mean.abs() + 1.0)) {
1304                        continue;
1305                    }
1306                    // Centering shifts mass onto the intercept; without one the
1307                    // shift is not representable, so scale only.
1308                    let center = if has_intercept { mean } else { 0.0 };
1309                    for v in x_dense.column_mut(col).iter_mut() {
1310                        *v = (*v - center) / scale;
1311                    }
1312                    standardized.push((col, center, scale));
1313                }
1314            }
1315            standardized
1316        };
1317    // Preserve the per-smooth-term penalty block structure (#561): each smooth
1318    // term `t` contributes its own `P × P` penalty component (`Blockwise` with
1319    // `total_dim = P`, the term's local `S_t` embedded at its `col_range`), and
1320    // every active class block receives the FULL list. The outer REML/LAML loop
1321    // then selects an independent smoothing parameter λ_{a,t} per (class, term),
1322    // matching mgcv/VGAM. Pre-summing the terms into one fused `S` (the prior
1323    // behaviour) forced a single λ per class that scales `Σ_t S_t`, so one
1324    // shared λ had to over-smooth a rough term while under-smoothing a smooth
1325    // one — biasing any multi-term class-probability surface.
1326    let k = y_one_hot.ncols();
1327    let m = k - 1;
1328    let n_obs = y_one_hot.nrows();
1329    let penalty_scale = multinomial_formula_penalty_scale(k);
1330    let per_term_penalties: Vec<PenaltyMatrix> = design
1331        .penalties_as_penalty_matrix()
1332        .into_iter()
1333        .map(|penalty| scale_multinomial_formula_penalty(penalty, penalty_scale))
1334        .collect();
1335    let per_term_nullspace_dims = design.nullspace_dims.clone();
1336
1337    // ── Custom-family driven REML/LAML path ───────────────────────────────
1338    // Each active class becomes one ParameterBlockSpec, all sharing X and the
1339    // per-term penalty list. `initial_log_lambdas` is seeded from the caller's
1340    // `init_lambda` (one entry per term).
1341    let design_arc = Arc::new(x_dense);
1342    let penalties_arc = Arc::new(per_term_penalties);
1343    let nullspace_dims_arc = Arc::new(per_term_nullspace_dims);
1344    let weights = Array1::<f64>::ones(n_obs);
1345    // First attempt runs the UNBIASED penalized-REML criterion (no Firth
1346    // shrinkage toward the uniform simplex); the Jeffreys/Firth proper prior is
1347    // armed conditionally below, only on separation evidence (#715/#753 — see
1348    // `multinomial_formula_separation_evidence`).
1349    let family = MultinomialFamily::new(
1350        y_one_hot.clone(),
1351        weights,
1352        k,
1353        design_arc.clone(),
1354        penalties_arc.clone(),
1355        nullspace_dims_arc.clone(),
1356    )
1357    .map_err(EstimationError::InvalidInput)?
1358    .with_joint_jeffreys_term(false);
1359    let mut blocks = family.build_block_specs();
1360    let log_init = init_lambda.ln();
1361    for spec_block in blocks.iter_mut() {
1362        for v in spec_block.initial_log_lambdas.iter_mut() {
1363            *v = log_init;
1364        }
1365    }
1366
1367    // ── Outer-derivative policy: dimension-gated exact curvature ────────────
1368    // The total smoothing-parameter dimension is `D = (K−1) · n_terms`.
1369    // Medium-D formula fits need exact curvature to keep lambda selection away
1370    // from over-smoothed caps, while smooth-by-factor `D = 8` models still avoid
1371    // the O(D²) dense Hessian path.
1372    let total_rho_dim = m.saturating_mul(penalties_arc.len());
1373    let use_outer_hessian = multinomial_formula_use_outer_hessian(total_rho_dim);
1374
1375    // ── Inner-vs-outer control split (#715 non-convergence root cause) ────────
1376    // The legacy `max_iter` / `tol` parameters are the *outer* REML/LAML
1377    // smoothing-parameter optimization controls — "how hard to search λ". The
1378    // earlier wiring routed them straight into `inner_max_cycles` / `inner_tol`,
1379    // capping the joint-Newton inner solve at `max_iter` (=50 in the quality
1380    // suite) cycles with a `tol`-tight (=1e-8) KKT target. That is the #715
1381    // hang: near the simplex boundary the softmax Fisher weight
1382    // `W = diag(p) − p pᵀ` collapses, so `H = JᵀWJ + S_λ` is full-rank but
1383    // ILL-CONDITIONED. The self-vanishing Levenberg–Marquardt damping
1384    // (`levenberg_on_ill_conditioning()`) that keeps the inner solve from
1385    // oscillating on those near-singular modes makes it converge only
1386    // GEOMETRICALLY (linearly), not quadratically. Reaching a 1e-8 relative KKT
1387    // residual under geometric descent needs FAR more than 50 cycles, so the
1388    // inner returned `converged = false` on every outer ρ-evaluation; with the
1389    // exact-Hessian outer optimizer on `FallbackPolicy::Disabled` that rejects
1390    // every ρ-step — each rejected eval still paying a near-full 50-cycle inner
1391    // solve plus the O(D²) pairwise outer-Hessian directional work — so the
1392    // outer never certifies and the fit runs unbounded (the observed >8-minute
1393    // non-termination). The certificate cannot be reached, not merely slow.
1394    //
1395    // Fix: give the INNER joint-Newton the framework's principled production
1396    // budget (`DEFAULT_CUSTOM_FAMILY_INNER_MAX_CYCLES` cycles at the default
1397    // `inner_tol`), which exists precisely so an ill-conditioned LM-damped solve
1398    // can certify a stationary KKT point instead of being declared non-converged
1399    // prematurely — and the KKT/objective certificates still exit in a handful
1400    // of cycles on the well-conditioned interior fits, so this is free there.
1401    // The caller's `max_iter` / `tol` become the OUTER controls they were always
1402    // meant to be (smoothing-parameter search depth / accuracy). The inner KKT
1403    // target is kept no tighter than the outer accuracy can consume — and no
1404    // tighter than the softmax objective's f64 noise floor on near-separable
1405    // fits (see `MULTINOMIAL_FORMULA_INNER_TOL`).
1406    let outer_max_iter = max_iter.max(1);
1407    // The OUTER REML/LAML smoothing-parameter search must converge to a
1408    // well-calibrated ρ-gradient tolerance, NOT to the caller's (typically very
1409    // tight) INNER KKT tolerance. The #715 control-split repurposed the caller's
1410    // `tol` as the outer control, but feeding an inner-scale `tol = 1e-8`
1411    // straight into `outer_tol` makes REML grind dozens of extra exact-gradient
1412    // outer iterations (each an O(D·p³) Laplace-derivative assembly over the full
1413    // P·M joint design) to squeeze ρ digits that no longer move the fitted
1414    // surface — the smooth-by-factor 269s wall-clock overrun (#1082).
1415    //
1416    // The right target is the framework's CALIBRATED REML convergence tolerance,
1417    // `MULTINOMIAL_OUTER_REML_TOL = 1e-7` — the same value the primary GLM REML
1418    // outer uses (`solver::fit_orchestration::materialize` `tol: 1e-7`, mirrored by the
1419    // `LOG_LAMBDA_TOL`/`KKT_TOL_*` constants across the REML stack). At 1e-7 the
1420    // λ-search reaches the genuine REML optimum (so the recovered probability
1421    // surface matches the mature reference), but it does NOT chase the last
1422    // surface-irrelevant ρ digits down to 1e-8. The earlier 1e-5 floor (the
1423    // generic `BlockwiseFitOptions` default) was too LOOSE: the optimizer halted
1424    // in a low-curvature region with λ still well above its optimum, UNDER-fitting
1425    // the smooth-by-factor surface (truth-RMSE 0.164 vs VGAM's 0.061). So the
1426    // outer tolerance is floored at the calibrated REML tol — never tighter than
1427    // it (perf), never looser (accuracy) — while the caller's `tol` continues to
1428    // drive the INNER joint-Newton KKT target (`inner_tol` below), where its
1429    // precision actually matters.
1430    let outer_tol = if tol.is_finite() && tol > 0.0 {
1431        tol.max(MULTINOMIAL_OUTER_REML_TOL)
1432    } else {
1433        MULTINOMIAL_OUTER_REML_TOL
1434    };
1435    // #1082 root cause: the outer convergence test derives BOTH the absolute
1436    // projected-gradient floor (`max(outer_tol, n·1e-9)`) AND the relative-cost
1437    // stop (`rel_cost = outer_tol`) from the single `outer_tol`. The accuracy of
1438    // the smooth-by-factor surface is governed by the ABSOLUTE floor reaching the
1439    // n-scaled REML resolution `n·1e-9` (≈ 1.8e-6 at n = 1800) — that is why the
1440    // earlier 1e-5 floor UNDER-fit (its absolute floor was pinned at 1e-5, well
1441    // above the genuine optimum's gradient) and why 1e-7 recovered accuracy (it
1442    // unpins the floor down to the n-scaled 1.8e-6). But tightening `outer_tol`
1443    // to 1e-7 ALSO tightened the rel-cost stop to 1e-7, which on this family's
1444    // dead-flat REML ridge NEVER trips — so the optimizer no longer converges and
1445    // grinds all the way to `outer_max_iter`, each surplus step an O(D·p³) Laplace-
1446    // derivative assembly over the 382-dim joint design (the >600s wall-clock
1447    // overrun; tightening tol REINTRODUCED the crawl the 1e-5 floor had removed).
1448    //
1449    // The two requirements live on two different criteria, so they must be set
1450    // independently. Keep `outer_tol = 1e-7` (drives the accurate absolute floor)
1451    // but FLOOR the relative-cost stop at the framework default 1e-5 (the loose,
1452    // fast value that resolves the cost-decrease plateau without chasing the flat
1453    // tail). The absolute n·1e-9 floor still gates final λ accuracy; the rel-cost
1454    // stop just lets the optimizer DECLARE convergence on the flat ridge instead
1455    // of crawling to the iteration cap.
1456    let outer_rel_cost_tol = Some(BlockwiseFitOptions::default().outer_tol);
1457    let inner_tol = MULTINOMIAL_FORMULA_INNER_TOL.max(tol.max(0.0));
1458
1459    let options = BlockwiseFitOptions {
1460        inner_max_cycles: crate::custom_family::DEFAULT_CUSTOM_FAMILY_INNER_MAX_CYCLES,
1461        inner_tol,
1462        outer_max_iter,
1463        outer_tol,
1464        outer_rel_cost_tol,
1465        rho_lower_bound: multinomial_formula_min_lambda(y_one_hot.view()).ln(),
1466        ridge_floor: MULTINOMIAL_FORMULA_RIDGE_FLOOR,
1467        // #747: the stabilization floor is SOLVER-ONLY — it keeps the inner
1468        // joint-Newton linear solve finite during screening (bounding the step
1469        // `(H+δI)⁻¹∇` away from a near-separable, rank-deficient curvature) but
1470        // is excluded from the REML objective, the penalty log-determinant, and
1471        // the Laplace Hessian. The earlier default (`explicit_stabilization_pospart`)
1472        // folded `½·δ·‖β‖²` and a `δ`-shift of the log-determinant into the
1473        // criterion, shrinking every identified coefficient off the MLE and
1474        // perturbing smoothing-parameter selection — a fixed-λ prior masking
1475        // separation, not a numerical stabilizer. With the floor solver-only the
1476        // optimized objective is the true penalized REML criterion (value tracks
1477        // its analytic gradient), and the smooth directions remain governed
1478        // solely by their own REML-selected `λ`.
1479        ridge_policy: gam_problem::RidgePolicy::solver_only(),
1480        use_outer_hessian,
1481        // #715 real-data arm ("canonical-gauge null direction rejects all REML
1482        // seeds"): skip the multi-seed outer screening cascade and let the
1483        // pinned `init_lambda` ρ flow straight to the outer optimizer.
1484        //
1485        // The multinomial family declares `levenberg_on_ill_conditioning() ->
1486        // true`: near the simplex boundary (the near-separable penguins regime)
1487        // the softmax Fisher weight `W = diag(p) − p pᵀ → 0`, so the joint
1488        // information `H = JᵀWJ + S_λ` can become full-rank but
1489        // ILL-CONDITIONED. The self-vanishing LM damping that keeps the inner
1490        // joint-Newton from oscillating on those near-singular modes converges
1491        // only GEOMETRICALLY. The default screening policy ranks candidate seeds
1492        // with a 2-cycle inner cap (`outer_seed_config`); under geometric
1493        // LM-damped descent two cycles never reach a finite, meaningful proxy
1494        // objective, so EVERY capped seed can collapse to non-finite cost and
1495        // the cascade escalates to ×4, ×16, then an UNCAPPED full inner solve
1496        // PER SEED on the near-singular Hessian. That is the adapter-level face
1497        // of "all REML startup seeds rejected" and the multi-minute timeout.
1498        //
1499        // The pinned seed is already principled here: `init_lambda` gives every
1500        // (class, term) ρ a sensible moderate warm start, and the per-term
1501        // effective-df-floor upper bounds (`effective_df_floor_rho_upper_bounds`,
1502        // #715 arm (a)) keep any λ from collapsing the smooth onto its polynomial
1503        // null space. So the outer ARC/BFGS optimizer performs the real REML ρ
1504        // search from this seed; screening only adds the cascade cost and, on the
1505        // near-separable arm, the rejection stall.
1506        screen_initial_rho: false,
1507        // #1101: compute the joint Laplace posterior covariance `H⁻¹` (and the
1508        // influence matrix `F = H⁻¹ X'WX`) at the converged mode so the saved
1509        // model can surface delta-method per-class probability standard errors
1510        // and Wald smooth-term p-values. The driver factorizes the penalized
1511        // Hessian during the inner solve regardless; this only asks it to keep
1512        // and invert the factor instead of discarding it.
1513        compute_covariance: true,
1514        ..BlockwiseFitOptions::default()
1515    };
1516    // ── Conditional Firth/Jeffreys engagement (#715 arm (b) / #753) ──────────
1517    // Attempt 1: the unbiased criterion (Jeffreys disarmed above). If the
1518    // returned mode is converged, finite, and interior, it is the exact penalized-REML
1519    // optimum with zero Firth bias — accept it (this is the synthetic-arm /
1520    // interior-data path, #715 arm (a)). If the solve FAILS (e.g. the
1521    // (quasi-)separated penguins geometry where `(H + S_λ)v ≈ 0` along
1522    // penalty-null directions for EVERY ρ rejects every REML startup seed) or
1523    // returns a non-finite artifact, that is direct separation evidence:
1524    // re-solve once with the full-span Jeffreys/Firth proper prior armed, which
1525    // supplies the O(1) curvature on the quotient-null subspace that smoothing
1526    // parameters mathematically cannot (`Sv = 0` ⇒ λ never touches `v`). The
1527    // Firth refit is the accepted result only when the unbiased formula solve
1528    // failed, did not converge on its full budget, or blew up; finite
1529    // formula-path logits can be large on valid near-separated optima and
1530    // should not be shrunk toward the uniform simplex once the unbiased outer
1531    // solve has actually certified.
1532    let mut unbiased_probe_options = options.clone();
1533    unbiased_probe_options.outer_max_iter = unbiased_probe_options
1534        .outer_max_iter
1535        .min(MULTINOMIAL_UNBIASED_PROBE_OUTER_MAX_ITER);
1536    // The FINAL accepted Firth/Jeffreys refit runs to the caller's full outer
1537    // budget: it is the result we ship, so it must reach the genuine REML
1538    // optimum, not a truncated iterate. The near-separable penguin refit that
1539    // motivated #1082's wall-clock concern is now halted honestly at its true
1540    // bound optimum by the KKT-stationary-at-bound guard
1541    // (`CostStallGuard`, #1082 / 64711ed82) and the Newton-decrement residual
1542    // certificate (363af9b56 / 2c9580b1f): on separable data the outer ARC
1543    // certifies and stops early on its own, so no artificial iteration cap is
1544    // needed to land in budget. On non-separable data (e.g. the
1545    // `vgam_smooth_by_factor` double-penalty arm) the refit needs the caller's
1546    // full budget to converge, which a `.min(20)` cap would cut off — accepting
1547    // a non-converged fit, which is dishonest. So the refit keeps `options`
1548    // unchanged. Only the discarded unbiased separation probe above is capped.
1549    let firth_refit_options = &options;
1550
1551    let run_firth_refit = |evidence: String| {
1552        let firth_family = family.clone().with_joint_jeffreys_term(true);
1553        fit_custom_family_with_rho_prior(
1554            &firth_family,
1555            &blocks,
1556            firth_refit_options,
1557            gam_problem::RhoPrior::Flat,
1558        )
1559        .map_err(|err| {
1560            EstimationError::InvalidInput(format!(
1561                "multinomial REML: Firth/Jeffreys-armed refit (separation evidence: \
1562                 {evidence}) failed: {err}"
1563            ))
1564        })
1565    };
1566
1567    // #1082: the capped unbiased probe and the (separable-path) Firth decision
1568    // are driven by separation scans over the full P×M logit block. The previous
1569    // match recomputed `multinomial_formula_separation_evidence` /
1570    // `..._unresolved_probe_separation_evidence` in BOTH the match guard AND the
1571    // arm body — three to four full logit walks per fit, paid on the hot
1572    // near-separable penguin path where this branch fires every iterate. Run the
1573    // probe once, evaluate each scan once into a binding, and branch on the
1574    // precomputed results. Behaviour is identical (same scans, same order of
1575    // precedence: converged-interior, unresolved-probe-separation,
1576    // no-separation-needs-full-solve, otherwise-Firth); only the duplicate
1577    // O(n·classes) scans are removed.
1578    let probe_attempt = fit_custom_family_with_rho_prior(
1579        &family,
1580        &blocks,
1581        &unbiased_probe_options,
1582        gam_problem::RhoPrior::Flat,
1583    );
1584    let fit = match probe_attempt {
1585        Ok(probe_fit) => {
1586            let separation = multinomial_formula_separation_evidence(&probe_fit.block_states);
1587            if probe_fit.outer_converged && separation.is_none() {
1588                // Interior, converged, no separation: accept the probe directly.
1589                probe_fit
1590            } else if let Some(evidence) =
1591                multinomial_formula_unresolved_probe_separation_evidence(&probe_fit.block_states)
1592            {
1593                // Non-converged probe already carrying separation-scale logits:
1594                // hand straight to the proper-prior Firth refit (do not spend the
1595                // full unbiased budget grinding the λ→0 separable ridge).
1596                run_firth_refit(format!(
1597                    "unbiased-criterion REML probe did not converge after {} outer iterations; {evidence}",
1598                    probe_fit.outer_iterations
1599                ))?
1600            } else if separation.is_none() {
1601                // Interior but the capped probe ran out of iterations without
1602                // certifying: re-solve at the caller's full outer budget.
1603                //
1604                // #1082 wall-clock: the capped probe is a strict prefix of this
1605                // solve from the same family/seed, so a COLD restart repeats the
1606                // probe's outer iterations. WARM-START the re-solve from the ρ the
1607                // probe already reached — seed each block's `initial_log_lambdas`
1608                // from the probe's selected `log_lambdas` (same block/penalty
1609                // order: the flat vector concatenates per-block penalties in block
1610                // order, exactly the order `build_block_specs()` emits them). This
1611                // changes only the optimizer's STARTING point, never the objective
1612                // or its optimum, but lets the full solve resume near the probe's
1613                // last iterate instead of crawling up from `init_lambda` again —
1614                // removing the probe-iterations double-pay on the non-separable
1615                // (e.g. `vgam_smooth_by_factor`) arm. If the probe's λ vector does
1616                // not line up with the block layout (it always should), fall back
1617                // to the cold `blocks` seed.
1618                let warm_blocks = warm_start_blocks_from_log_lambdas(
1619                    &blocks,
1620                    probe_fit.log_lambdas.as_slice().unwrap_or(&[]),
1621                );
1622                let resolve_blocks = warm_blocks.as_deref().unwrap_or(&blocks);
1623                match fit_custom_family_with_rho_prior(
1624                    &family,
1625                    resolve_blocks,
1626                    &options,
1627                    gam_problem::RhoPrior::Flat,
1628                ) {
1629                    Ok(full_unbiased_fit) => {
1630                        let full_separation = multinomial_formula_separation_evidence(
1631                            &full_unbiased_fit.block_states,
1632                        );
1633                        if full_unbiased_fit.outer_converged && full_separation.is_none() {
1634                            full_unbiased_fit
1635                        } else {
1636                            let evidence = full_separation.unwrap_or_else(|| {
1637                                format!(
1638                                    "full unbiased-criterion REML solve did not converge after {} outer iterations",
1639                                    full_unbiased_fit.outer_iterations
1640                                )
1641                            });
1642                            run_firth_refit(evidence)?
1643                        }
1644                    }
1645                    Err(err) => run_firth_refit(format!(
1646                        "full unbiased-criterion REML solve failed: {err}"
1647                    ))?,
1648                }
1649            } else {
1650                // Probe converged (or capped) but shows interior separation
1651                // evidence: Firth refit using the already-computed scan.
1652                let evidence = separation.unwrap_or_else(|| {
1653                    format!(
1654                        "unbiased-criterion REML probe did not converge after {} outer iterations",
1655                        probe_fit.outer_iterations
1656                    )
1657                });
1658                run_firth_refit(evidence)?
1659            }
1660        }
1661        Err(err) => run_firth_refit(format!("unbiased-criterion REML solve failed: {err}"))?,
1662    };
1663    if let Some(err) = multinomial_formula_separation_diagnostic(
1664        fit.inner_cycles,
1665        fit.outer_iterations,
1666        &fit.block_states,
1667    ) {
1668        return Err(err);
1669    }
1670
1671    // ── Repack coefficients (P, K-1) from per-block β vectors ─────────────
1672    if fit.blocks.len() != m {
1673        crate::bail_invalid_estim!(
1674            "multinomial REML: expected {m} fitted blocks (K-1), got {}",
1675            fit.blocks.len()
1676        );
1677    }
1678    let p_per_class = fit.blocks[0].beta.len();
1679    let mut coefficients_active = Array2::<f64>::zeros((p_per_class, m));
1680    for (a, block) in fit.blocks.iter().enumerate() {
1681        if block.beta.len() != p_per_class {
1682            crate::bail_invalid_estim!(
1683                "multinomial REML: block {a} has {} coefs, expected {p_per_class}",
1684                block.beta.len()
1685            );
1686        }
1687        for i in 0..p_per_class {
1688            coefficients_active[[i, a]] = block.beta[i];
1689        }
1690    }
1691    // Map the standardized-column coefficients back to raw units (the exact
1692    // inverse of the conditioning reparameterization above): β_raw = b/s, with
1693    // the centering mass `Σ_j b_j·m_j/s_j` returned to the intercept.
1694    if !parametric_standardization.is_empty() {
1695        let intercept_col = design.intercept_range.clone().next();
1696        for a in 0..m {
1697            let mut intercept_adjust = 0.0;
1698            for &(col, center, scale) in &parametric_standardization {
1699                if col < p_per_class {
1700                    let raw = coefficients_active[[col, a]] / scale;
1701                    coefficients_active[[col, a]] = raw;
1702                    intercept_adjust += raw * center;
1703                }
1704            }
1705            if let Some(i0) = intercept_col
1706                && i0 < p_per_class
1707            {
1708                coefficients_active[[i0, a]] -= intercept_adjust;
1709            }
1710        }
1711    }
1712    // Flatten every (class, term) smoothing parameter in block-major order
1713    // (class 0's terms, then class 1's, …). With per-term penalties each block
1714    // now carries one λ per smooth term, so a single λ per class would discard
1715    // the independent per-term selection that fixes #561. `lambdas_per_block`
1716    // segments the flat vector by class so callers can recover per-term λ.
1717    let lambdas_per_block: Vec<usize> = fit.blocks.iter().map(|b| b.lambdas.len()).collect();
1718    let lambdas_flat: Vec<f64> = fit
1719        .blocks
1720        .iter()
1721        .flat_map(|b| b.lambdas.iter().copied())
1722        .collect();
1723    // Per-active-class effective degrees of freedom, length `K-1`, summing to
1724    // the model `edf_total`. The REML inference block reports `edf_by_block` as
1725    // ONE entry per *penalty block* (per (class, term, penalty)), each computed
1726    // as `rank(S_kk) − tr(H⁻¹ λ_kk S_kk)`. That per-block sum OVER-COUNTS the
1727    // model EDF whenever several penalties share one coefficient range — a
1728    // double-penalty / te / ti / adaptive smooth has ≥2 penalty blocks over the
1729    // same columns, so `Σ_kk rank(S_kk) > p` and `Σ_kk edf_by_block > edf_total`
1730    // (the observed ~79 for a ~24-coefficient model). Handing that raw per-block
1731    // vector out as the documented length-(K-1) per-class EDF is therefore both
1732    // the wrong LENGTH (it is `Σ_a n_blocks_a`, not `K-1`) and an over-count.
1733    //
1734    // The honest per-class EDF is the influence-matrix trace over each class's
1735    // coefficient block. Classes occupy DISJOINT `p_per_class`-wide coefficient
1736    // ranges, and the per-block traces `tr_kk = tr(H⁻¹ λ_kk S_kk)` are additive
1737    // (no rank double-counting), so class `a`'s EDF is
1738    // `p_per_class − Σ_{kk ∈ class a} tr_kk`, and `Σ_a edf_a = m·p_per_class −
1739    // Σ_kk tr_kk = p − Σ tr_kk = edf_total` exactly. Segment the block-major
1740    // `penalty_block_trace` by `lambdas_per_block` (the same per-class λ-count
1741    // segmentation `lambdas_flat` uses). Fall back to `None` when the trace
1742    // channel is unavailable or mis-shaped (legacy fixed-λ path), exactly as the
1743    // raw `edf_by_block` map did before.
1744    let edf_per_class = fit.inference.as_ref().and_then(|info| {
1745        let traces = &info.penalty_block_trace;
1746        if traces.len() != lambdas_per_block.iter().sum::<usize>() {
1747            // Trace channel absent or not aligned with the per-class block
1748            // segmentation — cannot assemble an honest per-class EDF.
1749            return None;
1750        }
1751        let mut per_class = Vec::with_capacity(m);
1752        let mut cursor = 0usize;
1753        for &n_blocks in &lambdas_per_block {
1754            let class_trace: f64 = traces[cursor..cursor + n_blocks].iter().sum();
1755            // `tr(F)` over a class block ∈ [0, p_per_class]; clamp away
1756            // round-off so a reported EDF can never be negative or exceed the
1757            // class's own coefficient count.
1758            per_class.push((p_per_class as f64 - class_trace).clamp(0.0, p_per_class as f64));
1759            cursor += n_blocks;
1760        }
1761        Some(per_class)
1762    });
1763    let coefficients_flat: Vec<f64> = coefficients_active.iter().copied().collect();
1764
1765    // #1101: surface the joint Laplace posterior covariance `H⁻¹` (block-ordered
1766    // [β_0; …; β_{K-2}]) and the influence matrix `F = H⁻¹ X'WX` the REML driver
1767    // computed at the converged mode. These power the predict path's delta-method
1768    // per-class probability standard errors and the summary's Wald smooth-term
1769    // tests. The joint matrices are `(P·M)×(P·M)`. The covariance is mapped back
1770    // to RAW units (see below) so it pairs with the raw predict design; the
1771    // influence is kept in the fitted basis (the Wald table only slices penalized
1772    // columns, which the standardization affine leaves identity-mapped).
1773    let expected_joint = p_per_class.saturating_mul(m);
1774    // The joint Hessian (and thus `H⁻¹`) was assembled in the STANDARDIZED
1775    // parametric basis used during fitting, while the saved coefficients and the
1776    // raw predict design are in raw units. Map the covariance to raw units with
1777    // the same exact affine reparameterization `β_raw = A β_std`: for each
1778    // standardized parametric column `col`, `β_raw[col] = β_std[col]/scale` and
1779    // the intercept absorbs `−Σ_col (center/scale)·β_std[col]`. So `A = I` except
1780    // `A[col,col] = 1/scale` and `A[i0,col] = −center/scale`, replicated
1781    // block-diagonally per active class, and `Cov_raw = A Cov_std Aᵀ`. With no
1782    // standardization (`parametric_standardization` empty) `A = I` and this is a
1783    // no-op. The smooth-term (penalized) columns are untouched by `A`, so the
1784    // Wald table's per-term blocks are identical in both bases.
1785    let intercept_col0 = design.intercept_range.clone().next();
1786    let build_per_class_affine = |amat: &mut Array2<f64>| {
1787        for &(col, center, scale) in &parametric_standardization {
1788            if col >= p_per_class {
1789                continue;
1790            }
1791            amat[[col, col]] = 1.0 / scale;
1792            if let Some(i0) = intercept_col0
1793                && i0 < p_per_class
1794            {
1795                amat[[i0, col]] = -center / scale;
1796            }
1797        }
1798    };
1799    let coefficient_covariance_flat = fit
1800        .covariance_conditional
1801        .as_ref()
1802        .filter(|c| c.nrows() == expected_joint && c.ncols() == expected_joint)
1803        .map(|cov_std| {
1804            if parametric_standardization.is_empty() {
1805                return cov_std.iter().copied().collect::<Vec<f64>>();
1806            }
1807            // Block-diagonal joint A (same per active class).
1808            let mut a_joint = Array2::<f64>::eye(expected_joint);
1809            let mut a_class = Array2::<f64>::eye(p_per_class);
1810            build_per_class_affine(&mut a_class);
1811            for a in 0..m {
1812                let base = a * p_per_class;
1813                for i in 0..p_per_class {
1814                    for j in 0..p_per_class {
1815                        a_joint[[base + i, base + j]] = a_class[[i, j]];
1816                    }
1817                }
1818            }
1819            let cov_raw = a_joint.dot(cov_std).dot(&a_joint.t());
1820            cov_raw.iter().copied().collect::<Vec<f64>>()
1821        });
1822    // The influence matrix `F = H⁻¹ X'WX = H⁻¹(H − S_λ) = I − H⁻¹ S_λ`. The
1823    // exact-Newton multinomial blocks carry no IRLS pseudo-data, so the generic
1824    // inference path does not export `coefficient_influence`; reconstruct it
1825    // exactly here from the joint covariance `H⁻¹` (above) and the REML-selected
1826    // per-(class, term) `λ` scaling the shared penalties. Block-diagonal `S_λ`:
1827    // class `a`'s block is `Σ_t λ_{a,t} · S_t`, embedded at `a·P .. (a+1)·P`.
1828    let coefficient_influence_flat = fit
1829        .covariance_conditional
1830        .as_ref()
1831        .filter(|c| c.nrows() == expected_joint && c.ncols() == expected_joint)
1832        .and_then(|hinv| {
1833            if fit.blocks.len() != m {
1834                return None;
1835            }
1836            // Joint S_λ (block-diagonal across active classes).
1837            let mut s_lambda = Array2::<f64>::zeros((expected_joint, expected_joint));
1838            for (a, block) in fit.blocks.iter().enumerate() {
1839                if block.lambdas.len() != penalties_arc.len() {
1840                    return None;
1841                }
1842                let base = a * p_per_class;
1843                for (t, pen) in penalties_arc.iter().enumerate() {
1844                    let lam = block.lambdas[t];
1845                    if lam == 0.0 {
1846                        continue;
1847                    }
1848                    let dense = pen.to_dense();
1849                    if dense.nrows() != p_per_class || dense.ncols() != p_per_class {
1850                        return None;
1851                    }
1852                    for i in 0..p_per_class {
1853                        for j in 0..p_per_class {
1854                            s_lambda[[base + i, base + j]] += lam * dense[[i, j]];
1855                        }
1856                    }
1857                }
1858            }
1859            // F = I − H⁻¹ S_λ.
1860            let hinv_s = hinv.dot(&s_lambda);
1861            let mut f = Array2::<f64>::eye(expected_joint);
1862            f -= &hinv_s;
1863            Some(f.iter().copied().collect::<Vec<f64>>())
1864        });
1865
1866    // Per-(smooth term) coefficient span within a single class block, deduped by
1867    // col_range (the #561 double-penalty migration emits two penalty blocks per
1868    // term sharing one col_range; the Wald test covers the whole term block once).
1869    let mut smooth_term_spans: Vec<MultinomialSmoothTermSpan> = Vec::new();
1870    for (pen_idx, bp) in design.penalties.iter().enumerate() {
1871        let col_start = bp.col_range.start;
1872        let col_end = bp.col_range.end;
1873        if col_start >= col_end || col_end > p_per_class {
1874            continue;
1875        }
1876        if smooth_term_spans
1877            .iter()
1878            .any(|s| s.col_start == col_start && s.col_end == col_end)
1879        {
1880            continue;
1881        }
1882        let label = design
1883            .penaltyinfo
1884            .get(pen_idx)
1885            .and_then(|info| info.termname.clone())
1886            .unwrap_or_else(|| format!("s{pen_idx}"));
1887        let nullspace_dim = design
1888            .nullspace_dims
1889            .get(pen_idx)
1890            .copied()
1891            .unwrap_or(0)
1892            .min(col_end - col_start);
1893        smooth_term_spans.push(MultinomialSmoothTermSpan {
1894            label,
1895            col_start,
1896            col_end,
1897            nullspace_dim,
1898        });
1899    }
1900
1901    // One descriptive label per penalty *component* within a single class block,
1902    // parallel to that block's λ slice (#1544). `design.penalties` is index-
1903    // parallel to every active class's `block.lambdas` (each block carries the
1904    // full per-component penalty list, validated above by
1905    // `block.lambdas.len() == penalties_arc.len()`), so iterating it in order
1906    // yields exactly `lambdas_per_block[0]` labels aligned with the per-block λ.
1907    // This is deliberately NOT deduped by col_range (unlike `smooth_term_spans`):
1908    // the double penalty's primary and null-space components share one col_range
1909    // but select independent λ, and each must keep its own label so the summary
1910    // renderer never collapses or drops a λ.
1911    let lambda_labels: Vec<String> = design
1912        .penalties
1913        .iter()
1914        .enumerate()
1915        .map(|(pen_idx, _)| penalty_component_label(design.penaltyinfo.get(pen_idx), pen_idx))
1916        .collect();
1917
1918    // Unpenalized deviance read directly from the converged unpenalized
1919    // log-likelihood the rho-prior driver already computed (issue #348):
1920    // MultinomialFamily::evaluate sets FamilyEvaluation.log_likelihood =
1921    // log_lik(η, y) with no penalty term, and that value flows unchanged into
1922    // UnifiedFitResult.log_likelihood. This reproduces the legacy fixed-λ
1923    // path's `deviance = -2 · log_lik` contract bit-for-bit, so the previous
1924    // row-by-row η = Xβ rebuild and softmax recompute were pure dead work.
1925    let deviance = -2.0 * fit.log_likelihood;
1926
1927    Ok(MultinomialSavedModel {
1928        formula: formula.to_string(),
1929        class_levels: class_levels.clone(),
1930        reference_class_index: class_levels.len() - 1,
1931        resolved_termspec: spec,
1932        coefficients_flat,
1933        p_per_class,
1934        n_active_classes: m,
1935        training_headers: data.headers.clone(),
1936        lambdas: lambdas_flat,
1937        lambdas_per_block,
1938        iterations: fit.inner_cycles,
1939        converged: fit.outer_converged,
1940        penalized_neg_log_likelihood: -fit.log_likelihood + 0.5 * fit.stable_penalty_term,
1941        deviance,
1942        edf_per_class,
1943        coefficient_covariance_flat,
1944        coefficient_influence_flat,
1945        smooth_term_spans,
1946        lambda_labels,
1947    })
1948}
1949
1950/// Replay the saved termspec to build the predict-time design on a fresh
1951/// dataset, then evaluate softmax probabilities. The predict dataset must carry
1952/// the same feature columns the training data did, matched **by name** — it need
1953/// not reproduce the training column order, and in particular need not carry the
1954/// response column (prediction is for label-free new data).
1955pub fn predict_multinomial_formula(
1956    model: &MultinomialSavedModel,
1957    data: &EncodedDataset,
1958) -> Result<Array2<f64>, EstimationError> {
1959    // The saved termspec stores feature columns as absolute indices into the
1960    // *training* table `[response, features...]`. Replaying it verbatim only
1961    // works if the predict frame reproduces that exact layout — i.e. carries the
1962    // (unknown, at predict time) response column in the same position. Realign
1963    // the indices onto this dataset's columns by name instead, so prediction
1964    // works on label-free new data exactly as every other family's predict path
1965    // does. The response column is simply never referenced by any term, so its
1966    // absence is a non-issue once resolution is by name (issue #803).
1967    let predict_columns = data.column_map();
1968    let realigned = model.resolved_termspec.remap_feature_columns(
1969        |index| -> Result<usize, EstimationError> {
1970            let name = model.training_headers.get(index).ok_or_else(|| {
1971                EstimationError::InvalidInput(format!(
1972                    "multinomial predict: saved training column index {index} is out of bounds \
1973                     for {} training headers",
1974                    model.training_headers.len()
1975                ))
1976            })?;
1977            resolve_role_col(&predict_columns, name, "feature")
1978                .map_err(|err| EstimationError::InvalidInput(err.to_string()))
1979        },
1980    )?;
1981    let design = build_term_collection_design(data.values.view(), &realigned).map_err(|err| {
1982        EstimationError::InvalidInput(format!(
1983            "multinomial predict: rebuild design from saved termspec: {err}"
1984        ))
1985    })?;
1986    let x_dense = design
1987        .design
1988        .try_to_dense_by_chunks("multinomial predict design")
1989        .map_err(EstimationError::InvalidInput)?;
1990    if x_dense.ncols() != model.p_per_class {
1991        crate::bail_invalid_estim!(
1992            "multinomial predict: predict design has {} cols, saved model expects {}",
1993            x_dense.ncols(),
1994            model.p_per_class
1995        );
1996    }
1997    Ok(model.predict_probabilities(x_dense.view()))
1998}
1999
2000/// Predict class probabilities AND delta-method per-class probability standard
2001/// errors for a saved multinomial model on fresh data (#1101). Replays the
2002/// saved termspec to build the predict design exactly as
2003/// [`predict_multinomial_formula`], then applies the softmax-Jacobian delta
2004/// method against the stored joint posterior covariance. Returns
2005/// `(probs (N,K), prob_se (N,K) | None)`; `prob_se` is `None` for a legacy
2006/// model fitted before covariance was surfaced.
2007pub fn predict_multinomial_formula_with_se(
2008    model: &MultinomialSavedModel,
2009    data: &EncodedDataset,
2010) -> Result<(Array2<f64>, Option<Array2<f64>>), EstimationError> {
2011    let predict_columns = data.column_map();
2012    let realigned = model.resolved_termspec.remap_feature_columns(
2013        |index| -> Result<usize, EstimationError> {
2014            let name = model.training_headers.get(index).ok_or_else(|| {
2015                EstimationError::InvalidInput(format!(
2016                    "multinomial predict: saved training column index {index} is out of bounds \
2017                     for {} training headers",
2018                    model.training_headers.len()
2019                ))
2020            })?;
2021            resolve_role_col(&predict_columns, name, "feature")
2022                .map_err(|err| EstimationError::InvalidInput(err.to_string()))
2023        },
2024    )?;
2025    let design = build_term_collection_design(data.values.view(), &realigned).map_err(|err| {
2026        EstimationError::InvalidInput(format!(
2027            "multinomial predict: rebuild design from saved termspec: {err}"
2028        ))
2029    })?;
2030    let x_dense = design
2031        .design
2032        .try_to_dense_by_chunks("multinomial predict design")
2033        .map_err(EstimationError::InvalidInput)?;
2034    if x_dense.ncols() != model.p_per_class {
2035        crate::bail_invalid_estim!(
2036            "multinomial predict: predict design has {} cols, saved model expects {}",
2037            x_dense.ncols(),
2038            model.p_per_class
2039        );
2040    }
2041    Ok(model.predict_probabilities_with_se(x_dense.view()))
2042}
2043
2044#[cfg(test)]
2045mod fisher_override_tests {
2046    use super::*;
2047    use ndarray::Array3;
2048
2049    fn toy() -> (Array2<f64>, Array2<f64>, Array2<f64>, Array1<f64>) {
2050        let n = 15;
2051        let p = 2;
2052        let k = 3;
2053        let design =
2054            Array2::<f64>::from_shape_fn(
2055                (n, p),
2056                |(i, j)| {
2057                    if j == 0 { 1.0 } else { ((i + 2) as f64).cos() }
2058                },
2059            );
2060        let mut y = Array2::<f64>::zeros((n, k));
2061        for i in 0..n {
2062            y[[i, i % k]] = 1.0;
2063        }
2064        let penalty = Array2::<f64>::eye(p);
2065        let lambdas = Array1::<f64>::from_elem(k - 1, 0.5);
2066        (design, y, penalty, lambdas)
2067    }
2068
2069    #[test]
2070    fn fisher_override_none_reproduces_analytic() {
2071        // Issue #349: None override is exactly the analytic fit.
2072        let (design, y, penalty, lambdas) = toy();
2073        let mk = |over: Option<ndarray::ArrayView3<'_, f64>>| {
2074            fit_penalized_multinomial(MultinomialFitInputs {
2075                design: design.view(),
2076                y_one_hot: y.view(),
2077                penalty: penalty.view(),
2078                lambdas: lambdas.view(),
2079                row_weights: None,
2080                fisher_w_override: over,
2081                max_iter: 50,
2082                tol: 1.0e-9,
2083            })
2084            .expect("fit must succeed")
2085        };
2086        let a = mk(None);
2087        let b = mk(None);
2088        for (x, z) in a
2089            .coefficients_active
2090            .iter()
2091            .zip(b.coefficients_active.iter())
2092        {
2093            assert_eq!(x, z);
2094        }
2095    }
2096
2097    #[test]
2098    fn fisher_override_wrong_shape_is_rejected() {
2099        let (design, y, penalty, lambdas) = toy();
2100        let n = design.nrows();
2101        let m = y.ncols(); // K, not K-1 — deliberately wrong
2102        let bad = Array3::<f64>::zeros((n, m, m));
2103        let err = fit_penalized_multinomial(MultinomialFitInputs {
2104            design: design.view(),
2105            y_one_hot: y.view(),
2106            penalty: penalty.view(),
2107            lambdas: lambdas.view(),
2108            row_weights: None,
2109            fisher_w_override: Some(bad.view()),
2110            max_iter: 50,
2111            tol: 1.0e-9,
2112        })
2113        .expect_err("wrong active-block shape must error");
2114        assert!(format!("{err}").contains("fisher_w_override shape"));
2115    }
2116
2117    #[test]
2118    fn formula_outer_route_uses_exact_curvature_for_medium_d() {
2119        // The 2-smooth reference formula fit (K = 3, double-penalty terms) is
2120        // D = (K-1) * 2 terms * 2 penalties = 8 and needs exact curvature to
2121        // avoid over-smoothed lambda caps (#715 arm (a)).
2122        assert!(
2123            multinomial_formula_use_outer_hessian(8),
2124            "D=8 loaded multinomial fits need exact curvature to avoid over-smoothed lambda caps"
2125        );
2126        assert!(
2127            multinomial_formula_use_outer_hessian(12),
2128            "D=12 (3 double-penalty smooth terms, K=3) stays on exact curvature"
2129        );
2130    }
2131
2132    #[test]
2133    fn formula_outer_route_uses_exact_curvature_for_d16_penguin_fixture() {
2134        // Four k=10 penguin smooths (K = 3) are D = 16 under double-penalty
2135        // terms. They must reach the exact ARC route so the #1082 cost-stall
2136        // halt is available on the near-separable lambda-to-zero ridge.
2137        assert!(
2138            multinomial_formula_use_outer_hessian(16),
2139            "D=16 multinomial fits need exact ARC curvature for the #1082 stall halt"
2140        );
2141    }
2142
2143    #[test]
2144    fn formula_min_lambda_floor_is_continuous_and_information_scaled() {
2145        // Build a one-hot label matrix whose smallest class carries `count` rows.
2146        fn floor_for_min_count(count: usize) -> f64 {
2147            // Two classes: a large one (1000 rows) and a minority one (`count`).
2148            let n = 1000 + count;
2149            let mut y = Array2::<f64>::zeros((n, 2));
2150            for r in 0..1000 {
2151                y[[r, 0]] = 1.0;
2152            }
2153            for r in 1000..n {
2154                y[[r, 1]] = 1.0;
2155            }
2156            multinomial_formula_min_lambda(y.view())
2157        }
2158
2159        // The floor's endpoints are now DERIVED from a target prior strength in
2160        // pseudo-observations against the maximal per-observation softmax Fisher
2161        // information I₁ = ¼ (base = τ·I₁, sparse = τ_max·I₁). Pin them to the
2162        // previously fixture-calibrated values so the near-separable quality arms
2163        // (penguins, vgam softmax) — whose smallest class has n_c ≥ 50 — are
2164        // byte-for-byte unaffected: the derivation REDUCES TO the old constants
2165        // at the calibration point.
2166        let base = MULTINOMIAL_FORMULA_PRIOR_PSEUDO_OBS * MULTINOMIAL_FORMULA_FISHER_INFO_PER_OBS;
2167        let sparse = MULTINOMIAL_FORMULA_SPARSE_PRIOR_PSEUDO_OBS_MAX
2168            * MULTINOMIAL_FORMULA_FISHER_INFO_PER_OBS;
2169        assert!(
2170            (base - 2.0e-4).abs() < 1e-18,
2171            "derived base floor must equal the calibrated 2e-4"
2172        );
2173        assert!(
2174            (sparse - 1.0e-3).abs() < 1e-18,
2175            "derived sparse floor must equal the calibrated 1e-3"
2176        );
2177
2178        // Well-supported (n_c >= n_ref=50) sits exactly at the base floor.
2179        assert!((floor_for_min_count(50) - base).abs() < 1e-18);
2180        assert!((floor_for_min_count(200) - base).abs() < 1e-18);
2181        // Very sparse (n_c <= n_ref·base/sparse = 10) clamps to the strong floor.
2182        assert!((floor_for_min_count(10) - sparse).abs() < 1e-18);
2183        assert!((floor_for_min_count(5) - sparse).abs() < 1e-18);
2184        // No cliff at the old hard threshold: 49 vs 50 differ by < 5% (the old
2185        // step jumped 5x). Floor is monotone non-increasing in support.
2186        let f49 = floor_for_min_count(49);
2187        let f50 = floor_for_min_count(50);
2188        assert!(
2189            f49 >= f50 && f49 <= f50 * 1.05,
2190            "floor must be continuous across c0, got {f49} vs {f50}"
2191        );
2192        let f25 = floor_for_min_count(25);
2193        assert!(
2194            f25 > f50 && f25 < floor_for_min_count(10),
2195            "mid-support floor must interpolate strictly between the two endpoints"
2196        );
2197
2198        // FIRST-PRINCIPLES SCALING: in the interpolating regime the floor equals
2199        // exactly τ·I₁·(n_ref/n_c) — the effective-pseudo-observation prior held
2200        // to a fixed fraction of the per-class data information n_c·I₁. Halving
2201        // the effective sample size doubles the floor (until the cap), and the
2202        // absolute value matches the closed-form n_c-scaled prior.
2203        for &n_c in &[12usize, 16, 20, 30, 40] {
2204            let expected = base * (MULTINOMIAL_FORMULA_SPARSE_REFERENCE_SUPPORT / n_c as f64);
2205            assert!(
2206                (floor_for_min_count(n_c) - expected).abs() < 1e-15,
2207                "floor at n_c={n_c} must be τ·I₁·n_ref/n_c = {expected}, got {}",
2208                floor_for_min_count(n_c)
2209            );
2210        }
2211        // Inverse scaling with effective sample size: n_c -> n_c/2 doubles the
2212        // floor inside the unclamped band (20 and 40 are both interior; 40 < 50
2213        // so it is scaled, 20 > 10 so it is not capped).
2214        assert!(
2215            (floor_for_min_count(20) - 2.0 * floor_for_min_count(40)).abs() < 1e-15,
2216            "floor must scale like 1/n_c (effective Fisher information) in the interior band"
2217        );
2218    }
2219
2220    #[test]
2221    fn formula_penalty_scale_tracks_softmax_fisher_curvature() {
2222        assert!(
2223            (multinomial_formula_penalty_scale(2) - 0.5).abs() < 1.0e-12,
2224            "binary-logit neutral-simplex curvature scale should remain at 1/2"
2225        );
2226        assert!(
2227            (multinomial_formula_penalty_scale(3) - 4.0 / 9.0).abs() < 1.0e-12,
2228            "three-class softmax penalties should be calibrated to 2*(K-1)/K^2"
2229        );
2230        assert!(
2231            multinomial_formula_penalty_scale(5) < multinomial_formula_penalty_scale(3),
2232            "active-class Fisher curvature decreases as the simplex gains classes"
2233        );
2234    }
2235
2236    #[test]
2237    fn fixed_lambda_multinomial_reports_complete_separation() {
2238        let n = 90;
2239        let design = Array2::<f64>::from_shape_fn((n, 2), |(row, col)| match col {
2240            0 => 1.0,
2241            _ => -3.0 + 6.0 * (row as f64) / ((n - 1) as f64),
2242        });
2243        let mut y = Array2::<f64>::zeros((n, 3));
2244        for row in 0..n {
2245            let x = design[[row, 1]];
2246            let class = if x < -1.0 {
2247                0
2248            } else if x > 1.0 {
2249                1
2250            } else {
2251                2
2252            };
2253            y[[row, class]] = 1.0;
2254        }
2255        let penalty = Array2::<f64>::zeros((2, 2));
2256        let lambdas = Array1::<f64>::zeros(2);
2257        let err = fit_penalized_multinomial(MultinomialFitInputs {
2258            design: design.view(),
2259            y_one_hot: y.view(),
2260            penalty: penalty.view(),
2261            lambdas: lambdas.view(),
2262            row_weights: None,
2263            fisher_w_override: None,
2264            max_iter: 80,
2265            tol: 1.0e-12,
2266        })
2267        .expect_err("complete softmax separation must be a hard diagnostic");
2268        assert!(
2269            matches!(err, EstimationError::MultinomialSeparationDetected { .. }),
2270            "expected MultinomialSeparationDetected, got {err:?}"
2271        );
2272        assert!(
2273            err.to_string().contains("separation"),
2274            "diagnostic should mention separation, got {err}"
2275        );
2276        assert!(
2277            err.to_string().contains("active class-"),
2278            "diagnostic should name the separated active class logit, got {err}"
2279        );
2280        assert!(
2281            !err.to_string().contains("binary outcomes"),
2282            "multinomial diagnostic must not reuse the binary separation text, got {err}"
2283        );
2284    }
2285
2286    #[test]
2287    fn formula_multinomial_accepts_finite_saturated_logits() {
2288        // A saturated-but-FINITE logit surface can be a valid formula REML mode
2289        // (the #715 penguins regime: bill/flipper cleanly separate the species,
2290        // so fitted logits can legitimately exceed ±25). `outer_converged ==
2291        // false` then signals only that the driver auto-escalated to never-fail
2292        // posterior sampling about that finite mode (gam#860), NOT a separation
2293        // artifact — the adapter must accept it, never raise
2294        // `MultinomialSeparationDetected`.
2295        let saturated_states = vec![
2296            ParameterBlockState {
2297                beta: Array1::from_vec(vec![1.0, 2.0]),
2298                eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
2299            },
2300            ParameterBlockState {
2301                beta: Array1::from_vec(vec![-1.0, 3.0]),
2302                eta: Array1::from_vec(vec![1.0, 25.5, -0.1]),
2303            },
2304        ];
2305        assert!(
2306            multinomial_formula_separation_diagnostic(17, 9, &saturated_states).is_none(),
2307            "a finite (even saturated, |eta|>25) formula optimum is a valid fit, \
2308             not a separation diagnostic"
2309        );
2310
2311        // Only a genuinely NON-FINITE logit — a NaN/Inf blow-up in the inner
2312        // linear algebra with no finite mode to sample about — is a real
2313        // formula-path failure.
2314        let blown_up = vec![
2315            ParameterBlockState {
2316                beta: Array1::from_vec(vec![1.0, 2.0]),
2317                eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
2318            },
2319            ParameterBlockState {
2320                beta: Array1::from_vec(vec![-1.0, 3.0]),
2321                eta: Array1::from_vec(vec![1.0, f64::INFINITY, -0.1]),
2322            },
2323        ];
2324        let err = multinomial_formula_separation_diagnostic(17, 9, &blown_up)
2325            .expect("a non-finite formula logit must raise the separation diagnostic");
2326        assert!(
2327            matches!(
2328                err,
2329                EstimationError::MultinomialSeparationDetected {
2330                    iteration: 17,
2331                    max_abs_eta,
2332                    active_class_index: 1,
2333                    row_index: 1,
2334                } if !max_abs_eta.is_finite()
2335            ),
2336            "expected typed multinomial separation diagnostic at the non-finite channel, got {err:?}"
2337        );
2338    }
2339
2340    #[test]
2341    fn separation_evidence_gate_arms_firth_only_on_blowup() {
2342        // Interior fit: finite logits well inside the saturation threshold ⇒ NO
2343        // separation evidence ⇒ the unbiased criterion's mode is accepted as-is
2344        // and the Firth/Jeffreys prior stays disarmed (#715 arm (a): no 1/K
2345        // shrinkage on well-identified data).
2346        let interior = vec![
2347            ParameterBlockState {
2348                beta: Array1::from_vec(vec![1.0, 2.0]),
2349                eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
2350            },
2351            ParameterBlockState {
2352                beta: Array1::from_vec(vec![-1.0, 3.0]),
2353                eta: Array1::from_vec(vec![1.0, -3.5, -0.1]),
2354            },
2355        ];
2356        assert!(
2357            multinomial_formula_separation_evidence(&interior).is_none(),
2358            "an interior finite mode must not arm the Firth refit"
2359        );
2360
2361        // Saturated but finite logits are valid formula-path modes on
2362        // near-separated real data. They must not arm the Firth refit because
2363        // the Jeffreys pull can over-regularize the held-out probabilities.
2364        let saturated = vec![
2365            ParameterBlockState {
2366                beta: Array1::from_vec(vec![1.0, 2.0]),
2367                eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
2368            },
2369            ParameterBlockState {
2370                beta: Array1::from_vec(vec![-1.0, 3.0]),
2371                eta: Array1::from_vec(vec![1.0, 25.5, -0.1]),
2372            },
2373        ];
2374        assert!(
2375            multinomial_formula_separation_evidence(&saturated).is_none(),
2376            "a finite saturated formula-mode logit must not arm the Firth refit"
2377        );
2378
2379        // Non-finite logit ⇒ inner blow-up along an unbounded direction ⇒
2380        // separation evidence.
2381        let blown_up = vec![ParameterBlockState {
2382            beta: Array1::from_vec(vec![1.0, 2.0]),
2383            eta: Array1::from_vec(vec![0.2, f64::NAN, -7.0]),
2384        }];
2385        let evidence = multinomial_formula_separation_evidence(&blown_up)
2386            .expect("a non-finite logit is separation evidence");
2387        assert!(
2388            evidence.contains("non-finite logit") && evidence.contains("row 1"),
2389            "evidence must name the non-finite logit, got {evidence}"
2390        );
2391
2392        // Large finite logits below the fixed-lambda diagnostic threshold are
2393        // likewise accepted on the formula path.
2394        let near = vec![ParameterBlockState {
2395            beta: Array1::from_vec(vec![1.0, 2.0]),
2396            eta: Array1::from_vec(vec![0.2, 24.9, -24.9]),
2397        }];
2398        assert!(
2399            multinomial_formula_separation_evidence(&near).is_none(),
2400            "logits below the saturation threshold must not arm the Firth refit"
2401        );
2402    }
2403
2404    #[test]
2405    fn unresolved_probe_evidence_arms_firth_on_saturated_finite_logits() {
2406        let saturated = vec![
2407            ParameterBlockState {
2408                beta: Array1::from_vec(vec![1.0, 2.0]),
2409                eta: Array1::from_vec(vec![0.2, 4.0, -7.0]),
2410            },
2411            ParameterBlockState {
2412                beta: Array1::from_vec(vec![-1.0, 3.0]),
2413                eta: Array1::from_vec(vec![1.0, 25.5, -0.1]),
2414            },
2415        ];
2416
2417        assert!(
2418            multinomial_formula_separation_evidence(&saturated).is_none(),
2419            "a converged finite saturated formula optimum remains unbiased"
2420        );
2421        let evidence = multinomial_formula_unresolved_probe_separation_evidence(&saturated)
2422            .expect("a non-converged saturated probe should arm the Firth refit");
2423        assert!(
2424            evidence.contains("separation-scale finite logit")
2425                && evidence.contains("row 1")
2426                && evidence.contains("active class 1"),
2427            "unresolved-probe evidence should name the saturated channel, got {evidence}"
2428        );
2429
2430        let near = vec![ParameterBlockState {
2431            beta: Array1::from_vec(vec![1.0, 2.0]),
2432            eta: Array1::from_vec(vec![0.2, 24.9, -24.9]),
2433        }];
2434        assert!(
2435            multinomial_formula_unresolved_probe_separation_evidence(&near).is_none(),
2436            "finite logits below the separation threshold still get the full unbiased retry"
2437        );
2438    }
2439
2440    #[test]
2441    fn scaled_fisher_override_changes_first_step() {
2442        // Curvature scaled by 4× shrinks the first Newton step relative to the
2443        // analytic fit, so a single-iteration fit must differ.
2444        let (design, y, penalty, lambdas) = toy();
2445        let n = design.nrows();
2446        let m = y.ncols() - 1;
2447        // Analytic block at β = 0: p_a = 1/K = 1/3, so diag = p_a(1−p_a),
2448        // off-diag = −p_a p_b. Scale that exact block by 4.
2449        let pk = 1.0 / (y.ncols() as f64);
2450        let mut over = Array3::<f64>::zeros((n, m, m));
2451        for row in 0..n {
2452            for a in 0..m {
2453                for b in 0..m {
2454                    let analytic = if a == b { pk * (1.0 - pk) } else { -pk * pk };
2455                    over[[row, a, b]] = 4.0 * analytic;
2456                }
2457            }
2458        }
2459        let scaled = fit_penalized_multinomial(MultinomialFitInputs {
2460            design: design.view(),
2461            y_one_hot: y.view(),
2462            penalty: penalty.view(),
2463            lambdas: lambdas.view(),
2464            row_weights: None,
2465            fisher_w_override: Some(over.view()),
2466            max_iter: 1,
2467            tol: 1.0e-9,
2468        })
2469        .expect("override fit must succeed");
2470        let analytic = fit_penalized_multinomial(MultinomialFitInputs {
2471            design: design.view(),
2472            y_one_hot: y.view(),
2473            penalty: penalty.view(),
2474            lambdas: lambdas.view(),
2475            row_weights: None,
2476            fisher_w_override: None,
2477            max_iter: 1,
2478            tol: 1.0e-9,
2479        })
2480        .expect("analytic fit must succeed");
2481        let differs = scaled
2482            .coefficients_active
2483            .iter()
2484            .zip(analytic.coefficients_active.iter())
2485            .any(|(a, b)| (a - b).abs() > 1.0e-6);
2486        assert!(differs, "scaled curvature must change the first step");
2487    }
2488}