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>
This commit is contained in:
@@ -50,6 +50,8 @@ 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()
|
||||
@@ -63,6 +65,7 @@ struct PeriodData {
|
||||
/// 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; }
|
||||
};
|
||||
|
||||
@@ -74,6 +77,9 @@ struct PeriodData {
|
||||
//
|
||||
// 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) {
|
||||
@@ -103,6 +109,8 @@ inline std::complex<double> reduce_to_fundamental_domain(std::complex<double> ta
|
||||
// ─────────────────────────────────────────────────────────────────────────────
|
||||
// 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;
|
||||
@@ -117,6 +125,9 @@ inline bool is_in_fundamental_domain(std::complex<double> tau, double tol = 1e-9
|
||||
// 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;
|
||||
|
||||
Reference in New Issue
Block a user