aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/LU/FullPivLU.h
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2016-07-04 17:18:26 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2016-07-04 17:18:26 +0200
commit7f7839c12f9bbd88bee1f3c9d7f5dbbe556045d4 (patch)
treec589e0a09d130b532c8a6e374aa1ea657283ebf2 /Eigen/src/LU/FullPivLU.h
parent32a41ee659686fe1fb76156f7a55287acf14d4bb (diff)
Add documentation and exemples for inplace decomposition.
Diffstat (limited to 'Eigen/src/LU/FullPivLU.h')
-rw-r--r--Eigen/src/LU/FullPivLU.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/Eigen/src/LU/FullPivLU.h b/Eigen/src/LU/FullPivLU.h
index 113b8c7b8..1632d3ac3 100644
--- a/Eigen/src/LU/FullPivLU.h
+++ b/Eigen/src/LU/FullPivLU.h
@@ -52,6 +52,8 @@ template<typename _MatrixType> struct traits<FullPivLU<_MatrixType> >
* \include class_FullPivLU.cpp
* Output: \verbinclude class_FullPivLU.out
*
+ * This class supports the \link InplaceDecomposition inplace decomposition \endlink mechanism.
+ *
* \sa MatrixBase::fullPivLu(), MatrixBase::determinant(), MatrixBase::inverse()
*/
template<typename _MatrixType> class FullPivLU
@@ -99,7 +101,7 @@ template<typename _MatrixType> class FullPivLU
/** \brief Constructs a LU 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 FullPivLU(const EigenBase&)
*/