Struct StickSandwich 

pub struct StickSandwich { /* private fields */ }

Stick Sandwich — a 3-bar bullish reversal. A black candle is followed by a white candle that trades entirely above the first close, then a second black candle drives price back down to close at the same level as the first. The matching closes “sandwich” the white candle and mark a support floor.

bar1 black, bar2 white, bar3 black
bar2 trades above bar1's close: low2 > close1
matching closes: |close3 − close1| <= 0.1 * (high1 − low1)

Output is +1.0 when the pattern completes and 0.0 otherwise. Stick Sandwich is a single-direction (bullish-only) reversal, so it never emits −1.0. The first two bars always return 0.0 because the three-bar window is not yet filled. The matching-close tolerance follows the geometric house style (a fixed fraction of the first bar’s range) 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, 0.0 no pattern — so it drops straight into a machine-learning feature matrix as a single dimension.

Example

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

let mut indicator = StickSandwich::new();
indicator.update(Candle::new(12.0, 12.1, 9.9, 10.0, 1.0, 0).unwrap());
indicator.update(Candle::new(10.5, 11.6, 10.4, 11.5, 1.0, 1).unwrap());
let out = indicator
    .update(Candle::new(11.5, 11.6, 9.9, 10.0, 1.0, 2).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl StickSandwich

pub const fn new() -> Self

Construct a new Stick Sandwich detector.

Trait Implementations

impl Clone for StickSandwich

fn clone(&self) -> StickSandwich

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StickSandwich

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

Formats the value using the given formatter.

impl Default for StickSandwich

fn default() -> StickSandwich

Returns the “default value” for a type.

impl Indicator for StickSandwich

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.