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

modified documentation to exclude Side_of_hyperbolic_triangle_2 and to include Side_of_oriented_hyperbolic_segment_2

This commit is contained in:
Iordan Iordanov 2018-08-08 22:52:58 +02:00
parent e133fcea32
commit 6191874c60
3 changed files with 29 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/CGAL/Hyperbolic_Delaunay_triangulation_CK_traits_2.h
View File

@ -39,7 +39,13 @@ public:
/// @{ /// @{
typedef typename K::Orientation_2 Orientation_2; typedef typename K::Orientation_2 Orientation_2;
typedef typename K::Side_of_oriented_circle_2 Side_of_oriented_circle_2; typedef typename K::Side_of_oriented_circle_2 Side_of_oriented_circle_2;
typedef unspecified_type Side_of_hyperbolic_triangle_2; /*!
\cgalModifBegin
*/
typedef unspecified_type Side_of_oriented_hyperbolic_segment_2;
/*!
\cgalModifEnd
*/
/// @} /// @}
/// \name Construction Types /// \name Construction Types

8
Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/CGAL/Hyperbolic_Delaunay_triangulation_traits_2.h
View File

@ -40,7 +40,13 @@ public:
/// @{ /// @{
typedef typename K::Orientation_2 Orientation_2; typedef typename K::Orientation_2 Orientation_2;
typedef typename K::Side_of_oriented_circle_2 Side_of_oriented_circle_2; typedef typename K::Side_of_oriented_circle_2 Side_of_oriented_circle_2;
typedef unspecified_type Side_of_hyperbolic_triangle_2; /*!
\cgalModifBegin
*/
typedef unspecified_type Side_of_oriented_hyperbolic_segment_2;
/*!
\cgalModifEnd
*/
/// @} /// @}
/// \name Construction Types /// \name Construction Types

30
Hyperbolic_triangulation_2/doc/Hyperbolic_triangulation_2/Concepts/HyperbolicDelaunayTriangulationTraits_2.h
View File

@ -74,22 +74,16 @@ public:
/*! /*!
\cgalModifBegin
A predicate object. Must provide the function operator A predicate object. Must provide the function operator
`Bounded_side operator()(Point_2 p, Point_2 q, Point_2 r, Point_2 t, int& li),` `Oriented_side operator()(Point_2 p, Point_2 q, Point_2 query),`
which returns the position of point `t` relative to the hyperbolic triangle which returns the position of point `query` relative to the oriented hyperbolic
with vertices `p, q`, and `r`. segment with vertices `p` and `q`.
<ul> \cgalModifEnd
<li> If the point `t` coincides with one of the points `p, q` or `r`, then the
variable `li` contains the index of that point, assuming that the indices
of `p, q, r` are 0, 1, 2 respectively.
<li>If the point `t` lies on one of the edges of the hyperbolic triangle, then
the variable `li` contains the index of the vertex opposite to that side,
assuming that the indices of `p, q, r` are 0, 1, 2 respectively.
</ul>
*/ */
typedef unspecified_type Side_of_hyperbolic_triangle_2; typedef unspecified_type Side_of_oriented_hyperbolic_segment_2;
@ -149,9 +143,15 @@ public:
/// \name Operations /// \name Operations
/// The following functions give access to the predicate objects. /// The following functions give access to the predicate objects.
/// @{ /// @{
Orientation_2 orientation_2_object(); Orientation_2 orientation_2_object();
Side_of_oriented_circle_2 side_of_oriented_circle_2_object(); Side_of_oriented_circle_2 side_of_oriented_circle_2_object();
Side_of_hyperbolic_triangle_2 side_of_hyperbolic_triangle_2_object(); /*!
\cgalModifBegin
*/
Side_of_oriented_hyperbolic_segment_2 side_of_oriented_hyperbolic_segment_2_object();
/*!
\cgalModifEnd
*/
/// @} /// @}
/// \name /// \name