Clean up informal language, vague TODOs, and dead code in comments

libeigen/eigen!2191

Co-authored-by: Rasmus Munk Larsen <rmlarsen@gmail.com>
This commit is contained in:
Rasmus Munk Larsen
2026-02-22 18:32:10 -08:00
parent 7d727d26bc
commit d5e67adbe7
63 changed files with 136 additions and 161 deletions

View File

@@ -257,8 +257,8 @@ void alignedboxRotatable(const BoxType& box,
// box((-3, -2, -2), (-1, 0, 0))
IsometryTransform tf2 = IsometryTransform::Identity();
// for some weird reason the following statement has to be put separate from
// the following rotate call, otherwise precision problems arise...
// The following statement must be separate from the rotate call below,
// otherwise precision problems arise.
Rotation rot = rotate(NonInteger(EIGEN_PI));
tf2.rotate(rot);

View File

@@ -356,7 +356,7 @@ void check_indexed_view() {
VERIFY_IS_CWISE_EQUAL(R_ref(eigen_matrix_rows, eigen_matrix_cols), R_ref(c_array_rows, c_array_cols));
}
// check mat(i,j) with weird types for i and j
// check mat(i,j) with unusual types for i and j
{
VERIFY_IS_APPROX(A(B.RowsAtCompileTime - 1, 1), A(3, 1));
VERIFY_IS_APPROX(A(B.RowsAtCompileTime, 1), A(4, 1));
@@ -420,7 +420,7 @@ void check_indexed_view() {
// check symbolic indices
a(last) = 1.0;
A(last, last) = 1;
// check weird non-const, non-lvalue scenarios
// check unusual non-const, non-lvalue scenarios
{
// in these scenarios, the objects are not declared 'const', and the compiler will attempt to use the non-const
// overloads without intervention

View File

@@ -271,7 +271,7 @@ void nullary_internal_logic() {
VERIFY((!internal::has_binary_operator<internal::linspaced_op<float> >::value));
VERIFY((internal::functor_has_linear_access<internal::linspaced_op<float> >::ret));
// Regression unit test for a weird MSVC bug.
// Regression unit test for an MSVC bug.
// Search "nullary_wrapper_workaround_msvc" in CoreEvaluators.h for the details.
// See also traits<Ref>::match.
{

View File

@@ -124,7 +124,7 @@ void svd_least_square(const MatrixType& m) {
if (internal::is_same<RealScalar, double>::value || svd.rank() == m.diagonal().size()) {
using std::sqrt;
// This test is not stable with single precision.
// This is probably because squaring m signicantly affects the precision.
// This is likely because squaring m significantly affects the precision.
if (internal::is_same<RealScalar, float>::value) ++g_test_level;
VERIFY_IS_APPROX(m.adjoint() * (m * x), m.adjoint() * rhs);