A Python library for prototyping with SAT oracles
Project description
A Python library providing a simple interface to a number of state-of-art Boolean satisfiability (SAT) solvers and a few types of cardinality encodings. The purpose of PySAT is to enable researchers working on SAT and its applications and generalizations to easily prototype with SAT oracles in Python while exploiting incrementally the power of the original low-level implementations of modern SAT solvers.
With PySAT it should be easy for you to implement a MaxSAT solver, an MUS/MCS extractor/enumerator, or any tool solving an application problem with the (potentially multiple) use of a SAT oracle.
Currently, the following SAT solvers are supported (currently, for Minisat-based solvers only core versions are integrated):
Glucose (3.0)
Glucose (4.1)
Lingeling (bbc-9230380-160707)
Minicard (1.2)
Minisat (2.2 release)
Minisat (GitHub version)
Cardinality encodings supported are implemented in C++ and include:
pairwise [7]
bitwise [7]
sequential counters [8]
sorting networks [3]
cardinality networks [1]
ladder [4]
totalizer [2]
modulo totalizer [6]
iterative totalizer [5]
Usage
Boolean variables in PySAT are represented as natural identifiers, e.g. numbers from \(\mathbb{N}_{>0}\). A literal in PySAT is assumed to be an integer, e.g. -1 represents a literal \(\neg{x_1}\) while \(5\) represents a literal \(x_5\). A clause is a list of literals, e.g. [-3, -2] is a clause \((\neg{x_3} \vee \neg{x_2})\).
The following is a trivial example of PySAT usage:
>>> from pysat.solvers import Glucose3
>>>
>>> g = Glucose3()
>>> g.add_clause([-1, 2])
>>> g.add_clause([-2, 3])
>>> print g.solve()
>>> print g.get_model()
...
True
[-1, -2, -3]
Another example shows how to extract unsatisfiable cores from a SAT solver given an unsatisfiable set of clauses:
>>> from pysat.solvers import Minisat22
>>>
>>> with Minisat22(bootstrap_with=[[-1, 2], [-2, 3]]) as m:
... print m.solve(assumptions=[1, -3])
... print m.get_core()
...
False
[-3, 1]
Finally, the following example gives an idea of how one can extract a proof (supported by Glucose3, Glucose4, and Lingeling only):
>>> from pysat.formula import CNF
>>> from pysat.solvers import Lingeling
>>>
>>> formula = CNF()
>>> formula.append([-1, 2])
>>> formula.append([1, -2])
>>> formula.append([-1, -2])
>>> formula.append([1, 2])
>>>
>>> with Lingeling(bootstrap_with=formula.clauses, with_proof=True) as l:
... if l.solve() == False:
... print(l.get_proof())
...
['2 0', '1 0', '0']
PySAT usage is detailed in the provided examples. For instance, one can see there simple PySAT-based implementations of
Fu&Malik algorithm for MaxSAT [9]
RC2/OLLITI algorithm for MaxSAT [13]
CLD-like algorithm for MCS extraction and enumeration [11]
LBX-like algorithm for MCS extraction and enumeration [12]
Deletion-based MUS extraction [10]
Zhaohui Fu, Sharad Malik. On Solving the Partial MAX-SAT Problem. SAT 2006. pp. 252-265
Joao Marques Silva. Minimal Unsatisfiability: Models, Algorithms and Applications. ISMVL 2010. pp. 9-14
Joao Marques-Silva, Federico Heras, Mikolas Janota, Alessandro Previti, Anton Belov. On Computing Minimal Correction Subsets. IJCAI 2013. pp. 615-622
Carlos Mencia, Alessandro Previti, Joao Marques-Silva. Literal-Based MCS Extraction. IJCAI 2015. pp. 1973-1979
António Morgado, Carmine Dodaro, Joao Marques-Silva. Core-Guided MaxSAT with Soft Cardinality Constraints. CP 2014. pp. 564-573. CP 2014. pp. 564-573
The examples can also be accessed as a subpackage of PySAT:
>>> from pysat.formula import CNF
>>> from pysat.examples.lbx import LBX
>>>
>>> formula = CNF(from_file='input.cnf')
>>> mcsls = LBX(formula)
>>>
>>> for mcs in mcsls.enumerate():
... print mcs
Alternatively, they can be used as standalone executables, e.g. like this:
lbx.py -e all -d -s g4 -v another-input.wcnf
Installation
The simplest way to get and start using PySAT is to install the latest stable release of PySAT from PyPI:
pip install python-sat
Alternatively, you can clone this repository and do the following with your local copy:
python setup.py install
or (if you choose a directory to install PySAT into)
python setup.py install --prefix=<where-to-install>
Both options (i.e. via pip or setup.py) are supposed to download and compile all the supported SAT solvers as well as prepare the installation of PySAT.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file python-sat-0.1.3dev3.tar.gz
.
File metadata
- Download URL: python-sat-0.1.3dev3.tar.gz
- Upload date:
- Size: 101.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 231981220e1c930e590519372a3d649a0dc69d0272251dc472cbcf9dded994fa |
|
MD5 | 12e2421fc6471f031fb92978b9e6a070 |
|
BLAKE2b-256 | 46b8a624543ded81599e2a800d326b5484e011339dbe0ec70ef14ee40c74e8ce |