Renamed user_cost_scale to user_objective_scale

Author: jajhall

check/TestUserScale.cpp

@@ -46,8 +46,8 @@ TEST_CASE("user-scale-after-run", "[highs_user_scale]") {
 
     HighsInt user_objective_scale = 4;
     double user_objective_scale_value = std::pow(2, user_objective_scale);
-    REQUIRE(highs.setOptionValue("user_cost_scale", user_objective_scale) ==
-            HighsStatus::kOk);
+    REQUIRE(highs.setOptionValue("user_objective_scale",
+                                 user_objective_scale) == HighsStatus::kOk);
 
     highs.run();
 
@@ -57,7 +57,8 @@ TEST_CASE("user-scale-after-run", "[highs_user_scale]") {
 
     model = mip_model;
     REQUIRE(highs.setOptionValue("user_bound_scale", 0) == HighsStatus::kOk);
-    REQUIRE(highs.setOptionValue("user_cost_scale", 0) == HighsStatus::kOk);
+    REQUIRE(highs.setOptionValue("user_objective_scale", 0) ==
+            HighsStatus::kOk);
   }
 
   highs.resetGlobalScheduler(true);
@@ -96,14 +97,15 @@ TEST_CASE("user-small-cost-scale", "[highs_user_scale]") {
   REQUIRE(solution.col_value[0] == 40);
   REQUIRE(solution.col_value[1] == 20);
 
-  REQUIRE(highs.setOptionValue("user_cost_scale", -30) == HighsStatus::kOk);
+  REQUIRE(highs.setOptionValue("user_objective_scale", -30) ==
+          HighsStatus::kOk);
   highs.clearSolver();
   highs.run();
   if (dev_run) highs.writeSolution("", 1);
   REQUIRE(solution.col_value[0] == 0);
   REQUIRE(solution.col_value[1] == 0);
 
-  REQUIRE(highs.setOptionValue("user_cost_scale", 0) == HighsStatus::kOk);
+  REQUIRE(highs.setOptionValue("user_objective_scale", 0) == HighsStatus::kOk);
 
   highs.run();
   REQUIRE(solution.col_value[0] == 40);
@@ -114,7 +116,8 @@ TEST_CASE("user-small-cost-scale", "[highs_user_scale]") {
       std::string(HIGHS_DIR) + "/check/instances/" + model + ".mps";
   highs.readModel(filename);
 
-  REQUIRE(highs.setOptionValue("user_cost_scale", -30) == HighsStatus::kOk);
+  REQUIRE(highs.setOptionValue("user_objective_scale", -30) ==
+          HighsStatus::kOk);
 
   highs.run();
 
@@ -198,7 +201,7 @@ HighsHessian hessian(const double value) {
 }
 
 void testUserScale(Highs& h) {
-  h.setOptionValue("user_cost_scale", 0);
+  h.setOptionValue("user_objective_scale", 0);
   h.setOptionValue("user_bound_scale", 0);
   if (dev_run)
     printf("\n---------------\nWithout user scaling\n---------------\n");
@@ -224,7 +227,7 @@ void testUserScale(Highs& h) {
     suggested_bound_scale = 1;
   }
 
-  h.setOptionValue("user_cost_scale", suggested_objective_scale);
+  h.setOptionValue("user_objective_scale", suggested_objective_scale);
   h.setOptionValue("user_bound_scale", suggested_bound_scale);
   h.clearSolver();
   h.run();

highs/highs_bindings.cpp

@@ -1221,7 +1221,7 @@ PYBIND11_MODULE(_core, m, py::mod_gil_not_used()) {
       .def_readwrite("objective_target", &HighsOptions::objective_target)
       .def_readwrite("threads", &HighsOptions::threads)
       .def_readwrite("user_bound_scale", &HighsOptions::user_bound_scale)
-      .def_readwrite("user_cost_scale", &HighsOptions::user_cost_scale)
+      .def_readwrite("user_objective_scale", &HighsOptions::user_objective_scale)
       .def_readwrite("highs_debug_level", &HighsOptions::highs_debug_level)
       .def_readwrite("highs_analysis_level",
                      &HighsOptions::highs_analysis_level)

highs/interfaces/highs_c_api.h

@@ -2457,13 +2457,13 @@ HighsInt Highs_getIis(void* highs, HighsInt* iis_num_col, HighsInt* iis_num_row,
                       HighsInt* col_bound, HighsInt* row_bound,
                       HighsInt* col_status, HighsInt* row_status);
 /**
- * Identify suggested values of the options user_cost_scale and
+ * Identify suggested values of the options user_objective_scale and
  * user_bound_scale to address extremely large or small objective
  * coefficients and bound values
  *
  * @param highs                                A pointer to the Highs instance.
  * @param HighsInt* suggested_objective_scale  The suggested value of
- * user_cost_scale
+ * user_objective_scale
  * @param HighsInt* suggested_bound_scale      The suggested value of
  * user_bound_scale
  *

highs/lp_data/Highs.cpp

@@ -954,7 +954,7 @@ HighsStatus Highs::run() {
     // Indicate that the scaling has been applied
     user_scale_data.applied = true;
     // Zero the user scale values to prevent further scaling
-    this->options_.user_cost_scale = 0;
+    this->options_.user_objective_scale = 0;
     this->options_.user_bound_scale = 0;
   }
 
@@ -1001,7 +1001,7 @@ HighsStatus Highs::run() {
     unscale_status = this->userScaleSolution(user_scale_data, update_kkt);
     // Restore the user scale values, remembering that they've been
     // negated to undo user scaling
-    this->options_.user_cost_scale = -user_scale_data.user_objective_scale;
+    this->options_.user_objective_scale = -user_scale_data.user_objective_scale;
     this->options_.user_bound_scale = -user_scale_data.user_bound_scale;
     // Indicate that the scaling has not been applied
     user_scale_data.applied = false;

highs/lp_data/HighsLpUtils.cpp

@@ -3660,9 +3660,9 @@ void getSubVectorsTranspose(const HighsIndexCollection& index_collection,
 
 void initialiseUserScaleData(const HighsOptions& options,
                              HighsUserScaleData& user_scale_data) {
-  user_scale_data.initialise(options.user_cost_scale, options.user_bound_scale,
-                             options.infinite_cost, options.infinite_bound,
-                             options.small_matrix_value,
+  user_scale_data.initialise(options.user_objective_scale,
+                             options.user_bound_scale, options.infinite_cost,
+                             options.infinite_bound, options.small_matrix_value,
                              options.large_matrix_value);
 }
 

highs/lp_data/HighsOptions.h

@@ -316,8 +316,7 @@ struct HighsOptionsStruct {
   double objective_bound;
   double objective_target;
   HighsInt threads;
-  // V2.0: Should be user_objective_scale to accommodate Hessian
-  HighsInt user_cost_scale;
+  HighsInt user_objective_scale;
   HighsInt user_bound_scale;
   HighsInt highs_debug_level;
   HighsInt highs_analysis_level;
@@ -490,7 +489,7 @@ struct HighsOptionsStruct {
         objective_bound(0.0),
         objective_target(0.0),
         threads(0),
-        user_cost_scale(0),
+        user_objective_scale(0),
         user_bound_scale(0),
         highs_debug_level(0),
         highs_analysis_level(0),
@@ -800,8 +799,9 @@ class HighsOptions : public HighsOptionsStruct {
     records.push_back(record_int);
 
     record_int = new OptionRecordInt(
-        "user_cost_scale", "Exponent of power-of-two cost scaling for model",
-        advanced, &user_cost_scale, -kHighsIInf, 0, kHighsIInf);
+        "user_objective_scale",
+        "Exponent of power-of-two objective scaling for model", advanced,
+        &user_objective_scale, -kHighsIInf, 0, kHighsIInf);
     records.push_back(record_int);
 
     record_int = new OptionRecordInt("highs_debug_level",

highs/lp_data/HighsSolve.cpp

@@ -363,7 +363,7 @@ void assessExcessiveObjectiveBoundScaling(const HighsLogOptions log_options,
   std::stringstream message;
   if (user_cost_or_bound_scale) {
     if (user_scale_data.user_objective_scale)
-      message << highsFormatToString(" user_cost_scale option value of %d",
+      message << highsFormatToString(" user_objective_scale option value of %d",
                                      user_scale_data.user_objective_scale);
     if (user_scale_data.user_bound_scale) {
       if (user_scale_data.user_objective_scale) message << " and";
@@ -622,7 +622,7 @@ void assessExcessiveObjectiveBoundScaling(const HighsLogOptions log_options,
       message << ", or";
     }
     message << highsFormatToString(
-        " setting the user_cost_scale option to %d",
+        " setting the user_objective_scale option to %d",
         int(user_scale_data.suggested_user_objective_scale));
   }
   if (order_of_magnitude_message || dl_user_objective_scale)

tests/test_highspy.py

@@ -2272,7 +2272,7 @@ def test_get_user_objective_bound_scale(self):
         [status, dual_objective_value] = h.getDualObjectiveValue()
         self.assertAlmostEqual(unscaled_objective_value, dual_objective_value)
         [status, suggested_objective_scale, suggested_bound_scale] = h.getObjectiveBoundScaling();
-        h.setOptionValue("user_cost_scale", suggested_objective_scale)
+        h.setOptionValue("user_objective_scale", suggested_objective_scale)
         h.setOptionValue("user_bound_scale", suggested_bound_scale)
         h.run()
         scaled_objective_value = h.getObjectiveValue()