Struct RollingMean 

pub struct RollingMean { /* private fields */ }

Rolling mean over a fixed-size window.

The window is a FIFO queue: when full, the oldest observation is removed before the newest is inserted.

Examples

use rill_ml::stats::RollingMean;
use rill_ml::OnlineStatistic;

let mut rm = RollingMean::new(3).unwrap();
rm.update(1.0).unwrap();
rm.update(2.0).unwrap();
rm.update(3.0).unwrap();
assert!((rm.value().unwrap() - 2.0).abs() < 1e-12);
rm.update(6.0).unwrap(); // window becomes [2, 3, 6]
assert!((rm.value().unwrap() - 3.6666666666666665).abs() < 1e-12);

Implementations

impl RollingMean

pub fn new(capacity: usize) -> Result<Self, RillError>

Create a new rolling mean with the given window capacity.

Returns an error if capacity is zero.

pub const fn capacity(&self) -> usize

The configured window capacity.

pub fn len(&self) -> usize

Number of observations currently in the window.

pub fn is_empty(&self) -> bool

Whether the window is currently empty.

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

Current rolling mean, or None if the window is empty.

Trait Implementations

impl Clone for RollingMean

fn clone(&self) -> RollingMean

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RollingMean

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

Formats the value using the given formatter.

impl OnlineStatistic for RollingMean

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

Update the statistic with a new observation.

fn samples_seen(&self) -> u64

How many observations have been incorporated.

fn reset(&mut self)

Reset the statistic.