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

fix documentation of Triangulation_cell_base_with_circumcenter_3 

the base class should be Cb, that implements TriangulationCellBase_3 OR
RegularTriangulationCellBase_3
This commit is contained in:
Jane Tournois 2014-01-10 16:18:19 +01:00
parent a95c93cfe5
commit 63a0262e74
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_circumcenter_3.h
View File

@ -4,8 +4,8 @@ namespace CGAL {
/*!
\ingroup PkgTriangulation3VertexCellClasses
The class `Triangulation_cell_base_with_circumcenter_3` is a model of the
concept `TriangulationCellBase_3`, the base cell of a 3D-triangulation.
The class `Triangulation_cell_base_with_circumcenter_3` derives from
`Cb`, a cell base class of a 3D triangulation or a 3D regular triangulation.
It provides an easy way to cache the computation of the circumcenter of
tetrahedra.
Note that input/output operators discard this additional information.
@ -15,18 +15,20 @@ circumcenter.
\tparam TriangulationTraits_3 is the geometric traits class.
\tparam TriangulationCellBase_3 is a cell base class from which
`Triangulation_cell_base_with_circumcenter_3` derives.
It has the default value `Triangulation_cell_base_3<TriangulationTraits_3>`.
\tparam Cb is a cell base class from which
`Triangulation_cell_base_with_circumcenter_3` derives. Cb should
be a model of `TriangulationCellBase_3` or `RegularTriangulationCellBase_3`.
It has the default value `Triangulation_cell_base_3<DelaunayTriangulationTraits_3>`.
\cgalModels `TriangulationCellBase_3`
\cgalModels `TriangulationCellBase_3` or `RegularTriangulationCellBase_3`,
similarly to Cb.
\sa `CGAL::Triangulation_cell_base_3`
\sa `CGAL::Triangulation_cell_base_with_info_3`
*/
template< typename TriangulationTraits_3, typename TriangulationCellBase_3 >
class Triangulation_cell_base_with_circumcenter_3 : public TriangulationCellBase_3 {
template< typename TriangulationTraits_3, typename Cb >
class Triangulation_cell_base_with_circumcenter_3 : public Cb {
public:
/// \name Types