The code uses MiniSat as the SAT solver, CPLEX from IBM as the MIPS solver, MaxHS for MaxSAT solving, and a version of Gauss-Jordan elimination to perform CDCL(T). For our research paper PDF, see here, published at Knowledge Representation and Reasoning (KR) 2021 (Bibtex)
You need the CPLEX static libraries to link against. CPLEX is available from IBM under their academic Initiative program. It is free to faculty members and graduate students in academia, see here.
You can apply for their academic initiative program and then then you can download CPLEX and other IBM software.
Use make config VAR=defn or edit config.mk directly. Required variable settings:
- Linux:
LINUX_CPLEXLIBDIR=<path to CPLEX library>the directory on your linux system that contains libcplex.a and libilocplex.a (the makefile does a static build).LINUX_CPLEXINCDIR=<path to CPLEX headers> - MacOS:
DARWIN_CPLEXLIBDIR=<path to CPLEX library>the directory on your MAC system that contains libcplex.a and libilocplex.a (the makefile does a static build),DARWIN_CPLEXINCDIR=<path to CPLEX headers>
After the above configuration, you can:
make install
The system expects a CNF-XOR input, which is the same as the WDIMACS format with the extension that you can add XOR constraints just like with CryptoMiniSat, and the weight must be provided after the 'x'. Note that all XOR constraints must be hard constraints. Furthermore, XOR constraints must be at least 3-long, as 2-long XORs are trivial to write in CNF as two binary constraints.
For example, let's take the following input file:
p wcnf 4 6 10
5 1 2 -3 0
5 1 -2 3 0
5 -1 2 3 0
5 -1 -2 -3 0
x 10 1 2 3 0
x 10 -1 3 4 0
This file contains four variables and six constraints, and promises to give
weights with a hard constraint having a weight of 10 (hence the header p wcnf 4 6 10). The first four constraints say that v1 or v2 or NOT v3 = true,
v1 or NOT v2 or v3 = true, etc. all being soft constraint with a
weight of 5. The last two lines say that v1 XOR x2 = true and
v1 XOR v3 XOR v4 = false, both of which have a
weight of 10, and are hard constraints.
When you run the tool on the problem above, you get the following output:
git clone https://github.com/meelgroup/gaussmaxhs
cd gaussmaxhs
make
cd build/bin/release
./maxhs input.wcnf
[...]
o 5
s OPTIMUM FOUND
v -1 -2 3 4
[...]
This indicates that the lowest cost has been found, and it's the solution v1=false, v2=false, v3=true, v4=true. The cost of this solution is 5, because one of the soft constraints had to be violated, as together they clash with the first XOR constraint.
You will find generate-netrel.sh and generate-spin.sh problem generators under the default binary location build/release/bin. You can run these scripts to generate example Spin Glass and Network Reliability problems for you.
To run the generate-netrel.sh script, you will need to extract the files from build/release/bin/network-reliability/net-rel.tar.gz first. The files should all be extracted under build/release/bin/network-reliability/, e.g. one file should be build/release/bin/network-reliability/Net27_90_22_count_118.cnf.
You can find various fuzzers for the GaussMaxHS system under build/release/bin, the default binary location. You can run fuzz.sh to fuzz the system against MaxHS without Gauss-Jordan elimination. While this fuzzing is incomplete, it should find most bugs. You will need CryptoMiniSat5 installed, as the script uses CryptoMiniSat to check for errors with GJE.