Struct TrueRange 

pub struct TrueRange { /* private fields */ }

True Range — the single-bar building block of every ATR-based indicator.

TR = max( high − low, |high − close_prev|, |low − close_prev| )

True Range is the greatest of the bar’s own range and the two gaps to the previous close, so it captures volatility that opens between bars rather than only within them. The first bar has no previous close and falls back to high − low. Where Atr smooths this series, TrueRange exposes it raw, one value per bar.

Example

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

let mut indicator = TrueRange::new();
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 + 1.0, 10.0, i64::from(i)).unwrap();
    last = indicator.update(candle);
}
assert!(last.is_some());

Implementations

impl TrueRange

pub const fn new() -> Self

Construct a new True Range indicator.

Trait Implementations

impl Clone for TrueRange

fn clone(&self) -> TrueRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrueRange

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

Formats the value using the given formatter.

impl Default for TrueRange

fn default() -> TrueRange

Returns the “default value” for a type.

impl Indicator for TrueRange

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.