Skip to main content

StatisticsWindow

Struct StatisticsWindow 

Source
pub struct StatisticsWindow<T: Copy + Into<f64>> { /* private fields */ }
Expand description

A simple sliding-window buffer that retains the most-recent capacity values and exposes statistical helpers.

Unlike LockFreeRingBuffer this type is single-threaded and designed for convenience, not throughput.

§Type bound

T: Copy + Into<f64> so that integer and floating-point scalars can all be treated uniformly.

§Example

use trustformers_debug::ring_buffer::StatisticsWindow;
let mut w = StatisticsWindow::new(4);
w.push(1u32);
w.push(2u32);
w.push(3u32);
assert_eq!(w.mean(), Some(2.0));

Implementations§

Source§

impl<T: Copy + Into<f64>> StatisticsWindow<T>

Source

pub fn new(capacity: usize) -> Self

Create a new window that retains at most capacity values.

Panics if capacity == 0.

Source

pub fn push(&mut self, value: T)

Push a value; if the window is full the oldest value is evicted.

Source

pub fn len(&self) -> usize

Number of values currently stored.

Source

pub fn is_empty(&self) -> bool

Returns true when no values are stored.

Source

pub fn iter_ordered(&self) -> impl Iterator<Item = T> + '_

Iterate over the window contents in insertion order (oldest first).

Source

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

Mean of the current window contents.

Source

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

Population standard deviation of the current window.

Returns None when fewer than 2 values are stored.

Source

pub fn min(&self) -> Option<T>

Minimum value in the current window.

Source

pub fn max(&self) -> Option<T>

Maximum value in the current window.

Source

pub fn percentile(&self, p: f64) -> Option<f64>

Approximate the p-th percentile (0.0–100.0) via a sorted copy.

Uses nearest-rank method.

Source

pub fn windowed_mean(&self, window: usize) -> Option<f64>

Mean of the last window values (or all values if fewer available).

Auto Trait Implementations§

§

impl<T> Freeze for StatisticsWindow<T>
where Vec<T>: Freeze,

§

impl<T> RefUnwindSafe for StatisticsWindow<T>
where Vec<T>: RefUnwindSafe,

§

impl<T> Send for StatisticsWindow<T>
where Vec<T>: Send,

§

impl<T> Sync for StatisticsWindow<T>
where Vec<T>: Sync,

§

impl<T> Unpin for StatisticsWindow<T>
where Vec<T>: Unpin,

§

impl<T> UnsafeUnpin for StatisticsWindow<T>
where Vec<T>: UnsafeUnpin,

§

impl<T> UnwindSafe for StatisticsWindow<T>
where Vec<T>: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more