Struct SineWeightedMa 

pub struct SineWeightedMa { /* private fields */ }

Sine-Weighted Moving Average — a windowed average whose weights follow one half-cycle of a sine wave.

Over the last period inputs the weight of the value at position i = 0, 1, …, period − 1 (oldest to newest) is

w_i = sin(π · (i + 1) / (period + 1))
SWMA = Σ (w_i · value_i) / Σ w_i

The window is symmetric: weights rise to a peak in the middle of the window and fall off at both ends, so the central observations dominate while the extremes are de-emphasised. Every weight is strictly positive because the argument (i + 1) / (period + 1) lies in the open interval (0, 1), so the normaliser is always non-zero.

Each update is O(period): the fixed weight vector is dotted with the trailing window, mirroring the way Alma recomputes its Gaussian weights. period == 1 collapses to a pass-through (w_0 = sin(π/2) = 1).

Example

use wickra_core::{Indicator, SineWeightedMa};

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

Implementations

impl SineWeightedMa

pub fn new(period: usize) -> Result<SineWeightedMa, Error>

Construct a new sine-weighted moving average over period inputs.

Errors

Returns Error::PeriodZero if period == 0.

pub const fn period(&self) -> usize

Configured period.

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

Current value if the window is full.

Trait Implementations

impl Clone for SineWeightedMa

fn clone(&self) -> SineWeightedMa

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SineWeightedMa

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

Formats the value using the given formatter.

impl Indicator for SineWeightedMa

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.