whatnot 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d99b73ec46c7bc6666a955f1964d5ac9c899e800
+  data.tar.gz: 06fa24a955a158fd0c353a27ac4b8668351dfc6a
+SHA512:
+  metadata.gz: 326771f21e8b3fb830fa4984274dacb681ab94d007a8e9742287a848e64fba0e402a1a30aa8a65c8ca696da3dcfbb01928dc67b9314c97dc7c6161a505909cb8
+  data.tar.gz: 06c18358cab757a294f5c9492e1cad0c19f80452159b6aa749bd47e307ac13ae3eabe30d3355dbb4609e3d79fb52be2ee466b602803348d03e478a37d1f9d342

data/.bundle/binstubs/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bundler', 'bundler')

data/.bundle/binstubs/git-changelog

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'git-changelog' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('whatnot', 'git-changelog')

data/.bundle/binstubs/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/.bundle/binstubs/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/.bundle/binstubs/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/.bundle/binstubs/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec 

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    whatnot (1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (>= 0.8.7)
+  rspec (>= 1.3.0)
+  whatnot!
+
+BUNDLED WITH
+   1.10.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 PRIMEDIA
+
+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.md

@@ -0,0 +1,58 @@
+# Whatnot
+
+Whatnot is a Ruby wrapper for the Minisat CSP solver with flexible constraint definition syntax.
+
+### Motivation
+
+I looked at the existing tools for constraint-solving in Ruby and found that they were either: (a) too slow to handle highly complex systems of constraints, or (b) too inflexible to support all but the most well-known types of problems. So I wanted to provide a tool that was both flexible and fast.
+
+### Concepts
+
+To define a constraint problem, you can create two types of variables:
+
+1. A *slot*: a variable that can only hold one value in an array of possible values.
+2. A *set*: a variable that can hold one or more of an array of values.
+
+Then you may specify any number of *constraints* between any number of variables.
+
+### Syntax
+
+#### Initializing
+
+First, you have to create a SwitchInterpreter:
+
+```ruby
+i = SwitchInterpreter.new
+```
+
+#### Creating variables
+
+To create a slot called `:B` which can either hold `1` or `2`:
+
+```ruby
+i.create_slot(:B, [1,2])
+```
+
+To create a set called `:C` which can hold up to 3 values between 1 and 6:
+
+```ruby
+i.create_set(:C, [1,2,3,4,5,6], max_values: 3)
+```
+
+#### Creating constraints
+
+To create a constraint that all values of C should be greater than B:
+
+```ruby
+i.create_constraint(:C, :B) { |**sol| sol[:C].all? { |c| c > sol[:B] } }
+```
+
+### Installing
+
+Minisat must be installed. On a Mac:
+
+```bash
+$ brew install gcc
+$ brew install minisat
+```
+

data/lib/whatnot.rb

@@ -0,0 +1,3 @@
+require 'pp'
+
+Dir.glob(File.expand_path("../whatnot/*", __FILE__)).each { |f| require f }

data/lib/whatnot/dimacs_cnf_printer.rb

@@ -0,0 +1,116 @@
+require 'json'
+
+module Whatnot
+  class DimacsCNFPrinter
+    def initialize(*args)
+      @vars = {}
+      @vars_total = 1
+      @file = File.open("solver-out.txt", "w+")
+    end
+
+    attr_reader :file
+
+    def puts(str="")
+      @file << str.chomp + "\n"
+    end
+
+    def value_name_from_pair(name, value)
+      "#{name}=#{value.to_json}"
+    end
+
+    def vars(names, domain)
+      names.each do |name|
+        var(name, domain)
+      end
+    end
+
+    def var(name, domain)
+      puts "c -------------"
+      puts "c uniquifying..."
+      puts "c var:    #{name.inspect}"
+
+      iter1 = true
+      JSON.pretty_generate(domain).each_line do |slice|
+        prefix = iter1 ? "c domain: " : "c         "
+        iter1 = false
+        puts "#{prefix}#{slice}"
+      end
+
+      new_var = DimacsCNFVar.new(name, domain, key_iter: @vars_total)
+      @vars_total = new_var.key_iter()
+
+      # it must be at least one of the possible values
+      puts "#{new_var.all_keys_as_array().join(" ")} 0"
+
+      # it can't be two values
+      new_var.all_keys_as_array().combination(2).each do |key1, key2|
+        puts "-#{key1} -#{key2} 0"
+      end
+
+      @vars[name] = new_var
+
+      puts "c -------------"
+      puts
+    end
+
+    def all_different(varnames)
+      puts "c -------------"
+      puts "c all_different..."
+      puts "c varnames: #{varnames.inspect}"
+
+      varnames.combination(2).each do |varname1, varname2|
+        var1 = @vars[varname1]
+        var2 = @vars[varname2]
+
+        var1.matching_pairs(var2).each do |key1, key2|
+          puts "-#{key1} -#{key2} 0"
+        end
+      end
+      puts "c -------------"
+
+    end
+
+    def constrain(*varnames)
+      puts "c -------------"
+      puts "c constraining..."
+      puts "c varnames: #{varnames.inspect}"
+
+      argument_sets = nil
+      varnames.each do |varname|
+        argument_set = @vars[varname].argument_set()
+
+        if argument_sets.nil?
+          argument_sets ||= argument_set
+        else
+          argument_sets = argument_sets.product(argument_set).map(&:flatten)
+        end
+      end
+
+      argument_sets.each do |argument_set|
+        arguments_to_constraint = argument_set.values_at(* argument_set.each_index.select {|i| i.even?})
+        key_set =                 argument_set.values_at(* argument_set.each_index.select {|i| i.odd?})
+
+        result = yield(*arguments_to_constraint)
+
+        if !result
+          puts "#{key_set.map { |k| "-" + k.to_s }.join(" ")} 0"
+        end
+      end
+
+      puts "c -------------"
+    end
+
+    def all_pairs(vars, &block)
+      vars.combination(2).each do |var1, var2|
+        constrain(var1, var2, &block)
+      end
+    end
+
+    def solve
+      `minisat solver-out.txt minisat-out.txt`
+
+      solution = File.read("minisat-out.txt").lines[1]
+      DimacsCNFVar.interpret(solution)
+    end
+  end
+end

data/lib/whatnot/dimacs_cnf_var.rb

@@ -0,0 +1,73 @@
+module Whatnot
+  class DimacsCNFVar
+    def self.names
+      @@names ||= {}
+    end
+
+    def self.keys
+      @@keys ||= {}
+    end
+
+    def value_name_from_pair(name, value)
+      "#{name}=#{value.to_json}"
+    end
+
+    def self.interpret(solution)
+      keys = solution.split(" ").map(&:to_i).select { |k| k > 0 }
+      values = DimacsCNFVar.names.values_at(*keys)
+
+      values = values.map do |val|
+        key, v = *val.match(/\A([^=]+)=(.*)\Z/)[1..2]
+        [key.to_sym, JSON.parse(v)]
+      end
+
+      Hash[values]
+    end
+
+    attr_reader :all_keys_as_array, :key_iter
+
+    def initialize(name, domain, key_iter: 1)
+      @name = name
+      @domain = domain
+      @key_iter = key_iter
+
+      generate_keys
+    end
+
+    def matching_pairs(var2)
+      (self.keys_by_value.keys & var2.keys_by_value.keys).map do |value|
+        [self.keys_by_value[value], var2.keys_by_value[value]]
+      end
+    end
+
+    def argument_set
+      keys_by_value.to_a
+    end
+
+    protected
+
+    def generate_keys
+      all_val_keys = []
+
+      @domain.each do |value|
+        value_name = value_name_from_pair(@name, value)
+        all_val_keys << @key_iter
+
+        DimacsCNFVar.names[@key_iter] = value_name
+        DimacsCNFVar.keys[value_name] = @key_iter
+        @key_iter += 1
+      end
+
+      @all_keys_as_array = all_val_keys
+    end
+
+    def keys_by_value
+      @keys_by_value ||=
+        begin
+          arr = DimacsCNFVar.keys.select { |k,v| k.start_with?(@name.to_s) }
+          arr = arr.map { |k,v| [JSON.parse(k[(@name.to_s.size+1)..-1], symbolize_names: true), v] }
+          Hash[arr]
+        end
+    end
+  end
+end

data/lib/whatnot/failed_solution_switch_group.rb

@@ -0,0 +1,25 @@
+# a simple object that represents a failed constraint. acts as SwitchGroup.
+class FailedSolutionSwitchGroup
+  attr_accessor :failed_solutions
+
+  def initialize(failed_solution_dimacs_strings)
+    @failed_solutions = failed_solution_dimacs_strings
+  end
+
+  def dimacs
+    @failed_solutions.map { |str| inverse_of(str) }.join
+  end
+
+  def switches
+    []
+  end
+
+  private
+
+  def inverse_of(solution_string)
+    solution_string.
+      split(" ").
+      map { |num| (num.to_i * -1).to_s }.
+      join(" ") + "\n"
+  end
+end