Merge branch 'master' into debugSol

Author: Joao-Dionisio

.github/workflows/coverage.yml

@@ -40,8 +40,9 @@ jobs:
 
       - name: Install PySCIPOpt
         run: |
-          export CFLAGS="-O0 -ggdb" # disable compiler optimizations for faster builds
-          python -m pip install .
+          export CFLAGS="-O0 -ggdb -Wall -Wextra -Werror" # Debug mode. More warnings. Warnings as errors.
+          python -m pip install . -v 2>&1 | tee build.log
+          grep -i "warning" build.log || true
 
       - name: Run pyscipopt tests
         run: |

CHANGELOG.md

@@ -2,14 +2,22 @@
 
 ## Unreleased
 ### Added
-- Added enableDebugSol() and disableDebugSol() for controlling the debug solution mechanism if DEBUGSOL=true
 - More support for AND-Constraints
 - Added support for knapsack constraints
 - Added isPositive(), isNegative(), isFeasLE(), isFeasLT(), isFeasGE(), isFeasGT(), isHugeValue(), and tests
 - Added SCIP_LOCKTYPE, addVarLocksType(), getNLocksDown(), getNLocksUp(), getNLocksDownType(), getNLocksUpType(), and tests
+- Added addMatrixConsIndicator(), and tests
+- Added SCIPvarMarkRelaxationOnly, SCIPvarIsRelaxationOnly, SCIPvarMarkDeletable, SCIPvarIsDeletable, and tests
+- Wrapped SCIPgetNLPBranchCands
+- Added getConsVals() to get coefficients of any linear type constraint
+- Generalized getLhs() and getRhs() to additionally support any linear type constraint
+- Added recipe for getting local constraints
+- Added enableDebugSol() and disableDebugSol() for controlling the debug solution mechanism if DEBUGSOL=true
 ### Fixed
 - Raised an error when an expression is used when a variable is required
+- Fixed some compile warnings
 ### Changed
+- MatrixExpr.sum() now supports axis arguments and can return either a scalar or MatrixExpr depending on the result dimensions
 ### Removed
 
 ## 5.5.0 - 2025.05.06

INSTALL.md

@@ -26,7 +26,7 @@ If installing SCIP from source or using PyPI with a python and operating system
 you need to specify the install location using the environment variable
 `SCIPOPTDIR`:
 
--   on Linux and OS X:\
+-   on Linux and MacOS:\
     `export SCIPOPTDIR=<path_to_install_dir>`
 -   on Windows:\
     `set SCIPOPTDIR=<path_to_install_dir>` (**cmd**, **Cmder**, **WSL**)\
@@ -45,8 +45,9 @@ contains the corresponding header files:
         > nlpi
         > ...
 
-Please note that some Mac configurations require adding the library installation path to `DYLD_LIBRARY_PATH` when using a locally installed version of SCIP.
+On MacOS, to ensure that the SCIP dynamic library can be located at runtime by PySCIPOpt, you should add your SCIP installation path to the ``DYLD_LIBRARY_PATH`` environment variable by running:
 
+`export DYLD_LIBRARY_PATH="<path_to_install_dir>/lib:$DYLD_LIBRARY_PATH"`
 
 When building SCIP from source using Windows it is highly recommended to use the [Anaconda Python
 Platform](https://www.anaconda.com/).
@@ -75,7 +76,7 @@ at runtime by adjusting your `PATH` environment variable:
 
 -   on Windows: `set PATH=%PATH%;%SCIPOPTDIR%\bin`
 
-On Linux and OS X this is encoded in the generated PySCIPOpt library and
+On Linux and MacOS this is encoded in the generated PySCIPOpt library and
 therefore not necessary.
 
 Building everything from source

docs/build.rst

@@ -100,6 +100,15 @@ For Linux and MacOS systems set the variable with the following command:
 
   export SCIPOPTDIR=<path_to_install_dir>
 
+.. note::
+
+  For macOS users, to ensure that the SCIP dynamic library can be found at runtime by PySCIPOpt,
+  you should add your SCIP installation path to the ``DYLD_LIBRARY_PATH`` environment variable by running:
+
+  .. code-block::
+
+    export DYLD_LIBRARY_PATH="<path_to_install_dir>/lib:$DYLD_LIBRARY_PATH"
+
 For Windows use the following command:
 
 .. code-block:: bash

src/pyscipopt/event.pxi

@@ -39,7 +39,7 @@ cdef class Eventhdlr:
 
 
 # local helper functions for the interface
-cdef Eventhdlr getPyEventhdlr(SCIP_EVENTHDLR* eventhdlr) noexcept with gil:
+cdef Eventhdlr getPyEventhdlr(SCIP_EVENTHDLR* eventhdlr):
     cdef SCIP_EVENTHDLRDATA* eventhdlrdata
     eventhdlrdata = SCIPeventhdlrGetData(eventhdlr)
     return <Eventhdlr>eventhdlrdata

src/pyscipopt/expr.pxi

@@ -358,7 +358,7 @@ cdef class ExprCons:
     def __repr__(self):
         return 'ExprCons(%s, %s, %s)' % (self.expr, self._lhs, self._rhs)
 
-    def __nonzero__(self):
+    def __bool__(self):
         '''Make sure that equality of expressions is not asserted with =='''
 
         msg = """Can't evaluate constraints as booleans.

src/pyscipopt/lp.pxi

@@ -58,7 +58,8 @@ cdef class LP:
         """Adds a single column to the LP.
 
         Keyword arguments:
-        entries -- list of tuples, each tuple consists of a row index and a coefficient
+        entries -- a list of tuples; if p is the index of the new column, then each tuple (i, k) indicates that
+        A[i][p] = k, where A is the constraint matrix and k is a nonzero entry.
         obj     -- objective coefficient (default 0.0)
         lb      -- lower bound (default 0.0)
         ub      -- upper bound (default infinity)
@@ -85,7 +86,8 @@ cdef class LP:
         """Adds multiple columns to the LP.
 
         Keyword arguments:
-        entrieslist -- list containing lists of tuples, each tuple contains a coefficient and a row index
+        entrieslist -- a list of lists, where the j-th inner list contains tuples (i, k) such that A[i][p] = k,
+        where A is the constraint matrix, p is the index of the j-th new column, and k is a nonzero entry.
         objs  -- objective coefficient (default 0.0)
         lbs   -- lower bounds (default 0.0)
         ubs   -- upper bounds (default infinity)
@@ -147,7 +149,8 @@ cdef class LP:
         """Adds a single row to the LP.
 
         Keyword arguments:
-        entries -- list of tuples, each tuple contains a coefficient and a column index
+        entries -- a list of tuples; if q is the index of the new row, then each tuple (j, k) indicates that
+        A[q][j] = k, where A is the constraint matrix and k is a nonzero entry.
         lhs     -- left-hand side of the row (default 0.0)
         rhs     -- right-hand side of the row (default infinity)
         """
@@ -172,7 +175,8 @@ cdef class LP:
         """Adds multiple rows to the LP.
 
         Keyword arguments:
-        entrieslist -- list containing lists of tuples, each tuple contains a coefficient and a column index
+        entrieslist -- a list of lists, where the i-th inner list contains tuples (j, k) such that A[q][j] = k,
+        where A is the constraint matrix, q is the index of the i-th new row, and k is a nonzero entry.
         lhss        -- left-hand side of the row (default 0.0)
         rhss        -- right-hand side of the row (default infinity)
         """

src/pyscipopt/matrix.pxi

@@ -17,8 +17,13 @@ def _is_number(e):
 
 class MatrixExpr(np.ndarray):
     def sum(self, **kwargs):
-        return super().sum(**kwargs).item()
-    
+        """
+        Based on `numpy.ndarray.sum`, but returns a scalar if the result is a single value.
+        This is useful for matrix expressions where the sum might reduce to a single value.
+        """
+        res = super().sum(**kwargs)
+        return res if res.size > 1 else res.item()
+
     def __le__(self, other: Union[float, int, Variable, np.ndarray, 'MatrixExpr']) -> np.ndarray:
 
         expr_cons_matrix = np.empty(self.shape, dtype=object)

src/pyscipopt/recipes/getLocalConss.py

@@ -0,0 +1,50 @@
+from pyscipopt import Model, Constraint
+
+def getLocalConss(model: Model, node = None) -> list[list[Constraint]]:
+    """
+    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 node is None:
+        assert model.getStageName() in ["INITPRESOLVE", "PRESOLVING", "EXITPRESOLVE", "SOLVING"], "Model cannot be called in stage %s." % model.getStageName()
+        cur_node = model.getCurrentNode()
+    else:
+        cur_node = node
+
+    added_conss = []
+    while cur_node is not None:
+        added_conss = cur_node.getAddedConss() + added_conss
+        cur_node = cur_node.getParent()
+    
+    return [model.getConss(), added_conss]
+
+def getNLocalConss(model: Model, node = None) -> tuple[int,int]:
+    """
+    Returns the number of local constraints of a node.
+
+    Parameters
+    ----------
+    model : Model
+        The model from which to retrieve the number of local constraints.
+    node : Node, optional
+        The node from which to retrieve the number of local constraints. If not provided, the current node is used.
+
+    Returns
+    -------
+    list[int]
+        A list of the number of local constraints. First entry is the number of global constraints, second entry is the number of all the added constraints.
+    """
+    local_conss = getLocalConss(model, node)
+    return [len(local_conss[0]), len(local_conss[1])]

src/pyscipopt/recipes/nonlinear.py

@@ -1,6 +1,5 @@
 from pyscipopt import Model
 
-
 def set_nonlinear_objective(model: Model, expr, sense="minimize"):
     """
     Takes a nonlinear expression and performs an epigraph reformulation.