Expose SCIP_BASESTAT as a Python-level class

Author: Joao-Dionisio

src/pyscipopt/__init__.py

@@ -28,6 +28,7 @@
 from pyscipopt.scip      import LP as LP
 from pyscipopt.scip      import IISfinder as IISfinder 
 from pyscipopt.scip      import PY_SCIP_LPPARAM as SCIP_LPPARAM
+from pyscipopt.scip      import PY_SCIP_BASESTAT as SCIP_BASESTAT
 from pyscipopt.scip      import readStatistics as readStatistics
 from pyscipopt.scip      import Expr as Expr
 from pyscipopt.scip      import MatrixExpr as MatrixExpr

src/pyscipopt/lp.pxi

@@ -534,11 +534,7 @@ cdef class LP:
     def getBase(self):
         """Returns the basis status of columns and rows.
 
-        Column status values: SCIP_BASESTAT_LOWER (0), SCIP_BASESTAT_BASIC (1),
-        SCIP_BASESTAT_UPPER (2), SCIP_BASESTAT_ZERO (3).
-
-        Row status values: SCIP_BASESTAT_LOWER (0), SCIP_BASESTAT_BASIC (1),
-        SCIP_BASESTAT_UPPER (2).
+        Status values are defined in SCIP_BASESTAT: LOWER, BASIC, UPPER, ZERO.
 
         Returns
         -------
@@ -565,11 +561,7 @@ cdef class LP:
     def setBase(self, cstat, rstat):
         """Sets the basis status of columns and rows.
 
-        Column status values: SCIP_BASESTAT_LOWER (0), SCIP_BASESTAT_BASIC (1),
-        SCIP_BASESTAT_UPPER (2), SCIP_BASESTAT_ZERO (3).
-
-        Row status values: SCIP_BASESTAT_LOWER (0), SCIP_BASESTAT_BASIC (1),
-        SCIP_BASESTAT_UPPER (2).
+        Status values are defined in SCIP_BASESTAT: LOWER, BASIC, UPPER, ZERO.
 
         Parameters
         ----------

src/pyscipopt/scip.pxi

@@ -118,6 +118,12 @@ cdef class PY_SCIP_LPPARAM:
     POLISHING      = SCIP_LPPAR_POLISHING
     REFACTOR       = SCIP_LPPAR_REFACTOR
 
+cdef class PY_SCIP_BASESTAT:
+    LOWER = SCIP_BASESTAT_LOWER
+    BASIC = SCIP_BASESTAT_BASIC
+    UPPER = SCIP_BASESTAT_UPPER
+    ZERO  = SCIP_BASESTAT_ZERO
+
 cdef class PY_SCIP_PARAMEMPHASIS:
     DEFAULT      = SCIP_PARAMEMPHASIS_DEFAULT
     CPSOLVER     = SCIP_PARAMEMPHASIS_CPSOLVER

src/pyscipopt/scip.pyi

@@ -1803,6 +1803,13 @@ class PY_SCIP_LOCKTYPE:
     MODEL: ClassVar[int] = ...
     def __init__(self) -> None: ...
 
+class PY_SCIP_BASESTAT:
+    LOWER: ClassVar[int] = ...
+    BASIC: ClassVar[int] = ...
+    UPPER: ClassVar[int] = ...
+    ZERO: ClassVar[int] = ...
+    def __init__(self) -> None: ...
+
 class PY_SCIP_LPPARAM:
     BARRIERCONVTOL: ClassVar[int] = ...
     CONDITIONLIMIT: ClassVar[int] = ...

tests/test_lp.py

@@ -1,5 +1,6 @@
 from pyscipopt import LP
 from pyscipopt import SCIP_LPPARAM
+from pyscipopt import SCIP_BASESTAT
 
 def test_lp():
     # create LP instance, minimizing by default
@@ -97,6 +98,10 @@ def test_lp():
     cstat, rstat = myLP.getBase()
     assert len(cstat) == myLP.ncols()
     assert len(rstat) == myLP.nrows()
+    assert all(s in (SCIP_BASESTAT.LOWER, SCIP_BASESTAT.BASIC,
+                     SCIP_BASESTAT.UPPER, SCIP_BASESTAT.ZERO) for s in cstat)
+    assert all(s in (SCIP_BASESTAT.LOWER, SCIP_BASESTAT.BASIC,
+                     SCIP_BASESTAT.UPPER) for s in rstat)
 
     # set the same basis back and re-solve
     myLP.setBase(cstat, rstat)