Document (non)sorting of eigenvalues.

Also, update docs for (Generalized)SelfAdjointEigenSolver to reflect that these
two classes were split apart.
This commit is contained in:
Jitse Niesen
2011-02-27 14:06:55 +00:00
parent 58abf0eb98
commit a8f5ef9388
5 changed files with 22 additions and 26 deletions

View File

@@ -186,7 +186,8 @@ template<typename _MatrixType> class ComplexEigenSolver
* This function returns a column vector containing the
* eigenvalues. Eigenvalues are repeated according to their
* algebraic multiplicity, so there are as many eigenvalues as
* rows in the matrix.
* rows in the matrix. The eigenvalues are not sorted in any particular
* order.
*
* Example: \include ComplexEigenSolver_eigenvalues.cpp
* Output: \verbinclude ComplexEigenSolver_eigenvalues.out