mirror/eigen
2
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2024-12-21 07:19:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix docstrings to list all supported decompositions.

Browse Source
This commit is contained in:
Rasmus Munk Larsen 2016-04-04 14:34:59 -07:00
parent 86e0ed81f8
commit 513c372960
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Eigen/src/Core/ConditionEstimator.h
View File

@ -53,9 +53,9 @@ struct SignOrUnity<Vector, Vector, false> {
* \returns an estimate of the reciprocal condition number * \returns an estimate of the reciprocal condition number
* (1 / (||matrix||_1 * ||inv(matrix)||_1)) of matrix, given the matrix and * (1 / (||matrix||_1 * ||inv(matrix)||_1)) of matrix, given the matrix and
* its decomposition. Supports the following decompositions: FullPivLU, * its decomposition. Supports the following decompositions: FullPivLU,
* PartialPivLU. * PartialPivLU, LDLT, and LLT.
* *
* \sa FullPivLU, PartialPivLU. * \sa FullPivLU, PartialPivLU, LDLT, LLT.
*/ */
template <typename Decomposition> template <typename Decomposition>
typename Decomposition::RealScalar ReciprocalConditionNumberEstimate( typename Decomposition::RealScalar ReciprocalConditionNumberEstimate(
@ -82,9 +82,9 @@ typename Decomposition::RealScalar ReciprocalConditionNumberEstimate(
* \returns an estimate of the reciprocal condition number * \returns an estimate of the reciprocal condition number
* (1 / (||matrix||_1 * ||inv(matrix)||_1)) of matrix, given ||matrix||_1 and * (1 / (||matrix||_1 * ||inv(matrix)||_1)) of matrix, given ||matrix||_1 and
* its decomposition. Supports the following decompositions: FullPivLU, * its decomposition. Supports the following decompositions: FullPivLU,
* PartialPivLU. * PartialPivLU, LDLT, and LLT.
* *
* \sa FullPivLU, PartialPivLU. * \sa FullPivLU, PartialPivLU, LDLT, LLT.
*/ */
template <typename Decomposition> template <typename Decomposition>
typename Decomposition::RealScalar ReciprocalConditionNumberEstimate( typename Decomposition::RealScalar ReciprocalConditionNumberEstimate(
@ -114,6 +114,10 @@ typename Decomposition::RealScalar ReciprocalConditionNumberEstimate(
* The most common usage is in estimating the condition number * The most common usage is in estimating the condition number
* ||matrix||_1 * ||inv(matrix)||_1. The first term ||matrix||_1 can be * ||matrix||_1 * ||inv(matrix)||_1. The first term ||matrix||_1 can be
* computed directly in O(n^2) operations. * computed directly in O(n^2) operations.
*
* Supports the following decompositions: FullPivLU, PartialPivLU, LDLT, and LLT.
*
* \sa FullPivLU, PartialPivLU, LDLT, LLT.
*/ */
template <typename Decomposition> template <typename Decomposition>
typename Decomposition::RealScalar InverseMatrixL1NormEstimate( typename Decomposition::RealScalar InverseMatrixL1NormEstimate(