Struct Status

pub struct Status<T: Scalar> {
    pub message: String,
    pub x: DVector<T>,
    pub x0: DVector<T>,
    pub bounds: Option<Vec<Bound<T>>>,
    pub fx: T,
    pub n_f_evals: usize,
    pub n_g_evals: usize,
    pub converged: bool,
    pub hess: Option<DMatrix<T>>,
    pub cov: Option<DMatrix<T>>,
    pub err: Option<DVector<T>>,
    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: DVector<T>

The current position of the minimization.

x0: DVector<T>

The initial position of the minimization.

bounds: Option<Vec<Bound<T>>>

The bounds used for the minimization.

fx: T

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<DMatrix<T>>

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

cov: Option<DMatrix<T>>

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

err: Option<DVector<T>>

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

parameters: Option<Vec<String>>

Optional parameter names

Implementations

impl<T: Scalar> Status<T>

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

Updates the Status::message field.

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

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: AsRef<str>>(&mut self, names: &[L])

Sets parameter names.

impl<T: Scalar + Float + RealField> Status<T>

pub fn set_cov(&mut self, covariance: Option<DMatrix<T>>)

Sets the covariance matrix and updates parameter errors.

pub fn set_hess(&mut self, hessian: &DMatrix<T>)

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

Trait Implementations

impl<T: Clone + Scalar> 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 + Scalar> Debug for Status<T>

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

Formats the value using the given formatter.

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

fn default() -> Status<T>

Returns the “default value” for a type.

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

where T: Deserialize<'de> + Scalar,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Status<T>

where T: Float + Scalar + Display + UpperExp,

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

Formats the value using the given formatter.

impl<T> Serialize for Status<T>

where T: Serialize + Scalar,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.