From 011ddb85079493aa6aa1367c324dec01663c0551 Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Mon, 2 Jun 2025 14:09:11 +0100 Subject: [PATCH 1/3] Triangulation_3: Documentation fixes --- .../CGAL/Delaunay_triangulation_cell_base_with_circumcenter_3.h | 2 +- .../Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h | 2 +- ...gular_triangulation_cell_base_with_weighted_circumcenter_3.h | 2 +- .../Triangulation_3/Concepts/RegularTriangulationCellBase_3.h | 1 + 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_cell_base_with_circumcenter_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_cell_base_with_circumcenter_3.h index 6eba490b631..532d0a85cfd 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_cell_base_with_circumcenter_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_cell_base_with_circumcenter_3.h @@ -16,7 +16,7 @@ circumcenter. \tparam Traits is the geometric traits class and must be a model of `DelaunayTriangulationTraits_3`. \tparam Cb is a cell base class from which -`Delaunay_triangulation_cell_base_with_circumcenter_3` derives. Cb should +`Delaunay_triangulation_cell_base_with_circumcenter_3` derives. Cb must be a model of `DelaunayTriangulationCellBase_3`. It has the default value `Delaunay_triangulation_cell_base_3`. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h index 637595f1e25..af8ad177b2b 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h @@ -4,7 +4,7 @@ namespace CGAL { /*! \ingroup PkgTriangulation3VertexCellClasses -The class `Regular_triangulation_cell_base_with_weighted_circumcenter_3` derives from +The class `Regular_triangulation_cell_base_3` derives from `Cb`, a cell base class of a 3D triangulation. It is the default cell base class of regular triangulations. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_weighted_circumcenter_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_weighted_circumcenter_3.h index cbf43c1610c..25cbe39ea54 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_weighted_circumcenter_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_weighted_circumcenter_3.h @@ -16,7 +16,7 @@ circumcenter. \tparam Traits is the geometric traits class and must be a model of `RegularTriangulationTraits_3`. \tparam Cb is a cell base class from which -`Regular_triangulation_cell_base_with_weighted_circumcenter_3` derives. Cb should +`Regular_triangulation_cell_base_with_weighted_circumcenter_3` derives. Cb must be a model of `RegularTriangulationCellBase_3`. It has the default value `Regular_triangulation_cell_base_3`. diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h index ffafd4be04e..cabc90c58a0 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h @@ -37,6 +37,7 @@ and an operator to compute its weighted circumcenter. \cgalHasModelsBegin \cgalHasModels{CGAL::Regular_triangulation_cell_base_3} +\cgalHasModels{CGAL::Regular_triangulation_cell_base_with_weighted_circumcenter_3} \cgalHasModelsEnd \sa `RegularTriangulationTraits_3` From ebabf5ac66e69979ab420e0721e55453b6fa5d7f Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Mon, 2 Jun 2025 14:32:12 +0100 Subject: [PATCH 2/3] lowercase Object as it refers to the param of the function lock() --- .../doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h | 2 +- .../doc/Triangulation_3/CGAL/Regular_triangulation_3.h | 2 +- Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h index ba49e83c87a..903c4a7d8be 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h @@ -39,7 +39,7 @@ manual \ref Triangulation3exfastlocation. \tparam SLDS is an optional parameter to specify the type of the spatial lock data structure. It must be a model of the `SurjectiveLockDataStructure` concept, - with `Object` being a `Point` (as defined below). + with `object` being a `Point` (as defined below). It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when `TDS::Concurrency_tag` is `CGAL::Parallel_tag`). The default value is `Spatial_lock_grid_3` if diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h index f0c1bf08440..4824bd7a081 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h @@ -38,7 +38,7 @@ respectively. \tparam SLDS is an optional parameter to specify the type of the spatial lock data structure. It must be a model of the `SurjectiveLockDataStructure` concept, - with `Object` being a `Point`. + with `object` being a `Point`. It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when `TDS::Concurrency_tag` is `Parallel_tag`). The default value is `Spatial_lock_grid_3` if diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h index 58a7b229917..045d2be3c20 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h @@ -19,7 +19,7 @@ respectively. \tparam SLDS is an optional parameter to specify the type of the spatial lock data structure. It must be a model of the `SurjectiveLockDataStructure` concept, - with `Object` being a `Point` (as defined below). + with `object` being a `Point` (as defined below). It is only used if the triangulation data structure used is concurrency-safe (i.e.\ when `TriangulationDataStructure_3::Concurrency_tag` is `Parallel_tag`). The default value is `Spatial_lock_grid_3` if From 4cb8fb2ba9318d353893ecf40c27df93aefcde4f Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Tue, 3 Jun 2025 12:43:24 +0100 Subject: [PATCH 3/3] Fix in cicumcenter() --- .../Delaunay_triangulation_cell_base_with_circumcenter_3.h | 2 +- .../Concepts/DelaunayTriangulationCellBase_3.h | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_cell_base_with_circumcenter_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_cell_base_with_circumcenter_3.h index 532d0a85cfd..1066b985d01 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_cell_base_with_circumcenter_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_cell_base_with_circumcenter_3.h @@ -49,7 +49,7 @@ If it has already been computed in the past, the cached value is returned. Computes the circumcenter of the tetrahedron, or retrieves it if already computed */ -const Point& circumcenter(Traits> = Traits()) const; +const Point& circumcenter(const Traits> = Traits()) const; /// @} diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationCellBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationCellBase_3.h index fdb8b9ee870..f3b5cf39fa7 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationCellBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationCellBase_3.h @@ -34,9 +34,9 @@ typedef DelaunayTriangulationTraits_3::Point_3 Point; Returns the circumcenter of the cell. `DelaunayTriangulationTraits_3` is the geometric traits class of the triangulation. -This operator is required only when the dual functions are called. +This operator is required only when the `dual()` functions are called. */ -const Point& circumcenter(DelaunayTriangulationTraits_3> = DelaunayTriangulationTraits_3()) const; +const Point& circumcenter(const DelaunayTriangulationTraits_3> = DelaunayTriangulationTraits_3()) const; /// @}