Skip to main content

FixedWindowBuffer

Struct FixedWindowBuffer 

Source
pub struct FixedWindowBuffer { /* private fields */ }
Expand description

A bounded ring buffer storing the most recent capacity observations.

When the buffer is full, pushing a new value overwrites the oldest entry. Useful for fixed-window training or replay where only recent data matters.

Space complexity: O(capacity).

§Examples

use rill_ml::drift::FixedWindowBuffer;

let mut buf = FixedWindowBuffer::new(3).unwrap();
buf.push(1.0).unwrap();
buf.push(2.0).unwrap();
buf.push(3.0).unwrap();
assert_eq!(buf.mean(), Some(2.0));

// Overwrites the oldest entry (1.0).
buf.push(4.0).unwrap();
assert_eq!(buf.mean(), Some(3.0)); // (2 + 3 + 4) / 3

Implementations§

Source§

impl FixedWindowBuffer

Source

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

Create a new buffer with the given capacity.

capacity must be greater than zero.

Source

pub const fn capacity(&self) -> usize

The maximum number of elements the buffer can hold.

Source

pub const fn len(&self) -> usize

The current number of elements stored.

Source

pub const fn is_empty(&self) -> bool

Whether the buffer is empty.

Source

pub const fn is_full(&self) -> bool

Whether the buffer is at capacity.

Source

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

Push a new value, overwriting the oldest entry if full.

value must be finite.

Source

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

The mean of the stored values, or None if empty.

Source

pub fn iter(&self) -> impl Iterator<Item = &f64>

Iterate over the stored values in insertion order (oldest to newest).

Source

pub fn reset(&mut self)

Reset to the empty state.

Trait Implementations§

Source§

impl Clone for FixedWindowBuffer

Source§

fn clone(&self) -> FixedWindowBuffer

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 FixedWindowBuffer

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> 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, 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