Skip to main content

Huber

Struct Huber 

Source
pub struct Huber { /* private fields */ }
Expand description

Huber’s loss with tuning k (default 1.345, ≈ 95% Gaussian efficiency). ρ(r) = r²/2 for |r| ≤ k, else k|r| − k²/2.

Implementations§

Source§

impl Huber

Source

pub fn new(k: f64) -> Result<Huber, RobustError>

Create a Huber loss with the given positive tuning constant.

Trait Implementations§

Source§

impl Clone for Huber

Source§

fn clone(&self) -> Huber

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 Huber

Source§

impl Debug for Huber

Source§

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

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

impl Default for Huber

Source§

fn default() -> Huber

k = 1.345.

Source§

impl RhoFunction for Huber

Source§

fn rho(&self, r: f64) -> f64

The loss ρ(r).
Source§

fn psi(&self, r: f64) -> f64

The score ψ(r) = ρ'(r): the (unstandardized) influence-function shape.
Source§

fn weight(&self, r: f64) -> f64

The IRLS weight w(r) = ψ(r)/r, with the removable singularity at r = 0 resolved by the limit ψ'(0).
Source§

fn psi_prime(&self, r: f64) -> f64

The derivative ψ'(r) = ρ''(r): the curvature of the loss and the shape of the E[ψ'] term in the asymptotic variance. (That E[ψ'] is computed via Stein’s identity E[X·ψ(X)], not by integrating this, so kinked scores stay exact; psi_prime is exposed for callers and completeness.)
Source§

fn tuning(&self) -> f64

The tuning constant controlling the efficiency/robustness trade-off (f64::NAN for losses without one, e.g. L1/least squares).
Source§

fn is_redescending(&self) -> bool

Whether ψ redescends to zero (⇒ ρ non-convex ⇒ needs a good start).
Source§

fn rho_sup(&self) -> Option<f64>

sup ρ = ρ(∞): Some(_) for bounded (redescending) losses, None for unbounded ones (Huber, least squares). Consumed by the S-scale.

Auto Trait Implementations§

§

impl Freeze for Huber

§

impl RefUnwindSafe for Huber

§

impl Send for Huber

§

impl Sync for Huber

§

impl Unpin for Huber

§

impl UnsafeUnpin for Huber

§

impl UnwindSafe for Huber

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