Struct ResidualDiagnostics

Source

pub struct ResidualDiagnostics {
    pub n_residuals: usize,
    pub n_parameters: usize,
    pub degrees_of_freedom: isize,
    pub weighted_sum_squares: f64,
    pub rms_m: f64,
    pub normalized_residuals: Vec<f64>,
    pub worst_index: Option<usize>,
    pub reduced_chi_square: Option<f64>,
    pub chi_square_threshold: Option<f64>,
    pub chi_square_consistent: Option<bool>,
}

Expand description

Standalone post-fit residual diagnostics.

Fields§

§n_residuals: usize

Number of residuals.

§n_parameters: usize

Number of fitted parameters used to compute redundancy.

§degrees_of_freedom: isize

Redundancy / degrees of freedom: n_residuals - n_parameters.

§weighted_sum_squares: f64

Weighted residual sum of squares.

§rms_m: f64

Root-mean-square residual in metres, unweighted.

§normalized_residuals: Vec<f64>

Residuals scaled by sqrt(weight); unit weights when no weights are given.

§worst_index: Option<usize>

Index of the largest absolute normalized residual.

§reduced_chi_square: Option<f64>

Reduced chi-square, weighted_sum_squares / degrees_of_freedom, when degrees of freedom are positive.

§chi_square_threshold: Option<f64>

Chi-square threshold for the requested false-alarm probability, when requested and degrees of freedom are positive.

§chi_square_consistent: Option<bool>

Whether weighted_sum_squares <= chi_square_threshold, when a threshold was requested and degrees of freedom are positive.

Trait Implementations§

Source §

impl Clone for ResidualDiagnostics

Source §

fn clone(&self) -> ResidualDiagnostics

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for ResidualDiagnostics

Source §

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

Formats the value using the given formatter. Read more

Source §

impl PartialEq for ResidualDiagnostics

Source §

fn eq(&self, other: &ResidualDiagnostics) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Source §

impl StructuralPartialEq for ResidualDiagnostics

Auto Trait Implementations§

§

impl UnwindSafe for ResidualDiagnostics

Blanket Implementations§

Source §

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

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

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

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

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

Source §

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

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

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

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.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §