Merge branch 'master' into fix-binops

Author: Joao-Dionisio

CHANGELOG.md

@@ -2,8 +2,10 @@
 
 ## Unreleased
 ### Added
+- Added basic type stubs to help with IDE autocompletion and type checking.
 ### Fixed
 - Implemented all binary operations between MatrixExpr and GenExpr
+- Fixed the type of @ matrix operation result from MatrixVariable to MatrixExpr.
 ### Changed
 ### Removed
 
@@ -25,7 +27,6 @@
 ### Fixed
 - Raised an error when an expression is used when a variable is required
 - Fixed some compile warnings
-- Fixed the type of @ matrix operation result from MatrixVariable to MatrixExpr.
 ### Changed
 - MatrixExpr.sum() now supports axis arguments and can return either a scalar or MatrixExpr, depending on the result dimensions.
 - AddMatrixCons() also accepts ExprCons.

src/pyscipopt/scip.pxi

@@ -6979,7 +6979,7 @@ cdef class Model:
         return pyCons
 
 
-    def addMatrixConsIndicator(self, cons: MatrixExprCons, binvar: Union[Variable, MatrixVariable] = None,
+    def addMatrixConsIndicator(self, cons: Union[ExprCons, MatrixExprCons], binvar: Union[Variable, MatrixVariable] = None,
                                activeone: Union[bool, np.ndarray] = True, name: Union[str, np.ndarray] = "",
                                initial: Union[bool, np.ndarray] = True, separate: Union[bool, np.ndarray] = True,
                                enforce: Union[bool, np.ndarray] = True, check: Union[bool, np.ndarray] = True,
@@ -6993,7 +6993,7 @@ cdef class Model:
 
         Parameters
         ----------
-        cons : MatrixExprCons
+        cons : ExprCons or MatrixExprCons
             a linear inequality of the form "<=".
         binvar : Variable or MatrixVariable, optional
             binary indicator variable / matrix variable, or None if it should be created. (Default value = None)
@@ -7027,9 +7027,14 @@ cdef class Model:
             The newly created Indicator MatrixConstraint object.
         """
 
-        assert isinstance(cons, MatrixExprCons), (
-            f"given constraint is not MatrixExprCons but {cons.__class__.__name__}"
-        )
+        if not isinstance(cons, (ExprCons, MatrixExprCons)):
+            raise TypeError("given constraint is not MatrixExprCons nor ExprCons but %s" % cons.__class__.__name__)
+
+        if isinstance(cons, ExprCons):
+            return self.addConsIndicator(cons, binvar=binvar, activeone=activeone, name=name,
+                        initial=initial, separate=separate, enforce=enforce, check=check,
+                        propagate=propagate, local=local, dynamic=dynamic, removable=removable,
+                        stickingatnode=stickingatnode)
 
         shape = cons.shape
 

tests/test_matrix_variable.py

@@ -377,6 +377,11 @@ def test_matrix_cons_indicator():
     with pytest.raises(Exception):
         m.addMatrixConsIndicator(x >= y, is_equal)
 
+    # require MatrixExprCons or ExprCons
+    with pytest.raises(TypeError):
+        m.addMatrixConsIndicator(x)
+
+    # test MatrixExprCons
     for i in range(2):
         m.addMatrixConsIndicator(x[i] >= y[i], is_equal[0, i])
         m.addMatrixConsIndicator(x[i] <= y[i], is_equal[0, i])
@@ -388,12 +393,19 @@ def test_matrix_cons_indicator():
         m.addMatrixConsIndicator(x[:, i] >= y[:, i], is_equal[0])
         m.addMatrixConsIndicator(x[:, i] <= y[:, i], is_equal[0])
 
-    m.setObjective(is_equal.sum(), "maximize")
+    # test ExprCons
+    z = m.addVar(vtype="B")
+    binvar = m.addVar(vtype="B")
+    m.addMatrixConsIndicator(z >= 1, binvar, activeone=True)
+    m.addMatrixConsIndicator(z <= 0, binvar, activeone=False)
+
+    m.setObjective(is_equal.sum() + binvar, "maximize")
     m.optimize()
 
     assert m.getVal(is_equal).sum() == 2
     assert (m.getVal(x) == m.getVal(y)).all().all()
     assert (m.getVal(x) == np.array([[5, 5, 5], [5, 5, 5]])).all().all()
+    assert m.getVal(z) == 1
 
 
 _binop_model = Model()