Files
ConformalLabpp/code/include/discrete_elliptic_utility.hpp
Tarik Moussa 62b02f88b9
Some checks failed
C++ Tests / test-fast (pull_request) Successful in 2m40s
API Docs / doc-build (pull_request) Successful in 1m2s
C++ Tests / test-cgal (pull_request) Failing after 11m52s
docs(doxygen): 100% public-API coverage (228 → 0 undocumented)
Completes the work begun in the previous commit on this branch.  Every
public symbol under code/include/ now carries a brief Doxygen comment
(0 undocumented per scripts/doxygen-coverage.sh, with the `detail::`
implementation namespaces excluded as before).

Trajectory on this branch:
  start (after Doxyfile fix):  24.0 %  (165 / 437 in the no-detail set
                                       was 105 / 437 when detail counted)
  after PR #17 base commit  :  42.4 %  (165 / 396)
  this commit               : 100.0 %  (396 / 396)

Files touched (all .hpp / .h headers under code/include/):
  * cgal/Conformal_map_traits.h
  * clausen.hpp, conformal_mesh.hpp, constants.hpp (already docd)
  * cp_euclidean_functional.hpp, cut_graph.hpp, discrete_elliptic_utility.hpp
  * euclidean_functional.hpp, euclidean_geometry.hpp, euclidean_hessian.hpp
  * fundamental_domain.hpp, gauss_bonnet.hpp
  * hyper_ideal_{functional,geometry,hessian,utility,visualization_utility}.hpp
  * inversive_distance_functional.hpp, layout.hpp
  * matrix_utility.hpp, mesh_builder.hpp, mesh_io.hpp
  * newton_solver.hpp, p2_utility.hpp, period_matrix.hpp, projective_math.hpp
  * serialization.hpp, spherical_functional.hpp, spherical_geometry.hpp
  * spherical_hessian.hpp, viewer_utils.h

CI:
.gitea/workflows/doxygen-pages.yml now enforces
`scripts/doxygen-coverage.sh --threshold 100`, so any future regression
(a new public function landed without a `///` brief) fails the build
before the Doxygen HTML is published to Codeberg Pages.

Doxygen warnings remain at 0.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-24 04:22:49 +02:00

46 lines
1.5 KiB
C++

#pragma once
// Ported from de.varylab.discreteconformal.util.DiscreteEllipticUtility (Java).
// Only the pure-math subset (no HDS required).
#include <complex>
#include <cmath>
namespace conformallab {
// Move tau into the fundamental domain of the modular group SL(2,Z):
// |Re(tau)| <= 0.5, Im(tau) >= 0, Re(tau) >= 0, |tau| >= 1
//
// Algorithm: iteratively apply
// 1. T-shift: Re > 0.5 or Re < 0 → Re -= sign(Re)
// 2. Im-flip: Im < 0 → Im = -Im
// 3. Re-flip: Re < 0 → Re = -Re
// 4. S-invert: |tau| < 1 → tau = 1/tau
//
/// Normalise a complex modulus `τ` into the standard fundamental
/// domain of an elliptic curve (`|τ| ≥ 1`, `0 ≤ Re τ ≤ ½`, `Im τ ≥ 0`).
/// Same as Java `DiscreteEllipticUtility.normalizeModulus(Complex)`.
inline std::complex<double> normalizeModulus(std::complex<double> tau) {
int maxIter = 100;
while (--maxIter > 0) {
double re = tau.real();
double im = tau.imag();
// exit when all conditions satisfied
if (std::abs(re) <= 0.5 && im >= 0.0 && re >= 0.0 && std::abs(tau) >= 1.0)
break;
if (std::abs(re) > 0.5)
re -= (re > 0.0 ? 1.0 : -1.0); // signum shift
if (im < 0.0)
im = -im;
if (re < 0.0)
re = -re;
tau = std::complex<double>(re, im);
if (std::abs(tau) < 1.0)
tau = 1.0 / tau; // S-transformation: invert
}
return tau;
}
} // namespace conformallab