edits to Reference and User manual; to fix: doxygen does not process figure in the User manual

This commit is contained in:
Iordan Iordanov 2018-08-24 18:02:13 +02:00
parent 751508cc48
commit 6fb5bd6e56
3 changed files with 22 additions and 23 deletions

View File

@ -35,11 +35,15 @@ The Delaunay triangulation of a set of points \f$\mathcal P\f$ in \f$\mathbb H^2
<li> A face is Delaunay hyperbolic if its circumscribing circle is contained in \f$\mathbb H^2\f$. <li> A face is Delaunay hyperbolic if its circumscribing circle is contained in \f$\mathbb H^2\f$.
</ul> </ul>
\cgalModifEnd \cgalModifEnd
For an illustration, see \cgalFigureRef{figEmptyDisks} For an illustration, see \cgalFigureRef{Hyperbolic_triangulation_2Empty_disks}
\cgalFigureBegin{figEmptyDisks, ht-empty-disks.png} \cgalFigureAnchor{Hyperbolic_triangulation_2Empty_disks}
<center>
<img src="ht-empty-disks.png" style="max-width:70%;"/>
</center>
\cgalFigureCaptionBegin{Hyperbolic_triangulation_2Empty_disks}
A face is Delaunay hyperbolic if its circumscribing disk is empty and is also contained in \f$\mathbb H^2\f$ (shaded face). An edge is hyperbolic if there exists at least one disk that passes through its endpoints and is contained in \f$\mathbb H^2\f$. An example of non-hyperbolic edge is the dashed segment: the disks that pass through its endpoints and are contained in \f$\mathbb H^2\f$ are not empty; on the other hand, the disks that pass through its endpoint and are empty, are not contained in \f$\mathbb H^2\f$. A face is Delaunay hyperbolic if its circumscribing disk is empty and is also contained in \f$\mathbb H^2\f$ (shaded face). An edge is hyperbolic if there exists at least one disk that passes through its endpoints and is contained in \f$\mathbb H^2\f$. An example of non-hyperbolic edge is the dashed segment: the disks that pass through its endpoints and are contained in \f$\mathbb H^2\f$ are not empty; on the other hand, the disks that pass through its endpoint and are empty, are not contained in \f$\mathbb H^2\f$.
\cgalFigureEnd \cgalFigureCaptionEnd
\section HT2_Design Design and Implementation History \section HT2_Design Design and Implementation History

View File

@ -23,9 +23,9 @@
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Monique Teillaud, Mikhail Bogdanov, and Iordan Iordanov} \cgalPkgAuthor{Monique Teillaud, Mikhail Bogdanov, and Iordan Iordanov}
\cgalPkgDesc{This package allows to build and handle Delaunay triangulations of point sets \cgalPkgDesc{This package allows to build and handle Delaunay triangulations of point sets
in the hyperbolic plane. Triangulations are built incrementally and can be modified by insertion or in the hyperbolic plane. Triangulations are built incrementally and can be modified by insertion
removal of vertices; point location facilities are also offered, as well as primitives to build the and removal of vertices; point location facilities are also offered, as well as primitives to
dual Voronoi diagrams.} build the dual Voronoi diagrams.}
\cgalPkgManuals{Chapter_2D_Hyperbolic_Triangulations,PkgHyperbolicTriangulation2} \cgalPkgManuals{Chapter_2D_Hyperbolic_Triangulations,PkgHyperbolicTriangulation2}
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
@ -39,36 +39,30 @@ dual Voronoi diagrams.}
\cgalPkgDescriptionEnd \cgalPkgDescriptionEnd
The main class of the 2D Hyperbolic Triangulation package is `CGAL::Hyperbolic_Delaunay_triangulation_2`. This class allows the constructions of Delaunay triangulations in the hyperbolic plane. `CGAL::Hyperbolic_Delaunay_triangulation_2` offers all the functionalities provided by `CGAL::Delaunay_triangulation_2`, such as point location, insertion and removal. Construction of the dual Voronoi diagram is also provided. The class takes a geometric traits and a triangulation data structure as template parameters. The Delaunay triangulation of a set of points \f$P\f$ in the hyperbolic plane \f$\mathbb H^2\f$ is a two-dimensional connected simplicial complex with vertex set defined by the points \f$P\f$. In fact, the hyperbolic Delaunay triangulation of \f$P\f$ is a subset of the Euclidean Delaunay triangulation of \f$P\f$. This package offers the necessary functionality to obtain the hyperbolic Delaunay triangulation of \f$P\f$ from the Euclidean Delaunay triangulation of \f$P\f$.
The geometric traits class must be a model of the concept \cgalClassifedRefPages
`HyperbolicDelaunayTriangulationTraits_2`. It must contain all predicates and constructions
that are needed by the functions in the triangulation class.
The triangulation data structure must be a model of `TriangulationDataStructure_2`, templated by a base ## Concepts ##
vertex and a base face class. The base face and base vertex classes must be models of the concepts `HyperbolicTriangulationFaceBase_2` and `TriangulationVertexBase_2`, respectively. The main concept `HyperbolicDelaunayTriangulationTraits_2` provides an interface for geometric objects, constructions, and predicates in the hyperbolic plane. The concept `HyperbolicTriangulationFaceBase_2` provides an interface that allows faces of the hyperbolic Delaunay triangulation to be filtered from the faces of the Euclidean Delaunay triangulation.
By default, the package uses `CGAL::Triangulation_data_structure_2< CGAL::Triangulation_vertex_base_2, CGAL::Hyperbolic_triangulation_face_base_2 >` to represent the triangulation data structure.
The three vertices incident to a face are indexed with 0, 1, and 2 in positive (counter-clockwise) orientation. Each vertex stores a point, and gives access to one of its incident faces. Each face, on the other hand, stores its incident vertices and neighboring faces.
# Concepts #
- `HyperbolicDelaunayTriangulationTraits_2` - `HyperbolicDelaunayTriangulationTraits_2`
- `HyperbolicTriangulationFaceBase_2` - `HyperbolicTriangulationFaceBase_2`
# Classes # ## Classes ##
## Main Classes ##
The main class of the 2D Hyperbolic Triangulation package, which allows the constructions of Delaunay triangulations in the hyperbolic plane, is `CGAL::Hyperbolic_Delaunay_triangulation_2`. It offers all the functionalities provided by `CGAL::Delaunay_triangulation_2`, such as point location, insertion and removal. Construction of the dual Voronoi diagram is also provided.
- `CGAL::Hyperbolic_Delaunay_triangulation_2` - `CGAL::Hyperbolic_Delaunay_triangulation_2`
## Traits Classes ##
Two models for the concept `HyperbolicDelaunayTriangulationTraits_2` are provided. The traits class `CGAL::Hyperbolic_Delaunay_triangulation_CK_traits_2` is based upon `CGAL::Circular_kernel_2` and guarantees exact computations when the input points have rational coordinates. The traits class `CGAL::Hyperbolic_Delaunay_triangulation_traits_2` is by default based upon `CGAL::Cartesian<CORE::Expr>` and guarantees exact computations with algebraic numbers. `CGAL::Hyperbolic_Delaunay_triangulation_traits_2` is used as base for the traits class in the package \ref PkgPeriodic4HyperbolicTriangulation2Summary.
- `CGAL::Hyperbolic_Delaunay_triangulation_traits_2` - `CGAL::Hyperbolic_Delaunay_triangulation_traits_2`
- `CGAL::Hyperbolic_Delaunay_triangulation_CK_traits_2` - `CGAL::Hyperbolic_Delaunay_triangulation_CK_traits_2`
## Face Classes ## Finally, two models for the concept `HyperbolicTriangulationFaceBase_2` are also provided.
- `CGAL::Hyperbolic_triangulation_face_base_2` - `CGAL::Hyperbolic_triangulation_face_base_2`
- `CGAL::Hyperbolic_triangulation_face_base_with_info_2` - `CGAL::Hyperbolic_triangulation_face_base_with_info_2`

View File

@ -9,4 +9,5 @@ Triangulation_2
Triangulation Triangulation
Spatial_sorting Spatial_sorting
Circular_kernel_2 Circular_kernel_2
Number_types Number_types
Periodic_4_hyperbolic_triangulation_2