aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Cholesky/LLT.h
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2008-10-17 11:20:46 +0000
committerGravatar Gael Guennebaud <g.gael@free.fr>2008-10-17 11:20:46 +0000
commit727dfa1c439d02c712537bd19d891b1f0b23aa88 (patch)
treeb67bb6e6890bb3e4b8379d18b7906626d07f8260 /Eigen/src/Cholesky/LLT.h
parente747b338eec21cf1de664d257f0420485fd8e330 (diff)
fix some documentation issues
Diffstat (limited to 'Eigen/src/Cholesky/LLT.h')
-rw-r--r--Eigen/src/Cholesky/LLT.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/Eigen/src/Cholesky/LLT.h b/Eigen/src/Cholesky/LLT.h
index 8d4a1a752..16518b370 100644
--- a/Eigen/src/Cholesky/LLT.h
+++ b/Eigen/src/Cholesky/LLT.h
@@ -66,6 +66,7 @@ template<typename MatrixType> class LLT
compute(matrix);
}
+ /** \returns the lower triangular matrix L */
inline Part<MatrixType, Lower> matrixL(void) const { return m_matrix; }
/** \returns true if the matrix is positive definite */
@@ -129,13 +130,12 @@ void LLT<MatrixType>::compute(const MatrixType& a)
}
/** Computes the solution x of \f$ A x = b \f$ using the current decomposition of A.
- * The result is stored in \a bAndx
+ * The result is stored in \a result
*
* \returns true in case of success, false otherwise.
*
* In other words, it computes \f$ b = A^{-1} b \f$ with
* \f$ {L^{*}}^{-1} L^{-1} b \f$ from right to left.
- * \param bAndX stores both the matrix \f$ b \f$ and the result \f$ x \f$
*
* Example: \include LLT_solve.cpp
* Output: \verbinclude LLT_solve.out