Struct DojiStar 

pub struct DojiStar { /* private fields */ }

Doji Star — a 2-bar reversal warning. A long trending body is followed by a doji whose tiny body gaps away in the direction of the trend, the indecision hinting the move is about to turn.

long body  = |close − open| >= 0.5 * (high − low)        (bar1)
doji       = |close − open| <= 0.1 * (high − low)        (bar2)
bullish (+1.0): bar1 black, doji body gaps DOWN below it  (max(o2,c2) < close1)
bearish (−1.0): bar1 white, doji body gaps UP above it    (min(o2,c2) > close1)

Output is +1.0 (bullish star, after a black bar) or −1.0 (bearish star, after a white bar) when the pattern completes, and 0.0 otherwise. The first bar always returns 0.0 because the two-bar window is not yet filled. Doji thresholds follow the geometric house style (fixed half-range body for the long bar, tenth-range body for the doji) 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 bullish and bearish variants occupy a single dimension.

Example

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

let mut indicator = DojiStar::new();
// Long black bar, then a doji gapping down -> bullish star.
indicator.update(Candle::new(20.0, 20.2, 14.8, 15.0, 1.0, 0).unwrap());
let out = indicator
    .update(Candle::new(13.0, 13.1, 12.9, 13.0, 1.0, 1).unwrap());
assert_eq!(out, Some(1.0));

Implementations

impl DojiStar

pub const fn new() -> Self

Construct a new Doji Star detector.

Trait Implementations

impl Clone for DojiStar

fn clone(&self) -> DojiStar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DojiStar

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

Formats the value using the given formatter.

impl Default for DojiStar

fn default() -> DojiStar

Returns the “default value” for a type.

impl Indicator for DojiStar

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.