Struct ganesh::Status

pub struct Status<T> {
    pub message: String,
    pub x: Vec<T>,
    pub fx: T,
    pub n_evals: usize,
    pub converged: bool,
}

A status message struct containing all information about a minimization result.

Fields

message: String

A String message that can be set by minimization Algorithms.

x: Vec<T>

The current position of the minimization.

fx: T

The current value of the minimization problem function at Status::x.

n_evals: usize

The number of function evaluations (approximately, this is left up to individual Algorithms to correctly compute and may not be exact).

converged: bool

Flag that says whether or not the fit is in a converged state.

Implementations

impl<T> Status<T>

pub fn update_message(&mut self, message: &str)

Updates the Status::message field.

pub fn update_position(&mut self, pos: (Vec<T>, T))

Updates the Status::x and Status::fx fields.

pub fn set_converged(&mut self)

Sets Status::converged to be true.

pub fn increment_n_evals(&mut self)

Increments Status::n_evals by 1.

Trait Implementations

impl<T: Clone> Clone for Status<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Status<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Status<T>

fn default() -> Status<T>

Returns the “default value” for a type.

impl<T> Display for Status<T>

where T: Debug + Display,

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

Formats the value using the given formatter.