Struct HighWave 

pub struct HighWave { /* private fields */ }

High-Wave — a single-bar extreme-indecision signal. A small body with very long shadows on both sides: price swung far up and far down yet finished near the open, a sign that trend conviction has evaporated.

range = high − low
long upper = high − max(open, close) >= 0.4 * range
long lower = min(open, close) − low  >= 0.4 * range

The two long-shadow conditions force the body below 0.2 * range, so no separate body test is needed. Output is +1.0 when the high-wave prints and 0.0 otherwise — a non-directional indecision flag, it never emits −1.0. Shadow thresholds follow the geometric house style 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 detected, 0.0 no pattern — so it drops straight into a machine-learning feature matrix as a single dimension.

Example

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

let mut indicator = HighWave::new();
// Small body, long shadows both sides.
let candle = Candle::new(10.0, 12.0, 8.0, 10.3, 1.0, 0).unwrap();
assert_eq!(indicator.update(candle), Some(1.0));

Implementations

impl HighWave

pub const fn new() -> Self

Construct a new High-Wave detector.

Trait Implementations

impl Clone for HighWave

fn clone(&self) -> HighWave

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HighWave

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

Formats the value using the given formatter.

impl Default for HighWave

fn default() -> HighWave

Returns the “default value” for a type.

impl Indicator for HighWave

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.