From 174fde081e67b8093c251797b8c10a38d2c86a90 Mon Sep 17 00:00:00 2001 From: Clement Jamin Date: Fri, 23 May 2014 17:02:52 +0200 Subject: [PATCH] Update doc according to Menelaos review --- .../doc/Triangulation/CGAL/Delaunay_triangulation.h | 1 - .../doc/Triangulation/Concepts/TriangulationTraits.h | 4 +++- Triangulation/doc/Triangulation/Triangulation.txt | 10 +++++----- Triangulation/include/CGAL/Delaunay_triangulation.h | 2 +- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/Triangulation/doc/Triangulation/CGAL/Delaunay_triangulation.h b/Triangulation/doc/Triangulation/CGAL/Delaunay_triangulation.h index e6eaec684a4..7350650db9d 100644 --- a/Triangulation/doc/Triangulation/CGAL/Delaunay_triangulation.h +++ b/Triangulation/doc/Triangulation/CGAL/Delaunay_triangulation.h @@ -161,7 +161,6 @@ Full_cell_handle c); Returns `true` if and only if the point `p` is in (Delaunay) conflict with full cell `c` (i.e., the circumscribing ball of \f$ c\f$ contains \f$ p\f$ in its interior). - */ bool is_in_conflict(const Point & p, Full_cell_const_handle c) const; diff --git a/Triangulation/doc/Triangulation/Concepts/TriangulationTraits.h b/Triangulation/doc/Triangulation/Concepts/TriangulationTraits.h index 89767c4ee57..058735e0d2b 100644 --- a/Triangulation/doc/Triangulation/Concepts/TriangulationTraits.h +++ b/Triangulation/doc/Triangulation/Concepts/TriangulationTraits.h @@ -9,7 +9,9 @@ It brings the geometric ingredient to the definition of a triangulation, while the combinatorial ingredient is brought by the second template parameter, `TriangulationDataStructure`. -\cgalRefines `SpatialSortingTraits_d` If a range of points is inserted, the +\cgalRefines `SpatialSortingTraits_d` + +If a range of points is inserted, the traits must refine `SpatialSortingTraits_d` (this operation is optimized using spatial sorting). This is not required if the points are inserted one by one. diff --git a/Triangulation/doc/Triangulation/Triangulation.txt b/Triangulation/doc/Triangulation/Triangulation.txt index 81f9d9dc1f7..b8558d8a28a 100644 --- a/Triangulation/doc/Triangulation/Triangulation.txt +++ b/Triangulation/doc/Triangulation/Triangulation.txt @@ -132,12 +132,12 @@ us denote the maximal dimension with \f$ D \f$ and the current dimension with \f The inequalities \f$ -2 \leq d \leq D\f$ and \f$ 0 \le D\f$ always hold. The special meaning of negative values for \f$d\f$ is explained below. -### The data structure triangulates \f$ \mathcal S^d\f$ ### +### The data structure triangulates \f$ \mathbb{S}^d\f$ ### A `TriangulationDataStructure` can be viewed as -a triangulation of the topological sphere \f$ \mathcal S^d\f$, +a triangulation of the topological sphere \f$ \mathbb{S}^d\f$, i.e., its faces can be embedded to form a partition of -\f$ \mathcal S^d\f$ into \f$d\f$-simplices. +\f$ \mathbb{S}^d\f$ into \f$d\f$-simplices. One nice consequence of the above important fact is that a full cell has always exactly \f$ d+1\f$ neighbors. @@ -157,7 +157,7 @@ the two full cells being neighbors of each other. This is the unique triangulation of the \f$ 0\f$-sphere.
\f$ 0< d \le D\f$
This corresponds to a triangulation of -the sphere \f$ \mathcal S^d\f$. +the sphere \f$ \mathbb{S}^d\f$. @@ -357,7 +357,7 @@ structure as described in the previous section. The following example shows how to construct a triangulation in which we insert random points. In `STEP 1`, we generate one hundred random points in -\f$ \mathcal R^5\f$, which we then insert into a triangulation. In `STEP 2`, we +\f$ \mathbb{R}^5\f$, which we then insert into a triangulation. In `STEP 2`, we ask the triangulation to construct the set of edges (\f$ 1\f$ dimensional faces) incident to the vertex at infinity. It is easy to see that these edges are in bijection with the vertices on the convex hull of the diff --git a/Triangulation/include/CGAL/Delaunay_triangulation.h b/Triangulation/include/CGAL/Delaunay_triangulation.h index 1d4bf8906a6..4bed54a75c7 100644 --- a/Triangulation/include/CGAL/Delaunay_triangulation.h +++ b/Triangulation/include/CGAL/Delaunay_triangulation.h @@ -178,7 +178,7 @@ public: // the user can specify a Flat_orientation_d object to be used for // orienting simplices of a specific dimension // (= preset_flat_orientation_.first) - // It it used for by dark triangulations created by DT::remove + // It it used by the dark triangulations created by DT::remove Delaunay_triangulation( int dim, const std::pair &preset_flat_orientation,