Struct UpsideGapThreeMethods 

pub struct UpsideGapThreeMethods { /* private fields */ }

Upside Gap Three Methods — a 3-bar bullish continuation. Two white candles advance with an upside body gap between them, then a black candle opens inside the second body and closes inside the first body, partially filling the gap without erasing the prior advance.

bar1 white, bar2 white
upside body gap: open2 > close1   (bar2's body sits entirely above bar1's)
bar3 black, opens within bar2's body and closes within bar1's body

Output is +1.0 when the pattern completes and 0.0 otherwise. Upside Gap Three Methods is a single-direction (bullish-only) continuation, so it never emits −1.0; its bearish mirror is crate::DownsideGapThreeMethods. The first two bars always return 0.0 because the three-bar window is not yet filled. 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, UpsideGapThreeMethods};

let mut indicator = UpsideGapThreeMethods::new();
indicator.update(Candle::new(10.0, 11.2, 9.8, 11.0, 1.0, 0).unwrap());
indicator.update(Candle::new(12.0, 13.2, 11.9, 13.0, 1.0, 1).unwrap());
let out = indicator
    .update(Candle::new(12.5, 12.6, 10.4, 10.5, 1.0, 2).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl UpsideGapThreeMethods

pub const fn new() -> Self

Construct a new Upside Gap Three Methods detector.

Trait Implementations

impl Clone for UpsideGapThreeMethods

fn clone(&self) -> UpsideGapThreeMethods

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpsideGapThreeMethods

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

Formats the value using the given formatter.

impl Default for UpsideGapThreeMethods

fn default() -> UpsideGapThreeMethods

Returns the “default value” for a type.

impl Indicator for UpsideGapThreeMethods

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.