Struct PercentB 

pub struct PercentB { /* private fields */ }

Bollinger %b — where price sits within the Bollinger Bands.

%b = (price − lower) / (upper − lower)

%b = 1 means price is exactly on the upper band, %b = 0 on the lower band, %b = 0.5 on the middle band. The value is not clamped: price breaking above the upper band gives %b > 1, breaking below the lower band gives %b < 0. That makes %b a clean, scale-free way to compare a price’s band position across instruments and to spot band overshoots.

Example

use wickra_core::{Indicator, PercentB};

let mut indicator = PercentB::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 PercentB

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

Construct a new %b 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 PercentB

fn clone(&self) -> PercentB

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PercentB

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

Formats the value using the given formatter.

impl Indicator for PercentB

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.