Struct ThreeOutside 

pub struct ThreeOutside { /* private fields */ }

Three Outside Up / Down — a confirmed Engulfing: the first two bars form an Engulfing pattern and the third bar confirms direction.

Three Outside Up (+1.0):

1. Bar 1 is a red candle.
2. Bar 2 is a green candle that engulfs Bar 1’s body.
3. Bar 3 is a green candle with close > b2.close.

Three Outside Down (−1.0): the mirror — green, bearish engulfing, followed by a red bar closing below Bar 2’s close.

Pattern-shape check only — no trend filter is applied; combine with a trend indicator for actionable signals.

Signed ±1 encoding

This detector already 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 of the pattern occupy a single dimension.

Example

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

let mut indicator = ThreeOutside::new();
indicator.update(Candle::new(11.0, 11.2, 9.8, 10.0, 1.0, 0).unwrap());
indicator.update(Candle::new(9.5, 12.0, 9.5, 11.5, 1.0, 1).unwrap());
let out = indicator
    .update(Candle::new(11.5, 13.0, 11.4, 12.5, 1.0, 2).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl ThreeOutside

pub const fn new() -> Self

Construct a new Three Outside Up / Down detector.

Trait Implementations

impl Clone for ThreeOutside

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThreeOutside

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

Formats the value using the given formatter.

impl Default for ThreeOutside

fn default() -> Self

Returns the “default value” for a type.

impl Indicator for ThreeOutside

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 there is no value for this input.

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.

fn batch_nan_into(&mut self, inputs: &[Self::Input], out: &mut [f64])

where Self::Input: Copy, Self::Output: Into<f64>,

Run the indicator over inputs, writing one output per input into the caller-owned out buffer (NaN where update returns None). It exists for every indicator whose output converts to an f64; the batch pipelines use it for the scalar f64 -> f64 ones.

fn batch_fast_into(&mut self, inputs: &[Self::Input], out: &mut [f64])

where Self::Input: Copy, Self::Output: Into<f64>,

Opt-in fast batch: like batch_nan_into, but an indicator with a vectorised kernel may reassociate its arithmetic to run it in SIMD lanes. Each value then agrees with the exact batch to within the tolerance the indicator documents (a few units in the last place), not bit for bit; warmup positions, NaN placement and the output length are identical. The kernels are deterministic: the same input produces the same bits on every platform, with or without SIMD hardware.