Struct Breakaway 

pub struct Breakaway { /* private fields */ }

Breakaway — a 5-bar reversal that fades an exhausted run. A trend gaps away on the second bar, drifts two more bars in the same direction, then the fifth bar snaps the other way and closes back inside the body gap left between the first and second bars, signalling the move has broken away from the crowd and is turning.

bullish (+1.0)  — appears in a decline:
  bar1 black (close < open)
  bar2 black & its body gaps DOWN below bar1's body  (bar2.open < bar1.close)
  bar3 extends lower            (high & low below bar2)
  bar4 black & extends lower    (high & low below bar3)
  bar5 green & closes inside the bar1/bar2 body gap   (bar2.open < close < bar1.close)

bearish (−1.0) — the mirror in an advance:
  bar1 white (close > open)
  bar2 white & its body gaps UP above bar1's body    (bar2.open > bar1.close)
  bar3 extends higher           (high & low above bar2)
  bar4 white & extends higher   (high & low above bar3)
  bar5 red & closes inside the bar1/bar2 body gap     (bar1.close < close < bar2.open)

The middle bar (bar3) may be either colour — only its high/low must extend the run. Output is +1.0 bullish, −1.0 bearish, 0.0 otherwise. The first four bars always return 0.0 because the five-bar window is not yet filled. Pattern-shape check only — no trend filter is applied; combine with a trend indicator for actionable signals. Recognition uses TA-Lib’s CDLBREAKAWAY body-gap and high/low ordering rules directly; it does not add TA-Lib’s rolling body-length average, matching the geometric house style of the other multi-bar patterns in this family.

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::{Breakaway, Candle, Indicator};

let mut indicator = Breakaway::new();
indicator.update(Candle::new(20.0, 20.2, 14.8, 15.0, 1.0, 0).unwrap());
indicator.update(Candle::new(14.0, 14.1, 11.9, 12.0, 1.0, 1).unwrap());
indicator.update(Candle::new(12.5, 13.0, 10.5, 11.0, 1.0, 2).unwrap());
indicator.update(Candle::new(11.0, 11.5, 9.0, 9.5, 1.0, 3).unwrap());
let out = indicator
    .update(Candle::new(9.5, 14.7, 9.4, 14.5, 1.0, 4).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl Breakaway

pub const fn new() -> Self

Construct a new Breakaway detector.

Trait Implementations

impl Clone for Breakaway

fn clone(&self) -> Breakaway

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Breakaway

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

Formats the value using the given formatter.

impl Default for Breakaway

fn default() -> Breakaway

Returns the “default value” for a type.

impl Indicator for Breakaway

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.