Struct Doji 

pub struct Doji { /* private fields */ }

Doji — a candle whose body is negligible relative to its range.

A Doji prints whenever the absolute distance between open and close is small compared to the total high − low range. It is the canonical indecision bar and a building block for many three-bar reversal patterns.

body  = |close − open|
range = high − low
doji  = body <= body_threshold * range

Signed ±1 encoding

By default the output is +1.0 when a Doji is detected and 0.0 otherwise — a direction-less detection flag. For a drop-in machine-learning feature where every candlestick pattern shares the same sign convention (+1.0 bullish, −1.0 bearish, 0.0 none), switch the detector into signed mode with Doji::signed. A detected Doji is then classified by where its (negligible) body sits within the bar’s range:

pos = (0.5 * (open + close) − low) / (high − low)
pos > 2/3  ->  +1.0   dragonfly  (long lower shadow, bullish)
pos < 1/3  ->  −1.0   gravestone (long upper shadow, bearish)
else       ->   0.0   long-legged / standard (neutral)

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

Example

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

// Default: direction-less detection flag.
let mut indicator = Doji::default();
let candle = Candle::new(10.0, 11.0, 9.0, 10.0, 1.0, 0).unwrap();
assert_eq!(indicator.update(candle), Some(1.0));

// Signed: a dragonfly Doji (body at the top, long lower shadow) is bullish.
let mut signed = Doji::new().signed();
let dragonfly = Candle::new(10.0, 10.05, 6.0, 10.0, 1.0, 0).unwrap();
assert_eq!(signed.update(dragonfly), Some(1.0));

Implementations

impl Doji

pub const fn new() -> Self

Construct a Doji detector with the default body threshold (0.1).

pub fn with_threshold(body_threshold: f64) -> Result<Self>

Construct a Doji detector with a custom body / range threshold.

body_threshold must lie in (0, 1].

pub fn signed(self) -> Self

Switch to the signed dragonfly / gravestone encoding (consuming builder).

In signed mode a detected Doji emits +1.0 (dragonfly, bullish), −1.0 (gravestone, bearish) or 0.0 (long-legged / neutral) instead of the default direction-less +1.0 detection flag. See the type-level docs for the exact classification rule.

pub fn body_threshold(&self) -> f64

Configured body / range threshold.

pub fn is_signed(&self) -> bool

Whether this detector emits the signed dragonfly / gravestone encoding.

Trait Implementations

impl Clone for Doji

fn clone(&self) -> Doji

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Doji

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

Formats the value using the given formatter.

impl Default for Doji

fn default() -> Self

Returns the “default value” for a type.

impl Indicator for Doji

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.