cadical 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f84fde139dbf6d48d99ca9c0af8eede205596d7c596930659a830d824352f3c0
+  data.tar.gz: 5e93a72a594d4ca2a10ede543277a3cf3fc4753eb3076f3ce70f2e67ebda956e
+SHA512:
+  metadata.gz: 54dde2e043141394213d5666a6733cdc979400abba48112fc1606e5914b0f45668137f41675fdf2e8be5c92c9010621db94fc45988be93a18362b7f0a7496f4b
+  data.tar.gz: 8840576c8452117127df21f20fd840c9142b9f47d75e2255d64e495ff15b68fabeb2f0d64f2330dbf625ec1a21bd02cf1e82875b98a0bd1da82c887f57fbcd0c

data/LICENSE.txt

@@ -0,0 +1,26 @@
+MIT License
+
+Copyright (c) 2026 Yusuke Endoh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+This gem bundles the CaDiCaL SAT solver (ext/cadical/cadical/), which is
+distributed under the MIT License. See ext/cadical/cadical/LICENSE.

data/README.md

@@ -0,0 +1,101 @@
+# cadical
+
+A Ruby binding for [CaDiCaL](https://github.com/arminbiere/cadical), a state-of-the-art
+incremental SAT solver. The CaDiCaL C++ sources are vendored and compiled straight into
+the extension, so there is no external dependency.
+
+This is a thin, general-purpose binding over CaDiCaL's C API (`ccadical_*`). The Ruby class is
+`CaDiCaL`, and `CaDiCaL.new` creates a solver.
+
+## Installation
+
+```sh
+gem install cadical
+```
+
+Building the extension requires a C++17 compiler.
+
+## Usage
+
+A literal is an `Integer` in DIMACS form: positive `v` = "variable `v` is true", `-v` =
+false. A clause is just a list of literals.
+
+```ruby
+require "cadical"
+
+c = CaDiCaL.new
+x1, x2 = c.new_var, c.new_var
+
+c.add(x1, x2)     # (x1 \/ x2)
+c.add(x1, -x2)    # (x1 \/ !x2)
+c.add(-x1, -x2)   # (!x1 \/ !x2)
+
+c.solve           # => :sat
+c.true?(x1)       # => true
+c.true?(x2)       # => false
+```
+
+### Incremental solving
+
+Clauses added with `#add` stay for good, so you can keep solving as you learn more. An
+assumption is a temporary hypothesis for the next `#solve` only -- handy to pose what-if
+questions without rebuilding the formula:
+
+```ruby
+c.assume(-x1)     # what if x1 were false?
+c.solve           # => :unsat -- the clauses above force x1 true
+c.solve           # => :sat again; the assumption is already gone
+```
+
+A constraint is the same idea but a whole clause (a disjunction), at most one at a time:
+
+```ruby
+c.constrain(-x1, x2)    # require (!x1 \/ x2) for the next solve only
+c.solve                 # => :unsat
+c.constraint_failed?    # => true -- the constraint is what made it unsat
+```
+
+## API
+
+`CaDiCaL` (every `ccadical_*` function, plus a couple of conveniences)
+
+| method | C function | description |
+| --- | --- | --- |
+| `CaDiCaL.signature` | `ccadical_signature` | the bundled CaDiCaL version string |
+| `CaDiCaL.new` | `ccadical_init` | create a solver |
+| `#release` | `ccadical_release` | free the solver now (else at GC) |
+| `#add(*lits)` | `ccadical_add` | add a permanent clause (splat an array: `add(*clause)`) |
+| `#assume(lit)` | `ccadical_assume` | assume a literal for the next `solve` only |
+| `#constrain(*lits)` | `ccadical_constrain` | temporary constraint clause for the next `solve` |
+| `#constraint_failed?` | `ccadical_constraint_failed` | did the constraint cause the last UNSAT? |
+| `#solve` | `ccadical_solve` | solve -> `:sat` / `:unsat` / `:unknown` |
+| `#simplify` | `ccadical_simplify` | inprocessing -> `:sat` / `:unsat` / `:unknown` |
+| `#val(lit)` | `ccadical_val` | raw model value (signed literal) |
+| `#failed(lit)` | `ccadical_failed` | did this assumption take part in the last UNSAT core? |
+| `#fixed(lit)` | `ccadical_fixed` | `1` / `-1` / `0`: proven true / false / not yet fixed |
+| `#set_terminate { }` | `ccadical_set_terminate` | abort `solve` when the block is truthy (no block clears) |
+| `#set_learn(max) { \|clause\| }` | `ccadical_set_learn` | observe learned clauses (no block clears) |
+| `#terminate` | `ccadical_terminate` | force the running solve to stop |
+| `#declare_one_more_variable` | `ccadical_declare_one_more_variable` | allocate one fresh variable |
+| `#declare_more_variables(n)` | `ccadical_declare_more_variables` | allocate `n` variables |
+| `#vars` | `ccadical_vars` | number of variables |
+| `#phase(lit)` / `#unphase(lit)` | `ccadical_phase` / `ccadical_unphase` | set / clear a forced decision phase |
+| `#freeze_lit(lit)` / `#melt_lit(lit)` / `#frozen_lit?(lit)` | `ccadical_freeze` / `_melt` / `_frozen` | freeze a literal against elimination |
+| `#set_option(name, v)` / `#get_option(name)` | `ccadical_set_option` / `_get_option` | options |
+| `#limit(name, v)` | `ccadical_limit` | set a solve limit |
+| `#active` / `#irredundant` | `ccadical_active` / `_irredundant` | active-variable / irredundant-clause counts |
+| `#trace_proof(path)` / `#close_proof` / `#conclude` | `ccadical_trace_proof` / `_close_proof` / `_conclude` | DRAT proof tracing |
+| `#new_var` | -- | alias for `#declare_one_more_variable` |
+| `#true?(lit)` | -- | convenience boolean: is `lit` assigned true? |
+| `#true_var` / `#false_var` | -- | a variable pinned true / false, usable as a constant literal |
+
+## Notes
+
+Unlike many SAT-solver APIs where any integer can be used as a literal directly, the bundled
+CaDiCaL (with its defaults) rejects a literal whose variable was not produced by `#new_var`
+(the examples above use it). Set `c.set_option("factor", 0)` to allow raw integer literals.
+
+## License
+
+MIT. The bundled CaDiCaL solver (`ext/cadical/cadical/`) is also MIT-licensed; see
+`ext/cadical/cadical/LICENSE`.

data/ext/cadical/cadical/LICENSE

@@ -0,0 +1,28 @@
+MIT License
+
+Copyright (c) 2016-2021 Armin Biere, Johannes Kepler University Linz, Austria
+Copyright (c) 2020-2021 Mathias Fleury, Johannes Kepler University Linz, Austria
+Copyright (c) 2020-2021 Nils Froleyks, Johannes Kepler University Linz, Austria
+Copyright (c) 2022-2025 Katalin Fazekas, Vienna University of Technology, Austria
+Copyright (c) 2021-2025 Armin Biere, University of Freiburg, Germany
+Copyright (c) 2021-2025 Mathias Fleury, University of Freiburg, Germany
+Copyright (c) 2023-2025 Florian Pollitt, University of Freiburg, Germany
+Copyright (c) 2024-2024 Tobias Faller, University of Freiburg, Germany
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/ext/cadical/cadical/README.md

@@ -0,0 +1,65 @@
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+
+CaDiCaL Simplified Satisfiability Solver
+===============================================================================
+
+The goal of the development of CaDiCaL was to obtain a CDCL solver,
+which is easy to understand and change, while at the same time not being
+much slower than other state-of-the-art CDCL solvers.
+
+Originally we wanted to also radically simplify the design and internal data
+structures, but that goal was only achieved partially, at least for instance
+compared to Lingeling.
+
+However, the code is much better documented and CaDiCaL actually became in
+general faster than Lingeling even though it is missing some preprocessors
+(mostly parity and cardinality constraint reasoning), which would be crucial
+to solve certain instances.
+
+Use `./configure && make` to configure and build `cadical` and the library
+`libcadical.a` in the default `build` sub-directory.  The header file of
+the library is [`src/cadical.hpp`](src/cadical.hpp) and includes an example
+for API usage.
+  
+See [`BUILD.md`](BUILD.md) for options and more details related to the build
+process and [`test/README.md`](test/README.md) for testing the library and
+the solver.  Since release 1.5.1 we have a [`NEWS.md`](NEWS.md) file.
+You might also want to check out [`CONTRIBUTING.md`](CONTRIBUTING.md) on
+if you want to contribute.
+
+The solver has the following usage `cadical [ dimacs [ proof ] ]`.
+See `cadical -h` for more options.
+
+If you want to cite CaDiCaL please use as reference our CaDiCaL 2.0 tool
+paper which appeared at CAV'24:
+
+<p>
+<a
+href="https://cca.informatik.uni-freiburg.de/papers/BiereFallerFazekasFleuryFroleyksPollitt-CAV24.pdf">CaDiCaL
+2.0</a>
+<br>
+<a href="https://cca.informatik.uni-freiburg.de/biere">Armin Biere</a>,
+<a href="https://cca.informatik.uni-freiburg.de/fallert">Tobias Faller</a>,
+<a href="https://kfazekas.github.io">Katalin Fazekas</a>,
+<a href="https://cca.informatik.uni-freiburg.de/fleury">Mathias Fleury</a>,
+<a href="https://fmv.jku.at/froleyks">Nils Froleyks</a> and
+<a href="https://cca.informatik.uni-freiburg.de/pollittf">Florian Pollitt</a>
+<br>
+<i>
+Proc.&nbsp;Computer Aidded Verification - 26th Intl.&nbsp;Conf.&nbsp;(CAV'24)</i>
+<br>
+Lecture Notes in Computer Science (LNCS)
+<br>
+vol.&nbsp;14681,
+pages 133-152,
+Springer 2024
+<br>
+[ <a href="https://cca.informatik.uni-freiburg.de/papers/BiereFallerFazekasFleuryFroleyksPollitt-CAV24.pdf">paper</a>
+| <a href="https://cca.informatik.uni-freiburg.de/papers/BiereFallerFazekasFleuryFroleyksPollitt-CAV24.bib">bibtex</a>
+| <a href="https://cca.informatik.uni-freiburg.de/papers/BiereFallerFazekasFleuryFroleyksPollitt-CAV24-Springer.pdf">official</a>
+| <a href="https://zenodo.org/records/10943125">artifact</a>
+| <a href="https://github.com/arminbiere/cadical">github</a>
+| <a href="https://doi.org/10.1007/978-3-031-37703-7">doi</a>
+]
+</p>

data/ext/cadical/cadical/VERSION

@@ -0,0 +1 @@
+3.0.0