diff options
| author |  Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-02-27 14:06:55 +0000 |
|---|---|---|
| committer | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-02-27 14:06:55 +0000 |
| commit | a8f5ef93880e422db26c202ef514b7a796498e9f (patch) | |
| tree | 085bcd22287caf7daf163ecfaa8df6016a900fb3 /Eigen/src/Eigenvalues/EigenSolver.h | |
| parent | 58abf0eb98db7dc5f31e499c86d4e464a826ee99 (diff) | |
Document (non)sorting of eigenvalues.
Also, update docs for (Generalized)SelfAdjointEigenSolver to reflect that these
two classes were split apart.
Diffstat (limited to 'Eigen/src/Eigenvalues/EigenSolver.h')
| -rw-r--r-- | Eigen/src/Eigenvalues/EigenSolver.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Eigen/src/Eigenvalues/EigenSolver.h b/Eigen/src/Eigenvalues/EigenSolver.h index 5a59ccbd4..b3594655a 100644 --- a/Eigen/src/Eigenvalues/EigenSolver.h +++ b/Eigen/src/Eigenvalues/EigenSolver.h @@ -228,6 +228,7 @@ template<typename _MatrixType> class EigenSolver * block-diagonal. The blocks on the diagonal are either 1-by-1 or 2-by-2 * blocks of the form * \f$ \begin{bmatrix} u & v \\ -v & u \end{bmatrix} \f$. + * These blocks are not sorted in any particular order. * The matrix \f$ D \f$ and the matrix \f$ V \f$ returned by * pseudoEigenvectors() satisfy \f$ AV = VD \f$. * @@ -244,7 +245,8 @@ template<typename _MatrixType> class EigenSolver * compute(const MatrixType&, bool) has been called before. * * The eigenvalues are repeated according to their algebraic multiplicity, - * so there are as many eigenvalues as rows in the matrix. + * so there are as many eigenvalues as rows in the matrix. The eigenvalues + * are not sorted in any particular order. * * Example: \include EigenSolver_eigenvalues.cpp * Output: \verbinclude EigenSolver_eigenvalues.out |