Struct Inertia 

pub struct Inertia { /* private fields */ }

Donald Dorsey’s Inertia — a Linear-Regression-smoothed RVI (Relative Vigor Index). The endpoint of an n-bar least-squares fit of the RVI series is taken as the indicator’s reading, smoothing the underlying ratio while preserving its trend direction.

Inertia_t = LinearRegression(RVI(close - open, high - low; rvi_period), linreg_period)_t

Dorsey’s recommended defaults are (rvi_period = 14, linreg_period = 20).

Example

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

let mut inertia = Inertia::new(14, 20).unwrap();
let mut last = None;
for i in 0..80 {
    let o = 100.0 + f64::from(i);
    let c = o + 0.5;
    let candle = Candle::new(o, c + 0.2, o - 0.2, c, 1.0, i64::from(i)).unwrap();
    last = inertia.update(candle);
}
assert!(last.is_some());

Implementations

impl Inertia

pub fn new(rvi_period: usize, linreg_period: usize) -> Result<Self>

Errors

Returns Error::PeriodZero if either period is zero.

pub fn classic() -> Self

Dorsey’s recommended defaults (rvi_period = 14, linreg_period = 20).

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

Configured (rvi_period, linreg_period).

Trait Implementations

impl Clone for Inertia

fn clone(&self) -> Inertia

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Inertia

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

Formats the value using the given formatter.

impl Indicator for Inertia

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.