From 69c70afd0442774582b7e930bdab603600a3e750 Mon Sep 17 00:00:00 2001
From: ROUVREAU Vincent <vincent.rouvreau@inria.fr>
Date: Tue, 3 Nov 2020 11:33:39 +0100
Subject: doc review: explain briefly test aims

---
 .../test/Alpha_kernel_d_unit_test.cpp              |  5 ++++
 .../test/Weighted_alpha_complex_unit_test.cpp      | 30 ++++++++++++++--------
 2 files changed, 25 insertions(+), 10 deletions(-)

diff --git a/src/Alpha_complex/test/Alpha_kernel_d_unit_test.cpp b/src/Alpha_complex/test/Alpha_kernel_d_unit_test.cpp
index 6eae103d..6da4c084 100644
--- a/src/Alpha_complex/test/Alpha_kernel_d_unit_test.cpp
+++ b/src/Alpha_complex/test/Alpha_kernel_d_unit_test.cpp
@@ -37,6 +37,8 @@ typedef CGAL::Epick_d< CGAL::Dimension_tag<4> > Inexact_kernel_s;
 typedef boost::mpl::list<Exact_kernel_d, Exact_kernel_s, Inexact_kernel_d, Inexact_kernel_s> list_of_kernel_variants;
 
 BOOST_AUTO_TEST_CASE_TEMPLATE(Alpha_kernel_d_dimension, TestedKernel, list_of_kernel_variants) {
+  // Test for a point (weighted or not) in 4d, that the dimension is 4.
+
   Gudhi::alpha_complex::Alpha_kernel_d<TestedKernel, false> kernel;
   std::vector<double> p0 {0., 1., 2., 3.};
   typename TestedKernel::Point_d p0_d(p0.begin(), p0.end());
@@ -52,6 +54,9 @@ BOOST_AUTO_TEST_CASE_TEMPLATE(Alpha_kernel_d_dimension, TestedKernel, list_of_ke
 }
 
 BOOST_AUTO_TEST_CASE_TEMPLATE(Alpha_kernel_d_sphere, TestedKernel, list_of_kernel_variants) {
+  // Test with 5 points on a 3-sphere, that get_sphere returns the same center and squared radius
+  // for dD unweighted and for dD weighted with all weights at 0.
+
   using Unweighted_kernel = Gudhi::alpha_complex::Alpha_kernel_d<TestedKernel, false>;
   // Sphere: (x-1)² + (y-1)² + z² + t² = 1
   // At least 5 points for a 3-sphere
diff --git a/src/Alpha_complex/test/Weighted_alpha_complex_unit_test.cpp b/src/Alpha_complex/test/Weighted_alpha_complex_unit_test.cpp
index b84ab3de..2cd66963 100644
--- a/src/Alpha_complex/test/Weighted_alpha_complex_unit_test.cpp
+++ b/src/Alpha_complex/test/Weighted_alpha_complex_unit_test.cpp
@@ -27,14 +27,14 @@
 #include <gudhi/Simplex_tree.h>
 #include <gudhi/Unitary_tests_utils.h>
 
-// Use dynamic_dimension_tag for the user to be able to set dimension
-typedef CGAL::Epeck_d< CGAL::Dynamic_dimension_tag > Exact_kernel_d;
-// Use static dimension_tag to set dimension at 4
-typedef CGAL::Epeck_d< CGAL::Dimension_tag<4> > Exact_kernel_s;
+using list_of_exact_kernel_variants = boost::mpl::list<CGAL::Epeck_d< CGAL::Dynamic_dimension_tag >,
+                                                       CGAL::Epeck_d< CGAL::Dimension_tag<4> >
+                                                       > ;
 
-typedef boost::mpl::list<Exact_kernel_d, Exact_kernel_s> list_of_kernel_variants;
+BOOST_AUTO_TEST_CASE_TEMPLATE(Zero_weighted_alpha_complex, Kernel, list_of_exact_kernel_variants) {
+  // Check that in exact mode for static dimension 4 the code for dD unweighted and for dD weighted with all weights
+  // 0 give exactly the same simplex tree (simplices and filtration values).
 
-BOOST_AUTO_TEST_CASE_TEMPLATE(Zero_weighted_alpha_complex, Kernel, list_of_kernel_variants) {
   // Random points construction
   using Point_d = typename Kernel::Point_d;
   std::vector<Point_d> points;
@@ -89,6 +89,8 @@ bool cgal_3d_point_sort (Point_d a,Point_d b) {
 }
 
 BOOST_AUTO_TEST_CASE(Weighted_alpha_complex_3d_comparison) {
+  // check that for random weighted 3d points in safe mode the 3D and dD codes give the same result with some tolerance
+
   // Random points construction
   using Kernel_dD = CGAL::Epeck_d< CGAL::Dimension_tag<3> >;
   using Bare_point_d = typename Kernel_dD::Point_d;
@@ -186,17 +188,25 @@ BOOST_AUTO_TEST_CASE(Weighted_alpha_complex_3d_comparison) {
   }
 }
 
-BOOST_AUTO_TEST_CASE(Weighted_alpha_complex_non_visible_points) {
-  using Point_d = typename Exact_kernel_d::Point_d;
+using list_of_1d_kernel_variants = boost::mpl::list<CGAL::Epeck_d< CGAL::Dynamic_dimension_tag >,
+                                                    CGAL::Epeck_d< CGAL::Dimension_tag<1>>,
+                                                    CGAL::Epick_d< CGAL::Dynamic_dimension_tag >,
+                                                    CGAL::Epick_d< CGAL::Dimension_tag<1>>
+                                                    >;
+
+BOOST_AUTO_TEST_CASE_TEMPLATE(Weighted_alpha_complex_non_visible_points, Kernel, list_of_1d_kernel_variants) {
+  // check that for 2 closed weighted 1-d points, one with a high weight to hide the second one with a small weight,
+  // that the point with a small weight has the same high filtration value than the edge formed by the 2 points
+  using Point_d = typename Kernel::Point_d;
   std::vector<Point_d> points;
   std::vector<double> p1 {0.};
   points.emplace_back(p1.begin(), p1.end());
   // closed enough points
   std::vector<double> p2 {0.1};
   points.emplace_back(p2.begin(), p2.end());
-  std::vector<typename Exact_kernel_d::FT> weights {100., 0.01};
+  std::vector<typename Kernel::FT> weights {100., 0.01};
 
-  Gudhi::alpha_complex::Alpha_complex<Exact_kernel_d, true> alpha_complex(points, weights);
+  Gudhi::alpha_complex::Alpha_complex<Kernel, true> alpha_complex(points, weights);
   Gudhi::Simplex_tree<> stree;
   BOOST_CHECK(alpha_complex.create_complex(stree));
 
-- 
cgit v1.2.3