exact_matrix_cover 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c6e7574ad57165ba9c0a705f7b5923c5a5bfb071f3b06e1888832b27029579d
+  data.tar.gz: 44afa979f59f6d6d8fd18b4bb922d83cd5d47d3c69436ed9aea037531756930b
+SHA512:
+  metadata.gz: 69fa202fdca99e2921014a0bff4f09862adb236fc3c05acfe2a61e97b5931d1e8ab8b742f992ad8b098459b24f5e2aaa9dbc22e87bc6fba103933a860df8d291
+  data.tar.gz: 82dcf7d5a84dedda95feab12895aa844b427c7f0b5698d4f335cd751237b243e6226a23d6ad015c8ffe4aaa25b06a1102637bd4174a9aca7359145030b3a0f84

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in exact_cover.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    exact_matrix_cover (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug
+  exact_matrix_cover!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jerome Marhic
+
+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,80 @@
+# ExactCover
+
+This gem is a ruby implementation of D.Knuth's paper "Dancing Link" : https://arxiv.org/abs/cs/0011047
+It implements a solver for the "exact cover of a matrix" problem. For a given matrix of 0s and 1s, it finds a set of
+rows that contains exactly one "1" in each column.
+This can be used to implement a tetramino or a sudoku solver.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exact_cover'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exact_cover
+
+## Usage
+
+Basic usage
+```
+require "exact_cover"
+
+matrix =
+  [
+    [0, 0, 1, 0, 1, 1, 0],
+    [1, 0, 0, 1, 0, 0, 1],
+    [0, 1, 1, 0, 0, 1, 0],
+    [1, 0, 0, 1, 0, 0, 0],
+    [0, 1, 0, 0, 0, 0, 1],
+    [0, 0, 0, 1, 1, 0, 1]
+  ]
+
+solutions = ExactCover::CoverSolver.new(matrix).call
+solutions.count
+# => 1
+solutions.first
+# => [[1, 0, 0, 1, 0, 0, 0], [0, 1, 0, 0, 0, 0, 1], [0, 0, 1, 0, 1, 1, 0]]
+# this corresponds to the 4th, 3rd and first rows of the given matrix
+```
+
+You can iterate through all the solutions
+```
+require "exact_cover"
+
+matrix =
+  [
+    [1, 1],
+    [0, 1],
+    [1, 0]
+  ]
+
+solutions = ExactCover::CoverSolver.new(matrix).call
+solutions.count
+# => 2
+solutions.next
+# => [[1, 1]]
+solutions.next
+# => [[1, 0], [0, 1]]
+```
+
+## Development
+
+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 in `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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/exact_cover.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "exact_cover"
+
+# 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(__FILE__)

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/exact_cover.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "exact_cover/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "exact_matrix_cover"
+  spec.version       = ExactCover::VERSION
+  spec.authors       = ["Jerome Marhic"]
+  spec.email         = ["jerome.marhic@effilab.com"]
+
+  spec.summary       = "Find the set of rows that correspond to an exact cover for a given matrix."
+  spec.description   = "Implementation of D.Knuth 'dancing links' algorithm to solve the exact cover problem."
+  spec.homepage      = "https://github.com/MarhicJeromeGIT/exact_cover"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

data/lib/exact_cover.rb

@@ -0,0 +1,8 @@
+require "exact_cover/version"
+require "exact_cover/cover_solver"
+require "exact_cover/matrix_preprocessor"
+require "exact_cover/data_object"
+require "exact_cover/column_object"
+
+module ExactCover
+end

data/lib/exact_cover/column_object.rb

@@ -0,0 +1,14 @@
+module ExactCover
+  # a column header
+  class ColumnObject < DataObject
+    attr_accessor :size # size (number of 1 in the column)
+    attr_reader :name # name
+
+    def initialize(size, name)
+      super(nil)
+
+      @size = size
+      @name = name
+    end
+  end
+end

data/lib/exact_cover/cover_solver.rb

@@ -0,0 +1,165 @@
+# Cover problem solver
+# Ruby implementation of https://arxiv.org/abs/cs/0011047 (Dancing Link algorithm)
+# Can be used to solve tetramino or sudoku problems
+# @author Marhic Jerome 2019
+
+module ExactCover
+  # Solves the cover problem with algorithm "X"
+  class CoverSolver
+    class InvalidMatrixSize < StandardError; end
+
+    attr_reader :matrix
+    attr_reader :column_count
+
+    def initialize(matrix)
+      @matrix = matrix
+      # sanity check
+      if !matrix.is_a?(Array) || matrix.size == 0 || matrix[0].size == 0
+        raise(InvalidMatrixSize, "non-empty 2-dimensional array expected, got #{matrix.inspect}")
+      end
+
+      @column_count = matrix[0].size
+    end
+
+    # Solve the exact cover problem for the given matrix
+    # @return [Enumerator] An enumeration of the all the possible solutions
+    def call
+      root = MatrixPreprocessor.new(matrix).call
+      Enumerator.new do |y|
+        search(0, root, y)
+      end
+    end
+
+    private
+
+    # @param k [Integer] solution "deepness"
+    # @param root [ColumnObject] root
+    # @param y [Yielder] enumerator yielder
+    # @param solution [Array<DataObject>] current solution
+    def search(k, root, y, solution = [])
+      if root.right == root
+        y.yield format_solution(solution)
+        return
+      end
+
+      column = choose_column(root)
+      cover_column(column)
+
+      r = column.down
+      loop do
+        break if r == column
+
+        solution[k] = r
+
+        j = r.right
+        loop do
+          break if j == r
+
+          cover_column(j.column)
+          j = j.right
+        end
+
+        search(k + 1, root, y, solution.dup)
+
+        j = r.left
+        loop do
+          break if j == r
+
+          uncover_column(j.column)
+
+          j = j.left
+        end
+
+        r = r.down
+      end
+
+      uncover_column(column)
+    end
+
+    # @solution consists in an array of DataObject,
+    # formats it to an array of 0 and 1 rows (corresponding to some rows of the given matrix)
+    # @return [Array<Array>] Subset of the matrix rows corresponding to an exact cover
+    def format_solution(solution)
+      rows = []
+      solution.each do |data_object|
+        row = Array.new(column_count, 0)
+        current = data_object
+        loop do
+          row[current.column.name.to_i] = 1
+          current = current.right
+          break if current == data_object
+        end
+        rows << row
+      end
+      rows
+    end
+
+    def choose_column(root)
+      # Minimize the branching factor by choosing the column with the lowest size
+      min_size = root.right.size
+      min_size_column = root.right
+
+      current_column = min_size_column.right
+      loop do
+        break if current_column == root
+
+        if current_column.size < min_size
+          min_size = current_column.size
+          min_size_column = current_column
+        end
+
+        current_column = current_column.right
+      end
+
+      min_size_column
+    end
+
+    # removes c from the header list
+    # @param column [ColumnObject]
+    def cover_column(column)
+      column.right.left = column.left
+      column.left.right = column.right
+
+      i = column.down
+      loop do
+        break if i == column
+
+        j = i.right
+        loop do
+          break if j == i
+
+          j.down.up = j.up
+          j.up.down = j.down
+          j.column.size -= 1
+
+          j = j.right
+        end
+
+        i = i.down
+      end
+    end
+
+    def uncover_column(column)
+      i = column.up
+      loop do
+        break if i == column
+
+        j = i.left
+        loop do
+          break if j == i
+
+          j.column.size += 1
+          j.down.up = j
+          j.up.down = j
+
+          j = j.left
+        end
+
+        i = i.up
+      end
+
+      column.left.right = column
+      column.right.left = column
+    end
+  end
+end

data/lib/exact_cover/data_object.rb

@@ -0,0 +1,16 @@
+module ExactCover
+  # represents a "1" in the given matrix
+  class DataObject
+    attr_accessor :left, :right, :up, :down # left, right, up and down links
+    attr_reader :column # link to column object
+
+    # @param column [ColumnObject]
+    def initialize(column)
+      @column = column
+      @left = nil
+      @right = nil
+      @up = nil
+      @down = nil
+    end
+  end
+end

data/lib/exact_cover/matrix_preprocessor.rb

@@ -0,0 +1,96 @@
+module ExactCover
+  # Transforms an array into a linked list of data and column objects
+  class MatrixPreprocessor
+    attr_reader :matrix
+    attr_reader :row_count
+    attr_reader :col_count
+
+    def initialize(matrix)
+      @matrix = matrix
+      @row_count = matrix.size
+      @col_count = matrix[0].size
+    end
+
+    def call
+      # Generates the column objects
+      headers = []
+      (0..col_count - 1).each do |col|
+        col_size = size(col)
+        headers[col] = ColumnObject.new(col_size, col.to_s)
+      end
+
+      # Fill the left and right for each header object
+      prev = headers[-1]
+      headers.each do |current|
+        current.left = prev
+        prev.right = current
+        prev = current
+      end
+
+      # Generates the data objects (one for each 1 in the matrix)
+      data_objects = []
+      row_objects_array = []
+      col_objects_array = []
+      (0..row_count - 1).each do |row|
+        data_objects[row] = []
+        row_objects_array[row] = []
+        (0..col_count - 1).each do |col|
+          column = headers[col]
+          col_objects_array[col] = [column] if col_objects_array[col].nil?
+          next unless matrix[row][col] == 1
+
+          data_object = DataObject.new(column)
+          data_objects[row][col] = data_object
+          row_objects_array[row] << data_object
+          col_objects_array[col] << data_object
+        end
+      end
+
+      # Fill the left and right fields
+      row_objects_array.each do |row_objects|
+        prev = row_objects[-1]
+        loop do
+          break if row_objects.empty?
+
+          current = row_objects.shift
+          current.left = prev
+          prev.right = current
+          prev = current
+        end
+      end
+
+      # Fill the up and down fields
+      col_objects_array.each do |col_objects|
+        prev = col_objects[-1]
+        loop do
+          break if col_objects.empty?
+
+          current = col_objects.shift
+          current.up = prev
+          prev.down = current
+          prev = current
+        end
+      end
+
+      # insert the root between headers[-1] and headers[0]
+      root = ColumnObject.new(0, "root")
+      headers[-1].right = root
+      headers[0].left = root
+      root.right = headers[0]
+      root.left = headers[-1]
+
+      root
+    end
+
+    private
+
+    # @return [Integer] Number of 1 in the given column
+    def size(col)
+      size = 0
+      (0..row_count - 1).each do |row|
+        size += 1 if matrix[row][col] == 1
+      end
+      size
+    end
+  end
+end

data/lib/exact_cover/version.rb

@@ -0,0 +1,3 @@
+module ExactCover
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: exact_matrix_cover
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jerome Marhic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Implementation of D.Knuth 'dancing links' algorithm to solve the exact
+  cover problem.
+email:
+- jerome.marhic@effilab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exact_cover.gemspec
+- examples/sudoku.rb
+- lib/exact_cover.rb
+- lib/exact_cover/column_object.rb
+- lib/exact_cover/cover_solver.rb
+- lib/exact_cover/data_object.rb
+- lib/exact_cover/matrix_preprocessor.rb
+- lib/exact_cover/version.rb
+homepage: https://github.com/MarhicJeromeGIT/exact_cover
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Find the set of rows that correspond to an exact cover for a given matrix.
+test_files: []