PySCIPOpt 5.3.0__tar.gz → 5.4.1__tar.gz

{pyscipopt-5.3.0 → pyscipopt-5.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PySCIPOpt
-Version: 5.3.0
+Version: 5.4.1
 Summary: Python interface and modeling environment for SCIP
 Home-page: https://github.com/SCIP-Interfaces/PySCIPOpt
 Author: Zuse Institute Berlin
@@ -17,6 +17,7 @@ Classifier: Topic :: Scientific/Engineering :: Mathematics
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: numpy>=1.16.0
 Dynamic: author
 Dynamic: home-page
 
@@ -66,20 +67,20 @@ following steps are always required when using the interface:
 1)  It is necessary to import python-scip in your code. This is achieved
     by including the line
 
-``` {.sourceCode .python}
+```python
 from pyscipopt import Model
 ```
 
 2)  Create a solver instance.
 
-``` {.sourceCode .python}
+```python
 model = Model("Example")  # model name is optional
 ```
 
 3)  Access the methods in the `scip.pxi` file using the solver/model
     instance `model`, e.g.:
 
-``` {.sourceCode .python}
+```python
 x = model.addVar("x")
 y = model.addVar("y", vtype="INTEGER")
 model.setObjective(x + y)
@@ -104,6 +105,16 @@ examples.
 Please notice that in most cases one needs to use a `dictionary` to
 specify the return values needed by SCIP.
 
+Using PySCIPOpt?
+----------------
+
+If your project or company is using PySCIPOpt, consider letting us know at scip@zib.de. We are always interested
+in knowing how PySCIPOpt is being used, and, given permission, would also appreciate adding your company's logo 
+to our website.  
+
+If you are creating models with some degree of complexity which don't take too long to solve, also consider
+sharing them with us. We might want to add them to [`tests/helpers/utils.py`](tests/helpers/utils.py) to help make our tests more robust, or add them to our examples.
+
 Citing PySCIPOpt
 ----------------
 

{pyscipopt-5.3.0 → pyscipopt-5.4.1}/PySCIPOpt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: PySCIPOpt
-Version: 5.3.0
+Version: 5.4.1
 Summary: Python interface and modeling environment for SCIP
 Home-page: https://github.com/SCIP-Interfaces/PySCIPOpt
 Author: Zuse Institute Berlin
@@ -17,6 +17,7 @@ Classifier: Topic :: Scientific/Engineering :: Mathematics
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: numpy>=1.16.0
 Dynamic: author
 Dynamic: home-page
 
@@ -66,20 +67,20 @@ following steps are always required when using the interface:
 1)  It is necessary to import python-scip in your code. This is achieved
     by including the line
 
-``` {.sourceCode .python}
+```python
 from pyscipopt import Model
 ```
 
 2)  Create a solver instance.
 
-``` {.sourceCode .python}
+```python
 model = Model("Example")  # model name is optional
 ```
 
 3)  Access the methods in the `scip.pxi` file using the solver/model
     instance `model`, e.g.:
 
-``` {.sourceCode .python}
+```python
 x = model.addVar("x")
 y = model.addVar("y", vtype="INTEGER")
 model.setObjective(x + y)
@@ -104,6 +105,16 @@ examples.
 Please notice that in most cases one needs to use a `dictionary` to
 specify the return values needed by SCIP.
 
+Using PySCIPOpt?
+----------------
+
+If your project or company is using PySCIPOpt, consider letting us know at scip@zib.de. We are always interested
+in knowing how PySCIPOpt is being used, and, given permission, would also appreciate adding your company's logo 
+to our website.  
+
+If you are creating models with some degree of complexity which don't take too long to solve, also consider
+sharing them with us. We might want to add them to [`tests/helpers/utils.py`](tests/helpers/utils.py) to help make our tests more robust, or add them to our examples.
+
 Citing PySCIPOpt
 ----------------
 

{pyscipopt-5.3.0 → pyscipopt-5.4.1}/PySCIPOpt.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ setup.py
 PySCIPOpt.egg-info/PKG-INFO
 PySCIPOpt.egg-info/SOURCES.txt
 PySCIPOpt.egg-info/dependency_links.txt
+PySCIPOpt.egg-info/requires.txt
 PySCIPOpt.egg-info/top_level.txt
 src/pyscipopt/Multidict.py
 src/pyscipopt/__init__.py
@@ -19,6 +20,7 @@ src/pyscipopt/event.pxi
 src/pyscipopt/expr.pxi
 src/pyscipopt/heuristic.pxi
 src/pyscipopt/lp.pxi
+src/pyscipopt/matrix.pxi
 src/pyscipopt/nodesel.pxi
 src/pyscipopt/presol.pxi
 src/pyscipopt/pricer.pxi
@@ -53,9 +55,11 @@ tests/test_knapsack.py
 tests/test_linexpr.py
 tests/test_logical.py
 tests/test_lp.py
+tests/test_matrix_variable.py
 tests/test_memory.py
 tests/test_model.py
 tests/test_nlrow.py
+tests/test_node.py
 tests/test_nodesel.py
 tests/test_nogil.py
 tests/test_nonlinear.py

pyscipopt-5.4.1/PySCIPOpt.egg-info/requires.txt

@@ -0,0 +1 @@
+numpy>=1.16.0

{pyscipopt-5.3.0 → pyscipopt-5.4.1}/README.md

@@ -44,20 +44,20 @@ following steps are always required when using the interface:
 1)  It is necessary to import python-scip in your code. This is achieved
     by including the line
 
-``` {.sourceCode .python}
+```python
 from pyscipopt import Model
 ```
 
 2)  Create a solver instance.
 
-``` {.sourceCode .python}
+```python
 model = Model("Example")  # model name is optional
 ```
 
 3)  Access the methods in the `scip.pxi` file using the solver/model
     instance `model`, e.g.:
 
-``` {.sourceCode .python}
+```python
 x = model.addVar("x")
 y = model.addVar("y", vtype="INTEGER")
 model.setObjective(x + y)
@@ -82,6 +82,16 @@ examples.
 Please notice that in most cases one needs to use a `dictionary` to
 specify the return values needed by SCIP.
 
+Using PySCIPOpt?
+----------------
+
+If your project or company is using PySCIPOpt, consider letting us know at scip@zib.de. We are always interested
+in knowing how PySCIPOpt is being used, and, given permission, would also appreciate adding your company's logo 
+to our website.  
+
+If you are creating models with some degree of complexity which don't take too long to solve, also consider
+sharing them with us. We might want to add them to [`tests/helpers/utils.py`](tests/helpers/utils.py) to help make our tests more robust, or add them to our examples.
+
 Citing PySCIPOpt
 ----------------
 

{pyscipopt-5.3.0 → pyscipopt-5.4.1}/pyproject.toml

@@ -8,7 +8,7 @@ description = "Python interface and modeling environment for SCIP"
 authors = [
     {name = "Zuse Institute Berlin", email = "scip@zib.de"},
 ]
-dependencies = []
+dependencies = ['numpy >=1.16.0']
 requires-python = ">=3.8"
 readme = "README.md"
 license = {text = "MIT"}

{pyscipopt-5.3.0 → pyscipopt-5.4.1}/setup.cfg

@@ -1,6 +1,3 @@
-[bdist_wheel]
-universal = 1
-
 [egg_info]
 tag_build = 
 tag_date = 0

{pyscipopt-5.3.0 → pyscipopt-5.4.1}/setup.py

@@ -1,5 +1,5 @@
 from setuptools import find_packages, setup, Extension
-import os, platform, sys, re
+import os, platform, sys
 
 # look for environment variable that specifies path to SCIP
 scipoptdir = os.environ.get("SCIPOPTDIR", "").strip('"')
@@ -109,7 +109,7 @@ with open("README.md") as f:
 
 setup(
     name="PySCIPOpt",
-    version="5.3.0",
+    version="5.4.1",
     description="Python interface and modeling environment for SCIP",
     long_description=long_description,
     long_description_content_type="text/markdown",

{pyscipopt-5.3.0 → pyscipopt-5.4.1}/src/pyscipopt/__init__.py

@@ -10,7 +10,9 @@ if hasattr(os, 'add_dll_directory'):
 from pyscipopt.Multidict import multidict
 from pyscipopt.scip      import Model
 from pyscipopt.scip      import Variable
+from pyscipopt.scip      import MatrixVariable
 from pyscipopt.scip      import Constraint
+from pyscipopt.scip      import MatrixConstraint
 from pyscipopt.scip      import Benders
 from pyscipopt.scip      import Benderscut
 from pyscipopt.scip      import Branchrule
@@ -26,6 +28,9 @@ from pyscipopt.scip      import Sepa
 from pyscipopt.scip      import LP
 from pyscipopt.scip      import readStatistics
 from pyscipopt.scip      import Expr
+from pyscipopt.scip      import MatrixExpr
+from pyscipopt.scip      import MatrixExprCons
+from pyscipopt.scip      import ExprCons
 from pyscipopt.scip      import quicksum
 from pyscipopt.scip      import quickprod
 from pyscipopt.scip      import exp

pyscipopt-5.4.1/src/pyscipopt/_version.py

@@ -0,0 +1 @@
+__version__ = '5.4.1'

{pyscipopt-5.3.0 → pyscipopt-5.4.1}/src/pyscipopt/expr.pxi

@@ -42,7 +42,7 @@
 # which should, in princple, modify the expr. However, since we do not implement __isub__, __sub__
 # gets called (I guess) and so a copy is returned.
 # Modifying the expression directly would be a bug, given that the expression might be re-used by the user. </pre>
-
+include "matrix.pxi"
 
 def _is_number(e):
     try:
@@ -52,14 +52,15 @@ def _is_number(e):
         return False
     except TypeError: # for other types (Variable, Expr)
         return False
-
-
+        
 def _expr_richcmp(self, other, op):
     if op == 1: # <=
         if isinstance(other, Expr) or isinstance(other, GenExpr):
             return (self - other) <= 0.0
         elif _is_number(other):
             return ExprCons(self, rhs=float(other))
+        elif isinstance(other, MatrixExpr):
+            return _expr_richcmp(other, self, 5)
         else:
             raise NotImplementedError
     elif op == 5: # >=
@@ -67,6 +68,8 @@ def _expr_richcmp(self, other, op):
             return (self - other) >= 0.0
         elif _is_number(other):
             return ExprCons(self, lhs=float(other))
+        elif isinstance(other, MatrixExpr):
+            return _expr_richcmp(other, self, 1)
         else:
             raise NotImplementedError
     elif op == 2: # ==
@@ -74,6 +77,8 @@ def _expr_richcmp(self, other, op):
             return (self - other) == 0.0
         elif _is_number(other):
             return ExprCons(self, lhs=float(other), rhs=float(other))
+        elif isinstance(other, MatrixExpr):
+            return _expr_richcmp(other, self, 2)
         else:
             raise NotImplementedError
     else:
@@ -117,6 +122,7 @@ def buildGenExprObj(expr):
     """helper function to generate an object of type GenExpr"""
     if _is_number(expr):
         return Constant(expr)
+
     elif isinstance(expr, Expr):
         # loop over terms and create a sumexpr with the sum of each term
         # each term is either a variable (which gets transformed into varexpr)
@@ -135,6 +141,13 @@ def buildGenExprObj(expr):
                     prodexpr *= varexpr
                 sumexpr += coef * prodexpr
         return sumexpr
+
+    elif isinstance(expr, MatrixExpr):   
+        GenExprs = np.empty(expr.shape, dtype=object)
+        for idx in np.ndindex(expr.shape):
+            GenExprs[idx] = buildGenExprObj(expr[idx])
+        return GenExprs
+
     else:
         assert isinstance(expr, GenExpr)
         return expr
@@ -185,8 +198,11 @@ cdef class Expr:
             terms[CONST] = terms.get(CONST, 0.0) + c
         elif isinstance(right, GenExpr):
             return buildGenExprObj(left) + right
+        elif isinstance(right, MatrixExpr):
+            return right + left
         else:
             raise NotImplementedError
+
         return Expr(terms)
 
     def __iadd__(self, other):
@@ -203,6 +219,7 @@ cdef class Expr:
             return buildGenExprObj(self) + other
         else:
             raise NotImplementedError
+
         return self
 
     def __mul__(self, other):
@@ -319,7 +336,6 @@ cdef class ExprCons:
         if op == 1: # <=
            if not self._rhs is None:
                raise TypeError('ExprCons already has upper bound')
-           assert self._rhs is None
            assert not self._lhs is None
 
            if not _is_number(other):
@@ -622,19 +638,53 @@ cdef class Constant(GenExpr):
 
 def exp(expr):
     """returns expression with exp-function"""
-    return UnaryExpr(Operator.exp, buildGenExprObj(expr))
+    if isinstance(expr, MatrixExpr):   
+        unary_exprs = np.empty(shape=expr.shape, dtype=object)
+        for idx in np.ndindex(expr.shape):
+            unary_exprs[idx] = UnaryExpr(Operator.exp, buildGenExprObj(expr[idx]))
+        return unary_exprs.view(MatrixGenExpr)
+    else:
+        return UnaryExpr(Operator.exp, buildGenExprObj(expr))
+
 def log(expr):
     """returns expression with log-function"""
-    return UnaryExpr(Operator.log, buildGenExprObj(expr))
+    if isinstance(expr, MatrixExpr):
+        unary_exprs = np.empty(shape=expr.shape, dtype=object)
+        for idx in np.ndindex(expr.shape):
+            unary_exprs[idx] = UnaryExpr(Operator.log, buildGenExprObj(expr[idx]))
+        return unary_exprs.view(MatrixGenExpr)
+    else:
+        return UnaryExpr(Operator.log, buildGenExprObj(expr))
+
 def sqrt(expr):
     """returns expression with sqrt-function"""
-    return UnaryExpr(Operator.sqrt, buildGenExprObj(expr))
+    if isinstance(expr, MatrixExpr):
+        unary_exprs = np.empty(shape=expr.shape, dtype=object)
+        for idx in np.ndindex(expr.shape):
+            unary_exprs[idx] = UnaryExpr(Operator.sqrt, buildGenExprObj(expr[idx]))
+        return unary_exprs.view(MatrixGenExpr)
+    else:
+        return UnaryExpr(Operator.sqrt, buildGenExprObj(expr))
+
 def sin(expr):
     """returns expression with sin-function"""
-    return UnaryExpr(Operator.sin, buildGenExprObj(expr))
+    if isinstance(expr, MatrixExpr):
+        unary_exprs = np.empty(shape=expr.shape, dtype=object)
+        for idx in np.ndindex(expr.shape):
+            unary_exprs[idx] = UnaryExpr(Operator.sin, buildGenExprObj(expr[idx]))
+        return unary_exprs.view(MatrixGenExpr)
+    else:
+        return UnaryExpr(Operator.sin, buildGenExprObj(expr))
+
 def cos(expr):
     """returns expression with cos-function"""
-    return UnaryExpr(Operator.cos, buildGenExprObj(expr))
+    if isinstance(expr, MatrixExpr):   
+        unary_exprs = np.empty(shape=expr.shape, dtype=object)
+        for idx in np.ndindex(expr.shape):
+            unary_exprs[idx] = UnaryExpr(Operator.cos, buildGenExprObj(expr[idx]))
+        return unary_exprs.view(MatrixGenExpr)
+    else:
+        return UnaryExpr(Operator.cos, buildGenExprObj(expr))
 
 def expr_to_nodes(expr):
     '''transforms tree to an array of nodes. each node is an operator and the position of the 

pyscipopt-5.4.1/src/pyscipopt/matrix.pxi

@@ -0,0 +1,139 @@
+"""
+# TODO Cythonize things. Improve performance.
+# TODO Add tests
+"""
+
+import numpy as np
+from typing import Union
+
+def _is_number(e):
+    try:
+        f = float(e)
+        return True
+    except ValueError: # for malformed strings
+        return False
+    except TypeError: # for other types (Variable, Expr)
+        return False
+
+class MatrixExpr(np.ndarray):
+    def sum(self, **kwargs):
+        return super().sum(**kwargs).item()
+    
+    def __le__(self, other: Union[float, int, Variable, np.ndarray, 'MatrixExpr']) -> np.ndarray:
+        
+        expr_cons_matrix = np.empty(self.shape, dtype=object)
+        if _is_number(other) or isinstance(other, Variable):
+            for idx in np.ndindex(self.shape):
+                expr_cons_matrix[idx] = self[idx] <= other
+        
+        elif isinstance(other, np.ndarray):
+            for idx in np.ndindex(self.shape):
+                expr_cons_matrix[idx] = self[idx] <= other[idx]    
+        else:
+            raise TypeError(f"Unsupported type {type(other)}")
+
+        return expr_cons_matrix.view(MatrixExprCons)
+
+    def __ge__(self, other: Union[float, int, Variable, np.ndarray, 'MatrixExpr']) -> np.ndarray:
+        
+        expr_cons_matrix = np.empty(self.shape, dtype=object)
+        if _is_number(other) or isinstance(other, Variable):
+            for idx in np.ndindex(self.shape):
+                expr_cons_matrix[idx] = self[idx] >= other
+        
+        elif isinstance(other, np.ndarray):
+            for idx in np.ndindex(self.shape):
+                expr_cons_matrix[idx] = self[idx] >= other[idx]    
+        else:
+            raise TypeError(f"Unsupported type {type(other)}")
+
+        return expr_cons_matrix.view(MatrixExprCons)
+
+    def __eq__(self, other: Union[float, int, Variable, np.ndarray, 'MatrixExpr']) -> np.ndarray:
+        
+        expr_cons_matrix = np.empty(self.shape, dtype=object)
+        if _is_number(other) or isinstance(other, Variable):
+            for idx in np.ndindex(self.shape):
+                expr_cons_matrix[idx] = self[idx] == other
+        
+        elif isinstance(other, np.ndarray):
+            for idx in np.ndindex(self.shape):
+                expr_cons_matrix[idx] = self[idx] == other[idx]    
+        else:
+            raise TypeError(f"Unsupported type {type(other)}")
+
+        return expr_cons_matrix.view(MatrixExprCons)
+    
+    def __add__(self, other):
+        return super().__add__(other).view(MatrixExpr)
+    
+    def __iadd__(self, other):
+        return super().__iadd__(other).view(MatrixExpr)
+
+    def __mul__(self, other):
+        return super().__mul__(other).view(MatrixExpr)
+
+    def __truediv__(self, other):
+        return super().__truediv__(other).view(MatrixExpr)
+    
+    def __rtruediv__(self, other):
+        return super().__rtruediv__(other).view(MatrixExpr)
+        
+    def __pow__(self, other):
+        return super().__pow__(other).view(MatrixExpr)
+    
+    def __sub__(self, other):
+        return super().__sub__(other).view(MatrixExpr)
+    
+    def __radd__(self, other):
+        return super().__radd__(other).view(MatrixExpr)
+    
+    def __rmul__(self, other):
+        return super().__rmul__(other).view(MatrixExpr)
+    
+    def __rsub__(self, other):
+        return super().__rsub__(other).view(MatrixExpr)
+    
+class MatrixGenExpr(MatrixExpr):
+    pass
+
+class MatrixExprCons(np.ndarray):
+
+    def __le__(self, other: Union[float, int, Variable, MatrixExpr]) -> np.ndarray:
+       
+        if not _is_number(other) or not isinstance(other, MatrixExpr):
+                raise TypeError('Ranged MatrixExprCons is not well defined!')
+
+        expr_cons_matrix = np.empty(self.shape, dtype=object)
+        if _is_number(other) or isinstance(other, Variable):
+            for idx in np.ndindex(self.shape):
+                expr_cons_matrix[idx] = self[idx] <= other
+        
+        elif isinstance(other, np.ndarray):
+            for idx in np.ndindex(self.shape):
+                expr_cons_matrix[idx] = self[idx] <= other[idx]    
+        else:
+            raise TypeError(f"Unsupported type {type(other)}")
+
+        return expr_cons_matrix.view(MatrixExprCons)
+
+    def __ge__(self, other: Union[float, int, Variable, MatrixExpr]) -> np.ndarray:
+        
+        if not _is_number(other) or not isinstance(other, MatrixExpr):
+                raise TypeError('Ranged MatrixExprCons is not well defined!')
+                
+        expr_cons_matrix = np.empty(self.shape, dtype=object)
+        if _is_number(other) or isinstance(other, Variable):
+            for idx in np.ndindex(self.shape):
+                expr_cons_matrix[idx] = self[idx] >= other
+        
+        elif isinstance(other, np.ndarray):
+            for idx in np.ndindex(self.shape):
+                expr_cons_matrix[idx] = self[idx] >= other[idx]    
+        else:
+            raise TypeError(f"Unsupported type {type(other)}")
+
+        return expr_cons_matrix.view(MatrixExprCons)
+
+    def __eq__(self, other):
+        raise TypeError