Reformat file to compact style for more accurate line count

Author: XuhuaHuang

Scripts/wrap_doc_box_comment.py

@@ -0,0 +1,54 @@
+"""
+Locates a Visual Studio style comment block that starts at the beginning of a C++ file
+and wrap it around
+`// clang format off` and
+`// clang format on`
+"""
+
+import sys
+from pathlib import Path
+
+def wrap_top_box_comment_block(filename: str) -> None:
+    """
+    Wraps a Visual Studio style comment block around the specified file.
+
+    Args:
+        filename (str): File to format.
+    """
+    path = Path(filename)
+    if not path.exists():
+        print(f"File '{filename}' does not exist.")
+        return
+
+    lines = path.read_text(encoding="utf-8").splitlines()
+    output = []
+
+    i = 0
+    # Skip any leading blank lines
+    while i < len(lines) and lines[i].strip() == "":
+        output.append(lines[i])
+        i += 1
+
+    # Check if the next line starts with /* to begin a box-style comment
+    if i < len(lines) and lines[i].strip().startswith("/*"):
+        output.append("// clang-format off")
+        while i < len(lines):
+            output.append(lines[i])
+            if lines[i].strip().endswith("*/"):
+                i += 1
+                break
+            i += 1
+        output.append("// clang-format on")
+
+    # Append the rest of the file
+    output.extend(lines[i:])
+
+    # Save modified content
+    path.write_text("\n".join(output) + "\n", encoding="utf-8")
+    print(f"Wrapped top-level box comment in '{filename}'")
+
+if __name__ == "__main__":
+    if len(sys.argv) != 2:
+        print("Usage: python wrap_top_box_comment.py <source_file.cpp>")
+    else:
+        wrap_top_box_comment_block(sys.argv[1])

Util/ndarray/matrix_base_ext.hpp

@@ -1,56 +1,92 @@
+// clang-format off
 /*****************************************************************//**
  * \file   matrix_base_ext.hpp
  * \brief
  *
  * \author Xuhua Huang
  * \date   January 02, 2023
  *********************************************************************/
+// clang-format on
 
 #include <Eigen/Core>
 
-inline Scalar at(uint i, uint j) const { return this->operator()(i, j); }
-inline Scalar& at(uint i, uint j) { return this->operator()(i, j); }
-inline Scalar at(uint i) const { return this->operator[](i); }
-inline Scalar& at(uint i) { return this->operator[](i); }
+inline Scalar at(uint i, uint j) const {
+    return this->operator()(i, j);
+}
+inline Scalar& at(uint i, uint j) {
+    return this->operator()(i, j);
+}
+inline Scalar at(uint i) const {
+    return this->operator[](i);
+}
+inline Scalar& at(uint i) {
+    return this->operator[](i);
+}
 
-inline RealScalar squaredLength() const { return squaredNorm(); }
-inline RealScalar length() const { return norm(); }
-inline RealScalar invLength(void) const { return fast_inv_sqrt(squaredNorm()); }
+inline RealScalar squaredLength() const {
+    return squaredNorm();
+}
+inline RealScalar length() const {
+    return norm();
+}
+inline RealScalar invLength(void) const {
+    return fast_inv_sqrt(squaredNorm());
+}
 
-template<typename OtherDerived>
-inline Scalar squaredDistanceTo(const MatrixBase<OtherDerived>& other) const
-{
+template <typename OtherDerived>
+inline Scalar squaredDistanceTo(const MatrixBase<OtherDerived>& other) const {
     return (derived() - other.derived()).squaredNorm();
 }
 
-template<typename OtherDerived>
-inline RealScalar distanceTo(const MatrixBase<OtherDerived>& other) const
-{
+template <typename OtherDerived>
+inline RealScalar distanceTo(const MatrixBase<OtherDerived>& other) const {
     return internal::sqrt(derived().squaredDistanceTo(other));
 }
 
-inline void scaleTo(RealScalar l) { RealScalar vl = norm(); if (vl > 1e-9) derived() *= (l / vl); }
+inline void scaleTo(RealScalar l) {
+    RealScalar vl = norm();
+    if (vl > 1e-9)
+        derived() *= (l / vl);
+}
 
-inline Transpose<Derived> transposed() { return this->transpose(); }
-inline const Transpose<Derived> transposed() const { return this->transpose(); }
+inline Transpose<Derived> transposed() {
+    return this->transpose();
+}
+inline const Transpose<Derived> transposed() const {
+    return this->transpose();
+}
 
-inline uint minComponentId(void) const { int i; this->minCoeff(&i); return i; }
-inline uint maxComponentId(void) const { int i; this->maxCoeff(&i); return i; }
+inline uint minComponentId(void) const {
+    int i;
+    this->minCoeff(&i);
+    return i;
+}
+inline uint maxComponentId(void) const {
+    int i;
+    this->maxCoeff(&i);
+    return i;
+}
 
-template<typename OtherDerived>
-void makeFloor(const MatrixBase<OtherDerived>& other) { derived() = derived().cwiseMin(other.derived()); }
+template <typename OtherDerived>
+void makeFloor(const MatrixBase<OtherDerived>& other) {
+    derived() = derived().cwiseMin(other.derived());
+}
 
-template<typename OtherDerived>
-void makeCeil(const MatrixBase<OtherDerived>& other) { derived() = derived().cwiseMax(other.derived()); }
+template <typename OtherDerived>
+void makeCeil(const MatrixBase<OtherDerived>& other) {
+    derived() = derived().cwiseMax(other.derived());
+}
 
 const CwiseBinaryOp<internal::scalar_sum_op<Scalar>, const Derived, const ConstantReturnType>
-operator+(const Scalar& scalar) const
-{
-    return CwiseBinaryOp<internal::scalar_sum_op<Scalar>, const Derived, const ConstantReturnType>(derived(), Constant(rows(), cols(), scalar));
+operator+(const Scalar& scalar) const {
+    return CwiseBinaryOp<internal::scalar_sum_op<Scalar>, const Derived, const ConstantReturnType>(
+        derived(), Constant(rows(), cols(), scalar)
+    );
 }
 
 friend const CwiseBinaryOp<internal::scalar_sum_op<Scalar>, const ConstantReturnType, Derived>
-operator+(const Scalar& scalar, const MatrixBase<Derived>& mat)
-{
-    return CwiseBinaryOp<internal::scalar_sum_op<Scalar>, const ConstantReturnType, Derived>(Constant(rows(), cols(), scalar), mat.derived());
+operator+(const Scalar& scalar, const MatrixBase<Derived>& mat) {
+    return CwiseBinaryOp<internal::scalar_sum_op<Scalar>, const ConstantReturnType, Derived>(
+        Constant(rows(), cols(), scalar), mat.derived()
+    );
 }