Struct VolumeOscillator 

pub struct VolumeOscillator { /* private fields */ }

Volume Oscillator — the percent difference between a fast and a slow SMA of the bar volume.

VO_t = 100 · (SMA(volume, fast)_t − SMA(volume, slow)_t) / SMA(volume, slow)_t

A positive reading means short-term volume is running above the longer-term average (rising participation), a negative reading the opposite. The line is unbounded above and below -100, but stays near zero in stable conditions. Classic configuration is fast = 14, slow = 28. The first emission lands after slow candles. A slow average of 0 (only possible if every volume in the slow window was zero) collapses the output to 0 rather than NaN.

Example

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

let mut indicator = VolumeOscillator::new(14, 28).unwrap();
let mut last = None;
for i in 0..80 {
    let base = 100.0 + f64::from(i);
    let candle =
        Candle::new(base, base + 2.0, base - 2.0, base + 1.0, 10.0, i64::from(i)).unwrap();
    last = indicator.update(candle);
}
assert!(last.is_some());

Implementations

impl VolumeOscillator

pub fn new(fast: usize, slow: usize) -> Result<Self>

Construct a Volume Oscillator with the given SMA periods.

Errors

Returns Error::PeriodZero if either period is zero, or Error::InvalidPeriod if fast >= slow.

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

Configured (fast, slow) periods.

Trait Implementations

impl Clone for VolumeOscillator

fn clone(&self) -> VolumeOscillator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VolumeOscillator

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

Formats the value using the given formatter.

impl Indicator for VolumeOscillator

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.