Enum SeasonalComponent 

pub enum SeasonalComponent {
    None,
    Additive {
        season_length: usize,
    },
    Multiplicative {
        season_length: usize,
    },
}

The type of trend component included in the model.

Variants

None

No seasonal component.

Additive

Additive seasonal component.

Fields

season_length: usize

The number of observations in a seasonal cycle.

This was called m in the original ets R code.

Multiplicative

Multiplicative seasonal component.

Fields

season_length: usize

The number of observations in a seasonal cycle.

This was called m in the original ets R code.

Implementations

impl SeasonalComponent

pub fn included(&self) -> bool

Whether this component will be included in a model.

pub fn season_length(&self) -> usize

The number of observations in a seasonal cycle.

This will be 1 if the component is None, otherwise it will be the season_length of the variant.

Trait Implementations

impl Clone for SeasonalComponent

fn clone(&self) -> SeasonalComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SeasonalComponent

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

Formats the value using the given formatter.

impl Display for SeasonalComponent

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

Formats the value using the given formatter.

impl Ord for SeasonalComponent

fn cmp(&self, other: &SeasonalComponent) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SeasonalComponent

fn eq(&self, other: &SeasonalComponent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SeasonalComponent

fn partial_cmp(&self, other: &SeasonalComponent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SeasonalComponent

impl Eq for SeasonalComponent

impl StructuralPartialEq for SeasonalComponent