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/HouseholderQR.h | |
| parent | 32a41ee659686fe1fb76156f7a55287acf14d4bb (diff) | |
Add documentation and exemples for inplace decomposition.
Diffstat (limited to 'Eigen/src/QR/HouseholderQR.h')
| -rw-r--r-- | Eigen/src/QR/HouseholderQR.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Eigen/src/QR/HouseholderQR.h b/Eigen/src/QR/HouseholderQR.h index f2a9cc080..2e64fa7fe 100644 --- a/Eigen/src/QR/HouseholderQR.h +++ b/Eigen/src/QR/HouseholderQR.h @@ -37,6 +37,8 @@ namespace Eigen { * This Householder QR decomposition is faster, but less numerically stable and less feature-full than * FullPivHouseholderQR or ColPivHouseholderQR. * + * This class supports the \link InplaceDecomposition inplace decomposition \endlink mechanism. + * * \sa MatrixBase::householderQr() */ template<typename _MatrixType> class HouseholderQR @@ -104,7 +106,7 @@ template<typename _MatrixType> class HouseholderQR /** \brief Constructs a QR factorization from a given matrix * - * This overloaded constructor is provided for inplace solving when + * This overloaded constructor is provided for \link InplaceDecomposition inplace decomposition \endlink when * \c MatrixType is a Eigen::Ref. * * \sa HouseholderQR(const EigenBase&) |