multi-puzzle-solver 1.0.9__tar.gz → 1.0.10__tar.gz

{multi_puzzle_solver-1.0.9 → multi_puzzle_solver-1.0.10}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: multi-puzzle-solver
-Version: 1.0.9
-Summary: Efficient solvers for countless (50+) types of puzzles (like Sudoku, Minesweeper, etc.) with a simple python API.
+Version: 1.0.10
+Summary: Efficient solvers for countless (60+) types of puzzles (like Sudoku, Minesweeper, etc.) with a simple python API.
 Author: Ar-Kareem
 Project-URL: Homepage, https://github.com/Ar-Kareem/puzzle_solver
 Project-URL: Repository, https://github.com/Ar-Kareem/puzzle_solver
@@ -26,7 +26,7 @@ Requires-Dist: pytest-xdist; extra == "dev"
 
 # Python Puzzle Solver
 
-Solve countless (50+) classical logic puzzles automatically in Python. 
+Solve countless (60+) classical logic puzzles automatically in Python. 
 
 ## Quick Start
 
@@ -73,7 +73,7 @@ Time taken: 0.04 seconds
 
 ## Introduction
 
-The aim of this repo is to provide very efficient solvers (i.e. not brute force solvers) for countless (50+) popular pencil logic puzzles like Nonograms, Sudoku, Minesweeper, and many more lesser known ones.
+The aim of this repo is to provide very efficient solvers (i.e. not brute force solvers) for countless (60+) popular pencil logic puzzles like Nonograms, Sudoku, Minesweeper, and many more lesser known ones.
 
 If you happen to have a puzzle similar to the ones listed below and want to solve it (or see how many potential solutions a partially covered board has), then this repo is perfect for you.
 
@@ -417,6 +417,18 @@ 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/puzzles/mathema_grids_solved.png" alt="Mathema Grids" width="140">
     </a>
   </td>
+  <td align="center">
+    <a href="#split-ends-puzzle-type-60"><b>N-Queens</b><br><br>
+      <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/7_queens_solved.png" alt="N-Queens" width="140">
+    </a>
+  </td>
+</tr>
+<tr>
+  <td align="center">
+    <a href="#split-ends-puzzle-type-61"><b>Split Ends</b><br><br>
+      <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/split_ends_solved.png" alt="Split Ends" width="140">
+    </a>
+  </td>
 </tr>
 </table>
 
@@ -491,6 +503,8 @@ These are all the puzzles that are implemented in this repo. <br> Click on any o
   - [Nonograms Colored (Puzzle Type #57)](#nonograms-colored-puzzle-type-57)
   - [ABC View (Puzzle Type #58)](#abc-view-puzzle-type-58)
   - [Mathema Grids (Puzzle Type #59)](#mathema-grids-puzzle-type-59)
+  - [Split Ends (Puzzle Type #61)](#split-ends-puzzle-type-61)
+  - [N-Queens (Puzzle Type #60)](#n-queens-puzzle-type-60)
   - [Why SAT / CP-SAT?](#why-sat--cp-sat)
   - [Testing](#testing)
   - [Contributing](#contributing)
@@ -4399,19 +4413,30 @@ solutions = binst.solve_and_print()
 
 **Script Output**
 
-The output tells you which squares to tap to solve the puzzle.
+The output tells you which squares to tap to solve the puzzle, the shaded squares are the ones that need to be tapped.
 
 ```python
 Solution found
-[['T' ' ' 'T' 'T' 'T' ' ' ' ']
- [' ' ' ' ' ' 'T' ' ' 'T' ' ']
- [' ' 'T' ' ' ' ' 'T' ' ' ' ']
- ['T' ' ' 'T' ' ' ' ' 'T' ' ']
- [' ' ' ' ' ' 'T' ' ' ' ' 'T']
- ['T' ' ' 'T' ' ' 'T' 'T' 'T']
- [' ' ' ' ' ' ' ' ' ' 'T' 'T']]
+
+    0   1   2   3   4   5   6
+  ┌───┬───┬───┬───┬───┬───┬───┐
+ 0│▒▒▒│   │▒▒▒│▒▒▒│▒▒▒│   │   │
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 1│   │   │   │▒▒▒│   │▒▒▒│   │
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 2│   │▒▒▒│   │   │▒▒▒│   │   │
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 3│▒▒▒│   │▒▒▒│   │   │▒▒▒│   │
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 4│   │   │   │▒▒▒│   │   │▒▒▒│
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 5│▒▒▒│   │▒▒▒│   │▒▒▒│▒▒▒│▒▒▒│
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 6│   │   │   │   │   │▒▒▒│▒▒▒│
+  └───┴───┴───┴───┴───┴───┴───┘
 Solutions found: 1
 status: OPTIMAL
+Time taken: 0.01 seconds
 ```
 
 **Solved puzzle**
@@ -5946,6 +5971,142 @@ Time taken: 0.00 seconds
 
 ---
 
+## Split Ends (Puzzle Type #61)
+
+* [**Play online**](https://krazydad.com/play/splitends/)
+
+* [**Solver Code**](https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/split_ends)
+
+<details>
+  <summary><strong>Rules</strong></summary>
+
+Each row and column contains four unique Y shapes (four different orientations) and two Os. Ys should not form straight lines by touching other Ys.
+
+</details>
+
+**Unsolved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/split_ends_unsolved.png" alt="Split Ends unsolved" width="500">
+
+Code to utilize this package and solve the puzzle:
+
+```python
+import numpy as np
+from puzzle_solver import split_ends_solver as solver
+board = np.array([
+    ['O', ' ', 'O', 'L', ' ', 'U'],
+    [' ', ' ', ' ', ' ', ' ', ' '],
+    [' ', 'R', ' ', ' ', 'O', ' '],
+    [' ', 'O', ' ', ' ', 'L', ' '],
+    [' ', ' ', ' ', ' ', ' ', ' '],
+    ['U', ' ', 'L', 'D', ' ', 'R'],
+])
+binst = solver.Board(board=board)
+solutions = binst.solve_and_print()
+```
+
+**Script Output**
+
+```python
+Solution found
+
+    0   1   2   3   4   5
+  ┌───┬───┬───┬───┬───┬───┐
+ 0│ O │ D │ O │ L │ R │ U │
+  ├───┼───┼───┼───┼───┼───┤
+ 1│ O │ L │ D │ R │ U │ O │
+  ├───┼───┼───┼───┼───┼───┤
+ 2│ D │ R │ O │ U │ O │ L │
+  ├───┼───┼───┼───┼───┼───┤
+ 3│ R │ O │ U │ O │ L │ D │
+  ├───┼───┼───┼───┼───┼───┤
+ 4│ L │ U │ R │ O │ D │ O │
+  ├───┼───┼───┼───┼───┼───┤
+ 5│ U │ O │ L │ D │ O │ R │
+  └───┴───┴───┴───┴───┴───┘
+Solutions found: 1
+status: OPTIMAL
+Time taken: 0.01 seconds
+```
+
+**Solved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/split_ends_solved.png" alt="Split Ends solved" width="500">
+
+---
+
+## N-Queens (Puzzle Type #60)
+
+Can also solve puzzles such as 7-Queens.
+
+* [**Play online**](https://krazydad.com/play/queens/)
+
+* [**Solver Code**](https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/n_queens)
+
+<details>
+  <summary><strong>Rules</strong></summary>
+
+7-Queens Variant: Within each of the seven realms lives a lone queen. To maintain the peace, queens must not threaten each other: no row, column, diagonal, nor region may have more than one queen!
+
+</details>
+
+**Unsolved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/7_queens_unsolved.png" alt="7 Queens unsolved" width="500">
+
+Code to utilize this package and solve the puzzle:
+
+```python
+import numpy as np
+from puzzle_solver import n_queens_solver as solver
+board = np.array([
+  ['00', '00', '00', '00', '01', '01', '02', '02'],
+  ['00', '00', '03', '03', '01', '01', '02', '04'],
+  ['00', '00', '03', '03', '01', '01', '01', '04'],
+  ['03', '03', '03', '03', '01', '01', '01', '05'],
+  ['03', '03', '03', '03', '01', '01', '01', '05'],
+  ['03', '03', '06', '06', '06', '05', '05', '05'],
+  ['06', '06', '06', '06', '06', '06', '05', '05'],
+  ['06', '06', '06', '06', '06', '06', '05', '05']
+])
+binst = solver.Board(board=board)
+solutions = binst.solve_and_print()
+```
+
+**Script Output**
+
+```python
+Solution found
+
+    0   1   2   3   4   5   6   7
+  ┌───┬───┬───┬───┬───┬───┬───┬───┐
+ 0│   │   │   │   │   │   │▒▒▒│   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 1│▒▒▒│   │   │   │   │   │   │   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 2│   │   │   │   │   │   │   │▒▒▒│
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 3│   │   │   │   │▒▒▒│   │   │   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 4│   │▒▒▒│   │   │   │   │   │   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 5│   │   │   │   │   │▒▒▒│   │   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 6│   │   │▒▒▒│   │   │   │   │   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 7│   │   │   │   │   │   │   │   │
+  └───┴───┴───┴───┴───┴───┴───┴───┘
+Solutions found: 1
+status: OPTIMAL
+Time taken: 0.00 seconds
+```
+
+**Solved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/7_queens_solved.png" alt="7 Queens solved" width="500">
+
+---
+
 ---
 
 ## Why SAT / CP-SAT?

{multi_puzzle_solver-1.0.9 → multi_puzzle_solver-1.0.10}/README.md

@@ -1,6 +1,6 @@
 # Python Puzzle Solver
 
-Solve countless (50+) classical logic puzzles automatically in Python. 
+Solve countless (60+) classical logic puzzles automatically in Python. 
 
 ## Quick Start
 
@@ -47,7 +47,7 @@ Time taken: 0.04 seconds
 
 ## Introduction
 
-The aim of this repo is to provide very efficient solvers (i.e. not brute force solvers) for countless (50+) popular pencil logic puzzles like Nonograms, Sudoku, Minesweeper, and many more lesser known ones.
+The aim of this repo is to provide very efficient solvers (i.e. not brute force solvers) for countless (60+) popular pencil logic puzzles like Nonograms, Sudoku, Minesweeper, and many more lesser known ones.
 
 If you happen to have a puzzle similar to the ones listed below and want to solve it (or see how many potential solutions a partially covered board has), then this repo is perfect for you.
 
@@ -391,6 +391,18 @@ 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/puzzles/mathema_grids_solved.png" alt="Mathema Grids" width="140">
     </a>
   </td>
+  <td align="center">
+    <a href="#split-ends-puzzle-type-60"><b>N-Queens</b><br><br>
+      <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/7_queens_solved.png" alt="N-Queens" width="140">
+    </a>
+  </td>
+</tr>
+<tr>
+  <td align="center">
+    <a href="#split-ends-puzzle-type-61"><b>Split Ends</b><br><br>
+      <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/split_ends_solved.png" alt="Split Ends" width="140">
+    </a>
+  </td>
 </tr>
 </table>
 
@@ -465,6 +477,8 @@ These are all the puzzles that are implemented in this repo. <br> Click on any o
   - [Nonograms Colored (Puzzle Type #57)](#nonograms-colored-puzzle-type-57)
   - [ABC View (Puzzle Type #58)](#abc-view-puzzle-type-58)
   - [Mathema Grids (Puzzle Type #59)](#mathema-grids-puzzle-type-59)
+  - [Split Ends (Puzzle Type #61)](#split-ends-puzzle-type-61)
+  - [N-Queens (Puzzle Type #60)](#n-queens-puzzle-type-60)
   - [Why SAT / CP-SAT?](#why-sat--cp-sat)
   - [Testing](#testing)
   - [Contributing](#contributing)
@@ -4373,19 +4387,30 @@ solutions = binst.solve_and_print()
 
 **Script Output**
 
-The output tells you which squares to tap to solve the puzzle.
+The output tells you which squares to tap to solve the puzzle, the shaded squares are the ones that need to be tapped.
 
 ```python
 Solution found
-[['T' ' ' 'T' 'T' 'T' ' ' ' ']
- [' ' ' ' ' ' 'T' ' ' 'T' ' ']
- [' ' 'T' ' ' ' ' 'T' ' ' ' ']
- ['T' ' ' 'T' ' ' ' ' 'T' ' ']
- [' ' ' ' ' ' 'T' ' ' ' ' 'T']
- ['T' ' ' 'T' ' ' 'T' 'T' 'T']
- [' ' ' ' ' ' ' ' ' ' 'T' 'T']]
+
+    0   1   2   3   4   5   6
+  ┌───┬───┬───┬───┬───┬───┬───┐
+ 0│▒▒▒│   │▒▒▒│▒▒▒│▒▒▒│   │   │
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 1│   │   │   │▒▒▒│   │▒▒▒│   │
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 2│   │▒▒▒│   │   │▒▒▒│   │   │
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 3│▒▒▒│   │▒▒▒│   │   │▒▒▒│   │
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 4│   │   │   │▒▒▒│   │   │▒▒▒│
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 5│▒▒▒│   │▒▒▒│   │▒▒▒│▒▒▒│▒▒▒│
+  ├───┼───┼───┼───┼───┼───┼───┤
+ 6│   │   │   │   │   │▒▒▒│▒▒▒│
+  └───┴───┴───┴───┴───┴───┴───┘
 Solutions found: 1
 status: OPTIMAL
+Time taken: 0.01 seconds
 ```
 
 **Solved puzzle**
@@ -5920,6 +5945,142 @@ Time taken: 0.00 seconds
 
 ---
 
+## Split Ends (Puzzle Type #61)
+
+* [**Play online**](https://krazydad.com/play/splitends/)
+
+* [**Solver Code**](https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/split_ends)
+
+<details>
+  <summary><strong>Rules</strong></summary>
+
+Each row and column contains four unique Y shapes (four different orientations) and two Os. Ys should not form straight lines by touching other Ys.
+
+</details>
+
+**Unsolved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/split_ends_unsolved.png" alt="Split Ends unsolved" width="500">
+
+Code to utilize this package and solve the puzzle:
+
+```python
+import numpy as np
+from puzzle_solver import split_ends_solver as solver
+board = np.array([
+    ['O', ' ', 'O', 'L', ' ', 'U'],
+    [' ', ' ', ' ', ' ', ' ', ' '],
+    [' ', 'R', ' ', ' ', 'O', ' '],
+    [' ', 'O', ' ', ' ', 'L', ' '],
+    [' ', ' ', ' ', ' ', ' ', ' '],
+    ['U', ' ', 'L', 'D', ' ', 'R'],
+])
+binst = solver.Board(board=board)
+solutions = binst.solve_and_print()
+```
+
+**Script Output**
+
+```python
+Solution found
+
+    0   1   2   3   4   5
+  ┌───┬───┬───┬───┬───┬───┐
+ 0│ O │ D │ O │ L │ R │ U │
+  ├───┼───┼───┼───┼───┼───┤
+ 1│ O │ L │ D │ R │ U │ O │
+  ├───┼───┼───┼───┼───┼───┤
+ 2│ D │ R │ O │ U │ O │ L │
+  ├───┼───┼───┼───┼───┼───┤
+ 3│ R │ O │ U │ O │ L │ D │
+  ├───┼───┼───┼───┼───┼───┤
+ 4│ L │ U │ R │ O │ D │ O │
+  ├───┼───┼───┼───┼───┼───┤
+ 5│ U │ O │ L │ D │ O │ R │
+  └───┴───┴───┴───┴───┴───┘
+Solutions found: 1
+status: OPTIMAL
+Time taken: 0.01 seconds
+```
+
+**Solved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/split_ends_solved.png" alt="Split Ends solved" width="500">
+
+---
+
+## N-Queens (Puzzle Type #60)
+
+Can also solve puzzles such as 7-Queens.
+
+* [**Play online**](https://krazydad.com/play/queens/)
+
+* [**Solver Code**](https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/n_queens)
+
+<details>
+  <summary><strong>Rules</strong></summary>
+
+7-Queens Variant: Within each of the seven realms lives a lone queen. To maintain the peace, queens must not threaten each other: no row, column, diagonal, nor region may have more than one queen!
+
+</details>
+
+**Unsolved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/7_queens_unsolved.png" alt="7 Queens unsolved" width="500">
+
+Code to utilize this package and solve the puzzle:
+
+```python
+import numpy as np
+from puzzle_solver import n_queens_solver as solver
+board = np.array([
+  ['00', '00', '00', '00', '01', '01', '02', '02'],
+  ['00', '00', '03', '03', '01', '01', '02', '04'],
+  ['00', '00', '03', '03', '01', '01', '01', '04'],
+  ['03', '03', '03', '03', '01', '01', '01', '05'],
+  ['03', '03', '03', '03', '01', '01', '01', '05'],
+  ['03', '03', '06', '06', '06', '05', '05', '05'],
+  ['06', '06', '06', '06', '06', '06', '05', '05'],
+  ['06', '06', '06', '06', '06', '06', '05', '05']
+])
+binst = solver.Board(board=board)
+solutions = binst.solve_and_print()
+```
+
+**Script Output**
+
+```python
+Solution found
+
+    0   1   2   3   4   5   6   7
+  ┌───┬───┬───┬───┬───┬───┬───┬───┐
+ 0│   │   │   │   │   │   │▒▒▒│   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 1│▒▒▒│   │   │   │   │   │   │   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 2│   │   │   │   │   │   │   │▒▒▒│
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 3│   │   │   │   │▒▒▒│   │   │   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 4│   │▒▒▒│   │   │   │   │   │   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 5│   │   │   │   │   │▒▒▒│   │   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 6│   │   │▒▒▒│   │   │   │   │   │
+  ├───┼───┼───┼───┼───┼───┼───┼───┤
+ 7│   │   │   │   │   │   │   │   │
+  └───┴───┴───┴───┴───┴───┴───┴───┘
+Solutions found: 1
+status: OPTIMAL
+Time taken: 0.00 seconds
+```
+
+**Solved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/puzzles/7_queens_solved.png" alt="7 Queens solved" width="500">
+
+---
+
 ---
 
 ## Why SAT / CP-SAT?

{multi_puzzle_solver-1.0.9 → multi_puzzle_solver-1.0.10}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "multi-puzzle-solver"
 dynamic = ["version"]
-description = "Efficient solvers for countless (50+) types of puzzles (like Sudoku, Minesweeper, etc.) with a simple python API."
+description = "Efficient solvers for countless (60+) types of puzzles (like Sudoku, Minesweeper, etc.) with a simple python API."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.9"
 authors = [{name = "Ar-Kareem"}]