From b9e2b4f6f584f443339e1f68e9bee63c85547c37 Mon Sep 17 00:00:00 2001 From: Jitse Niesen Date: Thu, 26 Jan 2012 13:16:50 +0000 Subject: [PATCH] Document that JacobiSVD also handles complex matrices. Thanks to 'Jazzdude' for noting this on IRC. (transplanted from ed244e9c1ad18ea77596e6ece2fec3b02529d369 ) --- Eigen/SVD | 4 ++-- Eigen/src/SVD/JacobiSVD.h | 7 +++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/Eigen/SVD b/Eigen/SVD index d24471fd7..7c987a9dd 100644 --- a/Eigen/SVD +++ b/Eigen/SVD @@ -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: - * - MatrixBase::svd() + * - MatrixBase::jacobiSvd() * * \code * #include diff --git a/Eigen/src/SVD/JacobiSVD.h b/Eigen/src/SVD/JacobiSVD.h index c2326d752..3c423095c 100644 --- a/Eigen/src/SVD/JacobiSVD.h +++ b/Eigen/src/SVD/JacobiSVD.h @@ -708,6 +708,13 @@ struct solve_retval, Rhs> }; } // end namespace internal +/** \svd_module + * + * \return the singular value decomposition of \c *this computed by two-sided + * Jacobi transformations. + * + * \sa class JacobiSVD + */ template JacobiSVD::PlainObject> MatrixBase::jacobiSvd(unsigned int computationOptions) const