Struct HtTrendMode 

pub struct HtTrendMode { /* private fields */ }

Ehlers’ Hilbert Transform Trend Mode (HT_TRENDMODE).

Runs the same adaptive Hilbert-transform engine as HilbertDominantCycle, derives the dominant cycle phase, its sine / lead-sine, and an instantaneous trendline, then classifies the market into trend mode (1) or cycle mode (0):

• it is a cycle shortly after the sine and lead-sine cross, while the phase advances at roughly the dominant-cycle rate;
• it is a trend otherwise, and is forced to trend whenever price separates from the trendline by more than 1.5%.

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

Example

use wickra_core::{Indicator, HtTrendMode};

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

Implementations

impl HtTrendMode

pub fn new() -> Self

Construct a new Hilbert transform trend-mode classifier.

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

Current trend-mode flag (1.0 trend, 0.0 cycle) if available.

Trait Implementations

impl Clone for HtTrendMode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HtTrendMode

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

Formats the value using the given formatter.

impl Default for HtTrendMode

fn default() -> Self

Returns the “default value” for a type.

impl Indicator for HtTrendMode

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 there is no value for this input.

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.

fn batch_nan_into(&mut self, inputs: &[Self::Input], out: &mut [f64])

where Self::Input: Copy, Self::Output: Into<f64>,

Run the indicator over inputs, writing one output per input into the caller-owned out buffer (NaN where update returns None). It exists for every indicator whose output converts to an f64; the batch pipelines use it for the scalar f64 -> f64 ones.

fn batch_fast_into(&mut self, inputs: &[Self::Input], out: &mut [f64])

where Self::Input: Copy, Self::Output: Into<f64>,

Opt-in fast batch: like batch_nan_into, but an indicator with a vectorised kernel may reassociate its arithmetic to run it in SIMD lanes. Each value then agrees with the exact batch to within the tolerance the indicator documents (a few units in the last place), not bit for bit; warmup positions, NaN placement and the output length are identical. The kernels are deterministic: the same input produces the same bits on every platform, with or without SIMD hardware.