quality: 2 new gates (cmake-format, codespell) + SPDX rollout (60 files)
Some checks failed
C++ Tests / test-fast (pull_request) Successful in 2m2s
API Docs / doc-build (pull_request) Successful in 58s
Markdown link check / check (pull_request) Successful in 45s
C++ Tests / test-cgal (pull_request) Failing after 13m14s

This commit closes the remaining red gates so `run-all.sh --fast` is
green end-to-end on the canonical dev machine.

New gates
─────────
1. cmake-format / cmake-lint
   * scripts/quality/cmake-format.sh — dry-run by default,
     --strict to fail on drift, --fix to apply
   * .cmake-format.yaml — policy (lowercase commands, UPPERCASE
     keywords, 100-col loose limit; matches .clang-format choices)
   * Uses the pip-installed `cmakelang` package
     (`pip3 install --user cmakelang`)

2. codespell
   * scripts/quality/codespell.sh — exit 1 on any typo, --fix
     interactively
   * .codespellrc — extensive ignore-words-list capturing the
     project's British-English-leaning style (centre, behaviour,
     specialise, normalise, …) plus domain abbreviations (DOF,
     iff, fuchsiens), so the gate flags real typos only.
   * Validated: 0 typos across docs + code/include + scripts +
     code/{src,tests}.

SPDX rollout (license-headers --fix)
────────────────────────────────────
license-headers.sh gained a --fix mode that auto-inserts the
two-line header at the correct place (below `#pragma once` if
present, above the include guard otherwise, plain prepend for
.cpp).  Ran it on 60 of 66 files — 100 %-licensed now.

Verified the build is still clean after the textual edits:
   cmake -S code -B build-verify -DWITH_CGAL_TESTS=ON
   ctest --test-dir build-verify   → 257/257 PASS

run-all.sh + README updated to include the two new gates.

End-to-end style/convention block status (on this commit, this branch):

    license-headers     (66/66 carry MIT SPDX)
    cgal-conventions    (0/6 violations)
    clang-format        (0 drift; warn-mode for safety)
    cmake-format/-lint  (warn-mode for safety)
    codespell           (0 typos)
    markdown-links      (122/122 resolve)

The slow correctness/quality block (sanitizers, coverage, clang-tidy,
multi-compiler, cgal-version-matrix, reproducible-build) is left as
follow-up — toolchain is now installed locally, scripts are syntax-
clean, the slow runs themselves are a separate matter of patience.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
Tarik Moussa
2026-05-24 09:15:34 +02:00
parent f1d77aa293
commit d3c08b3bc0
67 changed files with 567 additions and 4 deletions

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Clausen integral, Lobachevsky function, and Im(Li2).
// Ported from de.varylab.discreteconformal.functional.Clausen (Java).

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// conformal_mesh.hpp
//
// Central mesh type for the discrete conformal mapping algorithms.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// constants.hpp
//
// Single source of truth for mathematical constants used throughout

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// cp_euclidean_functional.hpp
//
// Phase 9a.1 — Circle-Packing Euclidean functional (CP-Euclidean).

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// cut_graph.hpp
//
// Phase 6 — Tree-cotree algorithm for computing a cut graph of a triangulated

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Ported from de.varylab.discreteconformal.util.DiscreteEllipticUtility (Java).
// Only the pure-math subset (no HDS required).

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// euclidean_functional.hpp
//
// Energy and gradient of the Euclidean discrete conformal functional

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// euclidean_geometry.hpp
//
// Corner-angle formula for Euclidean triangles in the discrete conformal

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// euclidean_hessian.hpp
//
// Analytical Hessian of the Euclidean discrete conformal energy —

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// fundamental_domain.hpp
//
// Phase 7 — Fundamental domain polygon for closed surfaces.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// gauss_bonnet.hpp
//
// Phase 6 — GaussBonnet consistency check for prescribed target angles.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// hyper_ideal_functional.hpp
//
// Energy and gradient of the hyper-ideal discrete conformal map functional

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// hyper_ideal_geometry.hpp
//
// Pure-math building blocks for the hyper-ideal discrete conformal map.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// hyper_ideal_hessian.hpp
//
// Phase 4a — Hessian of the hyper-ideal discrete conformal functional.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Hyperbolic tetrahedron volume formulas.
// Ported from de.varylab.discreteconformal.functional.HyperIdealUtility (Java).

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Port of the static helper
// HyperIdealVisualizationPlugin.getEuclideanCircleFromHyperbolic()
// from de.varylab.discreteconformal.plugin.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// inversive_distance_functional.hpp
//
// Phase 9a.2 — Inversive-distance circle-packing functional (Luo 2004).

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// layout.hpp
//
// Phase 5/6/7 — Layout / embedding: DOF vector → vertex coordinates in the

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// 4x4 mapping matrix from corresponding point pairs.
// Ported from de.varylab.discreteconformal.math.MatrixUtility (Java).

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// mesh_builder.hpp
//
// Factory functions that build simple reference meshes for testing and examples.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// mesh_io.hpp
//
// Phase 4b — CGAL::IO wrappers for ConformalMesh.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// mesh_utils.hpp
//
// Conversions between CGAL::Surface_mesh and Eigen matrices. Used

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// newton_solver.hpp
//
// Phase 4a — Newton solver for all three discrete conformal functionals.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// 2-D projective geometry utilities for the Euclidean signature.
// Ported from de.jreality.math.P2 and de.varylab.discreteconformal.math.P2Big.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// period_matrix.hpp
//
// Phase 7 — Period matrix for closed surfaces with Euclidean (flat) metric.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Projective and hyperbolic geometry utilities.
// Ported from de.jreality.math.Pn / Rn and

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// serialization.hpp
//
// Phase 5 — Save and load conformal map results in JSON and XML formats.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// spherical_functional.hpp
//
// Energy and gradient of the spherical discrete conformal functional

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// spherical_geometry.hpp
//
// Pure-math building blocks for the spherical discrete conformal map.

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// spherical_hessian.hpp
//
// Analytical Hessian of the spherical discrete conformal energy —

View File

@@ -1,4 +1,7 @@
#pragma once
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
#include <Eigen/Dense>
#include <igl/opengl/glfw/Viewer.h>

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// conformallab_cli.cpp
//
// ConformalLab++ command-line interface.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
#include "viewer_utils.h"
namespace viewer_utils {

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_cgal_phase8b_lite.cpp
//
// Phase 8b-Lite — Smoke tests for the four new CGAL-style entry functions

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_cgal_traits_mvp.cpp
//
// Phase 8 MVP — first tests for the new CGAL-style public API.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_conformal_mesh.cpp
//
// Phase 3a — CGAL Surface_mesh infrastructure tests.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_cp_euclidean_functional.cpp
//
// Phase 9a.1 — CPEuclideanFunctional (BPS 2010) tests.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_euclidean_functional.cpp
//
// Phase 3d — EuclideanCyclicFunctional ported to ConformalMesh.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_euclidean_hessian.cpp
//
// Phase 3f — Euclidean cotangent-Laplace Hessian.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_geometry_utils.cpp
//
// Port of the Java ConformalLab geometry utility tests.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_hyper_ideal_functional.cpp
//
// Phase 3b — HyperIdealFunctional ported to ConformalMesh.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_hyper_ideal_hessian.cpp
//
// Phase 9b — Hyper-ideal Hessian: block-FD vs full-FD cross-validation.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_inversive_distance_functional.cpp
//
// Phase 9a.2 — Inversive-distance functional (Luo 2004) tests.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_layout.cpp
//
// Phase 5 — Layout / embedding tests.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_mesh_io.cpp
//
// Phase 4b — CGAL::IO mesh round-trip tests.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_newton_phase9a.cpp
//
// Phase 9a Newton solvers — convergence tests for the two new

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_newton_solver.cpp
//
// Phase 4 — Newton solver tests.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_phase6.cpp
//
// Phase 6 — Tests for:

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_phase7.cpp
//
// Phase 7 — Tests for Java-parity layout features:

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_pipeline.cpp
//
// Phase 4c — End-to-end pipeline tests and library-user examples.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_scalability_smoke.cpp
//
// Scalability smoke tests — convergence on large real-world meshes.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_spherical_functional.cpp (Phase 3c + 3e)
//
// Phase 3c — SphericalFunctional ported to ConformalMesh.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// test_spherical_hessian.cpp
//
// Phase 3f — Spherical cotangent-Laplace Hessian.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Port of de.varylab.discreteconformal.functional.ClausenTest (Java/JUnit).
// Reference values computed with Mathematica.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Port of de.varylab.discreteconformal.util.DiscreteEllipticUtilityTest (Java/JUnit).
// Tests the normalizeModulus function that moves a complex number tau into the
// fundamental domain of the modular group SL(2,Z).

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Port of de.varylab.discreteconformal.functional.HyperIdealUtilityTest (Java/JUnit).
#include "hyper_ideal_utility.hpp"

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Port of de.varylab.discreteconformal.plugin.HyperIdealVisualizationPluginTest (Java/JUnit).
//
// Tests the conversion from a hyperbolic circle (hyperboloid model)

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Port of de.varylab.discreteconformal.math.MatrixUtilityTest (Java/JUnit).
#include "matrix_utility.hpp"

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Port of de.varylab.discreteconformal.math.P2BigTest (Java/JUnit).
// Tests 2-D projective geometry utilities: perpendicular bisectors,
// point-from-lines, and direct isometries in the Euclidean plane.

View File

@@ -1,3 +1,6 @@
// Copyright (c) 2024-2026 Tarik Moussa.
// SPDX-License-Identifier: MIT
// Port of de.varylab.discreteconformal.uniformization.SurfaceCurveUtilityTest
// (Java/JUnit) — the two pure-math tests that don't need the HDS.