Struct HtDcPhase 

pub struct HtDcPhase { /* private fields */ }

Ehlers’ Hilbert Transform Dominant Cycle Phase (HT_DCPHASE).

Runs the same adaptive Hilbert-transform engine as HilbertDominantCycle to recover the dominant cycle period, then measures the phase angle of that cycle (in degrees) by correlating the smoothed price over one dominant-cycle window against a unit phasor. The phase advances roughly linearly through a clean cycle and stalls in a trend, which is the basis of Ehlers’ trend-versus-cycle detection.

From Rocket Science for Traders (Ehlers 2001), aligned with TA-Lib’s HT_DCPHASE. The first value is emitted after ~50 inputs, once the engine’s moving-average chain has filled.

Example

use wickra_core::{Indicator, HtDcPhase};

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

Implementations

impl HtDcPhase

pub fn new() -> Self

Construct a new Hilbert transform dominant-cycle phase estimator.

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

Current dominant-cycle phase (degrees) if available.

Trait Implementations

impl Clone for HtDcPhase

fn clone(&self) -> HtDcPhase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HtDcPhase

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

Formats the value using the given formatter.

impl Default for HtDcPhase

fn default() -> HtDcPhase

Returns the “default value” for a type.

impl Indicator for HtDcPhase

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.