Struct AroonOscillator 

pub struct AroonOscillator { /* private fields */ }

Aroon Oscillator — the single-line difference AroonUp − AroonDown.

The Aroon indicator reports two [0, 100] lines; the Aroon Oscillator collapses them into one value in [−100, 100]:

AroonOscillator = AroonUp − AroonDown

Strongly positive means the most recent high is much fresher than the most recent low (an up-trend); strongly negative is the mirror image. Readings near zero mean neither extreme is recent — a range.

Example

use wickra_core::{Candle, Indicator, AroonOscillator};

let mut indicator = AroonOscillator::new(5).unwrap();
let mut last = None;
for i in 0..80 {
    let base = 100.0 + i as f64;
    let candle =
        Candle::new(base, base + 2.0, base - 2.0, base + 1.0, 10.0, i64::from(i)).unwrap();
    last = indicator.update(candle);
}
assert_eq!(last, Some(100.0)); // pure uptrend

Implementations

impl AroonOscillator

pub fn new(period: usize) -> Result<Self>

Construct a new Aroon Oscillator with the given period.

Errors

Returns crate::Error::PeriodZero if period == 0.

pub const fn period(&self) -> usize

Configured period.

pub const fn value(&self) -> Option<f64>

Current value if available.

Trait Implementations

impl Clone for AroonOscillator

fn clone(&self) -> AroonOscillator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AroonOscillator

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

Formats the value using the given formatter.

impl Indicator for AroonOscillator

type Input = Candle

Type of one input data point (typically f64 for a price, or Candle / Tick).

type Output = f64

Type of one output value.

fn update(&mut self, candle: Candle) -> Option<f64>

Feed one new data point into the indicator and return the freshly computed output, or None if the indicator is still warming up.

fn reset(&mut self)

Reset all internal state, leaving the indicator equivalent to a freshly constructed instance with the same parameters.

fn warmup_period(&self) -> usize

Number of inputs required before the first non-None output can be produced.

fn is_ready(&self) -> bool

Whether the indicator has emitted at least one value since the last reset.

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

Stable, human-readable indicator name. Used by chaining and diagnostics.