multi-puzzle-solver 0.9.31__tar.gz → 1.0.3__tar.gz

{multi_puzzle_solver-0.9.31/src/multi_puzzle_solver.egg-info → multi_puzzle_solver-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multi-puzzle-solver
-Version: 0.9.31
+Version: 1.0.3
 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
@@ -369,6 +369,33 @@ These are all the puzzles that are implemented in this repo. <br> Click on any o
     </a>
   </td>
 </tr>
+<tr>
+  <td align="center">
+    <a href="#kakuro-puzzle-type-51"><b>Kakuro</b><br><br>
+      <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/kakuro_solved.png" alt="Kakuro" width="140">
+    </a>
+  </td>
+  <td align="center">
+    <a href="#sudoku-jigsaw-puzzle-type-52"><b>Sudoku Jigsaw</b><br><br>
+      <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/sudoku_jigsaw_solved.png" alt="Sudoku Jigsaw" width="140">
+    </a>
+  </td>
+  <td align="center">
+    <a href="#sudoku-killer-puzzle-type-53"><b>Sudoku Killer</b><br><br>
+      <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/sudoku_killer_solved.png" alt="Sudoku Killer" width="140">
+    </a>
+  </td>
+  <td align="center">
+    <a href="#flood-it-puzzle-type-54"><b>Flood It</b><br><br>
+      <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/flood_it_unsolved.png" alt="Flood It" width="140">
+    </a>
+  </td>
+  <td align="center">
+    <a href="#pipes-puzzle-type-55"><b>Pipes</b><br><br>
+      <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/pipes_solved.png" alt="Pipes" width="140">
+    </a>
+  </td>
+</tr>
 </table>
 
 </div>
@@ -434,6 +461,10 @@ These are all the puzzles that are implemented in this repo. <br> Click on any o
   - [Binairo Plus (Puzzle Type #49)](#binairo-plus-puzzle-type-49)
   - [Shakashaka (Puzzle Type #50)](#shakashaka-puzzle-type-50)
   - [Kakuro (Puzzle Type #51)](#kakuro-puzzle-type-51)
+  - [Sudoku Jigsaw (Puzzle Type #52)](#sudoku-jigsaw-puzzle-type-52)
+  - [Sudoku Killer (Puzzle Type #53)](#sudoku-killer-puzzle-type-53)
+  - [Flood It (Puzzle Type #54)](#flood-it-puzzle-type-54)
+  - [Pipes (Puzzle Type #55)](#pipes-puzzle-type-55)
   - [Why SAT / CP-SAT?](#why-sat--cp-sat)
   - [Testing](#testing)
   - [Contributing](#contributing)
@@ -4823,6 +4854,305 @@ Time taken: 0.00 seconds
 
 ---
 
+## Sudoku Jigsaw (Puzzle Type #52)
+
+* [**Play online**](https://www.puzzle-jigsaw-sudoku.com/)
+
+* [**Solver Code**][52]
+
+<details>
+  <summary><strong>Rules</strong></summary>
+
+   1. The basic Sudoku rules apply.
+   2. The difference is that instead of having 3x3 rectangular blocks these blocks have irregular shapes
+
+</details>
+
+**Unsolved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/sudoku_jigsaw_unsolved.png" alt="Sudoku Jigsaw unsolved" width="500">
+
+Code to utilize this package and solve the puzzle:
+
+(Note: the ids are arbitrary and simply represent cells that share a block)
+
+```python
+import numpy as np
+from puzzle_solver import sudoku_solver as solver
+board = np.array([
+  [ '1', ' ', ' ', '2', ' ', ' ', '8', '5', ' ' ],
+  [ '2', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ' ],
+  [ ' ', ' ', '8', ' ', ' ', ' ', ' ', ' ', ' ' ],
+  [ '7', ' ', ' ', '5', ' ', '1', ' ', ' ', ' ' ],
+  [ ' ', ' ', ' ', '1', ' ', '3', ' ', ' ', ' ' ],
+  [ ' ', ' ', ' ', '8', ' ', '4', ' ', ' ', '6' ],
+  [ ' ', ' ', ' ', ' ', ' ', ' ', '5', ' ', ' ' ],
+  [ ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', '5' ],
+  [ ' ', '2', '6', ' ', ' ', '9', ' ', ' ', '1' ],
+])
+jigsaw_ids = np.array([
+  ['00', '00', '01', '01', '01', '01', '02', '02', '02'],
+  ['00', '00', '01', '01', '03', '01', '01', '02', '02'],
+  ['00', '00', '01', '04', '03', '03', '02', '02', '02'],
+  ['00', '04', '04', '04', '03', '03', '03', '03', '02'],
+  ['00', '00', '04', '04', '03', '03', '05', '05', '05'],
+  ['06', '04', '04', '04', '05', '05', '05', '07', '05'],
+  ['06', '08', '08', '08', '08', '05', '05', '07', '07'],
+  ['06', '06', '06', '06', '08', '07', '07', '07', '07'],
+  ['06', '06', '06', '08', '08', '08', '08', '07', '07'],
+])
+binst = solver.Board(board=board, jigsaw=jigsaw_ids, constrain_blocks=False)
+solutions = binst.solve_and_print()
+```
+
+**Script Output**
+
+```python
+Solution found
+[['1' '9' '4' '2' '3' '6' '8' '5' '7']
+ ['2' '8' '5' '9' '4' '7' '1' '6' '3']
+ ['6' '3' '8' '4' '7' '5' '9' '1' '2']
+ ['7' '6' '3' '5' '9' '1' '2' '8' '4']
+ ['4' '5' '2' '1' '6' '3' '7' '9' '8']
+ ['5' '7' '9' '8' '1' '4' '3' '2' '6']
+ ['3' '1' '7' '6' '8' '2' '5' '4' '9']
+ ['9' '4' '1' '7' '2' '8' '6' '3' '5']
+ ['8' '2' '6' '3' '5' '9' '4' '7' '1']]
+Solutions found: 1
+status: OPTIMAL
+Time taken: 0.01 seconds
+```
+
+**Solved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/sudoku_jigsaw_solved.png" alt="Sudoku Jigsaw solved" width="500">
+
+---
+
+## Sudoku Killer (Puzzle Type #53)
+
+* [**Play online**](https://www.puzzle-killer-sudoku.com/)
+
+* [**Solver Code**][53]
+
+<details>
+  <summary><strong>Rules</strong></summary>
+
+   1. The basic Sudoku rules apply.
+   2. The sum of all numbers in a cage must match the small number printed in its corner.
+   3. No number appears more than once in a cage.
+
+</details>
+
+**Unsolved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/sudoku_killer_unsolved.png" alt="Sudoku Killer unsolved" width="500">
+
+Code to utilize this package and solve the puzzle:
+
+(Note: the ids are arbitrary and simply represent cells that share a cage)
+
+```python
+import numpy as np
+from puzzle_solver import sudoku_solver as solver
+board = np.full((9, 9), ' ')
+killer_board = np.array([
+  ['01', '01', '03', '03', '03', '12', '12', '13', '14'],
+  ['02', '01', '04', '16', '16', '17', '17', '13', '14'],
+  ['02', '02', '04', '18', '19', '19', '15', '15', '14'],
+  ['11', '11', '05', '18', '19', '19', '20', '15', '23'],
+  ['10', '10', '05', '30', '31', '32', '20', '22', '23'],
+  ['08', '07', '06', '30', '31', '32', '21', '22', '24'],
+  ['08', '07', '06', '29', '31', '33', '21', '24', '24'],
+  ['09', '34', '34', '29', '28', '33', '26', '26', '25'],
+  ['09', '34', '34', '28', '28', '27', '27', '25', '25'],
+])
+killer_clues = {
+  '01': 16, '02': 11, '03': 24, '04': 10, '05': 11, '06': 7, '07': 10, '08': 10, '09': 16,
+  '10': 11, '11': 10, '12': 7, '13': 11, '14': 16, '15': 16, '16': 8, '17': 12, '18': 8, '19': 15,
+  '20': 7, '21': 10, '22': 5, '23': 13, '24': 16, '25': 9, '26': 14, '27': 15, '28': 13, '29': 11,
+  '30': 9, '31': 15, '32': 13, '33': 11, '34': 15,
+}
+binst = solver.Board(board=board, block_size=(3, 3), killer=(killer_board, killer_clues))
+solutions = binst.solve_and_print()
+```
+
+**Script Output**
+
+```python
+Solution found
+[['5' '4' '8' '7' '9' '1' '6' '2' '3']
+ ['3' '7' '1' '6' '2' '8' '4' '9' '5']
+ ['2' '6' '9' '5' '4' '3' '1' '7' '8']
+ ['1' '9' '4' '3' '6' '2' '5' '8' '7']
+ ['8' '3' '7' '1' '5' '9' '2' '4' '6']
+ ['6' '2' '5' '8' '7' '4' '3' '1' '9']
+ ['4' '8' '2' '9' '3' '5' '7' '6' '1']
+ ['7' '1' '3' '2' '8' '6' '9' '5' '4']
+ ['9' '5' '6' '4' '1' '7' '8' '3' '2']]
+Solutions found: 1
+status: OPTIMAL
+Time taken: 0.01 seconds
+```
+
+**Solved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/sudoku_killer_solved.png" alt="Sudoku Killer solved" width="500">
+
+---
+
+## Flood It (Puzzle Type #54)
+
+* [**Play online**](https://www.chiark.greenend.org.uk/~sgtatham/puzzles/js/flood.html)
+
+* [**Instructions**](https://www.chiark.greenend.org.uk/~sgtatham/puzzles/doc/flood.html#flood)
+
+* [**Solver Code**][54]
+
+<details>
+  <summary><strong>Rules</strong></summary>
+
+The game is a combinatorial puzzle played on a colored N by N grid where the goal is to make the entire grid a single color using the minimum number of moves.
+
+A move consists of picking a new color, which then floods the connected component of the player's current area that has that chosen color.
+
+The player's current area is the top-leftmost corner of the grid along with any similarly colored orthogonal cells connected to the current area.
+
+</details>
+
+This game has a lot of interesting mathematical properties related to Graph Theory (for example many details are referenced in this [2022 Graph Theory paper](https://arxiv.org/pdf/1101.5876))
+
+Finding an optimal solution for any graph is NP-hard. 
+
+**Unsolved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/flood_it_unsolved.png" alt="Flood It unsolved" width="500">
+
+Code to utilize this package and solve the puzzle:
+
+(Note: the ids are arbitrary and simply represent cells that share a cage)
+
+```python
+import numpy as np
+from puzzle_solver import flood_it_solver as solver
+board = np.array([
+    ['B', 'Y', 'G', 'Y', 'R', 'B', 'Y', 'Y', 'G', 'B', 'R', 'P'],
+    ['P', 'G', 'G', 'Y', 'B', 'O', 'Y', 'O', 'B', 'Y', 'R', 'O'],
+    ['B', 'R', 'P', 'Y', 'O', 'R', 'G', 'G', 'G', 'R', 'R', 'Y'],
+    ['O', 'G', 'P', 'G', 'Y', 'Y', 'P', 'P', 'O', 'Y', 'B', 'B'],
+    ['G', 'Y', 'G', 'O', 'R', 'G', 'R', 'P', 'G', 'O', 'B', 'R'],
+    ['R', 'G', 'B', 'G', 'O', 'B', 'O', 'G', 'B', 'O', 'O', 'B'],
+    ['G', 'B', 'P', 'R', 'Y', 'P', 'R', 'B', 'Y', 'B', 'Y', 'P'],
+    ['G', 'B', 'G', 'P', 'O', 'Y', 'R', 'Y', 'P', 'P', 'O', 'G'],
+    ['R', 'P', 'B', 'O', 'B', 'G', 'Y', 'O', 'Y', 'R', 'P', 'O'],
+    ['G', 'P', 'P', 'P', 'P', 'Y', 'G', 'P', 'O', 'G', 'O', 'R'],
+    ['Y', 'Y', 'B', 'B', 'R', 'B', 'O', 'R', 'O', 'O', 'R', 'O'],
+    ['B', 'G', 'B', 'G', 'R', 'B', 'P', 'Y', 'P', 'B', 'R', 'G']
+])
+solution = solver.solve_minimum_steps(board=board)
+```
+
+**Script Output**
+
+```python
+Trying with exactly 16 moves... Not possible!
+Trying with exactly 32 moves... Possible!
+Solution: ['Y', 'G', 'B', 'Y', 'B', 'R', 'B', 'Y', 'G', 'Y', 'G', 'B', 'B', 'G', 'Y', 'Y', 'R', 'B', 'Y', 'G', 'Y', 'B', 'Y', 'B', 'Y', 'B', 'G', 'Y', 'B', 'G', 'R', 'Y']
+Trying with exactly 24 moves... Possible!
+Solution: ['Y', 'G', 'B', 'Y', 'B', 'R', 'B', 'R', 'Y', 'G', 'R', 'Y', 'R', 'B', 'G', 'B', 'G', 'Y', 'G', 'B', 'Y', 'G', 'R', 'Y']
+Trying with exactly 20 moves... Possible!
+Solution: ['Y', 'G', 'B', 'Y', 'B', 'R', 'B', 'G', 'Y', 'G', 'B', 'G', 'Y', 'B', 'Y', 'R', 'B', 'G', 'R', 'Y']
+Trying with exactly 18 moves... Possible!
+Solution: ['Y', 'G', 'B', 'Y', 'R', 'B', 'R', 'Y', 'B', 'G', 'R', 'Y', 'R', 'B', 'G', 'R', 'Y', 'B']
+Trying with exactly 17 moves... Not possible!
+Best Horizon is: T=18
+Best solution is: ['Y', 'G', 'B', 'Y', 'R', 'B', 'R', 'Y', 'B', 'G', 'R', 'Y', 'R', 'B', 'G', 'R', 'Y', 'B']
+Time taken: 3.10 seconds
+```
+
+**Solved puzzle**
+
+This picture won't mean much as the game is about the sequence and number of moves not the final frame as shown here. 
+
+Note that the solved solution on the bottom left says that only 18 moves were used (based on the above output) despite the website saying 20 total moves are permitted (and the puzzle settings specified 0 extra moves permitted). Thus the solver managed to find a more optimal solution than the website.
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/flood_it_solved.png" alt="Flood It solved" width="500">
+
+---
+
+## Pipes (Puzzle Type #55)
+
+Also called "Net"
+
+* [**Play online 1**](https://www.chiark.greenend.org.uk/~sgtatham/puzzles/js/net.html)
+
+* [**Play online 2**](https://www.puzzle-pipes.com/)
+
+* [**Instructions**](https://www.chiark.greenend.org.uk/~sgtatham/puzzles/doc/net.html#net)
+
+* [**Solver Code**][55]
+
+<details>
+  <summary><strong>Rules</strong></summary>
+
+You are given a grid of cells where each cell has 1, 2, 3, or 4 connections to its neighbors. Each cell can be freely rotated in multiple of 90 degrees, thus your can rotate the cells to be one of four possible states.
+
+The goal is to create a single fully connected graph where each cell's connection must be towards another cell's connection. No loose ends or loops are allowed.
+
+</details>
+
+**Unsolved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/pipes_unsolved.png" alt="Pipes unsolved" width="500">
+
+Code to utilize this package and solve the puzzle:
+
+(Note: cells with 1 or 3 active connections only have 1 unique orientation under rotational symmetry. However, cells with 2 active connections can be either a straight line (2I) or curved line (2L))
+
+```python
+import numpy as np
+from puzzle_solver import pipes_solver as solver
+board=np.array([
+    [ '1 ', '3 ', '3 ', '3 ', '1 ', '1 ', '2L', '2L', '2I', '1 ' ],
+    [ '1 ', '1 ', '1 ', '3 ', '2I', '1 ', '2I', '3 ', '2I', '1 ' ],
+    [ '2I', '1 ', '1 ', '3 ', '2L', '1 ', '3 ', '2I', '1 ', '1 ' ],
+    [ '2I', '2I', '1 ', '3 ', '3 ', '3 ', '2L', '3 ', '3 ', '2L' ],
+    [ '3 ', '3 ', '2I', '3 ', '1 ', '3 ', '2I', '2L', '1 ', '2L' ],
+    [ '1 ', '1 ', '3 ', '2I', '3 ', '2L', '1 ', '1 ', '2L', '2L' ],
+    [ '1 ', '1 ', '3 ', '1 ', '1 ', '1 ', '3 ', '3 ', '3 ', '2L' ],
+    [ '3 ', '2I', '3 ', '3 ', '2L', '3 ', '3 ', '2I', '2L', '1 ' ],
+    [ '1 ', '1 ', '3 ', '3 ', '3 ', '3 ', '1 ', '2L', '3 ', '2L' ],
+    [ '1 ', '2I', '3 ', '2I', '1 ', '1 ', '1 ', '3 ', '1 ', '1 ' ],
+])
+binst = solver.Board(board=board)
+solutions = binst.solve_and_print()
+```
+
+**Script Output**
+
+```python
+Solution found
+[['R' 'DLR' 'DLR' 'DLR' 'L' 'R' 'DL' 'DR' 'LR' 'L']
+ ['D' 'U' 'U' 'UDR' 'LR' 'L' 'UD' 'UDR' 'LR' 'L']
+ ['UD' 'D' 'R' 'ULR' 'DL' 'R' 'UDL' 'UD' 'D' 'D']
+ ['UD' 'UD' 'R' 'DLR' 'ULR' 'DLR' 'UL' 'UDR' 'ULR' 'UL']
+ ['UDR' 'ULR' 'LR' 'ULR' 'L' 'UDR' 'LR' 'UL' 'R' 'DL']
+ ['U' 'R' 'DLR' 'LR' 'DLR' 'UL' 'D' 'D' 'DR' 'UL']
+ ['D' 'R' 'UDL' 'D' 'U' 'D' 'UDR' 'ULR' 'ULR' 'DL']
+ ['UDR' 'LR' 'ULR' 'UDL' 'DR' 'ULR' 'ULR' 'LR' 'DL' 'U']
+ ['U' 'R' 'DLR' 'ULR' 'ULR' 'DLR' 'L' 'DR' 'ULR' 'DL']
+ ['R' 'LR' 'ULR' 'LR' 'L' 'U' 'R' 'ULR' 'L' 'U']]
+Solutions found: 1
+status: OPTIMAL
+Time taken: 5.65 seconds
+```
+
+**Solved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/pipes_solved.png" alt="Pipes solved" width="500">
+
+---
+
 ---
 
 ## Why SAT / CP-SAT?
@@ -4925,3 +5255,7 @@ Issues and PRs welcome!
 [49]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/binairo_plus "puzzle_solver/src/puzzle_solver/puzzles/binairo_plus at master · Ar-Kareem/puzzle_solver · GitHub"
 [50]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/shakashaka "puzzle_solver/src/puzzle_solver/puzzles/shakashaka at master · Ar-Kareem/puzzle_solver · GitHub"
 [51]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/kakuro "puzzle_solver/src/puzzle_solver/puzzles/kakuro at master · Ar-Kareem/puzzle_solver · GitHub"
+[52]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/sudoku "puzzle_solver/src/puzzle_solver/puzzles/sudoku at master · Ar-Kareem/puzzle_solver · GitHub"
+[53]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/sudoku "puzzle_solver/src/puzzle_solver/puzzles/sudoku at master · Ar-Kareem/puzzle_solver · GitHub"
+[54]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/flood_it "puzzle_solver/src/puzzle_solver/puzzles/flood_it at master · Ar-Kareem/puzzle_solver · GitHub"
+[55]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/pipes "puzzle_solver/src/puzzle_solver/puzzles/pipes at master · Ar-Kareem/puzzle_solver · GitHub"