Adapted the documentation to the new concept RegTrCellBaseWithWeightedCircumcenter

- MeshCellBase_3 loses "invalidate_circumcenter" and refines the new concept
- Reg_tr_cell_base_with_weighted_circumcenter_3 is a model of the new concept
This commit is contained in:
Mael Rouxel-Labbé 2017-06-01 11:23:04 +02:00
parent ea5c4fabb7
commit a68423f4c8
5 changed files with 10 additions and 16 deletions

View File

@ -23,8 +23,8 @@ the faces of the input complex. It has to be a model
of the concept `MeshDomain_3`.
\tparam Cb is the cell base class. It has to be a model
of the concept `RegularTriangulationCellBase_3` and defaults to
`Regular_triangulation_cell_base_3<Gt>`.
of the concept `RegularTriangulationCellBaseWithWeightedCircumcenter_3` and defaults to
`Regular_triangulation_cell_base_with_weighted_circumcenter_3<Gt>`.
\cgalModels `MeshCellBase_3`

View File

@ -4,7 +4,8 @@
The concept `MeshCellBase_3` describes the requirements
for the `Cell` type of the triangulation
used in the 3D mesh generation process. The type `MeshCellBase_3` refines the concept `RegularTriangulationCellBase_3`
used in the 3D mesh generation process. The type `MeshCellBase_3`
refines the concept `RegularTriangulationCellBaseWithWeightedCircumcenter_3`
and must be copy constructible.
The concept `MeshCellBase_3`
includes a way to store and retrieve
@ -39,7 +40,7 @@ and `is_facet_visited(1)` in parallel must be safe)
Moreover, the parallel algorithms require an erase counter in
each cell (see below).
\cgalRefines `RegularTriangulationCellBase_3`
\cgalRefines `RegularTriangulationCellBaseWithWeightedCircumcenter_3`
\cgalRefines `CopyConstructible`
\cgalHasModel `CGAL::Compact_mesh_cell_base_3<Gt,MD,Tds>`
@ -152,13 +153,6 @@ Returns the surface center index of `facet(i)`.
*/
Index get_facet_surface_center_index(int i);
/*!
Invalidates the circumcenter value stored in the cell.
This value is usually stored in the cell, but the optimizers need to be able to
invalidate this cache value.
*/
void invalidate_circumcenter();
/// Get the erase counter.
/// Only required by the parallel algorithms.
/// See `CGAL::Compact_container` for more details.

View File

@ -20,7 +20,7 @@ circumcenter.
be a model of `RegularTriangulationCellBase_3`.
It has the default value `Regular_triangulation_cell_base_3<RT>`.
\cgalModels `RegularTriangulationCellBase_3`
\cgalModels `RegularTriangulationCellBaseWithWeightedCircumcenter_3`
\sa `CGAL::Triangulation_cell_base_3`
\sa `CGAL::Triangulation_cell_base_with_info_3`
@ -41,13 +41,13 @@ typedef Traits::Weighted_point_3 Point;
/*! \name Access function
As a model of the concept `RegularTriangulationCellBase_3`,
`Regular_triangulation_cell_base_3`
`Regular_triangulation_cell_base_with_weighted_circumcenter_3`
provides a `weighted_circumcenter()` member fonction.
In this model, the `weighted_circumcenter()` member fonction returns the <b>weighted circumcenter</b>
of the cell.
This `Point_3` is computed by the `Construct_weighted_circumcenter_3` constructor of the traits class
when this function is first called.
This `Point_3` is computed using the `Construct_weighted_circumcenter_3` functor
of the traits class when this function is first called and its value is stored.
In the next calls, the cached value is returned.
Note that the returned point has no weight.

View File

@ -36,7 +36,6 @@ 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_weighted_circumcenter_3
\sa `RegularTriangulationTraits_3`

View File

@ -79,6 +79,7 @@ is opposite to the vertex with the same index. See
- `DelaunayTriangulationCellBase_3`
- `RegularTriangulationVertexBase_3`
- `RegularTriangulationCellBase_3`
- `RegularTriangulationCellBaseWithWeightedCircumcenter_3`
- `TriangulationDataStructure_3`
- `WeightedPoint`