![]() |
Eigen
5.0.1-dev+master
|
#include <Eigen/src/QR/CompleteOrthogonalDecomposition.h>
Complete orthogonal decomposition (COD) of a matrix.
| MatrixType_ | the type of the matrix of which we are computing the COD. |
This class performs a rank-revealing complete orthogonal decomposition of a matrix A into matrices P, Q, T, and Z such that
\[ \mathbf{A} \, \mathbf{P} = \mathbf{Q} \, \begin{bmatrix} \mathbf{T} & \mathbf{0} \\ \mathbf{0} & \mathbf{0} \end{bmatrix} \, \mathbf{Z} \]
by using Householder transformations. Here, P is a permutation matrix, Q and Z are unitary matrices and T an upper triangular matrix of size rank-by-rank. A may be rank deficient.
Internally backed by ColPivHouseholderQR. For large matrices, see RandCompleteOrthogonalDecomposition, which uses a randomized blocked column-pivoted QR and is faster on level-3-BLAS-friendly inputs.
This class supports the inplace decomposition mechanism.
Public Member Functions | |
| template<typename InputType> | |
| CompleteOrthogonalDecomposition & | compute (const EigenBase< InputType > &matrix) |
| Computes the COD of matrix. | |
| Inverse< CompleteOrthogonalDecomposition > | pseudoInverse () const |
| CompleteOrthogonalDecomposition & | setThreshold (const RealScalar &threshold) |
| CompleteOrthogonalDecomposition & | setThreshold (Default_t) |
|
inline |
Computes the COD of matrix.
|
inline |
this->pseudoInverse()*rhs to solve a linear system. It is more efficient and numerically stable to call this->solve(rhs).
|
inline |
Prescribes the threshold below which pivots are considered zero when compute() determines the rank, see ColPivHouseholderQR::setThreshold(const RealScalar&).
The rank, and the matrix Z that depends on it, are fixed by compute(). Calling setThreshold() on a decomposition that has already been computed does not change rank(), solve() or any other result; the new threshold takes effect at the next call of compute(). To use a threshold for the first computation, call setThreshold() before compute() (for instance on a default-constructed object).
|
inline |
Returns to the default threshold for the next call of compute(), see setThreshold(const RealScalar&).