getNBranchings and getNBranchingsCurrentRun

Author: sirenard

CHANGELOG.md

@@ -14,6 +14,7 @@
 - Added recipe for getting local constraints
 - Added enableDebugSol() and disableDebugSol() for controlling the debug solution mechanism if DEBUGSOL=true
 - Added getVarPseudocostScore() and getVarPseudocost()
+- Added getNBranchings() and getNBranchingsCurrentRun()
 ### Fixed
 - Raised an error when an expression is used when a variable is required
 - Fixed some compile warnings

src/pyscipopt/scip.pxd

@@ -813,6 +813,7 @@ cdef extern from "scip/scip.h":
     SCIP_Real SCIPgetVarPseudocostScore(SCIP* scip, SCIP_VAR* var, SCIP_Real solval)
     SCIP_Real SCIPvarGetCutoffSum(SCIP_VAR* var, SCIP_BRANCHDIR dir)
     SCIP_Longint SCIPvarGetNBranchings(SCIP_VAR* var, SCIP_BRANCHDIR dir)
+    SCIP_Longint SCIPvarGetNBranchingsCurrentRun(SCIP_VAR* var, SCIP_BRANCHDIR dir)
     SCIP_Bool SCIPvarMayRoundUp(SCIP_VAR* var)
     SCIP_Bool SCIPvarMayRoundDown(SCIP_VAR* var)
 

src/pyscipopt/scip.pxi

@@ -1804,6 +1804,37 @@ cdef class Variable(Expr):
             mayround = SCIPvarMayRoundUp(self.scip_var)
         return mayround
 
+    def getNBranchings(self, branchdir):
+        """
+        returns the number of times, a bound of the variable was changed in given direction due to branching
+
+        Parameters
+        ----------
+        branchdir : PY_SCIP_BRANCHDIR
+            branching direction (downwards, or upwards)
+
+        Returns
+        -------
+        int
+        """
+        return SCIPvarGetNBranchings(self.scip_var, branchdir)
+
+    def getNBranchingsCurrentRun(self, branchdir):
+        """
+        returns the number of times, a bound of the variable was changed in given direction due to branching in the
+        current run
+
+        Parameters
+        ----------
+        branchdir : PY_SCIP_BRANCHDIR
+            branching direction (downwards, or upwards)
+
+        Returns
+        -------
+        int
+        """
+        return SCIPvarGetNBranchingsCurrentRun(self.scip_var, branchdir)
+
 class MatrixVariable(MatrixExpr):
 
     def vtype(self):

tests/test_vars.py

@@ -80,3 +80,37 @@ def test_markRelaxationOnly():
     assert x.isDeletable()
     assert not y.isRelaxationOnly()
     assert not y.isDeletable()
+
+def test_getNBranchings():
+    m = Model()
+
+    x = m.addVar("x", vtype='I', obj=-1.0)
+    y = m.addVar("y", vtype='I', obj=-2.0)
+
+    m.addCons(2*x + 1*y <= 3.5)
+    m.addCons(x + 2*y <= 3.5)
+
+    m.setPresolve(SCIP_PARAMSETTING.OFF)
+    m.setHeuristics(SCIP_PARAMSETTING.OFF)
+    m.disablePropagation()
+    m.presolve()
+
+    assert x.getNBranchings(SCIP_BRANCHDIR.UPWARDS) == 0
+    assert x.getNBranchings(SCIP_BRANCHDIR.DOWNWARDS) == 0
+
+def test_getNBranchingsCurrentRun():
+    m = Model()
+
+    x = m.addVar("x", vtype='I', obj=-1.0)
+    y = m.addVar("y", vtype='I', obj=-2.0)
+
+    m.addCons(2 * x + 1 * y <= 3.5)
+    m.addCons(x + 2 * y <= 3.5)
+
+    m.setPresolve(SCIP_PARAMSETTING.OFF)
+    m.setHeuristics(SCIP_PARAMSETTING.OFF)
+    m.disablePropagation()
+    m.presolve()
+
+    assert x.getNBranchingsCurrentRun(SCIP_BRANCHDIR.UPWARDS) == 0
+    assert x.getNBranchingsCurrentRun(SCIP_BRANCHDIR.DOWNWARDS) == 0