Skip to main content

Summary

Struct Summary 

Source
pub struct Summary {
Show 17 fields pub n_observations: usize, pub n_parameters: usize, pub df_residual: f64, pub has_intercept: bool, pub coefficients: Vec<CoefficientRow>, pub r_squared: f64, pub adj_r_squared: f64, pub f_statistic: FStatistic, pub residual_std_error: f64, pub log_likelihood: f64, pub aic: f64, pub bic: f64, pub condition_number: f64, pub durbin_watson: f64, pub jarque_bera: JarqueBera, pub breusch_pagan: BreuschPagan, pub white: WhiteTest,
}
Expand description

A structured snapshot of every diagnostic in the crate for one fit.

Summary is structured data first: every field is a real number you can read programmatically. The Display impl is a convenience layer that renders it as a statsmodels-style table — it is not the primary interface, so you never have to parse text to get a value back out.

Build it with OlsFit::summary.

Fields§

§n_observations: usize

Number of observations.

§n_parameters: usize

Number of parameters.

§df_residual: f64

Residual degrees of freedom.

§has_intercept: bool

Whether an intercept is present.

§coefficients: Vec<CoefficientRow>

One row per coefficient.

§r_squared: f64

.

§adj_r_squared: f64

Adjusted .

§f_statistic: FStatistic

Overall F-test.

§residual_std_error: f64

Residual standard error s.

§log_likelihood: f64

Gaussian log-likelihood.

§aic: f64

Akaike information criterion.

§bic: f64

Bayesian information criterion.

§condition_number: f64

Design-matrix condition number.

§durbin_watson: f64

Durbin-Watson statistic.

§jarque_bera: JarqueBera

Jarque-Bera normality test.

§breusch_pagan: BreuschPagan

Breusch-Pagan heteroskedasticity test.

§white: WhiteTest

White’s heteroskedasticity test.

Implementations§

Source§

impl Summary

Source

pub fn max_cooks_distance(fit: &OlsFit) -> f64

Maximum absolute Cook’s distance across observations, recomputed from the fit — a convenience for callers that want a single influence headline number without walking the full vector. (Not stored on Summary because it is per-observation; use crate::influence::cooks_distance for the full vector.)

Trait Implementations§

Source§

impl Clone for Summary

Source§

fn clone(&self) -> Summary

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 Summary

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Summary

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<U> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V