Files
ConformalLabpp/code/include/period_matrix.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

164 lines
7.9 KiB
C++
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#pragma once
// period_matrix.hpp
//
// Phase 7 — Period matrix for closed surfaces with Euclidean (flat) metric.
//
// For a closed genus-g surface with Euclidean conformal structure the holonomy
// group is generated by 2g translations ω_1, ..., ω_{2g} ∈ ≅ ℝ².
//
// ─── Genus-1 (flat torus) ────────────────────────────────────────────────────
//
// The lattice Λ = ·ω_1 ⊕ ·ω_2 determines the conformal type.
//
// Period ratio: τ = ω_2 / ω_1 (as complex numbers)
//
// By convention choose ω_1 such that Im(τ) > 0.
// The conformal modulus / Teichmüller parameter is the SL(2,)-orbit of τ.
//
// Reduction to fundamental domain {|τ| ≥ 1, −½ ≤ Re(τ) < ½, Im(τ) > 0}:
// S: τ ↦ 1/τ (inversion)
// T: τ ↦ τ + 1 (translation)
// Apply S and T repeatedly until τ is in the fundamental domain.
//
// ─── Genus g > 1 ─────────────────────────────────────────────────────────────
//
// The full period matrix is a g×g complex symmetric matrix Ω with positive
// definite imaginary part (Siegel upper half-space H_g).
// Computing Ω from holonomy data requires integration of holomorphic
// differentials — not implemented here. For g > 1, this function returns
// only the 2×2 block for the first pair of generators.
//
// ─── API ─────────────────────────────────────────────────────────────────────
//
// PeriodData pd = compute_period_matrix(holonomy);
// pd.tau — complex period ratio τ (genus 1)
// pd.omega — holonomy generators as complex numbers (size = 2g)
// pd.in_fundamental_domain — whether τ has been reduced
//
// std::complex<double> reduce_to_fundamental_domain(τ) — apply SL(2,)
#include "layout.hpp"
#include <complex>
#include <cmath>
#include <vector>
#include <stdexcept>
#include <sstream>
namespace conformallab {
// ─────────────────────────────────────────────────────────────────────────────
// PeriodData
// ─────────────────────────────────────────────────────────────────────────────
/// Period-matrix data for a genus-g closed surface. For genus 1 the
/// conformal type is fully captured by `τ = ω₂ / ω₁ ∈ `.
struct PeriodData {
/// Lattice generators as complex numbers (one per cut edge).
/// omega[i] = translations[i].x() + i·translations[i].y()
std::vector<std::complex<double>> omega;
/// Period ratio τ = omega[1] / omega[0] (genus-1 only).
/// Undefined (NaN) for genus != 1 or if holonomy has fewer than 2 generators.
std::complex<double> tau = std::complex<double>(
std::numeric_limits<double>::quiet_NaN(), 0.0);
/// True if τ has been reduced to the standard fundamental domain.
bool in_fundamental_domain = false;
/// Genus of the surface = `|omega| / 2`.
int genus() const { return static_cast<int>(omega.size()) / 2; }
};
// ─────────────────────────────────────────────────────────────────────────────
// reduce_to_fundamental_domain
//
// Applies SL(2,) generators S: τ↦1/τ and T: τ↦τ+1 to bring τ into
// F = { τ ∈ : |τ| ≥ 1, −½ ≤ Re(τ) < ½ }
//
// Returns the reduced τ. Throws if Im(τ) ≤ 0 (not in upper half-plane).
// ─────────────────────────────────────────────────────────────────────────────
/// Reduce `τ ∈ ` to the standard SL(2,) fundamental domain
/// `F = { τ ∈ : |τ| ≥ 1, −½ ≤ Re τ < ½ }` via the generators
/// `S: τ↦1/τ` and `T: τ↦τ+1`. Throws if `Im τ ≤ 0`.
inline std::complex<double> reduce_to_fundamental_domain(std::complex<double> tau)
{
if (tau.imag() <= 0.0) {
std::ostringstream msg;
msg << "period_matrix: τ = " << tau.real() << " + " << tau.imag()
<< "i is not in the upper half-plane (Im(τ) must be > 0).";
throw std::domain_error(msg.str());
}
// Iterate at most 200 times (convergence is rapid for well-conditioned τ)
for (int k = 0; k < 200; ++k) {
// T step: shift Re(τ) into [−½, ½)
double re = tau.real();
long n = static_cast<long>(std::floor(re + 0.5));
tau -= std::complex<double>(static_cast<double>(n), 0.0);
// S step: if |τ| < 1, apply τ ← 1/τ
if (std::abs(tau) < 1.0 - 1e-12) {
tau = -1.0 / tau;
} else {
break;
}
}
return tau;
}
// ─────────────────────────────────────────────────────────────────────────────
// is_in_fundamental_domain — check membership in F with tolerance tol.
// ─────────────────────────────────────────────────────────────────────────────
/// `true` iff `τ` lies inside the standard SL(2,) fundamental domain
/// with tolerance `tol`.
inline bool is_in_fundamental_domain(std::complex<double> tau, double tol = 1e-9)
{
if (tau.imag() <= 0.0) return false;
if (std::abs(tau.real()) > 0.5 + tol) return false;
if (std::abs(tau) < 1.0 - tol) return false;
return true;
}
// ─────────────────────────────────────────────────────────────────────────────
// compute_period_matrix
//
// Computes the period data from the Euclidean holonomy translations.
// For genus-1 surfaces, also reduces τ to the fundamental domain.
// ─────────────────────────────────────────────────────────────────────────────
/// Compute the period data from the Euclidean holonomy translations.
/// For genus 1, also reduces `τ` to the SL(2,) fundamental domain
/// when `reduce` is `true` (default).
inline PeriodData compute_period_matrix(const HolonomyData& hol, bool reduce = true)
{
PeriodData pd;
pd.omega.reserve(hol.translations.size());
for (auto& t : hol.translations)
pd.omega.push_back(std::complex<double>(t.x(), t.y()));
if (pd.omega.size() < 2) return pd; // need at least 2 generators
// τ = ω_2 / ω_1 — choose ω_1 such that Im(τ) > 0
std::complex<double> w1 = pd.omega[0];
std::complex<double> w2 = pd.omega[1];
if (std::abs(w1) < 1e-14) return pd;
std::complex<double> tau = w2 / w1;
if (tau.imag() < 0.0) {
tau = std::conj(tau); // swap orientation
w1 = std::conj(w1);
w2 = std::conj(w2);
pd.omega[0] = w1;
pd.omega[1] = w2;
}
if (tau.imag() < 0.0) return pd; // degenerate
if (reduce) {
tau = reduce_to_fundamental_domain(tau);
pd.in_fundamental_domain = true;
}
pd.tau = tau;
return pd;
}
} // namespace conformallab