This class is a modification of Eigen's ColPivHouseholdeQR to perform a rank-revealing QR with column pivoting MP = QR with R*P' directly stored in the input matrix M and the householder vectors essential parts stored in the column of a different matrix given by the user. More...
#include <DestructiveColPivQR.hpp>
Public Types | |
enum | { RowsAtCompileTime = MatrixType::RowsAtCompileTime, ColsAtCompileTime = MatrixType::ColsAtCompileTime, MaxRowsAtCompileTime = MatrixType::MaxRowsAtCompileTime, MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime } |
typedef _MatrixType | MatrixType |
typedef MatrixType::Scalar | Scalar |
typedef MatrixType::RealScalar | RealScalar |
typedef MatrixType::Index | Index |
typedef _HouseholderStorageType | MatrixQType |
typedef Diagonal< MatrixQType, 0 > | HCoeffsType |
typedef PermutationMatrix < ColsAtCompileTime, MaxColsAtCompileTime, typename MatrixType::Index > | PermutationType |
typedef internal::plain_row_type < MatrixType, Index >::type | IntRowVectorType |
typedef internal::plain_row_type < MatrixType >::type | RowVectorType |
typedef internal::plain_row_type < MatrixType, RealScalar > ::type | RealRowVectorType |
typedef HouseholderSequence < MatrixQType, HCoeffsType > ::ConjugateReturnType | HouseholderSequenceType |
Public Member Functions | |
DestructiveColPivQR (MatrixType &matrix, MatrixQType &householderEssentialStorage, RealScalar epsilon=0.) | |
HouseholderSequenceType | householderQ (void) const |
const MatrixType & | matrixR () const |
DestructiveColPivQR & | compute (MatrixType &matrix, MatrixQType &householderEssentialStorage) |
DestructiveColPivQR & | compute () |
const PermutationType & | colsPermutation () const |
MatrixType::RealScalar | absDeterminant () const |
MatrixType::RealScalar | logAbsDeterminant () const |
Index | rank () const |
Index | dimensionOfKernel () const |
bool | isInjective () const |
bool | isSurjective () const |
bool | isInvertible () const |
Index | rows () const |
Index | cols () const |
const HCoeffsType & | hCoeffs () const |
DestructiveColPivQR & | setEpsilon (const RealScalar &epsilon) |
Allows to prescribe a threshold to be used by certain methods, such as rank(), who need to determine when pivots are to be considered nonzero. More... | |
DestructiveColPivQR & | setEpsilon (Default_t) |
Allows to come back to the default behavior, letting Eigen use its default formula for determining the threshold. More... | |
RealScalar | epsilon () const |
Returns the threshold that will be used by certain methods such as rank(). More... | |
Index | nonzeroPivots () const |
RealScalar | maxPivot () const |
This class is a modification of Eigen's ColPivHouseholdeQR to perform a rank-revealing QR with column pivoting MP = QR with R*P' directly stored in the input matrix M and the householder vectors essential parts stored in the column of a different matrix given by the user.
typedef Diagonal<MatrixQType, 0> Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::HCoeffsType |
typedef HouseholderSequence< MatrixQType, HCoeffsType>::ConjugateReturnType Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::HouseholderSequenceType |
typedef MatrixType::Index Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::Index |
typedef internal::plain_row_type<MatrixType, Index>::type Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::IntRowVectorType |
typedef _HouseholderStorageType Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::MatrixQType |
typedef _MatrixType Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::MatrixType |
typedef PermutationMatrix<ColsAtCompileTime, MaxColsAtCompileTime, typename MatrixType::Index> Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::PermutationType |
typedef internal::plain_row_type<MatrixType, RealScalar>::type Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::RealRowVectorType |
typedef MatrixType::RealScalar Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::RealScalar |
typedef internal::plain_row_type<MatrixType>::type Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::RowVectorType |
typedef MatrixType::Scalar Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::Scalar |
anonymous enum |
|
inline |
MatrixType::RealScalar Eigen::DestructiveColPivQR< MatrixType, HouseholderStrorageType >::absDeterminant | ( | ) | const |
References LOCAL_ABS.
|
inline |
|
inline |
|
inline |
DestructiveColPivQR< MatrixType, HouseholderStrorageType > & Eigen::DestructiveColPivQR< MatrixType, HouseholderStrorageType >::compute | ( | ) |
|
inline |
References Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::cols(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_isInitialized, and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::rank().
|
inline |
Returns the threshold that will be used by certain methods such as rank().
See the documentation of setThreshold(const RealScalar&).
References Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_prescribedEpsilon, Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_r, and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_usePrescribedEpsilon.
Referenced by Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::DestructiveColPivQR(), and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::setEpsilon().
|
inline |
DestructiveColPivQR< MatrixType, HouseholderStrorageType >::HouseholderSequenceType Eigen::DestructiveColPivQR< MatrixType, HouseholderStrorageType >::householderQ | ( | void | ) | const |
|
inline |
References Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::cols(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_isInitialized, and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::rank().
Referenced by Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::isInvertible().
|
inline |
References Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::isInjective(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::isSurjective(), and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_isInitialized.
|
inline |
References Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_isInitialized, Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::rank(), and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::rows().
Referenced by Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::isInvertible().
MatrixType::RealScalar Eigen::DestructiveColPivQR< MatrixType, HouseholderStrorageType >::logAbsDeterminant | ( | ) | const |
|
inline |
References Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_isInitialized, and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_r.
Referenced by soth::Stage::computeInitialCOD().
|
inline |
References Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_maxpivot.
|
inline |
References Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_isInitialized, and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_nonzero_pivots.
|
inline |
References Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_isInitialized, and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_nonzero_pivots.
Referenced by soth::Stage::computeInitialCOD(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::dimensionOfKernel(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::isInjective(), and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::isSurjective().
|
inline |
|
inline |
Allows to prescribe a threshold to be used by certain methods, such as rank(), who need to determine when pivots are to be considered nonzero.
This is not used for the QR decomposition itself.
When it needs to get the threshold value, Eigen calls threshold(). By default, this uses a formula to automatically determine a reasonable threshold. Once you have called the present method setThreshold(const RealScalar&), your value is used instead.
threshold | The new value to use as the threshold. |
A pivot will be considered nonzero if its absolute value is strictly greater than \( \vert pivot \vert \leqslant 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)
References Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::epsilon(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_prescribedEpsilon, and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_usePrescribedEpsilon.
|
inline |
Allows to come back to the default behavior, letting Eigen use its default formula for determining the threshold.
You should pass the special object Eigen::Default as parameter here.
See the documentation of setThreshold(const RealScalar&).
References Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::m_usePrescribedEpsilon.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Referenced by Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::colsPermutation(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::dimensionOfKernel(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::isInjective(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::isInvertible(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::isSurjective(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::matrixR(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::nonzeroPivots(), and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::rank().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Referenced by Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::cols(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::compute(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::epsilon(), Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::matrixR(), and Eigen::DestructiveColPivQR< _MatrixType, _HouseholderStorageType >::rows().
|
protected |
|
protected |