Struct StochRsi 

pub struct StochRsi { /* private fields */ }

Stochastic RSI — the Stochastic Oscillator formula applied to the RSI series instead of to price.

RSI itself rarely reaches its [0, 100] extremes, so it spends most of its life bunched in the middle of the range. StochRSI re-scales it: it reports where the current RSI sits within its own high/low range over the last stoch_period bars, which makes overbought/oversold turns far easier to see.

StochRSI = 100 · (RSI − min(RSI, stoch_period)) / (max(RSI, …) − min(RSI, …))

The output is bounded in [0, 100]. A flat RSI window (zero range) is reported as the neutral 50.0, matching the Stochastic convention.

Example

use wickra_core::{Indicator, StochRsi};

let mut indicator = StochRsi::new(14, 14).unwrap();
let mut last = None;
for i in 0..80 {
    last = indicator.update(100.0 + (f64::from(i) * 0.5).sin() * 10.0);
}
assert!(last.is_some());

Implementations

impl StochRsi

pub fn new(rsi_period: usize, stoch_period: usize) -> Result<Self>

Construct a new StochRSI with the RSI period and the stochastic lookback.

Errors

Returns Error::PeriodZero if either period is 0.

pub const fn periods(&self) -> (usize, usize)

The (rsi_period, stoch_period) pair.

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

Current value if available.

Trait Implementations

impl Clone for StochRsi

fn clone(&self) -> StochRsi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StochRsi

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

Formats the value using the given formatter.

impl Indicator for StochRsi

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.