Merge pull request #3095 from ERGO-Code/pr-2988-latest

PR 2988 with latest merged in

Author: galabovaa

check/TestLpSolvers.cpp

@@ -553,3 +553,32 @@ TEST_CASE("choose-lp-solver", "[highs_lp_solver]") {
 
   h.resetGlobalScheduler(true);
 }
+
+TEST_CASE("releaseMemory", "[highs_lp_solver]") {
+  std::string model_file =
+      std::string(HIGHS_DIR) + "/check/instances/avgas.mps";
+  Highs h;
+  h.setOptionValue("output_flag", dev_run);
+
+  // First solve
+  REQUIRE(h.readModel(model_file) == HighsStatus::kOk);
+  REQUIRE(h.run() == HighsStatus::kOk);
+  REQUIRE(h.getModelStatus() == HighsModelStatus::kOptimal);
+  double first_objective = h.getInfo().objective_function_value;
+
+  // Release memory and verify we can solve again
+  REQUIRE(h.releaseMemory() == HighsStatus::kOk);
+
+  // Second solve on a different model
+  std::string model_file2 =
+      std::string(HIGHS_DIR) + "/check/instances/adlittle.mps";
+  REQUIRE(h.readModel(model_file2) == HighsStatus::kOk);
+  REQUIRE(h.run() == HighsStatus::kOk);
+  REQUIRE(h.getModelStatus() == HighsModelStatus::kOptimal);
+  double second_objective = h.getInfo().objective_function_value;
+
+  // Verify objectives are different (different problems)
+  REQUIRE(first_objective != second_objective);
+
+  h.resetGlobalScheduler(true);
+}

highs/Highs.h

@@ -95,6 +95,16 @@ class Highs {
    */
   HighsStatus clearSolverDualData();
 
+  /**
+   * @brief Release all retained memory back to the allocator
+   *
+   * Clears all solver state and shrinks internal vectors to free
+   * unused capacity. Useful in long-running services that reuse a
+   * Highs instance across multiple solves to prevent unbounded RSS
+   * growth from heap fragmentation.
+   */
+  HighsStatus releaseMemory();
+
   /**
    * Methods for model input
    */

highs/interfaces/highs_c_api.cpp

@@ -379,6 +379,10 @@ HighsInt Highs_clearSolver(void* highs) {
   return (HighsInt)((Highs*)highs)->clearSolver();
 }
 
+HighsInt Highs_releaseMemory(void* highs) {
+  return (HighsInt)((Highs*)highs)->releaseMemory();
+}
+
 HighsInt Highs_setBoolOptionValue(void* highs, const char* option,
                                   const HighsInt value) {
   return (HighsInt)((Highs*)highs)

highs/interfaces/highs_c_api.h

@@ -395,6 +395,20 @@ HighsInt Highs_clearModel(void* highs);
  */
 HighsInt Highs_clearSolver(void* highs);
 
+/**
+ * Release all retained memory back to the allocator.
+ *
+ * Clears all solver state and shrinks internal vectors to free unused
+ * capacity. Useful in long-running services that reuse a Highs instance
+ * across multiple solves to prevent unbounded RSS growth from heap
+ * fragmentation.
+ *
+ * @param highs     A pointer to the Highs instance.
+ *
+ * @returns A `kHighsStatus` constant indicating whether the call succeeded.
+ */
+HighsInt Highs_releaseMemory(void* highs);
+
 /**
  * Presolve a model.
  *

highs/lp_data/Highs.cpp

@@ -63,13 +63,15 @@ HighsStatus Highs::clear() {
 HighsStatus Highs::clearModel() {
   model_.clear();
   multi_linear_objective_.clear();
+  saved_objective_and_solution_.clear();
   return clearSolver();
 }
 
 HighsStatus Highs::clearSolver() {
   HighsStatus return_status = HighsStatus::kOk;
   clearDerivedModelProperties();
   invalidateSolverData();
+  ekk_instance_.clear();
   return returnFromHighs(return_status);
 }
 
@@ -80,6 +82,61 @@ HighsStatus Highs::clearSolverDualData() {
   return returnFromHighs(return_status);
 }
 
+HighsStatus Highs::releaseMemory() {
+  HighsStatus return_status = HighsStatus::kOk;
+  // 1. Clear all model and solver state (same as clear()).
+  clearModel();
+
+  // 2. Clear and shrink vectors that clearModel/clearSolver only
+  //    invalidate or leave with residual capacity.  After this block the
+  //    instance holds zero allocated heap memory for solver state —
+  //    equivalent to a freshly constructed Highs.
+  saved_objective_and_solution_.shrink_to_fit();
+  solution_.clear();
+  solution_.col_value.shrink_to_fit();
+  solution_.col_dual.shrink_to_fit();
+  solution_.row_value.shrink_to_fit();
+  solution_.row_dual.shrink_to_fit();
+  basis_.clear();
+  basis_.col_status.shrink_to_fit();
+  basis_.row_status.shrink_to_fit();
+  ranging_.clear();
+  ranging_.col_cost_up.value_.shrink_to_fit();
+  ranging_.col_cost_up.objective_.shrink_to_fit();
+  ranging_.col_cost_up.in_var_.shrink_to_fit();
+  ranging_.col_cost_up.ou_var_.shrink_to_fit();
+  ranging_.col_cost_dn.value_.shrink_to_fit();
+  ranging_.col_cost_dn.objective_.shrink_to_fit();
+  ranging_.col_cost_dn.in_var_.shrink_to_fit();
+  ranging_.col_cost_dn.ou_var_.shrink_to_fit();
+  ranging_.col_bound_up.value_.shrink_to_fit();
+  ranging_.col_bound_up.objective_.shrink_to_fit();
+  ranging_.col_bound_up.in_var_.shrink_to_fit();
+  ranging_.col_bound_up.ou_var_.shrink_to_fit();
+  ranging_.col_bound_dn.value_.shrink_to_fit();
+  ranging_.col_bound_dn.objective_.shrink_to_fit();
+  ranging_.col_bound_dn.in_var_.shrink_to_fit();
+  ranging_.col_bound_dn.ou_var_.shrink_to_fit();
+  ranging_.row_bound_up.value_.shrink_to_fit();
+  ranging_.row_bound_up.objective_.shrink_to_fit();
+  ranging_.row_bound_up.in_var_.shrink_to_fit();
+  ranging_.row_bound_up.ou_var_.shrink_to_fit();
+  ranging_.row_bound_dn.value_.shrink_to_fit();
+  ranging_.row_bound_dn.objective_.shrink_to_fit();
+  ranging_.row_bound_dn.in_var_.shrink_to_fit();
+  ranging_.row_bound_dn.ou_var_.shrink_to_fit();
+  iis_.clear();
+
+  // 3. Shrink standard form LP vectors.
+  standard_form_cost_.shrink_to_fit();
+  standard_form_rhs_.shrink_to_fit();
+
+  // 4. Reset timer clocks (accumulated timing data).
+  timer_.zeroAllClocks();
+
+  return returnFromHighs(return_status);
+}
+
 HighsStatus Highs::setOptionValue(const std::string& option, const bool value) {
   if (setLocalOptionValue(options_.log_options, option, options_.records,
                           value) == OptionStatus::kOk)

highspy/highs_bindings.cpp

@@ -1380,6 +1380,7 @@ PYBIND11_MODULE(_core, m, py::mod_gil_not_used()) {
       .def("clear", &Highs::clear)
       .def("clearModel", &Highs::clearModel)
       .def("clearSolver", &Highs::clearSolver)
+      .def("releaseMemory", &Highs::releaseMemory)
       .def("passModel", &highs_passModel)
       .def("passModel", &highs_passModelPointers)
       .def("passModel", &highs_passLp)

highspy/highspy/_core/__init__.pyi

@@ -955,6 +955,7 @@ class _Highs:
     def clearModel(self) -> HighsStatus: ...
     def clearLinearObjectives(self) -> HighsStatus: ...
     def clearSolver(self) -> HighsStatus: ...
+    def releaseMemory(self) -> HighsStatus: ...
     def crossover(self, solution: HighsSolution) -> HighsStatus: ...
     def deleteCols(self, num_cols: int, cols: HighsIntArrayType) -> HighsStatus: ...
     def deleteRows(self, num_rows: int, rows: HighsIntArrayType) -> HighsStatus: ...

highspy/tests/test_highspy.py

@@ -1547,6 +1547,24 @@ def try_change_ptr(e):
         h.solve()
         self.assertEqual(check_called[0], True)
 
+    def test_releaseMemory(self):
+        """Test that releaseMemory() frees memory and allows solving again."""
+        # Create and solve first problem
+        h = self.get_example_model()
+        h.run()
+        first_objective = h.getInfo().objective_function_value
+
+        # Release memory
+        status = h.releaseMemory()
+        self.assertEqual(status, highspy.HighsStatus.kOk)
+
+        # Solve a different problem to verify the solver still works
+        h2 = self.get_basic_model()
+        h2.run()
+        second_objective = h2.getInfo().objective_function_value
+
+        # Verify objectives are different (different problems)
+        self.assertNotEqual(first_objective, second_objective)
     def test_addVars_invalid_parameter(self):
         """ensure_real raises on invalid parameter"""
         h = highspy.Highs()