aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Cholesky
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2017-08-22 14:12:47 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2017-08-22 14:12:47 +0200
commitb223918ea99dcff9f6a3f8d017e7bd79ff4a7db7 (patch)
tree6e4d163959011d3467d35b51df49c8fd992bb923 /Eigen/src/Cholesky
parent0c226644d8cf21d35cfcf46c60ce66d2183f530e (diff)
Doc: warn about constness in LLT::solveInPlace
Diffstat (limited to 'Eigen/src/Cholesky')
-rw-r--r--Eigen/src/Cholesky/LLT.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/Eigen/src/Cholesky/LLT.h b/Eigen/src/Cholesky/LLT.h
index 152837bfd..814174d47 100644
--- a/Eigen/src/Cholesky/LLT.h
+++ b/Eigen/src/Cholesky/LLT.h
@@ -489,6 +489,9 @@ void LLT<_MatrixType,_UpLo>::_solve_impl(const RhsType &rhs, DstType &dst) const
*
* This version avoids a copy when the right hand side matrix b is not needed anymore.
*
+ * \warning The parameter is only marked 'const' to make the C++ compiler accept a temporary expression here.
+ * This function will const_cast it, so constness isn't honored here.
+ *
* \sa LLT::solve(), MatrixBase::llt()
*/
template<typename MatrixType, int _UpLo>