Struct ProfileShape 

pub struct ProfileShape { /* private fields */ }

Profile Shape — classifies a rolling volume profile by where its point of control (POC) sits within the range: b, P, or D (normal).

build a `bins`-bucket volume profile over the last `period` candles
poc_idx = bin with the most volume
+1  P-shape : POC in the upper third  (heavy top, thin tail down) — short-covering / accumulation
−1  b-shape : POC in the lower third  (heavy bottom, thin tail up) — long-liquidation / distribution
 0  D/normal: POC in the middle third (balanced bell)

Market Profile readers classify the day’s shape by the location of the heaviest trading. A P-shape (control high, a thin tail beneath) typically marks short-covering or the start of accumulation; a b-shape (control low, thin tail above) marks long liquidation or distribution; a D-shape is a balanced, two-sided day. Reducing the profile to this three-way code gives a compact, streaming read of market posture.

The output is +1 / 0 / −1. The first value lands after period candles; each update rebuilds the profile in O(period · bins).

Example

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

let mut indicator = ProfileShape::new(20, 24).unwrap();
let mut last = None;
for i in 0..40 {
    let base = 100.0 + (f64::from(i) * 0.3).sin() * 5.0;
    let c = Candle::new(base, base + 1.0, base - 1.0, base, 1_000.0, 0).unwrap();
    last = indicator.update(c);
}
assert!(last.is_some());

Implementations

impl ProfileShape

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

Construct a Profile Shape classifier.

Errors

Returns Error::PeriodZero if period is zero, or Error::InvalidPeriod if bins < 3 (the three-way split needs three zones).

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

Configured (period, bins).

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

Current value if available.

Trait Implementations

impl Clone for ProfileShape

fn clone(&self) -> ProfileShape

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProfileShape

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

Formats the value using the given formatter.

impl Indicator for ProfileShape

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.