From 513c3729605a8d447d6f4b494851601601db70e4 Mon Sep 17 00:00:00 2001 From: Rasmus Munk Larsen Date: Mon, 4 Apr 2016 14:34:59 -0700 Subject: Fix docstrings to list all supported decompositions. --- Eigen/src/Core/ConditionEstimator.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'Eigen/src/Core') diff --git a/Eigen/src/Core/ConditionEstimator.h b/Eigen/src/Core/ConditionEstimator.h index 12b4ae648..35ec56128 100644 --- a/Eigen/src/Core/ConditionEstimator.h +++ b/Eigen/src/Core/ConditionEstimator.h @@ -53,9 +53,9 @@ struct SignOrUnity { * \returns an estimate of the reciprocal condition number * (1 / (||matrix||_1 * ||inv(matrix)||_1)) of matrix, given the matrix and * its decomposition. Supports the following decompositions: FullPivLU, - * PartialPivLU. + * PartialPivLU, LDLT, and LLT. * - * \sa FullPivLU, PartialPivLU. + * \sa FullPivLU, PartialPivLU, LDLT, LLT. */ template typename Decomposition::RealScalar ReciprocalConditionNumberEstimate( @@ -82,9 +82,9 @@ typename Decomposition::RealScalar ReciprocalConditionNumberEstimate( * \returns an estimate of the reciprocal condition number * (1 / (||matrix||_1 * ||inv(matrix)||_1)) of matrix, given ||matrix||_1 and * its decomposition. Supports the following decompositions: FullPivLU, - * PartialPivLU. + * PartialPivLU, LDLT, and LLT. * - * \sa FullPivLU, PartialPivLU. + * \sa FullPivLU, PartialPivLU, LDLT, LLT. */ template typename Decomposition::RealScalar ReciprocalConditionNumberEstimate( @@ -114,6 +114,10 @@ typename Decomposition::RealScalar ReciprocalConditionNumberEstimate( * The most common usage is in estimating the condition number * ||matrix||_1 * ||inv(matrix)||_1. The first term ||matrix||_1 can be * computed directly in O(n^2) operations. + * + * Supports the following decompositions: FullPivLU, PartialPivLU, LDLT, and LLT. + * + * \sa FullPivLU, PartialPivLU, LDLT, LLT. */ template typename Decomposition::RealScalar InverseMatrixL1NormEstimate( -- cgit v1.2.3