Struct yata::methods::PivotSignal

pub struct PivotSignal { /* fields omitted */ }

Searches for Pivot Points over last left+right+1 values of type ValueType

Parameters

Has a tuple of 2 parameters (left: PeriodType, right: PeriodType)

left should be > 0 and right should be > 0

There is an additional restriction on parameters: left+right+1 should be <= PeriodType::MAX. So if your PeriodType is default u8, then left+right+1 should be <= 255

Read more about PeriodType

Input type

Input type is ValueType

Output type

Output type is Action

use yata::prelude::*;
use yata::methods::PivotSignal;

let s = [1.0, 2.0, 3.0, 2.0, 1.0, 1.0, 2.0];
let r = [ 0,   0,   1,   0,   -1,  0,   1 ];

let mut pivot = PivotSignal::new(2, 2, s[0]);
let r2: Vec<i8> = s.iter().map(|&v| pivot.next(v).analog()).collect();

assert_eq!(r2, r2);

Perfomance

O(left+right)

See also

PivotHighSignal, PivotLowSignal

Implementations

impl PivotSignal

pub fn new(left: PeriodType, right: PeriodType, value: ValueType) -> Self

Constructs new instanceof PivotSignal It's just an alias for Method::new((left, right), value) but without parentheses of Input touple

Trait Implementations

impl Clone for PivotSignal

fn clone(&self) -> PivotSignal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PivotSignal

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

Formats the value using the given formatter.

impl Default for PivotSignal

fn default() -> PivotSignal

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for PivotSignal

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

Deserialize this value from the given Serde deserializer.

impl Method for PivotSignal

type Params = (PeriodType, PeriodType)

Method parameters

type Input = ValueType

Input value type

type Output = Action

Output value type

fn new(params: Self::Params, value: Self::Input) -> Self 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) -> Self::Output

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 Sequence and returns timeserie of output values

impl Serialize for PivotSignal

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

Serialize this value into the given Serde serializer.