Skip to main content

StateAndCovariance

Struct StateAndCovariance 

Source
pub struct StateAndCovariance<R, SS>
where R: RealField, SS: Dim, DefaultAllocator: Allocator<SS> + Allocator<SS, SS>,
{ /* private fields */ }
Expand description

State and covariance pair for a given estimate

Implementations§

Source§

impl<R, SS> StateAndCovariance<R, SS>
where R: RealField, SS: Dim, DefaultAllocator: Allocator<SS> + Allocator<SS, SS>,

Source

pub fn new( state: Vector<R, SS, Owned<R, SS>>, covariance: Matrix<R, SS, SS, Owned<R, SS, SS>>, ) -> Self

Create a new StateAndCovariance.

It is assumed that the covariance matrix is symmetric and positive semi-definite.

Source

pub fn state(&self) -> &Vector<R, SS, Owned<R, SS>>

Get a reference to the state vector.

Source

pub fn state_mut(&mut self) -> &mut Vector<R, SS, Owned<R, SS>>

Get a mut reference to the state vector.

Source

pub fn covariance(&self) -> &Matrix<R, SS, SS, Owned<R, SS, SS>>

Get a reference to the covariance matrix.

Source

pub fn covariance_mut(&mut self) -> &mut Matrix<R, SS, SS, Owned<R, SS, SS>>

Get a mutable reference to the covariance matrix.

Source

pub fn inner(self) -> (OVector<R, SS>, OMatrix<R, SS, SS>)

Get the state vector and covariance matrix.

Trait Implementations§

Source§

impl<R, SS> Clone for StateAndCovariance<R, SS>
where R: RealField + Clone, SS: Dim + Clone, DefaultAllocator: Allocator<SS> + Allocator<SS, SS>,

Source§

fn clone(&self) -> StateAndCovariance<R, SS>

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<R, SS> Debug for StateAndCovariance<R, SS>
where R: RealField + Debug, SS: Dim + Debug, DefaultAllocator: Allocator<SS> + Allocator<SS, SS>,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R, SS> !Freeze for StateAndCovariance<R, SS>

§

impl<R, SS> !RefUnwindSafe for StateAndCovariance<R, SS>

§

impl<R, SS> !Send for StateAndCovariance<R, SS>

§

impl<R, SS> !Sync for StateAndCovariance<R, SS>

§

impl<R, SS> !Unpin for StateAndCovariance<R, SS>

§

impl<R, SS> !UnsafeUnpin for StateAndCovariance<R, SS>

§

impl<R, SS> !UnwindSafe for StateAndCovariance<R, SS>

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> 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 = 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.