Struct yata::methods::Momentum

pub struct Momentum { /* private fields */ }

Momentum calculates difference between current value and n-th value back, where n = length

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::Momentum;

let mut change = Momentum::new(3, &1.0).unwrap(); // a.k.a. Change => let mut change = Change::new(3);
change.next(&1.0);
change.next(&2.0);
assert_eq!(change.next(&3.0), 2.0);
assert_eq!(change.next(&4.0), 3.0);
assert_eq!(change.next(&2.0), 0.0);

At length=1 Momentum is the same as Derivative with length=1

use yata::prelude::*;
use yata::methods::Momentum;
use yata::methods::Derivative;

let mut change = Momentum::new(1, &1.0).unwrap();
let mut derivative = Derivative::new(1, &1.0).unwrap();
change.next(&1.0); derivative.next(&1.0);
change.next(&2.0); derivative.next(&2.0);
assert_eq!(change.next(&3.0), derivative.next(&3.0));
assert_eq!(change.next(&4.0), derivative.next(&4.0));
assert_eq!(change.next(&2.0), derivative.next(&2.0));

Performance

O(1)

See Also

Rate of Change, Derivative

Trait Implementations

impl Clone for Momentum

fn clone(&self) -> Momentum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Momentum

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Momentum

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

Deserialize this value from the given Serde deserializer.

impl Method for Momentum

type Params = PeriodType

Method parameters

type Input = ValueType

Input value type

type Output = Self::Input

Output value type

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)

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

Generates next output value based on the given input value

fn with_history(
    parameters: Self::Params,
    initial_value: &Self::Input
) -> Result<WithHistory<Self, Self::Output>, Error> where
    Self: Sized,
    Self::Output: Debug + Clone, 

Creates an instance of the method with given parameters and initial value, wrapped by historical data holder

fn with_last_value(
    parameters: Self::Params,
    initial_value: &Self::Input
) -> Result<WithLastValue<Self, Self::Output>, Error> where
    Self: Sized,
    Self::Output: Debug + Clone, 

Creates an instance of the method with given parameters and initial value, wrapped by last produced value holder

fn name(&self) -> &str

Returns a name of the method

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

👎 Deprecated

Returns memory size of the method (size, align)

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

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

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

Applies method to the sequence in-place.

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

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

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

Creates new Method instance and applies it to the sequence.

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

Creates a function from the Method instance

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

Creates new function based on the method

impl Serialize for Momentum

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

Serialize this value into the given Serde serializer.