From cb60322552d7c0ad561353c7d0b9750d0c2f7d57 Mon Sep 17 00:00:00 2001 From: Jane Tournois Date: Mon, 17 Feb 2014 16:40:38 +0100 Subject: [PATCH] apply small fixes --- .../CGAL/Regular_triangulation_cell_base_3.h | 30 ++++++++++++------- ..._cell_base_with_weighted_circumcenter_3.h} | 8 +++-- .../DelaunayTriangulationCellBase_3.h | 2 +- .../Concepts/RegularTriangulationCellBase_3.h | 3 +- 4 files changed, 26 insertions(+), 17 deletions(-) rename Triangulation_3/doc/Triangulation_3/CGAL/{Regular_triangulation_cell_base_with_circumcenter_3.h => Regular_triangulation_cell_base_with_weighted_circumcenter_3.h} (89%) 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 1896486b4a7..410df84838c 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,14 +4,14 @@ namespace CGAL { /*! \ingroup PkgTriangulation3VertexCellClasses -The class `Regular_triangulation_cell_base_3` is a model of the concept -`RegularTriangulationCellBase_3`. It is the default cell base class -of regular triangulations. - +The class `Regular_triangulation_cell_base_with_weighted_circumcenter_3` derives from +`Cb`, a cell base class of a 3D triangulation. +It is the default cell base class of regular triangulations. \tparam Traits must be a model of `RegularTriangulationTraits_3`. -\tparam Cb must be a model of `TriangulationCellBase_3`. +\tparam Cb is a cell base class from which `Regular_triangulation_cell_base_3` +derives. It must be a model of `TriangulationCellBase_3`. By default, this parameter is instantiated by `Triangulation_cell_base_3`. \cgalModels `RegularTriangulationCellBase_3` @@ -23,30 +23,38 @@ By default, this parameter is instantiated by `Triangulation_cell_base_3 */ -template< typename Traits, typename Cb > +template< typename TriangulationTraits_3, typename Cb > class Regular_triangulation_cell_base_3 : public Cb { public: +/// \name Types +/// @{ +typedef TriangulationTraits_3::Bare_point Bare_point; +/// @} + /*! \name Access function As a model of the concept `RegularTriangulationCellBase_3`, `Regular_triangulation_cell_base_3` provides a `weighted_circumcenter()` member fonction. -In this model, the `weighted_circumcenter()` member fonction returns the weighted circumcenter -of the cell, computed by the `ConstructWeightedCircumcenter` constructor of the traits class. -However, this point has no weight. +In this model, the `weighted_circumcenter()` member fonction returns the +weighted circumcenter of the cell, computed +by the `ConstructWeightedCircumcenter` constructor of the traits class. + +Note that this point has no weight. */ /// @{ /*! Returns the weighted circumcenter of the cell. -Be careful that the return type is `Traits::Bare_point`, and the radius of the weighted +Be careful that the return type is `Traits::Bare_point`, and the radius of the weighted circumcenter is not supposed to be computed by the constructor `ConstructWeightedCircumcenter` of the traits class, so the returned point has no weight. */ -const Traits::Bare_point& weighted_circumcenter(const Traits& gt = Traits()) const; +const Bare_point& weighted_circumcenter( + const TriangulationTraits_3& gt = TriangulationTraits_3()) const; /// @} diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_circumcenter_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_weighted_circumcenter_3.h similarity index 89% rename from Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_circumcenter_3.h rename to Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_weighted_circumcenter_3.h index 788a3973344..a7de229fcd2 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_circumcenter_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_weighted_circumcenter_3.h @@ -44,10 +44,12 @@ As a model of the concept `RegularTriangulationCellBase_3`, provides a `weighted_circumcenter()` member fonction. In this model, the `weighted_circumcenter()` member fonction returns the weighted circumcenter -of the cell, computed by the `ConstructWeightedCircumcenter` constructor of the traits class. -However, this point has no weight. +of the cell. +This `Bare_point` is computed by the `ConstructWeightedCircumcenter` constructor of the traits class +when this function is first called. +In the next calls, the cached value is returned. -If it has already been computed in the past, the cached value is returned. +Note that this point has no weight. */ /// @{ diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationCellBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationCellBase_3.h index c3744f22599..ac00407bb13 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationCellBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationCellBase_3.h @@ -15,7 +15,7 @@ in the cell an operator that computes its circumcenter. \cgalHasModel CGAL::Delaunay_triangulation_cell_base_3 \cgalHasModel CGAL::Delaunay_triangulation_cell_base_with_circumcenter_3 -\sa `TriangulationCellBase_3` +\sa `DelaunayTriangulationTraits_3` */ diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h index 8963ad4c05c..9d5ab26de5b 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h @@ -36,9 +36,8 @@ and an operator to compute its weighted circumcenter. \cgalRefines `TriangulationCellBase_3` \cgalHasModel CGAL::Regular_triangulation_cell_base_3 -\cgalHasModel CGAL::Regular_triangulation_cell_base_with_circumcenter_3 +\cgalHasModel CGAL::Regular_triangulation_cell_base_with_weighted_circumcenter_3 -\sa `TriangulationCellBase_3` \sa `RegularTriangulationTraits_3` */