Struct DecyclerOscillator 

pub struct DecyclerOscillator { /* private fields */ }

Difference between a fast and a slow Decycler, producing a smoothed oscillator that crosses zero at trend changes.

Defined as fast_decycler - slow_decycler with fast_period < slow_period. The construct removes the trend component that both decyclers share, leaving the medium-frequency cycle band — analogous in spirit to MACD but with Ehlers’ zero-lag high-pass filters instead of EMAs.

Example

use wickra_core::{Indicator, DecyclerOscillator};

let mut dco = DecyclerOscillator::new(10, 30).unwrap();
let mut last = None;
for i in 0..60 {
    last = dco.update(100.0 + (f64::from(i) * 0.3).sin() * 5.0);
}
assert!(last.is_some());

Implementations

impl DecyclerOscillator

pub fn new(fast: usize, slow: usize) -> Result<DecyclerOscillator, Error>

Construct with the fast and slow periods.

Errors

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

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

Configured (fast, slow) periods.

pub const fn value(&self) -> Option<f64>

Current value if available.

Trait Implementations

impl Clone for DecyclerOscillator

fn clone(&self) -> DecyclerOscillator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecyclerOscillator

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

Formats the value using the given formatter.

impl Indicator for DecyclerOscillator

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.