Struct HikkakeModified 

pub struct HikkakeModified { /* private fields */ }

Modified Hikkake — a close-confirmed variant of the Hikkake trap. An inside bar is followed by a bar that breaks out and is immediately rejected: it pierces the inside bar’s range intrabar but closes back inside, a stronger signal than the plain breakout setup.

inside bar : bar2.high < bar1.high  &&  bar2.low > bar1.low
bullish (+1.0): bar3 makes a lower high AND lower low than bar2,
                yet closes back above the inside-bar low   (close3 > bar2.low)
bearish (−1.0): bar3 makes a higher high AND higher low than bar2,
                yet closes back below the inside-bar high  (close3 < bar2.high)

Output is +1.0 (bullish), −1.0 (bearish), or 0.0 otherwise. The extra close-recovery condition is what distinguishes it from the plain Hikkake, which fires on the high/low break alone. The first two bars always return 0.0 because the three-bar window is not yet filled. 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 as a single dimension.

Example

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

let mut indicator = HikkakeModified::new();
indicator.update(Candle::new(10.0, 15.0, 5.0, 12.0, 1.0, 0).unwrap());
indicator.update(Candle::new(11.0, 13.0, 8.0, 12.0, 1.0, 1).unwrap());
let out = indicator
    .update(Candle::new(9.0, 12.0, 6.0, 9.0, 1.0, 2).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl HikkakeModified

pub const fn new() -> Self

Construct a new Modified Hikkake detector.

Trait Implementations

impl Clone for HikkakeModified

fn clone(&self) -> HikkakeModified

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HikkakeModified

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

Formats the value using the given formatter.

impl Default for HikkakeModified

fn default() -> HikkakeModified

Returns the “default value” for a type.

impl Indicator for HikkakeModified

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.