Struct SineWave 

pub struct SineWave { /* private fields */ }

Ehlers’ Sine Wave indicator (sine + leadsine), TA-Lib HT_SINE.

Implementation from Rocket Science for Traders (Ehlers 2001, ch. 9). The phase is the dominant-cycle phase of HtDcPhase: the smoothed price is correlated with one cycle of a sine and a cosine of the measured dominant period, DCPhase = atan(Real / Imag), then corrected (+90°, the smoother’s lag, the quadrant). The indicator returns

Sine     = sin(DCPhase)
LeadSine = sin(DCPhase + 45°)

The two lines cross deep in trends but oscillate rapidly during cycles, providing a visual lead/lag signal.

Only the primary sine line is exposed as the scalar output to match the crate’s standard scalar-indicator surface; the lead is accessible via the SineWave::lead accessor after each update.

Example

use wickra_core::{Indicator, SineWave};

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

Implementations

impl SineWave

pub fn new() -> Self

Construct a new Sine Wave indicator.

pub const fn lead(&self) -> f64

Most recent lead (45°-ahead) value. 0.0 until the indicator is ready.

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

Current sine value if available.

Trait Implementations

impl Clone for SineWave

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 SineWave

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

Formats the value using the given formatter.

impl Default for SineWave

fn default() -> Self

Returns the “default value” for a type.

impl Indicator for SineWave

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.