Merge pull request #2289 from ERGO-Code/features-doc-mods

Features doc mods

Author: jajhall

FEATURES.md

@@ -7,3 +7,12 @@ Fixed incorrect assertion in `HighsMipSolver::solutionFeasible()` (fixing [#2204
 getColIntegrality now returns `HighsVarType::kContinuous` when `model_.lp_.integrality_` is empty (fixing [#2261](https://github.com/ERGO-Code/HiGHS/issues/2261))
 
 Now ensuring that when solving a scaled LP with useful but unvalidated basis, it does not lose its scaling after validation, since the scaling factors will be applied to the solution (fixing [#2267](https://github.com/ERGO-Code/HiGHS/issues/2267))
+
+By setting non-empty values of options `read_solution_file`, `read_basis_file`, `write_model_file` (with extension `.lp` or `.mps`), `write_solution_file`, `solution_file`, `write_basis_file`, these files will be read or written when calling `Highs::run()`. Hence options previously only available via the command line interface can be use (for example) by modelling languages that only call `Highs::run()` (fixing [#2269](https://github.com/ERGO-Code/HiGHS/issues/2269)).
+
+Bug [#2273](https://github.com/ERGO-Code/HiGHS/issues/2273)) fixed
+
+As part of [#2286](https://github.com/ERGO-Code/HiGHS/pull/2286)), the root of the HiGHS source files is now `highs/`, rather than `src/`
+
+ZI rounding and shifting MIP primal heuristics have been added (see [#2287](https://github.com/ERGO-Code/HiGHS/pull/2287)). They are off by default, but can be activated by setting the options `mip_heuristic_run_zi_round` and `mip_heuristic_run_shifting` to be true. Options `mip_heuristic_run_rins`, `mip_heuristic_run_rens` and `mip_heuristic_run_root_reduced_cost` to run the RINS, RENS and rootReducedCost heuristics have been added. These are true by default, but setting them to be false can accelerate the MIP solver on easy problems.
+

check/TestBasis.cpp

@@ -5,14 +5,19 @@
 #include "catch.hpp"
 
 const bool dev_run = false;
-const std::string basis_file = "adlittle.bas";
 HighsBasis basis_data;
 
-void testBasisReloadModel(Highs& highs, const bool from_file);
-void testBasisRestart(Highs& highs, const bool from_file);
+void testBasisReloadModel(Highs& highs, const std::string& basis_file,
+                          const bool from_file);
+void testBasisRestart(Highs& highs, const std::string& basis_file,
+                      const bool from_file);
 
 // No commas in test case name.
 TEST_CASE("Basis-file", "[highs_basis_file]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  const std::string basis_file = test_name + ".bas";
+  const std::string invalid_basis_file = test_name + "-Invalid.bas";
+
   HighsStatus return_status;
   std::string model0_file =
       std::string(HIGHS_DIR) + "/check/instances/adlittle.mps";
@@ -38,7 +43,6 @@ TEST_CASE("Basis-file", "[highs_basis_file]") {
   REQUIRE(return_status == HighsStatus::kError);
 
   // Check error return for some invalid basis files
-  std::string invalid_basis_file = "InvalidBasis.bas";
   std::ofstream f;
   // Write and read a file for unsupported HiGHS version
   f.open(invalid_basis_file, std::ios::out);
@@ -64,14 +68,16 @@ TEST_CASE("Basis-file", "[highs_basis_file]") {
   return_status = highs.readBasis(invalid_basis_file);
   REQUIRE(return_status == HighsStatus::kError);
 
-  testBasisRestart(highs, true);
-  testBasisReloadModel(highs, true);
+  testBasisRestart(highs, basis_file, true);
+  testBasisReloadModel(highs, basis_file, true);
 
   std::remove(basis_file.c_str());
   std::remove(invalid_basis_file.c_str());
 }
 
 TEST_CASE("Basis-data", "[highs_basis_data]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  const std::string basis_file = test_name + "adlittle.bas";
   HighsStatus return_status;
   std::string model0_file =
       std::string(HIGHS_DIR) + "/check/instances/adlittle.mps";
@@ -93,8 +99,8 @@ TEST_CASE("Basis-data", "[highs_basis_data]") {
   basis_data = highs.getBasis();
   REQUIRE(return_status == HighsStatus::kOk);
 
-  testBasisRestart(highs, false);
-  testBasisReloadModel(highs, false);
+  testBasisRestart(highs, basis_file, false);
+  testBasisReloadModel(highs, basis_file, false);
 }
 
 TEST_CASE("set-pathological-basis", "[highs_basis_data]") {
@@ -179,7 +185,8 @@ TEST_CASE("Basis-singular", "[highs_basis_data]") {
 }
 
 // No commas in test case name.
-void testBasisReloadModel(Highs& highs, const bool from_file) {
+void testBasisReloadModel(Highs& highs, const std::string& basis_file,
+                          const bool from_file) {
   // Checks that no simplex iterations are required if a saved optimal
   // basis is used for the original LP after solving a different LP
   HighsStatus return_status;
@@ -227,7 +234,8 @@ void testBasisReloadModel(Highs& highs, const bool from_file) {
   REQUIRE(highs.getInfo().simplex_iteration_count == 0);
 }
 
-void testBasisRestart(Highs& highs, const bool from_file) {
+void testBasisRestart(Highs& highs, const std::string& basis_file,
+                      const bool from_file) {
   // Checks that no simplex iterations are required if a saved optimal
   // basis is used for the original LP after changing a bound, solving
   // - so that the internal basis changes - and then restoring the

check/TestCheckSolution.cpp

@@ -8,13 +8,15 @@
 
 const bool dev_run = false;
 
-void runWriteReadCheckSolution(Highs& highs, const std::string model,
+void runWriteReadCheckSolution(Highs& highs, const std::string& test_name,
+                               const std::string& model,
                                const HighsModelStatus require_model_status,
                                const HighsInt write_solution_style);
 
 void runSetLpSolution(const std::string model);
 
 TEST_CASE("check-solution", "[highs_check_solution]") {
+  std::string test_name = Catch::getResultCapture().getCurrentTestName();
   std::string model = "";
   std::string model_file;
   HighsStatus read_status;
@@ -42,7 +44,8 @@ TEST_CASE("check-solution", "[highs_check_solution]") {
     REQUIRE(read_status == require_read_status);
 
     require_model_status = HighsModelStatus::kOptimal;
-    runWriteReadCheckSolution(highs, model, require_model_status,
+    test_name += "-";
+    runWriteReadCheckSolution(highs, test_name, model, require_model_status,
                               write_solution_style);
     SpecialLps special_lps;
     HighsLp lp;
@@ -51,21 +54,24 @@ TEST_CASE("check-solution", "[highs_check_solution]") {
     model = "distillation";
     special_lps.distillationMip(lp, require_model_status, optimal_objective);
     highs.passModel(lp);
-    runWriteReadCheckSolution(highs, model, require_model_status,
+    test_name += "-";
+    runWriteReadCheckSolution(highs, test_name, model, require_model_status,
                               write_solution_style);
 
     lp.clear();
     model = "primalDualInfeasible1Lp";
     special_lps.primalDualInfeasible1Lp(lp, require_model_status);
     highs.passModel(lp);
-    runWriteReadCheckSolution(highs, model, require_model_status,
+    test_name += "-";
+    runWriteReadCheckSolution(highs, test_name, model, require_model_status,
                               write_solution_style);
     // Second pass uses sparse format
     write_solution_style = kSolutionStyleSparse;
   }
 }
 
 TEST_CASE("check-set-mip-solution", "[highs_check_solution]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
   HighsStatus return_status;
   const std::string model = "flugpl";
   std::string model_file =
@@ -83,7 +89,7 @@ TEST_CASE("check-set-mip-solution", "[highs_check_solution]") {
   HighsInt scratch_num_nodes = info.mip_node_count;
   if (dev_run) printf("Num nodes = %d\n", int(scratch_num_nodes));
 
-  std::string solution_file = model + ".sol";
+  std::string solution_file = test_name + model + ".sol";
   if (dev_run) return_status = highs.writeSolution("");
   return_status = highs.writeSolution(solution_file);
   REQUIRE(return_status == HighsStatus::kOk);
@@ -354,8 +360,9 @@ TEST_CASE("check-set-rowwise-lp-solution", "[highs_check_solution]") {
 }
 
 TEST_CASE("check-set-mip-solution-extra-row", "[highs_check_solution]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  const std::string solution_file_name = test_name + ".sol";
   Highs highs;
-  const std::string solution_file_name = "temp.sol";
   highs.setOptionValue("output_flag", dev_run);
   highs.addVar(0, 2);
   highs.addVar(0, 2);
@@ -396,6 +403,7 @@ TEST_CASE("check-set-illegal-solution", "[highs_check_solution]") {
 }
 
 TEST_CASE("read-miplib-solution", "[highs_check_solution]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
   HighsLp lp;
   lp.num_col_ = 5;
   lp.num_row_ = 1;
@@ -417,7 +425,7 @@ TEST_CASE("read-miplib-solution", "[highs_check_solution]") {
   REQUIRE(h.run() == HighsStatus::kOk);
   //  REQUIRE(h.writeSolution("", kSolutionStylePretty) == HighsStatus::kOk);
   const std::vector<double>& col_value = h.getSolution().col_value;
-  std::string miplib_sol_file = "miplib.sol";
+  std::string miplib_sol_file = test_name + ".sol";
   FILE* file = fopen(miplib_sol_file.c_str(), "w");
   REQUIRE(file != 0);
   fprintf(file, "=obj= 22\n");
@@ -441,7 +449,8 @@ TEST_CASE("read-miplib-solution", "[highs_check_solution]") {
   std::remove(miplib_sol_file.c_str());
 }
 
-void runWriteReadCheckSolution(Highs& highs, const std::string model,
+void runWriteReadCheckSolution(Highs& highs, const std::string& test_name,
+                               const std::string& model,
                                const HighsModelStatus require_model_status,
                                const HighsInt write_solution_style) {
   HighsStatus run_status;
@@ -455,7 +464,7 @@ void runWriteReadCheckSolution(Highs& highs, const std::string model,
   status = highs.getModelStatus();
   REQUIRE(status == require_model_status);
 
-  solution_file = model + ".sol";
+  solution_file = test_name + model + ".sol";
   if (dev_run)
     printf("Writing solution in style %d to %s\n", int(write_solution_style),
            solution_file.c_str());

check/TestFilereader.cpp

@@ -199,6 +199,7 @@ TEST_CASE("filereader-free-format-parser-lp", "[highs_filereader]") {
 
 // No commas in test case name.
 TEST_CASE("filereader-read-mps-ems-lp", "[highs_filereader]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
   std::string filename;
   filename = std::string(HIGHS_DIR) + "/check/instances/adlittle.mps";
 
@@ -212,14 +213,14 @@ TEST_CASE("filereader-read-mps-ems-lp", "[highs_filereader]") {
   HighsLp lp_mps = highs.getLp();
 
   // Write lp
-  std::string filename_lp = "adlittle.lp";
+  std::string filename_lp = test_name + ".lp";
   status = highs.writeModel(filename_lp);
   REQUIRE(status == HighsStatus::kOk);
 
   /*
   bool are_the_same;
   // Write ems
-  std::string filename_ems = "adlittle.ems";
+  std::string filename_ems = test_name + ".ems";
   status = highs.writeModel(filename_ems);
   REQUIRE(status == HighsStatus::kOk);
 
@@ -357,9 +358,10 @@ TEST_CASE("filereader-dD2e", "[highs_filereader]") {
 // }
 
 TEST_CASE("writeLocalModel", "[highs_filereader]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  std::string write_model_file = test_name + ".mps";
   Highs h;
   h.setOptionValue("output_flag", dev_run);
-  std::string write_model_file = "foo.mps";
   HighsModel model;
   HighsLp& lp = model.lp_;
   ;
@@ -415,7 +417,8 @@ TEST_CASE("writeLocalModel", "[highs_filereader]") {
 }
 
 TEST_CASE("write-MI-bound-model", "[highs_filereader]") {
-  std::string write_model_file = "temp.mps";
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  std::string write_model_file = test_name + ".mps";
   Highs h;
   h.setOptionValue("output_flag", dev_run);
   h.addCol(1, -kHighsInf, 1, 0, nullptr, nullptr);

check/TestInfo.cpp

@@ -9,6 +9,8 @@
 const bool dev_run = false;
 
 TEST_CASE("highs-info", "[highs_info]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  const std::string highs_info_file = test_name + ".info";
   std::string filename;
   filename = std::string(HIGHS_DIR) + "/check/instances/avgas.mps";
   filename = std::string(HIGHS_DIR) + "/check/instances/adlittle.mps";
@@ -62,7 +64,6 @@ TEST_CASE("highs-info", "[highs_info]") {
     REQUIRE(return_status == HighsStatus::kOk);
   }
 
-  std::string highs_info_file = "Highs.info";
   return_status = highs.writeInfo(highs_info_file);
   REQUIRE(return_status == HighsStatus::kOk);
 

check/TestLogging.cpp

@@ -7,14 +7,14 @@
 const bool dev_run = false;
 
 TEST_CASE("logging", "[highs_logging]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  const std::string log_file = test_name + ".log";
   std::string model;
   std::string model_file;
-  std::string log_file;
   HighsStatus return_status;
 
   model = "avgas";
   model_file = std::string(HIGHS_DIR) + "/check/instances/" + model + ".mps";
-  log_file = "temp.log";
 
   Highs highs;
   if (!dev_run) highs.setOptionValue("output_flag", false);

check/TestLpSolvers.cpp

@@ -406,10 +406,11 @@ bool fileExists(const std::string& file_name) {
 }
 
 TEST_CASE("highs-files-lp", "[highs_lp_solver]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  const std::string write_solution_file = test_name + ".sol";
+  const std::string write_basis_file = test_name + ".bas";
+  const std::string write_model_file = test_name + ".mps";
   Highs h;
-  std::string write_solution_file = "lp-temp.sol";
-  std::string write_basis_file = "lp-temp.bas";
-  std::string write_model_file = "lp-temp.mps";
   h.setOptionValue("output_flag", dev_run);
   std::string model_file =
       std::string(HIGHS_DIR) + "/check/instances/avgas.mps";
@@ -443,10 +444,11 @@ TEST_CASE("highs-files-lp", "[highs_lp_solver]") {
 }
 
 TEST_CASE("highs-files-mip", "[highs_lp_solver]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  const std::string write_solution_file = test_name + ".sol";
+  const std::string write_basis_file = test_name + ".bas";
+  const std::string write_model_file = test_name + ".mps";
   Highs h;
-  std::string write_solution_file = "mip-temp.sol";
-  std::string write_basis_file = "mip-temp.bas";
-  std::string write_model_file = "mip-temp.mps";
   h.setOptionValue("output_flag", dev_run);
   std::string model_file =
       std::string(HIGHS_DIR) + "/check/instances/flugpl.mps";

check/TestMipSolver.cpp

@@ -509,6 +509,8 @@ TEST_CASE("MIP-infeasible-start", "[highs_test_mip_solver]") {
 TEST_CASE("get-integrality", "[highs_test_mip_solver]") {}
 
 TEST_CASE("MIP-bounds", "[highs_test_mip_solver]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  const std::string test_mps = test_name + ".mps";
   // Introduced due to #1325 observing that LI and UI are needed
   HighsLp lp;
   lp.num_col_ = 6;
@@ -536,7 +538,6 @@ TEST_CASE("MIP-bounds", "[highs_test_mip_solver]") {
   const double obj0 = highs.getObjectiveValue();
   if (dev_run) printf("Optimum at first run: %g\n", obj0);
   // now write out to MPS and load again
-  const std::string test_mps = "test.mps";
   highs.writeModel(test_mps);
   highs.readModel(test_mps);
   highs.run();
@@ -549,8 +550,9 @@ TEST_CASE("MIP-bounds", "[highs_test_mip_solver]") {
 }
 
 TEST_CASE("MIP-get-saved-solutions", "[highs_test_mip_solver]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  const std::string solution_file = test_name + ".sol";
   const std::string model = "flugpl";
-  const std::string solution_file = "MipImproving.sol";
   const std::string model_file =
       std::string(HIGHS_DIR) + "/check/instances/" + model + ".mps";
   Highs highs;
@@ -617,7 +619,8 @@ TEST_CASE("MIP-max-offset-test", "[highs_test_mip_solver]") {
 }
 
 TEST_CASE("MIP-get-saved-solutions-presolve", "[highs_test_mip_solver]") {
-  const std::string solution_file = "MipImproving.sol";
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  const std::string solution_file = test_name + ".sol";
   Highs highs;
   highs.setOptionValue("output_flag", dev_run);
   highs.setOptionValue("mip_improving_solution_save", true);
@@ -835,14 +838,13 @@ TEST_CASE("issue-2204", "[highs_test_mip_solver]") {
 }
 
 TEST_CASE("ZI Round and Shifting Heuristics", "[highs_test_mip_solver]") {
-  std::string model_file =
-      std::string(HIGHS_DIR) + "/check/instances/rgn.mps";
+  std::string model_file = std::string(HIGHS_DIR) + "/check/instances/rgn.mps";
 
   Highs highs;
   highs.setOptionValue("output_flag", dev_run);
   // Enable both heuristics
   highs.setOptionValue("mip_heuristic_run_zi_round", true);
-  highs.setOptionValue("mip_heuristic_run_shifting", true);  
+  highs.setOptionValue("mip_heuristic_run_shifting", true);
   highs.readModel(model_file);
   const HighsModelStatus require_model_status = HighsModelStatus::kOptimal;
   const double optimal_objective = 82.19999924;

check/TestNames.cpp

@@ -6,6 +6,8 @@
 
 const bool dev_run = false;
 TEST_CASE("highs-names", "[highs_names]") {
+  const std::string test_name = Catch::getResultCapture().getCurrentTestName();
+  const std::string solution_file = test_name + ".sol";
   std::string name;
   const std::string model = "avgas";
   const std::string model_file =
@@ -109,7 +111,6 @@ TEST_CASE("highs-names", "[highs_names]") {
   local_lp.col_names_.clear();
   local_lp.row_names_.clear();
   highs.passModel(local_lp);
-  const std::string solution_file = "temp.sol";
   REQUIRE(highs.writeSolution(solution_file, 1) == HighsStatus::kOk);
 
   // Cannot get name of column or row 0