Skip to main content

CovarianceGuards

Struct CovarianceGuards 

Source
pub struct CovarianceGuards {
    pub cov_max: f32,
    pub cov_min: f32,
    pub max_order_decrement: f32,
}
Expand description

Numerical guard configuration for the standard (covariance-form) RLS.

These guards prevent numerical instability that arises from maintaining the covariance matrix P directly. The inverse QR-RLS does not need these guards because it works with the information matrix factor, where updates involve only additions (never subtractions).

Default values match the indiflight C reference implementation.

Fields§

§cov_max: f32

Maximum allowed diagonal value in P.

When any P[i,i] exceeds this threshold, the forgetting factor λ is temporarily increased toward 1.0 to slow covariance growth.

Default: 1e10 (matches RLS_COV_MAX in indiflight).

§cov_min: f32

Minimum threshold for trace/diagonal ratio checks.

Guards against division by very small numbers in the order decrement limiting logic.

Default: 1e-10 (matches RLS_COV_MIN in indiflight).

§max_order_decrement: f32

Maximum relative trace reduction per update step.

Limits how much trace(P) can decrease in a single update, preventing numerical instability from aggressive rank-1 updates. A value of 0.1 means at most 10% of the trace can be removed per step.

Default: 0.1 (matches RLS_MAX_P_ORDER_DECREMENT in indiflight).

Trait Implementations§

Source§

impl Clone for CovarianceGuards

Source§

fn clone(&self) -> CovarianceGuards

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CovarianceGuards

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CovarianceGuards

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Copy for CovarianceGuards

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

Source§

type Output = T

Should always be Self
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.