Struct stlrs::StlParams

pub struct StlParams { /* private fields */ }

Implementations

impl StlParams

pub fn new() -> Self

Creates a new set of parameters.

pub fn seasonal_length(&mut self, length: usize) -> &mut Self

Sets the length of the seasonal smoother.

pub fn trend_length(&mut self, length: usize) -> &mut Self

Sets the length of the trend smoother.

pub fn low_pass_length(&mut self, length: usize) -> &mut Self

Sets the length of the low-pass filter.

pub fn seasonal_degree(&mut self, degree: i32) -> &mut Self

Sets the degree of locally-fitted polynomial in seasonal smoothing.

pub fn trend_degree(&mut self, degree: i32) -> &mut Self

Sets the degree of locally-fitted polynomial in trend smoothing.

pub fn low_pass_degree(&mut self, degree: i32) -> &mut Self

Sets the degree of locally-fitted polynomial in low-pass smoothing.

pub fn seasonal_jump(&mut self, jump: usize) -> &mut Self

Sets the skipping value for seasonal smoothing.

pub fn trend_jump(&mut self, jump: usize) -> &mut Self

Sets the skipping value for trend smoothing.

pub fn low_pass_jump(&mut self, jump: usize) -> &mut Self

Sets the skipping value for low-pass smoothing.

pub fn inner_loops(&mut self, loops: usize) -> &mut Self

Sets the number of loops for updating the seasonal and trend components.

pub fn outer_loops(&mut self, loops: usize) -> &mut Self

Sets the number of iterations of robust fitting.

pub fn robust(&mut self, robust: bool) -> &mut Self

Sets whether robustness iterations are to be used.

pub fn fit(&self, series: &[f32], period: usize) -> Result<StlResult, Error>

Decomposes a time series.

Trait Implementations

impl Clone for StlParams

fn clone(&self) -> StlParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StlParams

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

Formats the value using the given formatter.

impl Default for StlParams

fn default() -> Self

Returns the “default value” for a type.