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

Document the kernel typedefs specifying the return types of the predicates: 

Bool_type, Sign, Comparison_result, Orientation, Oriented_side, Bounded_side and Angle.
This commit is contained in:
Sylvain Pion 2008-07-16 13:59:26 +00:00
parent b98175b4f2
commit 6ee113f820
4 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Cartesian_kernel/include/CGAL/Cartesian/Cartesian_base.h
View File

@ -81,9 +81,6 @@ struct Cartesian_base
typedef CGAL::Object Object_2; typedef CGAL::Object Object_2;
typedef CGAL::Object Object_3; 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 // 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, // between a macro defined in Xlib.h poorly chosen to have the same name,
// that is 'Bool'. // that is 'Bool'.

1
Filtered_kernel/include/CGAL/Lazy_kernel.h
View File

@ -80,7 +80,6 @@ public:
typedef CGAL::Lazy_exact_nt<typename Exact_kernel::FT> FT; typedef CGAL::Lazy_exact_nt<typename Exact_kernel::FT> FT;
typedef FT RT; typedef FT RT;
// FIXME : Document these typedefs !
typedef typename Same_uncertainty_nt<bool, FT>::type typedef typename Same_uncertainty_nt<bool, FT>::type
Bool_type; Bool_type;
typedef typename Same_uncertainty_nt<CGAL::Sign, FT>::type typedef typename Same_uncertainty_nt<CGAL::Sign, FT>::type

6
Homogeneous_kernel/include/CGAL/Homogeneous/Homogeneous_base.h
View File

@ -88,12 +88,6 @@ struct Homogeneous_base
typedef CGAL::Object Object_2; typedef CGAL::Object Object_2;
typedef CGAL::Object Object_3; 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<bool, FT>::type typedef typename Same_uncertainty_nt<bool, FT>::type
Bool_type; Bool_type;
typedef typename Same_uncertainty_nt<CGAL::Sign, FT>::type typedef typename Same_uncertainty_nt<CGAL::Sign, FT>::type

19
Kernel_23/doc_tex/Kernel_23_ref/Kernel.tex
View File

@ -30,6 +30,25 @@ especially for equality testing.
\ccGlue \ccGlue
\ccNestedType{RT}{a model of \ccc{RingNumberType}} \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{Two-dimensional Kernel}
\ccHeading{Coordinate Access} \ccHeading{Coordinate Access}