Struct yata::core::IndicatorResult

pub struct IndicatorResult { /* fields omitted */ }

Every Indicator proceed an input of OHLCV and returns an IndicatorResult which consist of some returned raw values and some calculated signals.

Indicator may return up to 4 signals and 4 raw values at each step

Implementations

impl IndicatorResult

pub const SIZE: usize

Size of pre-allocated result array For the most of cases it should not be used anywhere outside this crate

#[must_use]pub fn signals(&self) -> &[Action]

Returns a slice of signals of current indicator result

#[must_use]pub fn values(&self) -> &[ValueType]

Returns a slice of raw indicator values of current indicator result

#[must_use]pub const fn signals_length(&self) -> u8

Returns count of signals

#[must_use]pub const fn values_length(&self) -> u8

Returns count of raw values

#[must_use]pub const fn size(&self) -> (u8, u8)

Returns a tuple of count of raw values and count of signals

#[must_use]pub fn value(&self, index: usize) -> ValueType

Returns a raw value at given index

#[must_use]pub fn signal(&self, index: usize) -> Action

Returns a signal at given index

#[must_use]pub fn new(values_slice: &[ValueType], signals_slice: &[Action]) -> Self

Creates a new instance of IndicatorResult with provided values and signals

Trait Implementations

impl Clone for IndicatorResult

pub fn clone(&self) -> IndicatorResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for IndicatorResult

impl Debug for IndicatorResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndicatorResult

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

Deserialize this value from the given Serde deserializer.

impl Serialize for IndicatorResult

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

Serialize this value into the given Serde serializer.