Struct VolumeProfile 

pub struct VolumeProfile { /* private fields */ }

Rolling Volume Profile over the last period candles.

Where crate::ValueArea reduces the same volume distribution to its summary levels (Point of Control, Value Area High / Low), Volume Profile exposes the full histogram so callers can inspect, render or post-process the raw distribution. Each candle’s volume is spread uniformly across the bins its [low, high] range touches; a single-print bar (low == high) drops its whole volume into one bin. The histogram domain spans the window’s lowest low to its highest high.

A window whose bars are all single-print at one price (price_high == price_low) is degenerate: the entire volume lands in bin 0 and both edges collapse to that price.

Example

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

let mut vp = VolumeProfile::new(5, 10).unwrap();
let mut last = None;
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();
    last = vp.update(candle);
}
let profile = last.unwrap();
assert_eq!(profile.bins.len(), 10);

Implementations

impl VolumeProfile

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

Construct a Volume Profile indicator.

Errors

Returns Error::PeriodZero if period or bin_count is zero.

pub fn classic() -> Self

Classic Volume Profile: 20-bar rolling window, 50 bins.

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

Configured (period, bin_count).

pub fn value(&self) -> Option<&VolumeProfileOutput>

Most recent profile if available.

Trait Implementations

impl Clone for VolumeProfile

fn clone(&self) -> VolumeProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VolumeProfile

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

Formats the value using the given formatter.

impl Indicator for VolumeProfile

type Input = Candle

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

type Output = VolumeProfileOutput

Type of one output value.

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

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.