Struct SpinningTop 

pub struct SpinningTop { /* private fields */ }

Spinning Top — a single-bar indecision candle with a small body and two long shadows.

body         = |close − open|
upper_shadow = high − max(open, close)
lower_shadow = min(open, close) − low
range        = high − low
spinning     = body <= body_threshold * range
              && upper_shadow >= 2 * body
              && lower_shadow >= 2 * body
              && body > 0

While direction is ambiguous by intent, the output is direction-signed so downstream filters can distinguish a green spinning top (+1.0) from a red one (−1.0). A clean Doji (body == 0) is not a Spinning Top.

body_threshold defaults to 0.3 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, SpinningTop};

let mut indicator = SpinningTop::new();
// Body 0.5, both shadows 3.0 -> spinning.
let candle = Candle::new(10.0, 13.5, 7.0, 10.5, 1.0, 0).unwrap();
assert_eq!(indicator.update(candle), Some(1.0));

Implementations

impl SpinningTop

pub const fn new() -> Self

Construct a Spinning Top detector with the default body threshold.

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

Construct a Spinning Top detector with a custom body / range threshold.

pub fn body_threshold(&self) -> f64

Configured body / range threshold.

Trait Implementations

impl Clone for SpinningTop

fn clone(&self) -> SpinningTop

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpinningTop

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

Formats the value using the given formatter.

impl Default for SpinningTop

fn default() -> Self

Returns the “default value” for a type.

impl Indicator for SpinningTop

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.