Skip to main content

HuberScale

Struct HuberScale 

Source
pub struct HuberScale {
    pub d: f64,
    pub tol: f64,
    pub maxiter: usize,
}
Expand description

Huber’s “proposal 2” scaling for the IRLS weights (HuberScale).

This is the scale_est=HuberScale() option in the reference. It solves, by fixed-point iteration,

scale_{i+1}² = (1 / (n·h)) · Σ χ(r / scale_i) · scale_i²

with χ(x) = x²/2 for |x| < d and d²/2 otherwise, and the consistency constant h = (df_resid / n) · (d² + (1 − d²)·Φ(d) − 1/2 − d·φ(d)).

Fields§

§d: f64

Tuning constant d (default 2.5).

§tol: f64

Convergence tolerance on successive scale estimates.

§maxiter: usize

Maximum number of fixed-point iterations.

Implementations§

Source§

impl HuberScale

Source

pub fn scale(&self, df_resid: f64, nobs: f64, resid: &[f64]) -> f64

Evaluate Huber’s proposal-2 scale for the given residuals.

df_resid and nobs are the model degrees of freedom and the number of observations; the iteration is seeded with the MAD of resid.

Trait Implementations§

Source§

impl Clone for HuberScale

Source§

fn clone(&self) -> HuberScale

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for HuberScale

Source§

impl Debug for HuberScale

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HuberScale

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.