Struct ProjectedKktResidual 

pub struct ProjectedKktResidual { /* private fields */ }

KKT residual r = grad_beta L_pen(beta_hat) at the converged inner iterate, tagged with the exact represented subspace.

Implementations

impl ProjectedKktResidual

pub fn residual_tol(&self) -> Option<f64>

The KKT-stationarity tolerance the inner solver applied at the producing iterate. Returns None when the residual was built from a legacy site that hasn’t been threaded yet; downstream consumers should substitute f64::NAN in that case.

pub fn free_rank(&self) -> Option<usize>

Dimensionality of the free subspace: total_p - active_set_size at the producing iterate. None from legacy construction sites.

impl ProjectedKktResidual

pub fn from_active_projected(residual: Array1<f64>) -> Self

Construct from r_A = P_T(Sbeta + Gamma beta - grad ell), with active constraint multipliers removed but before any reduced-range projection.

pub fn with_metadata(self, residual_tol: f64, free_rank: usize) -> Self

Attach the KKT tolerance and free-subspace rank to a previously constructed residual.

pub fn with_free_rank(self, free_rank: usize) -> Self

Attach the free-subspace rank alone, for producers that know which subspace they projected onto but have no inner-solver tolerance to report.

with_metadata demands both numbers, and the standard REML assembly builders have only one: the active set is empty by construction there (see the guards at both call sites), so free_rank is exactly the coefficient count, while the inner solve exposes no KKT tolerance at that seam. Before this existed those producers passed neither, and a residual that does not record its own projection cannot be audited – subspace=ActiveProjected free_rank=None says “some directions were removed” without saying which or how many. Supplying a made-up tolerance just to reach with_metadata would be worse: a number where a measurement belongs.

pub fn as_array(&self) -> &Array1<f64>

Borrow the underlying free-space residual for the H^-1*r solve and its rho-derivatives.

pub fn subspace(&self) -> KktResidualSubspace

pub fn inf_norm(&self) -> f64

Sup-norm of the projected residual — the scalar a stationarity verdict is actually taken on. A refusal that reports only its cycle count cannot say whether the solve was one order from the tolerance or ten, and those have different causes; this is the number to put next to the count.

Trait Implementations

impl Clone for ProjectedKktResidual

fn clone(&self) -> ProjectedKktResidual

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProjectedKktResidual

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.