Struct CandleVolume 

pub struct CandleVolume { /* private fields */ }

CandleVolume — the candlestick analogue of Equivolume: each bar’s body (close − open) paired with a width proportional to its volume relative to the recent average.

body  = close − open                          (signed; + bullish, − bearish)
width = volume / SMA(volume, period)          (1.0 = average volume)

Where Equivolume uses the high-low range for the box height, CandleVolume uses the candlestick body, preserving direction: a wide bullish body (long up candle on heavy volume) is strong demand, a wide bearish body strong supply, and a narrow body on heavy volume (wide but short) is churn. The signed body plus the normalised width capture both the move’s direction and the participation behind it.

The first value lands after period inputs (to seed the volume average). Each update is O(1).

Example

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

let mut indicator = CandleVolume::new(14).unwrap();
let mut last = None;
for i in 0..40 {
    let base = 100.0 + f64::from(i);
    let c = Candle::new(base, base + 1.0, base - 1.0, base + 0.5, 1_000.0 + f64::from(i), 0).unwrap();
    last = indicator.update(c);
}
assert!(last.is_some());

Implementations

impl CandleVolume

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

Construct a CandleVolume with the given volume-averaging period.

Errors

Returns Error::PeriodZero if period == 0.

pub const fn period(&self) -> usize

Configured volume-averaging period.

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

Current value if available.

Trait Implementations

impl Clone for CandleVolume

fn clone(&self) -> CandleVolume

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CandleVolume

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

Formats the value using the given formatter.

impl Indicator for CandleVolume

type Input = Candle

Type of one input data point (typically f64 for a price, or Candle / Tick).

type Output = CandleVolumeOutput

Type of one output value.

fn update(&mut self, candle: Candle) -> Option<CandleVolumeOutput>

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.