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

apply small fixes

This commit is contained in:
Jane Tournois 2014-02-17 16:40:38 +01:00
parent c6b0013475
commit cb60322552
4 changed files with 26 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h
View File

@ -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<Traits>`.
\cgalModels `RegularTriangulationCellBase_3`
@ -23,30 +23,38 @@ By default, this parameter is instantiated by `Triangulation_cell_base_3<Traits>
*/
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 <b>weighted circumcenter</b>
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
<b>weighted circumcenter</b> 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;
/// @}

8
Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_circumcenter_3.h → Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_with_weighted_circumcenter_3.h
View File

@ -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 <b>weighted circumcenter</b>
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.
*/
/// @{

2
Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationCellBase_3.h
View File

@ -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`
*/

3
Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h
View File

@ -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`
*/