Skip to main content

DeterministicProcess

Struct DeterministicProcess 

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

Builder for a matrix of deterministic time-series terms.

Configure with a constant, a polynomial time-trend order, and optional seasonal dummies of a given period, then call Self::in_sample to materialise the steps × k term matrix.

Column order is [const?, trend, trend_squared, ..., seasonal dummies?]. When the constant is present the first seasonal period is used as the reference category and dropped, yielding period - 1 dummy columns named s(2,period)..s(period,period); otherwise all period dummies are kept. The time index for the trend terms runs 1, 2, ..., steps.

Implementations§

Source§

impl DeterministicProcess

Source

pub fn new( steps: usize, constant: bool, order: usize, seasonal: bool, period: usize, ) -> Result<Self>

Create a process spanning steps in-sample observations.

constant toggles the intercept column, order is the degree of the polynomial time trend (0 disables it), and seasonal toggles seasonal dummies with the given period (which must be at least 2 when seasonal terms are requested).

Source

pub fn ncols(&self) -> usize

Total number of deterministic columns produced by Self::in_sample.

Source

pub fn in_sample(&self) -> Array2<f64>

Materialise the in-sample deterministic term matrix.

The result has shape (steps, ncols) with columns ordered [const?, trend^1..trend^order, seasonal dummies?].

Trait Implementations§

Source§

impl Clone for DeterministicProcess

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 DeterministicProcess

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.