Struct ValueArea 

pub struct ValueArea { /* private fields */ }

Rolling Value Area indicator over the last period candles.

Example

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

let mut va = ValueArea::new(5, 50, 0.70).unwrap();
for i in 0..10 {
    let base = 100.0 + f64::from(i);
    let candle =
        Candle::new(base, base + 2.0, base - 2.0, base, 10.0, i64::from(i)).unwrap();
    va.update(candle);
}
assert!(va.is_ready());

Implementations

impl ValueArea

pub fn new(period: usize, bin_count: usize, value_area_pct: f64) -> Result<Self>

Construct a Value Area indicator.

Errors

Returns Error::PeriodZero if period or bin_count is zero, and Error::InvalidPeriod if value_area_pct is not in (0, 1].

pub fn classic() -> Self

Classic Value Area: 20-bar rolling window, 50 bins, 70% concentration.

pub const fn params(&self) -> (usize, usize, f64)

Configured (period, bin_count, value_area_pct).

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

Most recent output if available.

Trait Implementations

impl Clone for ValueArea

fn clone(&self) -> ValueArea

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValueArea

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

Formats the value using the given formatter.

impl Indicator for ValueArea

type Input = Candle

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

type Output = ValueAreaOutput

Type of one output value.

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

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.