diff options
| author |  Jitse Niesen <jitse@maths.leeds.ac.uk> | 2012-01-26 13:16:50 +0000 |
|---|---|---|
| committer | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2012-01-26 13:16:50 +0000 |
| commit | ed244e9c1ad18ea77596e6ece2fec3b02529d369 (patch) | |
| tree | 14c30516bdeefc12e74b538d8a2fd2f5b8a63940 /Eigen/src/SVD | |
| parent | 0251bb6c1d2da1d4a685bc118cb5bc774c9dbc30 (diff) | |
Document that JacobiSVD also handles complex matrices.
Thanks to 'Jazzdude' for noting this on IRC.
Diffstat (limited to 'Eigen/src/SVD')
| -rw-r--r-- | Eigen/src/SVD/JacobiSVD.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Eigen/src/SVD/JacobiSVD.h b/Eigen/src/SVD/JacobiSVD.h index 3daa29df5..f9b25da7e 100644 --- a/Eigen/src/SVD/JacobiSVD.h +++ b/Eigen/src/SVD/JacobiSVD.h @@ -861,6 +861,13 @@ struct solve_retval<JacobiSVD<_MatrixType, QRPreconditioner>, Rhs> }; } // end namespace internal +/** \svd_module + * + * \return the singular value decomposition of \c *this computed by two-sided + * Jacobi transformations. + * + * \sa class JacobiSVD + */ template<typename Derived> JacobiSVD<typename MatrixBase<Derived>::PlainObject> MatrixBase<Derived>::jacobiSvd(unsigned int computationOptions) const |