Struct WavePm 

pub struct WavePm { /* private fields */ }

Wave PM (Peak Momentum): a 0..100 statistic that rises when the current length-bar momentum is large relative to its own recent energy — Cynthia Kase’s gauge of how “peaked” the move is.

m       = close_t - close_{t-length}                  (length-bar momentum)
energy  = EMA(m^2, length)                            (mean squared momentum)
raw     = 1 - exp( -m^2 / (2 * energy) )      (0 if energy == 0)
WavePM  = 100 * EMA(raw, smoothing)

The momentum m is normalised by its recent variance (energy): a move that merely matches its typical energy sits at the baseline 100·(1 − e^{−1/2}) ≈ 39.35, while a momentum spike that exceeds recent energy drives the reading toward 100. A flat market (m = 0) reads 0. High readings mark a peaking, possibly exhausted move rather than a fresh one.

Kase’s published WavePM is platform-specific; this is Wickra’s faithful reconstruction of its variance-normalised peak-momentum form. The exact constants differ from any single vendor implementation, but the shape — flat at zero, a fixed baseline on a steady trend, and saturation on an acceleration — matches the indicator’s intent.

Reference: Cynthia Kase, Trading with the Odds, 1996 (Wickra reconstruction).

Example

use wickra_core::{Indicator, WavePm};

let mut indicator = WavePm::new(10, 3).unwrap();
let mut last = None;
for i in 0..60 {
    last = indicator.update(100.0 + f64::from(i));
}
assert!(last.is_some());

Implementations

impl WavePm

pub fn new(length: usize, smoothing: usize) -> Result<Self>

Construct a Wave PM with the momentum length and the output smoothing period.

Errors

Returns Error::PeriodZero if length == 0 or smoothing == 0.

pub const fn periods(&self) -> (usize, usize)

Configured (length, smoothing).

Trait Implementations

impl Clone for WavePm

fn clone(&self) -> WavePm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WavePm

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

Formats the value using the given formatter.

impl Indicator for WavePm

type Input = f64

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, close: f64) -> 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.