Struct argmin_core::ArgminResult

pub struct ArgminResult<T> {
    pub param: T,
    pub cost: f64,
    pub iters: u64,
    pub terminated: bool,
    pub termination_reason: TerminationReason,
}

Expand description

Return struct for all solvers.

Fields

param: T

Final parameter vector

cost: f64

Final cost value

iters: u64

Number of iterations

terminated: bool

Indicated whether it terminated or not

termination_reason: TerminationReason

Reason of termination

Implementations

impl<T> ArgminResult<T>

pub fn new(
    param: T,
    cost: f64,
    iters: u64,
    termination_reason: TerminationReason
) -> Self

Constructor

param: Final (best) parameter vector cost: Final (best) cost function value iters: Number of iterations termination_reason: Reason of termination

Trait Implementations

impl<T: Clone> Clone for ArgminResult<T>

fn clone(&self) -> ArgminResult<T>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for ArgminResult<T>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<T> RefUnwindSafe for ArgminResult<T>where
T: RefUnwindSafe,

impl<T> Send for ArgminResult<T>where
T: Send,

impl<T> Sync for ArgminResult<T>where
T: Sync,

impl<T> Unpin for ArgminResult<T>where
T: Unpin,

impl<T> UnwindSafe for ArgminResult<T>where
T: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<T> ToOwned for Twhere
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 Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T> SendSyncUnwindSafe for Twhere
T: Send + Sync + UnwindSafe + ?Sized,