#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use crate::core::{Action, Error, Method, PeriodType, Source, ValueType, OHLCV};
use crate::core::{IndicatorConfig, IndicatorInstance, IndicatorResult};
use crate::methods::{StDev, SMA};
#[derive(Debug, Clone, Copy)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct BollingerBands {
pub avg_size: PeriodType,
pub sigma: ValueType,
pub source: Source,
}
impl IndicatorConfig for BollingerBands {
type Instance = BollingerBandsInstance;
const NAME: &'static str = "BollingerBands";
fn init<T: OHLCV>(self, candle: &T) -> Result<Self::Instance, Error> {
if !self.validate() {
return Err(Error::WrongConfig);
}
let cfg = self;
let src = T::source(candle, cfg.source);
Ok(Self::Instance {
ma: SMA::new(cfg.avg_size, &src)?,
st_dev: StDev::new(cfg.avg_size, &src)?,
cfg,
})
}
fn validate(&self) -> bool {
self.sigma > 0.0 && self.avg_size > 2 && self.avg_size < PeriodType::MAX
}
fn set(&mut self, name: &str, value: String) -> Result<(), Error> {
match name {
"avg_size" => match value.parse() {
Err(_) => return Err(Error::ParameterParse(name.to_string(), value.to_string())),
Ok(value) => self.avg_size = value,
},
"sigma" => match value.parse() {
Err(_) => return Err(Error::ParameterParse(name.to_string(), value.to_string())),
Ok(value) => self.sigma = value,
},
"source" => match value.parse() {
Err(_) => return Err(Error::ParameterParse(name.to_string(), value.to_string())),
Ok(value) => self.source = value,
},
_ => {
return Err(Error::ParameterParse(name.to_string(), value));
}
};
Ok(())
}
fn size(&self) -> (u8, u8) {
(3, 1)
}
}
impl Default for BollingerBands {
fn default() -> Self {
Self {
avg_size: 20,
sigma: 2.0,
source: Source::Close,
}
}
}
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct BollingerBandsInstance {
cfg: BollingerBands,
ma: SMA,
st_dev: StDev,
}
impl IndicatorInstance for BollingerBandsInstance {
type Config = BollingerBands;
#[inline]
fn config(&self) -> &Self::Config {
&self.cfg
}
fn next<T: OHLCV>(&mut self, candle: &T) -> IndicatorResult {
let source = candle.source(self.cfg.source);
let middle = self.ma.next(&source);
let sq_error = self.st_dev.next(&source);
let upper = sq_error.mul_add(self.cfg.sigma, middle);
let lower = sq_error.mul_add(-self.cfg.sigma, middle);
let values = [upper, middle, lower];
let range = upper - lower;
let relative = if range == 0.0 {
0.5
} else {
(source - lower) / range
};
let signals = [Action::from(relative.mul_add(2.0, -1.0))];
IndicatorResult::new(&values, &signals)
}
}