Document that JacobiSVD also handles complex matrices.

Thanks to 'Jazzdude' for noting this on IRC.
This commit is contained in:
Jitse Niesen 2012-01-26 13:16:50 +00:00
parent 0251bb6c1d
commit ed244e9c1a
2 changed files with 9 additions and 2 deletions

View File

@ -13,9 +13,9 @@ namespace Eigen {
* *
* *
* *
* This module provides SVD decomposition for (currently) real matrices. * This module provides SVD decomposition for matrices (both real and complex).
* This decomposition is accessible via the following MatrixBase method: * This decomposition is accessible via the following MatrixBase method:
* - MatrixBase::svd() * - MatrixBase::jacobiSvd()
* *
* \code * \code
* #include <Eigen/SVD> * #include <Eigen/SVD>

View File

@ -861,6 +861,13 @@ struct solve_retval<JacobiSVD<_MatrixType, QRPreconditioner>, Rhs>
}; };
} // end namespace internal } // 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> template<typename Derived>
JacobiSVD<typename MatrixBase<Derived>::PlainObject> JacobiSVD<typename MatrixBase<Derived>::PlainObject>
MatrixBase<Derived>::jacobiSvd(unsigned int computationOptions) const MatrixBase<Derived>::jacobiSvd(unsigned int computationOptions) const