Struct SuperTrend 

pub struct SuperTrend { /* private fields */ }

SuperTrend — an ATR-banded trailing stop that flips sides on a close through the band.

hl2          = (high + low) / 2
basic_upper  = hl2 + multiplier · ATR
basic_lower  = hl2 − multiplier · ATR

final_upper  = basic_upper  if basic_upper < prev_final_upper or prev_close > prev_final_upper
               else prev_final_upper
final_lower  = basic_lower  if basic_lower > prev_final_lower or prev_close < prev_final_lower
               else prev_final_lower

in a downtrend: stay down while close <= final_upper, else flip up
in an uptrend:  stay up   while close >= final_lower, else flip down
SuperTrend   = final_lower in an uptrend, final_upper in a downtrend

The final bands ratchet — the upper band only moves down (and the lower band only moves up) until price closes through it, which flips the trend and hands the role of trailing stop to the opposite band. The first ATR-ready bar seeds the trend as up. Wilder’s classic configuration is ATR(10) with a 3.0 multiplier.

Example

use wickra_core::{Candle, Indicator, SuperTrend};

let mut indicator = SuperTrend::classic();
let mut last = None;
for i in 0..80 {
    let base = 100.0 + f64::from(i);
    let candle =
        Candle::new(base, base + 2.0, base - 2.0, base + 1.0, 10.0, i64::from(i)).unwrap();
    last = indicator.update(candle);
}
assert!(last.is_some());

Implementations

impl SuperTrend

pub fn new(atr_period: usize, multiplier: f64) -> Result<Self>

Construct a SuperTrend with an explicit ATR period and band multiplier.

Errors

Returns Error::PeriodZero if atr_period == 0 and Error::NonPositiveMultiplier if multiplier is not strictly positive and finite.

pub fn classic() -> Self

Wilder’s classic configuration: ATR(10) with a 3.0 multiplier.

pub const fn params(&self) -> (usize, f64)

Configured (atr_period, multiplier).

Trait Implementations

impl Clone for SuperTrend

fn clone(&self) -> SuperTrend

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SuperTrend

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

Formats the value using the given formatter.

impl Indicator for SuperTrend

type Input = Candle

Type of one input data point (typically f64 for a price, or Candle / Tick).

type Output = SuperTrendOutput

Type of one output value.

fn update(&mut self, candle: Candle) -> Option<SuperTrendOutput>

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.