Add getMemUsed, getMemTotal, and getMemExternEstim methods

Author: Joao-Dionisio

src/pyscipopt/scip.pxd

@@ -1822,6 +1822,11 @@ cdef extern from "blockmemshell/memory.h":
     void BMScheckEmptyMemory()
     long long BMSgetMemoryUsed()
 
+cdef extern from "scip/scip_mem.h":
+    SCIP_Longint SCIPgetMemUsed(SCIP* scip)
+    SCIP_Longint SCIPgetMemTotal(SCIP* scip)
+    SCIP_Longint SCIPgetMemExternEstim(SCIP* scip)
+
 cdef extern from "scip/scip_expr.h":
     SCIP_RETCODE SCIPcreateExpr(SCIP* scip,
                                 SCIP_EXPR** expr,

src/pyscipopt/scip.pxi

@@ -11467,6 +11467,41 @@ cdef class Model:
 
         locale.setlocale(locale.LC_NUMERIC,user_locale)
 
+    def getMemUsed(self):
+        """
+        Gets the total number of bytes used in block and buffer memory.
+
+        Returns
+        -------
+        int
+
+        """
+        return SCIPgetMemUsed(self._scip)
+
+    def getMemTotal(self):
+        """
+        Gets the total number of bytes in block and buffer memory
+        (i.e., total allocated, including unused).
+
+        Returns
+        -------
+        int
+
+        """
+        return SCIPgetMemTotal(self._scip)
+
+    def getMemExternEstim(self):
+        """
+        Gets the estimated number of bytes used by external software,
+        e.g., the LP solver.
+
+        Returns
+        -------
+        int
+
+        """
+        return SCIPgetMemExternEstim(self._scip)
+
     def getNLPs(self):
         """
         Gets total number of LPs solved so far.

src/pyscipopt/scip.pyi

@@ -1153,6 +1153,9 @@ class Model:
     def getNLPIterations(self) -> Incomplete: ...
     def getNLPRows(self) -> Incomplete: ...
     def getNLPs(self) -> Incomplete: ...
+    def getMemUsed(self) -> int: ...
+    def getMemTotal(self) -> int: ...
+    def getMemExternEstim(self) -> int: ...
     def getNLeaves(self) -> Incomplete: ...
     def getNLimSolsFound(self) -> Incomplete: ...
     def getNNlRows(self) -> Incomplete: ...

tests/test_model.py

@@ -642,3 +642,23 @@ def test_getSolVal():
         m.getVal("not_a_var")
     with pytest.raises(TypeError):
         m.getSolVal(sol, "not_a_var")
+
+
+def test_memory_methods():
+    m = Model()
+
+    # Memory values should be non-negative even on an empty model
+    assert m.getMemUsed() >= 0
+    assert m.getMemTotal() >= 0
+    assert m.getMemExternEstim() >= 0
+
+    # Total allocated should be at least as much as actively used
+    assert m.getMemTotal() >= m.getMemUsed()
+
+    # After adding variables and solving, memory usage should increase
+    x = m.addVar("x", vtype="C", obj=1.0)
+    m.addCons(x >= 0)
+    m.optimize()
+
+    assert m.getMemUsed() > 0
+    assert m.getMemTotal() > 0