Struct yata::methods::HighestLowestDelta

pub struct HighestLowestDelta { /* fields omitted */ }

Calculates absolute difference between highest and lowest values over the last length values 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

Output value is always >= 0.0

Examples

use yata::prelude::*;
use yata::methods::HighestLowestDelta;


let values = [1.0, 2.0, 3.0, 2.0, 1.0, 0.5, 2.0, 3.0];
let r      = [0.0, 1.0, 2.0, 1.0, 2.0, 1.5, 1.5, 2.5];
let mut hld = HighestLowestDelta::new(3, values[0]).unwrap();

(0..values.len()).for_each(|i| {
	let v = hld.next(values[i]);
	assert_eq!(v, r[i]);
});

Perfomance

O(length)

This method is relatively very slow compare to the other methods.

See also

Highest, Lowest, HighestIndex, LowestIndex

Trait Implementations

impl Clone for HighestLowestDelta

fn clone(&self) -> HighestLowestDelta

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HighestLowestDelta

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HighestLowestDelta

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

Deserialize this value from the given Serde deserializer.

impl Method for HighestLowestDelta

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> where
    Self: Sized, 

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

fn next(&mut self, value: ValueType) -> ValueType

Generates next output value based on the given input value

fn name(&self) -> &str

Returns a name of the method

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

Returns memory size of the method (size, align)

fn iter_data<I>(&mut self, input: I) -> MethodOverIterator<'_, Self, I> where
    I: Iterator<Item = Self::Input>,
    Self: Sized, 

Creates an iterator which produces values by the Method over given input data Iterator

fn over<I>(&mut self, sequence: I) -> Sequence<Self::Output> where
    I: Iterator<Item = Self::Input>,
    Self: Sized, 

Iterates the Method over the given Iterator and returns timeserie of output values

impl Serialize for HighestLowestDelta

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

Serialize this value into the given Serde serializer.