diff --git a/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/CGAL/Hyperbolic_Delaunay_triangulation_2.h b/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/CGAL/Hyperbolic_Delaunay_triangulation_2.h index 3509f566b18..2960f5859af 100644 --- a/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/CGAL/Hyperbolic_Delaunay_triangulation_2.h +++ b/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/CGAL/Hyperbolic_Delaunay_triangulation_2.h @@ -7,7 +7,7 @@ namespace CGAL { /*! \ingroup PkgHyperbolicTriangulation2MainClasses -The class `Hyperbolic_Delaunay_triangulation_2` is the main class of the 2D Hyperbolic Triangulations package. +The class `Hyperbolic_Delaunay_triangulation_2` is the main class of the 2D Hyperbolic Delaunay Triangulations package. It is designed to represent Delaunay triangulations of sets of points in the hyperbolic plane. The hyperbolic plane is represented in the Poincaré disk model. diff --git a/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/Doxyfile.in b/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/Doxyfile.in index 66ed1b86431..c962f8ee5b8 100644 --- a/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/Doxyfile.in +++ b/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/Doxyfile.in @@ -4,6 +4,9 @@ EXTRACT_PRIVATE = NO EXAMPLE_PATH = ${CGAL_PACKAGE_DIR}/examples -PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - 2D Hyperbolic Triangulations" +PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - 2D Hyperbolic Delaunay Triangulations" -HTML_EXTRA_FILES = ${CGAL_PACKAGE_DOC_DIR}/fig/ht-empty-disks.png \ No newline at end of file +HTML_EXTRA_FILES = ${CGAL_PACKAGE_DOC_DIR}/fig/ht-empty-disks.png \ + ${CGAL_PACKAGE_DOC_DIR}/fig/poincare-disk.png \ + ${CGAL_PACKAGE_DOC_DIR}/fig/header.png \ + ${CGAL_PACKAGE_DOC_DIR}/fig/hyperbolic-vs-euclidean.png diff --git a/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/Hyperbolic_triangulation_2.txt b/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/Hyperbolic_triangulation_2.txt index ae2811adeb1..9be7ec92ea9 100644 --- a/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/Hyperbolic_triangulation_2.txt +++ b/Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/Hyperbolic_triangulation_2.txt @@ -11,16 +11,14 @@ namespace CGAL { \cgalAutoToc \author Mikhail Bogdanov, and Iordan Iordanov, and Monique Teillaud -\image html ht-450px.png +
+ +
-\cgalModifBegin -TODO image Delaunay + Voronoi a cote -\cgalModifEnd +This package allows to compute Delaunay triangulations of point sets in the Poincaré +disk model of the hyperbolic plane, as well as their dual objects. -This package allows to compute triangulations of point sets in the Poincaré -disk model of the hyperbolic plane. - -\section The Poincaré Disk Model of the Hyperbolic Plane +\section HT2_Poincare_model The Poincaré Disk Model of the Hyperbolic Plane The Poincaré disk model represents the hyperbolic plane \f$\mathbb H^2\f$ as the open unit disk centered at the origin in the Euclidean plane. The unit circle represents the set \f$\mathcal @@ -32,21 +30,35 @@ a diameter of the unit disk. A hyperbolic circle is a Euclidean circle contained in the unit disk; however, its hyperbolic center and radius are not the same as its Euclidean center and radius. -\cgalModifBegin -TODO figure showing \f$\mathcal H_\infty\f$ and O in black, 2 lines (one of each -kind) in e.g., blue, and a few co-circular circles in e.g., green -\cgalModifEnd +\cgalFigureAnchor{Hyperbolic_triangulation_2Poincare_disk} +
+ +
+\cgalFigureCaptionBegin{Hyperbolic_triangulation_2Poincare_disk} +The Poincaré disk model for the hyperbolic plane. The figure shows +two hyperbolic lines and three concentric hyperbolic circles with different +radii. +\cgalFigureCaptionEnd -\section Euclidean and Hyperbolic Delaunay Triangulations + +\section HT2_Euclidean_and_hyperbolic_Delaunay_triangulations Euclidean and Hyperbolic Delaunay Triangulations As hyperbolic circles coincide with Euclidean circles contained in the unit disk, the combinatorial structure of the hyperbolic Delaunay -triangulation of a set \f$\mathcal P\f of points in \f$\mathbb H^2\f$ +triangulation of a set \f$\mathcal P\f$ of points in \f$\mathbb H^2\f$ is a subset of the Euclidean Delaunay triangulation of \f$\mathcal -P\f. Of course, the hyperbolic and Euclidean geometric embeddings of a -given Delaunay face are different. -\cgalModifBegin -TODO maybe figure showing the 2 embeddings? -\cgalModifEnd +P\f$. Of course, the hyperbolic and Euclidean geometric embeddings of a +given Delaunay face are different. See +\cgalFigureRef{Hyperbolic_triangulation_2Euclidean_vs_hyperbolic}. + +\cgalFigureAnchor{Hyperbolic_triangulation_2Euclidean_vs_hyperbolic} +
+ +
+\cgalFigureCaptionBegin{Hyperbolic_triangulation_2Euclidean_vs_hyperbolic} +Comparison of the Euclidean (green) and hyperbolic (black) Delaunay triangulations +of a given set of points in the unit disk. Note that only the colored faces +are faces of the hyperbolic Delaunay triangulation. +\cgalFigureCaptionEnd More precisely, the hyperbolic Delaunay triangulation of \f$\mathcal P\f$ is a connected simplicial complex. It only @@ -58,20 +70,16 @@ are hyperbolic:
  • An Euclidean Delaunay edge is hyperbolic if one fo the empty disks (i.e., not containing any point of \f$\mathcal P\f$) passing through its endpoints is contained in \f$\mathbb - H^2\f. + H^2\f$. In the Euclidean Delaunay triangulation, there is a bijection between non-hyperbolic faces and non-hyperbolic edges \cgalCite{cgal:bdt-hdcvd-14}. See \cgalFigureRef{Hyperbolic_triangulation_2Empty_disks} -\cgalModifBegin -TODO fix bib entry: Delaunay and Voronoi should be capitalized -\cgalModifEnd - \cgalFigureAnchor{Hyperbolic_triangulation_2Empty_disks}
    - +
    \cgalFigureCaptionBegin{Hyperbolic_triangulation_2Empty_disks} The shaded face is non-hyperbolic. Its dashed edge is non-hyperbolic, @@ -79,24 +87,19 @@ as no empty circle through its endpoints is contained in \f$\mathbb H^2\f$. Its other two edges are hyperbolic. \cgalFigureCaptionEnd -\cgalModifBegin -TODO fix the picture so that it shows what is written in the caption. -\cgalModifEnd -\section Software Design +\section HT2_Software_design Software Design From what was said above, it is natural that the class `Hyperbolic_Delaunay_triangulation_2` privately inherits from the class `Delaunay_triangulation_2`. So, users are encouraged to look at the chapter -\cgalModifBegin -TODO link T2 -\cgalModifEnd -of the CGAL manual to know more in particular about the -representation of triangulations in CGAL and the flexibility of the design. +\ref Chapter_2D_Triangulations "2D Triangulation" of the CGAL manual to +know more in particular about the representation of triangulations in +CGAL and the flexibility of the design. The class `Hyperbolic_Delaunay_triangulation_2` has two template parameters: