Struct ColPivQR

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

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

Implementations

impl<T: ComplexField, R: DimMin<C>, C: Dim> ColPivQR<T, R, C>

where DefaultAllocator: Allocator<R, C> + Allocator<R> + Allocator<DimMinimum<R, C>>,

pub fn new(matrix: OMatrix<T, R, C>) -> Self

Computes the ColPivQR decomposition using householder reflections.

pub fn r(&self) -> OMatrix<T, DimMinimum<R, C>, C>

where DefaultAllocator: Allocator<DimMinimum<R, C>, C>,

Retrieves the upper trapezoidal submatrix R of this decomposition.

pub fn unpack_r(self) -> OMatrix<T, DimMinimum<R, C>, C>

where DefaultAllocator: Reallocator<T, R, C, DimMinimum<R, C>, C>,

Retrieves the upper trapezoidal submatrix R of this decomposition.

This is usually faster than r but consumes self.

pub fn q(&self) -> OMatrix<T, R, DimMinimum<R, C>>

where DefaultAllocator: Allocator<R, DimMinimum<R, C>>,

Computes the orthogonal matrix Q of this decomposition.

pub fn p(&self) -> &PermutationSequence<DimMinimum<R, C>>

Retrieves the column permutation of this decomposition.

pub fn unpack( self, ) -> (OMatrix<T, R, DimMinimum<R, C>>, OMatrix<T, DimMinimum<R, C>, C>, PermutationSequence<DimMinimum<R, C>>)

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

Unpacks this decomposition into its two matrix factors.

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

where S2: StorageMut<T, R2, C2>,

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

impl<T: ComplexField, D: DimMin<D, Output = D>> ColPivQR<T, D, D>

where DefaultAllocator: Allocator<D, D> + Allocator<D> + Allocator<DimMinimum<D, D>>,

pub fn solve<R2: Dim, C2: Dim, S2>( &self, b: &Matrix<T, R2, C2, S2>, ) -> Option<OMatrix<T, R2, C2>>

where 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: Dim, C2: Dim, S2>( &self, b: &mut Matrix<T, R2, C2, S2>, ) -> bool

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

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: Clone + ComplexField, R: Clone + DimMin<C>, C: Clone + Dim> Clone for ColPivQR<T, R, C>

where DefaultAllocator: Allocator<R, C> + Allocator<DimMinimum<R, C>>,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ComplexField, R: Debug + DimMin<C>, C: Debug + Dim> Debug for ColPivQR<T, R, C>

where DefaultAllocator: Allocator<R, C> + Allocator<DimMinimum<R, C>>,

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

Formats the value using the given formatter.

impl<'de, T: ComplexField, R: DimMin<C>, C: Dim> Deserialize<'de> for ColPivQR<T, R, C>

where DefaultAllocator: Allocator<R, C> + Allocator<DimMinimum<R, C>>, OMatrix<T, R, C>: Deserialize<'de>, PermutationSequence<DimMinimum<R, C>>: Deserialize<'de>, OVector<T, DimMinimum<R, C>>: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: ComplexField, R: DimMin<C>, C: Dim> Serialize for ColPivQR<T, R, C>

where DefaultAllocator: Allocator<R, C> + Allocator<DimMinimum<R, C>>, OMatrix<T, R, C>: Serialize, PermutationSequence<DimMinimum<R, C>>: Serialize, OVector<T, DimMinimum<R, C>>: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: ComplexField, R: DimMin<C>, C: Dim> Copy for ColPivQR<T, R, C>

where DefaultAllocator: Allocator<R, C> + Allocator<DimMinimum<R, C>>, OMatrix<T, R, C>: Copy, PermutationSequence<DimMinimum<R, C>>: Copy, OVector<T, DimMinimum<R, C>>: Copy,