Struct ColPivQR

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

The QR decomposition (with column pivoting) of a general matrix.

Implementations

impl<T, R, C> ColPivQR<T, R, C>

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

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

Computes the ColPivQR decomposition using householder reflections.

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

where DefaultAllocator: Allocator<<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<<R as DimMin<C>>::Output, C>>::Buffer<T>>

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<R, <R as DimMin<C>>::Output>>::Buffer<T>>

where DefaultAllocator: Allocator<R, <R as DimMin<C>>::Output>,

Computes the orthogonal matrix Q of this decomposition.

pub fn p(&self) -> &PermutationSequence<<R as DimMin<C>>::Output>

Retrieves the column permutation of this decomposition.

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

where <R as DimMin<C>>::Output: DimMin<C, Output = <R as DimMin<C>>::Output>, DefaultAllocator: Allocator<R, <R as DimMin<C>>::Output> + Reallocator<T, R, C, <R as DimMin<C>>::Output, C> + Allocator<<R as DimMin<C>>::Output>,

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> ColPivQR<T, D, D>

where T: ComplexField, D: DimMin<D, Output = D>, DefaultAllocator: Allocator<D, D> + Allocator<D> + Allocator<<D as DimMin<D>>::Output>,

pub fn solve<R2, C2, S2>( &self, b: &Matrix<T, R2, C2, S2>, ) -> Option<Matrix<T, R2, C2, <DefaultAllocator as Allocator<R2, C2>>::Buffer<T>>>

where R2: Dim, C2: Dim, S2: StorageMut<T, R2, C2>, ShapeConstraint: SameNumberOfRows<R2, D>, DefaultAllocator: Allocator<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>) -> bool

where 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<D, D>>::Buffer<T>>>

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.

pub fn determinant(&self) -> T

Computes the determinant of the decomposed matrix.

Trait Implementations

impl<T, R, C> Clone for ColPivQR<T, R, C>

where T: Clone + ComplexField, R: Clone + DimMin<C>, C: Clone + Dim, DefaultAllocator: Allocator<R, C> + Allocator<<R as DimMin<C>>::Output>,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, R, C> Debug for ColPivQR<T, R, C>

where T: Debug + ComplexField, R: Debug + DimMin<C>, C: Debug + Dim, DefaultAllocator: Allocator<R, C> + Allocator<<R as DimMin<C>>::Output>,

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

Formats the value using the given formatter.

impl<'de, T, R, C> Deserialize<'de> for ColPivQR<T, R, C>

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<ColPivQR<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 ColPivQR<T, R, C>

where T: ComplexField, R: DimMin<C>, C: Dim, DefaultAllocator: Allocator<R, C> + Allocator<<R as DimMin<C>>::Output>, Matrix<T, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<T>>: Serialize, PermutationSequence<<R as DimMin<C>>::Output>: Serialize, Matrix<T, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<<R as DimMin<C>>::Output>>::Buffer<T>>: 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 ColPivQR<T, R, C>

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