diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2016-07-04 17:18:26 +0200 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2016-07-04 17:18:26 +0200 |
| commit | 7f7839c12f9bbd88bee1f3c9d7f5dbbe556045d4 (patch) | |
| tree | c589e0a09d130b532c8a6e374aa1ea657283ebf2 /Eigen/src/QR/FullPivHouseholderQR.h | |
| parent | 32a41ee659686fe1fb76156f7a55287acf14d4bb (diff) | |
Add documentation and exemples for inplace decomposition.
Diffstat (limited to 'Eigen/src/QR/FullPivHouseholderQR.h')
| -rw-r--r-- | Eigen/src/QR/FullPivHouseholderQR.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Eigen/src/QR/FullPivHouseholderQR.h b/Eigen/src/QR/FullPivHouseholderQR.h index 5c2f57d04..4c85a4693 100644 --- a/Eigen/src/QR/FullPivHouseholderQR.h +++ b/Eigen/src/QR/FullPivHouseholderQR.h @@ -50,6 +50,8 @@ struct traits<FullPivHouseholderQRMatrixQReturnType<MatrixType> > * This decomposition performs a very prudent full pivoting in order to be rank-revealing and achieve optimal * numerical stability. The trade-off is that it is slower than HouseholderQR and ColPivHouseholderQR. * + * This class supports the \link InplaceDecomposition inplace decomposition \endlink mechanism. + * * \sa MatrixBase::fullPivHouseholderQr() */ template<typename _MatrixType> class FullPivHouseholderQR @@ -136,7 +138,7 @@ template<typename _MatrixType> class FullPivHouseholderQR /** \brief Constructs a QR factorization from a given matrix * - * This overloaded constructor is provided for inplace solving when \c MatrixType is a Eigen::Ref. + * This overloaded constructor is provided for \link InplaceDecomposition inplace decomposition \endlink when \c MatrixType is a Eigen::Ref. * * \sa FullPivHouseholderQR(const EigenBase&) */ |