ravensat 0.2.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2206c8010f299d713c19b74682a2c46470d0c4cc7e27ade7e429ee0de09622de
-  data.tar.gz: 14b05657764ab053b091da8f0ddb339201ea2cd469d2828eccc04fd0b3c4e49e
+  metadata.gz: f369c1036cde3ea2ff754109809d5b4ce62f826a2ab409e9ec19fdd07ff341dc
+  data.tar.gz: 76df72fb98e5140fcd1b2b394643f23de5218ea47f4ec03f450dc0a05074f801
 SHA512:
-  metadata.gz: ba52ce15498089d710d8e7ded3b8f35da11364a74a6f72241482ceb794cec83164423142e5b3d3feb90b0a444d8ec62327d7be830cac6d4390844fb9ce10cb6e
-  data.tar.gz: 83509b606c6693373ce2918fe4ae9feda5aafbd241bca5510ed795cc52aae6dc0120cfc0e0294dd76a53004dbb825c1a9b0aa27664c47ff04a5e311ebf7bb167
+  metadata.gz: b59a47f2b7a899e49d506f839c892178523ea3920e611278e0f31399dc1c0e5c868bb8f8a74adab5a848f26f2d2efb8779f6391a20ec566ec177a1fdacfb4565
+  data.tar.gz: 9ed85ceb8abc589197c9241679bb5c5486ce525e427d91f84568dcc4b4ab7a58b0d110688cba999d78dacc9fd0e067d6e4f3908ef87d2d3851ed7c30331d22ca

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/README.md

@@ -1,8 +1,54 @@
 # Ravensat
 
-Ravensat is an interface to SAT Solver .
-In order to use Ravensat, you need to install SAT Solver and specify the name of the Solver .
-(If you do not specify SAT Solver, it will use the one bundled in the gem .)
+[![GitHub Actions](https://github.com/matsuda0528/ravensat/actions/workflows/main.yml/badge.svg)](https://github.com/matsuda0528/ravensat/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/ravensat.svg)](https://badge.fury.io/rb/ravensat)
+[![LICENSE](https://img.shields.io/github/license/matsuda0528/ravensat)](https://opensource.org/licenses/MIT)
+
+[![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages--brightgreen.svg?logo=github&style=social)](https://matsuda0528.github.io/ravensat/)
+
+Ravensat is an interface to SAT solver in Ruby.
+
+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](https://en.wikipedia.org/wiki/Boolean_satisfiability_problem), [SAT solver](https://en.wikipedia.org/wiki/SAT_solver)
+
+## Description
+To solve SAT, 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})$$
+
+Most SAT solvers are input in [DIMACS Format](https://www.cs.utexas.edu/users/moore/acl2/manuals/current/manual/index-seo.php/SATLINK____DIMACS).
+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.
+
+To solve these problems, Ravensat can be used.
+Using Ravensat, propositional variables can be defined as local variables in Ruby.
+
+```ruby
+fuji_is_the_highest_mountain_in_japan = Ravensat::VarNode.new
+```
+
+In addition, you can write logical expressions intuitively.
+
+```ruby
+x = Ravensat::VarNode.new
+y = Ravensat::VarNode.new
+
+(x | y) & (~x | y) # (x or y) and (not x or y)
+```
 
 
 ## Installation
@@ -22,6 +68,8 @@ Or install it yourself as:
     $ gem install ravensat
 
 ## Usage
+### Basic Usage
+This is a basic usage example of the library.
 
 ```ruby
 require 'ravensat'
@@ -29,16 +77,71 @@ require 'ravensat'
 a = Ravensat::VarNode.new
 b = Ravensat::VarNode.new
 
-a.value #=> nil
-b.value #=> nil
+a.result #=> nil
+b.result #=> nil
 
 logic = (a | b) & (~a | b) & (a | ~b)
 
 solver = Ravensat::Solver.new
 solver.solve logic #=> true(SAT)
 
-a.value #=> true
-b.value #=> true
+a.result #=> true
+b.result #=> true
+```
+
+If you have SAT solver installed, you can write:
+
+```ruby
+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](https://github.com/niklasso/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
+In Ravensat::Extension, C-like variable definitions are available.
+
+*Note: In Ravensat::Extension, all undefined variables and methods are caught by method_missing method.*
+
+```ruby
+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
+```
+
+### Extension Usage(CSP; Constraint Satisfaction Problem)
+It is possible to define integer variables and to describe some integer constraints.
+
+```ruby
+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
@@ -47,10 +150,20 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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](https://rubygems.org).
 
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/matsuda0528/ravensat.
 
-## License
+```
+ ____                                 _
+|  _ \ __ ___   _____ _ __  ___  __ _| |_
+| |_) / _` \ \ / / _ \ '_ \/ __|/ _` | __|
+|  _ < (_| |\ V /  __/ | | \__ \ (_| | |_
+|_| \_\__,_| \_/ \___|_| |_|___/\__,_|\__|
+
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).