Struct BollingerBands

Source
pub struct BollingerBands { /* private fields */ }
Expand description

A Bollinger Bands (BB). (BB). It is a type of infinite impulse response filter that calculates Bollinger Bands using Exponential Moving Average. The Bollinger Bands are represented by Average EMA and standard deviaton that is moved ‘k’ times away in both directions from calculated average value.

§Formula

See SMA, SD documentation.

BB is composed as:

  • BBMiddle Band - Simple Moving Average (SMA).
  • BBUpper Band = SMA + SD of observation * multipler (usually 2.0)
  • BBLower Band = SMA - SD of observation * multipler (usually 2.0)

§Example

 use quantaxis_rs::indicators::{BollingerBands, BollingerBandsOutput};
 use quantaxis_rs::Next;

 let mut bb = BollingerBands::new(3, 2.0_f64).unwrap();

 let out_0 = bb.next(2.0);

 let out_1 = bb.next(5.0);

 assert_eq!(out_0.average, 2.0);
 assert_eq!(out_0.upper, 2.0);
 assert_eq!(out_0.lower, 2.0);

 assert_eq!(out_1.average, 3.5);
 assert_eq!(out_1.upper, 6.5);
 assert_eq!(out_1.lower, 0.5);

Bollinger Bands, Wikipedia

Implementations§

Source§

impl BollingerBands

Source

pub fn new(length: u32, multiplier: f64) -> Result<Self>

Source

pub fn length(&self) -> u32

Source

pub fn multiplier(&self) -> f64

Trait Implementations§

Source§

impl Clone for BollingerBands

Source§

fn clone(&self) -> BollingerBands

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BollingerBands

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BollingerBands

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for BollingerBands

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, T: Close> Next<&'a T> for BollingerBands

Source§

type Output = BollingerBandsOutput

Source§

fn next(&mut self, input: &'a T) -> Self::Output

Source§

impl Next<f64> for BollingerBands

Source§

type Output = BollingerBandsOutput

Source§

fn next(&mut self, input: f64) -> Self::Output

Source§

impl Reset for BollingerBands

Source§

fn reset(&mut self)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V