Skip to main content

SScale

Struct SScale 

Source
pub struct SScale<R>
where R: RhoFunction,
{ /* private fields */ }
Expand description

The M-estimate of scale (“S-scale”): the s > 0 solving (1/n) Σ ρ(rᵢ/s) = δ.

With a bounded, redescending ρ and δ = ρ.rho_sup()/2 this is the 50%-breakdown scale that S- and MM-regression minimize; with δ = E_Φ[ρ] it is Fisher-consistent for σ at the Gaussian (for the biweight the S-step tuning c ≈ 1.547 makes the two coincide). Generic over the loss, but the loss must have bounded ρ (rho_sup().is_some()): an unbounded ρ gives zero breakdown (a single rᵢ → ∞ drives s without limit) so new rejects it with RobustError::UnboundedLoss.

Solved by the standard fixed-point iteration s ← s·√(mean_i ρ(rᵢ/s) / δ) from a MAD start; g(s) = (1/n)Σρ(rᵢ/s) is monotone decreasing, so the root is unique.

Implementations§

Source§

impl<R> SScale<R>
where R: RhoFunction,

Source

pub fn new(rho: R, delta: f64) -> Result<SScale<R>, RobustError>

Create an S-scale for loss rho with consistency target 0 < delta < sup ρ.

Rejects an unbounded loss (rho_sup() == None) with RobustError::UnboundedLoss, since it cannot define a high-breakdown scale and a delta outside (0, sup ρ) (for which the scale equation has no root) with RobustError::InvalidTuning.

Source

pub fn fisher_consistent( rho: R, quad_points: usize, ) -> Result<SScale<R>, RobustError>

Create a Fisher-consistent S-scale by setting δ = E_Φ[ρ], evaluated by Gauss–Hermite quadrature with quad_points nodes.

Source

pub fn with_control(self, control: Control) -> SScale<R>

Override the default convergence control.

Source

pub fn delta(&self) -> f64

The consistency target δ.

Trait Implementations§

Source§

impl<R> Clone for SScale<R>
where R: Clone + RhoFunction,

Source§

fn clone(&self) -> SScale<R>

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<R> Copy for SScale<R>
where R: Copy + RhoFunction,

Source§

impl<R> Debug for SScale<R>
where R: Debug + RhoFunction,

Source§

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

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

impl<R> ScaleEstimator for SScale<R>
where R: RhoFunction,

Source§

fn scale(&self, residuals: &[f64]) -> Result<Scale, RobustError>

A robust scale of the given residuals.

Auto Trait Implementations§

§

impl<R> Freeze for SScale<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for SScale<R>
where R: RefUnwindSafe,

§

impl<R> Send for SScale<R>
where R: Send,

§

impl<R> Sync for SScale<R>
where R: Sync,

§

impl<R> Unpin for SScale<R>
where R: Unpin,

§

impl<R> UnsafeUnpin for SScale<R>
where R: UnsafeUnpin,

§

impl<R> UnwindSafe for SScale<R>
where R: UnwindSafe,

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> 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> 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> 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> 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> 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 = 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