From 172000aaeb968198dcafbb22edc03377bb16f599 Mon Sep 17 00:00:00 2001
From: Gael Guennebaud <g.gael@free.fr>
Date: Tue, 22 Jul 2008 10:54:42 +0000
Subject: Add .perpendicular() function in Geometry module (adapted from
 Eigen1) Documentation:  * add an overview for each module.  * add an example
 for .all() and Cwise::operator<

---
 Eigen/Cholesky | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'Eigen/Cholesky')

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"
 
-- 
cgit v1.2.3