From 45cf2c3f5aeb8506f0de0a58b0d0070c32dd50a5 Mon Sep 17 00:00:00 2001 From: Mariette Yvinec Date: Wed, 27 Aug 2003 10:22:31 +0000 Subject: [PATCH] fixed details and caption --- .../doc_tex/TDS_2/tds_user.tex | 13 +++++++----- .../TriangulationDataStructure_2.tex | 7 ++++--- .../Triangulation_2/triangulation_user.tex | 20 +++++++++++-------- .../Triangulation_face_base_with_info_2.tex | 2 +- .../Triangulation_2/doc_tex/basic/Makefile | 15 +++++++------- .../doc_tex/basic/TDS_2/tds_user.tex | 13 +++++++----- .../TriangulationDataStructure_2.tex | 7 ++++--- .../Triangulation_2/triangulation_user.tex | 20 +++++++++++-------- .../Triangulation_face_base_with_info_2.tex | 2 +- 9 files changed, 57 insertions(+), 42 deletions(-) diff --git a/Packages/Triangulation_2/doc_tex/TDS_2/tds_user.tex b/Packages/Triangulation_2/doc_tex/TDS_2/tds_user.tex index 60a0881d4ec..8ade2bbb2b4 100644 --- a/Packages/Triangulation_2/doc_tex/TDS_2/tds_user.tex +++ b/Packages/Triangulation_2/doc_tex/TDS_2/tds_user.tex @@ -40,11 +40,15 @@ The three vertices of a face are indexed with 0, 1 and 2. The neighbor of a face are also indexed with 0,1,2 in such a way that the neighbor indexed by \ccc{i} is opposite to the vertex with the same index. +See Figure~\ref{2D_TDS_Fig_neighbors1}, + the functions \ccc{ccw(i)} +and \ccc{cw(i)} shown on this figure +compute respectively $i+1$ and $i-1$ modulo 3 Each edge has two implicit representations : the edge of a face \ccc{f} which is opposed to the vertex indexed \ccc{i}, can be represented as well as an edge of the \ccc{neighbor(i)} of -\ccc{f}. See Figure~\ref{2D_Triangulation_Fig_neighbors1}. +\ccc{f}. \begin{figure} \begin{ccTexOnly} @@ -52,8 +56,7 @@ can be represented as well as an edge of the \ccc{neighbor(i)} of \includegraphics[width=6cm]{rep_bis.eps} \end{center} \end{ccTexOnly} - \caption{Vertices and neighbors. The function \ccc{ccw(i)} -and \ccc{cw(i)} compute respectively $i+1$ and $i-1$ modulo 3. + \caption{Vertices and neighbors. \label{2D_TDS_Fig_neighbors1}} \begin{ccHtmlOnly}
@@ -262,7 +265,7 @@ class Triangulation_data_structure { typedef Triangulation_data_structure Self; - // Rebind the vertex and cell base to the actual TDS (Self). + // Rebind the vertex and face base to the actual TDS (Self). typedef typename Vb::template Rebind_TDS::Other VertexBase; typedef typename Fb::template Rebind_TDS::Other FaceBase; @@ -318,7 +321,7 @@ store a data member of this type and gives acces to it. his own base classes from the default base classes : \ccc{Triangulation_ds_vertex_base_2}, and -\ccc{Triangulation_ds_cell_base_2} +\ccc{Triangulation_ds_face_base_2} are the default base classes to be plugged in a triangulation data structure used alone. Triangulation classes requires a data strucure in which diff --git a/Packages/Triangulation_2/doc_tex/TDS_2_ref/TriangulationDataStructure_2.tex b/Packages/Triangulation_2/doc_tex/TDS_2_ref/TriangulationDataStructure_2.tex index 966ddca96b3..7e8b626d12b 100644 --- a/Packages/Triangulation_2/doc_tex/TDS_2_ref/TriangulationDataStructure_2.tex +++ b/Packages/Triangulation_2/doc_tex/TDS_2_ref/TriangulationDataStructure_2.tex @@ -76,9 +76,10 @@ are decribed in concept \ccc{TriangulationDataStructure_2::Vertex} are decribed in concept \ccc{TriangulationDataStructure_2::Face} \lcTex{\ccRefPage{TriangulationDataStructure_2::Face}}.} -Vertices and cells are acessed via \ccc{handles}. -\ccc{handles} are trivial pointers supporting -the two dereference operators \ccc{operator*} and \ccc{operator->}. +Vertices and facess are accessed via \ccc{Vertex_handle} and +\ccc{Face_handle}. These types +are trivial pointers supporting +the two dereference operators \ccc{*} and \ccc{->}. \ccNestedType{Vertex_handle}{Handle to a vertex} \ccGlue diff --git a/Packages/Triangulation_2/doc_tex/Triangulation_2/triangulation_user.tex b/Packages/Triangulation_2/doc_tex/Triangulation_2/triangulation_user.tex index 466420ddfbb..a16f16218e6 100644 --- a/Packages/Triangulation_2/doc_tex/Triangulation_2/triangulation_user.tex +++ b/Packages/Triangulation_2/doc_tex/Triangulation_2/triangulation_user.tex @@ -212,13 +212,18 @@ The three vertices of a face are indexed with 0, 1 and 2 in counterclockwise order. The neighbor of a face are also indexed with 0,1,2 in such a way that the neighbor indexed by \ccc{i} is opposite to the vertex with the same index. +See Figure~\ref{2D_Triangulation_Fig_neighbors1}, + the functions \ccc{ccw(i)} +and \ccc{cw(i)} shown on this figure +compute respectively $i+1$ and $i-1$ modulo 3. The edges are not explicitly represented, they are only implicitely represented through the adjacency relations of two faces. Each edge has two implicit representations : the edge of a face \ccc{f} which is opposed to the vertex indexed \ccc{i}, can be represented as well as an edge of the \ccc{neighbor(i)} of -\ccc{f}. See Figure~\ref{2D_Triangulation_Fig_neighbors1}. +\ccc{f}. + \begin{figure} \begin{ccTexOnly} @@ -226,8 +231,7 @@ can be represented as well as an edge of the \ccc{neighbor(i)} of \includegraphics[width=6cm]{rep_bis.eps} \end{center} \end{ccTexOnly} - \caption{Vertices and neighbors. The function \ccc{ccw(i)} -and \ccc{cw(i)} compute respectively $i+1$ and $i-1$ modulo 3. + \caption{Vertices and neighbors. \label{2D_Triangulation_Fig_neighbors1} } \begin{ccHtmlOnly}
@@ -372,21 +376,21 @@ interface to a triangulation. The vertices and faces of the triangulations are accessed through \ccc{handles} \footnote{A handle is a type which supports the two -dereference operators \ccc{operator*} and \ccc{operator->}.}, +dereference operators \ccc{*} and \ccc{->}.}, \ccc{iterators} and \ccc{circulators} \footnote{A circulator is a type devoted to visit circular sequences.}. \end{ccTexOnly} \begin{ccHtmlOnly} The vertices and faces of the triangulations are accessed through -\ccc{handles}, -\ccc{iterators} and \ccc{circulators}. +handles, +iterators, and circulators. (A handle is a type which supports the two -dereference operators \ccc{operator*} and \ccc{operator->}, +dereference operators * and -> , a circulator is a type devoted to visit circular sequences.) \end{ccHtmlOnly} Handles are used whenever the accessed element is not part of a sequence. -iterators and circulators are used +Iterators and circulators are used to visit all or parts of the triangulation. The iterators and circulators diff --git a/Packages/Triangulation_2/doc_tex/Triangulation_2_ref/Triangulation_face_base_with_info_2.tex b/Packages/Triangulation_2/doc_tex/Triangulation_2_ref/Triangulation_face_base_with_info_2.tex index 45de794d757..5c847725631 100644 --- a/Packages/Triangulation_2/doc_tex/Triangulation_2_ref/Triangulation_face_base_with_info_2.tex +++ b/Packages/Triangulation_2/doc_tex/Triangulation_2_ref/Triangulation_face_base_with_info_2.tex @@ -63,7 +63,7 @@ or \ccc{RegularTriangulationFaceBase_2} {Returns a const reference to the object of type \ccc{Info} stored in the face.} \ccGlue \ccMethod{Info & info();} -{Returns a reference to the object of type \ccc{Info} stored in the cell.} +{Returns a reference to the object of type \ccc{Info} stored in the face.} \ccSeeAlso \ccc{CGAL::Triangulation_face_base_2} \\ diff --git a/Packages/Triangulation_2/doc_tex/basic/Makefile b/Packages/Triangulation_2/doc_tex/basic/Makefile index d4f39428c1d..7181eda8f43 100644 --- a/Packages/Triangulation_2/doc_tex/basic/Makefile +++ b/Packages/Triangulation_2/doc_tex/basic/Makefile @@ -1,15 +1,14 @@ all : doc_ps doc_html -#LATEX_CONV_INPUTS=.:../../examples:Triangulation_2:TDS_2:Triangulation_2_ref:TDS2_ref: -#TEXINPUTS=.:/0/prisme_util/latex:/u/abeille/0/prisme/yvinec/tex/inputs:Triangulation_2:TDS_2:../../examples:Triangulation_2_ref:TD2_ref: +LOCALINPUTS=.:../../examples:Triangulation_2:TDS_2:Triangulation_2_ref:TDS2_ref: doc_ps : - latex wrapper + TEXINPUTS=${LOCALINPUTS}${TEXINPUTS} latex wrapper bibtex wrapper makeindex wrapper index_fix wrapper.ind - latex wrapper - dvips wrapper -o + TEXINPUTS=${LOCALINPUTS}${TEXINPUTS} latex wrapper + TEXINPUTS=${LOCALINPUTS}${TEXINPUTS} dvips wrapper -o doc_html : rm -rf ../../doc_html/basic/ @@ -17,13 +16,13 @@ doc_html : mkdir -p ../../doc_html/basic/Triangulation_2_ref mkdir -p ../../doc_html/basic/TDS_2 mkdir -p ../../doc_html/basic/TDS_2_ref - LATEX_CONV_INPUTS=.:Triangulation_2:TDS_2:Triangulation_2_ref:TDS2_ref\ + LATEX_CONV_INPUTS=${LOCALINPUTS}$ \ cc_manual_to_html -o ../../doc_html/basic/Triangulation_2\ Triangulation_2/main.tex - LATEX_CONV_INPUTS=.:Triangulation_2:TDS_2:Triangulation_2_ref:TDS2_ref\ + LATEX_CONV_INPUTS=${LOCALINPUTS}$ \ cc_manual_to_html -o ../../doc_html/basic/Triangulation_2_ref \ Triangulation_2_ref/main.tex - LATEX_CONV_INPUTS=.:Triangulation_2:TDS_2:Triangulation_2_ref:TDS2_ref\ + LATEX_CONV_INPUTS=${LOCALINPUTS}$ \ cc_manual_to_html -o ../../doc_html/basic/TDS_2 \ TDS_2/main.tex LATEX_CONV_INPUTS=.:Triangulation_2:TDS_2:Triangulation_2_ref:TDS2_ref\ diff --git a/Packages/Triangulation_2/doc_tex/basic/TDS_2/tds_user.tex b/Packages/Triangulation_2/doc_tex/basic/TDS_2/tds_user.tex index 60a0881d4ec..8ade2bbb2b4 100644 --- a/Packages/Triangulation_2/doc_tex/basic/TDS_2/tds_user.tex +++ b/Packages/Triangulation_2/doc_tex/basic/TDS_2/tds_user.tex @@ -40,11 +40,15 @@ The three vertices of a face are indexed with 0, 1 and 2. The neighbor of a face are also indexed with 0,1,2 in such a way that the neighbor indexed by \ccc{i} is opposite to the vertex with the same index. +See Figure~\ref{2D_TDS_Fig_neighbors1}, + the functions \ccc{ccw(i)} +and \ccc{cw(i)} shown on this figure +compute respectively $i+1$ and $i-1$ modulo 3 Each edge has two implicit representations : the edge of a face \ccc{f} which is opposed to the vertex indexed \ccc{i}, can be represented as well as an edge of the \ccc{neighbor(i)} of -\ccc{f}. See Figure~\ref{2D_Triangulation_Fig_neighbors1}. +\ccc{f}. \begin{figure} \begin{ccTexOnly} @@ -52,8 +56,7 @@ can be represented as well as an edge of the \ccc{neighbor(i)} of \includegraphics[width=6cm]{rep_bis.eps} \end{center} \end{ccTexOnly} - \caption{Vertices and neighbors. The function \ccc{ccw(i)} -and \ccc{cw(i)} compute respectively $i+1$ and $i-1$ modulo 3. + \caption{Vertices and neighbors. \label{2D_TDS_Fig_neighbors1}} \begin{ccHtmlOnly}
@@ -262,7 +265,7 @@ class Triangulation_data_structure { typedef Triangulation_data_structure Self; - // Rebind the vertex and cell base to the actual TDS (Self). + // Rebind the vertex and face base to the actual TDS (Self). typedef typename Vb::template Rebind_TDS::Other VertexBase; typedef typename Fb::template Rebind_TDS::Other FaceBase; @@ -318,7 +321,7 @@ store a data member of this type and gives acces to it. his own base classes from the default base classes : \ccc{Triangulation_ds_vertex_base_2}, and -\ccc{Triangulation_ds_cell_base_2} +\ccc{Triangulation_ds_face_base_2} are the default base classes to be plugged in a triangulation data structure used alone. Triangulation classes requires a data strucure in which diff --git a/Packages/Triangulation_2/doc_tex/basic/TDS_2_ref/TriangulationDataStructure_2.tex b/Packages/Triangulation_2/doc_tex/basic/TDS_2_ref/TriangulationDataStructure_2.tex index 966ddca96b3..7e8b626d12b 100644 --- a/Packages/Triangulation_2/doc_tex/basic/TDS_2_ref/TriangulationDataStructure_2.tex +++ b/Packages/Triangulation_2/doc_tex/basic/TDS_2_ref/TriangulationDataStructure_2.tex @@ -76,9 +76,10 @@ are decribed in concept \ccc{TriangulationDataStructure_2::Vertex} are decribed in concept \ccc{TriangulationDataStructure_2::Face} \lcTex{\ccRefPage{TriangulationDataStructure_2::Face}}.} -Vertices and cells are acessed via \ccc{handles}. -\ccc{handles} are trivial pointers supporting -the two dereference operators \ccc{operator*} and \ccc{operator->}. +Vertices and facess are accessed via \ccc{Vertex_handle} and +\ccc{Face_handle}. These types +are trivial pointers supporting +the two dereference operators \ccc{*} and \ccc{->}. \ccNestedType{Vertex_handle}{Handle to a vertex} \ccGlue diff --git a/Packages/Triangulation_2/doc_tex/basic/Triangulation_2/triangulation_user.tex b/Packages/Triangulation_2/doc_tex/basic/Triangulation_2/triangulation_user.tex index 466420ddfbb..a16f16218e6 100644 --- a/Packages/Triangulation_2/doc_tex/basic/Triangulation_2/triangulation_user.tex +++ b/Packages/Triangulation_2/doc_tex/basic/Triangulation_2/triangulation_user.tex @@ -212,13 +212,18 @@ The three vertices of a face are indexed with 0, 1 and 2 in counterclockwise order. The neighbor of a face are also indexed with 0,1,2 in such a way that the neighbor indexed by \ccc{i} is opposite to the vertex with the same index. +See Figure~\ref{2D_Triangulation_Fig_neighbors1}, + the functions \ccc{ccw(i)} +and \ccc{cw(i)} shown on this figure +compute respectively $i+1$ and $i-1$ modulo 3. The edges are not explicitly represented, they are only implicitely represented through the adjacency relations of two faces. Each edge has two implicit representations : the edge of a face \ccc{f} which is opposed to the vertex indexed \ccc{i}, can be represented as well as an edge of the \ccc{neighbor(i)} of -\ccc{f}. See Figure~\ref{2D_Triangulation_Fig_neighbors1}. +\ccc{f}. + \begin{figure} \begin{ccTexOnly} @@ -226,8 +231,7 @@ can be represented as well as an edge of the \ccc{neighbor(i)} of \includegraphics[width=6cm]{rep_bis.eps} \end{center} \end{ccTexOnly} - \caption{Vertices and neighbors. The function \ccc{ccw(i)} -and \ccc{cw(i)} compute respectively $i+1$ and $i-1$ modulo 3. + \caption{Vertices and neighbors. \label{2D_Triangulation_Fig_neighbors1} } \begin{ccHtmlOnly}
@@ -372,21 +376,21 @@ interface to a triangulation. The vertices and faces of the triangulations are accessed through \ccc{handles} \footnote{A handle is a type which supports the two -dereference operators \ccc{operator*} and \ccc{operator->}.}, +dereference operators \ccc{*} and \ccc{->}.}, \ccc{iterators} and \ccc{circulators} \footnote{A circulator is a type devoted to visit circular sequences.}. \end{ccTexOnly} \begin{ccHtmlOnly} The vertices and faces of the triangulations are accessed through -\ccc{handles}, -\ccc{iterators} and \ccc{circulators}. +handles, +iterators, and circulators. (A handle is a type which supports the two -dereference operators \ccc{operator*} and \ccc{operator->}, +dereference operators * and -> , a circulator is a type devoted to visit circular sequences.) \end{ccHtmlOnly} Handles are used whenever the accessed element is not part of a sequence. -iterators and circulators are used +Iterators and circulators are used to visit all or parts of the triangulation. The iterators and circulators diff --git a/Packages/Triangulation_2/doc_tex/basic/Triangulation_2_ref/Triangulation_face_base_with_info_2.tex b/Packages/Triangulation_2/doc_tex/basic/Triangulation_2_ref/Triangulation_face_base_with_info_2.tex index 45de794d757..5c847725631 100644 --- a/Packages/Triangulation_2/doc_tex/basic/Triangulation_2_ref/Triangulation_face_base_with_info_2.tex +++ b/Packages/Triangulation_2/doc_tex/basic/Triangulation_2_ref/Triangulation_face_base_with_info_2.tex @@ -63,7 +63,7 @@ or \ccc{RegularTriangulationFaceBase_2} {Returns a const reference to the object of type \ccc{Info} stored in the face.} \ccGlue \ccMethod{Info & info();} -{Returns a reference to the object of type \ccc{Info} stored in the cell.} +{Returns a reference to the object of type \ccc{Info} stored in the face.} \ccSeeAlso \ccc{CGAL::Triangulation_face_base_2} \\