Add getTreeSizeEstimation (#829)

* wrap getTreeSizeEstimation method

* wrap getTreeSizeEstimation method

* wrap getTreeSizeEstimation method

* test getTreeSizeEstimation

Author: sirenard

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 ### Added
+- Add SCIP function SCIPgetTreesizeEstimation and wrapper getTreesizeEstimation
 ### Fixed
 ### Changed
 ### Removed

src/pyscipopt/scip.pxd

@@ -1270,6 +1270,7 @@ cdef extern from "scip/scip.h":
     SCIP_Bool SCIPisPositive(SCIP *scip, SCIP_Real val)
     SCIP_Bool SCIPisNegative(SCIP *scip, SCIP_Real val)
     SCIP_Bool SCIPisIntegral(SCIP *scip, SCIP_Real val)
+    SCIP_Real SCIPgetTreesizeEstimation(SCIP *scip)
 
     # Statistic Methods
     SCIP_RETCODE SCIPprintStatistics(SCIP* scip, FILE* outfile)

src/pyscipopt/scip.pxi

@@ -5195,6 +5195,10 @@ cdef class Model:
         assert isinstance(var, Variable), "The given variable is not a pyvar, but %s" % var.__class__.__name__
         PY_SCIP_CALL(SCIPchgVarBranchPriority(self._scip, var.scip_var, priority))
 
+    def getTreesizeEstimation(self):
+        """Get an estimation of the final tree size """
+        return SCIPgetTreesizeEstimation(self._scip)
+
 # debugging memory management
 def is_memory_freed():
     return BMSgetMemoryUsed() == 0

tests/test_model.py

@@ -286,3 +286,17 @@ def test_getStage():
     print(m.getStage())
     assert m.getStage() == SCIP_STAGE.SOLVED
     assert m.getStageName() == "SOLVED"
+
+def test_getTreesizeEstimation():
+    m = Model()
+
+    assert m.getTreesizeEstimation() == -1
+
+    x = m.addVar("x", vtype='B', obj=1.0)
+    y = m.addVar("y", vtype='B', obj=2.0)
+    c = m.addCons(x + y <= 10.0)
+    m.setMaximize()
+
+    m.optimize()
+
+    assert m.getTreesizeEstimation() > 0