Struct Status

pub struct Status {
    pub message: String,
    pub x: Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>,
    pub x0: Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>,
    pub bounds: Option<Vec<Bound>>,
    pub fx: f64,
    pub n_f_evals: usize,
    pub n_g_evals: usize,
    pub converged: bool,
    pub hess: Option<Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>>,
    pub cov: Option<Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>>,
    pub err: Option<Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>>,
    pub parameters: Option<Vec<String>>,
}

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: Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>

The current position of the minimization.

x0: Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>

The initial position of the minimization.

bounds: Option<Vec<Bound>>

The bounds used for the minimization.

fx: f64

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

n_f_evals: usize

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

n_g_evals: usize

The number of gradient 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.

hess: Option<Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>>

The Hessian matrix at the end of the fit (None if not computed yet)

cov: Option<Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>>

Covariance matrix at the end of the fit (None if not computed yet)

err: Option<Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>>

Errors on parameters at the end of the fit (None if not computed yet)

parameters: Option<Vec<String>>

Optional parameter names

Implementations

impl Status

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

Updates the Status::message field.

pub fn update_position( &mut self, pos: (Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>, f64), )

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

pub fn set_converged(&mut self)

Sets Status::converged to be true.

pub fn inc_n_f_evals(&mut self)

Increments Status::n_f_evals by 1.

pub fn inc_n_g_evals(&mut self)

Increments Status::n_g_evals by 1.

pub fn set_parameter_names<L>(&mut self, names: &[L])

where L: AsRef<str>,

Sets parameter names.

pub fn set_cov( &mut self, covariance: Option<Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>>, )

Sets the covariance matrix and updates parameter errors.

pub fn set_hess( &mut self, hessian: &Matrix<f64, Dyn, Dyn, VecStorage<f64, Dyn, Dyn>>, )

Sets the Hessian matrix, computes the covariance matrix, and updates parameter errors.

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Default for Status

fn default() -> Status

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Status

fn deserialize<__D>( __deserializer: __D, ) -> Result<Status, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Status

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

Formats the value using the given formatter.

impl ReadWrite for Status

fn create_null() -> Self

Create a null version of the object which acts as a shell into which Python’s pickle module can load data. This generally shouldn’t be used to construct the struct in regular code.

fn save_as<T: AsRef<str>>(&self, file_path: T) -> Result<(), LadduError>

Save a serde-object to a file path, using the extension to determine the file format

fn load_from<T: AsRef<str>>(file_path: T) -> Result<Self, LadduError>

Load a serde-object from a file path, using the extension to determine the file format

impl Serialize for Status

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.