scirs2_optimize::unconstrained::convergence_diagnostics

Struct ConvergenceMetrics

pub struct ConvergenceMetrics {
    pub f_rel_change: f64,
    pub f_abs_change: f64,
    pub grad_rel_norm: f64,
    pub x_rel_change: f64,
    pub optimality: f64,
    pub condition_estimate: Option<f64>,
}

Expand description

Convergence metrics for an iteration

Fields§

§f_rel_change: f64

Relative function change

§f_abs_change: f64

Absolute function change

§grad_rel_norm: f64

Relative gradient norm

§x_rel_change: f64

Step size relative to x

§optimality: f64

First-order optimality measure

§condition_estimate: Option<f64>

Estimated condition number

Trait Implementations§

Source §

impl Clone for ConvergenceMetrics

Source §

fn clone(&self) -> ConvergenceMetrics

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for ConvergenceMetrics

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for ConvergenceMetrics

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> 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> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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 §