Struct Engulfing 

pub struct Engulfing { /* private fields */ }

Engulfing — a 2-bar reversal pattern. The current candle’s body fully engulfs the prior candle’s body and points in the opposite direction.

prev_body  = |prev.close − prev.open|
curr_body  = |curr.close − curr.open|
bullish    = prev red & curr green
            & curr.open <= prev.close & curr.close >= prev.open
            & curr_body > prev_body
bearish    = prev green & curr red
            & curr.open >= prev.close & curr.close <= prev.open
            & curr_body > prev_body

Output is +1.0 for a bullish engulfing, −1.0 for a bearish one, and 0.0 otherwise. The first bar always returns 0.0 because no previous body exists to engulf. 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, Engulfing, Indicator};

let mut indicator = Engulfing::new();
// Prior red candle followed by a larger green engulfing candle.
indicator.update(Candle::new(11.0, 11.2, 9.8, 10.0, 1.0, 0).unwrap());
let out = indicator
    .update(Candle::new(9.5, 12.0, 9.5, 11.5, 1.0, 1).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl Engulfing

pub const fn new() -> Self

Construct a new Engulfing detector.

Trait Implementations

impl Clone for Engulfing

fn clone(&self) -> Engulfing

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Engulfing

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

Formats the value using the given formatter.

impl Default for Engulfing

fn default() -> Engulfing

Returns the “default value” for a type.

impl Indicator for Engulfing

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.