Struct ReversalSignal

pub struct ReversalSignal { /* private fields */ }

Searches for reversal 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::ReversalSignal;

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

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

assert_eq!(r2, r);

Performance

O(left+right)

See also

UpperReversalSignal, LowerReversalSignal

Implementations

impl ReversalSignal

pub fn new( left: PeriodType, right: PeriodType, value: &ValueType, ) -> Result<Self, Error>

Constructs new instanceof ReversalSignal It’s just an alias for Method::new((left, right), value) but without parentheses of Input tuple

Trait Implementations

impl Clone for ReversalSignal

fn clone(&self) -> ReversalSignal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReversalSignal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReversalSignal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Method for ReversalSignal

type Params = (u8, u8)

Method parameters

type Input = f64

Input value type

type Output = Action

Output value type

fn new(params: 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: &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 ReversalSignal

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

where __S: Serializer,

Serialize this value into the given Serde serializer.