Legacy ortools behind API - user story 3.1 & 3.2 (#2455)

AntaresSimulatorTeam · Oct 23, 2024 · b94e65e · b94e65e
1 parent 0bb9b9a
commit b94e65e
Show file tree

Hide file tree

Showing 16 changed files with 400 additions and 354 deletions.
diff --git a/src/packaging/CMakeLists.txt b/src/packaging/CMakeLists.txt
@@ -6,18 +6,18 @@
 include(GNUInstallDirs)
 # generate and install export file
 set(TARGET_LIBS #No alias
-        #each "block" of dependency describe the dependency for a target
-        #not dependency is present since once a dependency is in the export set
-        #it is available for everything
+        # each "block" of dependency describe the dependency for a target
+        # not dependency is present since once a dependency is in the export set
+        # it is available for everything
 
-        solver_api #What we want to export
+        solver_api # What we want to export
 
-        #solver_api
+        # solver_api
         study
         study-loader
         file-tree-study-loader
         antares-solver-simulation
-        #study
+        # study
         yuni-static-core
         array
         date
@@ -37,56 +37,57 @@ set(TARGET_LIBS #No alias
         antares-solver-variable
         lps
 
-        #study-loader
-        #nothing
+        # study-loader : nothing
 
-        #file-tree-study-loader
+        # file-tree-study-loader
         application
 
-        #run-mode
+        # run-mode
         infoCollection
 
-        #antares-solver-simulation
+        # antares-solver-simulation
         concurrency
         misc
         model_antares
         antares-solver-ts-generator
 
-        #lps
-        #nothing
+        # lps : nothing
 
-        #array
+        # array
         io
         jit
         AntaresMemory
 
-        #date
+        # date
         logs
 
-        #correlation
+        # correlation
         locator
 
-        #antares-core
+        # antares-core
         antares-config-lib
 
-        #application
+        # application
         solver-lib
         sys
         signal-handling
         antares-solver-variable-info
         optimization-options
         resources
 
-        #model_antares
+        # model_antares
         infeasible_problem_analysis
+        modeler_api
+        modeler-ortools-impl
 
-        #solver-lib
+        # solver-lib
         args_helper
         checks
         locale
         yuni-static-uuid
 
-        antares-solver #executable
+        # executable
+        antares-solver
 )
 
 install(TARGETS ${TARGET_LIBS}

diff --git a/src/solver/modeler/api/include/antares/solver/modeler/api/linearProblem.h b/src/solver/modeler/api/include/antares/solver/modeler/api/linearProblem.h
@@ -46,6 +46,9 @@ class ILinearProblem
     virtual IMipVariable* addNumVariable(double lb, double ub, const std::string& name) = 0;
     /// Create a integer variable
     virtual IMipVariable* addIntVariable(double lb, double ub, const std::string& name) = 0;
+    /// Create a continuous or integer variable
+    virtual IMipVariable* addVariable(double lb, double ub, bool integer, const std::string& name)
+      = 0;
     virtual IMipVariable* getVariable(const std::string& name) const = 0;
     virtual int variableCount() const = 0;
 
@@ -68,6 +71,9 @@ class ILinearProblem
 
     /// Solve the problem, returns a IMipSolution
     virtual IMipSolution* solve(bool verboseSolver) = 0;
+
+    // Definition of infinity
+    virtual double infinity() const = 0;
 };
 
 } // namespace Antares::Solver::Modeler::Api
diff --git a/src/solver/modeler/api/linearProblemBuilder.cpp b/src/solver/modeler/api/linearProblemBuilder.cpp
@@ -20,7 +20,6 @@
  */
 
 #include <algorithm>
-#include <memory>
 
 #include <antares/solver/modeler/api/linearProblemBuilder.h>
 

diff --git a/src/solver/modeler/ortoolsImpl/include/antares/solver/modeler/ortoolsImpl/linearProblem.h b/src/solver/modeler/ortoolsImpl/include/antares/solver/modeler/ortoolsImpl/linearProblem.h
@@ -36,14 +36,18 @@ class MPObjective;
 namespace Antares::Solver::Modeler::OrtoolsImpl
 {
 
-class OrtoolsLinearProblem final: public Api::ILinearProblem
+class OrtoolsLinearProblem: public Api::ILinearProblem
 {
 public:
     OrtoolsLinearProblem(bool isMip, const std::string& solverName);
     ~OrtoolsLinearProblem() override = default;
 
     OrtoolsMipVariable* addNumVariable(double lb, double ub, const std::string& name) override;
     OrtoolsMipVariable* addIntVariable(double lb, double ub, const std::string& name) override;
+    OrtoolsMipVariable* addVariable(double lb,
+                                    double ub,
+                                    bool integer,
+                                    const std::string& name) override;
     OrtoolsMipVariable* getVariable(const std::string& name) const override;
     int variableCount() const override;
 
@@ -62,10 +66,13 @@ class OrtoolsLinearProblem final: public Api::ILinearProblem
 
     OrtoolsMipSolution* solve(bool verboseSolver) override;
 
-private:
-    OrtoolsMipVariable* addVariable(double lb, double ub, bool integer, const std::string& name);
+    double infinity() const override;
+
+protected:
+    operations_research::MPSolver* MpSolver() const;
 
-    std::shared_ptr<operations_research::MPSolver> mpSolver_;
+private:
+    operations_research::MPSolver* mpSolver_;
     operations_research::MPObjective* objective_;
     operations_research::MPSolverParameters params_;
 

diff --git a/src/solver/modeler/ortoolsImpl/include/antares/solver/modeler/ortoolsImpl/mipSolution.h b/src/solver/modeler/ortoolsImpl/include/antares/solver/modeler/ortoolsImpl/mipSolution.h
@@ -35,7 +35,7 @@ class OrtoolsMipSolution final: public Api::IMipSolution
 {
 public:
     OrtoolsMipSolution(operations_research::MPSolver::ResultStatus& responseStatus,
-                       std::shared_ptr<operations_research::MPSolver> solver);
+                       operations_research::MPSolver* solver);
 
     ~OrtoolsMipSolution() override = default;
 
@@ -47,7 +47,7 @@ class OrtoolsMipSolution final: public Api::IMipSolution
 
 private:
     operations_research::MPSolver::ResultStatus status_;
-    std::shared_ptr<operations_research::MPSolver> mpSolver_;
+    operations_research::MPSolver* mpSolver_;
     std::map<std::string, double> solution_;
 };
 

diff --git a/src/solver/modeler/ortoolsImpl/linearProblem.cpp b/src/solver/modeler/ortoolsImpl/linearProblem.cpp
@@ -31,16 +31,8 @@ namespace Antares::Solver::Modeler::OrtoolsImpl
 
 OrtoolsLinearProblem::OrtoolsLinearProblem(bool isMip, const std::string& solverName)
 {
-    auto* mpSolver = isMip ? MPSolver::CreateSolver(
-                               (OrtoolsUtils::solverMap.at(solverName)).MIPSolverName)
-                           : MPSolver::CreateSolver(
-                               (OrtoolsUtils::solverMap.at(solverName)).LPSolverName);
-
-    mpSolver_ = std::unique_ptr<operations_research::MPSolver>(mpSolver);
-    objective_ = mpSolver->MutableObjective();
-
-    params_.SetIntegerParam(MPSolverParameters::SCALING, 0);
-    params_.SetIntegerParam(MPSolverParameters::PRESOLVE, 0);
+    mpSolver_ = MPSolverFactory(isMip, solverName);
+    objective_ = mpSolver_->MutableObjective();
 }
 
 class ElemAlreadyExists: public std::exception
@@ -172,6 +164,11 @@ bool OrtoolsLinearProblem::isMaximization() const
     return objective_->maximization();
 }
 
+MPSolver* OrtoolsLinearProblem::MpSolver() const
+{
+    return mpSolver_;
+}
+
 OrtoolsMipSolution* OrtoolsLinearProblem::solve(bool verboseSolver)
 {
     if (verboseSolver)
@@ -185,4 +182,9 @@ OrtoolsMipSolution* OrtoolsLinearProblem::solve(bool verboseSolver)
     return solution_.get();
 }
 
+double OrtoolsLinearProblem::infinity() const
+{
+    return MPSolver::infinity();
+}
+
 } // namespace Antares::Solver::Modeler::OrtoolsImpl
diff --git a/src/solver/modeler/ortoolsImpl/mipSolution.cpp b/src/solver/modeler/ortoolsImpl/mipSolution.cpp
@@ -26,7 +26,7 @@ namespace Antares::Solver::Modeler::OrtoolsImpl
 {
 
 OrtoolsMipSolution::OrtoolsMipSolution(operations_research::MPSolver::ResultStatus& status,
-                                       std::shared_ptr<operations_research::MPSolver> solver):
+                                       operations_research::MPSolver* solver):
     status_(status),
     mpSolver_(solver)
 {