Struct rolling_norm::Series

source · [−]

pub struct Series<R: Real, const N: usize> { /* private fields */ }

Expand description

Implements a ring buffer of length N that continuously and efficiently computes useful information such as mean and variance, or the minimum and maximum values.

All operations, except initialization, take time O(1).

The buffer can be accessed using indexing, where rolling[0] is the latest value, rolling[1], is the value inserted before, and so on.

Implementations

source

impl<R: Real, const N: usize> Series<R, N>

source

pub fn new() -> Self

Create a new rolling series. All values are initialized to zero.

source

pub fn insert(&mut self, new: R)

Inserts a new value into the rolling series.

source

pub fn mean(&self) -> R

Returns the mean, or average.

source

pub fn var(&self) -> R

Returns the variance.

source

pub fn stdev(&self) -> R

Returns the standard derivation.

source

pub fn curr(&self) -> R

Returns the latest value.

source

pub fn norm(&self) -> R

Returns the latest value, normalized. If the standard derivation is zero, return zero.

source

pub fn sum(&self) -> R

Returns the sum of all entries.

Trait Implementations

source

impl<R: Clone + Real, const N: usize> Clone for Series<R, N>

source

fn clone(&self) -> Series<R, N>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<R: Debug + Real, const N: usize> Debug for Series<R, N>

source

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

Formats the value using the given formatter. Read more

source

impl<R: Real, const N: usize> Default for Series<R, N>

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl<R: Real, const N: usize> From<[R; N]> for Series<R, N>

source

fn from(buf: [R; N]) -> Self

Converts to this type from the input type.

source

impl<R: Real, const N: usize> Index<usize> for Series<R, N>

type Output = R

The returned type after indexing.

source

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation. Read more

source

impl<R: Copy + Real, const N: usize> Copy for Series<R, N>

Auto Trait Implementations

impl<R, const N: usize> RefUnwindSafe for Series<R, N> where
R: RefUnwindSafe,

impl<R, const N: usize> Send for Series<R, N> where
R: Send,

impl<R, const N: usize> Sync for Series<R, N> where
R: Sync,

impl<R, const N: usize> Unpin for Series<R, N> where
R: Unpin,

impl<R, const N: usize> UnwindSafe for Series<R, N> where
R: 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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> ToOwned for T where
T: Clone,

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)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct rolling_norm::Series

Implementations

impl<R: Real, const N: usize> Series<R, N>

pub fn new() -> Self

pub fn insert(&mut self, new: R)

pub fn mean(&self) -> R

pub fn var(&self) -> R

pub fn stdev(&self) -> R

pub fn curr(&self) -> R

pub fn norm(&self) -> R

pub fn sum(&self) -> R

Trait Implementations

impl<R: Clone + Real, const N: usize> Clone for Series<R, N>

fn clone(&self) -> Series<R, N>

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

impl<R: Debug + Real, const N: usize> Debug for Series<R, N>

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

impl<R: Real, const N: usize> Default for Series<R, N>

fn default() -> Self

impl<R: Real, const N: usize> From<[R; N]> for Series<R, N>

fn from(buf: [R; N]) -> Self

impl<R: Real, const N: usize> Index<usize> for Series<R, N>

type Output = R

fn index(&self, index: usize) -> &Self::Output

impl<R: Copy + Real, const N: usize> Copy for Series<R, N>

Auto Trait Implementations

impl<R, const N: usize> RefUnwindSafe for Series<R, N> where R: RefUnwindSafe,

impl<R, const N: usize> Send for Series<R, N> where R: Send,

impl<R, const N: usize> Sync for Series<R, N> where R: Sync,

impl<R, const N: usize> Unpin for Series<R, N> where R: Unpin,

impl<R, const N: usize> UnwindSafe for Series<R, N> where R: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<R, const N: usize> RefUnwindSafe for Series<R, N> where
R: RefUnwindSafe,

impl<R, const N: usize> Send for Series<R, N> where
R: Send,

impl<R, const N: usize> Sync for Series<R, N> where
R: Sync,

impl<R, const N: usize> Unpin for Series<R, N> where
R: Unpin,

impl<R, const N: usize> UnwindSafe for Series<R, N> where
R: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

impl<T> ToOwned for T where
T: Clone,

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

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