pycsp3-solvers-extra 0.7.7

Extra solver backends for pycsp3 (OR-Tools, IBM CPO, Z3, Pumpkin)

pycsp3-solvers-extra

Extension library that adds extra solver backends to pycsp3.

Supported Solvers

• OR-Tools CP-SAT - Google's constraint programming solver
• IBM DOcplex CP Optimizer - IBM's CP solver (requires CPLEX Studio)
• Z3 - Microsoft's SMT solver with optimization support
• Pumpkin - Lazy clause generation CP solver written in Rust (WIP)

Installation

pip install pycsp3-solvers-extra

Install with specific solver backends:

# Install with OR-Tools
pip install pycsp3-solvers-extra[ortools]

# Install with Z3
pip install pycsp3-solvers-extra[z3]

# Install with CPO (requires IBM CPLEX Studio installed separately)
pip install pycsp3-solvers-extra[cpo]

# Install with Pumpkin
pip install pycsp3-solvers-extra[pumpkin]

# Install all backends
pip install pycsp3-solvers-extra[all]

Dependencies

• pycsp3 - base constraint modeling library
• ortools - for OR-Tools backend
• z3-solver - for Z3 backend
• docplex - for CPO backend (requires IBM CPLEX Studio installed separately)
• pumpkin-solver - for Pumpkin backend

Usage

from pycsp3 import *
from pycsp3_solvers_extra import solve

# Define your model
x = VarArray(size=3, dom=range(1, 10))
satisfy(AllDifferent(x))
minimize(Sum(x))

# Solve with OR-Tools
status = solve(solver="ortools")

# Or solve with Z3
status = solve(solver="z3")

# Or solve with CPO
status = solve(solver="cpo")

# Or solve with Pumpkin
status = solve(solver="pumpkin")

# Of course, you still can use the native supported pycsp3 solvers as well ('ace', 'choco')
status = solve(solver="ace")

# Access solution values
print([v.value for v in x])

Warm Start (Solution Hints)

Provide hints from a previous solution to guide the solver search:

from pycsp3 import *
from pycsp3_solvers_extra import solve

x = VarArray(size=4, dom=range(10))
satisfy(AllDifferent(x))

# Provide hints as {var_id: value}
hints = {'x[0]': 5, 'x[1]': 2, 'x[2]': 8, 'x[3]': 1}
status = solve(solver='ortools', hints=hints)

Warm start is supported by OR-Tools, CPO, and ACE/Choco. Z3 and Pumpkin do not support hints natively.

Loading XCSP3 instances

from pycsp3 import clear, solution
from pycsp3_solvers_extra import load, solve

clear()
load("path/to/instance.xml.lzma")  # or .xml
status = solve(solver="ortools", time_limit=10)
print(status)
print(solution())

API

solve(
    solver="ortools",  # "ortools", "z3", "cpo", "pumpkin", "ace", or "choco"
    time_limit=None,   # seconds
    sols=None,         # number of solutions to find
    verbose=0,         # verbosity level (0-2)
    options="",        # solver-specific options
    hints=None,        # warm start hints as {var_id: value}
    output_dir=None    # directory for generated XCSP3/log files (defaults to temp)
)

Returns TypeStatus.SAT, TypeStatus.OPTIMUM, TypeStatus.UNSAT, or TypeStatus.UNKNOWN.

Examples

See the examples/ directory:

python examples/send_more_money.py --solvers ortools z3 cpo
python examples/solve_xcsp.py path/to/instance.xml.lzma --solver z3 --time-limit 10
python examples/solve_xcsp.py path/to/instance.xml.lzma --solver ace --options="-positive=CT -sts"

Running Tests

pytest tests/ -v

License

This project is licensed under the MIT License.