aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/Cholesky
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2008-07-22 10:54:42 +0000
committerGravatar Gael Guennebaud <g.gael@free.fr>2008-07-22 10:54:42 +0000
commit172000aaeb968198dcafbb22edc03377bb16f599 (patch)
tree02f2531123f8a3a3f21a5ce7eaa15ab1d24d05af /Eigen/Cholesky
parent516db2c3b97345553c3489681fba67f52a8eda6b (diff)
Add .perpendicular() function in Geometry module (adapted from Eigen1)
Documentation: * add an overview for each module. * add an example for .all() and Cwise::operator<
Diffstat (limited to 'Eigen/Cholesky')
-rw-r--r--Eigen/Cholesky11
1 files changed, 11 insertions, 0 deletions
diff --git a/Eigen/Cholesky b/Eigen/Cholesky
index d4b487ce7..a0d4311f9 100644
--- a/Eigen/Cholesky
+++ b/Eigen/Cholesky
@@ -14,6 +14,17 @@
namespace Eigen {
+/** \defgroup Cholesky_Module Cholesky module
+ * This module provides two variants of the Cholesky decomposition for selfadjoint (hermitian) matrices.
+ * Those decompositions are accessible via the following MatrixBase methods:
+ * - MatrixBase::cholesky(),
+ * - MatrixBase::choleskyNoSqrt()
+ *
+ * \code
+ * #include <Eigen/Cholesky>
+ * \endcode
+ */
+
#include "src/Cholesky/Cholesky.h"
#include "src/Cholesky/CholeskyWithoutSquareRoot.h"