![]() |
Eigen
5.0.1-dev+master
|
#include <Eigen/src/QR/CompleteOrthogonalDecomposition.h>
Complete orthogonal decomposition (COD) of a matrix, backed by RandColPivHouseholderQR.
Same factorization as CompleteOrthogonalDecomposition, but the rank-revealing QR step uses the randomized blocked column-pivoted Householder QR (BQRRP framework). On large matrices this is faster than the classical Businger-Golub pivoting in CompleteOrthogonalDecomposition because almost all work is performed in level-3 BLAS. The pivot-quality difference is empirically minor; see RandColPivHouseholderQR for references and details.
The block size and RNG seed of the underlying QR can be configured via setBlockSize() and setSeed() before calling compute().
For small or fixed-size matrices prefer CompleteOrthogonalDecomposition: the sketch overhead dominates below roughly a few hundred rows/columns.
Public Member Functions | |
| RandCompleteOrthogonalDecomposition & | setBlockSize (Index b) |
| Sets the panel block size of the underlying randomized QR. | |
| RandCompleteOrthogonalDecomposition & | setSeed (uint64_t seed) |
| Fixes the RNG seed of the underlying randomized QR. | |
| RandCompleteOrthogonalDecomposition & | setThreshold (const RealScalar &threshold) |
| RandCompleteOrthogonalDecomposition & | setThreshold (Default_t) |
|
inline |
Sets the panel block size of the underlying randomized QR.
|
inline |
Fixes the RNG seed of the underlying randomized QR.
|
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&).