Struct DescrStatsW 

pub struct DescrStatsW { /* private fields */ }

Weighted descriptive statistics for a 1-D sample.

Wraps a data vector and (optional) case weights and exposes the weighted mean, (co)variance with a configurable degrees-of-freedom correction, and a one-sample t-test of the mean. Mirrors the reference DescrStatsW.

Implementations

impl DescrStatsW

pub fn new(data: Array1<f64>, weights: Option<Array1<f64>>, ddof: f64) -> Self

Construct from data and optional weights (defaulting to all-ones), with degrees-of-freedom correction ddof (default convention 0).

pub fn sum_weights(&self) -> f64

Sum of the weights (the effective number of observations).

pub fn nobs(&self) -> f64

Number of observations, equal to the sum of weights.

pub fn sum(&self) -> f64

Weighted sum of the data.

pub fn mean(&self) -> f64

Weighted mean of the data.

pub fn sumsquares(&self) -> f64

Weighted sum of squares of the demeaned data.

pub fn var_ddof(&self, ddof: f64) -> f64

Variance with denominator sum_weights - ddof_override.

pub fn var(&self) -> f64

Variance with the instance’s default ddof.

pub fn std_ddof(&self, ddof: f64) -> f64

Standard deviation with denominator sum_weights - ddof_override.

pub fn std(&self) -> f64

Standard deviation with the instance’s default ddof.

pub fn std_mean(&self) -> f64

Standard error of the weighted mean.

Uses the ddof-adjusted standard deviation rescaled to the population form and divided by sqrt(sum_weights - 1), exactly as the reference.

pub fn ttest_mean(&self, value: f64, alternative: Alternative) -> TTestResult

One-sample t-test that the (weighted) mean equals value.

Returns the statistic (mean - value) / std_mean, its t-distribution p-value with sum_weights - 1 degrees of freedom, and that d.o.f.

Trait Implementations

impl Clone for DescrStatsW

fn clone(&self) -> DescrStatsW

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescrStatsW

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

Formats the value using the given formatter.