From ba79a013d0f812bd2c355ad7da4bc89c1c861b48 Mon Sep 17 00:00:00 2001 From: Marc Glisse Date: Mon, 19 Mar 2012 11:25:20 +0000 Subject: [PATCH] more doc stubs --- .../NewKernel_d_ref/Cartesian_complete.tex | 24 +++++++++++++++++++ .../NewKernel_d_ref/Cartesian_mini_d.tex | 15 ++++++++++++ .../NewKernel_d_ref/Kernel_d_interface.tex | 18 ++++++++++++++ NewKernel_d/doc_tex/NewKernel_d_ref/main.tex | 6 ++++- 4 files changed, 62 insertions(+), 1 deletion(-) create mode 100644 NewKernel_d/doc_tex/NewKernel_d_ref/Cartesian_complete.tex create mode 100644 NewKernel_d/doc_tex/NewKernel_d_ref/Cartesian_mini_d.tex create mode 100644 NewKernel_d/doc_tex/NewKernel_d_ref/Kernel_d_interface.tex diff --git a/NewKernel_d/doc_tex/NewKernel_d_ref/Cartesian_complete.tex b/NewKernel_d/doc_tex/NewKernel_d_ref/Cartesian_complete.tex new file mode 100644 index 00000000000..d1264e05686 --- /dev/null +++ b/NewKernel_d/doc_tex/NewKernel_d_ref/Cartesian_complete.tex @@ -0,0 +1,24 @@ +\begin{ccRefClass}{Cartesian_complete} +\include{CGAL/NewKernel_d/Cartesian_complete.h} +\ccDefinition +A model for \ccc{Kernel}, that takes a \ccc{Kernel} model \ccc{Base} +which provides at least \ccc{Point} and extends it by defining a number +of classical types and functors. The \ccc{force} parameter says whether +the class should override existing objects from \ccc{Base}. +\ccc{Derived} is the name of the ``final'' class for CRTP patterns, +which by default is \ccc{Cartesian_complete} itself. + +This is in particular expected to be enough for the \ccc{Triangulation} +package. + +\ccIsModel +\ccRefConceptPage{Kernel} + +\ccImplementation +This is split in classes \ccc{Cartesian_complete_predicates}, +\ccc{Cartesian_complete_computations}, +\ccc{Cartesian_complete_constructions}, +\ccc{Cartesian_complete_functors} (a reunion of the previous three), +\ccc{Cartesian_complete_types}, all with the same parameters. + +\end{ccRefClass} diff --git a/NewKernel_d/doc_tex/NewKernel_d_ref/Cartesian_mini_d.tex b/NewKernel_d/doc_tex/NewKernel_d_ref/Cartesian_mini_d.tex new file mode 100644 index 00000000000..13dc0a4ef4d --- /dev/null +++ b/NewKernel_d/doc_tex/NewKernel_d_ref/Cartesian_mini_d.tex @@ -0,0 +1,15 @@ +\begin{ccRefClass}{Cartesian_mini_d} +\include{CGAL/NewKernel_d/Cartesian_mini_d.h} +\ccDefinition +A minimal model for \ccc{Kernel} where \ccc{FT} and +\ccc{Default_ambient_dimension} are provided as template arguments. +This kernel provides the \ccc{Point} concept and not much more. + +The class takes several other template parameters (in particular to +specify \ccc{LA}) that are undocumented for now. + +\ccIsModel +\ccRefConceptPage{Kernel} +\ccRefConceptPage{Point} + +\end{ccRefClass} diff --git a/NewKernel_d/doc_tex/NewKernel_d_ref/Kernel_d_interface.tex b/NewKernel_d/doc_tex/NewKernel_d_ref/Kernel_d_interface.tex new file mode 100644 index 00000000000..5f9d6b75bf5 --- /dev/null +++ b/NewKernel_d/doc_tex/NewKernel_d_ref/Kernel_d_interface.tex @@ -0,0 +1,18 @@ +\begin{ccRefClass}{Kernel_d_interface} +\include{CGAL/NewKernel_d/Kernel_d_interface.h} +\ccDefinition +This class derives from a \ccc{Kernel} \ccc{Base} and defines a number +of typedefs and functions to give it an interface close to that of the +classical \ccc{Kernel_d}. As an example, it contains: + +\ccc{typedef Type::type Point_d}\\ +\ccc{typedef Functor::type Compare_lexicographically_d}\\ +\ccc{Compare_lexicographically_d compare_lexicographically_d_object()const{ return Compare_lexicographically_d(*this); }} + +Assuming that \ccc{Base} provides everything required, this provides +an interface suitable for the \ccc{Triangulation} package. + +\ccIsModel +\ccRefConceptPage{Triangulation_traits} + +\end{ccRefClass} diff --git a/NewKernel_d/doc_tex/NewKernel_d_ref/main.tex b/NewKernel_d/doc_tex/NewKernel_d_ref/main.tex index c63d1b402d1..b2fe3c8c2c5 100644 --- a/NewKernel_d/doc_tex/NewKernel_d_ref/main.tex +++ b/NewKernel_d/doc_tex/NewKernel_d_ref/main.tex @@ -9,4 +9,8 @@ \input{NewKernel_d_ref/Kernel} \input{NewKernel_d_ref/Kernel_functor} \input{NewKernel_d_ref/Point} - +\input{NewKernel_d_ref/Cartesian_filter_K.tex} +\input{NewKernel_d_ref/Cartesian_mini_d.tex} +\input{NewKernel_d_ref/Cartesian_complete.tex} +\input{NewKernel_d_ref/KernelD_converter.tex} +\input{NewKernel_d_ref/Kernel_d_interface}