Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add new entry in Release_Notes.
[simgrid.git] / src / xbt / utils / iter / subsets_tests.cpp
index 2db7f187ab06b1bfa3f4ccf5596393d1c108a9b8..fd7cee549659e709fc0e5dd3a5b15168f87b4834 100644 (file)
@@ -1,6 +1,7 @@
 #include "src/3rd-party/catch.hpp"
 #include "src/xbt/utils/iter/LazyKSubsets.hpp"
 #include "src/xbt/utils/iter/LazyPowerset.hpp"
+#include "src/xbt/utils/iter/variable_for_loop.hpp"
 
 #include <unordered_map>
 #include <unordered_set>
@@ -22,10 +23,10 @@ TEST_CASE("simgrid::xbt::subsets_iterator: Iteration General Properties")
 {
   std::vector<int> example_vec{0, 1, 2, 3, 4, 5, 6, 7};
 
-  SECTION("Each element of each subset is distinct and appears half of the time")
+  SECTION("Each element of each subset is distinct")
   {
     for (unsigned k = 0; static_cast<size_t>(k) < example_vec.size(); k++) {
-      for (auto& subset : make_k_subsets_iter(k, example_vec)) {
+      for (const auto& subset : make_k_subsets_iter(k, example_vec)) {
         // Each subset must have size `k`
         REQUIRE(subset.size() == k);
 
@@ -48,12 +49,12 @@ TEST_CASE("simgrid::xbt::powerset_iterator: Iteration General Properties")
   SECTION("Each element of each subset is distinct and appears half of the time in all subsets iteration")
   {
     // Each element is expected to be found in half of the sets
-    const unsigned k         = static_cast<unsigned>(example_vec.size());
+    const auto k             = static_cast<unsigned>(example_vec.size());
     const int expected_count = integer_power(2, k - 1);
 
     std::unordered_map<int, int> element_counts(k);
 
-    for (auto& subset : make_powerset_iter(example_vec)) {
+    for (const auto& subset : make_powerset_iter(example_vec)) {
       // Each subset must be comprised only of distinct elements
       std::unordered_set<int> elements_seen(k);
       for (const auto& element_ptr : subset) {
@@ -64,8 +65,126 @@ TEST_CASE("simgrid::xbt::powerset_iterator: Iteration General Properties")
       }
     }
 
-    for (const auto& iter : element_counts) {
-      REQUIRE(iter.second == expected_count);
+    for (const auto& [_, count] : element_counts) {
+      REQUIRE(count == expected_count);
     }
   }
-}
\ No newline at end of file
+}
+
+TEST_CASE("simgrid::xbt::variable_for_loop: Edge Cases")
+{
+  // Note the extra `{}` in the tests. This constructs a
+  // `std::reference_wrapper` to the specified collection
+  std::vector<int> outer_loop1{0, 1, 2, 3, 4};
+  std::vector<int> outer_loop2{0, 1, 6, 7};
+  std::vector<int> outer_loop3{1, 2};
+  std::vector<int> empty_set;
+
+  SECTION("Iterations without effect")
+  {
+    SECTION("Iteration over no collections")
+    {
+      variable_for_loop<std::vector<int>> first;
+      variable_for_loop<std::vector<int>> last;
+      REQUIRE(first == last);
+    }
+
+    SECTION("Iteration with an empty collection")
+    {
+      variable_for_loop<std::vector<int>> last;
+      REQUIRE(variable_for_loop<std::vector<int>>{{empty_set}} == last);
+      REQUIRE(variable_for_loop<std::vector<int>>{{outer_loop1}, {empty_set}} == last);
+      REQUIRE(variable_for_loop<std::vector<int>>{{outer_loop1}, {outer_loop2}, {empty_set}} == last);
+      REQUIRE(variable_for_loop<std::vector<int>>{{outer_loop1}, {outer_loop2}, {outer_loop3}, {empty_set}} == last);
+      REQUIRE(variable_for_loop<std::vector<int>>{{outer_loop3}, {empty_set}} == last);
+    }
+
+    SECTION("Iteration with multiple empty collections")
+    {
+      variable_for_loop<std::vector<int>> last;
+      REQUIRE(variable_for_loop<std::vector<int>>{{empty_set}} == last);
+      REQUIRE(variable_for_loop<std::vector<int>>{{empty_set}, {empty_set}} == last);
+      REQUIRE(variable_for_loop<std::vector<int>>{{outer_loop1}, {outer_loop2}, {empty_set}} == last);
+      REQUIRE(variable_for_loop<std::vector<int>>{{outer_loop1}, {outer_loop2}, {empty_set}, {empty_set}} == last);
+      REQUIRE(variable_for_loop<std::vector<int>>{
+                  {outer_loop1}, {outer_loop2}, {outer_loop3}, {empty_set}, {empty_set}} == last);
+    }
+  }
+
+  SECTION("Iteration with effects")
+  {
+    SECTION("Iteration over a single collection yields the collection")
+    {
+      variable_for_loop<std::vector<int>> first{{outer_loop1}};
+      variable_for_loop<std::vector<int>> last;
+
+      std::vector<int> elements_seen;
+
+      for (; first != last; ++first) {
+        const auto& elements = *first;
+        REQUIRE(elements.size() == 1);
+        elements_seen.push_back(*elements[0]);
+      }
+
+      REQUIRE(elements_seen == outer_loop1);
+    }
+
+    SECTION("Iteration over two collections yields all pairs")
+    {
+      variable_for_loop<std::vector<int>> first{{outer_loop1, outer_loop2}};
+      variable_for_loop<std::vector<int>> last;
+
+      std::vector<std::pair<int, int>> pairs_seen;
+      for (; first != last; ++first) {
+        const auto& elements = *first;
+        REQUIRE(elements.size() == 2);
+        pairs_seen.push_back(std::make_pair(*elements[0], *elements[1]));
+      }
+
+      std::vector<std::pair<int, int>> expected_pairs{{0, 0}, {0, 1}, {0, 6}, {0, 7}, {1, 0}, {1, 1}, {1, 6},
+                                                      {1, 7}, {2, 0}, {2, 1}, {2, 6}, {2, 7}, {3, 0}, {3, 1},
+                                                      {3, 6}, {3, 7}, {4, 0}, {4, 1}, {4, 6}, {4, 7}};
+      REQUIRE(pairs_seen == expected_pairs);
+    }
+
+    SECTION("Iteration over three collections yields all triples")
+    {
+      variable_for_loop<std::vector<int>> first{{outer_loop3, outer_loop1, outer_loop2}};
+      variable_for_loop<std::vector<int>> last;
+
+      std::vector<std::tuple<int, int, int>> triples_seen;
+      for (; first != last; ++first) {
+        const auto& elements = *first;
+        REQUIRE(elements.size() == 3);
+        triples_seen.push_back(std::make_tuple(*elements[0], *elements[1], *elements[2]));
+      }
+
+      std::vector<std::tuple<int, int, int>> expected_triples{
+          {1, 0, 0}, {1, 0, 1}, {1, 0, 6}, {1, 0, 7}, {1, 1, 0}, {1, 1, 1}, {1, 1, 6}, {1, 1, 7}, {1, 2, 0}, {1, 2, 1},
+          {1, 2, 6}, {1, 2, 7}, {1, 3, 0}, {1, 3, 1}, {1, 3, 6}, {1, 3, 7}, {1, 4, 0}, {1, 4, 1}, {1, 4, 6}, {1, 4, 7},
+
+          {2, 0, 0}, {2, 0, 1}, {2, 0, 6}, {2, 0, 7}, {2, 1, 0}, {2, 1, 1}, {2, 1, 6}, {2, 1, 7}, {2, 2, 0}, {2, 2, 1},
+          {2, 2, 6}, {2, 2, 7}, {2, 3, 0}, {2, 3, 1}, {2, 3, 6}, {2, 3, 7}, {2, 4, 0}, {2, 4, 1}, {2, 4, 6}, {2, 4, 7}};
+
+      REQUIRE(triples_seen == expected_triples);
+    }
+
+    SECTION("Iteration over all collections yields all combinations")
+    {
+      std::vector<int> outer_loop4{1, 5};
+      std::vector<int> outer_loop5{1, 8};
+
+      variable_for_loop<std::vector<int>> first{
+          {outer_loop1}, {outer_loop2}, {outer_loop3}, {outer_loop4}, {outer_loop5}};
+      variable_for_loop<std::vector<int>> last;
+
+      size_t total_iterations = 0;
+      for (; first != last; ++first, ++total_iterations) {
+        const auto& elements = *first;
+        REQUIRE(elements.size() == 5);
+      }
+      REQUIRE(total_iterations ==
+              (outer_loop1.size() * outer_loop2.size() * outer_loop3.size() * outer_loop4.size() * outer_loop5.size()));
+    }
+  }
+}