Files
ConformalLabpp/doc/api/tests.md
Tarik Moussa 039cc26e36
Some checks failed
C++ Tests / test-fast (push) Successful in 1m58s
C++ Tests / test-fast (pull_request) Successful in 2m33s
API Docs / doc-build (pull_request) Successful in 51s
C++ Tests / test-cgal (push) Has been skipped
C++ Tests / test-cgal (pull_request) Failing after 10m32s
Phase 8b-Lite: pipe-operator chaining for named parameters
Adds `operator|` in `namespace CGAL` so package-local named parameters
can be combined left-to-right without modifying CGAL upstream:

    auto p = CGAL::parameters::gradient_tolerance(1e-12)
           | CGAL::parameters::max_iterations(500)
           | CGAL::parameters::output_uv_map(uv);
    CGAL::discrete_conformal_map_euclidean(mesh, p);

Why not the canonical `.a().b().c()` syntax
───────────────────────────────────────────
CGAL's standard chaining mechanism requires registering each named
parameter as a member function on `Named_function_parameters` via the
`CGAL_add_named_parameter` macro in
`CGAL/STL_Extension/internal/parameters_interface.h` — a vendored
upstream file that conformallab++ deliberately treats as read-only.

Adding member-function chainers for our package-local tags would
require either forking CGAL or modifying the vendored copy.  Neither
is acceptable for a library that wants to remain portable across
future CGAL releases.

The pipe-operator achieves the same compositional semantics via a
free function in `namespace CGAL` (so ADL finds it for
`Named_function_parameters` operands).  Implementation: rebuild the
right-hand-side `Named_function_parameters` with the left-hand-side
as its `Base`, producing an indistinguishable chain that every entry
function accepts unchanged.

Implementation: `code/include/CGAL/Conformal_map/internal/parameters.h`
lines 158-187.  The operator is constrained to right-hand-sides with
`No_property` base (i.e. fresh single-parameter packs from the helper
functions), so it never collides with any future CGAL operator on the
same type.

Tests (2 new, total Phase-8b-Lite suite 15 → 17)
────────────────────────────────────────────────
* CGALPhase8bLite.NamedParamPipe_MultipleParamsTakeEffect
    Chain three parameters; verify all three take effect (tight
    tolerance respected + UV pmap populated + iteration cap honoured).
* CGALPhase8bLite.NamedParamPipe_TwoParams
    Chain two parameters; verify max_iterations(0) blocks the loop
    even when combined with another param.

Full CGAL suite: 234/234 PASSED, 0 SKIPPED (was 232).
Total: 257/257 PASSED, 0 SKIPPED (was 255).
scripts/check-test-counts.sh: OK.

Documentation updates
─────────────────────
* doc/tutorials/add-output-uv-map.md §3.4: "Current limitation: no
  chaining" → "Chaining: use the pipe operator `|`".  Explains why
  CGAL's `.member()` syntax isn't available and shows the `|`
  workaround with a working code example.
* doc/architecture/locked-vs-flexible.md §8: chaining now flagged as
  shipped via pipe; recommended posture says `.member()` chaining
  only if a user pushes for the CGAL-canonical syntax.
* doc/roadmap/porting-status.md §5: API limitations table updated.
* doc/api/tests.md: CGALPhase8bLite row 15 → 17, total 232 → 234.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-22 13:43:52 +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 = #halfedges, seam consistency, boundary halfedges = 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