Skip to main content

HoltWinters

Struct HoltWinters 

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

Holt-Winters Triple Exponential Smoothing.

Implementations§

Source§

impl HoltWinters

Source

pub fn new( alpha: f64, beta: f64, gamma: f64, period: usize, seasonality: Seasonality, ) -> Option<Self>

Creates a new Holt-Winters smoother.

§Parameters
  • alpha: level smoothing constant ∈ (0, 1)
  • beta: trend smoothing constant ∈ (0, 1)
  • gamma: seasonal smoothing constant ∈ (0, 1)
  • period: seasonal period (must be ≥ 2)
  • seasonality: additive or multiplicative

Returns None if parameters are invalid.

Source

pub fn period(&self) -> usize

Returns the seasonal period.

Source

pub fn seasonality(&self) -> Seasonality

Returns the seasonality type.

Source

pub fn smooth(&self, data: &[f64]) -> Option<HoltWintersResult>

Applies Holt-Winters smoothing to the data.

Requires at least 2 * period data points for initialization. Returns None if data is insufficient or if multiplicative seasonality is used with non-positive data.

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> 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, 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