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:
@@ -12,17 +12,15 @@
|
||||
|
||||
namespace conformallab {
|
||||
|
||||
// Divide a homogeneous vector by its last component.
|
||||
// Corresponds to Java Pn.dehomogenize().
|
||||
/// Dehomogenise: divide a homogeneous vector by its last component.
|
||||
/// Same as Java `Pn.dehomogenize()`.
|
||||
inline Eigen::VectorXd dehomogenize(const Eigen::VectorXd& p) {
|
||||
return p / p(p.size() - 1);
|
||||
}
|
||||
|
||||
// Hyperbolic distance between two homogeneous vectors of the same dimension.
|
||||
// The last component is the "timelike" coordinate (jReality convention).
|
||||
// Inner product: <p,q> = -sum_i p_i*q_i + p_last * q_last
|
||||
// Distance: arcosh(<p̂, q̂>) where p̂ normalises to the hyperboloid.
|
||||
// Corresponds to Java Pn.distanceBetween(p, q, Pn.HYPERBOLIC).
|
||||
/// Hyperbolic distance `arcosh(⟨p̂, q̂⟩)` between two homogeneous
|
||||
/// vectors (last component = timelike coordinate; jReality convention).
|
||||
/// Same as Java `Pn.distanceBetween(p, q, Pn.HYPERBOLIC)`.
|
||||
inline double hyperbolicDistance(const Eigen::VectorXd& p,
|
||||
const Eigen::VectorXd& q) {
|
||||
int n = static_cast<int>(p.size());
|
||||
@@ -34,10 +32,8 @@ inline double hyperbolicDistance(const Eigen::VectorXd& p,
|
||||
return std::acosh(std::max(1.0, inner));
|
||||
}
|
||||
|
||||
// Check whether a homogeneous point p lies on the segment [s[0], s[1]].
|
||||
// Works for n-dimensional homogeneous coords; cross product uses the first
|
||||
// 3 spatial components after dehomogenization (matching jReality's Rn behaviour).
|
||||
// Corresponds to Java SurfaceCurveUtility.isOnSegment().
|
||||
/// `true` iff the homogeneous point `p_h` lies on the segment
|
||||
/// `[s0_h, s1_h]`. Same as Java `SurfaceCurveUtility.isOnSegment()`.
|
||||
inline bool isOnSegment(const Eigen::VectorXd& p_h,
|
||||
const Eigen::VectorXd& s0_h,
|
||||
const Eigen::VectorXd& s1_h) {
|
||||
@@ -63,10 +59,10 @@ inline bool isOnSegment(const Eigen::VectorXd& p_h,
|
||||
return true;
|
||||
}
|
||||
|
||||
// Find the point on `target` that corresponds to `p` on `source`.
|
||||
// The parameter t is determined by hyperbolic distance ratios on `source`,
|
||||
// then applied as a linear interpolation on the dehomogenized `target`.
|
||||
// Corresponds to Java SurfaceCurveUtility.getPointOnCorrespondingSegment().
|
||||
/// Find the point on the target segment `(tgt0, tgt1)` corresponding
|
||||
/// to `p` on the source segment `(src0, src1)`, parametrised by
|
||||
/// hyperbolic distance ratios on the source. Same as Java
|
||||
/// `SurfaceCurveUtility.getPointOnCorrespondingSegment()`.
|
||||
inline Eigen::VectorXd getPointOnCorrespondingSegment(
|
||||
const Eigen::VectorXd& p,
|
||||
const Eigen::VectorXd& src0,
|
||||
|
||||
Reference in New Issue
Block a user