Struct Rvi 

pub struct Rvi { /* private fields */ }

Relative Vigor Index — Donald Dorsey’s ratio of intra-bar drive (close − open) to intra-bar range (high − low), averaged over a period-bar window.

The reading is SMA(close − open, period) / SMA(high − low, period). A positive value means the average bar in the window closed above where it opened (bullish “vigor”); a negative value means the average closed below. The denominator’s rolling-window SMA can fall to zero on a perfectly flat stretch, in which case the recurrence is undefined and the indicator holds its previous value.

Example

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

let mut rvi = Rvi::new(10).unwrap();
let mut last = None;
for i in 0..40 {
    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 = rvi.update(candle);
}
assert!(last.is_some());

Implementations

impl Rvi

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

Errors

Returns Error::PeriodZero if period == 0.

pub const fn period(&self) -> usize

Configured period.

pub const fn value(&self) -> Option<f64>

Current value if available.

Trait Implementations

impl Clone for Rvi

fn clone(&self) -> Rvi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rvi

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

Formats the value using the given formatter.

impl Indicator for Rvi

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.