pub struct ColPivQR<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>> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,{ /* private fields */ }
Expand description
The QR decomposition (with column pivoting) of a general matrix.
Implementations§
source§impl<T, R, C> ColPivQR<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>> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,
impl<T, R, C> ColPivQR<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>> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,
sourcepub fn new(
matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>
) -> ColPivQR<T, R, C>
pub fn new( matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer> ) -> ColPivQR<T, R, C>
Computes the ColPivQR
decomposition using householder reflections.
sourcepub 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>,
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.
sourcepub 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>,
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
.
sourcepub 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>,
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.
sourcepub fn p(&self) -> &PermutationSequence<<R as DimMin<C>>::Output>
pub fn p(&self) -> &PermutationSequence<<R as DimMin<C>>::Output>
Retrieves the column permutation of this decomposition.
sourcepub 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>, PermutationSequence<<R as DimMin<C>>::Output>)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> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,
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>, PermutationSequence<<R as DimMin<C>>::Output>)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> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,
Unpacks this decomposition into its two matrix factors.
source§impl<T, D> ColPivQR<T, D, D>where
T: ComplexField,
D: DimMin<D, Output = D>,
DefaultAllocator: Allocator<T, D, D> + Allocator<T, D, Const<1>> + Allocator<(usize, usize), <D as DimMin<D>>::Output, Const<1>>,
impl<T, D> ColPivQR<T, D, D>where T: ComplexField, D: DimMin<D, Output = D>, DefaultAllocator: Allocator<T, D, D> + Allocator<T, D, Const<1>> + Allocator<(usize, usize), <D as DimMin<D>>::Output, Const<1>>,
sourcepub 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: StorageMut<T, R2, C2>,
ShapeConstraint: SameNumberOfRows<R2, D>,
DefaultAllocator: Allocator<T, R2, C2>,
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: StorageMut<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.
sourcepub 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>,
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.
sourcepub fn try_inverse(
&self
) -> Option<Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>>
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.
sourcepub fn is_invertible(&self) -> bool
pub fn is_invertible(&self) -> bool
Indicates if the decomposed matrix is invertible.
sourcepub fn determinant(&self) -> T
pub fn determinant(&self) -> T
Computes the determinant of the decomposed matrix.
Trait Implementations§
source§impl<T, R, C> Clone for ColPivQR<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>> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,
impl<T, R, C> Clone for ColPivQR<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>> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,
source§impl<T, R, C> Debug for ColPivQR<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>> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,
impl<T, R, C> Debug for ColPivQR<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>> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,
impl<T, R, C> Copy for ColPivQR<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>> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>, Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>: Copy, PermutationSequence<<R as DimMin<C>>::Output>: Copy, Matrix<T, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, Const<1>>>::Buffer>: Copy,
Auto Trait Implementations§
impl<T, R, C> !RefUnwindSafe for ColPivQR<T, R, C>
impl<T, R, C> !Send for ColPivQR<T, R, C>
impl<T, R, C> !Sync for ColPivQR<T, R, C>
impl<T, R, C> !Unpin for ColPivQR<T, R, C>
impl<T, R, C> !UnwindSafe for ColPivQR<T, R, C>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.