HuberT

Struct HuberT 

Source
pub struct HuberT<F>
where F: Float + 'static + Display,
{ pub t: F, pub weight_func: fn(F, F) -> F, }
Expand description

Huber loss function and constants for robust regression

Fields§

§t: F

The parameter that controls the transition between squared and absolute error

§weight_func: fn(F, F) -> F

The weight function used for iteratively reweighted least squares

Implementations§

Source§

impl<F> HuberT<F>
where F: Float + 'static + Display,

Source

pub fn new() -> Self

Create a new Huber T object with default parameters

The default tuning constant t=1.345 provides 95% efficiency compared to ordinary least squares when the errors are normally distributed.

Source

pub fn with_t(t: F) -> Self

Create a new Huber T object with custom parameter

§Arguments
  • t - The tuning constant that controls the transition between L1 and L2 loss
    • Smaller values (e.g., 1.0) make the estimator more robust to outliers but less efficient
    • Larger values (e.g., 2.0) make the estimator more similar to ordinary least squares
    • The recommended range is 1.0 to 2.0
Source

pub fn loss(&self, r: F) -> F

Calculate the Huber loss for a given residual

The Huber loss function is defined as:

  • For |r| ≤ t: L(r) = 0.5 * r² (quadratic/L2 loss)
  • For |r| > t: L(r) = t * |r| - 0.5 * t² (linear/L1 loss with an offset)
§Arguments
  • r - The residual value
§Returns

The Huber loss value for the residual

Trait Implementations§

Source§

impl<F> Default for HuberT<F>
where F: Float + 'static + Display,

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<F> Freeze for HuberT<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for HuberT<F>
where F: RefUnwindSafe,

§

impl<F> Send for HuberT<F>
where F: Send,

§

impl<F> Sync for HuberT<F>
where F: Sync,

§

impl<F> Unpin for HuberT<F>
where F: Unpin,

§

impl<F> UnwindSafe for HuberT<F>
where F: 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> 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> 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