GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-09-17 03:43:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

JacobiSVD doc fix

Browse Source
This commit is contained in:
Benoit Jacob 2010-10-14 10:17:40 -04:00
parent 8f0e80fe30
commit 65c01e2bf7
1 changed files with 4 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Eigen/src/SVD/JacobiSVD.h
View File

@ -310,14 +310,9 @@ template<typename _MatrixType, int QRPreconditioner> class JacobiSVD
* \param computationOptions optional parameter allowing to specify if you want full or thin U or V unitaries to be computed. * \param computationOptions optional parameter allowing to specify if you want full or thin U or V unitaries to be computed.
* By default, none is computed. This is a bit-field, the possible bits are ComputeFullU, ComputeThinU, * By default, none is computed. This is a bit-field, the possible bits are ComputeFullU, ComputeThinU,
* ComputeFullV, ComputeThinV. * ComputeFullV, ComputeThinV.
*
* Thin unitaries are not available with the default FullPivHouseholderQRPreconditioner, see class documentation for details.
* If you want thin unitaries, use another preconditioner, for example:
* \code
* JacobiSVD<MatrixXf, ColPivHouseholderQRPreconditioner> svd(matrix, ComputeThinU);
* \endcode
* *
* Thin unitaries also are only available if your matrix type has a Dynamic number of columns (for example MatrixXf). * Thin unitaries are only available if your matrix type has a Dynamic number of columns (for example MatrixXf). They also are not
* available with the (non-default) FullPivHouseholderQR preconditioner.
*/ */
JacobiSVD(const MatrixType& matrix, unsigned int computationOptions = 0) JacobiSVD(const MatrixType& matrix, unsigned int computationOptions = 0)
{ {
@ -331,13 +326,8 @@ template<typename _MatrixType, int QRPreconditioner> class JacobiSVD
* By default, none is computed. This is a bit-field, the possible bits are ComputeFullU, ComputeThinU, * By default, none is computed. This is a bit-field, the possible bits are ComputeFullU, ComputeThinU,
* ComputeFullV, ComputeThinV. * ComputeFullV, ComputeThinV.
* *
* Thin unitaries are not available with the default FullPivHouseholderQRPreconditioner, see class documentation for details. * Thin unitaries are only available if your matrix type has a Dynamic number of columns (for example MatrixXf). They also are not
* If you want thin unitaries, use another preconditioner, for example: * available with the (non-default) FullPivHouseholderQR preconditioner.
* \code
* JacobiSVD<MatrixXf, ColPivHouseholderQRPreconditioner> svd(matrix, ComputeThinU);
* \endcode
*
* Thin unitaries also are only available if your matrix type has a Dynamic number of columns (for example MatrixXf).
*/ */
JacobiSVD& compute(const MatrixType& matrix, unsigned int computationOptions = 0); JacobiSVD& compute(const MatrixType& matrix, unsigned int computationOptions = 0);