multi-puzzle-solver 0.9.13__tar.gz → 0.9.14__tar.gz

{multi_puzzle_solver-0.9.13/src/multi_puzzle_solver.egg-info → multi_puzzle_solver-0.9.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multi-puzzle-solver
-Version: 0.9.13
+Version: 0.9.14
 Summary: Efficient solvers for numerous popular and esoteric logic puzzles using CP-SAT
 Author: Ar-Kareem
 Project-URL: Homepage, https://github.com/Ar-Kareem/puzzle_solver
@@ -264,6 +264,11 @@ These are all the puzzles that are implemented in this repo. <br> Click on any o
       <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/lits_solved.png" alt="Lits" width="140">
     </a>
   </td>
+  <td align="center">
+    <a href="#black-box-puzzle-type-34"><b>Black Box</b><br><br>
+      <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/black_box_solved.png" alt="Black Box" width="140">
+    </a>
+  </td>
 </tr>
 </table>
 
@@ -312,6 +317,7 @@ These are all the puzzles that are implemented in this repo. <br> Click on any o
   - [Star Battle (Puzzle Type #31)](#star-battle-puzzle-type-31)
   - [Star Battle Shapeless (Puzzle Type #32)](#star-battle-shapeless-puzzle-type-32)
   - [Lits (Puzzle Type #33)](#lits-puzzle-type-33)
+  - [Black Box (Puzzle Type #34)](#black-box-puzzle-type-34)
   - [Why SAT / CP-SAT?](#why-sat--cp-sat)
   - [Testing](#testing)
   - [Contributing](#contributing)
@@ -804,7 +810,7 @@ You have a grid of squares, some of which contain digits, and the rest of which
 For example, it follows that no square can contain a zero, and that two adjacent squares can not both contain a one. No region has an area greater than 9 (because then its area would not be a single digit).
 </details>
 
-(Note: The solver for this puzzle is the only extremely slow solver in this repo and will take a minute to solve a simple 6x7 puzzle)
+Note: It may take a few seconds for the model to be built.
 
 **Unsolved puzzle**
 
@@ -837,7 +843,7 @@ Solution found
  [1 6 6 1 4 4 4]]
 Solutions found: 1
 status: OPTIMAL
-Time taken: 46.27 seconds
+Time taken: 0.10 seconds
 ```
 
 **Solved puzzle**
@@ -1212,8 +1218,6 @@ You have a grid of squares; some squares contain numbers. Your job is to colour
 For instance, a square containing the number one must have four black squares as its neighbours by the last criterion; but then it's impossible for it to be connected to any outside white square, which violates the second to last criterion. So no square will contain the number one. 
 </details>
 
-(Note: The solver for this puzzle is slightly slower and could take several seconds to solve a 16x11 puzzle)
-
 **Unsolved puzzle**
 
 <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/range_unsolved.png" alt="Range unsolved" width="500">
@@ -1254,7 +1258,7 @@ B . . . B . B . . . . . B . . .
 B . . . . . . B . . . . B . . .
 Solutions found: 1
 status: OPTIMAL
-Time taken: 3.32 seconds
+Time taken: 0.04 seconds
 ```
 
 **Solved puzzle**
@@ -1410,8 +1414,6 @@ Complete the track from A to B so that the rows and columns contain the same num
 
 </details>
 
-(Note: The solver for this puzzle is slightly slower and could take several seconds to solve a large 15x15 puzzle)
-
 **Unsolved puzzle**
 
 <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/tracks_unsolved.png" alt="Tracks unsolved" width="500">
@@ -1461,7 +1463,7 @@ solutions = binst.solve_and_print()
  ['  ' '  ' '  ' '  ' '  ' '  ' '  ' '  ' '  ' '  ' '  ' '  ' '  ' '┏━' '━┛']]
 Solutions found: 1
 status: OPTIMAL
-Time taken: 9.42 seconds
+Time taken: 1.04 seconds
 ```
 
 **Solved puzzle**
@@ -2782,6 +2784,114 @@ Time taken: 0.38 seconds
 
 ---
 
+## Black Box (Puzzle Type #34)
+
+* [**Play online**](https://www.chiark.greenend.org.uk/~sgtatham/puzzles/js/blackbox.html)
+
+* [**Instructions**](https://www.chiark.greenend.org.uk/~sgtatham/puzzles/doc/blackbox.html#blackbox)
+
+* [**Solver Code**][34]
+
+<details>
+  <summary><strong>Rules</strong></summary>
+
+A number of balls are hidden in a rectangular arena. You have to deduce the positions of the balls by firing lasers positioned at the edges of the arena and observing how their beams are deflected.
+
+Beams will travel straight from their origin until they hit the opposite side of the arena (at which point they emerge), unless affected by balls in one of the following ways:
+
+    A beam that hits a ball head-on is absorbed and will never re-emerge. This includes beams that meet a ball on the first rank of the arena.
+    A beam with a ball in its front-left square and no ball ahead of it gets deflected 90 degrees to the right.
+    A beam with a ball in its front-right square and no ball ahead of it gets similarly deflected to the left.
+    A beam that would re-emerge from its entry location is considered to be ‘reflected’.
+    A beam which would get deflected before entering the arena by a ball to the front-left or front-right of its entry point is also considered to be ‘reflected’.
+
+Beams that are reflected appear as a ‘R’; beams that hit balls head-on appear as ‘H’. Otherwise, a number appears at the firing point and the location where the beam emerges (this number is unique to that shot).
+
+You can place guesses as to the location of the balls, based on the entry and exit patterns of the beams; once you have placed enough balls a button appears enabling you to have your guesses checked.
+
+Here is a diagram showing how the positions of balls can create each of the beam behaviours shown above:
+
+      1 R H R - - - -  
+    | . . O . O . . . |
+    2 . . . . . . . . 3
+    | . . . . . . . . |
+    | . . . . . . . . |
+    3 . . . . . . . . |
+    | . . . . . . O . |
+    H . . . . . . . . |
+    | . . . . . O . . |
+      1 2 - R R - - - 
+
+As shown, it is possible for a beam to receive multiple reflections before re-emerging (see turn 3). Similarly, a beam may be reflected (possibly more than once) before receiving a hit (the ‘H’ on the left side of the example).
+
+Note that any layout with more than 4 balls may have a non-unique solution. The following diagram illustrates this; if you know the board contains 5 balls, it is impossible to determine where the fifth ball is (possible positions marked with an x):
+
+      - - - - - - - -  
+    | . . . . . . . . |
+    | . . . . . . . . |
+    | . . O . . O . . |
+    | . . . x x . . . |
+    | . . . x x . . . |
+    | . . O . . O . . |
+    | . . . . . . . . |
+    | . . . . . . . . |
+      - - - - - - - - 
+
+For this reason, when you have your guesses checked, the game will check that your solution produces the same results as the computer's, rather than that your solution is identical to the computer's. So in the above example, you could put the fifth ball at any of the locations marked with an x, and you would still win.
+</details>
+
+Note: This puzzle is one of the very rare puzzles where CP-SAT is not a good fit because for every placement of the balls the state of the beams is dynamically changes and thus required a lot of variables to construct and constraint. This is why the resulting model is large and slow.
+
+**Unsolved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/black_box_unsolved.png" alt="Black Box unsolved" width="500">
+
+Code to utilize this package and solve the puzzle:
+```python
+from puzzle_solver import black_box_solver as solver
+top = ['1', 'H', 'R', 'R', 'H', 'R', '2', '3']
+left = ['H', '1', 'H', '7', '5', '6', 'H', 'H']
+right = ['2', 'H', '4', 'H', '5', '6', 'H', 'H'] 
+bottom = ['7', 'R', 'H', 'R', 'H', 'R', '4', '3']
+
+# create board and solve; ball count if between 3 and 6
+binst = solver.Board(top=top, left=left, bottom=bottom, right=right, ball_count=(3, 6))
+solutions = binst.solve_and_print()
+```
+**Script Output**
+
+As the instructions say, the solution to this puzzle is not garunteed to be unique.
+
+```python
+Solution found
+[[' ' ' ' ' ' ' ' 'O' ' ' ' ' ' ']
+ [' ' ' ' ' ' ' ' ' ' 'O' ' ' ' ']
+ [' ' 'O' ' ' ' ' ' ' ' ' ' ' ' ']
+ [' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ']
+ [' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ']
+ [' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ']
+ [' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ']
+ [' ' ' ' 'O' ' ' 'O' ' ' ' ' ' ']]
+Solution found
+[[' ' ' ' ' ' ' ' 'O' ' ' ' ' ' ']
+ [' ' ' ' ' ' ' ' ' ' 'O' ' ' ' ']
+ [' ' 'O' ' ' 'O' ' ' ' ' ' ' ' ']
+ [' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ']
+ [' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ']
+ [' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ']
+ [' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ']
+ [' ' ' ' 'O' ' ' 'O' ' ' ' ' ' ']]
+Solutions found: 2
+status: OPTIMAL
+Time taken: 30.33 seconds
+```
+
+**Solved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/black_box_solved.png" alt="Black Box solved" width="500">
+
+---
+
 ---
 
 ## Why SAT / CP-SAT?
@@ -2866,3 +2976,4 @@ Issues and PRs welcome!
 [31]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/star_battle "puzzle_solver/src/puzzle_solver/puzzles/star_battle at master · Ar-Kareem/puzzle_solver · GitHub"
 [32]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/star_battle_shapeless "puzzle_solver/src/puzzle_solver/puzzles/star_battle_shapeless at master · Ar-Kareem/puzzle_solver · GitHub"
 [33]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/lits "puzzle_solver/src/puzzle_solver/puzzles/lits at master · Ar-Kareem/puzzle_solver · GitHub"
+[34]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/black_box "puzzle_solver/src/puzzle_solver/puzzles/black_box at master · Ar-Kareem/puzzle_solver · GitHub"