Struct HurstChannel 

pub struct HurstChannel { /* private fields */ }

Hurst Channel: an SMA centerline wrapped by a rolling high-low range.

middle = SMA(close, period)
range  = max(high, period) − min(low, period)
upper  = middle + multiplier · range
lower  = middle − multiplier · range

The Hurst Channel sizes its envelope by the realised high-low range of the window — a simpler, range-based volatility proxy than Bollinger’s rolling stddev or Keltner’s ATR. With a multiplier of 0.5 the channel reduces to a centerline that hugs the midpoint of the Donchian envelope; chart vendors that follow Hurst’s cycle work commonly use period = 10 and multiplier = 0.5 for the “inner” channel.

Example

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

let mut indicator = HurstChannel::new(10, 0.5).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 HurstChannel

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 period.

pub const fn multiplier(&self) -> f64

Configured range multiplier.

Trait Implementations

impl Clone for HurstChannel

fn clone(&self) -> HurstChannel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HurstChannel

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

Formats the value using the given formatter.

impl Indicator for HurstChannel

type Input = Candle

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

type Output = HurstChannelOutput

Type of one output value.

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

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.