Struct WeightedMean 

pub struct WeightedMean { /* private fields */ }

Preview O(1)-space weighted arithmetic mean.

Implementations

impl WeightedMean

pub const fn new() -> Self

Create an empty weighted mean.

pub fn value(&self) -> Option<f64>

Current weighted mean, or None before a positive weight is seen.

Trait Implementations

impl Clone for WeightedMean

fn clone(&self) -> WeightedMean

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WeightedMean

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

Formats the value using the given formatter.

impl Default for WeightedMean

fn default() -> WeightedMean

Returns the “default value” for a type.

impl PartialEq for WeightedMean

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WeightedMean

impl WeightedStatistic for WeightedMean

fn update_weighted(&mut self, value: f64, weight: f64) -> Result<(), RillError>

Incorporate a value with a caller-defined weight.

fn total_weight(&self) -> f64

Sum of accepted positive weights.

fn samples_seen(&self) -> u64

Number of accepted positive-weight observations.

fn reset(&mut self)

Reset values, total weight, and sample count.