From 5e351fe56ef5b53443a14c79c99ff60a48d19b21 Mon Sep 17 00:00:00 2001 From: Clement Jamin Date: Wed, 19 Mar 2014 18:00:48 +0100 Subject: [PATCH] Doc: some fixes according to Mariette's review --- .../Concepts/TriangulationDataStructure.h | 40 ++++++++----------- .../doc/Triangulation/Triangulation.txt | 4 +- 2 files changed, 19 insertions(+), 25 deletions(-) diff --git a/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h b/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h index 19ef5e656fd..7e322e86a7a 100644 --- a/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h +++ b/Triangulation/doc/Triangulation/Concepts/TriangulationDataStructure.h @@ -3,19 +3,16 @@ \ingroup PkgTriangulationsConcepts \cgalConcept -The `TriangulationDataStructure` concept describes objects responsible for storing and -maintaining the combinatorial part of a -\f$ d\f$-dimensional pure simplicial complex (all simplices that are not -sub-faces of another have the same dimension \f$ d\f$). -Its topology is the topology -of the sphere \f$ \mathcal S^d\f$ with \f$ d\in[-2,D]\f$. -In a pure (or homogeneous) simplicial \f$ d\f$-complex, all -faces are sub-faces of some \f$ d\f$-simplex. (A -simplex is also a face of itself.) In particular, it does not -contain any \f$ d+1\f$-face, and any \f$ d-1\f$-face belongs to exactly -two \f$ d\f$-dimensional full cells. +The `TriangulationDataStructure` concept describes objects responsible for +storing and maintaining the combinatorial part of a +\f$ d\f$-dimensional pure simplicial complex that has the topology +of the \f$ d\f$-dimensional sphere \f$ \mathcal S^d\f$ with \f$ d\in[-2,D]\f$. +Since the simplicial \f$ d\f$-complex is pure, all +faces are sub-faces of some \f$ d\f$-simplex. And since it has the +topology of the sphere \f$ \mathcal S^d\f$, it is manifold, thus +any \f$ d-1\f$-face belongs to exactly two \f$ d\f$-dimensional full cells. -Values of \f$ d\f$ (the current dimension of the complex) include +Possible values for the current dimension \f$ d\f$ include
-2
This corresponds to the non-existence of any object in @@ -43,7 +40,7 @@ is a proper face of \f$ \sigma\f$. We call a \f$ 0\f$-simplex a vertex, a \f$ (d-1)\f$-simplex a facet and a \f$ d\f$-simplex a full cell. A face can have any dimension. -Two full cells are adjacent if they share a facet. Two faces are +Two full cells are neighbors if they share a facet. Two faces are incident if one is included in the other. Input/Output @@ -86,14 +83,14 @@ public: /*! -Vertex type. +The vertex type. A model of the concept `TriangulationDSVertex`. */ typedef Hidden_type Vertex; /*! -Full cell type. +The full cell type. A model of the concept `TriangulationDSFullCell`. */ typedef Hidden_type Full_cell; @@ -101,7 +98,7 @@ typedef Hidden_type Full_cell; /*! The concept `TriangulationDataStructure` also defines a type for -describing facets of the triangulation with codimension 1. +describing faces of the triangulation with codimension 1. The constructor `Facet(c,i)` constructs a `Facet` representing the facet of full cell `c` opposite to its `i`-th vertex. Its dimension is @@ -140,24 +137,21 @@ typedef Hidden_type Full_cell_handle; /// @} /// \name Rebind -/// Requirements for `Vertex` and `Full_cell` are described in -/// concepts `TriangulationDataStructure::Vertex` and -/// `TriangulationDataStructure::FullCell` . /// @{ /*! This nested template class allows to get the type of a triangulation data structure that only changes the vertex type. It has to define a type -`Other` which is a rebound triangulation data structure, that is, the -one whose `TriangulationDSVertexBase` will be `Vb2`. +`Other` which is a rebound triangulation data structure with `Vb2` +as vertex type. */ typedef Hidden_type template struct Rebind_vertex; /*! This nested template class allows to get the type of a triangulation data structure that only changes the full cell type. It has to define a type -`Other` which is a rebound triangulation data structure, that is, the -one whose `TriangulationDSFullCellBase` will be `Fcb2`. +`Other` which is a rebound triangulation data structure with `Fcb2` +as full cell type. */ typedef Hidden_type template struct Rebind_full_cell; diff --git a/Triangulation/doc/Triangulation/Triangulation.txt b/Triangulation/doc/Triangulation/Triangulation.txt index fbe916c1808..57a3c314c0f 100644 --- a/Triangulation/doc/Triangulation/Triangulation.txt +++ b/Triangulation/doc/Triangulation/Triangulation.txt @@ -56,8 +56,8 @@ entry for more about simplicial complexes. ## What's in this package? ## -This \cgal package deals with pure finite simplicial complexes -without boundary, which +This \cgal package deals with pure simplicial complexes which are connected +and have no singularities, which we will simply call in the sequel triangulations. It provides three main classes for creating and manipulating triangulations.