From 6ee113f820dba782d1b39ddf9e22e9dac7e71079 Mon Sep 17 00:00:00 2001 From: Sylvain Pion Date: Wed, 16 Jul 2008 13:59:26 +0000 Subject: [PATCH] Document the kernel typedefs specifying the return types of the predicates: Bool_type, Sign, Comparison_result, Orientation, Oriented_side, Bounded_side and Angle. --- .../include/CGAL/Cartesian/Cartesian_base.h | 3 --- Filtered_kernel/include/CGAL/Lazy_kernel.h | 1 - .../CGAL/Homogeneous/Homogeneous_base.h | 6 ------ Kernel_23/doc_tex/Kernel_23_ref/Kernel.tex | 19 +++++++++++++++++++ 4 files changed, 19 insertions(+), 10 deletions(-) diff --git a/Cartesian_kernel/include/CGAL/Cartesian/Cartesian_base.h b/Cartesian_kernel/include/CGAL/Cartesian/Cartesian_base.h index f90ceffe23a..69891b49bb6 100644 --- a/Cartesian_kernel/include/CGAL/Cartesian/Cartesian_base.h +++ b/Cartesian_kernel/include/CGAL/Cartesian/Cartesian_base.h @@ -81,9 +81,6 @@ struct Cartesian_base typedef CGAL::Object Object_2; typedef CGAL::Object Object_3; - // These are currently undocumented. - // Should they be part of the Kernel interface ? - // Bool_type had originally been Bool. It was renamed to avoid a conflict // between a macro defined in Xlib.h poorly chosen to have the same name, // that is 'Bool'. diff --git a/Filtered_kernel/include/CGAL/Lazy_kernel.h b/Filtered_kernel/include/CGAL/Lazy_kernel.h index 5719b9a4440..039d96f99fc 100644 --- a/Filtered_kernel/include/CGAL/Lazy_kernel.h +++ b/Filtered_kernel/include/CGAL/Lazy_kernel.h @@ -80,7 +80,6 @@ public: typedef CGAL::Lazy_exact_nt FT; typedef FT RT; - // FIXME : Document these typedefs ! typedef typename Same_uncertainty_nt::type Bool_type; typedef typename Same_uncertainty_nt::type diff --git a/Homogeneous_kernel/include/CGAL/Homogeneous/Homogeneous_base.h b/Homogeneous_kernel/include/CGAL/Homogeneous/Homogeneous_base.h index e130d31d5bf..32ce413be98 100644 --- a/Homogeneous_kernel/include/CGAL/Homogeneous/Homogeneous_base.h +++ b/Homogeneous_kernel/include/CGAL/Homogeneous/Homogeneous_base.h @@ -88,12 +88,6 @@ struct Homogeneous_base typedef CGAL::Object Object_2; typedef CGAL::Object Object_3; - // These are currently undocumented. - // Should they be part of the Kernel interface ? - - // Bool_type had originally been Bool. It was renamed to avoid a conflict - // between a macro defined in Xlib.h poorly chosen to have the same name, - // that is 'Bool'. typedef typename Same_uncertainty_nt::type Bool_type; typedef typename Same_uncertainty_nt::type diff --git a/Kernel_23/doc_tex/Kernel_23_ref/Kernel.tex b/Kernel_23/doc_tex/Kernel_23_ref/Kernel.tex index beffdcb6152..2ef50793293 100644 --- a/Kernel_23/doc_tex/Kernel_23_ref/Kernel.tex +++ b/Kernel_23/doc_tex/Kernel_23_ref/Kernel.tex @@ -30,6 +30,25 @@ especially for equality testing. \ccGlue \ccNestedType{RT}{a model of \ccc{RingNumberType}} +The following types describe the return types of predicates. They typically +map to \ccc{bool} and CGAL kernel enum types, except when an interval arithmetic +number type is used such as within the filtering kernels. + +\ccNestedType{Bool_type}{typically \ccc{bool}} +\ccGlue +\ccNestedType{Sign}{typically \ccc{CGAL::Sign}} +\ccGlue +\ccNestedType{Comparison_result}{typically \ccc{CGAL::Comparison_result}} +\ccGlue +\ccNestedType{Orientation}{typically \ccc{CGAL::Orientation}} +\ccGlue +\ccNestedType{Oriented_side}{typically \ccc{CGAL::Oriented_side}} +\ccGlue +\ccNestedType{Bounded_side}{typically \ccc{CGAL::Bounded_side}} +\ccGlue +\ccNestedType{Angle}{typically \ccc{CGAL::Angle}} + + \ccHeading{Two-dimensional Kernel} \ccHeading{Coordinate Access}