Struct MacdHistogram 

pub struct MacdHistogram { /* private fields */ }

MACD Histogram — the macd − signal bar of MacdIndicator as a standalone scalar indicator.

macd      = EMA(fast) − EMA(slow)
signal    = EMA(macd, signal)
histogram = macd − signal

The histogram is the most actively traded part of MACD: it crosses zero exactly when the MACD line crosses its signal, and its slope measures whether that momentum is accelerating or fading. This wrapper exposes just that series for pipelines that want a plain f64 stream rather than the full MacdOutput; for the line and signal alongside it, use MacdIndicator directly.

Standard parameters are fast = 12, slow = 26, signal = 9, so the first value lands after slow + signal − 1 inputs — exactly when MacdIndicator emits its first full output.

Example

use wickra_core::{Indicator, MacdHistogram};

let mut indicator = MacdHistogram::new(12, 26, 9).unwrap();
let mut last = None;
for i in 0..80 {
    last = indicator.update(100.0 + f64::from(i));
}
assert!(last.is_some());

Implementations

impl MacdHistogram

pub fn new(fast: usize, slow: usize, signal: usize) -> Result<Self>

Construct a MACD histogram with the given periods.

Errors

Returns [Error::PeriodZero] if any period is zero, and [Error::InvalidPeriod] if fast >= slow.

pub fn classic() -> Self

Default (12, 26, 9) configuration, matching every classical chart package.

pub const fn periods(&self) -> (usize, usize, usize)

Configured periods as (fast, slow, signal).

Trait Implementations

impl Clone for MacdHistogram

fn clone(&self) -> MacdHistogram

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MacdHistogram

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

Formats the value using the given formatter.

impl Indicator for MacdHistogram

type Input = f64

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, input: f64) -> 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.