Struct yata::indicators::Aroon

pub struct Aroon {
    pub period: PeriodType,
    pub signal_zone: ValueType,
    pub over_zone_period: PeriodType,
}

Aroon indicator

Links

• https://www.fidelity.com/learning-center/trading-investing/technical-analysis/technical-indicator-guide/aroon-indicator

2 values

• AroonUp

Range in [0.0; 1.0]

• AroonDown

Range in [0.0; 1.0]

3 signals

• When AroonUp crosses AroonDown upwards, gives full positive #0 signal. When AroonDown crosses AroonUp upwards, gives full negative #0 signal. Otherwise gives no #0 signal.
• When AroonUp rises up to 1.0, gives full positive #1 signal. When AroonDown rises up to 1.0, gives full negative #1 signal.
• Gives positive #2 signal when AroonUp stays above (1.0-signal_zone) and AroonDown stays under signal_zone. Gives negative #2 signal when AroonDown stays above (1.0-signal_zone) and AroonUp stays under signal_zone.

Fields

period: PeriodType

main period length. Default is 14.

Range in [2; PeriodType::MAX)

signal_zone: ValueType

zone value determines when signal #2 appears. Default is 0.3.

Range in [0.0; 1.0]

over_zone_period: PeriodType

period until signal #2 appears in full strength. Default is 7.

Range in [1; PeriodType::MAX)

Trait Implementations

impl Clone for Aroon

fn clone(&self) -> Aroon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Aroon

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

Formats the value using the given formatter.

impl Default for Aroon

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Aroon

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

Deserialize this value from the given Serde deserializer.

impl IndicatorConfig for Aroon

type Instance = AroonInstance

Type of State

const NAME: &'static str

Name of an indicator

fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error>

Initializes the State based on current Configuration

fn validate(&self) -> bool

Validates if Configuration is OK

fn set(&mut self, name: &str, value: String) -> Result<(), Error>

Dynamically sets Configuration parameters

fn size(&self) -> (u8, u8)

Returns an IndicatorResult size processing by the indicator (count of raw values, count of signals)

fn name(&self) -> &'static str

Returns a name of the indicator

fn init_fn<'a, T: OHLCV>(
    self,
    initial_value: &'a T
) -> Result<Box<dyn FnMut(&'a T) -> IndicatorResult>, Error> where
    Self: 'static, 

Creates an IndicatorInstance function from this IndicatorConfig.

fn over<T, S>(self, inputs: S) -> Result<Vec<IndicatorResult>, Error> where
    T: OHLCV,
    S: AsRef<[T]>,
    Self: Sized, 

Evaluates indicator config over sequence of OHLC and returns sequence of IndicatorResults

impl Serialize for Aroon

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

Serialize this value into the given Serde serializer.

impl Copy for Aroon