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

@@ -247,7 +247,7 @@ struct homogeneous_left_product_impl<Homogeneous<MatrixType, Vertical>, Lhs>
template <typename Dest>
EIGEN_DEVICE_FUNC void evalTo(Dest& dst) const {
// FIXME investigate how to allow lazy evaluation of this product when possible
// FIXME: investigate how to allow lazy evaluation of this product when possible.
dst = Block < const LhsMatrixTypeNested, LhsMatrixTypeNested::RowsAtCompileTime,
LhsMatrixTypeNested::ColsAtCompileTime == Dynamic
? Dynamic
@@ -278,7 +278,7 @@ struct homogeneous_right_product_impl<Homogeneous<MatrixType, Horizontal>, Rhs>
template <typename Dest>
EIGEN_DEVICE_FUNC void evalTo(Dest& dst) const {
// FIXME investigate how to allow lazy evaluation of this product when possible
// FIXME: investigate how to allow lazy evaluation of this product when possible.
dst = m_lhs * Block < const RhsNested,
RhsNested::RowsAtCompileTime == Dynamic ? Dynamic : RhsNested::RowsAtCompileTime - 1,
RhsNested::ColsAtCompileTime > (m_rhs, 0, 0, m_rhs.rows() - 1, m_rhs.cols());
@@ -392,8 +392,7 @@ struct generic_product_impl<Lhs, Homogeneous<RhsArg, Vertical>, DenseShape, Homo
}
};
// TODO: the following specialization is to address a regression from 3.2 to 3.3
// In the future, this path should be optimized.
// TODO: this specialization addresses a performance regression from 3.2 to 3.3; optimize this path.
template <typename Lhs, typename RhsArg, int ProductTag>
struct generic_product_impl<Lhs, Homogeneous<RhsArg, Vertical>, TriangularShape, HomogeneousShape, ProductTag> {
template <typename Dest>

View File

@@ -111,7 +111,7 @@ class Hyperplane {
* If the dimension of the ambient space is greater than 2, then there isn't uniqueness,
* so an arbitrary choice is made.
*/
// FIXME to be consistent with the rest this could be implemented as a static Through function ??
// FIXME: for consistency, consider implementing as a static Through function.
EIGEN_DEVICE_FUNC explicit Hyperplane(const ParametrizedLine<Scalar, AmbientDimAtCompileTime>& parametrized) {
normal() = parametrized.direction().unitOrthogonal();
offset() = -parametrized.origin().dot(normal());

View File

@@ -790,7 +790,7 @@ EIGEN_DEVICE_FUNC Quaternion<Scalar, Options> Quaternion<Scalar, Options>::FromT
template <class Derived>
EIGEN_DEVICE_FUNC inline Quaternion<typename internal::traits<Derived>::Scalar> QuaternionBase<Derived>::inverse()
const {
// FIXME should this function be called multiplicativeInverse and conjugate() be called inverse() or opposite() ??
// FIXME: consider renaming to multiplicativeInverse() and renaming conjugate() to inverse() or opposite().
Scalar n2 = this->squaredNorm();
if (n2 > Scalar(0))
return Quaternion<Scalar>(conjugate().coeffs() / n2);

View File

@@ -80,7 +80,7 @@ class UniformScaling {
}
/** Concatenates a uniform scaling and a linear transformation matrix */
// TODO returns an expression
// TODO: return an expression instead of a dense matrix.
template <typename Derived>
inline typename Eigen::internal::plain_matrix_type<Derived>::type operator*(const MatrixBase<Derived>& other) const {
return other * m_factor;