ruby-minisat 1.14.2

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+lib
+*.gemspec
+tmp

data/LICENSE

@@ -0,0 +1,21 @@
+MiniSat -- Copyright (c) 2003-2005, Niklas Een, Niklas Sorensson
+ruby-minisat -- Copyright (c) 2007,2010 Yusuke Endoh
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,56 @@
+= ruby-minisat
+
+ruby-minisat is ruby binding for MiniSat, which is an open-source SAT solver.
+
+== Installation
+
+  $ gem install ruby-minisat
+
+== How to Use
+
+A brief example that solves a simple SAT problem:
+
+    # solve (a or b) and (not a or b) and (a or not b)
+
+    require "minisat"
+    solver = MiniSat::Solver.new
+    
+    a = solver.new_var
+    b = solver.new_var
+    
+    solver << [a, b] << [-a, b] << [a, -b]
+    
+    p solver.solve  #=> true (satisfiable)
+    
+    p solver[a]  #=> true
+    p solver[b]  #=> true
+
+For more examples, see the examples directory in the distribution.
+
+== Copyright
+
+ruby-minisat is covered under the MIT License.
+This package includes MiniSat in the directory minisat/*, which is also
+distributed under the MIT License.
+
+
+MiniSat -- Copyright (c) 2003-2005, Niklas Een, Niklas Sorensson
+ruby-minisat -- Copyright (c) 2007,2010 Yusuke Endoh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  jeweler_tasks = Jeweler::Tasks.new do |gem|
+    gem.name = "ruby-minisat"
+    gem.summary = %Q{ruby binding for MiniSat, which is an open-source SAT solver}
+    gem.description = gem.summary
+    gem.email = "mame@tsg.ne.jp"
+    gem.homepage = "http://github.com/mame/ruby-minisat"
+    gem.authors = ["Yusuke Endoh"]
+    gem.extensions = FileList['ext/**/extconf.rb']
+    gem.files.include FileList['ext/**/*', 'minisat/**/*/**']
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby-minisat #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('ext/**/*.c')
+end
+
+begin
+  require 'rake/extensiontask'
+  require 'rake/extensiontesttask'
+
+  Rake::ExtensionTask.new('minisat', jeweler_tasks.gemspec)
+rescue LoadError
+end

data/VERSION

@@ -0,0 +1 @@
+1.14.2

data/examples/compat18.rb

@@ -0,0 +1,65 @@
+if RUBY_VERSION < "1.9.0"
+  require "enumerator"
+  class Array
+    def permutation(n = nil, ary = [])
+      n = size unless n
+      if n == 0
+        yield ary
+      else
+        each_with_index do |x, i|
+          (self[0 ... i] + self[i + 1 .. -1]).
+            permutation(n - 1, ary + [x]) {|r| yield r }
+        end
+      end
+    end
+    def combination(n)
+      if n == 0
+        yield []
+      else
+        (0 .. size - n).each do |i|
+          self[i + 1 ... size].combination(n - 1) do |ary|
+            yield [self[i]] + ary
+          end
+        end
+      end
+    end
+    def product(ary)
+      result = []
+      self.each do |i|
+        ary.each do |j|
+          result << [i, j]
+        end
+      end
+      result
+    end
+    alias flatten_org flatten
+    def flatten(i = nil)
+      if i
+        a = self
+        i.times do
+          r = []
+          a.each do |x|
+            x.is_a?(Array) ? r += x : r << x
+          end
+          a = r
+        end
+        a
+      else
+        flatten_org
+      end
+    end
+  end
+
+  class Range
+    alias step_org step
+    def step(s)
+      if block_given?
+        step_org(s) {|x| yield x }
+      else
+        a = []
+        step_org(s) {|x| a << x }
+        a
+      end
+    end
+  end
+end

data/examples/example.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+# ruby-minisat example -- example.rb
+
+require "minisat"
+
+# initialize solver
+solver = MiniSat::Solver.new
+
+# make variable
+a = solver.new_var
+b = solver.new_var
+
+# input CNF to solver: (a or b) and (not a or b) and (a or not b)
+solver << [a, b] << [-a, b] << [a, -b]
+
+# solve SAT (return true if solvable)
+puts "solve: (a or b) and (not a or b) and (a or not b)"
+solver.solve
+
+# output results
+puts("result: " + (solver.satisfied? ? "SAT" : "UNSAT"))  #=> SAT
+if solver.satisfied?
+  puts "a = #{ solver[a].inspect }"  #=> a = true
+  puts "b = #{ solver[b].inspect }"  #=> a = false
+end

data/examples/example2.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+# ruby-minisat example -- example2.rb
+
+require "minisat"
+
+# initialize solver
+solver = MiniSat::Solver.new
+
+# make variable
+a = solver.new_var
+b = solver.new_var
+
+# input CNF to solver: (a or b) and (not a or b) and (a or not b)
+solver << [a, b] << [-a, b] << [a, -b]
+
+# solve SAT (return true if solvable)
+p solver
+puts "solve: (a or b) and (not a or b) and (a or not b)"
+solver.solve
+p solver
+
+# output results
+puts("result: " + (solver.satisfied? ? "SAT" : "UNSAT"))  #=> SAT
+if solver.satisfied?
+  puts "a = #{ solver[a].inspect }"  #=> a = true
+  puts "b = #{ solver[b].inspect }"  #=> a = false
+end
+puts
+
+
+# solve SAT with assumption
+puts "solve: (a or b) and (not a or b) and (a or not b)"
+puts "assumption: a = false"
+solver.solve(-a)  #=> false
+p solver
+
+# output results
+puts("result: " + (solver.satisfied? ? "SAT" : "UNSAT"))  #=> UNSAT
+if solver.satisfied?
+  puts "a = #{ solver[a].inspect }"
+  puts "b = #{ solver[b].inspect }"
+end
+puts
+
+
+# input additonal CNF to solver: ... and (not a or not b)
+solver << [-a, -b]
+p solver  #=> trivially unsatisfiable
+
+# solve SAT (return true if solvable)
+puts "solve: (a or b) and (not a or b) and (a or not b) and (not a or not b)"
+solver.solve
+
+# output results
+puts("result: " + (solver.satisfied? ? "SAT" : "UNSAT"))  #=> UNSAT
+if solver.satisfied?
+  puts "a = #{ solver[a].inspect }"
+  puts "b = #{ solver[b].inspect }"
+end

data/examples/kakuro.rb

@@ -0,0 +1,178 @@
+#!/usr/bin/env ruby
+
+# ruby-minisat example -- kakuro.rb
+# ref: http://en.wikipedia.org/wiki/Kakuro
+
+##
+## SAT configuration:
+##   - Variables: 9 variables for number to each blank cell
+##   - Clauses: sum of each entry is specified
+##
+
+require "minisat"
+require File.dirname($0) + "/compat18" if RUBY_VERSION < "1.9.0"
+
+
+def error(msg)
+  $stderr.puts msg
+  exit 1
+end
+
+
+def parse_file(file)
+  width = nil
+  field = []
+  File.read(file).split(/\n/).each do |line|
+    next if line[/^\s*#/]
+    field << (line + "  ").
+      scan(/\G(?:(\*\*|\d+)\\(\*\*|\d+)|(\.))(?:\s+|$)/).
+      map {|v, h, b| b ? nil : [v.to_i, h.to_i] }
+  end
+  field
+end
+
+
+def define_sat(solver, field)
+  # define variables
+  vars = field.map do |line|
+    line.map do |c|
+      next if c
+      vs = (1..9).map { solver.new_var }
+      solver << vs
+      vs.combination(2) {|v1, v2| solver << [-v1, -v2] }
+      vs
+    end
+  end
+
+  # define clauses
+  define_entries(solver, field          , vars          ) {|c| c.last }
+  define_entries(solver, field.transpose, vars.transpose) {|c| c.first }
+
+  vars
+end
+
+def define_entries(solver, field, vars)
+  field.zip(vars) do |fline, vline|
+    num = nil
+    ary = []
+    fline.zip(vline) do |c, vs|
+      if c
+        define_entry(solver, num, ary)
+        num, ary = (yield c), []
+      else
+        ary << vs
+      end
+    end
+    define_entry(solver, num, ary) 
+  end
+end
+
+# define constraints for entry
+def define_entry(solver, num, ary)
+  return unless num && !ary.empty?
+  h = {}
+  enum_entry(num, ary.size, 1, []) do |is|
+    (0 ... is.size).each do |n|
+      h[is[0...n]] ||= []
+      h[is[0...n]] |= [is[n]]
+    end
+  end
+  error "bad field" if h.empty?
+  h.each do |bs, as|
+    a = bs.zip(ary).map {|i, vs| -vs[i - 1] }
+    a += as.map {|i| ary[bs.size][i - 1] }
+    solver << a
+  end
+end
+
+# enumerate possible numbers for entry
+#   enum_entry(8, 2) -> [1, 7], [2, 6], [3, 5] and these permutations
+#   enum_entry(9, 3) -> [1, 2, 6], [1, 3, 5], [2, 3, 4] and these permutations
+def enum_entry(num, count, start = 1, ary = [])
+  if count == 0
+    ary.permutation {|r| yield r } if num == 0
+  else
+    (start .. 9).each do |x|
+      break if num < x
+      enum_entry(num - x, count - 1, x + 1, ary + [x]) {|r| yield r }
+    end
+  end
+end
+
+
+def solve_sat(solver)
+  start = Time.now
+  result = solver.solve
+  eplise = Time.now - start
+  puts "time: %.6f sec." % eplise
+  result
+end
+
+
+def make_solution(solver, vars)
+  vars.map {|line| line.map {|vs| (1..9).find {|i| solver[vs[i - 1]]} if vs } }
+end
+
+
+def add_constraint(solver, vars)
+  solver << vars.flatten.compact.map {|v| solver[v] ? -v : v }
+end
+
+
+def output_field(solution, field)
+  field.zip(solution) do |fline, sline|
+    line = fline.zip(sline).map do |c, s|
+      if c
+        f = c.first == 0 ? "##" : "%02d" % c.first
+        s = c.last  == 0 ? "##" : "%02d" % c.last 
+        f + "\\" + s
+      else
+        s.to_s.center(5)
+      end
+    end.join(" ")
+    puts line
+  end
+end
+
+
+
+error "usage: kakuro.rb kakuro.sample" if ARGV.empty?
+
+ARGV.each do |file|
+  field = parse_file(file)
+
+  solver = MiniSat::Solver.new
+
+  puts "defining SAT..."
+  vars = define_sat(solver, field)
+  puts "variables : #{ solver.var_size }"
+  puts "clauses : #{ solver.clause_size }"
+  puts
+
+  puts "solving SAT..."
+  result = solve_sat(solver)
+  puts "result: " + (result ? "solvable" : "unsolvable")
+  puts
+  next unless result
+
+  puts "translating model into solution..."
+  solution = make_solution(solver, vars)
+  puts "solution found:"
+  output_field(solution, field)
+  puts
+
+  puts "checking different solution..."
+  add_constraint(solver, vars)
+  result = solve_sat(solver)
+  puts "result: " +
+    (result ? "different solution found" : "different solution not found")
+  puts
+  next unless result
+
+  puts "translating model into solution..."
+  solution = make_solution(solver, vars)
+  puts "different solution:"
+  output_field(solution, field)
+  puts
+  puts
+end