songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Corrections demandees par Susan pour 2.3-*

This commit is contained in:
Monique Teillaud 2000-10-16 11:35:28 +00:00
parent be87b85245
commit 43a22b039b
14 changed files with 80 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Packages/Triangulation_3/doc_tex/Triangulation_3/TDS3.tex
View File

@ -283,7 +283,7 @@ It is up to the user to derive his own base classes from the \cgal\
base classes to add any other information he may need for his given
application, or to write his own base classes from scratch. In this
case, the base classes must be models for the concepts described in
\ccRefPage{Triangulation_vb_3} and \ccRefPage{Triangulation_cb_3}.
\ccc{Triangulation_vb_3} and \ccc{Triangulation_cb_3}.
The upper layer, described in Chapter~\ref{chapter-Triangulation3}, is
the geometric triangulation class, providing operations such as

42
Packages/Triangulation_3/doc_tex/Triangulation_3/Triang3.tex
View File

@ -164,7 +164,8 @@ sufficient for practical cases.
\section{Software Design}
\label{Triangulation3-sec-design}
The class \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>} is designed to be used as
The class \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>} is
designed to be used as
a layer upon a 3D-triangulation data structure as presented in
Section~\ref{TDS3-sec-design} of Chapter~\ref{chapter-TDS3}.
It provides high level geometric operations such as location of a point
@ -174,11 +175,13 @@ the geometric validity. This class is parameterized by two classes:
\item {} the \textbf{geometric traits} class, where the user can
specify the type of points to use as well as the elementary
operations on them (predicates,\ldots). The concept of such a class is
introduced in Section~\ref{Triangulation3-sec-Traits} and described in
\ccRefPage{Triangulation_traits_3} and a
introduced in Section~\ref{Triangulation3-sec-Traits}\lcTex{ and described in
\ccRefPage{Triangulation_traits_3}} and a
model is provided by \cgal\
(see \ccRefPage{CGAL::Triangulation_geom_traits_3<R>} and
\ccRefPage{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>}).
(see \ccc{CGAL::Triangulation_geom_traits_3<R>}\lcTex{
(\ccRefPage{CGAL::Triangulation_geom_traits_3<R>})} and
\ccc{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>}\lcTex{
(\ccRefPage{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>})}.
\item {} the \textbf{triangulation data structure} class of the middle level,
described in Chapter~\ref{chapter-TDS3}.
\end{itemize}
@ -194,8 +197,8 @@ Delaunay triangulations are not yet implemented.)}
\ccc{Triangulation_3<Triangulation_traits_3,Tds_3>} derives from
\ccc{Triangulation_utils_3<Triangulation_traits_3,Tds_3>},
which defines a set of tools
working on the indices of vertices in cells
(\ccRefPage{CGAL::Triangulation_utils_3}).
working on the indices of vertices in cells\lcTex{
(\ccRefPage{CGAL::Triangulation_utils_3})}.
\subsection{Basic Triangulation}
@ -203,9 +206,13 @@ working on the indices of vertices in cells
\textit{geometric traits class} as its first template argument and a model
of a \textit{triangulation data structure} as its second argument. The
requirements and defaults for these classes are described in
\ccRefPage{Triangulation_traits_3},
\ccRefPage{CGAL::Triangulation_geom_traits_3<R>} and
\ccRefPage{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>}.
the reference pages for Triangulation\_traits\_3\lcTex{ (
\ccRefPage{Triangulation_traits_3})},
\ccc{CGAL::Triangulation_geom_traits_3<R>}\lcTex{
(\ccRefPage{CGAL::Triangulation_geom_traits_3<R>})} and
\ccc{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>}\lcTex{
(\ccRefPage{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>})}.
%\subsection{The Vertex of a Triangulation}
%\label{Triangulation3-sec-class-Vertex}
@ -387,10 +394,10 @@ by \cgal, a class must provide definitions for the \textit{power tests}.
geometric objects and predicates.
This class is templated with a representation class.
The traits class \ccClassTemplateName\ is designed to deal with \cgal\ three
dimensional points. It supplies the user with all
the functionalities described in
\ccRefPage{Triangulation_traits_3}.
The traits class \ccClassTemplateName\ is designed to deal with \cgal\
three-dimensional points. It supplies the user with all
the functionalities described for the concept
Triangulation\_traits\_3\lcTex{ (\ccRefPage{Triangulation_traits_3})}.
So, it can be used as a default traits
class for \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>},
\ccc{Delaunay_triangulation_3<Triangulation_traits_3,Tds_3>} and
@ -403,7 +410,8 @@ class for \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>},
provided by the class, which derives from the \cgal\ three dimensional
point class. It supplies
the user with all the functionalities
described in \ccRefPage{Triangulation_traits_3}.
described for the concept Triangulation\_traits\_3\lcTex{
(\ccRefPage{Triangulation_traits_3})}.
It can be used as a default traits
class for \ccc{Regular_triangulation_3<Triangulation_traits_3,Tds_3>}.
@ -436,8 +444,8 @@ The second template parameter of the basic triangulation class
data structure class. This class can be seen as a container for the
cells and vertices maintaining incidence and adjacency relations (see
Chapter~\ref{chapter-TDS3}). A model of this triangulation data
structure is \ccc{Triangulation_data_structure_3}
(\ccRefPage{CGAL::Triangulation_data_structure_3<Triangulation_vb_3,Triangulation_cb_3>}).
structure is \ccc{Triangulation_data_structure_3}\lcTex{
(\ccRefPage{CGAL::Triangulation_data_structure_3<Triangulation_vb_3,Triangulation_cb_3>})}.
\section{Examples}
\label{Triangulation3-sec-examples}

4
Packages/Triangulation_3/doc_tex/Triangulation_3/Triangulation_3_ref/Triangulation_3/Triangulation_traits_3.tex
View File

@ -28,7 +28,7 @@ equality, coordinate comparison, orientation in space, orientation
in case of coplanar points, and collinearity tests.
\ccTypes
\ccThree{Triangulation_traits_3::Tetrahedron}{tds.set_number_of_vertices()}{}
\ccTwo{Triangulation_traits_3::Tetrahedron}{}
\ccNestedType{Point}
{The type must provide a copy constructor and assignment operator.}
@ -56,6 +56,8 @@ Only a default constructor is required.
\ccOperations
\ccThree{Comparison_result}{traits.orientation_in_plane( Point q, Point r, Point s, Point test)}{}
\ccHeading{Predicates}
\ccMethod{bool equal(const Point & p, const Point & q) const;}
{Equality test.}

7
Packages/Triangulation_3/doc_tex/Triangulation_3/Triangulation_3_ref/Triangulation_3/Triangulation_vertex_3.tex
View File

@ -28,7 +28,8 @@ maximal dimension.
\ccc{Tds_3::Vertex}
\ccTypes
\ccThree{typedef triple <Cell*, int, int>}{Facettoto}{}
\ccThree{typedef Triangulation_traits_3::Pointxx}{Pointxx}{}
\ccThreeToTwo
The class \ccClassTemplateName\ defines the following types, also
defined in the class \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>}:
@ -38,7 +39,6 @@ defined in the class \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>}:
\ccGlue
\ccNestedType{Cell_handle}{handle to a cell}
\ccCreation
\ccCreationVariable{v} %% choose variable name
\begin{ccAdvanced}
@ -109,9 +109,6 @@ of maximal dimension (Section~\ref{Triangulation3-sec-degen_dim}).}
\ccc{CGAL::Triangulation_3<Triangulation_traits_3,Tds_3>::Cell}.
\ccExample
\end{ccRefClass}
% +------------------------------------------------------------------------+

8
Packages/Triangulation_3/doc_tex/Triangulation_3/Triangulation_3_ref/Triangulation_data_structure_3/Tds_3.tex
View File

@ -57,8 +57,8 @@ data structure class. (See Chapter~\ref{chapter-TDS3}.)
To ensure all the \textbf{flexibility} of class \ccc{Triangulation_3}
described in
\ccRefPage{CGAL::Triangulation_3<Triangulation_traits_3,Tds_3>}
and in Chapter~\ref{chapter-Triangulation3}, a model of a
\lcTex{ \ccRefPage{CGAL::Triangulation_3<Triangulation_traits_3,Tds_3>}
and in } Chapter~\ref{chapter-Triangulation3}, a model of a
triangulation data structure must be templated by the base vertex and
the base cell classes (see~\ref{TDS3-sec-intro}):
\ccc{Tds_3<Triangulation_vb_3,Triangulation_cb_3>}.
@ -75,11 +75,13 @@ operations.
\ccThree{typedef triple <Cell*, int, int>}{Facet }{}
\ccThreeToTwo
\ccNestedType{Vertex }{Vertex}
\ccNestedType{Vertex }{}
\ccGlue
\ccNestedType{Cell}{Cell type}
\lcTex{
Requirements for \ccc{Vertex} and \ccc{Cell} are described in
\ccRefPage{Tds_3::Vertex} and \ccRefPage{Tds_3::Cell}.
}
\ccTypedef{typedef triple<Cell*, int, int> Edge;}{\ccc{(c,i,j)} is the
edge of cell \ccc{c} whose vertices indices are \ccc{i} and

4
Packages/Triangulation_3/doc_tex/Triangulation_3/Triangulation_3_ref/Triangulation_data_structure_3/Triangulation_cell_base_3.tex
View File

@ -19,9 +19,9 @@
\ccDefinition
The class \ccRefName\ is provided by \cgal\ as a base cell class,
and is similar to the base vertex classes. (See
and is similar to the base vertex classes. \lcTex{(See
\ccRefPage{CGAL::Triangulation_vertex_base_3<Triangulation_traits_3>} and
\ccRefPage{CGAL::Triangulation_vertex_base_pointer_3<Triangulation_traits_3>}.)
\ccRefPage{CGAL::Triangulation_vertex_base_pointer_3<Triangulation_traits_3>}.)}
\ccInclude{CGAL/Triangulation_cell_base_3.h}

4
Packages/Triangulation_3/doc_tex/Triangulation_3/Triangulation_3_ref/Triangulation_data_structure_3/Triangulation_data_structure_3.tex
View File

@ -22,8 +22,8 @@ and provides the optional
geometric functionalities to be used as a parameter for a
3D-geometric triangulation (see Chapter~\ref{chapter-Triangulation3}.
It is templated by base classes for vertices and cells.
(See \ccRefPage{Triangulation_vb_3}
and \ccRefPage{Triangulation_cb_3}.)
\lcTex{(See \ccRefPage{Triangulation_vb_3}
and \ccRefPage{Triangulation_cb_3}.)}
\ccIsModel

2
Packages/Triangulation_3/doc_tex/basic/Triangulation_3/TDS3.tex
View File

@ -283,7 +283,7 @@ It is up to the user to derive his own base classes from the \cgal\
base classes to add any other information he may need for his given
application, or to write his own base classes from scratch. In this
case, the base classes must be models for the concepts described in
\ccRefPage{Triangulation_vb_3} and \ccRefPage{Triangulation_cb_3}.
\ccc{Triangulation_vb_3} and \ccc{Triangulation_cb_3}.
The upper layer, described in Chapter~\ref{chapter-Triangulation3}, is
the geometric triangulation class, providing operations such as

42
Packages/Triangulation_3/doc_tex/basic/Triangulation_3/Triang3.tex
View File

@ -164,7 +164,8 @@ sufficient for practical cases.
\section{Software Design}
\label{Triangulation3-sec-design}
The class \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>} is designed to be used as
The class \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>} is
designed to be used as
a layer upon a 3D-triangulation data structure as presented in
Section~\ref{TDS3-sec-design} of Chapter~\ref{chapter-TDS3}.
It provides high level geometric operations such as location of a point
@ -174,11 +175,13 @@ the geometric validity. This class is parameterized by two classes:
\item {} the \textbf{geometric traits} class, where the user can
specify the type of points to use as well as the elementary
operations on them (predicates,\ldots). The concept of such a class is
introduced in Section~\ref{Triangulation3-sec-Traits} and described in
\ccRefPage{Triangulation_traits_3} and a
introduced in Section~\ref{Triangulation3-sec-Traits}\lcTex{ and described in
\ccRefPage{Triangulation_traits_3}} and a
model is provided by \cgal\
(see \ccRefPage{CGAL::Triangulation_geom_traits_3<R>} and
\ccRefPage{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>}).
(see \ccc{CGAL::Triangulation_geom_traits_3<R>}\lcTex{
(\ccRefPage{CGAL::Triangulation_geom_traits_3<R>})} and
\ccc{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>}\lcTex{
(\ccRefPage{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>})}.
\item {} the \textbf{triangulation data structure} class of the middle level,
described in Chapter~\ref{chapter-TDS3}.
\end{itemize}
@ -194,8 +197,8 @@ Delaunay triangulations are not yet implemented.)}
\ccc{Triangulation_3<Triangulation_traits_3,Tds_3>} derives from
\ccc{Triangulation_utils_3<Triangulation_traits_3,Tds_3>},
which defines a set of tools
working on the indices of vertices in cells
(\ccRefPage{CGAL::Triangulation_utils_3}).
working on the indices of vertices in cells\lcTex{
(\ccRefPage{CGAL::Triangulation_utils_3})}.
\subsection{Basic Triangulation}
@ -203,9 +206,13 @@ working on the indices of vertices in cells
\textit{geometric traits class} as its first template argument and a model
of a \textit{triangulation data structure} as its second argument. The
requirements and defaults for these classes are described in
\ccRefPage{Triangulation_traits_3},
\ccRefPage{CGAL::Triangulation_geom_traits_3<R>} and
\ccRefPage{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>}.
the reference pages for Triangulation\_traits\_3\lcTex{ (
\ccRefPage{Triangulation_traits_3})},
\ccc{CGAL::Triangulation_geom_traits_3<R>}\lcTex{
(\ccRefPage{CGAL::Triangulation_geom_traits_3<R>})} and
\ccc{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>}\lcTex{
(\ccRefPage{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>})}.
%\subsection{The Vertex of a Triangulation}
%\label{Triangulation3-sec-class-Vertex}
@ -387,10 +394,10 @@ by \cgal, a class must provide definitions for the \textit{power tests}.
geometric objects and predicates.
This class is templated with a representation class.
The traits class \ccClassTemplateName\ is designed to deal with \cgal\ three
dimensional points. It supplies the user with all
the functionalities described in
\ccRefPage{Triangulation_traits_3}.
The traits class \ccClassTemplateName\ is designed to deal with \cgal\
three-dimensional points. It supplies the user with all
the functionalities described for the concept
Triangulation\_traits\_3\lcTex{ (\ccRefPage{Triangulation_traits_3})}.
So, it can be used as a default traits
class for \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>},
\ccc{Delaunay_triangulation_3<Triangulation_traits_3,Tds_3>} and
@ -403,7 +410,8 @@ class for \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>},
provided by the class, which derives from the \cgal\ three dimensional
point class. It supplies
the user with all the functionalities
described in \ccRefPage{Triangulation_traits_3}.
described for the concept Triangulation\_traits\_3\lcTex{
(\ccRefPage{Triangulation_traits_3})}.
It can be used as a default traits
class for \ccc{Regular_triangulation_3<Triangulation_traits_3,Tds_3>}.
@ -436,8 +444,8 @@ The second template parameter of the basic triangulation class
data structure class. This class can be seen as a container for the
cells and vertices maintaining incidence and adjacency relations (see
Chapter~\ref{chapter-TDS3}). A model of this triangulation data
structure is \ccc{Triangulation_data_structure_3}
(\ccRefPage{CGAL::Triangulation_data_structure_3<Triangulation_vb_3,Triangulation_cb_3>}).
structure is \ccc{Triangulation_data_structure_3}\lcTex{
(\ccRefPage{CGAL::Triangulation_data_structure_3<Triangulation_vb_3,Triangulation_cb_3>})}.
\section{Examples}
\label{Triangulation3-sec-examples}

4
Packages/Triangulation_3/doc_tex/basic/Triangulation_3/Triangulation_3_ref/Triangulation_3/Triangulation_traits_3.tex
View File

@ -28,7 +28,7 @@ equality, coordinate comparison, orientation in space, orientation
in case of coplanar points, and collinearity tests.
\ccTypes
\ccThree{Triangulation_traits_3::Tetrahedron}{tds.set_number_of_vertices()}{}
\ccTwo{Triangulation_traits_3::Tetrahedron}{}
\ccNestedType{Point}
{The type must provide a copy constructor and assignment operator.}
@ -56,6 +56,8 @@ Only a default constructor is required.
\ccOperations
\ccThree{Comparison_result}{traits.orientation_in_plane( Point q, Point r, Point s, Point test)}{}
\ccHeading{Predicates}
\ccMethod{bool equal(const Point & p, const Point & q) const;}
{Equality test.}

7
Packages/Triangulation_3/doc_tex/basic/Triangulation_3/Triangulation_3_ref/Triangulation_3/Triangulation_vertex_3.tex
View File

@ -28,7 +28,8 @@ maximal dimension.
\ccc{Tds_3::Vertex}
\ccTypes
\ccThree{typedef triple <Cell*, int, int>}{Facettoto}{}
\ccThree{typedef Triangulation_traits_3::Pointxx}{Pointxx}{}
\ccThreeToTwo
The class \ccClassTemplateName\ defines the following types, also
defined in the class \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>}:
@ -38,7 +39,6 @@ defined in the class \ccc{Triangulation_3<Triangulation_traits_3,Tds_3>}:
\ccGlue
\ccNestedType{Cell_handle}{handle to a cell}
\ccCreation
\ccCreationVariable{v} %% choose variable name
\begin{ccAdvanced}
@ -109,9 +109,6 @@ of maximal dimension (Section~\ref{Triangulation3-sec-degen_dim}).}
\ccc{CGAL::Triangulation_3<Triangulation_traits_3,Tds_3>::Cell}.
\ccExample
\end{ccRefClass}
% +------------------------------------------------------------------------+

8
Packages/Triangulation_3/doc_tex/basic/Triangulation_3/Triangulation_3_ref/Triangulation_data_structure_3/Tds_3.tex
View File

@ -57,8 +57,8 @@ data structure class. (See Chapter~\ref{chapter-TDS3}.)
To ensure all the \textbf{flexibility} of class \ccc{Triangulation_3}
described in
\ccRefPage{CGAL::Triangulation_3<Triangulation_traits_3,Tds_3>}
and in Chapter~\ref{chapter-Triangulation3}, a model of a
\lcTex{ \ccRefPage{CGAL::Triangulation_3<Triangulation_traits_3,Tds_3>}
and in } Chapter~\ref{chapter-Triangulation3}, a model of a
triangulation data structure must be templated by the base vertex and
the base cell classes (see~\ref{TDS3-sec-intro}):
\ccc{Tds_3<Triangulation_vb_3,Triangulation_cb_3>}.
@ -75,11 +75,13 @@ operations.
\ccThree{typedef triple <Cell*, int, int>}{Facet }{}
\ccThreeToTwo
\ccNestedType{Vertex }{Vertex}
\ccNestedType{Vertex }{}
\ccGlue
\ccNestedType{Cell}{Cell type}
\lcTex{
Requirements for \ccc{Vertex} and \ccc{Cell} are described in
\ccRefPage{Tds_3::Vertex} and \ccRefPage{Tds_3::Cell}.
}
\ccTypedef{typedef triple<Cell*, int, int> Edge;}{\ccc{(c,i,j)} is the
edge of cell \ccc{c} whose vertices indices are \ccc{i} and

4
Packages/Triangulation_3/doc_tex/basic/Triangulation_3/Triangulation_3_ref/Triangulation_data_structure_3/Triangulation_cell_base_3.tex
View File

@ -19,9 +19,9 @@
\ccDefinition
The class \ccRefName\ is provided by \cgal\ as a base cell class,
and is similar to the base vertex classes. (See
and is similar to the base vertex classes. \lcTex{(See
\ccRefPage{CGAL::Triangulation_vertex_base_3<Triangulation_traits_3>} and
\ccRefPage{CGAL::Triangulation_vertex_base_pointer_3<Triangulation_traits_3>}.)
\ccRefPage{CGAL::Triangulation_vertex_base_pointer_3<Triangulation_traits_3>}.)}
\ccInclude{CGAL/Triangulation_cell_base_3.h}

4
Packages/Triangulation_3/doc_tex/basic/Triangulation_3/Triangulation_3_ref/Triangulation_data_structure_3/Triangulation_data_structure_3.tex
View File

@ -22,8 +22,8 @@ and provides the optional
geometric functionalities to be used as a parameter for a
3D-geometric triangulation (see Chapter~\ref{chapter-Triangulation3}.
It is templated by base classes for vertices and cells.
(See \ccRefPage{Triangulation_vb_3}
and \ccRefPage{Triangulation_cb_3}.)
\lcTex{(See \ccRefPage{Triangulation_vb_3}
and \ccRefPage{Triangulation_cb_3}.)}
\ccIsModel