Struct HighLowRange 

pub struct HighLowRange { /* private fields */ }

High-Low Range — the bar’s high-low range expressed as a fraction of its close price.

HighLowRange = (high − low) / close

A scale-free, single-bar volatility proxy: the absolute range high − low grows with the nominal price level, so dividing by the close makes a 2$ range on a 100$ instrument (0.02) directly comparable to a 200$ range on a 10000$ one (0.02). It is the per-bar cousin of average-true-range style measures without the smoothing — useful as an instant intrabar volatility read or a normaliser for other features. The output is ≥ 0 for positive prices. A zero close carries no scale and yields 0.

This is a stateless per-bar transform: every candle produces one value.

Example

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

let mut indicator = HighLowRange::new();
// range 104 - 98 = 6, close 100 -> 0.06.
let c = Candle::new(99.0, 104.0, 98.0, 100.0, 10.0, 0).unwrap();
assert!((indicator.update(c).unwrap() - 0.06).abs() < 1e-12);

Implementations

impl HighLowRange

pub const fn new() -> Self

Construct a new High-Low Range transform.

Trait Implementations

impl Clone for HighLowRange

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HighLowRange

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

Formats the value using the given formatter.

impl Default for HighLowRange

fn default() -> Self

Returns the “default value” for a type.

impl Indicator for HighLowRange

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 there is no value for this input.

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.

fn batch_nan_into(&mut self, inputs: &[Self::Input], out: &mut [f64])

where Self::Input: Copy, Self::Output: Into<f64>,

Run the indicator over inputs, writing one output per input into the caller-owned out buffer (NaN where update returns None). It exists for every indicator whose output converts to an f64; the batch pipelines use it for the scalar f64 -> f64 ones.

fn batch_fast_into(&mut self, inputs: &[Self::Input], out: &mut [f64])

where Self::Input: Copy, Self::Output: Into<f64>,

Opt-in fast batch: like batch_nan_into, but an indicator with a vectorised kernel may reassociate its arithmetic to run it in SIMD lanes. Each value then agrees with the exact batch to within the tolerance the indicator documents (a few units in the last place), not bit for bit; warmup positions, NaN placement and the output length are identical. The kernels are deterministic: the same input produces the same bits on every platform, with or without SIMD hardware.