Struct Natr 

pub struct Natr { /* private fields */ }

Normalized Average True Range — Atr expressed as a percentage of price.

Atr reports volatility in raw price units, which makes its readings impossible to compare across instruments at different price levels. NATR fixes that by dividing by the current close:

NATR = 100 · ATR / close

A NATR of 2.0 always means “the average true range is 2 % of price”, whether the instrument trades at $10 or $10 000 — so NATR values are directly comparable, and stop distances or position sizes expressed as a NATR multiple behave consistently across a portfolio.

Example

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

let mut indicator = Natr::new(14).unwrap();
let mut last = None;
for i in 0..80 {
    let base = 100.0 + f64::from(i);
    let candle =
        Candle::new(base, base + 2.0, base - 2.0, base, 10.0, i64::from(i)).unwrap();
    last = indicator.update(candle);
}
assert!(last.is_some());

Implementations

impl Natr

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

Construct a new NATR with the given ATR 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 Natr

fn clone(&self) -> Natr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Natr

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

Formats the value using the given formatter.

impl Indicator for Natr

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.