bfs_brute_force 0.1.0 → 0.2.0

data/example/run_example.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+Dir.chdir(File.dirname(__FILE__))
+
+basename = File.basename __FILE__
+
+unless ARGV.size == 1
+  files = (Dir["*.rb"] - [basename]).join(" | ")
+  $stderr.puts "usage: #{basename} (#{files})"
+
+  exit 1
+end
+
+# Run against source in local git repo
+require 'bundler/setup'
+
+require File.join('.', ARGV.first)

data/example/simple_addition.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+require 'bfs_brute_force'
+
+# This is a very simple 'puzzle' to show how to use the bfs_brute_force gem
+#
+# Puzzle:
+#
+# Using the moves "Add 10" and "Add 1," find the shortest number
+# of moves from a starting number to a final number.
+
+class AdditionPuzzleState < BfsBruteForce::State
+  def initialize(value, final)
+    @value = value
+    @final = final
+  end
+
+  # (see BfsBruteForce::State.solved?)
+  def solved?
+    @value == @final
+  end
+
+  # Call yield for every next state in your puzzle
+  # This puzzle has two legal moves from every state: Add 10, and Add 1
+  #
+  # (see BfsBruteForce::State.next_states)
+  def next_states(already_seen)
+    # If there are no more available states to analyze,
+    # {BfsBruteForce::Solver#solve} will throw a {BfsBruteForce::NoSolution}
+    # exception.
+    return if @value > @final
+
+    # already_seen is a set passed to every call of next_states.
+    # You can use this set to record which states you have previously
+    # visited, from a shorter path, avoiding having to visit that
+    # same state again.
+    #
+    # Set#add?(x) will return nil if x is already in the set
+    if already_seen.add?(@value + 10)
+      yield "Add 10", AdditionPuzzleState.new(@value + 10, @final)
+    end
+
+    if already_seen.add?(@value + 1)
+      yield "Add 1", AdditionPuzzleState.new(@value + 1, @final)
+    end
+  end
+end
+
+# Find shortest path from 0 to 42
+initial_state = AdditionPuzzleState.new 0, 42
+
+solver = BfsBruteForce::Solver.new
+moves  = solver.solve(initial_state).moves
+
+moves.each_with_index do |move, index|
+  puts "Move %d) %s" % [index + 1, move]
+end
+
+# Running this code will produce the following output:
+#
+# Move 1) Add 10
+# Move 2) Add 10
+# Move 3) Add 10
+# Move 4) Add 10
+# Move 5) Add 1
+# Move 6) Add 1

data/example/two_knights.rb

@@ -0,0 +1,627 @@
+#!/usr/bin/env ruby
+
+require 'bfs_brute_force'
+
+# Puzzle:
+#
+# Swap the white and black knights, using standard chess moves.
+# This is the "two knights" puzzle from an old video game, The 11th Hour.
+#
+# Initial board layout:
+#
+#       +----+
+#     4 | BK |
+#       +----+----+----+----+
+#     3 |    |    |    | WK |
+#       +----+----+----+----+
+#     2 | BK | WK |    |
+#       +----+----+----+
+#     1 |    |    |
+#       +----+----+
+#         a    b    c    d
+#
+#     BK = Black Knight
+#     WK = White Knight
+
+class KnightsState < BfsBruteForce::State
+  # Legal moves: from_position => [to_position, ...]
+  @@moves = {
+    :a1 => [:b3, :c2],
+    :a2 => [:c3],
+    :a3 => [:b1, :c2],
+    :a4 => [:b2, :c3],
+    :b1 => [:a3, :c3],
+    :b2 => [:a4, :d3],
+    :b3 => [:a1],
+    :c2 => [:a1, :a3],
+    :c3 => [:a2, :a4, :b1],
+    :d3 => [:b2]
+  }
+
+  def initialize(knights = nil)
+    # State of the board: position => knight
+    @knights = knights || {
+      :a2 => :BK,
+      :a4 => :BK,
+      :b2 => :WK,
+      :d3 => :WK
+    }
+  end
+
+  # (see BfsBruteForce::State#solved)
+  def solved?
+    @knights == {
+      :a2 => :WK,
+      :a4 => :WK,
+      :b2 => :BK,
+      :d3 => :BK
+    }
+  end
+
+  # Yield all not previously seen states from the current state
+  # (see BfsBruteForce::State#next_states)
+  def next_states(already_seen)
+    @knights.each do |from, knight|
+      @@moves[from].reject do |to|
+        # Skip occupied positions
+        @knights[to]
+      end.each do |to|
+        new_knights = @knights.merge(to => knight)
+        new_knights.delete from
+
+        if already_seen.add?(new_knights)
+          state = KnightsState.new new_knights
+          move  = "Move #{knight} from #{from} to #{to}\n#{state}"
+          yield move, state
+        end
+      end
+    end
+  end
+
+  def to_s
+    fmt = %q{
+        +----+
+      4 | %s |
+        +----+----+----+----+
+      3 | %s | %s | %s | %s |
+        +----+----+----+----+
+      2 | %s | %s | %s |
+        +----+----+----+
+      1 | %s | %s |
+        +----+----+
+          a    b    c    d
+    }
+
+    fmt % [:a4, :a3, :b3, :c3, :d3, :a2, :b2, :c2, :a1, :b1].map do |index|
+      @knights[index] || '  '
+    end
+  end
+end
+
+solver = BfsBruteForce::Solver.new
+moves  = solver.solve(KnightsState.new).moves
+
+puts moves
+
+# Running this code will produce the following output:
+#
+# Move BK from a2 to c3
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    | BK | WK |
+#         +----+----+----+----+
+#       2 |    | WK |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from c3 to b1
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    |    | WK |
+#         +----+----+----+----+
+#       2 |    | WK |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from a4 to c3
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 |    |    | BK | WK |
+#         +----+----+----+----+
+#       2 |    | WK |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from b2 to a4
+#
+#         +----+
+#       4 | WK |
+#         +----+----+----+----+
+#       3 |    |    | BK | WK |
+#         +----+----+----+----+
+#       2 |    |    |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from b1 to a3
+#
+#         +----+
+#       4 | WK |
+#         +----+----+----+----+
+#       3 | BK |    | BK | WK |
+#         +----+----+----+----+
+#       2 |    |    |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from c3 to b1
+#
+#         +----+
+#       4 | WK |
+#         +----+----+----+----+
+#       3 | BK |    |    | WK |
+#         +----+----+----+----+
+#       2 |    |    |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from a4 to c3
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 | BK |    | WK | WK |
+#         +----+----+----+----+
+#       2 |    |    |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from c3 to a2
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 | BK |    |    | WK |
+#         +----+----+----+----+
+#       2 | WK |    |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from b1 to c3
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 | BK |    | BK | WK |
+#         +----+----+----+----+
+#       2 | WK |    |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from a3 to b1
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 |    |    | BK | WK |
+#         +----+----+----+----+
+#       2 | WK |    |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from c3 to a4
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    |    | WK |
+#         +----+----+----+----+
+#       2 | WK |    |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from b1 to c3
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    | BK | WK |
+#         +----+----+----+----+
+#       2 | WK |    |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from a4 to b2
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 |    |    | BK | WK |
+#         +----+----+----+----+
+#       2 | WK | BK |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from c3 to a4
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    |    | WK |
+#         +----+----+----+----+
+#       2 | WK | BK |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from a2 to c3
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    | WK | WK |
+#         +----+----+----+----+
+#       2 |    | BK |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from c3 to b1
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    |    | WK |
+#         +----+----+----+----+
+#       2 |    | BK |    |
+#         +----+----+----+
+#       1 |    | WK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from a4 to c3
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 |    |    | BK | WK |
+#         +----+----+----+----+
+#       2 |    | BK |    |
+#         +----+----+----+
+#       1 |    | WK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from b2 to a4
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    | BK | WK |
+#         +----+----+----+----+
+#       2 |    |    |    |
+#         +----+----+----+
+#       1 |    | WK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from d3 to b2
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    | BK |    |
+#         +----+----+----+----+
+#       2 |    | WK |    |
+#         +----+----+----+
+#       1 |    | WK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from b1 to a3
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 | WK |    | BK |    |
+#         +----+----+----+----+
+#       2 |    | WK |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from c3 to b1
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 | WK |    |    |    |
+#         +----+----+----+----+
+#       2 |    | WK |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from a4 to c3
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 | WK |    | BK |    |
+#         +----+----+----+----+
+#       2 |    | WK |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from b2 to a4
+#
+#         +----+
+#       4 | WK |
+#         +----+----+----+----+
+#       3 | WK |    | BK |    |
+#         +----+----+----+----+
+#       2 |    |    |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from a3 to c2
+#
+#         +----+
+#       4 | WK |
+#         +----+----+----+----+
+#       3 |    |    | BK |    |
+#         +----+----+----+----+
+#       2 |    |    | WK |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from b1 to a3
+#
+#         +----+
+#       4 | WK |
+#         +----+----+----+----+
+#       3 | BK |    | BK |    |
+#         +----+----+----+----+
+#       2 |    |    | WK |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from c3 to b1
+#
+#         +----+
+#       4 | WK |
+#         +----+----+----+----+
+#       3 | BK |    |    |    |
+#         +----+----+----+----+
+#       2 |    |    | WK |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from a4 to c3
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 | BK |    | WK |    |
+#         +----+----+----+----+
+#       2 |    |    | WK |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from c3 to a2
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 | BK |    |    |    |
+#         +----+----+----+----+
+#       2 | WK |    | WK |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from b1 to c3
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 | BK |    | BK |    |
+#         +----+----+----+----+
+#       2 | WK |    | WK |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from a3 to b1
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 |    |    | BK |    |
+#         +----+----+----+----+
+#       2 | WK |    | WK |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from c2 to a3
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 | WK |    | BK |    |
+#         +----+----+----+----+
+#       2 | WK |    |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from c3 to a4
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 | WK |    |    |    |
+#         +----+----+----+----+
+#       2 | WK |    |    |
+#         +----+----+----+
+#       1 |    | BK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from b1 to c3
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 | WK |    | BK |    |
+#         +----+----+----+----+
+#       2 | WK |    |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from a3 to b1
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    | BK |    |
+#         +----+----+----+----+
+#       2 | WK |    |    |
+#         +----+----+----+
+#       1 |    | WK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from a4 to b2
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 |    |    | BK |    |
+#         +----+----+----+----+
+#       2 | WK | BK |    |
+#         +----+----+----+
+#       1 |    | WK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from c3 to a4
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    |    |    |
+#         +----+----+----+----+
+#       2 | WK | BK |    |
+#         +----+----+----+
+#       1 |    | WK |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from b1 to c3
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    | WK |    |
+#         +----+----+----+----+
+#       2 | WK | BK |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from b2 to d3
+#
+#         +----+
+#       4 | BK |
+#         +----+----+----+----+
+#       3 |    |    | WK | BK |
+#         +----+----+----+----+
+#       2 | WK |    |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move BK from a4 to b2
+#
+#         +----+
+#       4 |    |
+#         +----+----+----+----+
+#       3 |    |    | WK | BK |
+#         +----+----+----+----+
+#       2 | WK | BK |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#
+# Move WK from c3 to a4
+#
+#         +----+
+#       4 | WK |
+#         +----+----+----+----+
+#       3 |    |    |    | BK |
+#         +----+----+----+----+
+#       2 | WK | BK |    |
+#         +----+----+----+
+#       1 |    |    |
+#         +----+----+
+#           a    b    c    d
+#