FitStat

Struct FitStat

pub struct FitStat<Model: FitModelErrors + LevMarModel> {
    pub report: MinimizationReport<Model::Scalar>,
    pub reduced_chi2: Model::Scalar,
    pub errors: Model::OwnedModel,
    pub covariance_matrix: GenericMatrix<Model::Scalar, Model::ParamCount, Model::ParamCount>,
}

Expand description

Result of fit_stat.

Fields§

§report: MinimizationReport<Model::Scalar>

Report resulted from the fit

§reduced_chi2: Model::Scalar

$\chi^{2}/\test{dof}$ criteria. Should be about 1 for correct fit.

§errors: Model::OwnedModel

Type defined by model, containing parameter errors.

This will usually be the model type itself, but there may be exceptions.

§covariance_matrix: GenericMatrix<Model::Scalar, Model::ParamCount, Model::ParamCount>

A parameter covariance matrix. If you don’t know what this is, you can safely ignore it.

Trait Implementations§

impl<Model: Debug + FitModelErrors + LevMarModel> Debug for FitStat<Model>
where Model::Scalar: Debug, Model::OwnedModel: Debug, Model::ParamCount: Debug,

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<Model> Freeze for FitStat<Model>
where <Model as LevMarModel>::RealScalar: Freeze, <Model as FitModelErrors>::OwnedModel: Freeze, <<<Model as FitModel>::ParamCount as Conv>::TNum as ArrayLength>::ArrayType<GenericArray<<Model as LevMarModel>::RealScalar, <<Model as FitModel>::ParamCount as Conv>::TNum>>: Freeze,

impl<Model> RefUnwindSafe for FitStat<Model>
where <Model as LevMarModel>::RealScalar: RefUnwindSafe, <Model as FitModelErrors>::OwnedModel: RefUnwindSafe, <<<Model as FitModel>::ParamCount as Conv>::TNum as ArrayLength>::ArrayType<GenericArray<<Model as LevMarModel>::RealScalar, <<Model as FitModel>::ParamCount as Conv>::TNum>>: RefUnwindSafe, <<Model as FitModel>::ParamCount as Conv>::Nalg: RefUnwindSafe,

impl<Model> Send for FitStat<Model>
where <Model as FitModelErrors>::OwnedModel: Send,

impl<Model> Sync for FitStat<Model>
where <Model as FitModelErrors>::OwnedModel: Sync,

impl<Model> Unpin for FitStat<Model>
where <Model as LevMarModel>::RealScalar: Unpin, <Model as FitModelErrors>::OwnedModel: Unpin, <<<Model as FitModel>::ParamCount as Conv>::TNum as ArrayLength>::ArrayType<GenericArray<<Model as LevMarModel>::RealScalar, <<Model as FitModel>::ParamCount as Conv>::TNum>>: Unpin, <<Model as FitModel>::ParamCount as Conv>::Nalg: Unpin,

impl<Model> UnwindSafe for FitStat<Model>
where <Model as LevMarModel>::RealScalar: UnwindSafe, <Model as FitModelErrors>::OwnedModel: UnwindSafe, <<<Model as FitModel>::ParamCount as Conv>::TNum as ArrayLength>::ArrayType<GenericArray<<Model as LevMarModel>::RealScalar, <<Model as FitModel>::ParamCount as Conv>::TNum>>: UnwindSafe, <<Model as FitModel>::ParamCount as Conv>::Nalg: UnwindSafe,

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> 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> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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.