Struct oxygengine_physics_2d::prelude::nalgebra::QR

pub struct QR<T, R, C>where
    T: ComplexField,
    R: DimMin<C>,
    C: Dim,
    DefaultAllocator: Allocator<T, R, C> + Allocator<T, <R as DimMin<C>>::Output, Const<1>>,{ /* private fields */ }

The QR decomposition of a general matrix.

Implementations

impl<T, R, C> QR<T, R, C>where T: ComplexField, R: DimMin<C>, C: Dim, DefaultAllocator: Allocator<T, R, C> + Allocator<T, R, Const<1>> + Allocator<T, <R as DimMin<C>>::Output, Const<1>>,

pub fn new( matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer> ) -> QR<T, R, C>

Computes the QR decomposition using householder reflections.

pub fn r( &self ) -> Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer>where DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C>,

Retrieves the upper trapezoidal submatrix R of this decomposition.

pub fn unpack_r( self ) -> Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer>where DefaultAllocator: Reallocator<T, R, C, <R as DimMin<C>>::Output, C>,

Retrieves the upper trapezoidal submatrix R of this decomposition.

This is usually faster than r but consumes self.

pub fn q( &self ) -> Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<T, R, <R as DimMin<C>>::Output>>::Buffer>where DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,

Computes the orthogonal matrix Q of this decomposition.

pub fn unpack( self ) -> (Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<T, R, <R as DimMin<C>>::Output>>::Buffer>, Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer>)where <R as DimMin<C>>::Output: DimMin<C, Output = <R as DimMin<C>>::Output>, DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output> + Reallocator<T, R, C, <R as DimMin<C>>::Output, C>,

Unpacks this decomposition into its two matrix factors.

pub fn q_tr_mul<R2, C2, S2>(&self, rhs: &mut Matrix<T, R2, C2, S2>)where R2: Dim, C2: Dim, S2: StorageMut<T, R2, C2>,

Multiplies the provided matrix by the transpose of the Q matrix of this decomposition.

impl<T, D> QR<T, D, D>where T: ComplexField, D: DimMin<D, Output = D>, DefaultAllocator: Allocator<T, D, D> + Allocator<T, D, Const<1>>,

pub fn solve<R2, C2, S2>( &self, b: &Matrix<T, R2, C2, S2> ) -> Option<Matrix<T, R2, C2, <DefaultAllocator as Allocator<T, R2, C2>>::Buffer>>where R2: Dim, C2: Dim, S2: Storage<T, R2, C2>, ShapeConstraint: SameNumberOfRows<R2, D>, DefaultAllocator: Allocator<T, R2, C2>,

Solves the linear system self * x = b, where x is the unknown to be determined.

Returns None if self is not invertible.

pub fn solve_mut<R2, C2, S2>(&self, b: &mut Matrix<T, R2, C2, S2>) -> boolwhere R2: Dim, C2: Dim, S2: StorageMut<T, R2, C2>, ShapeConstraint: SameNumberOfRows<R2, D>,

Solves the linear system self * x = b, where x is the unknown to be determined.

If the decomposed matrix is not invertible, this returns false and its input b is overwritten with garbage.

pub fn try_inverse( &self ) -> Option<Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>>

Computes the inverse of the decomposed matrix.

Returns None if the decomposed matrix is not invertible.

pub fn is_invertible(&self) -> bool

Indicates if the decomposed matrix is invertible.

Trait Implementations

impl<T, R, C> Clone for QR<T, R, C>where T: Clone + ComplexField, R: Clone + DimMin<C>, C: Clone + Dim, DefaultAllocator: Allocator<T, R, C> + Allocator<T, <R as DimMin<C>>::Output, Const<1>>,

fn clone(&self) -> QR<T, R, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, R, C> Debug for QR<T, R, C>where T: Debug + ComplexField, R: Debug + DimMin<C>, C: Debug + Dim, DefaultAllocator: Allocator<T, R, C> + Allocator<T, <R as DimMin<C>>::Output, Const<1>>,

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

Formats the value using the given formatter.

impl<'de, T, R, C> Deserialize<'de> for QR<T, R, C>where T: ComplexField, R: DimMin<C>, C: Dim, DefaultAllocator: Allocator<T, R, C> + Allocator<T, <R as DimMin<C>>::Output, Const<1>>, Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>: Deserialize<'de>, Matrix<T, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, Const<1>>>::Buffer>: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D ) -> Result<QR<T, R, C>, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, R, C> Serialize for QR<T, R, C>where T: ComplexField, R: DimMin<C>, C: Dim, DefaultAllocator: Allocator<T, R, C> + Allocator<T, <R as DimMin<C>>::Output, Const<1>>, Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>: Serialize, Matrix<T, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, Const<1>>>::Buffer>: Serialize,

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, R, C> Copy for QR<T, R, C>where T: ComplexField, R: DimMin<C>, C: Dim, DefaultAllocator: Allocator<T, R, C> + Allocator<T, <R as DimMin<C>>::Output, Const<1>>, Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>: Copy, Matrix<T, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, Const<1>>>::Buffer>: Copy,