mirror of https://github.com/CGAL/cgal
more doc stubs
This commit is contained in:
parent
5a20d46962
commit
ba79a013d0
|
|
@ -0,0 +1,24 @@
|
|||
\begin{ccRefClass}{Cartesian_complete<Base,bool force=false,Derived=Default>}
|
||||
\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}
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
\begin{ccRefClass}{Cartesian_mini_d<FT,Dim>}
|
||||
\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}
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
\begin{ccRefClass}{Kernel_d_interface<Base>}
|
||||
\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<Point_tag>::type Point_d}\\
|
||||
\ccc{typedef Functor<Compare_lexicographically_tag>::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}
|
||||
|
|
@ -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}
|
||||
|
|
|
|||
Loading…
Reference in New Issue