pub struct Momentum { /* private fields */ }
Expand description
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
Trait Implementations§
source§impl<'de> Deserialize<'de> for Momentum
impl<'de> Deserialize<'de> for Momentum
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl Method for Momentum
impl Method for Momentum
source§fn new(length: Self::Params, value: &Self::Input) -> Result<Self, Error>
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)source§fn next(&mut self, value: &Self::Input) -> Self::Output
fn next(&mut self, value: &Self::Input) -> Self::Output
Generates next output value based on the given input
value
source§fn with_history(
parameters: Self::Params,
initial_value: &Self::Input
) -> Result<WithHistory<Self, Self::Output>, Error>
fn with_history( parameters: Self::Params, initial_value: &Self::Input ) -> Result<WithHistory<Self, Self::Output>, Error>
Creates an instance of the method with given
parameters
and initial value
, wrapped by historical data holdersource§fn with_last_value(
parameters: Self::Params,
initial_value: &Self::Input
) -> Result<WithLastValue<Self, Self::Output>, Error>
fn with_last_value( parameters: Self::Params, initial_value: &Self::Input ) -> Result<WithLastValue<Self, Self::Output>, Error>
Creates an instance of the method with given
parameters
and initial value
, wrapped by last produced value holdersource§fn memsize(&self) -> (usize, usize)where
Self: Sized,
fn memsize(&self) -> (usize, usize)where
Self: Sized,
👎Deprecated
Returns memory size of the method
(size, align)
source§fn new_over<S>(
parameters: Self::Params,
inputs: S
) -> Result<Vec<Self::Output>, Error>
fn new_over<S>( parameters: Self::Params, inputs: S ) -> Result<Vec<Self::Output>, Error>
Creates new
Method
instance and iterates it over the given inputs
slice and returns Vec
of output values. Read moresource§fn new_apply<T, S>(
parameters: Self::Params,
sequence: &mut S
) -> Result<(), Error>
fn new_apply<T, S>( parameters: Self::Params, sequence: &mut S ) -> Result<(), Error>
Creates new
Method
instance and applies it to the sequence
.Auto Trait Implementations§
impl RefUnwindSafe for Momentum
impl Send for Momentum
impl Sync for Momentum
impl Unpin for Momentum
impl UnwindSafe for Momentum
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more