Skip to main content

FitSensitivity

Struct FitSensitivity 

Source
pub struct FitSensitivity<'a> { /* private fields */ }
Expand description

The one sensitivity operator built at the optimum. See module docs.

Implementations§

Source§

impl<'a> FitSensitivity<'a>

Source

pub fn from_faer_cholesky(factor: &'a FaerCholeskyFactor, dim: usize) -> Self

Source

pub fn from_lower_triangular(factor: &'a Array2<f64>) -> Self

Source

pub fn from_projected( basis: &'a Array2<f64>, reduced_inverse: &'a Array2<f64>, ) -> Self

Source

pub fn dim(&self) -> usize

Coefficient dimension p the operator acts on.

Source

pub fn apply(&self, rhs: &Array1<f64>) -> Array1<f64>

H⁻¹ · rhs (pseudo-inverse action for the projected variant).

Source

pub fn apply_multi(&self, rhs: ArrayView2<'_, f64>) -> Array2<f64>

H⁻¹ · RHS for a (p × m) block of right-hand sides — the batched form every multi-channel consumer should use (outer ρ-pair solves, ALO’s H⁻¹Xᵀ leverage block) so the factor is traversed once per block instead of once per column.

Source

pub fn mode_response(&self, dg_dt: ArrayView2<'_, f64>) -> Option<Array2<f64>>

The IFT mode response ∂β̂/∂t = −H⁻¹ · ∂g/∂t for a (p × m) block of score perturbations — THE object of #935.

Returns None if any solved entry is non-finite (the factored curvature was unusable for this channel); callers must not substitute an approximation, matching the contract of the deleted ift_dbeta_drho_from_solver.

Source

pub fn mode_response_coned( &self, hessian: ArrayView2<'_, f64>, dg_dt: ArrayView2<'_, f64>, col_supports: &[Range<usize>], ) -> Option<Array2<f64>>

Cone-of-influence mode response (#779), the lazy/local form of Self::mode_response. Each perturbation column ∂g/∂t_a is structurally supported only within col_supports[a], so its response −H⁻¹ ∂g/∂t_a is exactly zero outside the coupling component of hessian containing that support. Columns whose support is empty (a structurally inactive channel) are skipped with no solve; the active columns are solved as ONE batched block through Self::apply_multi — strictly better than the per-column BLAS-2 loop this replaces — and each result confined to its cone. On a fully coupled hessian every cone is the whole space and the result equals Self::mode_response bit-for-bit.

hessian must be the same curvature this operator inverts; a dimension mismatch (or any non-finite solved entry) returns None rather than silently substituting an approximation.

Source

pub fn leverage_block(&self, design: &Array2<f64>) -> Array2<f64>

H⁻¹Xᵀ (p × n) — the shared leverage/case-sensitivity block: its column i is simultaneously ALO’s per-observation solve, the case- weight channel ∂g/∂w_i ∝ x_i, and the response channel ∂g/∂y_i ∝ x_i. One blocked solve serves all three diagnostics.

Source

pub fn response_jacobian( &self, design: &Array2<f64>, working_weights: ArrayView1<'_, f64>, ) -> Option<Array2<f64>>

Data attribution ∂β̂/∂y (p × n) — how each fitted coefficient responds to each response value, the t = y channel of the one identity ∂β̂/∂t = −H⁻¹ ∂g/∂t.

The response enters the penalized score only through the working residual, so ∂g/∂y_i = −w_i x_i and therefore

  ∂β̂/∂y_i = w_i · H⁻¹ x_i,

i.e. column i of Self::leverage_block scaled by the working weight w_i. Contracting back through the design recovers the smoother/hat matrix A = X (∂β̂/∂y) = X H⁻¹ Xᵀ W, whose diagonal is the leverage already reported elsewhere. For a Gaussian penalized fit β̂ = H⁻¹ Xᵀ y, so this Jacobian is exact (and weight-free); for a GLM it is the one-step attribution at the fitted working weights.

Returns None on a shape mismatch.

Source

pub fn case_deletion( &self, design: &Array2<f64>, working_weights: ArrayView1<'_, f64>, working_residual: ArrayView1<'_, f64>, phi: f64, ) -> Option<CaseDeletionInfluence>

Case-deletion influence (dfbetas + Cook’s distance) for every observation, built from the one sensitivity operator — the “leave-one-out” channel #935 was designed to unify.

Deleting observation i perturbs the penalized score by exactly its own contribution, so the IFT mode response gives the coefficient change in closed form (the penalized Sherman–Morrison identity):

  β̂ − β̂₍ᵢ₎ = (w_i r_i / (1 − h_ii)) · H⁻¹ x_i

where x_i is row i of design, w_i = working_weights[i] the IRLS working weight, r_i = working_residual[i] the working residual z_i − x_iᵀβ̂, and h_ii = w_i x_iᵀ H⁻¹ x_i the leverage. Column i of Self::leverage_block is H⁻¹ x_i, so each dfbeta is one scaled column — no per-observation refit, no second factorization. For a Gaussian penalized fit the identity is exact; for a GLM it is the standard one-step (ALO) approximation, consistent with the leverage already reported by AloDiagnostics.

Cook’s distance uses the metric the fit actually moves in, H = XᵀWX + S:

  D_i = (β̂−β̂₍ᵢ₎)ᵀ H (β̂−β̂₍ᵢ₎) / (p · φ)
      = scale_i² · (x_iᵀ H⁻¹ x_i) / (p · φ),   scale_i = w_i r_i / (1 − h_ii),

the second form following from (H⁻¹x_i)ᵀ H (H⁻¹x_i) = x_iᵀ H⁻¹ x_i, so the single quadratic form x_iᵀ H⁻¹ x_i gates the leverage, the deletion denominator, and Cook’s distance alike — no separate H apply.

This is an opt-in diagnostic: dfbeta is n × p and is never materialized on the default fit path (it would be ruinous at large-scale scale). Returns None on a shape mismatch or if any leverage reaches 1 (a point the deletion identity cannot resolve).

Auto Trait Implementations§

§

impl<'a> Freeze for FitSensitivity<'a>

§

impl<'a> RefUnwindSafe for FitSensitivity<'a>

§

impl<'a> Send for FitSensitivity<'a>

§

impl<'a> Sync for FitSensitivity<'a>

§

impl<'a> Unpin for FitSensitivity<'a>

§

impl<'a> UnsafeUnpin for FitSensitivity<'a>

§

impl<'a> UnwindSafe for FitSensitivity<'a>

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V