Struct TsfOscillator 

pub struct TsfOscillator { /* private fields */ }

Time Series Forecast Oscillator — the percentage gap between the close and the one-bar-ahead time-series forecast of the close.

TSFOsc_t = 100 · (close_t − TSF(close, period)_t) / close_t

where Tsf projects the rolling least-squares line one bar past the window (a + b·period). It is the close-relative companion to Cfo, which measures the same percentage gap against the regression value at the current bar (a + b·(period − 1)). Because TSF advances one bar further than LinearRegression, the two differ by exactly the slope term 100·b/close: on a trending series TSFOsc reads more negative in an uptrend (the forecast has already stepped above price) and more positive in a downtrend.

Positive readings mean the close sits above its forward forecast (price has overshot the projected trend); negative readings mean it sits below. Wraps the existing Tsf so the warmup matches.

Example

use wickra_core::{Indicator, TsfOscillator};

let mut indicator = TsfOscillator::new(14).unwrap();
let mut last = None;
for i in 0..40 {
    last = indicator.update(100.0 + f64::from(i));
}
assert!(last.is_some());

Implementations

impl TsfOscillator

pub fn new(period: usize) -> Result<Self>

Construct a new TSF oscillator over period inputs.

Errors

Returns Error::InvalidPeriod if period < 2 — a regression line is undefined for fewer than two points.

pub const fn period(&self) -> usize

Configured period.

Trait Implementations

impl Clone for TsfOscillator

fn clone(&self) -> TsfOscillator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TsfOscillator

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

Formats the value using the given formatter.

impl Indicator for TsfOscillator

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.