Struct TickIndex 

pub struct TickIndex { /* private fields */ }

TICK Index — the instantaneous net of advancing minus declining issues across a universe, advancers - decliners.

Unlike the cumulative AdvanceDecline line, the TICK is not accumulated: each tick reports the breadth of that snapshot alone. It oscillates around zero — strongly positive readings mean a broad surge of upticks (often an intraday overbought extreme), strongly negative readings a broad flush. Traders fade extremes and watch the zero line for intraday bias.

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

Example

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

let mut tick = TickIndex::new();
// 2 advancers, 5 decliners -> net -3.
let snapshot = 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!(tick.update(snapshot), Some(-3.0));

Implementations

impl TickIndex

pub const fn new() -> Self

Construct a new TICK Index indicator.

Trait Implementations

impl Clone for TickIndex

fn clone(&self) -> TickIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TickIndex

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

Formats the value using the given formatter.

impl Default for TickIndex

fn default() -> TickIndex

Returns the “default value” for a type.

impl Indicator for TickIndex

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.