Document kernel converters

CGAL · Sep 20, 2024 · 7ef1a76 · 7ef1a76
1 parent b7cc075
commit 7ef1a76
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 8 deletions.
diff --git a/Frechet_distance/doc/Frechet_distance/Concepts/FrechetDistanceTraits.h b/Frechet_distance/doc/Frechet_distance/Concepts/FrechetDistanceTraits.h
@@ -83,5 +83,13 @@ The  point type must have `operator[]` returning a number type which can be used
 */
 using Exact_point = unspecified_type;
 
+/*! A converter for points from `Kernel` to  `Filtered_kernel`
+*/
+using K2F = unspecified_type;
+
+
+/*! A converter for points from `Filtered_kernel` to  `Exact_kernel`
+*/
+using F2E = unspecified_type;
 /// @}
 };
diff --git a/Frechet_distance/include/CGAL/Frechet_distance/internal/curve.h b/Frechet_distance/include/CGAL/Frechet_distance/internal/curve.h
@@ -104,9 +104,9 @@ class Curve
     using Rational = typename Rational_kernel::FT;
     using Rational_point = typename Traits::Exact_point;
 
-    using I2R = typename Traits::I2R;
+    using I2R = typename Traits::F2E;
 
-    using K2I = typename Traits::K2I;
+    using K2I = typename Traits::K2F;
 
     Curve() = default;
 

diff --git a/Frechet_distance/include/CGAL/Frechet_distance_traits_2.h b/Frechet_distance/include/CGAL/Frechet_distance_traits_2.h
@@ -61,10 +61,10 @@ class Frechet_distance_traits_2
     using Exact_point = typename Exact_kernel::Point_2;
 
     using D2D = NT_converter<distance_t,double>;
-    using I2R = Cartesian_converter<Filtered_kernel, Exact_kernel, D2D>;
+    using F2E = Cartesian_converter<Filtered_kernel, Exact_kernel, D2D>;
 
     using FT2I = NT_converter<typename Kernel::FT,distance_t>;
-    using K2I = Cartesian_converter<Kernel, Filtered_kernel, FT2I>;
+    using K2F = Cartesian_converter<Kernel, Filtered_kernel, FT2I>;
 
     /// @todo remove?
     using Polyline = std::vector<Point>;

diff --git a/Frechet_distance/include/CGAL/Frechet_distance_traits_3.h b/Frechet_distance/include/CGAL/Frechet_distance_traits_3.h
@@ -61,10 +61,10 @@ class Frechet_distance_traits_3
     using Exact_point = typename Exact_kernel::Point_3;
 
     using D2D = NT_converter<distance_t,double>;
-    using I2R = Cartesian_converter<Filtered_kernel, Exact_kernel, D2D>;
+    using F2E = Cartesian_converter<Filtered_kernel, Exact_kernel, D2D>;
 
     using FT2I = NT_converter<typename Kernel::FT,distance_t>;
-    using K2I = Cartesian_converter<Kernel, Filtered_kernel, FT2I>;
+    using K2F = Cartesian_converter<Kernel, Filtered_kernel, FT2I>;
 
 
     /// @todo remove?

diff --git a/Frechet_distance/include/CGAL/Frechet_distance_traits_d.h b/Frechet_distance/include/CGAL/Frechet_distance_traits_d.h
@@ -62,10 +62,10 @@ class Frechet_distance_traits_d
     using Exact_point = typename Exact_kernel::Point_d;
 
     using D2D = NT_converter<distance_t,double>;
-    using I2R = KernelD_converter<Filtered_kernel, Exact_kernel, Default, D2D>;
+    using F2E = KernelD_converter<Filtered_kernel, Exact_kernel, Default, D2D>;
 
     using FT2I = NT_converter<typename Kernel::FT,distance_t>;
-    using K2I = KernelD_converter<Kernel, Filtered_kernel, Default, FT2I>;
+    using K2F = KernelD_converter<Kernel, Filtered_kernel, Default, FT2I>;
 
 
     /// @todo  remove?