Skip to main content

Ema

Struct Ema 

pub struct Ema { /* private fields */ }
Expand description

Exponential Moving Average over a stream of prices.

The first period samples accumulate like an SMA to produce the seed value. From sample period + 1 onward the standard EMA recurrence is used: ema = price * k + prev_ema * (1 - k) where k = 2 / (period + 1).

§Example

use sdk::indicators::Ema;

let mut ema = Ema::new(3).unwrap();
ema.push("100.0".parse().unwrap());
ema.push("200.0".parse().unwrap());
assert!(!ema.is_ready());

ema.push("300.0".parse().unwrap());
assert!(ema.is_ready());
// Seed value equals the SMA of the first 3 samples.
assert_eq!(ema.value().unwrap(), "200.0".parse().unwrap());

Implementations§

§

impl Ema

pub fn new(period: usize) -> Result<Self, InvalidPeriod>

Create a new EMA with the given window size.

Returns Err(InvalidPeriod) if period is zero.

pub fn push(&mut self, price: Price)

Push a new price sample.

Uses checked arithmetic during warmup so that extreme Decimal values do not panic — the sample is silently dropped on overflow.

pub fn is_ready(&self) -> bool

Returns true once at least period samples have been pushed.

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

Returns the current EMA value, or None if not yet ready.

pub fn count(&self) -> usize

Number of samples received so far.

pub fn period(&self) -> usize

The configured period.

Trait Implementations§

§

impl Clone for Ema

§

fn clone(&self) -> Ema

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
§

impl Debug for Ema

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Ema

§

impl RefUnwindSafe for Ema

§

impl Send for Ema

§

impl Sync for Ema

§

impl Unpin for Ema

§

impl UnsafeUnpin for Ema

§

impl UnwindSafe for Ema

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

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
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
§

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

Performs the conversion.
§

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

§

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

The type returned in the event of a conversion error.
§

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

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