Feature/detect xpress at runtime

.github/workflows/build_windows.yml

@@ -141,5 +141,6 @@ jobs:
         run: |
           set PATH=%PATH%;C:\Program Files\Microsoft MPI\Bin
           set PATH=%PATH%;${{ env.XPRESS }}
+          set XPRESSDIR=${{ env.XPRESSDIR }}
           cd _build
           ctest -C Release --output-on-failure -L "medium|unit|benders|lpnamer"

.github/workflows/windows-vcpkg.yml

@@ -193,6 +193,7 @@ jobs:
         run: |
           set PATH=%PATH%;C:\Program Files\Microsoft MPI\Bin\
           set PATH=%PATH%;${{ env.XPRESS }}
+          set XPRESSDIR=${{ env.XPRESSDIR }}
           cd _build
           ctest -C Release --output-on-failure -L "medium|unit|benders|lpnamer"
 

CMakeLists.txt

@@ -237,31 +237,6 @@ endif()
 
 find_package(jsoncpp CONFIG REQUIRED)
 
-# Third-party solver
-## Xpress
-if(XPRESS)
-	message("XPRESS is ${XPRESS}")
-
-	#Default xpress install dir
-	if (NOT XPRESS_ROOT)
-		if (MSVC)
-			set(XPRESS_ROOT "C:/xpressmp")
-		elseif(UNIX)
-			set(XPRESS_ROOT "/opt/xpressmp")
-		endif()
-	endif()
-
-	find_package(XPRESS REQUIRED)
-
-	# Add solver variables for usage in C++ source code
-	# There are already some variables defined by SOLVER, -DUSE_XPRESS, -DUSE_CBC
-	# But they are exclusive, only one can be set to True
-	# We need to keep COIN-OR at least COIN-OR to True while it is required in lpnamer
-	# and we want to allow compilation with several solvers so that the user can switch 
-	# the solver without any compilation phase.
-	# @TODO : I think those parameters should be merged in a future version
-	add_definitions( -DXPRESS=true )
-endif(XPRESS)
 
 
 ## Coin-OR (Clp and CBC solvers)

src/CMakeLists.txt

@@ -6,9 +6,7 @@ if (COIN_OR)
     SET(AVAILABLE_SOLVER_YML_LIST "${AVAILABLE_SOLVER_YML_LIST}- Cbc\n")
     SET(AVAILABLE_SOLVER_YML_LIST "${AVAILABLE_SOLVER_YML_LIST}- Coin\n")
 endif()
-if (XPRESS)
     SET(AVAILABLE_SOLVER_YML_LIST "${AVAILABLE_SOLVER_YML_LIST}- Xpress\n")
-endif()
 
 
 #configure file to define antares-solver executable

src/cpp/lpnamer/main/RunProblemGeneration.cpp

@@ -1,13 +1,11 @@
 
 #include "RunProblemGeneration.h"
 
-#include <boost/archive/text_iarchive.hpp>
 #include <execution>
 #include <iostream>
 
 #include "ActiveLinks.h"
 #include "AdditionalConstraints.h"
-#include "Clock.h"
 #include "GeneralDataReader.h"
 #include "LauncherHelpers.h"
 #include "LinkProblemsGenerator.h"
@@ -17,14 +15,12 @@
 #include "MasterGeneration.h"
 #include "MasterProblemBuilder.h"
 #include "MpsTxtWriter.h"
-#include "ProblemGenerationExeOptions.h"
 #include "ProblemVariablesFromProblemAdapter.h"
 #include "ProblemVariablesZipAdapter.h"
 #include "StringManip.h"
 #include "Timer.h"
 #include "WeightsFileReader.h"
 #include "WeightsFileWriter.h"
-#include "XpansionProblemsFromAntaresProvider.h"
 #include "ZipProblemsProviderAdapter.h"
 #include "config.h"
 
@@ -59,6 +55,7 @@ struct Version {
   int major;
   int minor;
 };
+
 std::shared_ptr<ArchiveReader> InstantiateZipReader(
     const std::filesystem::path& antares_archive_path);
 void ProcessWeights(
@@ -128,6 +125,7 @@ std::vector<std::shared_ptr<Problem>> getXpansionProblems(
                                                               problem_names);
   return adapter->provideProblems(solver_name, solver_log_manager);
 }
+
 void RunProblemGeneration(
     const std::filesystem::path& xpansion_output_dir,
     const std::string& master_formulation,
@@ -169,14 +167,10 @@ void RunProblemGeneration(
   auto files_mapper = FilesMapper(antares_archive_path);
   auto mpsList = files_mapper.MpsAndVariablesFilesVect();
 
-  bool use_zip_implementation = true;
-  bool use_file_implementation = false;
-
   auto solver_log_manager = SolverLogManager(log_file_path);
   Couplings couplings;
   LinkProblemsGenerator linkProblemsGenerator(
       lpDir_, links, solver_name, logger, solver_log_manager, rename_problems);
-  if (use_zip_implementation) {
     std::shared_ptr<ArchiveReader> reader =
         InstantiateZipReader(antares_archive_path);
 
@@ -185,79 +179,33 @@ void RunProblemGeneration(
         getXpansionProblems(solver_log_manager, solver_name, mpsList, lpDir_,
                             reader);
 
-    std::vector<std::pair<std::shared_ptr<Problem>, ProblemData>>
-        problems_and_data;
-    for (int i = 0; i < xpansion_problems.size(); ++i) {
-      xpansion_problems.at(i)->_name = mpsList.at(i)._problem_mps;
-      problems_and_data.emplace_back(xpansion_problems.at(i), mpsList.at(i));
-    }
-    auto mps_file_writer = std::make_shared<MPSFileWriter>(lpDir_);
-    std::for_each(
-        std::execution::par, problems_and_data.begin(), problems_and_data.end(),
-        [&](const auto& problem_and_data) {
-          const auto& [problem, data] = problem_and_data;
-          std::shared_ptr<IProblemVariablesProviderPort> variables_provider;
-          if (rename_problems) {
-            variables_provider = std::make_shared<ProblemVariablesZipAdapter>(
-                reader, data, links, logger);
-          } else {
-            variables_provider =
-                std::make_shared<ProblemVariablesFromProblemAdapter>(
-                    problem, links, logger);
-          }
-          linkProblemsGenerator.treat(data._problem_mps, couplings, problem.get(),
-                                      variables_provider.get(), mps_file_writer.get());
-        });
-
-    reader->Close();
-    reader->Delete();
-  } else if (use_file_implementation) {
-    /* Main stuff */
-    auto mps_file_writer = std::make_shared<MPSFileWriter>(lpDir_);
-    linkProblemsGenerator.treatloop(xpansion_output_dir, couplings, mpsList,
+  std::vector<std::pair<std::shared_ptr<Problem>, ProblemData>>
+      problems_and_data;
+  for (int i = 0; i < xpansion_problems.size(); ++i) {
+    xpansion_problems.at(i)->_name = mpsList.at(i)._problem_mps;
+    problems_and_data.emplace_back(xpansion_problems.at(i), mpsList.at(i));
+  }
+  auto mps_file_writer = std::make_shared<MPSFileWriter>(lpDir_);
+  std::for_each(
+      std::execution::par, problems_and_data.begin(), problems_and_data.end(),
+      [&](const auto& problem_and_data) {
+        const auto& [problem, data] = problem_and_data;
+        std::shared_ptr<IProblemVariablesProviderPort> variables_provider;
+        if (rename_problems) {
+          variables_provider = std::make_shared<ProblemVariablesZipAdapter>(
+              reader, data, links, logger);
+        } else {
+          variables_provider =
+              std::make_shared<ProblemVariablesFromProblemAdapter>(
+                  problem, links, logger);
+        }
+        linkProblemsGenerator.treat(data._problem_mps, couplings, problem.get(),
+                                    variables_provider.get(),
                                     mps_file_writer.get());
-  } else {
-    std::filesystem::path path =
-        xpansion_output_dir.parent_path().parent_path() /
-        "fichierDeSerialisation";
-    std::ifstream ifs(xpansion_output_dir.parent_path().parent_path() /
-                      "fichierDeSerialisation");
-    boost::archive::text_iarchive ia(ifs);
-
-    LpsFromAntares lps;
-    ia >> lps;
-    lps._constant->Mdeb.push_back(lps._constant->NombreDeCoefficients);
-
-    XpansionProblemsFromAntaresProvider adapter(lps);
-    auto xpansion_problems =
-        adapter.provideProblems(solver_name, solver_log_manager);
-    std::vector<std::pair<std::shared_ptr<Problem>, ProblemData>>
-        problems_and_data;
-    for (int i = 0; i < xpansion_problems.size(); ++i) {
-      xpansion_problems.at(i)->_name = mpsList.at(i)._problem_mps;
-      problems_and_data.emplace_back(xpansion_problems.at(i), mpsList.at(i));
-    }
-
-    auto reader = InstantiateZipReader(antares_archive_path);
-    auto mps_file_writer = std::make_shared<MPSFileWriter>(lpDir_);
+      });
 
-    std::for_each(
-        std::execution::par, problems_and_data.begin(), problems_and_data.end(),
-        [&](const auto& problem_and_data) {
-          const auto& [problem, data] = problem_and_data;
-          std::shared_ptr<IProblemVariablesProviderPort> variables_provider;
-          if (rename_problems) {
-            variables_provider = std::make_shared<ProblemVariablesZipAdapter>(
-                reader, data, links, logger);
-          } else {
-            variables_provider =
-                std::make_shared<ProblemVariablesFromProblemAdapter>(
-                    problem, links, logger);
-          }
-          linkProblemsGenerator.treat(data._problem_mps, couplings, problem.get(),
-                                      variables_provider.get(), mps_file_writer.get());
-        });
-  }
+  reader->Close();
+  reader->Delete();
 
   MasterGeneration master_generation(
       xpansion_output_dir, links, additionalConstraints, couplings,

src/cpp/multisolver_interface/CMakeLists.txt

@@ -17,12 +17,14 @@ list(APPEND Solver_sources
 	${CMAKE_CURRENT_LIST_DIR}/SolverFactory.cpp
 )
 
+list(APPEND XPRESS_LOAD
+	${CMAKE_CURRENT_LIST_DIR}/environment.cc
+)
+
 # XPRESS
-IF( XPRESS )
 	list(APPEND Solver_sources
 		${CMAKE_CURRENT_LIST_DIR}/SolverXpress.cpp
 	)
-ENDIF( XPRESS )
 
 #Clp - CBc
 IF(COIN_OR)
@@ -39,6 +41,7 @@ ENDIF(COIN_OR)
 # ---------------------------------------------------------------------------
 add_library (solvers STATIC
 	${Solver_sources}
+	${XPRESS_LOAD}
 )
 get_target_property(xpansion_interfaces_path xpansion_interfaces INTERFACE_INCLUDE_DIRECTORIES)
 target_include_directories (solvers
@@ -51,13 +54,6 @@ target_include_directories (solvers
 )
 
 
-# XPRESS
-if(XPRESS)
-	target_link_libraries (solvers
-		PUBLIC
-			XPRESS::XPRESS
-	)
-endif()
 
 #CLP-CBC
 if(COIN_OR)
@@ -68,5 +64,6 @@ if(COIN_OR)
 			Coin::CoinUtils
 			Coin::Osi
 			Coin::Cbc
+		   ${CMAKE_DL_LIBS}
 	)
 endif()

src/cpp/multisolver_interface/SolverFactory.cpp

@@ -1,34 +1,44 @@
-#ifdef XPRESS
+
 #include "SolverXpress.h"
-#endif
+#include "multisolver_interface/environment.h"
+
 #ifdef COIN_OR
 #include "SolverCbc.h"
 #include "SolverClp.h"
 #endif
 #include "LogUtils.h"
 #include "multisolver_interface/SolverFactory.h"
+std::vector<std::string> available_solvers;
 
-SolverFactory::SolverFactory() {
-  _available_solvers.clear();
-#ifdef XPRESS
-  _available_solvers.push_back(XPRESS_STR);
-#endif
+std::vector<std::string> SolverLoader::GetAvailableSolvers() {
+  if (available_solvers.empty()) {
+    if (LoadXpress::XpressIsCorrectlyInstalled()) {
+      available_solvers.push_back(XPRESS_STR);
+    }
 #ifdef COIN_OR
-  _available_solvers.push_back(CLP_STR);
-  _available_solvers.push_back(CBC_STR);
+    available_solvers.push_back(CLP_STR);
+    available_solvers.push_back(CBC_STR);
 #endif
+  }
+  return available_solvers;
+}
+
+SolverFactory::SolverFactory()
+    : _available_solvers(SolverLoader::GetAvailableSolvers()) {
+  isXpress_available_ =
+      std::find(available_solvers.cbegin(), available_solvers.cend(),
+                XPRESS_STR) != available_solvers.cend();
 }
 
 SolverAbstract::Ptr SolverFactory::create_solver(
     const std::string &solver_name, const SOLVER_TYPE solver_type) const {
   if (solver_name == "") {
     throw InvalidSolverNameException(solver_name, LOGLOCATION);
   }
-#ifdef XPRESS
-  else if (solver_name == XPRESS_STR) {
+
+  else if (isXpress_available_ && solver_name == XPRESS_STR) {
     return std::make_shared<SolverXpress>();
   }
-#endif
 #ifdef COIN_OR
   if (solver_name == COIN_STR && solver_type == SOLVER_TYPE::CONTINUOUS) {
     return std::make_shared<SolverClp>();
@@ -58,12 +68,9 @@ SolverAbstract::Ptr SolverFactory::create_solver(
     const std::string &solver_name) const {
   if (solver_name == "") {
     throw InvalidSolverNameException(solver_name, LOGLOCATION);
-  }
-#ifdef XPRESS
-  else if (solver_name == XPRESS_STR) {
+  } else if (isXpress_available_ && solver_name == XPRESS_STR) {
     return std::make_shared<SolverXpress>();
   }
-#endif
 #ifdef COIN_OR
   else if (solver_name == CLP_STR) {
     return std::make_shared<SolverClp>();
@@ -81,11 +88,9 @@ SolverAbstract::Ptr SolverFactory::create_solver(
   if (solver_name == "") {
     throw InvalidSolverNameException(solver_name, LOGLOCATION);
   }
-#ifdef XPRESS
-  else if (solver_name == XPRESS_STR) {
+  if (isXpress_available_ && solver_name == XPRESS_STR) {
     return std::make_shared<SolverXpress>(log_manager);
   }
-#endif
 #ifdef COIN_OR
   else if (solver_name == CLP_STR) {
     return std::make_shared<SolverClp>(log_manager);
@@ -105,11 +110,9 @@ SolverAbstract::Ptr SolverFactory::copy_solver(
   if (solver_name == "") {
     throw InvalidSolverNameException(solver_name, LOGLOCATION);
   }
-#ifdef XPRESS
-  else if (solver_name == XPRESS_STR) {
+  if (isXpress_available_ && solver_name == XPRESS_STR) {
     return std::make_shared<SolverXpress>(to_copy);
   }
-#endif
 #ifdef COIN_OR
   else if (solver_name == CLP_STR) {
     return std::make_shared<SolverClp>(to_copy);

src/cpp/multisolver_interface/SolverXpress.cpp

@@ -6,6 +6,8 @@
 
 #include "StringManip.h"
 
+using namespace LoadXpress;
+
 /*************************************************************************************************
 -----------------------------------    Constructor/Desctructor
 --------------------------------
@@ -25,6 +27,7 @@ SolverXpress::SolverXpress() {
   std::lock_guard<std::mutex> guard(license_guard);
   int status = 0;
   if (_NumberOfProblems == 0) {
+    initXpressEnv();
     status = XPRSinit(NULL);
     zero_status_check(status, "initialize XPRESS environment", LOGLOCATION);
   }

src/cpp/multisolver_interface/SolverXpress.h

@@ -4,7 +4,7 @@
 #include <mutex>
 
 #include "multisolver_interface/SolverAbstract.h"
-#include "xprs.h"
+#include "multisolver_interface/environment.h"
 
 /*!
  * \class class SolverXpress