Struct DisparityIndex 

pub struct DisparityIndex { /* private fields */ }

Disparity Index — the percentage gap between price and its moving average.

Disparity = 100 * (price - SMA(price, period)) / SMA(price, period)

Originating in Japanese technical analysis (kairi), the disparity index expresses how far price has stretched from its period-bar simple moving average, as a percentage of that average. Positive readings mean price is above the mean (potentially overbought / strong), negative readings mean it is below (potentially oversold / weak); the magnitude measures how over-extended the move is.

The first output lands once the inner SMA is ready (input period). If the moving average is exactly zero the gap percentage is undefined and the index returns 0.0.

Example

use wickra_core::{DisparityIndex, Indicator};

let mut indicator = DisparityIndex::new(14).unwrap();
let mut last = None;
for i in 0..80 {
    last = indicator.update(100.0 + f64::from(i));
}
assert!(last.is_some());

Implementations

impl DisparityIndex

pub fn new(period: usize) -> Result<Self>

Construct a disparity index over period inputs.

Errors

Returns crate::Error::PeriodZero if period == 0.

pub const fn period(&self) -> usize

Configured period.

Trait Implementations

impl Clone for DisparityIndex

fn clone(&self) -> DisparityIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisparityIndex

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

Formats the value using the given formatter.

impl Indicator for DisparityIndex

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, input: 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.