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

Reworded ExactAlphaComparisonTag warning

This commit is contained in:
Mael Rouxel-Labbé 2017-06-15 10:27:16 +02:00
parent 2364a551c4
commit 41e7520b3e
2 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h
View File

@ -35,13 +35,14 @@ does not make sense if the traits class already provides exact constructions.
\warning When the tag `ExactAlphaComparisonTag` is set to \link Tag_true `Tag_true`\endlink, \warning When the tag `ExactAlphaComparisonTag` is set to \link Tag_true `Tag_true`\endlink,
the class `Cartesian_converter` is used internally to switch between the traits class the class `Cartesian_converter` is used internally to switch between the traits class
and exact CGAL kernels. `Cartesian_converter` must thus provide the necessary functor and the %CGAL kernel `CGAL::Simple_cartesian<NT>`, where `NT` can be either `CGAL::Interval_nt` or
to convert a point of the traits class to a point of an exact kernel. However, this `CGAL::Exact_rational`. `Cartesian_converter` must thus offer the necessary functors
functor is not necessarily provided by `Cartesian_converter`. For example to convert a two-dimensional point of the traits class to a two-dimensional point
when using the traits class `CGAL::Projection_traits_xy_3`, a `CGAL::Point_3` of `CGAL::Simple_cartesian<NT>`. However, these functors are not necessarily provided by
is camouflaged as a `%Point_2` and the basic `Cartesian_converter` does not know the basic `Cartesian_converter`. For example when using the traits class `CGAL::Projection_traits_xy_3`,
a `CGAL::Point_3` is camouflaged as a `%Point_2` and the basic `Cartesian_converter` does not know
how to convert from the camouflaged `CGAL::Point_3` to the two-dimensional point how to convert from the camouflaged `CGAL::Point_3` to the two-dimensional point
of an exact kernel. In this case, a partial specialization of `Cartesian_converter` of `CGAL::Simple_cartesian<NT>`. In this case, a partial specialization of `Cartesian_converter`
must be provided by the user. An example of such specialization is given in the example must be provided by the user. An example of such specialization is given in the example
\ref Alpha_shapes_2/ex_alpha_projection_traits.cpp "ex_alpha_projection_traits.cpp". \ref Alpha_shapes_2/ex_alpha_projection_traits.cpp "ex_alpha_projection_traits.cpp".

15
Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h
View File

@ -10,6 +10,9 @@ alpha shapes of points in the 3D space for <I>all</I> real
of the class `Dt`. Each k-dimensional face of Dt is associated with an of the class `Dt`. Each k-dimensional face of Dt is associated with an
interval that specifies for which values of alpha the face belongs to the alpha shape. interval that specifies for which values of alpha the face belongs to the alpha shape.
Note that this class is used for <I>basic</I>, <I>weighted</I>,
and <I>periodic</I> Alpha Shapes.
The modifying functions `insert` and `remove` will overwrite The modifying functions `insert` and `remove` will overwrite
the one inherited from the underlying triangulation class `Dt`. the one inherited from the underlying triangulation class `Dt`.
At the moment, only the static version is implemented. At the moment, only the static version is implemented.
@ -30,15 +33,15 @@ does not make sense if the traits class already provides exact constructions.
\warning When the tag `ExactAlphaComparisonTag` is set to \link Tag_true `Tag_true`\endlink, \warning When the tag `ExactAlphaComparisonTag` is set to \link Tag_true `Tag_true`\endlink,
the class `Cartesian_converter` is used internally to switch between the traits class the class `Cartesian_converter` is used internally to switch between the traits class
and exact CGAL kernels. `Cartesian_converter` must thus provide the necessary functor and the %CGAL kernel `CGAL::Simple_cartesian<NT>`, where `NT` can be either `CGAL::Interval_nt` or
to convert a point of the traits class to a point of an exact kernel. However, this `CGAL::Exact_rational`. `Cartesian_converter` must thus offer the necessary functors
functor is not necessarily provided by `Cartesian_converter`. In this case, a partial specialization of `Cartesian_converter` to convert a three-dimensional point of the traits class to a three-dimensional point
of `CGAL::Simple_cartesian<NT>`. However, these functors are not necessarily provided by
the basic `Cartesian_converter`, for example when a custom point is used.
In this case, a partial specialization of `Cartesian_converter`
must be provided by the user. An example of such specialization is given in the must be provided by the user. An example of such specialization is given in the
two-dimensional Alpha Shapes example \ref Alpha_shapes_2/ex_alpha_projection_traits.cpp "ex_alpha_projection_traits.cpp". two-dimensional Alpha Shapes example \ref Alpha_shapes_2/ex_alpha_projection_traits.cpp "ex_alpha_projection_traits.cpp".
Note that this class is used for <I>basic</I>, <I>weighted</I>,
and <I>periodic</I> Alpha Shapes.
\cgalHeading{I/O} \cgalHeading{I/O}
The I/O operators are defined for `iostream`, and for The I/O operators are defined for `iostream`, and for