Add new entry in Release_Notes.

[simgrid.git] / src / kernel / lmm / bmf.hpp

diff --git a/src/kernel/lmm/bmf.hpp b/src/kernel/lmm/bmf.hpp
index e478df6..3bebff1 100644 (file)
--- a/src/kernel/lmm/bmf.hpp
+++ b/src/kernel/lmm/bmf.hpp
@@ -1,18 +1,29 @@
-/* Copyright (c) 2004-2022. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#ifndef SURF_BMF_HPP
-#define SURF_BMF_HPP
+#ifndef SIMGRID_KERNEL_LMM_BMF_HPP
+#define SIMGRID_KERNEL_LMM_BMF_HPP
 
-#include "src/kernel/lmm/maxmin.hpp"
+#include "src/kernel/lmm/System.hpp"
+#include "xbt/config.hpp"
+
+#include <set>
+
+#ifdef __clang__
+// Ignore deprecation warnings with Eigen < 4.0 (see https://gitlab.com/libeigen/eigen/-/issues/1850)
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+#endif
 #include <Eigen/Dense>
+#ifdef __clang__
+#pragma clang diagnostic pop
+#endif
+
 #include <unordered_set>
 
-namespace simgrid {
-namespace kernel {
-namespace lmm {
+namespace simgrid::kernel::lmm {
 
 /** @brief Generate all combinations of valid allocation */
 class XBT_PUBLIC AllocationGenerator {
@@ -65,6 +76,12 @@ private:
  * @endrst
  */
 class XBT_PUBLIC BmfSolver {
+  inline static simgrid::config::Flag<int> cfg_bmf_max_iteration{
+      "bmf/max-iterations", "Maximum number of steps to be performed while searching for a BMF allocation", 1000};
+
+  inline static simgrid::config::Flag<double> cfg_bmf_precision{
+      "bmf/precision", {"precision/bmf"}, "Numerical precision used when computing resource sharing", 1E-12};
+
 public:
   /**
    * @brief Instantiate the BMF solver
@@ -92,6 +109,14 @@ private:
    * @return Actual resource capacity
    */
   double get_resource_capacity(int resource, const std::vector<int>& bounded_players) const;
+  /**
+   * @brief Get maxmin share of the resource
+   *
+   * @param resource Internal index of resource in C_ vector
+   * @param bounded_players List of players that are externally bounded
+   * @return maxmin share
+   */
+  double get_maxmin_share(int resource, const std::vector<int>& bounded_players) const;
   /**
    * @brief Auxiliary method to get list of bounded player from allocation
    *
@@ -178,9 +203,8 @@ private:
 
   std::set<std::vector<int>> allocations_; //!< set of already tested allocations, since last identified loop
   AllocationGenerator gen_;
-  std::vector<int> allocations_age_;
   static constexpr int NO_RESOURCE = -1;                    //!< flag to indicate player has selected no resource
-  int max_iteration_;                                       //!< number maximum of iterations of BMF algorithm
+  int max_iteration_               = cfg_bmf_max_iteration; //!< number maximum of iterations of BMF algorithm
 };
 
 /**
@@ -224,10 +248,10 @@ private:
 class XBT_PUBLIC BmfSystem : public System {
 public:
   using System::System;
-  /** @brief Implements the solve method to calculate a BMF allocation */
-  void solve() final;
 
 private:
+  /** @brief Implements the solve method to calculate a BMF allocation */
+  void do_solve() final;
   using allocation_map_t = std::unordered_map<int, std::unordered_set<int>>;
   /**
    * @brief Solve equation system to find a fair-sharing of resources
@@ -260,11 +284,8 @@ private:
 
   std::unordered_map<int, Variable*> idx2Var_; //!< Map player index (and position in matrices) to system's variable
   std::unordered_map<const Constraint*, int> cnst2idx_; //!< Conversely map constraint to index
-  bool warned_nonlinear_ = false;
 };
 
-} // namespace lmm
-} // namespace kernel
-} // namespace simgrid
+} // namespace simgrid::kernel::lmm
 
 #endif