Struct Hikkake 

pub struct Hikkake { /* private fields */ }

Hikkake — a 3-bar trap. An inside bar (bar2 fully contained by bar1) sets up a breakout that immediately fails on bar3, trapping breakout traders and pointing the opposite way.

inside bar : bar2.high < bar1.high  &&  bar2.low > bar1.low
bullish (+1.0): bar3 makes a LOWER high AND LOWER low than bar2
                (a false downside break -> expect a move up)
bearish (−1.0): bar3 makes a HIGHER high AND HIGHER low than bar2
                (a false upside break -> expect a move down)

Output is +1.0 (bullish setup), −1.0 (bearish setup), or 0.0 otherwise. The detector fires when the three-bar setup completes on bar3; it does not separately flag the optional later confirmation bar. The first two bars always return 0.0 because the 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 where the bullish and bearish setups occupy a single dimension.

Example

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

let mut indicator = Hikkake::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, 7.0, 1.0, 2).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl Hikkake

pub const fn new() -> Self

Construct a new Hikkake detector.

Trait Implementations

impl Clone for Hikkake

fn clone(&self) -> Hikkake

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hikkake

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

Formats the value using the given formatter.

impl Default for Hikkake

fn default() -> Hikkake

Returns the “default value” for a type.

impl Indicator for Hikkake

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.