Struct KagiBars 

pub struct KagiBars { /* private fields */ }

Kagi bar builder using the fixed reversal-amount method on close prices.

A Kagi chart is one continuous line that extends in its current direction as long as price makes new extremes, and turns when price retraces by at least reversal from the latest extreme. This builder emits the completed segment each time the line turns:

• The first candle seeds the start price; the first subsequent move (of any size) sets the initial direction.
• While the trend holds, new extremes extend the current segment silently.
• A retracement of >= reversal closes the current segment (returned from BarBuilder::update) and starts a new one in the opposite direction.

At most one segment completes per candle, so update returns either an empty vector or a single KagiBar.

Example

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

let flat = |price: f64| Candle::new(price, price, price, price, 1.0, 0).unwrap();
let mut kagi = KagiBars::new(2.0).unwrap();
kagi.update(flat(10.0)); // seed
kagi.update(flat(15.0)); // rise to 15
let bars = kagi.update(flat(12.0)); // retrace >= 2 -> closes the up segment
assert_eq!(bars.len(), 1);
assert_eq!(bars[0].direction, 1);

Implementations

impl KagiBars

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

Construct a Kagi builder with the given reversal amount.

Errors

Returns Error::InvalidPeriod if reversal is not finite and positive.

pub const fn reversal(&self) -> f64

Configured reversal amount.

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

Current extreme price (or the seed price before any move).

Trait Implementations

impl BarBuilder for KagiBars

type Bar = KagiBar

Type of one completed bar.

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

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 KagiBars

fn clone(&self) -> KagiBars

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KagiBars

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

Formats the value using the given formatter.