Skip to main content

SesResult

Struct SesResult 

Source
pub struct SesResult {
    pub smoothed: Vec<f64>,
    pub forecast: f64,
    pub fitted: Vec<f64>,
    pub alpha: f64,
}
Expand description

Result of simple exponential smoothing at each time step.

Fields§

§smoothed: Vec<f64>

Smoothed values.

§forecast: f64

One-step-ahead forecast for the next period.

§fitted: Vec<f64>

One-step-ahead in-sample forecasts: fitted[t] = smoothed[t − 1], and fitted[0] the initial level data[0].

§alpha: f64

The smoothing constant α.

Implementations§

Source§

impl SesResult

Source

pub const FIRST_ERROR: usize = 1

The index of the first one-step error the smoother learns from: before it the fitted value is the initialisation.

Source

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

data[t] − fitted[t], None at the initialisation.

Source

pub fn forecasts( &self, data: &[f64], horizon: usize, level: f64, ) -> Option<Vec<SmoothingForecast>>

Forecasts 1..=horizon steps ahead with the prediction interval of ETS(A,N,N) at two-sided level (module documentation); data is the series smoothed (for σ). None when level is not in (0, 1).

Source

pub fn first_passage( &self, data: &[f64], horizon: usize, threshold: f64, quantiles: &[f64], paths: usize, seed: u64, ) -> Option<FirstPassage>

When the forecast total over steps 1, 2, … first reaches threshold (non-zero; from below when positive, from above when negative), over paths simulated futures of the fitted model seeded with seed, within horizon steps – with the quantiles (each in (0, 1]) of that time (FirstPassage). data is the series smoothed (for σ). None when an argument is outside those ranges or there is no one-step error to estimate σ from.

Trait Implementations§

Source§

impl Clone for SesResult

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SesResult

Source§

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

Formats the value using the given formatter. Read more

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.