Rework setDestinationNodes function in Dynamics class

Author: Grufoony

benchmark/Dynamics/BenchDynamics.cpp

@@ -18,14 +18,12 @@ int main() {
   graph.buildAdj();
 
   Dynamics dynamics{graph};
-  std::vector<dsm::Id> destinations{10, 42, 69, 121, 420, 690, 777, 999, 1020, 1212};
-  dynamics.setDestinationNodes(destinations);
+  dynamics.setDestinationNodes({10, 42, 69, 121, 420, 690, 777, 999, 1020, 1212}, false);
 
   const int n_rep{1};
   Bench b1(n_rep);
   std::cout << "Benchmarking updatePaths\n";
-  dynamics.updatePaths();
   b1.benchmark([&dynamics]() -> void { dynamics.updatePaths(); });
-  std::cout << "Time elapsed (ms):\n";
-  b1.print<sb::milliseconds>();
+  std::cout << "Time elapsed (s):\n";
+  b1.print<sb::seconds>();
 }

src/dsm/headers/Dynamics.hpp

@@ -200,12 +200,18 @@ namespace dsm {
     /// @brief Update the paths of the itineraries based on the actual travel times
     virtual void updatePaths();
 
-    /// @brief Set the dynamics destination nodes auto-generating itineraries
-    /// @param destinationNodes The destination nodes
+    /// @brief Set the destination nodes
+    /// @param destinationNodes The destination nodes (as an initializer list)
     /// @param updatePaths If true, the paths are updated
-    /// @throws std::invalid_argument Ifone or more destination nodes do not exist
-    void setDestinationNodes(const std::span<Id>& destinationNodes,
+    void setDestinationNodes(std::initializer_list<Id> destinationNodes,
                              bool updatePaths = true);
+    /// @brief Set the destination nodes
+    /// @param destinationNodes A container of destination nodes ids
+    /// @param updatePaths If true, the paths are updated
+    /// @details The container must have a value_type convertible to Id and begin() and end() methods
+    template <typename TContainer>
+      requires(std::is_convertible_v<typename TContainer::value_type, Id>)
+    void setDestinationNodes(TContainer const& destinationNodes, bool updatePaths = true);
 
     /// @brief Add an agent to the simulation
     /// @param agent std::unique_ptr to the agent
@@ -253,6 +259,7 @@ namespace dsm {
     /// @brief Add an itinerary
     /// @param itinerary std::unique_ptr to the itinerary
     /// @throws std::invalid_argument If the itinerary already exists
+    /// @throws std::invalid_argument If the itinerary's destination is not a node of the graph
     void addItinerary(std::unique_ptr<Itinerary> itinerary);
     template <typename... Tn>
       requires(is_itinerary_v<Tn> && ...)
@@ -373,36 +380,28 @@ namespace dsm {
         m_itineraries.cbegin(), m_itineraries.cend(), [this](auto const& pair) -> void {
           this->m_updatePath(pair.second);
         });
-    // std::vector<std::thread> threads;
-    // threads.reserve(m_itineraries.size());
-    // std::exception_ptr pThreadException;
-    // for (const auto& [itineraryId, itinerary] : m_itineraries) {
-    //   threads.emplace_back(std::thread([this, &itinerary, &pThreadException] {
-    //     try {
-    //       this->m_updatePath(itinerary);
-    //     } catch (...) {
-    //       if (!pThreadException)
-    //         pThreadException = std::current_exception();
-    //     }
-    //   }));
-    // }
-    // for (auto& thread : threads) {
-    //   thread.join();
-    // }
-    // // Throw the exception launched first
-    // if (pThreadException)
-    //   std::rethrow_exception(pThreadException);
   }
 
   template <typename agent_t>
-  void Dynamics<agent_t>::setDestinationNodes(const std::span<Id>& destinationNodes,
+  void Dynamics<agent_t>::setDestinationNodes(std::initializer_list<Id> destinationNodes,
                                               bool updatePaths) {
-    for (const auto& nodeId : destinationNodes) {
-      if (!m_graph.nodeSet().contains(nodeId)) {
-        Logger::error(std::format("Node with id {} not found", nodeId));
-      }
-      this->addItinerary(nodeId, nodeId);
+    std::for_each(
+        destinationNodes.begin(),
+        destinationNodes.end(),
+        [this](auto const& nodeId) -> void { this->addItinerary(nodeId, nodeId); });
+    if (updatePaths) {
+      this->updatePaths();
     }
+  }
+  template <typename agent_t>
+  template <typename TContainer>
+    requires(std::is_convertible_v<typename TContainer::value_type, Id>)
+  void Dynamics<agent_t>::setDestinationNodes(TContainer const& destinationNodes,
+                                              bool updatePaths) {
+    std::for_each(
+        destinationNodes.begin(),
+        destinationNodes.end(),
+        [this](auto const& nodeId) -> void { this->addItinerary(nodeId, nodeId); });
     if (updatePaths) {
       this->updatePaths();
     }
@@ -488,6 +487,10 @@ namespace dsm {
       throw std::invalid_argument(Logger::buildExceptionMessage(
           std::format("Itinerary with id {} already exists.", itinerary->id())));
     }
+    if (!m_graph.nodeSet().contains(itinerary->destination())) {
+      throw std::invalid_argument(Logger::buildExceptionMessage(std::format(
+          "Destination node with id {} not found", itinerary->destination())));
+    }
     m_itineraries.emplace(itinerary->id(), std::move(itinerary));
   }
 

test/Test_dynamics.cpp

@@ -512,8 +512,7 @@ TEST_CASE("Dynamics") {
       graph2.addStreets(s0_1, s1_0, s1_2, s2_1);
       graph2.buildAdj();
       Dynamics dynamics{graph2, false, 69};
-      std::vector<dsm::Id> dsts{1, 2};
-      dynamics.setDestinationNodes(dsts);
+      dynamics.setDestinationNodes({1, 2});
       std::vector<dsm::Id> trip{2, 1};
       dynamics.addAgent(0, trip, 0);
       auto const& pAgent{dynamics.agents().at(0)};
@@ -619,9 +618,7 @@ TEST_CASE("Dynamics") {
       graph2.buildStreetAngles();
 
       Dynamics dynamics{graph2, false, 69};
-
-      std::vector<uint32_t> destinationNodes{0, 2, 3, 4};
-      dynamics.setDestinationNodes(destinationNodes);
+      dynamics.setDestinationNodes({0, 2, 3, 4});
 
       WHEN("We add agents and make the system evolve") {
         Agent agent1{0, 2, 0};
@@ -688,9 +685,7 @@ TEST_CASE("Dynamics") {
       graph2.buildStreetAngles();
 
       Dynamics dynamics{graph2, false, 69};
-
-      std::vector<uint32_t> destinationNodes{0, 2, 3, 4};
-      dynamics.setDestinationNodes(destinationNodes);
+      dynamics.setDestinationNodes({0, 2, 3, 4});
 
       WHEN("We add agents and make the system evolve") {
         Agent agent1{0, 2, 0};
@@ -744,8 +739,7 @@ TEST_CASE("Dynamics") {
         tl.setComplementaryCycle(16, 11);
         tl.setComplementaryCycle(21, 11);
         Dynamics dynamics{graph2, false, 69};
-        std::vector<dsm::Id> destinationNodes{0, 2, 3, 4};
-        dynamics.setDestinationNodes(destinationNodes);
+        dynamics.setDestinationNodes({0, 2, 3, 4});
         WHEN("We evolve the dynamics and optimize traffic lights") {
           dynamics.addAgents(7, 0, 2);
           dynamics.addAgents(7, 2, 0);