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

documentation of the default template parameters

This commit is contained in:
Monique Teillaud 2001-06-19 12:28:51 +00:00
parent 4d678c2001
commit 8b7f004076
4 changed files with 42 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -201,8 +201,9 @@ working on the indices of vertices in cells\lcTex{
\ccc{Triangulation_3<TriangulationTraits_3,TriangulationDataStructure_3>} expects a model of a
\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
of a \textit{triangulation data structure} as its second argument.
The requirements and defaults for the traits classes are described in
the reference pages for
\ccc{TriangulationTraits_3}\lcTex{
(\ccRefPage{TriangulationTraits_3})},
@ -216,6 +217,13 @@ and
\ccc{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>}\lcTex{
(\ccRefPage{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>})}.
The requirements and default for the triangulation data structure are
described in Chapter~/ref{chapter-TDS3}. However, a default parameter
is defined in \ccc{Triangulation_3}, so that the user who
has no additional needs can use
\ccc{Triangulation_3<TriangulationTraits_3>} without specifying the
second argument.
%\subsection{The Vertex of a Triangulation}
%\label{Triangulation3-sec-class-Vertex}
@ -468,6 +476,9 @@ Chapter~\ref{chapter-TDS3}). A model of this triangulation data
structure is \ccc{Triangulation_data_structure_3}\lcTex{
(\ccRefPage{CGAL::Triangulation_data_structure_3<TriangulationVertexBase_3,TriangulationCellBase_3>})}.
A default parameter is defined in all the triangulation classes, so, it
need not be specified by the user.
\section{Examples}
\label{Triangulation3-sec-examples}
This example shows the incremental construction of a 3D triangulation,

9
Packages/Triangulation_3/doc_tex/Triangulation_3/Triangulation_3_ref/Triangulation_3/Triangulation_3.tex
View File

@ -22,6 +22,13 @@ The class \ccRefName\ expects a model of a \ccc{geometric traits
class} as its first template argument and a model of a \ccc{triangulation data
structure} as its second argument.
The second argument is optional,
since a default parameter is proposed by \cgal. This default parameter
is
\ccc{Triangulation_data_structure_3< Triangulation_vertex_base_3<TriangulationTraits_3>,Triangulation_cell_base_3<TriangulationTraits_3>
>}.
\ccInclude{CGAL/Triangulation_3.h}
\ccInheritsFrom{\ccc{Triangulation_utils_3}}
@ -102,7 +109,7 @@ OUTSIDE_AFFINE_HULL};}
\ccCreation
\ccCreationVariable{t} %% choose variable name
\ccThree{Triangulation_3<TriangulationTraits_3,TriangulationDataStructure_3>}{Facet }{}
\ccThree{Triangulation_3<Traits_3,DataStructure_3>}{Facet }{}
\ccConstructor{Triangulation_3<TriangulationTraits_3,TriangulationDataStructure_3>
(const TriangulationTraits_3 & traits );}

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

@ -201,8 +201,9 @@ working on the indices of vertices in cells\lcTex{
\ccc{Triangulation_3<TriangulationTraits_3,TriangulationDataStructure_3>} expects a model of a
\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
of a \textit{triangulation data structure} as its second argument.
The requirements and defaults for the traits classes are described in
the reference pages for
\ccc{TriangulationTraits_3}\lcTex{
(\ccRefPage{TriangulationTraits_3})},
@ -216,6 +217,13 @@ and
\ccc{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>}\lcTex{
(\ccRefPage{CGAL::Regular_triangulation_euclidean_traits_3<R,Weight>})}.
The requirements and default for the triangulation data structure are
described in Chapter~/ref{chapter-TDS3}. However, a default parameter
is defined in \ccc{Triangulation_3}, so that the user who
has no additional needs can use
\ccc{Triangulation_3<TriangulationTraits_3>} without specifying the
second argument.
%\subsection{The Vertex of a Triangulation}
%\label{Triangulation3-sec-class-Vertex}
@ -468,6 +476,9 @@ Chapter~\ref{chapter-TDS3}). A model of this triangulation data
structure is \ccc{Triangulation_data_structure_3}\lcTex{
(\ccRefPage{CGAL::Triangulation_data_structure_3<TriangulationVertexBase_3,TriangulationCellBase_3>})}.
A default parameter is defined in all the triangulation classes, so, it
need not be specified by the user.
\section{Examples}
\label{Triangulation3-sec-examples}
This example shows the incremental construction of a 3D triangulation,

9
Packages/Triangulation_3/doc_tex/basic/Triangulation_3/Triangulation_3_ref/Triangulation_3/Triangulation_3.tex
View File

@ -22,6 +22,13 @@ The class \ccRefName\ expects a model of a \ccc{geometric traits
class} as its first template argument and a model of a \ccc{triangulation data
structure} as its second argument.
The second argument is optional,
since a default parameter is proposed by \cgal. This default parameter
is
\ccc{Triangulation_data_structure_3< Triangulation_vertex_base_3<TriangulationTraits_3>,Triangulation_cell_base_3<TriangulationTraits_3>
>}.
\ccInclude{CGAL/Triangulation_3.h}
\ccInheritsFrom{\ccc{Triangulation_utils_3}}
@ -102,7 +109,7 @@ OUTSIDE_AFFINE_HULL};}
\ccCreation
\ccCreationVariable{t} %% choose variable name
\ccThree{Triangulation_3<TriangulationTraits_3,TriangulationDataStructure_3>}{Facet }{}
\ccThree{Triangulation_3<Traits_3,DataStructure_3>}{Facet }{}
\ccConstructor{Triangulation_3<TriangulationTraits_3,TriangulationDataStructure_3>
(const TriangulationTraits_3 & traits );}