From a5357164da20ac2cc70e5cbb23e285409f095607 Mon Sep 17 00:00:00 2001 From: Sven Oesau Date: Wed, 19 Nov 2025 11:49:06 +0100 Subject: [PATCH] fixed some documentation --- AABB_tree/include/CGAL/AABB_traits_3.h | 4 +++- Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h | 6 +++--- Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h | 3 +++ 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/AABB_tree/include/CGAL/AABB_traits_3.h b/AABB_tree/include/CGAL/AABB_traits_3.h index a6dcacb1f48..f30ee6e5214 100644 --- a/AABB_tree/include/CGAL/AABB_traits_3.h +++ b/AABB_tree/include/CGAL/AABB_traits_3.h @@ -313,7 +313,9 @@ class Compare_distance_getter_3 { } // This static filter was introduced by https://github.com/CGAL/cgal/pull/5507 . - // It prefers to indicate an intersection over using exact arithmetic. + // In case of uncertainty, it avoids exact arithmetic and indicates an intersection. + // This is acceptable for search data structures like AABB trees as the actual elements + // will be tested later. Comparison_result operator()(const Point& p, const Bounding_box& b, const Point& bound) const { Sphere_3 s = GeomTraits().construct_sphere_3_object()(p, GeomTraits().compute_squared_distance_3_object()(p, bound)); CGAL_BRANCH_PROFILER_3(std::string("semi-static failures/attempts/calls to : ") + diff --git a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h index c66bd0c922a..51b645bff96 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h +++ b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h @@ -1852,7 +1852,7 @@ public: /// @{ /*! - returns an approximation of the area of `c`. + returns an approximation of the area bounded by `c`. */ double operator()(const Kernel::Circle_3& c); @@ -1969,7 +1969,7 @@ public: /// @{ /*! - returns the area of `c`, divided by \f$ \pi\f$. + returns the area bounded by `c`, divided by \f$ \pi\f$. */ Kernel::FT operator()(const Kernel::Circle_3& c); @@ -3079,7 +3079,7 @@ public: /*! returns the squared radius of the - smallest sphere circle to the argument(s). + smallest circle to the argument(s). */ Kernel::FT operator() (const Kernel::Weighted_point_2& pw, const Kernel::Weighted_point_2& qw, diff --git a/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h b/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h index e85d5b723bc..23d5764a707 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h +++ b/Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h @@ -26,6 +26,7 @@ namespace Kernel { \sa `Kernel::IsDegenerate_2` \sa `Kernel::OrientedSide_2` + \warning Circle_2 is the bordless 1-manifold embedded in 2D. It is not a disk. Be careful when implementing functors. */ class Circle_2 { public: @@ -60,6 +61,7 @@ public: \sa `Kernel::HasOnUnboundedSide_3` \sa `Kernel::IsDegenerate_3` + \warning Circle_3 is the bordless 1-manifold embedded in 3D. It is not a disk. Be careful when implementing functors. */ class Circle_3 { public: @@ -640,6 +642,7 @@ public: \sa `Kernel::IsDegenerate_3` \sa `Kernel::OrientedSide_3` + \warning Sphere_3 is the bordless 2-manifold embedded in 3D. It is not a ball. Be careful when implementing functors. */ class Sphere_3 { public: