diff --git a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Euclidean_distance.tex b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Euclidean_distance.tex index 4dafc5bb875..8c09c54bdae 100755 --- a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Euclidean_distance.tex +++ b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Euclidean_distance.tex @@ -47,7 +47,7 @@ OrthogonalDistance \ccOperations -\ccMethod{FT transformed_distance(Point_d q, Point_d p);}{Returns the squared Euclidean distance between \ccc{q} and \ccc{p}.} +\ccMethod{FT transformed_distance(Point_d q, Point_d p);}{Returns the squared Euclidean distance between~\ccc{q} and~\ccc{p}.} \ccMethod{FT min_distance_to_rectangle(Point_d q, Kd_tree_rectangle r);} {Returns the squared Euclidean distance between \ccc{q} and diff --git a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Euclidean_distance_sphere_point.tex b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Euclidean_distance_sphere_point.tex index 9f8aaa5a4c1..bc74a9c7f87 100755 --- a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Euclidean_distance_sphere_point.tex +++ b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Euclidean_distance_sphere_point.tex @@ -39,7 +39,7 @@ for example \ccc{CGAL::Cartesian_d::Sphere_d}. \ccIsModel -GeneralDistance +\ccc{GeneralDistance} \ccTypes diff --git a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Fuzzy_iso_box_d.tex b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Fuzzy_iso_box_d.tex index c2bea9bd036..ef03a7b9dc5 100755 --- a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Fuzzy_iso_box_d.tex +++ b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Fuzzy_iso_box_d.tex @@ -27,7 +27,7 @@ by a $d$-dim square with side length $\epsilon$. \ccParameters Expects for the template argument a model of the concept -\ccc{SearchTraits}, for example \ccc{CGAL::Search_traits_2}. +\ccc{SearchTraits}, for example \ccc{CGAL::Search_traits_2 >}. Expects for the second template argument a model of the concept \ccc{IsoBox}, for example \ccc{CGAL::Iso_rectangle_2}. diff --git a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Fuzzy_sphere_d.tex b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Fuzzy_sphere_d.tex index 334f9935ee3..a81de782388 100755 --- a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Fuzzy_sphere_d.tex +++ b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Fuzzy_sphere_d.tex @@ -29,7 +29,7 @@ as inner approximation a sphere with radius $r-\epsilon$. Expects for the template argument a model of the concept -\ccc{SearchTraits}, for example \ccc{CGAL::Search_traits_2}. +\ccc{SearchTraits}, for example \ccc{CGAL::Search_traits_2 >}. \ccIsModel diff --git a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/GeneralDistance.tex b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/GeneralDistance.tex index 9e0b4b53798..9f0489f7763 100755 --- a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/GeneralDistance.tex +++ b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/GeneralDistance.tex @@ -34,7 +34,7 @@ e.g., for an Euclidian distance the transformed distance is the squared Euclidea \ccOperations -\ccMethod{FT distance(Query_item q, Point_d r);}{Returns the transformed distance between \ccc{q} and \ccc{r}.} +\ccMethod{FT transformed_distance(Query_item q, Point_d r);}{Returns the transformed distance between \ccc{q} and~\ccc{r}.} \ccMethod{FT min_distance_to_rectangle(Query_item q, Kd_tree_rectangle r);} {Returns the transformed distance between \ccc{q} and diff --git a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Manhattan_distance_iso_box_point.tex b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Manhattan_distance_iso_box_point.tex index f2d585575ef..316a0bb7f9c 100755 --- a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Manhattan_distance_iso_box_point.tex +++ b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Manhattan_distance_iso_box_point.tex @@ -53,12 +53,13 @@ for example \ccc{CGAL::Cartesian::Iso_cuboid_3}. \ccOperations +\ccMethod{FT transformed distance(IsoBox b, Point_d p);}{Returns the transformed +distance between \ccc{b} and \ccc{p}.} + \ccMethod{FT transformed_distance(FT d);} {Returns $d$.} \ccMethod{FT inverse_of_transformed_distance(FT d);} {Returns $d$.} -\ccMethod{FT distance(IsoBox b, Point_d p);}{Returns the distance between \ccc{b} and \ccc{p}.} - \ccMethod{FT min_distance_to_rectangle(IsoBox b, Kd_tree_rectangle r);} {Returns the minimal distance between a point from \ccc{b} and a point from \ccc{r}.} diff --git a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/OrthogonalDistance.tex b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/OrthogonalDistance.tex index 9951fcbd456..2a669e26b6b 100755 --- a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/OrthogonalDistance.tex +++ b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/OrthogonalDistance.tex @@ -46,7 +46,7 @@ $d$-dimensional query items. \ccOperations -\ccMethod{FT distance(Point_d q, Point_d r);}{Returns the transformed distance between \ccc{q} and \ccc{r}.} +\ccMethod{FT transformed_distance(Point_d q, Point_d r);}{Returns the transformed distance between \ccc{q} and~\ccc{r}.} \ccMethod{FT min_distance_to_rectangle(Point_d q, Kd_tree_rectangle r);} {Returns the transformed distance between \ccc{q} and diff --git a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Weighted_Minkowski_distance.tex b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Weighted_Minkowski_distance.tex index 1d427989065..6e8ae01fe17 100755 --- a/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Weighted_Minkowski_distance.tex +++ b/Packages/Spatial_searching/doc_tex/Spatial_searching_ref/Weighted_Minkowski_distance.tex @@ -56,7 +56,7 @@ The values in the iterator range \ccc{[wb,we)} are the weight. } \ccOperations -\ccMethod{FT distance(Point q, Point r);}{Returns $d^{power}$, +\ccMethod{FT transformed_distance(Point q, Point r);}{Returns $d^{power}$, where $d$ denotes the distance between \ccc{q} and \ccc{r}.} \ccMethod{FT min_distance_to_rectangle(Point q, Kd_tree_rectangle r;);} @@ -78,8 +78,8 @@ and returns the updated distance.} \ccSeeAlso -\ccc{OrthogonalDistance},\\ -\ccc{CGAL::Euclidean_distance}. +\ccc{OrthogonalDistance}\\ +\ccc{CGAL::Euclidean_distance} \end{ccRefClass} diff --git a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Euclidean_distance.tex b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Euclidean_distance.tex index 4dafc5bb875..8c09c54bdae 100755 --- a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Euclidean_distance.tex +++ b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Euclidean_distance.tex @@ -47,7 +47,7 @@ OrthogonalDistance \ccOperations -\ccMethod{FT transformed_distance(Point_d q, Point_d p);}{Returns the squared Euclidean distance between \ccc{q} and \ccc{p}.} +\ccMethod{FT transformed_distance(Point_d q, Point_d p);}{Returns the squared Euclidean distance between~\ccc{q} and~\ccc{p}.} \ccMethod{FT min_distance_to_rectangle(Point_d q, Kd_tree_rectangle r);} {Returns the squared Euclidean distance between \ccc{q} and diff --git a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Euclidean_distance_sphere_point.tex b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Euclidean_distance_sphere_point.tex index 9f8aaa5a4c1..bc74a9c7f87 100755 --- a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Euclidean_distance_sphere_point.tex +++ b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Euclidean_distance_sphere_point.tex @@ -39,7 +39,7 @@ for example \ccc{CGAL::Cartesian_d::Sphere_d}. \ccIsModel -GeneralDistance +\ccc{GeneralDistance} \ccTypes diff --git a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Fuzzy_iso_box_d.tex b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Fuzzy_iso_box_d.tex index c2bea9bd036..ef03a7b9dc5 100755 --- a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Fuzzy_iso_box_d.tex +++ b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Fuzzy_iso_box_d.tex @@ -27,7 +27,7 @@ by a $d$-dim square with side length $\epsilon$. \ccParameters Expects for the template argument a model of the concept -\ccc{SearchTraits}, for example \ccc{CGAL::Search_traits_2}. +\ccc{SearchTraits}, for example \ccc{CGAL::Search_traits_2 >}. Expects for the second template argument a model of the concept \ccc{IsoBox}, for example \ccc{CGAL::Iso_rectangle_2}. diff --git a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Fuzzy_sphere_d.tex b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Fuzzy_sphere_d.tex index 334f9935ee3..a81de782388 100755 --- a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Fuzzy_sphere_d.tex +++ b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Fuzzy_sphere_d.tex @@ -29,7 +29,7 @@ as inner approximation a sphere with radius $r-\epsilon$. Expects for the template argument a model of the concept -\ccc{SearchTraits}, for example \ccc{CGAL::Search_traits_2}. +\ccc{SearchTraits}, for example \ccc{CGAL::Search_traits_2 >}. \ccIsModel diff --git a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/GeneralDistance.tex b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/GeneralDistance.tex index 9e0b4b53798..9f0489f7763 100755 --- a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/GeneralDistance.tex +++ b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/GeneralDistance.tex @@ -34,7 +34,7 @@ e.g., for an Euclidian distance the transformed distance is the squared Euclidea \ccOperations -\ccMethod{FT distance(Query_item q, Point_d r);}{Returns the transformed distance between \ccc{q} and \ccc{r}.} +\ccMethod{FT transformed_distance(Query_item q, Point_d r);}{Returns the transformed distance between \ccc{q} and~\ccc{r}.} \ccMethod{FT min_distance_to_rectangle(Query_item q, Kd_tree_rectangle r);} {Returns the transformed distance between \ccc{q} and diff --git a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Manhattan_distance_iso_box_point.tex b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Manhattan_distance_iso_box_point.tex index f2d585575ef..316a0bb7f9c 100755 --- a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Manhattan_distance_iso_box_point.tex +++ b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Manhattan_distance_iso_box_point.tex @@ -53,12 +53,13 @@ for example \ccc{CGAL::Cartesian::Iso_cuboid_3}. \ccOperations +\ccMethod{FT transformed distance(IsoBox b, Point_d p);}{Returns the transformed +distance between \ccc{b} and \ccc{p}.} + \ccMethod{FT transformed_distance(FT d);} {Returns $d$.} \ccMethod{FT inverse_of_transformed_distance(FT d);} {Returns $d$.} -\ccMethod{FT distance(IsoBox b, Point_d p);}{Returns the distance between \ccc{b} and \ccc{p}.} - \ccMethod{FT min_distance_to_rectangle(IsoBox b, Kd_tree_rectangle r);} {Returns the minimal distance between a point from \ccc{b} and a point from \ccc{r}.} diff --git a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/OrthogonalDistance.tex b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/OrthogonalDistance.tex index 9951fcbd456..2a669e26b6b 100755 --- a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/OrthogonalDistance.tex +++ b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/OrthogonalDistance.tex @@ -46,7 +46,7 @@ $d$-dimensional query items. \ccOperations -\ccMethod{FT distance(Point_d q, Point_d r);}{Returns the transformed distance between \ccc{q} and \ccc{r}.} +\ccMethod{FT transformed_distance(Point_d q, Point_d r);}{Returns the transformed distance between \ccc{q} and~\ccc{r}.} \ccMethod{FT min_distance_to_rectangle(Point_d q, Kd_tree_rectangle r);} {Returns the transformed distance between \ccc{q} and diff --git a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Weighted_Minkowski_distance.tex b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Weighted_Minkowski_distance.tex index 1d427989065..6e8ae01fe17 100755 --- a/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Weighted_Minkowski_distance.tex +++ b/Packages/Spatial_searching/doc_tex/basic/Spatial_searching_ref/Weighted_Minkowski_distance.tex @@ -56,7 +56,7 @@ The values in the iterator range \ccc{[wb,we)} are the weight. } \ccOperations -\ccMethod{FT distance(Point q, Point r);}{Returns $d^{power}$, +\ccMethod{FT transformed_distance(Point q, Point r);}{Returns $d^{power}$, where $d$ denotes the distance between \ccc{q} and \ccc{r}.} \ccMethod{FT min_distance_to_rectangle(Point q, Kd_tree_rectangle r;);} @@ -78,8 +78,8 @@ and returns the updated distance.} \ccSeeAlso -\ccc{OrthogonalDistance},\\ -\ccc{CGAL::Euclidean_distance}. +\ccc{OrthogonalDistance}\\ +\ccc{CGAL::Euclidean_distance} \end{ccRefClass}