Struct GapSideBySideWhite 

pub struct GapSideBySideWhite { /* private fields */ }

Gap Side-by-Side White Lines — a 3-bar continuation. After a gap away from the first bar, two white candles of similar size open at roughly the same level (side by side) and hold the gap open, signalling the trend resumes in the gap direction.

bar2, bar3 both white
bar2 body gaps away from bar1 body            (up or down)
bar3 opens beside bar2                          (|open3 − open2| <= 0.1 · range2)
bar3 body is similar in size to bar2           (neither more than twice the other)
gap up   -> +1.0   (bullish continuation)
gap down -> −1.0   (bearish continuation — "downside" gap side-by-side white)

Output is +1.0 (gap up) or −1.0 (gap down) when the pattern completes and 0.0 otherwise. The first two bars always return 0.0 because the three-bar window is not yet filled. Open-equality and body-similarity thresholds follow 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 gap directions occupy a single dimension.

Example

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

let mut indicator = GapSideBySideWhite::new();
indicator.update(Candle::new(10.0, 11.1, 9.9, 11.0, 1.0, 0).unwrap());
indicator.update(Candle::new(13.0, 14.1, 12.9, 14.0, 1.0, 1).unwrap());
let out = indicator
    .update(Candle::new(13.0, 14.1, 12.9, 14.0, 1.0, 2).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl GapSideBySideWhite

pub const fn new() -> Self

Construct a new Gap Side-by-Side White Lines detector.

Trait Implementations

impl Clone for GapSideBySideWhite

fn clone(&self) -> GapSideBySideWhite

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GapSideBySideWhite

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

Formats the value using the given formatter.

impl Default for GapSideBySideWhite

fn default() -> GapSideBySideWhite

Returns the “default value” for a type.

impl Indicator for GapSideBySideWhite

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.