Struct BollingerBandwidth 

pub struct BollingerBandwidth { /* private fields */ }

Bollinger Bandwidth — the width of the Bollinger Bands relative to the middle band.

Bandwidth = (upper − lower) / middle

Because the bands are middle ± multiplier · stddev, the bandwidth is 2 · multiplier · stddev / middle — a normalised volatility reading. Its value is the basis of two classic patterns: the squeeze (bandwidth at a multi-month low, signalling a coiled, low-volatility market about to expand) and the bulge (bandwidth at an extreme high).

Example

use wickra_core::{Indicator, BollingerBandwidth};

let mut indicator = BollingerBandwidth::new(20, 2.0).unwrap();
let mut last = None;
for i in 0..80 {
    last = indicator.update(100.0 + (f64::from(i) * 0.3).sin() * 6.0);
}
assert!(last.is_some());

Implementations

impl BollingerBandwidth

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

Construct a new Bollinger Bandwidth indicator.

Errors

Returns crate::Error::PeriodZero for period == 0 and crate::Error::NonPositiveMultiplier for multiplier <= 0.

pub const fn period(&self) -> usize

Configured period.

pub const fn multiplier(&self) -> f64

Configured multiplier.

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

Current value if available.

Trait Implementations

impl Clone for BollingerBandwidth

fn clone(&self) -> BollingerBandwidth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BollingerBandwidth

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

Formats the value using the given formatter.

impl Indicator for BollingerBandwidth

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.