Struct PointAndFigureBars 

pub struct PointAndFigureBars { /* private fields */ }

Point-and-Figure bar builder using the fixed box-size, N-box reversal method.

Price is quantised to a box_size grid (each close maps to the box that contains it). An X column extends upward while price makes new box highs; an O column extends downward while price makes new box lows. A reversal needs price to move reversal boxes against the column, at which point the current column is closed (returned from BarBuilder::update) and a new column starts one box offset from the prior extreme.

• The first candle seeds the grid box and prints no column.
• The first one-box move sets the initial column direction.
• At most one column completes per candle, so update returns an empty vector or a single PnfColumn.

Closes are mapped to their containing box via floor(close / box_size) for both directions, so the construction is fully deterministic.

Example

use wickra_core::{BarBuilder, Candle, PointAndFigureBars};

let flat = |price: f64| Candle::new(price, price, price, price, 1.0, 0).unwrap();
let mut pnf = PointAndFigureBars::new(1.0, 3).unwrap();
pnf.update(flat(10.0)); // seed
pnf.update(flat(15.0)); // X column up to 15
let cols = pnf.update(flat(12.0)); // 3-box reversal closes the X column
assert_eq!(cols.len(), 1);
assert_eq!(cols[0].direction, 1);

Implementations

impl PointAndFigureBars

pub fn new(box_size: f64, reversal: usize) -> Result<Self>

Construct a Point-and-Figure builder with the given box size and reversal (in boxes).

Errors

Returns Error::InvalidPeriod if box_size is not finite and positive, and Error::PeriodZero if reversal is zero.

pub const fn box_size(&self) -> f64

Configured box size.

pub const fn reversal(&self) -> usize

Configured reversal, in boxes.

Trait Implementations

impl BarBuilder for PointAndFigureBars

type Bar = PnfColumn

Type of one completed bar.

fn update(&mut self, candle: Candle) -> Vec<PnfColumn>

Feed one candle and return every bar completed on it (possibly none).

fn reset(&mut self)

Reset all internal state to the freshly-constructed configuration.

fn name(&self) -> &'static str

Stable, human-readable builder name.

fn batch(&mut self, candles: &[Candle]) -> Vec<Self::Bar>

Replay update over a slice, concatenating all completed bars. The result length is data-dependent (not the input length).

impl Clone for PointAndFigureBars

fn clone(&self) -> PointAndFigureBars

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PointAndFigureBars

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

Formats the value using the given formatter.