ravensat 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d0f5a2e88e6b17130dc2101a9c2e85d0e401fba9bcba081299cf14ded1c683b
-  data.tar.gz: ee09cdeb7da7fd0cd04a80a5017ae351b836cf9a6d63ab92fddaa9181f36dff2
+  metadata.gz: bd6bb73a8f6668c36675461d24272ae8e02632c5b2d3f768b5a81347ad29956a
+  data.tar.gz: 48e4f44fa76bd1716b32ed98ddaa82d198cb83064e944269ecfd57ab21645860
 SHA512:
-  metadata.gz: d763bab0b969a710ef42cae2e1aed39161e4b49488c1d898f8665b14a4763df09a881508875576f6505fc25c75daed694b805cb82ca081c95ac61d31bb49c12d
-  data.tar.gz: d5ff19dd7503194401664bba22b12bbe16a7ce8b6f1ff8cb54d19d1fcfde0d8912ad25d9762549d19f50dcc0d9d82161f020fae1c1207bd015ce530178eb8b62
+  metadata.gz: 5365bfdf37eeb55b5a7ccab53f0ecca8cf8c73ecdfcac2eb9c92ce843aa6fa2e77f711f14a9b00f37cb9a37bfade19c65ea38cbd3f7478398b0d1ef8a5cf416a
+  data.tar.gz: abf648c3097425241ae106e7ed42876f9c9a33e55bf4615cefc16c77943aedf62b0bd99fc6b9c2062147dbaf6c9b690b13f5a28204771e03934e4c59bdf98a9e

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,26 +68,45 @@ Or install it yourself as:
     $ gem install ravensat
 
 ## Usage
-### General Usage
+### Basic Usage
+This is a basic usage example of the library.
+
 ```ruby
 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
 ```
 
-### Extension Usage(SAT)
+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'
 
@@ -53,13 +118,15 @@ module Ravensat
     solver = Ravensat::Solver.new
     solver.solve logic #=> true
 
-    a.value #=> true
-    b.value #=> 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'
 
@@ -83,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).