songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fixed some documentation

This commit is contained in:
Sven Oesau 2025-11-19 11:49:06 +01:00
parent f68692bf58
commit a5357164da
3 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
AABB_tree/include/CGAL/AABB_traits_3.h
View File

@ -313,7 +313,9 @@ class Compare_distance_getter_3<GeomTraits, true, true> {
} }
// This static filter was introduced by https://github.com/CGAL/cgal/pull/5507 . // 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 { 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)); 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 : ") + CGAL_BRANCH_PROFILER_3(std::string("semi-static failures/attempts/calls to : ") +

6
Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h
View File

@ -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); 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); Kernel::FT operator()(const Kernel::Circle_3& c);
@ -3079,7 +3079,7 @@ public:
/*! /*!
returns the squared radius of the 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, Kernel::FT operator() (const Kernel::Weighted_point_2& pw,
const Kernel::Weighted_point_2& qw, const Kernel::Weighted_point_2& qw,

3
Kernel_23/doc/Kernel_23/Concepts/GeomObjects.h
View File

@ -26,6 +26,7 @@ namespace Kernel {
\sa `Kernel::IsDegenerate_2` \sa `Kernel::IsDegenerate_2`
\sa `Kernel::OrientedSide_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 { class Circle_2 {
public: public:
@ -60,6 +61,7 @@ public:
\sa `Kernel::HasOnUnboundedSide_3` \sa `Kernel::HasOnUnboundedSide_3`
\sa `Kernel::IsDegenerate_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 { class Circle_3 {
public: public:
@ -640,6 +642,7 @@ public:
\sa `Kernel::IsDegenerate_3` \sa `Kernel::IsDegenerate_3`
\sa `Kernel::OrientedSide_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 { class Sphere_3 {
public: public: