Struct AdaptiveCycle 

pub struct AdaptiveCycle { /* private fields */ }

Ehlers’ Adaptive Cycle Indicator.

Returns half the current dominant cycle period — the “best” lookback for downstream oscillators like an adaptive RSI or adaptive Stochastic, per Ehlers’ Cycle Analytics for Traders (2013, ch. 11). Halving accounts for the fact that an oscillator over a half-cycle captures the full peak-to- trough swing without aliasing.

The output is rounded to an integer-valued f64 and clamped to [3, 25], matching the typical operating range of period-adaptive oscillators.

Example

use wickra_core::{Indicator, AdaptiveCycle};

let mut ac = AdaptiveCycle::new();
let mut last = None;
for i in 0..200 {
    last = ac.update(100.0 + (f64::from(i) * 0.4).sin() * 5.0);
}
assert!(last.is_some());

Implementations

impl AdaptiveCycle

pub fn new() -> Self

Construct a new adaptive cycle estimator.

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

Current adaptive period if available.

Trait Implementations

impl Clone for AdaptiveCycle

fn clone(&self) -> AdaptiveCycle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdaptiveCycle

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

Formats the value using the given formatter.

impl Default for AdaptiveCycle

fn default() -> AdaptiveCycle

Returns the “default value” for a type.

impl Indicator for AdaptiveCycle

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.