Enum candle_optimisers::lbfgs::GradConv

#[non_exhaustive]
pub enum GradConv {
    MinForce(f64),
    RMSForce(f64),
}

Conditions for terminsation based on gradient

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MinForce(f64)

convergence based on max abs component of gradient

RMSForce(f64)

convergence based on mean force

Trait Implementations

impl Clone for GradConv

fn clone(&self) -> GradConv

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GradConv

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

Formats the value using the given formatter.

impl PartialEq for GradConv

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for GradConv

fn partial_cmp(&self, other: &GradConv) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for GradConv

impl StructuralPartialEq for GradConv