- Notifications
You must be signed in to change notification settings - Fork193
msoos/cryptominisat
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
This system provides CryptoMiniSat, an advanced incremental SAT solver. Thesystem has 3 interfaces: command-line, C++ library and python. The command-lineinterface takes acnfas an input in theDIMACS formatwith the extension of XOR clauses. The C++ and python interface mimics this andalso allows for incremental use: assumptions and multiplesolve calls. A Cand a Rust compatible wrapper is also provided.
When citing, always reference ourSAT 2009 conferencepaper,bibtex record ishere.
Use of therelease binaries isstrongly encouraged, as Ganak requires a specific set of libraries to beinstalled. The second best thing to use is Nix. Simplyinstallnix and then:
nix shell github:msoos/cryptominisat
Then you will havecryptominisat binary available and ready to use.
If this is somehow not what you want, you can also build it. See theGitHubAction for thespecific set of steps.
You can also run CryptoMiniSat from your web browser, without installinganything,here.
Let's take the file:
p cnf 3 31 0-2 0-1 2 3 0The file has 3 variables and 3 clauses, this is reflected in the headerp cnf 3 3 which gives the number of variables as the first number and the number ofclauses as the second. Every clause is ended by '0'. The clauses say: 1 must beTrue, 2 must be False, and either 1 has to be False, 2 has to be True or 3 hasto be True. The only solution to this problem is:
cryptominisat5 --verb 0 file.cnfs SATISFIABLEv 1 -2 3 0Which means, that setting variable 1 True, variable 2 False and variable 3 Truesatisfies the set of constraints (clauses) in the CNF. If the file hadcontained:
p cnf 3 41 0-2 0-3 0-1 2 3 0Then there is no solution and the solver returnss UNSATISFIABLE.
The python module works with both Python 3. Just execute:
pip3 install pycryptosat
You can then use it in incremental mode as:
>>>frompycryptosatimportSolver>>>s=Solver()>>>s.add_clause([1])>>>s.add_clause([-2])>>>s.add_clause([-1,2,3])>>>sat,solution=s.solve()>>>printsatTrue>>>printsolution(None,True,False,True)>>>sat,solution=s.solve([-3])>>printsatFalse>>>sat,solution=s.solve()>>>printsatTrue>>>s.add_clause([-3])>>>sat,solution=s.solve()>>>printsatFalse
We can also try to assume any variable values for a single solver run:
>>>sat,solution=s.solve([-3])>>>printsatFalse>>>printsolutionNone>>>sat,solution=s.solve()>>>printsatTrue>>>printsolution(None,True,False,True)
If you want to build the python module, you can do this:
sudo apt-get install build-essentialsudo apt-get install python3-setuptools python3-devgit clone https://github.com/msoos/cryptominisatpython -m buildpip install dist/pycryptosat-*.whlThe library uses a variable numbering scheme that starts from 0. Since 0 cannotbe negated, the classLit is used as:Lit(variable_number, is_negated). Assuch, the 1st CNF above would become:
#include<cryptominisat5/cryptominisat.h>#include<assert.h>#include<vector>using std::vector;usingnamespaceCMSat;intmain(){ SATSolver solver; vector<Lit> clause;//Let's use 4 threads solver.set_num_threads(4);//We need 3 variables. They will be: 0,1,2//Variable numbers are always trivially increasing solver.new_vars(3);//add "1 0" clause.push_back(Lit(0,false)); solver.add_clause(clause);//add "-2 0" clause.clear(); clause.push_back(Lit(1,true)); solver.add_clause(clause);//add "-1 2 3 0" clause.clear(); clause.push_back(Lit(0,true)); clause.push_back(Lit(1,false)); clause.push_back(Lit(2,false)); solver.add_clause(clause); lbool ret = solver.solve();assert(ret == l_True); std::cout <<"Solution is:" << solver.get_model()[0] <<"," << solver.get_model()[1] <<"," << solver.get_model()[2] << std::endl;//assumes 3 = FALSE, no solutions left vector<Lit> assumptions; assumptions.push_back(Lit(2,true)); ret = solver.solve(&assumptions);assert(ret == l_False);//without assumptions we still have a solution ret = solver.solve();assert(ret == l_True);//add "-3 0"//No solutions left, UNSATISFIABLE returned clause.clear(); clause.push_back(Lit(2,true)); solver.add_clause(clause); ret = solver.solve();assert(ret == l_False);return0;}
The library usage also allows for assumptions. We can add these lines justbefore thereturn 0; above:
vector<Lit> assumptions;assumptions.push_back(Lit(2, true));lbool ret = solver.solve(&assumptions);assert(ret == l_False);lbool ret = solver.solve();assert(ret == l_True);Since we assume that variable 2 must be false, there is no solution. However,if we solve again, without the assumption, we get back the original solution.Assumptions allow us to assume certain literal values for aspecific run butnot all runs -- for all runs, we can simply add these assumptions as 1-longclauses.
To find multiple solutions to your problem, just run the solver in a loopand ban the previous solution found:
while(true) {lboolret=solver->solve();if (ret!=l_True) {assert(ret==l_False);//All solutions found.exit(0); }//Use solution here. print it, for example.//Banning found solutionvector<Lit>ban_solution;for (uint32_tvar=0;var<solver->nVars();var++) {if (solver->get_model()[var]!=l_Undef) {ban_solution.push_back(Lit(var, (solver->get_model()[var]==l_True)? true : false)); } }solver->add_clause(ban_solution);}
The above loop will run as long as there are solutions. It ishighlysuggested toonly add into the new clause(bad_solutions above) thevariables that are "important" or "main" to your problem. Variables that wereonly used to translate the original problem into CNF should not be added.This way, you will not get spurious solutions that don't differ in the main,important variables.
To build the Rust bindings:
git clone https://github.com/msoos/cryptominisat-rs/cd cryptominisat-rscargo build --releasecargo testYou can use it as per theREADME in that repository. To include CryptoMiniSat in your Rust project, add the dependency to yourCargo.toml file:
cryptominisat = { git = "https://github.com/msoos/cryptominisat-rs", branch= "master" }You can see an example project using CryptoMiniSat in Rusthere.
If you wish to use CryptoMiniSat as a preprocessor, we encourage youto try out our model counting preprocessor,Arjun.
Since CryptoMiniSat 5.8, Gauss-Jordan elimination is compiled into the solverby default. However, it will turn off automatically in case the solver observesGJ not to perform too well. To use Gaussian elimination, provide a CNF withxors in it (either in CNF or XOR+CNF form) and either run with default setup,or, tune it to your heart's desire:
Gauss options: --iterreduce arg (=1) Reduce iteratively the matrix that is updated.We effectively are moving the start to the last column updated --maxmatrixrows arg (=3000) Set maximum no. of rows for gaussian matrix. Too large matrixes should be discarded for reasons of efficiency --autodisablegauss arg (=1) Automatically disable gauss when performing badly --minmatrixrows arg (=5) Set minimum no. of rows for gaussian matrix. Normally, too small matrixes are discarded for reasons of efficiency --savematrix arg (=2) Save matrix every Nth decision level --maxnummatrixes arg (=3) Maximum number of matrixes to treat.In particular, you may want to set--autodisablegauss 0 in case you are sure it'll help.
Build and use instructions below. Please see theassociated blogpostfor more information.
# prerequisites on a modern Debian/Ubuntu installationsudo apt-get install build-essential cmake gitsudo apt-get install zlib1g-dev libsqlite3-devsudo apt-get install libboost-program-options-dev libboost-serialization-devsudo apt-get install python3-pipsudo pip3 install sklearn pandas numpy lit matplotlib# build and install Louvain Communitiesgit clone https://github.com/meelgroup/louvain-communitycd louvain-communitymkdir build&&cd buildcmake ..make -j10sudo make installcd ../..# build and install LightGBMgit clone https://github.com/microsoft/LightGBMcd LightGBMmkdir build&&cd buildcmake ..make -j10sudo make installcd ../..# getting the codegit clone https://github.com/msoos/cryptominisatcd cryptominisatgit checkout crystalballgit submodule update --initmkdir build&&cd buildln -s ../scripts/crystal/*.ln -s ../scripts/build_scripts/*.# Let's get an unsatisfiable CNFwget https://www.msoos.org/largefiles/goldb-heqc-i10mul.cnf.gzgunzip goldb-heqc-i10mul.cnf.gz# Gather the data, denormalize, label,# create the classifier, generate C++,# and build the final SAT solver./ballofcrystal.sh goldb-heqc-i10mul.cnf[...compilations and the full data pipeline...]# let's use our newly built tool./cryptominisat5 goldb-heqc-i10mul.cnf[ ... ]s UNSATISFIABLE# Let's look at the datacd goldb-heqc-i10mul.cnf-dirsqlite3 mydata.dbsqlite>selectcount() from sum_cl_use;94507
The following arguments to cmake configure the generated build artifacts. Touse, specify options prior to running make in a clean subdirectory:cmake <options> ..
-DSTATICCOMPILE=<ON/OFF>-- statically linked library and binary.-DSTATS=<ON/OFF>-- advanced statistics (slower). Needslouvaincommunities installed.-DENABLE_TESTING=<ON/OFF>-- test suite support-DLARGEMEM=<ON/OFF>-- more memory available for clauses (but slower onmost problems)-DIPASIR=<ON/OFF>-- Buildlibipasircryptominisat.soforIPASIRinterface support
See src/cryptominisat_c.h.in for details. This is an experimental feature.
Everything that is needed to build by default is MIT licensed. If youspecifically instruct the system it can build with Bliss, which are both GPL.However, by default CryptoMiniSat will not build with these.
About
An advanced SAT solver
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.