Skip to main content

SquareRootKalmanFilter

Struct SquareRootKalmanFilter 

Source
pub struct SquareRootKalmanFilter<const N: usize, const M: usize> {
    pub x: [f32; N],
    pub s: [[f32; N]; N],
    pub f: [[f32; N]; N],
    pub s_q: [[f32; N]; N],
    pub h: [[f32; N]; M],
    pub s_r: [[f32; M]; M],
}
Expand description

Square-Root Covariance Kalman Filter (SRKF) for $N$-state, $M$-measurement linear systems.

Propagates the lower-triangular Cholesky factor $S$ of the covariance matrix ($P = S S^T$). By operating directly on the square-root factors via orthogonal Givens transformations, the filter guarantees numerical positive-definiteness and never diverges due to roundoff error.

Fields§

§x: [f32; N]

State estimate vector $\hat{x} \in \mathbb{R}^N$.

§s: [[f32; N]; N]

Lower-triangular Cholesky factor of state covariance $P = S S^T$.

§f: [[f32; N]; N]

State transition matrix $F \in \mathbb{R}^{N \times N}$.

§s_q: [[f32; N]; N]

Lower-triangular Cholesky factor of process noise covariance $Q = S_Q S_Q^T$.

§h: [[f32; N]; M]

Measurement matrix $H \in \mathbb{R}^{M \times N}$.

§s_r: [[f32; M]; M]

Lower-triangular Cholesky factor of measurement noise $R = S_R S_R^T$.

Implementations§

Source§

impl<const N: usize, const M: usize> SquareRootKalmanFilter<N, M>

Source

pub fn new( x0: [f32; N], s0: [[f32; N]; N], f: [[f32; N]; N], s_q: [[f32; N]; N], h: [[f32; N]; M], s_r: [[f32; M]; M], ) -> Self

Initialize a new Square-Root Kalman Filter from explicit Cholesky factors.

Source

pub fn predict(&mut self)

Predict step: propagates state $\hat{x}^- = F \hat{x}$ and triangularizes $[F S \quad S_Q]$.

Source

pub fn update(&mut self, z: &[f32; M]) -> Status

Update step: updates state $\hat{x}^+$ and factor $S^+$ given measurement vector $z \in \mathbb{R}^M$.

Source

pub fn covariance(&self) -> [[f32; N]; N]

Reconstructs the full covariance matrix $P = S S^T$.

Trait Implementations§

Source§

impl<const N: usize, const M: usize> Clone for SquareRootKalmanFilter<N, M>

Source§

fn clone(&self) -> SquareRootKalmanFilter<N, M>

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<const N: usize, const M: usize> Debug for SquareRootKalmanFilter<N, M>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<const N: usize, const M: usize> Freeze for SquareRootKalmanFilter<N, M>
where [f32; N]: Freeze, [[f32; N]; N]: Freeze, [[f32; N]; M]: Freeze, [[f32; M]; M]: Freeze,

§

impl<const N: usize, const M: usize> RefUnwindSafe for SquareRootKalmanFilter<N, M>
where [f32; N]: RefUnwindSafe, [[f32; N]; N]: RefUnwindSafe, [[f32; N]; M]: RefUnwindSafe, [[f32; M]; M]: RefUnwindSafe,

§

impl<const N: usize, const M: usize> Send for SquareRootKalmanFilter<N, M>
where [f32; N]: Send, [[f32; N]; N]: Send, [[f32; N]; M]: Send, [[f32; M]; M]: Send,

§

impl<const N: usize, const M: usize> Sync for SquareRootKalmanFilter<N, M>
where [f32; N]: Sync, [[f32; N]; N]: Sync, [[f32; N]; M]: Sync, [[f32; M]; M]: Sync,

§

impl<const N: usize, const M: usize> Unpin for SquareRootKalmanFilter<N, M>
where [f32; N]: Unpin, [[f32; N]; N]: Unpin, [[f32; N]; M]: Unpin, [[f32; M]; M]: Unpin,

§

impl<const N: usize, const M: usize> UnsafeUnpin for SquareRootKalmanFilter<N, M>
where [f32; N]: UnsafeUnpin, [[f32; N]; N]: UnsafeUnpin, [[f32; N]; M]: UnsafeUnpin, [[f32; M]; M]: UnsafeUnpin,

§

impl<const N: usize, const M: usize> UnwindSafe for SquareRootKalmanFilter<N, M>
where [f32; N]: UnwindSafe, [[f32; N]; N]: UnwindSafe, [[f32; N]; M]: UnwindSafe, [[f32; M]; M]: UnwindSafe,

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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

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

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.