CPMpy pysat interace (
Interface to PySAT’s API
PySAT is a Python (2.7, 3.4+) toolkit, which aims at providing a simple and unified interface to a number of state-of-art Boolean satisfiability (SAT) solvers as well as to a variety of cardinality and pseudo-Boolean encodings. https://pysathq.github.io/
This solver can be used if the model only has Boolean variables, and only logical constraints (and,or,xor,implies,==,!=) or cardinality constraints.
Documentation of the solver’s own Python API: https://pysathq.github.io/docs/html/api/solvers.html
WARNING: CPMpy uses ‘model’ to refer to a constraint specification, the PySAT docs use ‘model’ to refer to a solution.
List of classes¶
Interface to PySAT's API
- class cpmpy.solvers.pysat.CPM_pysat(cpm_model=None, subsolver=None)¶
Interface to PySAT’s API
Requires that the ‘python-sat’ python package is installed: $ pip install python-sat
See detailed installation instructions at: https://pysathq.github.io/installation.html
Creates the following attributes (see parent constructor for more): pysat_vpool: a pysat.formula.IDPool for the variable mapping pysat_solver: a pysat.solver.Solver() (default: glucose4)
For use with s.solve(assumptions=[…]). Only meaningful if the solver returned UNSAT. In that case, get_core() returns a small subset of assumption variables that are unsat together.
CPMpy will return only those assumptions which are False (in the UNSAT core)
Note that there is no guarantee that the core is minimal. More advanced Minimal Unsatisfiable Subset are available in the ‘examples’ folder on GitHub
Post the given expression to the solver as objective to maximize
maximize() can be called multiple times, only the last one is stored
Post the given expression to the solver as objective to minimize
minimize() can be called multiple times, only the last one is stored
- objective(expr, minimize)¶
Post the given expression to the solver as objective to minimize/maximize
expr: Expression, the CPMpy expression that represents the objective function
minimize: Bool, whether it is a minimization problem (True) or maximization problem (False)
‘objective()’ can be called multiple times, only the last one is stored
Returns the value of the objective function of the latest solver run on this model
an integer or ‘None’ if it is not run, or a satisfaction problem
- solution_hint(cpm_vars, vals)¶
PySAT supports warmstarting the solver with a feasible solution
In PySAT, this is called setting the ‘phases’ or the ‘polarities’ of literals
cpm_vars – list of CPMpy variables
vals – list of (corresponding) values for the variables
- solve(time_limit=None, assumptions=None)¶
Call the PySAT solver
Arguments: - time_limit: maximum solve time in seconds (float, optional). Auto-interrups in case the
runtime exceeds given time_limit. Warning: the time_limit is not very accurate at subsecond level
- assumptions: list of CPMpy Boolean variables that are assumed to be true.
For use with s.get_core(): if the model is UNSAT, get_core() returns a small subset of assumption variables that are unsat together. Note: the PySAT interface is statefull, so you can incrementally call solve() with assumptions and it will reuse learned clauses
- solveAll(display=None, time_limit=None, solution_limit=None, **kwargs)¶
Compute all solutions and optionally display the solutions.
This is the generic implementation, solvers can overwrite this with a more efficient native implementation
- display: either a list of CPMpy expressions, OR a callback function, called with the variables after value-mapping
default/None: nothing displayed
time_limit: stop after this many seconds (default: None)
solution_limit: stop after this many solutions (default: None)
any other keyword argument
Returns: number of solutions found
Creates solver variable for cpmpy variable or returns from cache if previously created
Transforms cpm_var into CNF literal using self.pysat_vpool (positive or negative integer)
so vpool is the varmap (we don’t use _varmap here)
Like solver_var() but for arbitrary shaped lists/tensors
- static solvernames()¶
Returns solvers supported by PySAT on your system
- static supported()¶
Check for support in current system setup. Return True if the system has package installed or supports solver, else returns False.
[bool]: Solver support by current system setup.