Struct Marubozu 

pub struct Marubozu { /* private fields */ }

Marubozu — a single-bar strong-continuation candle with body equal to range and (almost) no shadows.

range        = high − low
upper_shadow = high − max(open, close)
lower_shadow = min(open, close) − low
shadows OK   = upper_shadow <= tol * range && lower_shadow <= tol * range

When the shadow tolerance is satisfied the output is +1.0 for a bullish Marubozu (close > open) and −1.0 for a bearish one (close < open). Any candle whose shadows exceed the tolerance — or whose body is zero — yields 0.0.

shadow_tolerance defaults to 0.05 (5 % of the bar range allowed on each side) and must lie in [0, 1).

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, Marubozu};

let mut indicator = Marubozu::new();
// Bullish marubozu: open == low, close == high.
let candle = Candle::new(10.0, 12.0, 10.0, 12.0, 1.0, 0).unwrap();
assert_eq!(indicator.update(candle), Some(1.0));

Implementations

impl Marubozu

pub const fn new() -> Self

Construct a Marubozu detector with the default 5 % shadow tolerance.

pub fn with_tolerance(shadow_tolerance: f64) -> Result<Self>

Construct a Marubozu detector with a custom shadow tolerance.

shadow_tolerance must lie in [0, 1).

pub fn shadow_tolerance(&self) -> f64

Configured shadow tolerance.

Trait Implementations

impl Clone for Marubozu

fn clone(&self) -> Marubozu

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Marubozu

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

Formats the value using the given formatter.

impl Default for Marubozu

fn default() -> Self

Returns the “default value” for a type.

impl Indicator for Marubozu

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.