Files
ConformalLabpp/doc/api/tests.md
Tarik Moussa e04515c423 docs(doxygen): fix critical extraction bug; baseline 24% → 42% on public API
ROOT CAUSE FIX
The Doxyfile EXCLUDE_PATTERNS line contained `*/* 2.hpp` (note the
space — a stray glob from macOS-style "foo 2.hpp" duplicate files).
That pattern was silently matching ALL .hpp / .h files, so Doxygen was
indexing nothing under code/include/.  The pre-existing 556 KB of HTML
output was effectively documenting only README.md, CLAUDE.md and a
small stub for std:: — not the C++ API at all.

After fixing the pattern (and properly escaping the space-prefixed
"foo 2.hpp / foo 2.h" macOS-dup patterns), Doxygen now extracts 141
compounds and emits 248 HTML pages from the public headers.

WHAT THIS PR ADDS
1. Doxyfile fix: correct EXCLUDE_PATTERNS; add GENERATE_XML for the
   coverage measurement script; add MathJax for `$$...$$` math in
   markdown; add the missing CGAL `\cgalParamNBegin/End/Description/
   Default/...` aliases so CGAL-style param blocks render correctly.

2. New headers:
   - code/include/CGAL/Conformal_map/doxygen_groups.h
     defines `PkgConformalMap{,Ref,Concepts,NamedParameters}`,
     resolving 17 prior "non-existing group" warnings.
   - code/include/CGAL/Conformal_map/doxygen_namespaces.h
     gives every namespace under `CGAL::` and `conformallab::` a
     brief description.

3. New tool: scripts/doxygen-coverage.sh
   Parses the XML output and reports % of public symbols (excluding
   the `detail::` implementation namespaces by default) that have a
   non-empty brief/detailed description.  Supports `--list-undoc`
   and `--threshold N` for CI integration.

4. Substantial docstring additions to the public CGAL headers:
   `Conformal_map_traits.h`, `Discrete_circle_packing.h`,
   `Discrete_inversive_distance.h`, `conformal_mesh.hpp`,
   `Discrete_conformal_map.h` (Hyper_ideal_map_result fields).

5. Markdown housekeeping that the strict-warning Doxygen run surfaced:
   tests.md (escape literal `#` in table cell),
   locked-vs-flexible.md (broken section anchor),
   overall_pipeline.md (replace `$$LaTeX$$` with inline-unicode math).

CURRENT NUMBERS

  before:  ~24%  documented (public API; the prior "87%" claim was
                 based on the broken extraction)
  after:    42%  documented   (165 of 396 public symbols)
  warnings: 0   (was 27 spurious + a flood of bogus undocumented
                  warnings hidden by the buggy EXCLUDE pattern)

NEXT (in a follow-up commit on this branch)
The remaining 231 public symbols (mostly in `layout.hpp`,
`hyper_ideal_functional.hpp`, `spherical_functional.hpp`, the per-mode
functional/Hessian files) can be brought to ~100% with another pass of
short `///` brief descriptions.  The coverage script is the gate; CI
can begin enforcing `--threshold 95` once the next pass lands.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-23 23:44:54 +02:00

5.8 KiB
Raw Blame History

Test Suites

conformallab_tests — always built (no CGAL)

Pure-math tests, only Eigen required. Covers Java utilities ported in Phase 12.

File What it tests
test_clausen.cpp Clausen Cl₂, Lobachevsky Л, ImLi₂ — values at known points
test_hyper_ideal_utility.cpp Tetrahedron volumes (Meyerhoff / KolpakovMednykh)
test_matrix_utility.cpp Matrix helpers
test_surface_curve_utility.cpp Surface curve utilities
test_discrete_elliptic_utility.cpp Discrete elliptic functions
test_p2_utility.cpp P2 projective utilities
test_hyper_ideal_visualization_utility.cpp Poincaré disk projection, circumcircle

Total: 23 tests, 0 skipped.


conformallab_cgal_tests — built with -DWITH_CGAL_TESTS=ON or -DWITH_CGAL=ON

All tests have CTest prefix cgal. (set via TEST_PREFIX "cgal." in CMakeLists).

Suite File Tests What is verified
ConformalMeshTopology test_conformal_mesh.cpp 4 Euler characteristic, vertex/edge/face counts
ConformalMeshTraversal test_conformal_mesh.cpp 4 Halfedge iteration, valence, opposite
ConformalMeshProperties test_conformal_mesh.cpp 5 Property maps (λ, θ, idx, α, geometry type)
ConformalMeshValidity test_conformal_mesh.cpp 1 CGAL validity for all factory meshes
HyperIdealFunctional test_hyper_ideal_functional.cpp 7 FD gradient checks + Hessian symmetry
SphericalFunctional test_spherical_functional.cpp 12 Angle formula + gradient + gauge-fix + cross-module Hessian check
EuclideanFunctional test_euclidean_functional.cpp 12 Angle formula + gradient + cross-module Hessian check
EuclideanHessian test_euclidean_hessian.cpp 9 Cotangent Laplacian structure, FD agreement, PSD, null space
SphericalHessian test_spherical_hessian.cpp 8 Derivative correctness, NSD at equilibrium
NewtonSolver test_newton_solver.cpp 11 Convergence: Euclidean ×3, Spherical ×4, HyperIdeal ×4
SparseQRFallback test_newton_solver.cpp 3 Full-rank LDLT · singular matrix → QR · closed mesh gauge mode
MeshIO test_mesh_io.cpp 6 OFF/OBJ round-trips, error handling
Pipeline test_pipeline.cpp 5 End-to-end: build → setup → solve → export → reload
Layout test_layout.cpp 6 Edge-length preservation (Eucl./Spher.), Poincaré disk layout
Serialization test_layout.cpp 2 JSON and XML round-trips (DOF vector + layout UVs)
GaussBonnet test_phase6.cpp 12 χ, genus, sum/RHS, deficit, check, enforce
CutGraph test_phase6.cpp 6 Tree-cotree, open/closed meshes, flagindex consistency
HyperbolicTrilateration test_phase6.cpp 4 Möbius + law of cosines: exact distances, disk interior, off-origin
Normalisation test_phase6.cpp 4 Euclidean centroid, length ratios, Möbius centring
MobiusMap test_phase7.cpp 8 Identity, inverse, compose, from_three, apply(Vector2d)
BestRootFace test_phase7.cpp 2 Valid root face selection, interior bonus
HalfedgeUV test_phase7.cpp 4 Size = number of half-edges, seam consistency, boundary half-edges = 0
PriorityBFS test_phase7.cpp 3 Success, no seam on open meshes, all vertices placed
NormaliseEuclidean test_phase7.cpp 2 UV centroid = 0, halfedge_uv centroid = 0
PeriodMatrix test_phase7.cpp 7 τ ∈ , SL(2,) reduction, exception outside
FundamentalDomain test_phase7.cpp 7 Genus-1 parallelogram CCW, generators, g > 1 empty
TilingCopy/Neighbourhood test_phase7.cpp 4 Translation correct, tile count
CuttingUtility test_geometry_utils.cpp 3 point_in_triangle_2d: false, true, unit triangle (Java CuttingUtilityTest)
UnwrapUtility test_geometry_utils.cpp 2 Corner angle: collinear → π, equilateral → π/3 (Java UnwrapUtilityTest)
ConvergenceUtility test_geometry_utils.cpp 6 Circumradius + scale-invariant R_f/√A (Java ConvergenceUtilityTests)
EuclideanLayout test_geometry_utils.cpp 2 Euclidean layout round-trip edge lengths
SphericalLayout test_geometry_utils.cpp 1 Spherical layout on unit sphere
HomologyGenerators test_geometry_utils.cpp 1 Genus-2 cut graph: χ = 2, 4 cut edges (brezel2.obj)
SmokeEuclidean test_scalability_smoke.cpp 3 Smoke tests on real meshes: CatHead (open), Brezel genus-1, Brezel2 genus-2
CGALConformalTraits test_cgal_traits_mvp.cpp 2 Phase 8a MVP traits + Default model
CGALDiscreteConformalMap test_cgal_traits_mvp.cpp 6 Phase 8a MVP wrapper smoke tests
CPEuclideanFunctional test_cp_euclidean_functional.cpp 10 Phase 9a.1 — BPS-2010 face-based packing (Java parity)
InversiveDistanceFunctional test_inversive_distance_functional.cpp 11 Phase 9a.2 — Luo-2004 vertex-based packing (from literature)
HyperIdealHessian test_hyper_ideal_hessian.cpp 7 Phase 9b — block-FD vs full-FD cross-validation + PSD + speed-up
NewtonPhase9a test_newton_phase9a.cpp 7 Phase 9a-Newton — convergence for the two new circle-packing solvers
CGALPhase8bLite test_cgal_phase8b_lite.cpp 15 Phase 8b-Lite — CGAL entries for all 5 DCE models + output_uv_map + pipe-operator chaining

Total: 234 tests, 0 skipped.


Running tests

# All CGAL tests
ctest --test-dir build -R "^cgal\." --output-on-failure

# One suite
./build/conformallab_cgal_tests --gtest_filter="PeriodMatrix*"

# One specific test
./build/conformallab_cgal_tests --gtest_filter="PeriodMatrix.TauInUpperHalfPlane"

# Verbose output with timing
./build/conformallab_cgal_tests --gtest_filter="NewtonSolver*" --gtest_print_time=1