template<typename Derived>
class Eigen::RankRevealingBase< Derived >
CRTP mixin providing threshold management, rank computation, and rank-derived queries for rank-revealing decompositions (FullPivLU, ColPivHouseholderQR, FullPivHouseholderQR).
- Template Parameters
-
| Derived | the concrete decomposition class (CRTP parameter) |
The derived class must provide:
- rows(), cols() (inherited from SolverBase)
- m_isInitialized (bool member, also used by SolverBase)
- pivotCoeff(Index i) returning the absolute value of the i-th pivot
template<typename Derived>
Allows to prescribe a threshold to be used by certain methods, such as rank(), which need to determine when pivots are to be considered nonzero. This is not used for the decomposition itself, except by CompleteOrthogonalDecomposition, whose rank is determined by compute().
When it needs to get the threshold value, Eigen calls threshold(). By default, this is \( 4 \, \min(rows, cols) \, \epsilon \), where \( \epsilon \) is NumTraits<Scalar>::epsilon() and rows and cols are the dimensions of the decomposed matrix. Once you have called the present method setThreshold(const RealScalar&), your value is used instead.
- Parameters
-
| threshold | The new value to use as the threshold. |
A pivot will be considered nonzero if its absolute value is strictly greater than \( threshold \times \vert maxpivot \vert \) where maxpivot is the biggest pivot.
If you want to come back to the default behavior, call setThreshold(Default_t)