From 59f94004202f534f7693c29b55516a9b495ffe4d Mon Sep 17 00:00:00 2001 From: Desire NUENTSA Date: Thu, 21 Feb 2013 13:33:31 +0100 Subject: [PATCH] Clarify the doc for column-pivoting QR --- Eigen/src/QR/ColPivHouseholderQR.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Eigen/src/QR/ColPivHouseholderQR.h b/Eigen/src/QR/ColPivHouseholderQR.h index bca0ede61..8c1d8349c 100644 --- a/Eigen/src/QR/ColPivHouseholderQR.h +++ b/Eigen/src/QR/ColPivHouseholderQR.h @@ -146,8 +146,9 @@ template class ColPivHouseholderQR return m_qr; } - /** \returns a reference to the matrix where the Householder QR is stored - * To get the triangular factor R, use + /** \returns a reference to the matrix where the result Householder QR is stored + * \warning The strict lower part of this matrix contains internal values. + * Only the upper triangular part should be referenced. To get it, use * \code matrixR().template triangularView() \endcode * For rank-deficient matrices, use * \code @@ -353,9 +354,9 @@ template class ColPivHouseholderQR /** \brief Reports whether the QR factorization was succesful. * - * \note This routine is provided for uniformity with other factorization modules - * \returns \c Success if computation was succesful, - * \c NumericalIssue if the QR can not be computed + * \note This function always returns \c Success. It is provided for compatibility + * with other factorization routines. + * \returns \c Success */ ComputationInfo info() const { @@ -371,7 +372,6 @@ template class ColPivHouseholderQR RowVectorType m_temp; RealRowVectorType m_colSqNorms; bool m_isInitialized, m_usePrescribedThreshold; - mutable ComputationInfo m_info; RealScalar m_prescribedThreshold, m_maxpivot; Index m_nonzero_pivots; Index m_det_pq;