Light changes

Author: Joao-Dionisio

src/pyscipopt/recipes/getLocalConss.py

@@ -2,7 +2,19 @@
 
 def getLocalConss(model: Model, node = None) -> list[Constraint]:
     """
-    Returns the local constraints of a node.
+    Returns local constraints.
+
+    Parameters
+    ----------
+    model : Model
+        The model from which to retrieve the local constraints.
+    node : Node, optional
+        The node from which to retrieve the local constraints. If not provided, the current node is used.
+
+    Returns
+    -------
+    list[Constraint]
+        A list of local constraints. First entry are global constraints, second entry are all the added constraints.
     """
 
     if not node:
@@ -11,14 +23,15 @@ def getLocalConss(model: Model, node = None) -> list[Constraint]:
     else:
         cur_node = node
 
-    local_conss = []
+    added_conss = []
     while cur_node is not None:
-        local_conss = cur_node.getAddedConss() + local_conss
+        added_conss = cur_node.getAddedConss() + added_conss
         cur_node = cur_node.getParent()
-    return local_conss
+    
+    return [model.getConss(), added_conss]
 
-def getNLocalConss(model: Model) -> int:
+def getNAddedConss(model: Model) -> int:
     """
     Returns the number of local constraints of a node.
     """
-    return len(getLocalConss(model))
+    return len(getLocalConss(model)[1])

tests/test_recipe_getLocalConss.py

@@ -4,25 +4,28 @@
 
 def localconss(model, event):
     local_conss = getLocalConss(model)
-    assert len(local_conss) == getNLocalConss(model)
+    assert len(local_conss[1]) == getNAddedConss(model)
 
     vars = model.getVars()
     if model.getCurrentNode().getNumber() == 1:
         pass
+
     elif model.getCurrentNode().getNumber() == 2:
         model.data["local_cons1"] = model.addCons(vars[0] + vars[1] <= 1, name="c1", local=True)
-        assert getNLocalConss(model) == 1
-        assert getLocalConss(model)[0] == model.data["local_cons1"]
+        assert getNAddedConss(model) == 1
+        assert getLocalConss(model)[1][0] == model.data["local_cons1"]
+
     elif model.getCurrentNode().getNumber() == 4:
         local_conss = getLocalConss(model)
         model.data["local_cons2"] = model.addCons(vars[1] + vars[2] <= 1, name="c2", local=True)
         model.data["local_cons3"] = model.addCons(vars[2] + vars[3] <= 1, name="c3", local=True)
-        assert getNLocalConss(model) == 3
-        assert getLocalConss(model)[0] == model.data["local_cons1"]
-        assert getLocalConss(model)[1] == model.data["local_cons2"]
-        assert getLocalConss(model)[2] == model.data["local_cons3"]
+        assert getNAddedConss(model) == 3
+        assert getLocalConss(model)[1][0] == model.data["local_cons1"]
+        assert getLocalConss(model)[1][1] == model.data["local_cons2"]
+        assert getLocalConss(model)[1][2] == model.data["local_cons3"]
+
     elif model.getCurrentNode().getParent().getNumber() not in [2,4]:
-        assert getLocalConss(model) == []
+        assert getLocalConss(model) == [model.getConss(), []]
 
 def test_getLocalConss():
     model = random_mip_1(node_lim=4)