Ravensat

Ravensat provides an intuitive interface for working with SAT solver. SAT solver is a useful tool for solving various problems, but it is not user-friendly. Ravensat wraps the SAT solver and makes it easier to use. In order to use Ravensat, you need to install SAT solver. If you do not install SAT solver, it will use the one bundled in the gem.

About SAT, SAT solver

Description

To solve SAT(Boolean Satisfiability Problem), we usually use SAT solver. Now, let's solve the following SAT with SAT solver.

$$(p_1 \lor \lnot p_5 \lor p_4) \land (\lnot p_1 \lor p_5 \lor p_3 \lor p_4) \land (\lnot p_3 \lor \lnot p_4)$$

To solve the above SAT, give it to the SAT solver. Most SAT solvers are input in DIMACS Format. Converting the example SAT to DIMACS Format yields the following.

```DIMACS Format p cnf 5 3 1 -5 4 0 -1 5 3 4 0 -3 -4 0

DIMACS Format is widely distributed as an I/O format for SAT solver.
However, when solving a large SAT, the following problems occur.
- Need to create a file with thousands of lines.
- Confusion arises because of the inability to name variables meaningfully.

Therefore, we need an interface that can flexibly determine the names of variables and imperatively write loginal expressions.
To achieve these requirements, we are developing Ravensat.
Using Ravensat, propositional variables can be defined as local variables in Ruby.

```ruby
John_is_a_male = Ravensat::VarNode.new

In addition, you can write logical expressions intuitively and imperatively.

x = Ravensat::VarNode.new
y = Ravensat::VarNode.new

(x | y) & (~x | y)

x = Ravensat::VarNode.new
y = Ravensat::VarNode.new
z = Ravensat::VarNode.new

# (~x | ~y) & (~x | ~z) & (~y | ~z)
Ravensat::Claw.pairwise_amo [x,y,z]

Installation

Add this line to your application's Gemfile:

gem 'ravensat'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install ravensat

Usage

Basic Usage

This is a basic usage example of the library.

require 'ravensat'

a = Ravensat::VarNode.new
b = Ravensat::VarNode.new

a.result #=> nil
b.result #=> nil

logic = (a | b) & (~a | b) & (a | ~b)

solver = Ravensat::Solver.new
solver.solve logic #=> true(SAT)

a.result #=> true
b.result #=> true

If you have SAT solver installed, you can write:

solver = Ravensat::Solver.new("<solver_name>")
solver.solve logic

The available solvers are assumed to be those that can be I/O in the DIMACS Format. At least, we have confirmed that it works properly with MiniSat.

If you do not use an external SAT solver, create a SAT solver object without any constructor arguments. In that case, Arcteryx(the very simple SAT solver built into Ravensat) will launch.

Extension Usage(prototype)

In Ravensat::Extension, C-like variable definitions are available.

Note: In Ravensat::Extension, all undefined variables and methods are caught by method_missing method.

require 'ravensat'

module Ravensat
  module Extension
    bool a, b
    logic = (a | b) & (~a | b) & (a | ~b)

    solver = Ravensat::Solver.new
    solver.solve logic #=> true

    a.result #=> true
    b.result #=> true
  end
end

It is possible to define integer variables and to describe some integer constraints.

require 'ravensat'

module Ravensat
  module Extension
    int a(1..10), b(1..10)
    constraint = (a.only_one & b.only_one & (a != b))

    solver = Ravensat::Solver.new
    solver.solve constraint #=> true

    a.result #=> 1
    b.result #=> 2
  end
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

License

The gem is available as open source under the terms of the MIT License.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/matsuda0528/ravensat.

 ____                                 _
|  _ \ __ ___   _____ _ __  ___  __ _| |_
| |_) / _` \ \ / / _ \ '_ \/ __|/ _` | __|
|  _ < (_| |\ V /  __/ | | \__ \ (_| | |_
|_| \_\__,_| \_/ \___|_| |_|___/\__,_|\__|