aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/Jacobi
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2009-09-03 11:17:16 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2009-09-03 11:17:16 +0200
commit16c7b1daabd2697950605706a8bc68ae32d70fc8 (patch)
tree3662a984cd9847c0e7a1a8eb46b8454ad9d6ce69 /Eigen/Jacobi
parentc893917d65724aee15cad8c2d5d711d991c361c9 (diff)
add examples for makeJacobi and makeGivens
Diffstat (limited to 'Eigen/Jacobi')
-rw-r--r--Eigen/Jacobi6
1 files changed, 5 insertions, 1 deletions
diff --git a/Eigen/Jacobi b/Eigen/Jacobi
index 33a6b757e..da67d2a6a 100644
--- a/Eigen/Jacobi
+++ b/Eigen/Jacobi
@@ -8,11 +8,15 @@
namespace Eigen {
/** \defgroup Jacobi_Module Jacobi module
- * This module provides Jacobi rotations.
+ * This module provides Jacobi and Givens rotations.
*
* \code
* #include <Eigen/Jacobi>
* \endcode
+ *
+ * In addition to listed classes, it defines the two following MatrixBase methods to apply a Jacobi or Givens rotation:
+ * - MatrixBase::applyOnTheLeft()
+ * - MatrixBase::applyOnTheRight().
*/
#include "src/Jacobi/Jacobi.h"