Struct AbsoluteBreadthIndex 

pub struct AbsoluteBreadthIndex { /* private fields */ }

Absolute Breadth Index (ABI) — the absolute value of net advancing issues, |advancers - decliners|.

The ABI ignores the direction of breadth and measures only its magnitude: a high reading means the universe moved decisively one way or the other (high internal activity / volatility), while a low reading means advances and declines were nearly balanced (a quiet, directionless market). It is sometimes called a “market thermometer” because elevated readings often cluster around turning points.

Input = CrossSection, Output = f64, warmup_period == 1.

Example

use wickra_core::{AbsoluteBreadthIndex, CrossSection, Indicator, Member};

let mut abi = AbsoluteBreadthIndex::new();
// 2 advancers, 5 decliners -> |2 - 5| = 3.
let tick = CrossSection::new(
    vec![
        Member::new(1.0, 10.0, false, false),
        Member::new(1.0, 10.0, false, false),
        Member::new(-1.0, 10.0, false, false),
        Member::new(-1.0, 10.0, false, false),
        Member::new(-1.0, 10.0, false, false),
        Member::new(-1.0, 10.0, false, false),
        Member::new(-1.0, 10.0, false, false),
    ],
    0,
)
.unwrap();
assert_eq!(abi.update(tick), Some(3.0));

Implementations

impl AbsoluteBreadthIndex

pub const fn new() -> Self

Construct a new Absolute Breadth Index indicator.

Trait Implementations

impl Clone for AbsoluteBreadthIndex

fn clone(&self) -> AbsoluteBreadthIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AbsoluteBreadthIndex

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

Formats the value using the given formatter.

impl Default for AbsoluteBreadthIndex

fn default() -> AbsoluteBreadthIndex

Returns the “default value” for a type.

impl Indicator for AbsoluteBreadthIndex

type Input = CrossSection

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, section: CrossSection) -> 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.