Struct Atr 

pub struct Atr<const N: usize> { /* private fields */ }

Average True Range over a Wilder period N.

Seeds with the mean of the first N true ranges, then applies Wilder smoothing avg.mul_add(N - 1, tr) / N, identical to wickra_core::Atr. The first value appears after N candles. Input is a Candle; only high, low and the previous close are read.

Example

use wickra_embed_core::{Atr, Candle, Indicator};

let mut atr = Atr::<5>::new();
let mut last = None;
for i in 0..40 {
    let base = 100.0 + f64::from(i);
    let c = Candle::new(base, base + 2.0, base - 2.0, base + 1.0, 10.0, i64::from(i));
    last = atr.update(c);
}
assert!(last.is_some());

Implementations

impl<const N: usize> Atr<N>

pub fn new() -> Self

Construct a new ATR over a Wilder period of N.

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

Current value if seeded.

Trait Implementations

impl<const N: usize> Clone for Atr<N>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Atr<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for Atr<N>

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Indicator for Atr<N>

type Input = Candle

Type of one input data point (f64 for a price, Candle for an OHLC bar).

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

Feed one new data point in and return the freshly computed value, or None while 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.

fn is_ready(&self) -> bool

Whether the indicator has produced at least one value since construction or the last reset.

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

Stable, human-readable indicator name.