csp-solver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1b102aca077836539239a3ccd1155506049a4e0
+  data.tar.gz: 09a69a401ada157cd9838443df4e2585670f0a99
+SHA512:
+  metadata.gz: b14e9d098aed00fbd8131b1a4029ce050de66de53ebe8ebc98985081e07b89d8acd2aebbc2a22fe81595653b4df29879e989d7b8646f2e0e5bd643c26b88b2f5
+  data.tar.gz: e97a1a5a895b9782188ab3ed7bd3cd6642d38d9230a4fb34aebaca391cea0192f5d12eeeda58f7a6189736bf4bfd5df4d07ae241ab0b7d51dbe603257d9f76ab

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at moore.niemi@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in csp-solver.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Matthew Barry
+
+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,60 @@
+# CSP::Solver
+A gem for solving arbitrary [constraint satisfaction problems][wiki-csp] (CSPs). If the constraints are [hard][hard-constraints] (as opposed to flexible/soft) and can be specified in the Ruby programming language, then this library can find a solution.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'csp-solver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csp-solver
+
+## Usage
+
+```ruby
+# first we need to set up a Problem
+problem = CSP::Solver::Problem.new
+# then we need to set up some variables and their domain
+problem.vars weekdays, meals
+# then we set up constraints as predicate blocks
+problem.all_pairs(weekdays) { |a, b| a != b}
+# (or you can use the convenience method `all_different`)
+# problem.all_different(weekdays)
+# then it's as simple as calling #solve
+problem.solve
+# which returns to us a hash of variables as keys, and
+# domain entries as values
+# => { weekday: meal }
+```
+
+See also: [Official documentation and API][csp-solver-docs]
+
+## Development
+
+This project makes uses [git-flow][] conventions: the **master** branch is intended for the current stable release. Active development commits should be made on the **develop** branch or, better yet, on **feature/** branches that will merge back into **develop**.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number (`CSP::Solver::VERSION`) in `lib/csp/solver/version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org][].
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/komputerwhiz/csp-solver. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant][] code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[wiki-csp]: http://en.wikipedia.org/wiki/Constraint_satisfaction_problem
+[hard-constraints]: https://en.wikipedia.org/wiki/Constraint_satisfaction_problem#Flexible_CSPs
+[csp-solver-docs]: http://komputerwiz.net/apps/csp-solver[git-flow]: http://nvie.com/posts/a-successful-git-branching-model/
+[rubygems.org]: https://rubygems.org
+[contributor covenant]: http://contributor-covenant.org

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'csp/solver'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start
+
+# require 'irb'
+# IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/csp-solver.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csp/solver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'csp-solver'
+  spec.version       = CSP::Solver::VERSION
+  spec.authors       = ['Matthew Barry', 'Alex Moore-Niemi']
+
+  spec.summary       = 'Solve constraint satisfaction problems with ease.'
+  spec.description   = 'A ruby library for solving arbitrary constraint satisfaction problems. If the constraints can be specified in the ruby programming language, then this library can find a solution.'
+  spec.homepage      = 'https://github.com/komputerwiz/csp-solver'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+end

data/lib/csp.rb

@@ -0,0 +1 @@
+require 'csp/solver'

data/lib/csp/solver.rb

@@ -0,0 +1,132 @@
+require 'csp/solver/version'
+require 'csp/solver/convenient_constraints'
+require 'securerandom'
+
+module CSP
+  module Solver
+    # You initialize a problem, set its variables and constraints, then
+    # can call `solve` on it.
+    class Problem
+      include ConvenientConstraints
+
+      def initialize
+        @vars = {}
+        @gen_prefix = '__gen__'
+
+        @unary_constraints = Hash.new { |h, k| h[k] = [] }
+        @binary_constraints = Hash.new { |h, k| h[k] = [] }
+      end
+
+      # backtracking algorithm with interleaved local constraint propagation
+      def solve(domains = @vars)
+        # deep-copy domains to prevent changes from "leaking" to outside
+        domains = domains.each_with_object({}) { |(k, v), ds| ds[k] = v.dup; ds }
+
+        return false unless ac3(domains)
+
+        if domains.values.all? { |dom| dom.size == 1 }
+          return domains.each_with_object({}) do |(k, v), sol|
+            sol[k] = v[0] unless k.is_a?(String) && k.start_with?(@gen_prefix)
+            sol
+          end
+        end
+
+        var = domains.select { |_var, dom| dom.size > 1 }.keys.sort_by { |k| domains[k].size }.first
+        dom = domains[var]
+
+        dom.each do |value|
+          domains[var] = [value]
+
+          result = solve(domains)
+          return result if result
+        end
+
+        domains[var] = dom
+
+        false
+      end
+
+      def var(id, domain)
+        @vars[id] = domain.to_a
+      end
+
+      def vars(ids, domain)
+        ids.each { |id| var(id, domain.dup) }
+      end
+
+      def assign(hash)
+        hash.each { |x, v| @vars[x] = [v] }
+      end
+
+      def constrain(*vars, &pred)
+        case vars.length
+        when 1
+          unary_constrain(vars[0], &pred)
+        when 2
+          binary_constrain(vars[0], vars[1], &pred)
+        else
+          nary_constrain(vars, &pred)
+        end
+      end
+
+      private
+
+      def ac3(vars)
+        vars.each do |var, domain|
+          next unless @unary_constraints.key? var
+          domain.reject! { |x| !@unary_constraints[var].all? { |c| c.call(x) } }
+          return false if domain.empty?
+        end
+
+        worklist = @binary_constraints.keys
+
+        until worklist.empty?
+          x, y = worklist.shift
+          reduced_domain = vars[x].reject! { |vx| !vars[y].any? { |vy| @binary_constraints[[x, y]].all? { |c| c.call(vx, vy) } } }
+          unless reduced_domain.nil?
+            return false if vars[x].empty?
+            worklist |= @binary_constraints.keys.select { |k| k.include?(x) && !k.include?(y) }
+          end
+        end
+
+        true
+      end
+
+      def unary_constrain(x, &pred)
+        raise "No variable #{x}" unless @vars.key? x
+
+        @unary_constraints[x] << pred
+      end
+
+      def binary_constrain(x1, x2, &pred)
+        raise "No variable #{x1}" unless @vars.key? x1
+        raise "No variable #{x2}" unless @vars.key? x2
+
+        @binary_constraints[[x1, x2]] << pred
+
+        # note the swapped parameter order
+        @binary_constraints[[x2, x1]] << proc { |v2, v1| yield(v1, v2) }
+      end
+
+      def nary_constrain(vars)
+        vars.each do |x|
+          raise "No variable #{x}" unless @vars.key? x
+        end
+
+        # Reduce n-way constraint to binary constraints:
+        # Generate auxiliary variable to serve as binary intermediary between all constrained variables.
+        # This variable's full domain is the cartesian product of all constrained variables' domains,
+        # but here we filter the domain to only the values that satisfy the constraint.
+        head, *tail = vars.map { |x| @vars[x] }
+        dom = head.product(*tail).select { |tuple| yield(*tuple) }
+        gen_id = @gen_prefix + SecureRandom.uuid
+
+        var(gen_id, dom)
+
+        vars.each_with_index do |x, i|
+          binary_constrain(x, gen_id) { |v, tuple| v == tuple[i] }
+        end
+      end
+    end
+  end
+end

data/lib/csp/solver/convenient_constraints.rb

@@ -0,0 +1,20 @@
+module CSP
+  module Solver
+    # These methods are convenience methods to allow you
+    # to set common constraints (predicates) on your Problem.
+    module ConvenientConstraints
+      def all_pairs(vars, &block)
+        pairs = vars.repeated_combination(2).reject { |x, y| x == y }
+        pairs.each { |x, y| constrain(x, y, &block) }
+      end
+
+      def all_same(vars)
+        all_pairs(vars) { |x, y| x == y }
+      end
+
+      def all_different(vars)
+        all_pairs(vars) { |x, y| x != y }
+      end
+    end
+  end
+end

data/lib/csp/solver/version.rb

@@ -0,0 +1,5 @@
+module CSP
+  module Solver
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: csp-solver
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Barry
+- Alex Moore-Niemi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: A ruby library for solving arbitrary constraint satisfaction problems.
+  If the constraints can be specified in the ruby programming language, then this
+  library can find a solution.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- csp-solver.gemspec
+- lib/csp.rb
+- lib/csp/solver.rb
+- lib/csp/solver/convenient_constraints.rb
+- lib/csp/solver/version.rb
+homepage: https://github.com/komputerwiz/csp-solver
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Solve constraint satisfaction problems with ease.
+test_files: []