feat: round integral variables by default (#158)

Author: mtth

poetry.lock

@@ -14,7 +14,7 @@ requires = ['poetry-core']
 build-backend = 'poetry.core.masonry.api'
 
 [tool.poetry]
-version = '0.23.4rc2'
+version = '0.23.4rc3'
 packages = [{include = 'opvious', from = 'src'}]
 
 [tool.poetry.dependencies]
@@ -42,7 +42,7 @@ sphinx-rtd-theme = '^3.0.2'
 types-docopt = '^0.6.11.3'
 
 [tool.poetry.extras]
-aio = ['aiohttp', 'Brotli', 'lru-dict']
+aio = ['aiohttp', 'brotli', 'lru-dict']
 cli = ['docopt-ng']
 
 # Poe

pyproject.toml

@@ -216,18 +216,26 @@ class SolveOutputs:
     raw_constraints: list[Any]
     """All constraints in raw format"""
 
-    def variable(self, label: Label) -> pd.DataFrame:
+    def variable(self, label: Label, coerce: bool = True) -> pd.DataFrame:
         """Returns variable results for a given label
 
         The returned dataframe always has a `value` column with the variable's
         values (0 values may be omitted). If applicable, it will also have a
-        `dual_value` column.
+        `reduced_cost` column.
+
+        Args:
+            label: Variable label to retrieve
+            coerce: Round integral variables
         """
         for res in self.raw_variables:
             if res["label"] == label:
+                outline = self.problem_outline.variables[label]
                 return _output_dataframe(
                     res["entries"],
-                    self.problem_outline.variables[label].bindings,
+                    outline.bindings,
+                    value_name="value",
+                    dual_value_name="reduced_cost",
+                    round_values=coerce and outline.is_integral,
                 )
         raise Exception(f"Unknown variable {label}")
 
@@ -236,33 +244,39 @@ def constraint(self, label: Label) -> pd.DataFrame:
 
         The returned dataframe always has a `slack` column with the
         constraint's slack (0 values may be omitted). If applicable, it will
-        also have a `dual_value` column.
+        also have a `shadow_price` column.
         """
         for res in self.raw_constraints:
             if res["label"] == label:
                 return _output_dataframe(
                     res["entries"],
                     self.problem_outline.constraints[label].bindings,
                     value_name="slack",
+                    dual_value_name="shadow_price",
                 )
         raise Exception(f"Unknown constraint {label}")
 
 
 def _output_dataframe(
     entries: Sequence[Json],
     bindings: Sequence[SourceBinding],
-    value_name: str = "value",
+    *,
+    value_name: str,
+    dual_value_name: str,
+    round_values: bool = False,
 ) -> pd.DataFrame:
     df = pd.DataFrame(
         data=(
             (decode_extended_float(e["value"]), e.get("dualValue"))
             for e in entries
         ),
-        columns=[value_name, "dual_value"],
+        columns=[value_name, dual_value_name],
         index=_entry_index(entries, bindings),
     )
-    if df["dual_value"].isnull().all():
-        df.drop("dual_value", axis=1, inplace=True)
+    if df[dual_value_name].isnull().all():
+        df.drop(dual_value_name, axis=1, inplace=True)
+    if round_values:
+        df[value_name] = df[value_name].round(0).astype(np.int64)
     df.fillna(0, inplace=True)
     return df
 

src/opvious/data/solves.py

@@ -89,7 +89,7 @@ async def register(self, context: ProblemTransformationContext) -> None:
             context.add("pinVariable", label=label)
 
 
-RelaxationPenalty = Literal[
+type RelaxationPenalty = Literal[
     "TOTAL_DEVIATION",
     "MAX_DEVIATION",
     "DEVIATION_CARDINALITY",