ravensat 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76d71945818d257f977fde25685896cc7e8c7da0d290f329525beb5d7e5c2ca2
-  data.tar.gz: 2c201e0b4815822e40f7b15fe8b1492a532c6665bc456a87c8c6f42227468f38
+  metadata.gz: 47afc062227efddad35ed4643e28c4eea8957ecb32c8aa34d3c69a9ff52d3a88
+  data.tar.gz: a39c4f15fb17321ded803e79b702c55150197b3a613a340ca4a728e0a6a27402
 SHA512:
-  metadata.gz: 4a25a24ca9553e5ea66737f21d5cf9942b9202f106f3c0063d3a4fa84816b665797a761ac2399ef0de374e36bfa29a23c5dccaf7f78f0adfa73cd9e45558e591
-  data.tar.gz: 74baa2d28e39e50dca6d280a411cc0fd5727f15dca74ada2ec94eb4a1c1c7d785e686293de0202d0e249c03a78685be3c823917519936d79438740c0bd861b90
+  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,23 +64,81 @@ Or install it yourself as:
     $ gem install ravensat
 
 ## 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
+```
+
+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'
+
+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

data/exe/ravensat

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require 'ravensat'
+require 'pry'
+
+Pry.start(Ravensat::Extension)

data/lib/ravensat/ast/initial_node.rb

@@ -0,0 +1,11 @@
+module Ravensat
+  class InitialNode < Node
+    def &(object)
+      object
+    end
+
+    def |(object)
+      object
+    end
+  end
+end

data/lib/ravensat/ast/node.rb

@@ -14,6 +14,20 @@ module Ravensat
       end
     end
 
+    def each_with_clause
+      case self
+      when AndNode, OrNode
+        @children.first.each_with_clause{|c| yield(c)}
+        yield(self)
+        @children.last.each_with_clause{|c| yield(c)}
+      when NotNode
+        yield(self)
+        @children.first.each_with_clause{|c| yield(c)}
+      when VarNode
+        yield(self)
+      end
+    end
+
     def &(object)
       AndNode.new(self, object)
     end
@@ -22,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/ast.rb

@@ -0,0 +1,11 @@
+module Ravensat
+  dir = File.dirname(__FILE__) + '/ast'
+
+  autoload :Node, dir + '/node.rb'
+  autoload :VarNode, dir + '/var_node.rb'
+  autoload :OprNode, dir + '/opr_node.rb'
+  autoload :AndNode, dir + '/and_node.rb'
+  autoload :OrNode, dir + '/or_node.rb'
+  autoload :NotNode, dir + '/not_node.rb'
+  autoload :InitialNode, dir + '/initial_node.rb'
+end

data/lib/ravensat/{dimacs_encoder.rb → dimacs/dimacs_encoder.rb}

@@ -8,19 +8,18 @@ module Ravensat
     def to_dimacs(formula)
       return nil unless formula.cnf?
 
-      dimacs_header = "p cnf #{formula.vars_size} #{formula.clauses_size}"
+      dimacs_header = "p cnf #{formula.vars_size} #{formula.clauses_size}\n"
       dimacs_body = ""
       create_table(formula)
-      formula.each do |node|
+      formula.each_with_clause do |node|
         case node
-        when AndNode
-        when OrNode then dimacs_body << "\n"
+        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] << " "
+        when VarNode then dimacs_body << @name_table[node]
         end
       end
-
-      dimacs_body.gsub!(/\n{2,}/, "\n").gsub!(/\n/, "0\n") << '0'
+      dimacs_body << " 0\n"
 
       dimacs_header + dimacs_body
     end

data/lib/ravensat/dimacs.rb

@@ -0,0 +1,6 @@
+module Ravensat
+  dir = File.dirname(__FILE__) + '/dimacs'
+
+  autoload :DimacsEncoder, dir + '/dimacs_encoder.rb'
+  autoload :DimacsDecoder, dir + '/dimacs_decoder.rb'
+end

data/lib/ravensat/extension/domain.rb

@@ -0,0 +1,24 @@
+module Ravensat
+  module Extension
+    module Domain
+      LOCAL_VARIABLE_TABLE = {}
+      def int(*vars)
+        vars.each do |var|
+          next if var.is_defined?
+          LOCAL_VARIABLE_TABLE[var.name] = Ravensat::Extension::IntegerVariable.new(var.name, var.args)
+        end
+      end
+
+      def bool(*vars)
+        vars.each do |var|
+          next if var.is_defined?
+          LOCAL_VARIABLE_TABLE[var.name] = Ravensat::Extension::BooleanVariable.new(var.name, var.args)
+        end
+      end
+
+      def method_missing(name, *args)
+        LOCAL_VARIABLE_TABLE[name] || UndefinedVariable.new(name, args)
+      end
+    end
+  end
+end

data/lib/ravensat/extension/variable/boolean_variable.rb

@@ -0,0 +1,17 @@
+require 'forwardable'
+
+module Ravensat
+  module Extension
+    class BooleanVariable < Variable
+      extend Forwardable
+      delegate Node.public_instance_methods(false) => :@var_node
+      delegate OprNode.public_instance_methods(false) => :@var_node
+      delegate VarNode.public_instance_methods(false) => :@var_node
+
+      def initialize(name, args)
+        super
+        @var_node = VarNode.new
+      end
+    end
+  end
+end

data/lib/ravensat/extension/variable/integer_variable.rb

@@ -0,0 +1,63 @@
+module Ravensat
+  module Extension
+    class IntegerVariable < Variable
+
+      attr_reader :var_nodes
+      def initialize(name, args)
+        super
+        return unless args.first.is_a? Range
+        @var_nodes = args.first.zip(Array.new(args.first.size){Ravensat::VarNode.new}).to_h
+      end
+
+      def ==(object)
+        case object
+        when Integer
+          return @var_nodes[object]
+        when IntegerVariable
+          result_formula = Ravensat::InitialNode.new
+          duplicated_keys = self.var_nodes.keys & object.var_nodes.keys
+
+          [self.var_nodes, object.var_nodes].repeated_permutation(duplicated_keys.size) do |var_nodes|
+            result_formula &= Ravensat::RavenClaw.alo(var_nodes.zip(duplicated_keys).map{|arr| arr.first[arr.last]})
+          end
+          return result_formula
+        else
+          raise ArgumentError
+        end
+      end
+
+      def !=(object)
+        case object
+        when Integer
+          return ~(@var_nodes[object])
+        when IntegerVariable
+          result_formula = Ravensat::InitialNode.new
+          duplicated_keys = self.var_nodes.keys & object.var_nodes.keys
+
+          duplicated_keys.each do |index|
+            result_formula &= ~(self.var_nodes[index]) | ~(object.var_nodes[index])
+          end
+          return result_formula
+        else
+          raise ArgumentError
+        end
+      end
+
+      def only_one
+        result_formula = Ravensat::InitialNode.new
+        result_formula &= Ravensat::RavenClaw.alo @var_nodes.values
+        result_formula &= Ravensat::RavenClaw.amo @var_nodes.values
+        result_formula
+      end
+
+      def result
+        result = @var_nodes.select{|key, var_node| var_node.value}.keys
+        if result.one?
+          result.first
+        else
+          result
+        end
+      end
+    end
+  end
+end

data/lib/ravensat/extension/variable/undefined_variable.rb

@@ -0,0 +1,9 @@
+module Ravensat
+  module Extension
+    class UndefinedVariable < Variable
+      def is_defined?
+        false
+      end
+    end
+  end
+end

data/lib/ravensat/extension/variable/variable.rb

@@ -0,0 +1,16 @@
+module Ravensat
+  module Extension
+    class Variable
+
+      attr_reader :name, :args
+      def initialize(name, args)
+        @name = name
+        @args = args
+      end
+
+      def is_defined?
+        true
+      end
+    end
+  end
+end

data/lib/ravensat/extension.rb

@@ -0,0 +1,13 @@
+module Ravensat
+  module Extension
+    dir = File.dirname(__FILE__) + '/extension'
+
+    autoload :Domain, dir + '/domain.rb'
+    autoload :Variable, dir + '/variable/variable.rb'
+    autoload :BooleanVariable, dir + '/variable/boolean_variable.rb'
+    autoload :IntegerVariable, dir + '/variable/integer_variable.rb'
+    autoload :UndefinedVariable, dir + '/variable/undefined_variable.rb'
+
+    extend Domain
+  end
+end

data/lib/ravensat/ravenclaw.rb

@@ -1,15 +1,19 @@
 module Ravensat
-  class RavenClaw
-    def initialize; end
-
-    def self.alo(prop_vars)
-      prop_vars.reduce(:|)
+  module RavenClaw
+    def self.alo(bool_vars)
+      bool_vars.reduce(:|)
     end
 
-    def self.amo(prop_vars)
-      prop_vars.combination(2).map do |e|
+    def self.amo(bool_vars)
+      bool_vars.combination(2).map do |e|
         e.map(&:~@).reduce(:|)
       end.reduce(:&)
     end
+
+    def self.all_different(*int_vars)
+      int_vars.combination(2).map do |int_var|
+        int_var.reduce(:!=)
+      end.reduce(:&)
+    end
   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.2.1"
+  VERSION = "0.3.1"
 end

data/lib/ravensat.rb

@@ -7,17 +7,12 @@ module Ravensat
   ast = File.dirname(__FILE__) + '/ravensat/ast'
   arcteryx = File.dirname(__FILE__) + '/arcteryx'
 
+  require_relative ravensat + "/ast.rb"
+  require_relative ravensat + "/dimacs.rb"
+
   autoload :Solver, ravensat + '/solver.rb'
-  autoload :DimacsEncoder, ravensat + '/dimacs_encoder.rb'
-  autoload :DimacsDecoder, ravensat + '/dimacs_decoder.rb'
   autoload :RavenClaw, ravensat + '/ravenclaw.rb'
-
-  autoload :Node, ast + '/node.rb'
-  autoload :VarNode, ast + '/var_node.rb'
-  autoload :OprNode, ast + '/opr_node.rb'
-  autoload :AndNode, ast + '/and_node.rb'
-  autoload :OrNode, ast + '/or_node.rb'
-  autoload :NotNode, ast + '/not_node.rb'
+  autoload :Extension, ravensat + '/extension.rb'
 
   autoload :Arcteryx, arcteryx + '/arcteryx.rb'
 end

metadata

@@ -1,22 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: ravensat
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - rikuto matsuda
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-16 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
 - p99y92og@s.okayama-u.ac.jp
-executables: []
+executables:
+- ravensat
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -28,17 +30,27 @@ files:
 - bin/console
 - bin/setup
 - example/magic_square_3x3.rb
+- exe/ravensat
 - lib/arcteryx/arcteryx.rb
 - lib/arcteryx/cnf.rb
 - lib/ravensat.rb
+- lib/ravensat/ast.rb
 - lib/ravensat/ast/and_node.rb
+- lib/ravensat/ast/initial_node.rb
 - lib/ravensat/ast/node.rb
 - lib/ravensat/ast/not_node.rb
 - lib/ravensat/ast/opr_node.rb
 - lib/ravensat/ast/or_node.rb
 - lib/ravensat/ast/var_node.rb
-- lib/ravensat/dimacs_decoder.rb
-- lib/ravensat/dimacs_encoder.rb
+- lib/ravensat/dimacs.rb
+- lib/ravensat/dimacs/dimacs_decoder.rb
+- lib/ravensat/dimacs/dimacs_encoder.rb
+- lib/ravensat/extension.rb
+- lib/ravensat/extension/domain.rb
+- lib/ravensat/extension/variable/boolean_variable.rb
+- lib/ravensat/extension/variable/integer_variable.rb
+- lib/ravensat/extension/variable/undefined_variable.rb
+- lib/ravensat/extension/variable/variable.rb
 - lib/ravensat/ravenclaw.rb
 - lib/ravensat/solver.rb
 - lib/ravensat/version.rb