Struct AtrBands 

pub struct AtrBands { /* private fields */ }

ATR Bands: a close-anchored envelope of width multiplier · ATR.

upper = close + multiplier · ATR(period)
lower = close − multiplier · ATR(period)

Unlike Keltner or StarcBands, the centerline is the raw close rather than a smoothed average — the band rides the price tick-for-tick. This is the standard volatility-targeting envelope traders use to set initial stop-loss and profit targets: an entry at the close sets a multiplier · ATR stop and the symmetric target without ever needing to wait for a moving average to warm up.

Example

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

let mut indicator = AtrBands::new(14, 3.0).unwrap();
let mut last = None;
for i in 0..30 {
    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 AtrBands

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

Errors

Returns Error::PeriodZero / Error::NonPositiveMultiplier on invalid inputs.

pub const fn period(&self) -> usize

Configured ATR period.

pub const fn multiplier(&self) -> f64

Configured ATR multiplier.

Trait Implementations

impl Clone for AtrBands

fn clone(&self) -> AtrBands

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AtrBands

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

Formats the value using the given formatter.

impl Indicator for AtrBands

type Input = Candle

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

type Output = AtrBandsOutput

Type of one output value.

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

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.