knossos 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14ddf78b4ee346ccd47871a10ea3da7217f0a2d4b8b4057d8024bb02c8b6940c
-  data.tar.gz: 7ccba0d9c547d891381142c46a862487d9571af0c6183fe7dfb250faaed44249
+  metadata.gz: 8c2bf5993f7288ba9f26d3d51455bf2844f36bd650e1cc3816eaac6e181c6316
+  data.tar.gz: fd09305e92ecf3ff5332b251888659187258ba3b4e6d59e36df64741e7c7c471
 SHA512:
-  metadata.gz: bd6e51fd8a7116c1f5844e9b0bd98e80ad7edc540d0f3e9a014d16b1cc332013aa825bca03d63adea764e93d9c48e1b8492fb812619d1e2e956def4a8669f98f
-  data.tar.gz: caa60fb3da899b1e69affbdf172e2a8621a8dd588bc9631b0fbf710aa8985f07ae2e2aa02c924940144a501bf0c74fd7c0ee0b60adff9e67e7dcee2180aae59f
+  metadata.gz: 14ae5ceee9e2771b005cbb7900cc753ac7279e3083cc2eb802c96372068d98bc4aea057561afc85a6daca227b45d794f128b1234688d9580ea056d38a82df5db
+  data.tar.gz: 135dddf5a3c9542cf346f618c14e27444fae24a58669523549140077703176dc60009159de8b23af4393a0ae996e2e7e27b669afd3cc3e30c09d61822a79470a

data/CHANGELOG.md

@@ -4,32 +4,70 @@ All notable changes to this project will be documented in this file.
 This project uses [Semantic Versioning][sv].
 
 ## [Unreleased][new]
+
+## [0.3.0][0.3.0] — 2020-01-26
+
+### Added
+- Add the `HuntAndKill` algorithm for generating mazes.
+- `BinaryTree` accepts an option to configure the bias.
+- Algorithms accept an argument to `#carve` to set the seed for the random number
+  generator.
+- Create a `Serializer` module to hold the methods that encode mazes for
+  archiving and transfer.
+- Add the `Bitmask` serializer to represent the maze as a matrix of integers,
+  where each integer is a bitfield encoding the passage directions.
+- Add `Bitmask#deserialize` to decode an array of bitmasked integers into a
+  maze.
+- Create a `Solver` module to hold algorithms that analyze or plot solutions to
+  mazes.
+- Create `Solver::Distances` helper class to store the distances from a root
+  cell to any other cell in the maze.
+- Add `Dijkstra#distances_from` to calculate the distances from a given cell to
+  every other cell in the maze.
+- Add `Dijkstra#shortest_path` to extract the shortest path from the starting
+  cell to a given goal.
+- Add `Dijkstra#longest_path` to find the longest path in the entire maze.
+- Display all distances or the solution path within the rendered grid.
+
+### Changed
+- Change `carve` to be an instance method of the Algorithm classes.
+
+### Fixed
+- Update Usage in README with namespace changes.
+
+## [0.2.0][0.2.0] — 2020-01-09
+
 ### Changed
 - Correctly nest the `Algorithm` module within the `Knossos` namespace.
 - Correctly nest the `Renderer` module within the `Knossos` namespace.
 
 ## [0.1.0][0.1.0] — 2020-01-07
+
 ### Added
 - Create an `Algorithm` module to hold the maze generators.
 - Create a `Renderer` module to hold the methods that produce graphical
 representations of a maze.
 - Create `Renderer::Text` to produce ASCII text representations.
+
 ### Changed
-- Move `AldousBroder` to the `Algorithm` module
-- Move `BinaryTree` to the `Algorithm` module
-- Move `RecursiveBacktracker` to the `Algorithm` module
-- Move `Sidewinder` to the `Algorithm` module
-- Move `Wilsons` to the `Algorithm` module
-- Move and rename `Display` to `Renderer::Image`
-- Rename `Display.to_png` to `Image.render`
+- Move `AldousBroder` to the `Algorithm` module.
+- Move `BinaryTree` to the `Algorithm` module.
+- Move `RecursiveBacktracker` to the `Algorithm` module.
+- Move `Sidewinder` to the `Algorithm` module.
+- Move `Wilsons` to the `Algorithm` module.
+- Move and rename `Display` to `Renderer::Image`.
+- Rename `Display.to_png` to `Image.render`.
+
 ### Fixed
-- Correctly scope private class methods in `Sidewinder`
-- Algorithms now uniformly require a `grid:` keyword argument to `.carve`
+- Correctly scope private class methods in `Sidewinder`.
+- Algorithms now uniformly require a `grid:` keyword argument to `.carve`.
+
 ### Removed
 - `Grid` no longer has a custom `to_s` method to produce a graphical maze.
-Use `Renderer::Text.render` instead.
+  Use `Renderer::Text.render` instead.
 
 ## [0.0.0][0.0.0] — 2020-01-02
+
 ### Added
 - Restructure the project as a Ruby gem.
 
@@ -39,6 +77,8 @@ _This file is composed with [GitHub Flavored Markdown][gfm]._
 [gfm]: https://github.github.com/gfm/
 [sv]: https://semver.org
 
-[new]: https://github.com/petejh/knossos/compare/HEAD..v0.1.0
+[new]: https://github.com/petejh/knossos/compare/HEAD..v0.3.0
+[0.3.0]: https://github.com/petejh/knossos/releases/tag/v0.3.0
+[0.2.0]: https://github.com/petejh/knossos/releases/tag/v0.2.0
 [0.1.0]: https://github.com/petejh/knossos/releases/tag/v0.1.0
 [0.0.0]: https://github.com/petejh/knossos/releases/tag/v0.0.0

data/README.md

@@ -19,12 +19,13 @@ Or install the library globally with:
 require 'knossos'
 
 grid = Knossos::Grid.new({rows: 5, columns: 5})
-Algorithm::BinaryTree.carve(grid: grid)
+carver = Knossos::Algorithm::BinaryTree.new
+carver.carve(grid: grid)
 
-text_renderer = Renderer::Text.new
+text_renderer = Knossos::Renderer::Text.new
 puts text_renderer.render(grid: grid)
 
-image_renderer = Renderer::Image.new(grid)
+image_renderer = Knossos::Renderer::Image.new(grid)
 png = image_renderer.render
 png.save("maze.png")
 ```

data/lib/knossos.rb

@@ -3,6 +3,8 @@ require 'knossos/cell'
 require 'knossos/error'
 require 'knossos/grid'
 require 'knossos/renderer'
+require 'knossos/serializer'
+require 'knossos/solver'
 require 'knossos/version'
 
 module Knossos

data/lib/knossos/algorithm.rb

@@ -1,5 +1,6 @@
 require_relative 'algorithm/aldous_broder'
 require_relative 'algorithm/binary_tree'
+require_relative 'algorithm/hunt_and_kill'
 require_relative 'algorithm/recursive_backtracker'
 require_relative 'algorithm/sidewinder'
 require_relative 'algorithm/wilsons'

data/lib/knossos/algorithm/aldous_broder.rb

@@ -1,7 +1,13 @@
 module Knossos
   module Algorithm
     class AldousBroder
-      def self.carve(grid:)
+      def initialize
+        # nothing to do
+      end
+
+      def carve(grid:, seed: nil)
+        srand(seed || Kernel.srand)
+
         cell = grid.random_cell
         unvisited = grid.cell_count - 1
 

data/lib/knossos/algorithm/binary_tree.rb

@@ -1,15 +1,19 @@
 module Knossos
   module Algorithm
     class BinaryTree
-      def self.carve(grid:)
-        grid.each_cell do |cell|
-          neighbors = []
+      attr_reader :bias
+
+      def initialize(**options)
+        options = defaults.merge(options)
+
+        @bias = options[:bias]
+      end
 
-          north = grid.north(cell)
-          neighbors << north if north
+      def carve(grid:, seed: nil)
+        srand(seed || Kernel.srand)
 
-          east = grid.east(cell)
-          neighbors << east if east
+        grid.each_cell do |cell|
+          neighbors = bias.map { |direction| grid.send(direction, cell) }.compact
 
           neighbor = neighbors.sample
           grid.build_passage(cell, neighbor) if neighbor
@@ -17,6 +21,12 @@ module Knossos
 
         grid
       end
+
+      private
+
+      def defaults
+        { bias: [:north, :east] }
+      end
     end
   end
 end

data/lib/knossos/algorithm/hunt_and_kill.rb

@@ -0,0 +1,49 @@
+module Knossos
+  module Algorithm
+    class HuntAndKill
+      attr_reader :bias
+
+      def initialize(**options)
+        options = defaults.merge(options)
+      end
+
+      def carve(grid:, seed: nil)
+        srand(seed || Kernel.srand)
+
+        current = grid.random_cell
+
+        while current
+          unvisited_neighbors = grid.neighborhood(current).select { |n| n.links.empty? }
+
+          if unvisited_neighbors.any?
+            neighbor = unvisited_neighbors.sample
+            grid.build_passage(current, neighbor)
+            current = neighbor
+          else
+            current = nil
+
+            grid.each_cell do |cell|
+              visited_neighbors = grid.neighborhood(cell).select { |n| n.links.any? }
+              if cell.links.empty? && visited_neighbors.any?
+                current = cell
+
+                neighbor = visited_neighbors.sample
+                grid.build_passage(current, neighbor)
+
+                break
+              end
+            end
+          end
+        end
+
+        grid
+      end
+
+      private
+
+      def defaults
+        {}
+      end
+    end
+  end
+end

data/lib/knossos/algorithm/recursive_backtracker.rb

@@ -1,7 +1,15 @@
 module Knossos
   module Algorithm
     class RecursiveBacktracker
-      def self.carve(grid:, start_at: grid.random_cell)
+      def initialize
+        # nothing to do
+      end
+
+      def carve(grid:, start_at: nil, seed: nil)
+        srand(seed || Kernel.srand)
+
+        start_at ||= grid.random_cell
+
         stack = []
         stack.push start_at
 

data/lib/knossos/algorithm/sidewinder.rb

@@ -1,7 +1,13 @@
 module Knossos
   module Algorithm
     class Sidewinder
-      def self.carve(grid:)
+      def initialize
+        # nothing to do
+      end
+
+      def carve(grid:, seed: nil)
+        srand(seed || Kernel.srand)
+
         grid.each_row do |row|
           run = []
           row.each do |cell|
@@ -24,20 +30,18 @@ module Knossos
         grid
       end
 
-      class << self
-        private
+      private
 
-        def close_out_run?(grid, cell)
-          at_east_border?(grid, cell) || (!at_north_border?(grid, cell) && rand(2) == 0)
-        end
+      def close_out_run?(grid, cell)
+        at_east_border?(grid, cell) || (!at_north_border?(grid, cell) && rand(2) == 0)
+      end
 
-        def at_east_border?(grid, cell)
-          grid.east(cell).nil?
-        end
+      def at_east_border?(grid, cell)
+        grid.east(cell).nil?
+      end
 
-        def at_north_border?(grid, cell)
-          grid.north(cell).nil?
-        end
+      def at_north_border?(grid, cell)
+        grid.north(cell).nil?
       end
     end
   end

data/lib/knossos/algorithm/wilsons.rb

@@ -1,7 +1,13 @@
 module Knossos
   module Algorithm
     class Wilsons
-      def self.carve(grid:)
+      def initialize
+        # nothing to do
+      end
+
+      def carve(grid:, seed: nil)
+        srand(seed || Kernel.srand)
+
         unvisited = []
         grid.each_cell { |cell| unvisited << cell }
 

data/lib/knossos/renderer/text.rb

@@ -5,7 +5,7 @@ module Knossos
         # nothing to do
       end
 
-      def render(grid:)
+      def render(grid:, distances: nil)
         output = "+" + "---+" * grid.columns + "\n"
 
         grid.each_row do |row|
@@ -19,7 +19,7 @@ module Knossos
             south = grid.south(cell)
             south_border = cell.linked?(south) ? "   " : "---"
 
-            body << "   " << east_border
+            body << decorate(cell, distances) << east_border
             bottom << south_border << "+"
           end
 
@@ -29,6 +29,13 @@ module Knossos
 
         output
       end
+
+      private
+
+      def decorate(cell, distances)
+        label = distances && distances[cell] ? distances[cell].to_s(36) : ' '
+        " #{label} "
+      end
     end
   end
 end

data/lib/knossos/serializer.rb

@@ -0,0 +1,6 @@
+require_relative 'serializer/bitmask'
+
+module Knossos
+  module Serializer
+  end
+end

data/lib/knossos/serializer/bitmask.rb

@@ -0,0 +1,65 @@
+module Knossos
+  module Serializer
+    class Bitmask
+      NORTH = 1
+      EAST = 2
+      SOUTH = 4
+      WEST = 8
+
+      def serialize(grid:)
+        encoded_maze = Array.new(grid.columns) { Array.new(grid.rows, 0) }
+
+        grid.each_row do |cells, row|
+          cells.each_with_index do |cell, column|
+            link_mask = 0
+
+            cell.links.each do |link|
+              link_mask |=
+                case column <=> link.column
+                when -1
+                  EAST
+                when 0
+                  0
+                when 1
+                  WEST
+                end
+
+              link_mask |=
+                case row <=> link.row
+                when -1
+                  SOUTH
+                when 0
+                  0
+                when 1
+                  NORTH
+                end
+              end
+
+            encoded_maze[row][column] = link_mask
+          end
+        end
+
+        encoded_maze
+      end
+
+      def deserialize(encoded_maze:)
+        rows = encoded_maze.length
+        columns = encoded_maze.first.length
+        grid = Knossos::Grid.new({rows: rows, columns: columns})
+
+        encoded_maze.each_with_index do |cells, row|
+          cells.each_with_index do |cell, column|
+            current_cell = grid[row, column]
+
+            grid.build_passage(current_cell, grid[row - 1, column]) if (cell & NORTH > 0)
+            grid.build_passage(current_cell, grid[row, column + 1]) if (cell & EAST > 0)
+            grid.build_passage(current_cell, grid[row + 1, column]) if (cell & SOUTH > 0)
+            grid.build_passage(current_cell, grid[row, column - 1]) if (cell & WEST > 0)
+          end
+        end
+
+        grid
+      end
+    end
+  end
+end

data/lib/knossos/solver.rb

@@ -0,0 +1,7 @@
+require_relative 'solver/dijkstra'
+require_relative 'solver/distances'
+
+module Knossos
+  module Solver
+  end
+end

data/lib/knossos/solver/dijkstra.rb

@@ -0,0 +1,61 @@
+module Knossos
+  module Solver
+    class Dijkstra
+      def initialize
+        # nothing to do
+      end
+
+      def distances_from(start:)
+        frontier = [start]
+        distances = Distances.new(root: start)
+
+        while frontier.any?
+          new_frontier = []
+
+          frontier.each do |cell|
+            cell.links.each do |linked_cell|
+              next if distances[linked_cell]
+              distances[linked_cell] = distances[cell] + 1
+              new_frontier << linked_cell
+            end
+          end
+
+          frontier = new_frontier
+        end
+
+        distances
+      end
+
+      def shortest_path(start:, goal:, distances:)
+        current = goal
+
+        path = Distances.new(root: start)
+        path[current] = distances[current]
+
+        until current == start
+          current.links.each do |neighbor|
+            if distances[neighbor] < distances[current]
+              path[neighbor] = distances[neighbor]
+              current = neighbor
+              break
+            end
+          end
+        end
+
+        path
+      end
+
+      def longest_path(distances:)
+        # Find the cell that is furthest from any given starting cell. Then find
+        # the cell that is furthest from that one. This is guaranteed to yield
+        # the longest path in a perfect maze.
+
+        new_start, _ = distances.max
+        new_distances = distances_from(start: new_start)
+        goal, _ = new_distances.max
+
+        shortest_path(start: new_start, goal: goal, distances: new_distances)
+      end
+    end
+  end
+end

data/lib/knossos/solver/distances.rb

@@ -0,0 +1,37 @@
+module Knossos
+  module Solver
+    class Distances
+      def initialize(root:)
+        @root = root
+        @cells = {}
+        @cells[@root] = 0
+      end
+
+      def [](cell)
+        @cells[cell]
+      end
+
+      def []=(cell, distance)
+        @cells[cell] = distance
+      end
+
+      def cells
+        @cells.keys
+      end
+
+      def max
+        max_distance = 0
+        max_cell = @root
+
+        @cells.each do |cell, distance|
+          if distance > max_distance
+            max_cell = cell
+            max_distance = distance
+          end
+        end
+
+        [max_cell, max_distance]
+      end
+    end
+  end
+end

data/lib/knossos/version.rb

@@ -1,3 +1,3 @@
 module Knossos
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knossos
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter J. Hinckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -81,6 +81,7 @@ files:
 - lib/knossos/algorithm.rb
 - lib/knossos/algorithm/aldous_broder.rb
 - lib/knossos/algorithm/binary_tree.rb
+- lib/knossos/algorithm/hunt_and_kill.rb
 - lib/knossos/algorithm/recursive_backtracker.rb
 - lib/knossos/algorithm/sidewinder.rb
 - lib/knossos/algorithm/wilsons.rb
@@ -91,6 +92,11 @@ files:
 - lib/knossos/renderer/image.rb
 - lib/knossos/renderer/png_adapter.rb
 - lib/knossos/renderer/text.rb
+- lib/knossos/serializer.rb
+- lib/knossos/serializer/bitmask.rb
+- lib/knossos/solver.rb
+- lib/knossos/solver/dijkstra.rb
+- lib/knossos/solver/distances.rb
 - lib/knossos/version.rb
 homepage: https://github.com/petejh/knossos
 licenses: