Struct OnlineStats 

pub struct OnlineStats { /* private fields */ }

Online state for computing mean, variance and standard deviation.

Optimized memory layout for better cache performance:

• Grouped related fields together in hot, warm and cold paths.

Implementations

impl OnlineStats

pub fn new() -> OnlineStats

Create initial state.

Population size, variance and mean are set to 0.

pub fn from_slice<T: ToPrimitive>(samples: &[T]) -> OnlineStats

Initializes OnlineStats from a sample.

pub const fn mean(&self) -> f64

Return the current mean.

pub fn stddev(&self) -> f64

Return the current standard deviation.

pub fn variance(&self) -> f64

Return the current variance.

pub fn harmonic_mean(&self) -> f64

Return the current harmonic mean.

pub fn geometric_mean(&self) -> f64

Return the current geometric mean.

pub const fn n_counts(&self) -> (u64, u64, u64)

Return the number of negative, zero and positive counts.

Returns a tuple (negative_count, zero_count, positive_count) where:

• negative_count: number of values with negative sign bit (including -0.0)
• zero_count: number of values equal to +0.0
• positive_count: number of values greater than 0

Note: -0.0 and +0.0 are distinguished by their sign bit and counted separately.

Example

use stats::OnlineStats;

let mut stats = OnlineStats::new();
stats.extend(vec![-2, -1, 0, 0, 1, 2, 3]);

let (neg, zero, pos) = stats.n_counts();
assert_eq!(neg, 2);   // -2, -1
assert_eq!(zero, 2);  // 0, 0
assert_eq!(pos, 3);   // 1, 2, 3

pub fn add<T: ToPrimitive>(&mut self, sample: &T)

Add a new sample.

pub fn add_f64(&mut self, sample: f64)

Add a new f64 sample. Skipping the ToPrimitive conversion.

pub fn add_null(&mut self)

Add a new NULL value to the population. This increases the population size by 1.

pub const fn len(&self) -> usize

Returns the number of data points.

pub const fn is_empty(&self) -> bool

Returns if empty.

Trait Implementations

impl Clone for OnlineStats

fn clone(&self) -> OnlineStats

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Commute for OnlineStats

fn merge(&mut self, v: OnlineStats)

Merges the value other into self.

fn consume<I: Iterator<Item = Self>>(&mut self, other: I)

Merges the values in the iterator into self.

impl Debug for OnlineStats

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

Formats the value using the given formatter.

impl Default for OnlineStats

fn default() -> OnlineStats

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OnlineStats

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: ToPrimitive> Extend<T> for OnlineStats

fn extend<I: IntoIterator<Item = T>>(&mut self, it: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<T: ToPrimitive> FromIterator<T> for OnlineStats

fn from_iter<I: IntoIterator<Item = T>>(it: I) -> OnlineStats

Creates a value from an iterator.

impl PartialEq for OnlineStats

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

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

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

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

impl Serialize for OnlineStats

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for OnlineStats

impl StructuralPartialEq for OnlineStats