Skip to main content

Solution

Struct Solution

pub struct Solution {
    pub final_point: Array1<f64>,
    pub final_value: f64,
    pub final_gradient: Option<Array1<f64>>,
    pub final_hessian: Option<Array2<f64>>,
    pub final_gradient_norm: Option<f64>,
    pub final_step_norm: Option<f64>,
    pub stationarity_kind: StationarityKind,
    pub iterations: usize,
    pub func_evals: usize,
    pub grad_evals: usize,
    pub hess_evals: usize,
}

Expand description

A summary of a successful solver run.

Note that for non-convex functions, convergence to a local minimum is not guaranteed.

Fields§

§final_point: Array1<f64>

The point at which the minimum value was found.

§final_value: f64

The minimum value of the objective function.

§final_gradient: Option<Array1<f64>>

The gradient at the final point when the solver is gradient-based.

§final_hessian: Option<Array2<f64>>

The Hessian at the final point when the solver tracks one.

§final_gradient_norm: Option<f64>

The projected gradient norm at the final point when available.

§final_step_norm: Option<f64>

The final accepted fixed-point step norm when available.

§stationarity_kind: StationarityKind

The meaning of the stationarity metric for this solution.

§iterations: usize

The total number of iterations performed.

§func_evals: usize

The total number of times the objective function was evaluated.

§grad_evals: usize

The total number of times the gradient was evaluated.

§hess_evals: usize

The total number of times a Hessian was supplied directly by the objective.

Trait Implementations§

impl Clone for Solution

fn clone(&self) -> Solution

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Solution

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for Solution

impl RefUnwindSafe for Solution

impl Send for Solution

impl Sync for Solution

impl Unpin for Solution

impl UnsafeUnpin for Solution

impl UnwindSafe for Solution

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.