aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/QR
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/QR
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/QR')
-rw-r--r--Eigen/QR12
1 files changed, 12 insertions, 0 deletions
diff --git a/Eigen/QR b/Eigen/QR
index cf4a8d15f..3ed9204b1 100644
--- a/Eigen/QR
+++ b/Eigen/QR
@@ -15,6 +15,18 @@
namespace Eigen {
+/** \defgroup QR_Module QR module
+ * This module mainly provides QR decomposition and an eigen value solver.
+ * This module also provides some MatrixBase methods, including:
+ * - MatrixBase::qr(),
+ * - MatrixBase::eigenvalues(),
+ * - MatrixBase::matrixNorm()
+ *
+ * \code
+ * #include <Eigen/QR>
+ * \endcode
+ */
+
#include "src/QR/QR.h"
#include "src/QR/Tridiagonalization.h"
#include "src/QR/EigenSolver.h"