mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-06-04 18:54:00 +08:00
Document that JacobiSVD also handles complex matrices.
Thanks to 'Jazzdude' for noting this on IRC.
This commit is contained in:
parent
0251bb6c1d
commit
ed244e9c1a
@ -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>
|
||||||
|
@ -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
|
||||||
|
Loading…
x
Reference in New Issue
Block a user