Struct InitialBalance 

pub struct InitialBalance { /* private fields */ }

Session Initial Balance (first N bars).

period defaults to 12 — the canonical one-hour IB on 5-minute bars for U.S. equities. Callers MUST invoke Indicator::reset at every new session boundary; otherwise the IB locks after the first period bars and stays fixed for the entire lifetime of the instance.

Example

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

let mut ib = InitialBalance::new(3).unwrap();
let bars = [
    Candle::new(100.0, 102.0, 99.0, 101.0, 10.0, 0).unwrap(),
    Candle::new(101.0, 103.0, 100.0, 102.0, 10.0, 1).unwrap(),
    Candle::new(102.0, 104.0, 101.0, 103.0, 10.0, 2).unwrap(),
    // Locked after period bars — subsequent bars do not modify IB.
    Candle::new(103.0, 120.0, 80.0, 105.0, 10.0, 3).unwrap(),
];
for b in bars {
    ib.update(b);
}
let v = ib.value().unwrap();
assert_eq!(v.high, 104.0);
assert_eq!(v.low, 99.0);

Implementations

impl InitialBalance

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

Construct an Initial Balance indicator with the given window length.

Errors

Returns Error::PeriodZero if period == 0.

pub fn classic() -> Self

Classic 12-bar Initial Balance.

pub const fn period(&self) -> usize

Configured period.

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

Most recent output if at least one bar has been seen.

pub const fn is_locked(&self) -> bool

True once period bars have been ingested and the IB is locked.

Trait Implementations

impl Clone for InitialBalance

fn clone(&self) -> InitialBalance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitialBalance

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

Formats the value using the given formatter.

impl Indicator for InitialBalance

type Input = Candle

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

type Output = InitialBalanceOutput

Type of one output value.

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

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.