ravensat 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d0f5a2e88e6b17130dc2101a9c2e85d0e401fba9bcba081299cf14ded1c683b
-  data.tar.gz: ee09cdeb7da7fd0cd04a80a5017ae351b836cf9a6d63ab92fddaa9181f36dff2
+  metadata.gz: 47afc062227efddad35ed4643e28c4eea8957ecb32c8aa34d3c69a9ff52d3a88
+  data.tar.gz: a39c4f15fb17321ded803e79b702c55150197b3a613a340ca4a728e0a6a27402
 SHA512:
-  metadata.gz: d763bab0b969a710ef42cae2e1aed39161e4b49488c1d898f8665b14a4763df09a881508875576f6505fc25c75daed694b805cb82ca081c95ac61d31bb49c12d
-  data.tar.gz: d5ff19dd7503194401664bba22b12bbe16a7ce8b6f1ff8cb54d19d1fcfde0d8912ad25d9762549d19f50dcc0d9d82161f020fae1c1207bd015ce530178eb8b62
+  metadata.gz: f29375d0971be0c3a721e9932fec0b69ad9db5b6df089e9d07fad557a82fac176faf7b71eea0ca73b8ee76ba60b413bfc799fd2de798c0b0fc513e39c8c0388d
+  data.tar.gz: a596fa29bfb55341a016ddde64b2e7d788a4877d4504cd5921cee81e486ee28207fd14027c81c0e113c8485edd0cc9bd5921beac75728da85e3390c1eab4d23f

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,50 @@
 # 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 .)
+[![Ruby](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)
+
+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 align="center">
+<img src="https://latex.codecogs.com/svg.image?\inline&space;\large&space;\bg{white}(1&space;\lor&space;\lnot&space;5&space;\lor&space;4)&space;\land&space;(\lnot&space;1&space;\lor&space;5&space;\lor&space;3&space;\lor&space;4)&space;\land&space;(\lnot&space;3&space;\lor&space;\lnot&space;4)" style="background-color:white;"/>
+</p>
+
+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 or y) and (not x or y)
+(x | y) & (~x | y)
+```
 
 
 ## Installation
@@ -22,26 +64,47 @@ 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'
 
+# Define propositional variables
 a = Ravensat::VarNode.new
 b = Ravensat::VarNode.new
 
-a.value #=> nil
-b.value #=> nil
+a.result #=> nil
+b.result #=> nil
 
+# Generate logical expressions as CNF
 logic = (a | b) & (~a | b) & (a | ~b)
 
+# Launch SAT solver
 solver = Ravensat::Solver.new
 solver.solve logic #=> true(SAT)
 
-a.value #=> true
-b.value #=> true
+# Refer to the satisfiability
+a.result #=> true
+b.result #=> true
 ```
 
-### Extension Usage(SAT)
+If you have SAT solver installed, you can write:
+```ruby
+# Launch SAT solver
+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'
 
@@ -53,13 +116,14 @@ 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'
 

data/exe/ravensat

@@ -4,8 +4,4 @@ $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 require 'ravensat'
 require 'pry'
 
-module Ravensat
-  module Extension
-    binding.pry
-  end
-end
+Pry.start(Ravensat::Extension)

data/lib/ravensat/ast/node.rb

@@ -36,12 +36,6 @@ module Ravensat
       OrNode.new(self, object)
     end
 
-    # def tree_text
-    #   self.each do |child|
-    #     child.to_s
-    #   end
-    # end
-
     def to_s
       self.class.name
     end

data/lib/ravensat/ast/var_node.rb

@@ -13,5 +13,9 @@ module Ravensat
     def cnf?
       true
     end
+
+    def result
+      @value
+    end
   end
 end

data/lib/ravensat/extension/domain.rb

@@ -12,7 +12,6 @@ module Ravensat
       def bool(*vars)
         vars.each do |var|
           next if var.is_defined?
-          # LOCAL_VARIABLE_TABLE[var.name] = Ravensat::VarNode.new
           LOCAL_VARIABLE_TABLE[var.name] = Ravensat::Extension::BooleanVariable.new(var.name, var.args)
         end
       end

data/lib/ravensat/solver.rb

@@ -5,15 +5,8 @@ module Ravensat
     attr_accessor :name
     def initialize( default_solver_name = "arcteryx" )
       @name = default_solver_name
-      # @cnf = Array.new
-      # @nr_vars
-      # @nr_clses
     end
 
-    # def <<( clause )
-    #   'this is << method'
-    # end
-
     def solve( cnf )
       encoder = DimacsEncoder.new
       @input_file = Tempfile.open(["ravensat",".cnf"])

data/lib/ravensat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ravensat
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ravensat
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - rikuto matsuda
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -18,6 +18,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"