ravensat 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd6bb73a8f6668c36675461d24272ae8e02632c5b2d3f768b5a81347ad29956a
-  data.tar.gz: 48e4f44fa76bd1716b32ed98ddaa82d198cb83064e944269ecfd57ab21645860
+  metadata.gz: 0fe48515db2ce222168fac2854fcab5b2057c84336195e129e6c532ab519082e
+  data.tar.gz: bc265a79298a55684d1bb1c83a196e0530b4670515c22d4388f65bdf7b872c67
 SHA512:
-  metadata.gz: 5365bfdf37eeb55b5a7ccab53f0ecca8cf8c73ecdfcac2eb9c92ce843aa6fa2e77f711f14a9b00f37cb9a37bfade19c65ea38cbd3f7478398b0d1ef8a5cf416a
-  data.tar.gz: abf648c3097425241ae106e7ed42876f9c9a33e55bf4615cefc16c77943aedf62b0bd99fc6b9c2062147dbaf6c9b690b13f5a28204771e03934e4c59bdf98a9e
+  metadata.gz: 7d715763470fe222f0ba71c998e27a43f8e40c04ae50cadceae48b324a962eaa75ceef92f02154cc74f9e04edbae47de1f36eb6e3c655019c0f3fedd72aae448
+  data.tar.gz: d2178778880fa55127ef5bd0b2b5d76fa5431452d20f06b0672374a99f9a718a881c01c1c055b11579c86e063decc607416c0f3450213f460dac756e28cc201c

data/README.md

@@ -1,24 +1,26 @@
-# Ravensat
-
 [![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/)
+<!-- [![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.
+# 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](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.
+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](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.
 
@@ -34,22 +36,31 @@ 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.
+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
-fuji_is_the_highest_mountain_in_japan = Ravensat::VarNode.new
+John_is_a_male = Ravensat::VarNode.new
 ```
 
-In addition, you can write logical expressions intuitively.
+In addition, you can write logical expressions intuitively and imperatively.
 
 ```ruby
 x = Ravensat::VarNode.new
 y = Ravensat::VarNode.new
 
-(x | y) & (~x | y) # (x or y) and (not x or y)
+(x | y) & (~x | y)
 ```
 
+```ruby
+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
 
@@ -102,7 +113,7 @@ At least, we have confirmed that it works properly with [MiniSat](https://github
 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
+### 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.*
@@ -124,7 +135,6 @@ module Ravensat
 end
 ```
 
-### Extension Usage(CSP; Constraint Satisfaction Problem)
 It is possible to define integer variables and to describe some integer constraints.
 
 ```ruby

data/lib/ravensat/ast/node.rb

@@ -7,40 +7,13 @@ module Ravensat
       @children = []
     end
 
-    # def each
-    #   yield(self)
-    #   @children.each do |child|
-    #     child.each {|c| yield(c)}
-    #   end
-    # end
-
-    # def each
-    #   case self
-    #   when AndNode, OrNode
-    #     @children.first.each{|c| yield(c)}
-    #     yield(self)
-    #     @children.last.each{|c| yield(c)}
-    #   when NotNode
-    #     yield(self)
-    #     @children.first.each{|c| yield(c)}
-    #   when VarNode
-    #     yield(self)
-    #   end
-    # end
-
-    def each_DP
+    def each_by_descriptive
       node_stack = [[self, self.children.clone]] #[[parent, children], ...]
 
       until node_stack.empty?
         current_parent, current_children = node_stack.pop
         current_node = current_children.shift
 
-#         puts 'loop'
-#         puts "node_stack.size:#{node_stack.size}"
-#         puts "current_parent:#{current_parent.class}"
-#         puts "current_children.size:#{current_children.size}"
-#         puts "current_node:#{current_node.class}"
-
         case current_node
         when AndNode
           node_stack.push [current_parent, current_children.clone]
@@ -68,7 +41,6 @@ module Ravensat
             node_stack.push [current_parent, current_children.clone]
           end
         end
-
       end
     end
 
@@ -88,13 +60,6 @@ module Ravensat
       self if block_given?
     end
 
-    def each_naive
-      yield(self)
-      @children.each do |child|
-        child.each {|c| yield(c)}
-      end
-    end
-
     def &(object)
       AndNode.new(self, object)
     end

data/lib/ravensat/claw.rb

@@ -10,6 +10,7 @@ module Ravensat
       end.reduce(:&)
     end
 
+    # NOTE: Klieber, W. and Kwon, G.: Efficient CNF Encoding for Selecting 1 from N Objects (2007).
     def self.commander_amo(bool_vars)
       m = bool_vars.size / 2
       commander_variables = []

data/lib/ravensat/dimacs/dimacs_decoder.rb

@@ -1,22 +1,13 @@
 module Ravensat
   class DimacsDecoder
     def decode(model, cnf)
-      # inverted_name_table = name_table.invert
       prop_vars = cnf.vars
       case model.first
       when "SAT"
-        model.last.split.each do |e|
-          if e == '0'
-            next
-          elsif e[0] == "-"
-            dimacs_name = e.slice(1..-1)
-            var = prop_vars.find{|i| i.dimacs_name == dimacs_name}
-            var.value = false
-          else
-            dimacs_name = e
-            var = prop_vars.find{|i| i.dimacs_name == dimacs_name}
-            var.value = true
-          end
+        model.last.split.each_with_index do |e,i|
+          break if e == '0'
+          var = prop_vars[i]
+          var.value = !(e[0] == '-')
         end
         true
       when "UNSAT"

data/lib/ravensat/dimacs/dimacs_encoder.rb

@@ -12,7 +12,7 @@ module Ravensat
 
       set_dimacs_name(formula)
 
-      formula.each_DP do |node|
+      formula.each_by_descriptive do |node|
         dimacs_body << node.to_dimacs
       end
 

data/lib/ravensat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ravensat
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - rikuto matsuda
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -23,7 +23,6 @@ files:
 - ".rspec"
 - ".ruby-version"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,45 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ravensat (0.1.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (11.1.3)
-    coderay (1.1.3)
-    diff-lcs (1.4.4)
-    method_source (1.0.0)
-    pry (0.14.0)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.8.0)
-      byebug (~> 11.0)
-      pry (~> 0.10)
-    rake (13.0.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  pry
-  pry-byebug
-  rake (~> 13.0)
-  ravensat!
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.2.24