Struct Ema

Source
pub struct Ema<F>
where F: Float,
{ /* private fields */ }
Expand description

A struct representing an exponential moving average

The weighting can be chosen for each accumulation. To have the weighting be part of the struct see StableEma

Implementations§

Source§

impl<F> Ema<F>
where F: Float + TryInto<NotNan<F>>,

Source

pub fn try_new( mean: impl TryInto<NotNan<F>, Error = FloatIsNan>, variance: impl TryInto<NotNan<F>, Error = FloatIsNan>, ) -> Result<Self, FloatIsNan>

Tries to create a new Ema struct from raw float values

§Errors

Fails if mean or variance are NaN

Source§

impl<F> Ema<F>
where F: Float,

Source

pub fn new(mean: NotNan<F>, variance: NotNan<F>) -> Self

Returns a new Ema struct with the mean and variance estimates already initialized.

It is recommended to choose these values to be as close to expected as possible so that they can converge quickly

Source

pub fn accumulate(&mut self, value: NotNan<F>, recent_weight: NotNan<F>)

Accumulates a new value into this Ema. The mean and variance are adjusted by the recent_weight

Source

pub fn try_accumulate( &mut self, value: F, recent_weight: F, ) -> Result<(), FloatIsNan>

Tries to accumulate raw flaot values.

§Errors

Fails if value or recent_weight are NaN

Source

pub fn mean(&self) -> NotNan<F>

Returns the mean of this Ema

Source

pub fn variance(&self) -> NotNan<F>

Returns the variance of this Ema

Source

pub fn std_dev(&self) -> NotNan<F>

Returns the standard deviation of this Ema

Source

pub fn mean_duration(&self) -> Duration

Returns the mean of this Ema as a duration in seconds. Useful when using an Ema to time events.

Source

pub fn std_dev_duration(&self) -> Duration

Returns the standard deviation of this Ema as a duration in seconds. Useful when using an Ema to time events

Trait Implementations§

Source§

impl<F> Clone for Ema<F>
where F: Float + Clone,

Source§

fn clone(&self) -> Ema<F>

Returns a duplicate 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<F> Debug for Ema<F>
where F: Float + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<F> Default for Ema<F>
where F: Float,

Source§

fn default() -> Self

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

impl<F> Ord for Ema<F>
where F: Float,

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<F> PartialEq for Ema<F>
where F: Float,

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<F> PartialOrd for Ema<F>
where F: Float,

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<F> Eq for Ema<F>
where F: Float,

Auto Trait Implementations§

§

impl<F> Freeze for Ema<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for Ema<F>
where F: RefUnwindSafe,

§

impl<F> Send for Ema<F>
where F: Send,

§

impl<F> Sync for Ema<F>
where F: Sync,

§

impl<F> Unpin for Ema<F>
where F: Unpin,

§

impl<F> UnwindSafe for Ema<F>
where F: 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<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> 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.