Struct BeltHold 

pub struct BeltHold { /* private fields */ }

Belt-hold — a single-bar reversal: a long candle that opens at one extreme of its range (an “opening marubozu”) and runs the other way.

range        = high − low
bullish (+1.0): green, opens at the low  (open − low <= tol * range) & long body
bearish (−1.0): red,   opens at the high (high − open <= tol * range) & long body
long body    = |close − open| >= 0.5 * range

Output is 0.0 when the opening side carries a shadow, the body is short, or the range is degenerate. shadow_tolerance defaults to 0.05 (5 % of the bar range allowed on the opening side) and must lie in [0, 1). Pattern-shape check only — no trend filter is applied; combine with a trend indicator for actionable signals.

Signed ±1 encoding

This detector emits the uniform candlestick sign convention shared across the pattern family — +1.0 bullish, −1.0 bearish, 0.0 no pattern — so it drops straight into a machine-learning feature matrix where the bullish and bearish variants occupy a single dimension.

Example

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

let mut indicator = BeltHold::new();
// Bullish belt-hold: opens at the low, closes near the high.
let candle = Candle::new(10.0, 12.0, 10.0, 11.5, 1.0, 0).unwrap();
assert_eq!(indicator.update(candle), Some(1.0));

Implementations

impl BeltHold

pub const fn new() -> Self

Construct a Belt-hold detector with the default 5 % opening-shadow tolerance.

pub fn with_tolerance(shadow_tolerance: f64) -> Result<Self>

Construct a Belt-hold detector with a custom opening-shadow tolerance.

shadow_tolerance must lie in [0, 1).

pub fn shadow_tolerance(&self) -> f64

Configured opening-shadow tolerance.

Trait Implementations

impl Clone for BeltHold

fn clone(&self) -> BeltHold

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BeltHold

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

Formats the value using the given formatter.

impl Default for BeltHold

fn default() -> Self

Returns the “default value” for a type.

impl Indicator for BeltHold

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.