Struct yata::methods::SMA

pub struct SMA { /* fields omitted */ }

Simple Moving Average of specified length for timeseries of type ValueType

Parameters

Has a single parameter length: PeriodType

length should be > 0

Input type

Input type is ValueType

Output type

Output type is ValueType

Examples

use yata::prelude::*;
use yata::methods::SMA;

// SMA of length=3
let mut sma = SMA::new(3, 1.0).unwrap();

sma.next(1.0);
sma.next(2.0);

assert_eq!(sma.next(3.0), 2.0);
assert_eq!(sma.next(4.0), 3.0);

Performance

O(1)

Implementations

impl SMA

#[must_use]pub const fn get_window(&self) -> &Window<ValueType>

Returns inner Window. Useful for implementing in other methods and indicators.

#[must_use]pub const fn get_divider(&self) -> ValueType

Returns 1/length. Useful for implementing in other methods and indicators.

#[must_use]pub const fn get_last_value(&self) -> ValueType

Returns last result value. Useful for implementing in other methods and indicators.

Trait Implementations

impl Clone for SMA

pub fn clone(&self) -> SMA

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SMA

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SMA

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Method<'_> for SMA

type Params = PeriodType

Method parameters

type Input = ValueType

Input value type

type Output = Self::Input

Output value type

pub fn new(length: Self::Params, value: Self::Input) -> Result<Self, Error>

Static method for creating an instance of the method with given parameters and initial value (simply first input value)

pub fn next(&mut self, value: Self::Input) -> Self::Output

Generates next output value based on the given input value

pub fn name(&self) -> &str

Returns a name of the method

pub fn memsize(&self) -> (usize, usize) where
    Self: Sized, 

Returns memory size of the method (size, align)

pub fn over<S>(&'a mut self, inputs: S) -> Vec<Self::Output> where
    S: Sequence<Self::Input>,
    Self: Sized, 

Iterates the Method over the given inputs slice and returns Vec of output values.

pub fn apply<'b: 'a, T, S>(&'a mut self, sequence: &'b mut S) where
    S: Sequence<T> + AsMut<[T]>,
    Self: Method<'a, Input = T, Output = T> + Sized,
    T: Copy, 

Applies method to the sequence in-place.

pub fn new_over<S>(
    parameters: Self::Params,
    inputs: S
) -> Result<Vec<Self::Output>, Error> where
    S: Sequence<Self::Input>,
    Self::Input: Clone,
    Self: Sized + 'a, 

Creates new Method instance and iterates it over the given inputs slice and returns Vec of output values.

pub fn new_apply<T, S>(
    parameters: Self::Params,
    sequence: &'a mut S
) -> Result<(), Error> where
    T: Copy,
    S: Sequence<T> + AsMut<[T]>,
    Self: Method<'a, Input = T, Output = T> + Sized + 'a, 

Creates new Method instance and applies it to the sequence.

pub fn into_fn(self) -> Box<dyn FnMut(Self::Input) -> Self::Output> where
    Self: Sized + 'static, 

Creates a function from the Method instance

pub fn new_fn(
    params: Self::Params,
    initial_value: Self::Input
) -> Result<Box<dyn FnMut(Self::Input) -> Self::Output>, Error> where
    Self: Sized + 'static, 

Creates new function based on the method

impl Serialize for SMA

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.