Struct nalgebra::linalg::ColPivQR [−][src]
pub struct ColPivQR<T: ComplexField, R: DimMin<C>, C: Dim> where
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<(usize, usize), DimMinimum<R, C>>, { /* fields omitted */ }
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<T, R, C> + Allocator<T, R> + Allocator<T, DimMinimum<R, C>> + Allocator<(usize, usize), DimMinimum<R, C>>,
[src]
impl<T: ComplexField, R: DimMin<C>, C: Dim> ColPivQR<T, R, C> where
DefaultAllocator: Allocator<T, R, C> + Allocator<T, R> + Allocator<T, DimMinimum<R, C>> + Allocator<(usize, usize), DimMinimum<R, C>>,
[src]pub fn new(matrix: OMatrix<T, R, C>) -> Self
[src]
Computes the ColPivQR decomposition using householder reflections.
pub fn r(&self) -> OMatrix<T, DimMinimum<R, C>, C> where
DefaultAllocator: Allocator<T, DimMinimum<R, C>, C>,
[src]
DefaultAllocator: Allocator<T, 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>,
[src]
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<T, R, DimMinimum<R, C>>,
[src]
DefaultAllocator: Allocator<T, R, DimMinimum<R, C>>,
Computes the orthogonal matrix Q
of this decomposition.
pub fn p(&self) -> &PermutationSequence<DimMinimum<R, C>>
[src]
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<T, R, DimMinimum<R, C>> + Reallocator<T, R, C, DimMinimum<R, C>, C> + Allocator<(usize, usize), DimMinimum<R, C>>,
[src]
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<T, R, DimMinimum<R, C>> + Reallocator<T, R, C, DimMinimum<R, C>, C> + Allocator<(usize, usize), 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>,
[src]
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<T, D, D> + Allocator<T, D> + Allocator<(usize, usize), DimMinimum<D, D>>,
[src]
impl<T: ComplexField, D: DimMin<D, Output = D>> ColPivQR<T, D, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T, D> + Allocator<(usize, usize), DimMinimum<D, D>>,
[src]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<T, R2, C2>,
[src]
&self,
b: &Matrix<T, R2, C2, S2>
) -> Option<OMatrix<T, R2, C2>> where
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.
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>,
[src]
&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>>
[src]
Computes the inverse of the decomposed matrix.
Returns None
if the decomposed matrix is not invertible.
pub fn is_invertible(&self) -> bool
[src]
Indicates if the decomposed matrix is invertible.
pub fn determinant(&self) -> T
[src]
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<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<(usize, usize), DimMinimum<R, C>>,
[src]
impl<T: Clone + ComplexField, R: Clone + DimMin<C>, C: Clone + Dim> Clone for ColPivQR<T, R, C> where
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<(usize, usize), DimMinimum<R, C>>,
[src]impl<T: ComplexField, R: DimMin<C>, C: Dim> Copy for ColPivQR<T, R, C> where
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<(usize, usize), DimMinimum<R, C>>,
OMatrix<T, R, C>: Copy,
PermutationSequence<DimMinimum<R, C>>: Copy,
OVector<T, DimMinimum<R, C>>: Copy,
[src]
impl<T: ComplexField, R: DimMin<C>, C: Dim> Copy for ColPivQR<T, R, C> where
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>> + Allocator<(usize, usize), DimMinimum<R, C>>,
OMatrix<T, R, C>: Copy,
PermutationSequence<DimMinimum<R, C>>: Copy,
OVector<T, DimMinimum<R, C>>: Copy,
[src]Auto Trait Implementations
impl<T, R, C> !RefUnwindSafe for ColPivQR<T, R, C>
impl<T, R, C> !RefUnwindSafe for ColPivQR<T, R, C>
impl<T, R, C> !UnwindSafe for ColPivQR<T, R, C>
impl<T, R, C> !UnwindSafe for ColPivQR<T, R, C>
Blanket Implementations
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]pub fn to_subset(&self) -> Option<SS>
[src]
pub fn is_in_subset(&self) -> bool
[src]
pub fn to_subset_unchecked(&self) -> SS
[src]
pub fn from_subset(element: &SS) -> SP
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,