pub struct DynamicLinearModel {
pub base_model: StateSpaceModel,
pub time_varying_obs: Option<Vec<Array2<f64>>>,
}Expand description
Dynamic Linear Model with optional time-varying observation matrix.
Fields§
§base_model: StateSpaceModelBase SSM (used when no time-varying H is provided)
time_varying_obs: Option<Vec<Array2<f64>>>Optional sequence of observation matrices H_t (one per time step)
Implementations§
Source§impl DynamicLinearModel
impl DynamicLinearModel
Sourcepub fn new(model: StateSpaceModel) -> Self
pub fn new(model: StateSpaceModel) -> Self
Create a DLM from a static SSM.
Sourcepub fn with_time_varying_obs(self, h_sequence: Vec<Array2<f64>>) -> Self
pub fn with_time_varying_obs(self, h_sequence: Vec<Array2<f64>>) -> Self
Attach a time-varying sequence of observation matrices.
Sourcepub fn filter(
&self,
observations: ArrayView2<'_, f64>,
) -> Result<KalmanFilterResult>
pub fn filter( &self, observations: ArrayView2<'_, f64>, ) -> Result<KalmanFilterResult>
Run the Kalman filter.
Sourcepub fn smooth(
&self,
observations: ArrayView2<'_, f64>,
) -> Result<KalmanSmootherResult>
pub fn smooth( &self, observations: ArrayView2<'_, f64>, ) -> Result<KalmanSmootherResult>
Run filter + smoother.
Trait Implementations§
Source§impl Clone for DynamicLinearModel
impl Clone for DynamicLinearModel
Source§fn clone(&self) -> DynamicLinearModel
fn clone(&self) -> DynamicLinearModel
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for DynamicLinearModel
impl RefUnwindSafe for DynamicLinearModel
impl Send for DynamicLinearModel
impl Sync for DynamicLinearModel
impl Unpin for DynamicLinearModel
impl UnsafeUnpin for DynamicLinearModel
impl UnwindSafe for DynamicLinearModel
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.