Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
- Expression fields now use concrete Cython types (`double`/`list`), so values are converted on construction
- Methods taking a list of variables (e.g. `addConsKnapsack()`) no longer convert it to a NumPy array to check its dimension
- Speed up `PowExpr._evaluate` via the C-level API
- Add shortcut path for `Term()` and `Term(x)`to speed up `Term.__init__`, `Term.__eq__`, and `Term.__mul__`
- `PowExpr._evaluate` now raises `ValueError("math domain error")` for a negative base with a non-integer exponent and `OverflowError` when the result overflows.
### Removed
- Removed support for Python 3.8
Expand Down
63 changes: 47 additions & 16 deletions src/pyscipopt/expr.pxi
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ from cpython.long cimport PyLong_Check
from cpython.number cimport PyNumber_Check
from cpython.object cimport Py_LE, Py_EQ, Py_GE, Py_TYPE
from cpython.ref cimport PyObject
from cpython.tuple cimport PyTuple_GET_ITEM
from cpython.tuple cimport PyTuple_GET_ITEM, PyTuple_GET_SIZE
from libc.math cimport cos as c_cos
from libc.math cimport exp as c_exp
from libc.math cimport fabs as c_fabs
Expand All @@ -79,8 +79,31 @@ cdef class Term:
cdef Py_ssize_t hashval

def __init__(self, *vartuple: Variable):
self.vartuple = tuple(sorted(vartuple, key=lambda v: v.getIndex()))
self.hashval = <Py_ssize_t>hash(tuple(v.ptr() for v in self.vartuple))
cdef Py_ssize_t i, n = PyTuple_GET_SIZE(vartuple)
cdef Variable var
cdef object item

for i in range(n):
item = <object>PyTuple_GET_ITEM(vartuple, i)
if not isinstance(item, Variable):
raise TypeError(
f"Term() arguments must be Variable, got {type(item).__name__}"
)
Comment on lines 81 to +91

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The following used to return an error, but now segfaults:

  • Term(None)
  • Term(x) * None
  • m.delVar(None)

fixed


if n == 0:
# The constant term; the empty args tuple is already canonical.
self.vartuple = vartuple
self.hashval = <Py_ssize_t>hash(vartuple)

elif n == 1:
# Avoid sorting single variable
var = <Variable>PyTuple_GET_ITEM(vartuple, 0)
self.vartuple = vartuple
self.hashval = <Py_ssize_t>hash((var.ptr(),))

else:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should Term forbid n > 1? Term(x, y) (n>1) cannot be initialized directly, it’s always comes from Term.mul

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But users could still use it to access the coefficients of a quadratic constraint, for example, right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about this, @Zeroto521 ? It's not a big deal either way for me

@Zeroto521 Zeroto521 Nov 22, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer Term should receive one single variable or a None.
The normal user would call x^3 instead of Term(x, x, x) and they don’t need to know how to import Term. Term is kind of an inner class.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, we can change this. But I think there's a test that'd need to change as well.

self.vartuple = tuple(sorted(vartuple, key=lambda v: v.getIndex()))
self.hashval = <Py_ssize_t>hash(tuple(v.ptr() for v in self.vartuple))

def __getitem__(self, idx):
return self.vartuple[idx]
Expand All @@ -94,12 +117,12 @@ cdef class Term:
if <type>Py_TYPE(other) is not Term:
return False

cdef int n = len(self)
cdef Py_ssize_t n = PyTuple_GET_SIZE(self.vartuple)
cdef Term _other = <Term>other
if n != len(_other) or self.hashval != _other.hashval:
if n != PyTuple_GET_SIZE(_other.vartuple) or self.hashval != _other.hashval:
return False

cdef int i
cdef Py_ssize_t i
cdef Variable var1, var2
for i in range(n):
var1 = <Variable>PyTuple_GET_ITEM(self.vartuple, i)
Expand All @@ -109,41 +132,49 @@ cdef class Term:
return True

def __len__(self):
return len(self.vartuple)
return PyTuple_GET_SIZE(self.vartuple)

def __mul__(self, Term other):
# NOTE: This merge algorithm requires a sorted `Term.vartuple`.
# This should be ensured in the constructor of Term.
cdef int n1 = len(self)
cdef int n2 = len(other)
cdef Py_ssize_t n1 = PyTuple_GET_SIZE(self.vartuple)
cdef Py_ssize_t n2 = PyTuple_GET_SIZE(other.vartuple)
if n1 == 0: return other
if n2 == 0: return self

cdef list vartuple = [None] * (n1 + n2)
cdef int i = 0, j = 0, k = 0
cdef Py_ssize_t m = n1 + n2
cdef list vartuple = [None] * m
cdef list ptrs = [None] * m
cdef Py_ssize_t i = 0, j = 0, k = 0
cdef Variable var1, var2
while i < n1 and j < n2:
var1 = <Variable>PyTuple_GET_ITEM(self.vartuple, i)
var2 = <Variable>PyTuple_GET_ITEM(other.vartuple, j)
if var1.getIndex() <= var2.getIndex():
vartuple[k] = var1
ptrs[k] = var1.ptr()
i += 1
else:
vartuple[k] = var2
ptrs[k] = var2.ptr()
j += 1
k += 1
while i < n1:
vartuple[k] = <Variable>PyTuple_GET_ITEM(self.vartuple, i)
var1 = <Variable>PyTuple_GET_ITEM(self.vartuple, i)
vartuple[k] = var1
ptrs[k] = var1.ptr()
i += 1
k += 1
while j < n2:
vartuple[k] = <Variable>PyTuple_GET_ITEM(other.vartuple, j)
var2 = <Variable>PyTuple_GET_ITEM(other.vartuple, j)
vartuple[k] = var2
ptrs[k] = var2.ptr()
j += 1
k += 1

cdef Term res = Term.__new__(Term)
res.vartuple = tuple(vartuple)
res.hashval = <Py_ssize_t>hash(tuple(v.ptr() for v in res.vartuple))
res.hashval = <Py_ssize_t>hash(tuple(ptrs))
return res

def __repr__(self) -> str:
Expand All @@ -153,11 +184,11 @@ cdef class Term:
cdef double res = 1.0
cdef SCIP* scip_ptr = sol.scip
cdef SCIP_SOL* sol_ptr = sol.sol
cdef int i = 0, n = len(self)
cdef Py_ssize_t i, n = PyTuple_GET_SIZE(self.vartuple)
cdef Variable var

for i in range(n):
var = <Variable>self.vartuple[i]
var = <Variable>PyTuple_GET_ITEM(self.vartuple, i)
res *= SCIPgetSolVal(scip_ptr, sol_ptr, var.scip_var)
if res == 0: # early stop
return 0.0
Expand Down
3 changes: 3 additions & 0 deletions src/pyscipopt/scip.pxd
Original file line number Diff line number Diff line change
Expand Up @@ -2301,6 +2301,9 @@ cdef class Variable(Expr):
@staticmethod
cdef create(SCIP_VAR* scipvar)

cpdef size_t ptr(self) noexcept
cpdef int getIndex(self) noexcept

cdef class Constraint:
cdef SCIP_CONS* scip_cons
# can be used to store problem data
Expand Down
4 changes: 2 additions & 2 deletions src/pyscipopt/scip.pxi
Original file line number Diff line number Diff line change
Expand Up @@ -1595,7 +1595,7 @@ cdef class Variable(Expr):
cdef Variable copy(self, bint copy=True):
return self

def ptr(self):
cpdef size_t ptr(self) noexcept:
Comment thread
Joao-Dionisio marked this conversation as resolved.
Resolved
return <size_t>(self.scip_var)

def __repr__(self):
Expand Down Expand Up @@ -1730,7 +1730,7 @@ cdef class Variable(Expr):
"""
return SCIPvarIsInLP(self.scip_var)

def getIndex(self):
cpdef int getIndex(self) noexcept:
"""
Retrieve the unique index of the variable.

Expand Down
19 changes: 19 additions & 0 deletions tests/test_expr.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
GenExpr,
MatrixGenExpr,
ProdExpr,
Term,
)


Expand Down Expand Up @@ -680,3 +681,21 @@ def test_neg():
assert str(neg_expr) == "prod(1.0,sqrt(sum(0.0,prod(1.0,x))))"

assert str(-Constant(3.0)) == "-3.0"


def test_term_rejects_non_variable_arguments(model):
m, x, y, z = model

with pytest.raises(TypeError, match="must be Variable"):
Term(None)
with pytest.raises(TypeError, match="must be Variable"):
Term(1)
with pytest.raises(TypeError, match="must be Variable"):
Term(x, None)
with pytest.raises(TypeError, match="must be Variable"):
Term(None, x)

# Valid constructions are unaffected.
assert len(Term()) == 0
assert len(Term(x)) == 1
assert Term(x, y) == Term(y, x)
Loading