Comment cleanup v3: trailing ??, informal language, FIXME/TODO colons

libeigen/eigen!2197

Co-authored-by: Rasmus Munk Larsen <rmlarsen@gmail.com>
This commit is contained in:
Rasmus Munk Larsen
2026-02-22 21:20:08 -08:00
parent 112c2324bd
commit 78b76986b7
57 changed files with 90 additions and 89 deletions

View File

@@ -1,5 +1,5 @@
// This is a regression unit regarding a weird linking issue with gcc.
// This is a regression unit regarding an unusual linking issue with GCC.
#include "bug1213.h"

View File

@@ -635,7 +635,7 @@ inline bool verifyIsCwiseApprox(const Type1& a, const Type2& b, bool exact) {
// The idea behind this function is to compare the two scalars a and b where
// the scalar ref is a hint about the expected order of magnitude of a and b.
// WARNING: the scalar a and b must be positive
// Therefore, if for some reason a and b are very small compared to ref,
// Therefore, if a and b happen to be very small compared to ref,
// we won't issue a false negative.
// This test could be: abs(a-b) <= eps * ref
// However, it seems that simply comparing a+ref and b+ref is more sensitive to true error.

View File

@@ -127,7 +127,7 @@ inline T REF_FREXP(const T& x, T& exp) {
exp = static_cast<T>(iexp);
// The exponent value is unspecified if the input is inf or NaN, but MSVC
// seems to set it to 1. We need to set it back to zero for consistency.
// sets it to 1. We need to set it back to zero for consistency.
if (!(numext::isfinite)(x)) {
exp = T(0);
}

View File

@@ -43,7 +43,7 @@ void inverse_general_4x4(int repeat) {
double error_avg = error_sum / repeat;
EIGEN_DEBUG_VAR(error_avg);
EIGEN_DEBUG_VAR(error_max);
// FIXME that 1.25 used to be a 1.0 until the NumTraits changes on 28 April 2010, what's going wrong??
// FIXME: that 1.25 used to be 1.0 until the NumTraits changes on 28 April 2010.
// FIXME that 1.25 used to be 1.2 until we tested gcc 4.1 on 30 June 2010 and got 1.21.
VERIFY(error_avg < (NumTraits<Scalar>::IsComplex ? 8.0 : 1.25));
VERIFY(error_max < (NumTraits<Scalar>::IsComplex ? 64.0 : 20.0));

View File

@@ -14,7 +14,7 @@
// SafeScalar<T> is used to simulate custom Scalar types, which use a more generalized approach to generate random
// numbers
// For GCC-6, if this function is inlined then there seems to be an optimization
// For GCC-6, if this function is inlined then there is an optimization
// bug that triggers a failure. This failure goes away if you access `r` in
// in any way, and for any other compiler.
template <typename Scalar>