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

Document the third template parameter

This commit is contained in:
Andreas Fabri 2023-07-27 10:24:35 +01:00 committed by Mael Rouxel-Labbé
parent a909cafcce
commit 6f0907d07c
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h
View File

@ -7,9 +7,12 @@ namespace CGAL {
The class `Apollonius_graph_vertex_base_2` provides a model for the The class `Apollonius_graph_vertex_base_2` provides a model for the
`ApolloniusGraphVertexBase_2` concept which is the vertex base `ApolloniusGraphVertexBase_2` concept which is the vertex base
required by the `ApolloniusGraphDataStructure_2` concept. The required by the `ApolloniusGraphDataStructure_2` concept. The
class `Apollonius_graph_vertex_base_2` has two template arguments, the first being the class `Apollonius_graph_vertex_base_2` has two template arguments.
geometric traits of the Apollonius graph and should be a model of the
concept `ApolloniusGraphTraits_2`. The second is a Boolean which \tparam Gt is the geometric traits of the Apollonius graph and must be a model of the
concept `ApolloniusGraphTraits_2`.
\tparam StoreHidden is a Boolean which
controls whether hidden sites are actually stored. Such a controls whether hidden sites are actually stored. Such a
control is important if the user is not interested in hidden sites control is important if the user is not interested in hidden sites
and/or if only insertions are made, in which case no hidden and/or if only insertions are made, in which case no hidden
@ -17,13 +20,17 @@ site can become visible. If `StoreHidden` is set to
`true`, hidden sites are stored, otherwise they are `true`, hidden sites are stored, otherwise they are
discarded. By default `StoreHidden` is set to `true`. discarded. By default `StoreHidden` is set to `true`.
\tparam Vb must be a model of the concept `TriangulationDSVertexBase_2`
By default this parameter is
instantiated by `Triangulation_ds_vertex_base_2<>`.
\cgalModels `ApolloniusGraphVertexBase_2` \cgalModels `ApolloniusGraphVertexBase_2`
\sa `CGAL::Triangulation_data_structure_2<Vb,Fb>` \sa `CGAL::Triangulation_data_structure_2<Vb,Fb>`
\sa `CGAL::Apollonius_graph_hierarchy_vertex_base_2<Gt>` \sa `CGAL::Apollonius_graph_hierarchy_vertex_base_2<Gt>`
*/ */
template< typename Gt, typename StoreHidden > template< typename Gt, typename StoreHidden, typename Vb >
class Apollonius_graph_vertex_base_2 { class Apollonius_graph_vertex_base_2 : public Vb {
public: public:
/// \name Creation /// \name Creation