Struct MaEnvelope 

pub struct MaEnvelope { /* private fields */ }

Moving Average Envelope: an SMA centerline with constant-percent bands on each side.

middle = SMA(period)
upper  = middle · (1 + percent)
lower  = middle · (1 − percent)

The envelope is a fixed multiplicative offset around the moving average, so the band width scales with price rather than with realised volatility (contrast Bollinger Bands, whose width is 2·k·σ, or Keltner Channels, whose width is 2·k·ATR). It is the oldest band-style overlay still in regular use; chart vendors typically default to period = 20, percent = 0.025 (2.5 %).

Example

use wickra_core::{Indicator, MaEnvelope};

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

Implementations

impl MaEnvelope

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

Construct a new Moving Average Envelope.

Errors

Returns Error::PeriodZero if period == 0 and Error::NonPositiveMultiplier if percent is not strictly positive and finite.

pub const fn period(&self) -> usize

Configured period.

pub const fn percent(&self) -> f64

Configured envelope percent (e.g. 0.025 for ±2.5 %).

Trait Implementations

impl Clone for MaEnvelope

fn clone(&self) -> MaEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaEnvelope

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

Formats the value using the given formatter.

impl Indicator for MaEnvelope

type Input = f64

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

type Output = MaEnvelopeOutput

Type of one output value.

fn update(&mut self, input: f64) -> Option<MaEnvelopeOutput>

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.