Take into account breaking change in OR-Tools's API, enable SCIP & GL…

…PK solvers, bump OR-Tools (#1825)

- `SetStartingLpBasisInt` and `GetFinalBasisInt` have been removed from
recent versions, due to redundancy with their non-Int counterparts.
- Bump OR-Tools v9.5-rte2.0 -> v9.5-rte3.0 
- Add SCIP solver in lookup list (works better for MILP) and GLPK

.github/workflows/centos7.yml

@@ -44,7 +44,7 @@ jobs:
 
     - name: Config OR-Tools URL
       run: |
-           echo "URL_ORTOOLS=https://github.com/rte-france/or-tools/releases/download/v9.5-rte2.0/ortools_cxx_centos7_static_sirius.zip" >> $GITHUB_ENV
+           echo "URL_ORTOOLS=https://github.com/rte-france/or-tools/releases/download/$(cat ortools_tag)/ortools_cxx_centos7_static_sirius.zip" >> $GITHUB_ENV
 
     - name: Download OR-Tools
       id: ortools

.github/workflows/sonarcloud.yml

@@ -20,13 +20,16 @@ jobs:
     env:
       SONAR_SERVER_URL: "https://sonarcloud.io"
       ORTOOLS_DIR: ${{ github.workspace }}/or-tools
-      ORTOOLS_URL: "https://github.com/rte-france/or-tools/releases/download/v9.5-rte2.0/ortools_cxx_ubuntu-20.04_static_sirius.zip"
 
     steps:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
 
+      - name: Config OR-Tools URL
+        run: |
+            echo "ORTOOLS_URL=https://github.com/rte-france/or-tools/releases/download/$(cat ortools_tag)/ortools_cxx_ubuntu-20.04_static_sirius.zip" >> $GITHUB_ENV
+
       - name: Install sonar-scanner and build-wrapper
         uses: SonarSource/sonarcloud-github-c-cpp@v2
 

.github/workflows/ubuntu.yml

@@ -66,7 +66,7 @@ jobs:
 
     - name: Config OR-Tools URL
       run: |
-          echo "ORTOOLS_URL=https://github.com/rte-france/or-tools/releases/download/v9.5-rte2.0/ortools_cxx_ubuntu-20.04_static_sirius.zip" >> $GITHUB_ENV
+          echo "ORTOOLS_URL=https://github.com/rte-france/or-tools/releases/download/$(cat ortools_tag)/ortools_cxx_ubuntu-20.04_static_sirius.zip" >> $GITHUB_ENV
 
     - name: Download pre-compiled librairies
       uses: ./.github/workflows/download-extract-precompiled-libraries-tgz

.github/workflows/windows-release.yml

@@ -20,11 +20,15 @@ jobs:
       # Indicates the location of the vcpkg as a Git submodule of the project repository.
       VCPKG_ROOT: ${{ github.workspace }}/vcpkg
       ORTOOLS_DIR: ${{ github.workspace }}/or-tools
-      ORTOOLS_URL: "https://github.com/rte-france/or-tools/releases/download/v9.5-rte2.0/ortools_cxx_windows-latest_static_sirius.zip"
 
     steps:
     - uses: actions/checkout@v3
 
+    - name: Config OR-Tools URL
+      run: |
+          echo "ORTOOLS_URL=https://github.com/rte-france/or-tools/releases/download/$(cat ortools_tag)/ortools_cxx_windows-latest_static_sirius.zip" >> $GITHUB_ENV    
+      shell: bash
+
     - name: Pre-requisites
       shell: cmd
       run: |

.github/workflows/windows-vcpkg.yml

@@ -30,12 +30,16 @@ jobs:
       # Indicates the location of the vcpkg as a Git submodule of the project repository.
       VCPKG_ROOT: ${{ github.workspace }}/vcpkg
       ORTOOLS_DIR: ${{ github.workspace }}/or-tools
-      ORTOOLS_URL: "https://github.com/rte-france/or-tools/releases/download/v9.5-rte2.0/ortools_cxx_windows-latest_static_sirius.zip"
       RUN_EXTENDED_TESTS: ${{ github.event_name == 'schedule'}}
 
     steps:
     - uses: actions/checkout@v3
 
+    - name: Config OR-Tools URL
+      run: |
+          echo "ORTOOLS_URL=https://github.com/rte-france/or-tools/releases/download/$(cat ortools_tag)/ortools_cxx_windows-latest_static_sirius.zip" >> $GITHUB_ENV
+      shell: bash
+
     - name: Pre-requisites
       shell: cmd
       run: |

ortools_tag

@@ -1 +1 @@
-v9.5-rte2.0
+v9.5-rte3.0

src/CMakeLists.txt

@@ -269,7 +269,8 @@ message(STATUS "OR-Tools tag ${ORTOOLS_TAG}")
   set(BUILD_SAMPLES "OFF" CACHE INTERNAL "")
   set(BUILD_FLATZINC "OFF" CACHE INTERNAL "")
   set(BUILD_EXAMPLES "OFF" CACHE INTERNAL "")
-  set(USE_SCIP "OFF" CACHE INTERNAL "")
+  set(USE_SCIP "ON" CACHE INTERNAL "")
+  set(USE_GLPK "ON" CACHE INTERNAL "")
   # We build OR-Tools as a static lib. Cyclic dependencies are detected
   # without this flag.
   set(BUILD_SHARED_LIBS "OFF" CACHE INTERNAL "")

src/solver/optimisation/opt_structure_probleme_a_resoudre.h

@@ -30,6 +30,7 @@
 #include <vector>
 #include <string>
 #include "opt_constants.h"
+#include "ortools/linear_solver/linear_solver.h"
 
 /*--------------------------------------------------------------------------------------*/
 
@@ -117,8 +118,11 @@ struct PROBLEME_ANTARES_A_RESOUDRE
 
     std::vector<bool> VariablesEntieres; // true = int, false = continuous
 
-    std::vector<int> StatutDesVariables;
-    std::vector<int> StatutDesContraintes;
+private:
+  using BasisStatus = operations_research::MPSolver::BasisStatus;
+public:
+    std::vector<BasisStatus> StatutDesVariables;
+    std::vector<BasisStatus> StatutDesContraintes;
 
 };
 

src/solver/utils/include/antares/solver/utils/named_problem.h

@@ -7,19 +7,22 @@
 #include <string>
 #include <algorithm>
 #include <iterator>
+#include "ortools/linear_solver/linear_solver.h"
 
 namespace Antares
 {
 namespace Optimization
 {
 struct PROBLEME_SIMPLEXE_NOMME : public PROBLEME_SIMPLEXE
 {
+private:
+    using BasisStatus = operations_research::MPSolver::BasisStatus;
 public:
     PROBLEME_SIMPLEXE_NOMME(const std::vector<std::string>& NomDesVariables,
                             const std::vector<std::string>& NomDesContraintes,
                             const std::vector<bool>& VariablesEntieres,
-                            std::vector<int>& StatutDesVariables,
-                            std::vector<int>& StatutDesContraintes,
+                            std::vector<BasisStatus>& StatutDesVariables,
+                            std::vector<BasisStatus>& StatutDesContraintes,
                             bool UseNamedProblems,
                             bool SolverLogs);
 
@@ -30,8 +33,8 @@ struct PROBLEME_SIMPLEXE_NOMME : public PROBLEME_SIMPLEXE
     bool solverLogs_;
 
 public:
-    std::vector<int>& StatutDesVariables;
-    std::vector<int>& StatutDesContraintes;
+    std::vector<BasisStatus>& StatutDesVariables;
+    std::vector<BasisStatus>& StatutDesContraintes;
     const std::vector<bool>& VariablesEntieres;
 
     bool isMIP() const;

src/solver/utils/named_problem.cpp

@@ -4,11 +4,13 @@
 namespace Antares::Optimization
 {
 
+using BasisStatus = operations_research::MPSolver::BasisStatus;
+
 PROBLEME_SIMPLEXE_NOMME::PROBLEME_SIMPLEXE_NOMME(const std::vector<std::string>& NomDesVariables,
                                                  const std::vector<std::string>& NomDesContraintes,
                                                  const std::vector<bool>& VariablesEntieres,
-                                                 std::vector<int>& StatutDesVariables,
-                                                 std::vector<int>& StatutDesContraintes,
+                                                 std::vector<BasisStatus>& StatutDesVariables,
+                                                 std::vector<BasisStatus>& StatutDesContraintes,
                                                  bool UseNamedProblems,
                                                  bool SolverLogs) : PROBLEME_SIMPLEXE(),
 

src/solver/utils/ortools_utils.cpp

@@ -288,6 +288,17 @@ MPSolver* ORTOOLS_ConvertIfNeeded(const std::string& solverName,
     }
 }
 
+template<class SourceT>
+static void transferBasis(std::vector<operations_research::MPSolver::BasisStatus>& destination,
+                          const SourceT& source)
+{
+    destination.resize(source.size());
+    for (size_t idx = 0; idx < source.size(); idx++)
+    {
+        destination[idx] = source[idx]->basis_status();
+    }
+}
+
 MPSolver* ORTOOLS_Simplexe(Antares::Optimization::PROBLEME_SIMPLEXE_NOMME* Probleme,
                            MPSolver* solver,
                            bool keepBasis)
@@ -298,7 +309,8 @@ MPSolver* ORTOOLS_Simplexe(Antares::Optimization::PROBLEME_SIMPLEXE_NOMME* Probl
     // Provide an initial simplex basis, if any
     if (warmStart && Probleme->basisExists())
     {
-        solver->SetStartingLpBasisInt(Probleme->StatutDesVariables, Probleme->StatutDesContraintes);
+        solver->SetStartingLpBasis(Probleme->StatutDesVariables,
+                                   Probleme->StatutDesContraintes);
     }
 
     if (solveAndManageStatus(solver, Probleme->ExistenceDUneSolution, params))
@@ -307,8 +319,8 @@ MPSolver* ORTOOLS_Simplexe(Antares::Optimization::PROBLEME_SIMPLEXE_NOMME* Probl
         // Save the final simplex basis for next resolutions
         if (warmStart && keepBasis)
         {
-            solver->GetFinalLpBasisInt(Probleme->StatutDesVariables,
-                                       Probleme->StatutDesContraintes);
+            transferBasis(Probleme->StatutDesVariables, solver->variables());
+            transferBasis(Probleme->StatutDesContraintes, solver->constraints());
         }
     }
 
@@ -373,7 +385,8 @@ const std::map<std::string, struct OrtoolsUtils::SolverNames> OrtoolsUtils::solv
   = {{"xpress", {"xpress_lp", "xpress"}},
      {"sirius", {"sirius_lp", "sirius"}},
      {"coin", {"clp", "cbc"}},
-     {"glpk", {"glpk_lp", "glpk"}}};
+     {"glpk", {"glpk_lp", "glpk"}},
+     {"scip", {"scip", "scip"}}};
 
 std::list<std::string> getAvailableOrtoolsSolverName()
 {