`shrinkage::StoppingCriterion`

Shrinkage for Rust · rust · 0.3.0

Source: src/solver.rs

pub enum StoppingCriterion

A convergence check with tolerances in its own units.

Variants

`DualityGap`

Source: src/solver.rs

DualityGap { absolute: f64, relative: f64 }

Stop when the absolute Gaussian lasso duality gap is at most absolute + relative * reference_loss.

`absolute`

Source: src/solver.rs

absolute: f64

Absolute gap tolerance.

`relative`

Source: src/solver.rs

relative: f64

Gap tolerance relative to the fixed zero-coefficient loss.

`KktViolation`

Source: src/solver.rs

KktViolation { absolute: f64 }

Stop when the maximum absolute KKT violation is at most absolute.

`absolute`

Source: src/solver.rs

absolute: f64

Absolute KKT tolerance.

`ProximalGradientMapping`

Source: src/solver.rs

ProximalGradientMapping { absolute: f64 }

Stop when the infinity norm of the proximal-gradient mapping, including the unpenalized intercept derivative, is at most absolute.

`absolute`

Source: src/solver.rs

absolute: f64

Absolute stationarity tolerance on the optimization scale.

Inherent implementation

Source: src/solver.rs

impl StoppingCriterion

`duality_gap`

Source: src/solver.rs

pub const fn duality_gap(relative: f64) -> Self

Select a relative duality-gap tolerance.

`kkt_violation`

Source: src/solver.rs

pub const fn kkt_violation(absolute: f64) -> Self

Select an absolute KKT tolerance.

`proximal_gradient_mapping`

Source: src/solver.rs

pub const fn proximal_gradient_mapping(absolute: f64) -> Self

Select an absolute proximal-gradient mapping tolerance.

Implementation of Clone

Source: src/solver.rs

impl Clone for StoppingCriterion

`clone`

Source: src/solver.rs

fn clone(&self) -> Self

Implementation of Copy

Source: src/solver.rs

impl Copy for StoppingCriterion

Implementation of Debug

Source: src/solver.rs

impl Debug for StoppingCriterion

`fmt`

Source: src/solver.rs

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

Implementation of PartialEq

Source: src/solver.rs

impl PartialEq for StoppingCriterion

`eq`

Source: src/solver.rs

fn eq(&self, other: &Self) -> bool

Implementation of StructuralPartialEq

Source: src/solver.rs

impl StructuralPartialEq for StoppingCriterion

Implementation of Freeze

impl Freeze for StoppingCriterion

Implementation of RefUnwindSafe

impl RefUnwindSafe for StoppingCriterion

Implementation of Send

impl Send for StoppingCriterion

Implementation of Sync

impl Sync for StoppingCriterion

Implementation of Unpin

impl Unpin for StoppingCriterion

Implementation of UnsafeUnpin

impl UnsafeUnpin for StoppingCriterion

Implementation of UnwindSafe

impl UnwindSafe for StoppingCriterion

Implementation of Any

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

Implementation of Boilerplate

impl<T> Boilerplate for T where T: Copy + Send + Sync + Debug + PartialEq + 'static

Implementation of Borrow

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

Implementation of BorrowMut

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

Implementation of ByRef

impl<T> ByRef<T> for T

Implementation of CastableFrom

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

Implementation of CastableFrom

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

Implementation of CloneToUninit

impl<T> CloneToUninit for T where T: Clone

Implementation of From

impl<T> From<T> for T

Implementation of Imply

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

Implementation of Into

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

Implementation of IntoEither

impl<T> IntoEither for T

Implementation of Pointable

impl<T> Pointable for T

Implementation of Read

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

Implementation of Same

impl<T> Same for T

Implementation of Scalar

impl<T> Scalar for T where T: 'static + Clone + PartialEq + Debug

Implementation of SupersetOf

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

Implementation of ToOwned

impl<T> ToOwned for T where T: Clone

Implementation of TryFrom

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

Implementation of TryInto

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