Struct McClellanSummationIndex 

pub struct McClellanSummationIndex { /* private fields */ }

McClellan Summation Index — the running cumulative sum of the McClellanOscillator.

Where the oscillator measures the momentum of breadth, the summation index integrates it into a longer-term breadth trend: it rises while the oscillator is positive and falls while it is negative, so it behaves like a slow, smoothed advance/decline line. Sustained readings far above or below zero mark strong bull or bear breadth regimes, and crosses of the zero line are read as major trend changes.

The index embeds a McClellanOscillator and adds its value on every tick. Because the oscillator seeds to 0.0 on the first tick, the summation index also starts at 0.0 and is defined from the first update (warmup_period == 1).

Input = CrossSection, Output = f64.

Example

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

let mut msi = McClellanSummationIndex::new();
let tick = CrossSection::new(
    vec![
        Member::new(1.0, 10.0, false, false),
        Member::new(-1.0, 10.0, false, false),
    ],
    0,
)
.unwrap();
// First tick: oscillator seeds to 0, so the summation index is 0.
assert_eq!(msi.update(tick), Some(0.0));

Implementations

impl McClellanSummationIndex

pub fn new() -> Self

Construct a new McClellan Summation Index.

Trait Implementations

impl Clone for McClellanSummationIndex

fn clone(&self) -> McClellanSummationIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for McClellanSummationIndex

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

Formats the value using the given formatter.

impl Default for McClellanSummationIndex

fn default() -> McClellanSummationIndex

Returns the “default value” for a type.

impl Indicator for McClellanSummationIndex

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.