Struct Kicking 

pub struct Kicking { /* private fields */ }

Kicking — a 2-bar reversal of two opposite-coloured marubozu separated by a gap. A shadowless candle is “kicked” the other way by a shadowless candle of the opposite colour that gaps clear of it — a violent change of control. It is trend-agnostic: the gap direction alone defines the signal.

marubozu = |close − open| >= 0.95 * (high − low)   (no meaningful shadows)
bullish (+1.0): black marubozu, then a white marubozu gapping UP   (low2 > high1)
bearish (−1.0): white marubozu, then a black marubozu gapping DOWN (high2 < low1)

Output is +1.0 (bullish) or −1.0 (bearish) when the pattern completes and 0.0 otherwise. The first bar always returns 0.0 because the two-bar window is not yet filled. The marubozu threshold follows the geometric house style rather than TA-Lib’s rolling averages. 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 two directions occupy a single dimension.

Example

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

let mut indicator = Kicking::new();
indicator.update(Candle::new(12.0, 12.0, 10.0, 10.0, 1.0, 0).unwrap());
let out = indicator
    .update(Candle::new(14.0, 16.0, 14.0, 16.0, 1.0, 1).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl Kicking

pub const fn new() -> Self

Construct a new Kicking detector.

Trait Implementations

impl Clone for Kicking

fn clone(&self) -> Kicking

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Kicking

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

Formats the value using the given formatter.

impl Default for Kicking

fn default() -> Kicking

Returns the “default value” for a type.

impl Indicator for Kicking

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.