ravensat 0.3.2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f369c1036cde3ea2ff754109809d5b4ce62f826a2ab409e9ec19fdd07ff341dc
-  data.tar.gz: 76df72fb98e5140fcd1b2b394643f23de5218ea47f4ec03f450dc0a05074f801
+  metadata.gz: 78a4fe449b52b526589311a1d8bd4203e121e0d490ff86a870f08833328bda05
+  data.tar.gz: f7dfe20367b98c416ed30cdbf4061b1662268181007f188942d6f393d0aff687
 SHA512:
-  metadata.gz: b59a47f2b7a899e49d506f839c892178523ea3920e611278e0f31399dc1c0e5c868bb8f8a74adab5a848f26f2d2efb8779f6391a20ec566ec177a1fdacfb4565
-  data.tar.gz: 9ed85ceb8abc589197c9241679bb5c5486ce525e427d91f84568dcc4b4ab7a58b0d110688cba999d78dacc9fd0e067d6e4f3908ef87d2d3851ed7c30331d22ca
+  metadata.gz: c7a341443b901bb3d3717a380af641956d7d9552d217e88250c6146f5fa9f1c0dd81fef9db5f5f38b37dca40f092030c6c99ef967ba534816e7a160b3525074e
+  data.tar.gz: 4d994c5983f2d66d988140aec41385533039dac96e62c6952416604efa2ecf9ede311241a6e4c5eb322da8396128f44ff6b5fcf3f8a55e36ea4ce5d8a0ea6be2

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/and_node.rb

@@ -1,4 +1,12 @@
 module Ravensat
   class AndNode < OprNode
+    def &(object)
+      @children.append object
+      self
+    end
+
+    def to_dimacs
+      " 0\n"
+    end
   end
 end

data/lib/ravensat/ast/node.rb

@@ -7,25 +7,57 @@ module Ravensat
       @children = []
     end
 
-    # def each
-    #   yield(self)
-    #   @children.each do |child|
-    #     child.each {|c| yield(c)}
-    #   end
-    # end
+    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
+
+        case current_node
+        when AndNode
+          node_stack.push [current_parent, current_children.clone]
+          node_stack.push [current_node, current_node.children.clone]
+        when OrNode
+          node_stack.push [current_parent, current_children.clone]
+          node_stack.push [current_node, current_node.children.clone]
+        when NotNode
+          yield(current_node)
+          yield(current_node.children.first)
+
+          if current_children.empty?
+            yield(node_stack.last.first)
+          else
+            yield(current_parent)
+            node_stack.push [current_parent, current_children.clone]
+          end
+        when VarNode, Extension::BooleanVariable
+          yield(current_node)
+
+          if current_children.empty?
+            yield(node_stack.last.first)
+          else
+            yield(current_parent)
+            node_stack.push [current_parent, current_children.clone]
+          end
+        end
+      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)
+      return to_enum unless block_given?
+      node_stack = [self]
+
+      until node_stack.empty?
+        current_node = node_stack.shift
+        next unless current_node
+
+        yield current_node
+
+        node_stack = node_stack.concat(current_node.children)
       end
+
+      self if block_given?
     end
 
     def &(object)
@@ -40,6 +72,9 @@ module Ravensat
       self.class.name
     end
 
+    def to_dimacs
+    end
+
     def cnf?
       @children.map(&:cnf?).reduce(:&)
     end

data/lib/ravensat/ast/not_node.rb

@@ -3,5 +3,9 @@ module Ravensat
     def ~@
       @children.first
     end
+
+    def to_dimacs
+      "-"
+    end
   end
 end

data/lib/ravensat/ast/or_node.rb

@@ -1,8 +1,17 @@
 module Ravensat
   class OrNode < OprNode
+    def |(object)
+      @children.append object
+      self
+    end
+
     def cnf?
       return false if @children.any?{|node| node.is_a? AndNode}
       @children.map(&:cnf?).reduce(:&)
     end
+
+    def to_dimacs
+      " "
+    end
   end
 end

data/lib/ravensat/ast/var_node.rb

@@ -1,9 +1,10 @@
 module Ravensat
   class VarNode < Node
-    attr_accessor :value
+    attr_accessor :value, :dimacs_name
     def initialize
       @value
       @children = []
+      @dimacs_name
     end
 
     def ~@
@@ -17,5 +18,9 @@ module Ravensat
     def result
       @value
     end
+
+    def to_dimacs
+      @dimacs_name
+    end
   end
 end

data/lib/ravensat/claw.rb

@@ -10,22 +10,23 @@ 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
-      introductory_variables = []
+      commander_variables = []
       formula = Ravensat::InitialNode.new
-      bool_vars.each_slice(2) do |e|
+      bool_vars.each_slice(2) do |g|
         c = Ravensat::VarNode.new
-        subset = e << ~c
+        subset = g << ~c
         formula &= pairwise_amo(subset)
         formula &= alo(subset)
-        introductory_variables << c
+        commander_variables << c
       end
 
       if m < 6
-        formula &= pairwise_amo(introductory_variables)
+        formula &= pairwise_amo(commander_variables)
       else
-        formula &= commander_amo(introductory_variables)
+        formula &= commander_amo(commander_variables)
       end
     end
 

data/lib/ravensat/dimacs/dimacs_decoder.rb

@@ -1,19 +1,13 @@
 module Ravensat
   class DimacsDecoder
-    def decode(model, name_table)
-      inverted_name_table = name_table.invert
+    def decode(model, cnf)
+      prop_vars = cnf.vars
       case model.first
       when "SAT"
-        model.last.split.each do |e|
-          if e == '0'
-            next
-          elsif e[0] == "-"
-            index = e.slice(1..-1)
-            inverted_name_table[index].value = false
-          else
-            index = e
-            inverted_name_table[index].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

@@ -6,26 +6,23 @@ module Ravensat
     end
 
     def to_dimacs(formula)
-      return nil unless formula.cnf?
-
       dimacs_header = "p cnf #{formula.vars_size} #{formula.clauses_size}\n"
       dimacs_body = ""
-      create_table(formula)
-      formula.each do |node|
-        case node
-        when AndNode then dimacs_body << " 0\n"
-        when OrNode then dimacs_body << " "
-        when NotNode then dimacs_body << "-"
-        when VarNode then dimacs_body << @name_table[node]
-        end
+      return nil unless formula.cnf?
+
+      set_dimacs_name(formula)
+
+      formula.each_by_descriptive do |node|
+        dimacs_body << node.to_dimacs
       end
-      dimacs_body << " 0\n"
 
       dimacs_header + dimacs_body
     end
 
-    def create_table(formula)
-      @name_table = formula.vars.zip((1..formula.vars.size).map(&:to_s)).to_h
+    def set_dimacs_name(formula)
+      formula.vars.each_with_index do |node, i|
+        node.dimacs_name = (i+1).to_s
+      end
     end
   end
 end

data/lib/ravensat/solver.rb

@@ -1,4 +1,5 @@
 require 'tempfile'
+require 'open3'
 
 module Ravensat
   class Solver
@@ -7,7 +8,7 @@ module Ravensat
       @name = default_solver_name
     end
 
-    def solve( cnf )
+    def solve( cnf , solver_log: false)
       encoder = DimacsEncoder.new
       @input_file = Tempfile.open(["ravensat",".cnf"])
       @output_file = Tempfile.open(["ravensat",".mdl"])
@@ -19,12 +20,13 @@ module Ravensat
       when "arcteryx"
         Arcteryx.solve(@input_file.to_path, @output_file.to_path)
       else
-        system("#{@name} #{@input_file.to_path} #{@output_file.to_path}")
+        result, err, status = Open3.capture3("#{@name} #{@input_file.to_path} #{@output_file.to_path}")
+        puts result if solver_log
       end
 
       decoder = DimacsDecoder.new
       model = @output_file.read.split("\n")
-      decoder.decode(model, encoder.name_table)
+      decoder.decode(model, cnf)
     end
 
   end

data/lib/ravensat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ravensat
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.2
 platform: ruby
 authors:
 - rikuto matsuda
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-07-29 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