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/GeneralizedSelfAdjointEigenSolver.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/GeneralizedSelfAdjointEigenSolver.h')
-rw-r--r-- | Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h | 13 |
1 files changed, 4 insertions, 9 deletions
diff --git a/Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h b/Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h index a19e8cf24..a0ece70c4 100644 --- a/Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h +++ b/Eigen/src/Eigenvalues/GeneralizedSelfAdjointEigenSolver.h @@ -70,13 +70,9 @@ class GeneralizedSelfAdjointEigenSolver : public SelfAdjointEigenSolver<_MatrixT /** \brief Default constructor for fixed-size matrices. * * The default constructor is useful in cases in which the user intends to - * perform decompositions via compute(const MatrixType&, bool) or - * compute(const MatrixType&, const MatrixType&, bool). This constructor + * perform decompositions via compute(). This constructor * can only be used if \p _MatrixType is a fixed-size matrix; use - * SelfAdjointEigenSolver(Index) for dynamic-size matrices. - * - * Example: \include SelfAdjointEigenSolver_SelfAdjointEigenSolver.cpp - * Output: \verbinclude SelfAdjointEigenSolver_SelfAdjointEigenSolver.out + * GeneralizedSelfAdjointEigenSolver(Index) for dynamic-size matrices. */ GeneralizedSelfAdjointEigenSolver() : Base() {} @@ -86,12 +82,11 @@ class GeneralizedSelfAdjointEigenSolver : public SelfAdjointEigenSolver<_MatrixT * eigenvalues and eigenvectors will be computed. * * This constructor is useful for dynamic-size matrices, when the user - * intends to perform decompositions via compute(const MatrixType&, bool) - * or compute(const MatrixType&, const MatrixType&, bool). The \p size + * intends to perform decompositions via compute(). The \p size * parameter is only used as a hint. It is not an error to give a wrong * \p size, but it may impair performance. * - * \sa compute(const MatrixType&, bool) for an example + * \sa compute() for an example */ GeneralizedSelfAdjointEigenSolver(Index size) : Base(size) |