Struct WickRatio 

pub struct WickRatio { /* private fields */ }

Wick Ratio — the signed imbalance between the upper and lower shadows as a fraction of the bar’s range.

upper_wick  = high − max(open, close)
lower_wick  = min(open, close) − low
WickRatio   = (upper_wick − lower_wick) / (high − low)

The result lives in [−1, +1]: +1 is a bar that is all upper shadow (a long rejection of higher prices, classic shooting-star geometry), −1 all lower shadow (a long rejection of lower prices, hammer geometry), and 0 either a symmetric bar or a wickless one. Where BodySizePct measures how much of the range is body, this measures which side the wicks fall on — the rejection asymmetry many reversal setups depend on. A zero-range bar yields 0.

This is a stateless per-bar transform: every candle produces one value.

Example

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

let mut indicator = WickRatio::new();
// upper 13 - 10.5 = 2.5, lower 10 - 10 = 0, range 3 -> +0.8333.
let c = Candle::new(10.0, 13.0, 10.0, 10.5, 10.0, 0).unwrap();
assert!((indicator.update(c).unwrap() - 2.5 / 3.0).abs() < 1e-12);

Implementations

impl WickRatio

pub const fn new() -> Self

Construct a new Wick Ratio transform.

Trait Implementations

impl Clone for WickRatio

fn clone(&self) -> WickRatio

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WickRatio

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

Formats the value using the given formatter.

impl Default for WickRatio

fn default() -> WickRatio

Returns the “default value” for a type.

impl Indicator for WickRatio

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.