multi-puzzle-solver 0.9.25__py3-none-any.whl → 0.9.26__py3-none-any.whl

{multi_puzzle_solver-0.9.25.dist-info → multi_puzzle_solver-0.9.26.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multi-puzzle-solver
-Version: 0.9.25
+Version: 0.9.26
 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
@@ -331,6 +331,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/palisade_solved.png" alt="Palisade" width="140">
     </a>
   </td>
+  <td align="center">
+    <a href="#flip-puzzle-type-44"><b>Flip</b><br><br>
+      <img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/flip_unsolved.png" alt="Flip" width="140">
+    </a>
+  </td>
 </tr>
 </table>
 
@@ -389,6 +394,7 @@ These are all the puzzles that are implemented in this repo. <br> Click on any o
   - [Binairo (Puzzle Type #41)](#binairo-puzzle-type-41)
   - [Rectangles (Puzzle Type #42)](#rectangles-puzzle-type-42)
   - [Palisade (Puzzle Type #43)](#palisade-puzzle-type-43)
+  - [Flip (Puzzle Type #44)](#flip-puzzle-type-44)
   - [Why SAT / CP-SAT?](#why-sat--cp-sat)
   - [Testing](#testing)
   - [Contributing](#contributing)
@@ -3730,14 +3736,13 @@ Applying the solution to the puzzle visually:
 
 ---
 
-
 ## Palisade (Puzzle Type #43)
 
 * [**Play online**](https://www.chiark.greenend.org.uk/~sgtatham/puzzles/js/palisade.html)
 
 * [**Instructions**](https://www.chiark.greenend.org.uk/~sgtatham/puzzles/doc/palisade.html#palisade)
 
-* [**Solver Code**][42]
+* [**Solver Code**][43]
 
 <details>
   <summary><strong>Rules</strong></summary>
@@ -3819,6 +3824,70 @@ Applying the solution to the puzzle visually:
 
 ---
 
+## Flip (Puzzle Type #44)
+
+* [**Play online**](https://www.chiark.greenend.org.uk/~sgtatham/puzzles/js/flip.html)
+
+* [**Instructions**](https://www.chiark.greenend.org.uk/~sgtatham/puzzles/doc/flip.html#flip)
+
+* [**Solver Code**][44]
+
+<details>
+  <summary><strong>Rules</strong></summary>
+
+You have a grid of squares, some light and some dark. Your aim is to light all the squares up at the same time. You can choose any square and flip its state from light to dark or dark to light, but when you do so, other squares around it change state as well. 
+
+</details>
+
+**Unsolved puzzle**
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/flip_unsolved.png" alt="Flip unsolved" width="500">
+
+Code to utilize this package and solve the puzzle:
+
+(Note: the solver also supports random mapping of squares to the neighbors they flip, see the test cases in `tests/test_flip.py` for usage examples)
+
+```python
+import numpy as np
+from puzzle_solver import flip_solver as solver
+board = np.array([
+    ['B', 'W', 'W', 'W', 'W', 'W', 'W'],
+    ['B', 'B', 'W', 'W', 'W', 'B', 'B'],
+    ['W', 'B', 'W', 'W', 'B', 'B', 'W'],
+    ['B', 'B', 'B', 'W', 'W', 'B', 'W'],
+    ['W', 'W', 'B', 'B', 'W', 'B', 'W'],
+    ['B', 'W', 'B', 'B', 'W', 'W', 'W'],
+    ['B', 'W', 'B', 'W', 'W', 'B', 'B'],
+])
+binst = solver.Board(board=board)
+solutions = binst.solve_and_print()
+```
+
+**Script Output**
+
+The output tells you which squares to tap to solve the puzzle.
+
+```python
+Solution found
+[['T' ' ' 'T' 'T' 'T' ' ' ' ']
+ [' ' ' ' ' ' 'T' ' ' 'T' ' ']
+ [' ' 'T' ' ' ' ' 'T' ' ' ' ']
+ ['T' ' ' 'T' ' ' ' ' 'T' ' ']
+ [' ' ' ' ' ' 'T' ' ' ' ' 'T']
+ ['T' ' ' 'T' ' ' 'T' 'T' 'T']
+ [' ' ' ' ' ' ' ' ' ' 'T' 'T']]
+Solutions found: 1
+status: OPTIMAL
+```
+
+**Solved puzzle**
+
+This picture won't mean much as the game is about the sequence of moves not the final frame as shown here.
+
+<img src="https://raw.githubusercontent.com/Ar-Kareem/puzzle_solver/master/images/flip_solved.png" alt="Flip solved" width="500">
+
+---
+
 ---
 
 ## Why SAT / CP-SAT?
@@ -3913,3 +3982,4 @@ Issues and PRs welcome!
 [41]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/binairo "puzzle_solver/src/puzzle_solver/puzzles/binairo at master · Ar-Kareem/puzzle_solver · GitHub"
 [42]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/rectangles "puzzle_solver/src/puzzle_solver/puzzles/rectangles at master · Ar-Kareem/puzzle_solver · GitHub"
 [43]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/palisade "puzzle_solver/src/puzzle_solver/puzzles/palisade at master · Ar-Kareem/puzzle_solver · GitHub"
+[44]: https://github.com/Ar-Kareem/puzzle_solver/tree/master/src/puzzle_solver/puzzles/flip "puzzle_solver/src/puzzle_solver/puzzles/flip at master · Ar-Kareem/puzzle_solver · GitHub"

{multi_puzzle_solver-0.9.25.dist-info → multi_puzzle_solver-0.9.26.dist-info}/RECORD

@@ -1,5 +1,5 @@
-puzzle_solver/__init__.py,sha256=DsQVO-Eo1odFFFvQB1IpbJw-Yr2MTtON6zMnLUi05P8,3203
-puzzle_solver/core/utils.py,sha256=7Wo8_LHLEv8bY5-HsuCuLIjttZMMW09DoL1CcFDiu1Q,14046
+puzzle_solver/__init__.py,sha256=ScIPz0Gi0xGaY-v7N0JcfFgKUvfdSF3lUggAh8yagdg,3201
+puzzle_solver/core/utils.py,sha256=LyrdhExCcdp7jWJJv1cu2urgS2gpcI44OsIipPeBAeQ,14113
 puzzle_solver/core/utils_ortools.py,sha256=_i8cixHOB5XGqqcr-493bOiZgYJidnvxQMEfj--Trns,10278
 puzzle_solver/puzzles/aquarium/aquarium.py,sha256=BUfkAS2d9eG3TdMoe1cOGGeNYgKUebRvn-z9nsC9gvE,5708
 puzzle_solver/puzzles/battleships/battleships.py,sha256=RuYCrs4j0vUjlU139NRYYP-uNPAgO0V7hAzbsHrRwD8,7446
@@ -12,7 +12,7 @@ puzzle_solver/puzzles/chess_range/chess_solo.py,sha256=U3v766UsZHx_dC3gxqU90VbjA
 puzzle_solver/puzzles/chess_sequence/chess_sequence.py,sha256=6ap3Wouf2PxHV4P56B9ol1QT98Ym6VHaxorQZWl6LnY,13692
 puzzle_solver/puzzles/dominosa/dominosa.py,sha256=Nmb7pn8U27QJwGy9F3wo8ylqo2_U51OAo3GN2soaNpc,7195
 puzzle_solver/puzzles/filling/filling.py,sha256=vrOIil285_r3IQ0F4c9mUBWMRVlPH4vowog_z1tCGdI,5567
-puzzle_solver/puzzles/flip/flip.py,sha256=4rQ-JsC_f33YKDM7aueKVlcVdDwzeBkTJL51K-Vy0gA,2223
+puzzle_solver/puzzles/flip/flip.py,sha256=ZngJLUhRNc7qqo2wtNLdMPx4u9w9JTUge27PmdXyDCw,3985
 puzzle_solver/puzzles/galaxies/galaxies.py,sha256=p10lpmW0FjtneFCMEjG1FSiEpQuvD8zZG9FG8zYGoes,5582
 puzzle_solver/puzzles/galaxies/parse_map/parse_map.py,sha256=v5TCrdREeOB69s9_QFgPHKA7flG69Im1HVzIdxH0qQc,9355
 puzzle_solver/puzzles/guess/guess.py,sha256=sH-NlYhxM3DNbhk4eGde09kgM0KaDvSbLrpHQiwcFGo,10791
@@ -29,7 +29,7 @@ puzzle_solver/puzzles/minesweeper/minesweeper.py,sha256=LiQVOGkWCsc1WtX8CdPgL_Ww
 puzzle_solver/puzzles/mosaic/mosaic.py,sha256=QX_nVpVKQg8OfaUcqFk9tKqsDyVqvZc6-XWvfI3YcSw,2175
 puzzle_solver/puzzles/nonograms/nonograms.py,sha256=1jmDTOCnmivmBlwtMDyyk3TVqH5IjapzLn7zLQ4qubk,6056
 puzzle_solver/puzzles/norinori/norinori.py,sha256=uC8vXAw35xsTmpmTeKqYW7tbcssms9LCcXFBONtV2Ng,4743
-puzzle_solver/puzzles/palisade/palisade.py,sha256=ZFvBnBVbR0iIcQ5Vm3PtHPjdSDvrO5OUbM91YoTKpHI,4962
+puzzle_solver/puzzles/palisade/palisade.py,sha256=GTtzuc1OZCm3D5p-Po7LzK1d-whJkNSZ9G9rWr3vFMc,4966
 puzzle_solver/puzzles/pearl/pearl.py,sha256=OhzpMYpxqvR3GCd5NH4ETT0NO4X753kRi6p5omYLChM,6798
 puzzle_solver/puzzles/range/range.py,sha256=rruvD5ZSaOgvQuX6uGV_Dkr82nSiWZ5kDz03_j7Tt24,4425
 puzzle_solver/puzzles/rectangles/rectangles.py,sha256=V7p6GSCwYrFfILDWiLLUbX08WlnPbQKdhQm8bMa2Mgw,7060
@@ -53,7 +53,7 @@ puzzle_solver/puzzles/unruly/unruly.py,sha256=sDF0oKT50G-NshyW2DYrvAgD9q9Ku9ANUy
 puzzle_solver/puzzles/yin_yang/yin_yang.py,sha256=WrRdNhmKhIARdGOt_36gpRxRzrfLGv3wl7igBpPFM64,5259
 puzzle_solver/puzzles/yin_yang/parse_map/parse_map.py,sha256=drjfoHqmFf6U-ZQUwrBbfGINRxDQpgbvy4U3D9QyMhM,6617
 puzzle_solver/utils/visualizer.py,sha256=tsX1yEKwmwXBYuBJpx_oZGe2UUt1g5yV73G3UbtmvtE,6817
-multi_puzzle_solver-0.9.25.dist-info/METADATA,sha256=DcVaQpmwyhYN0y0XxOcvomrpoerVjgYdylE8VUFml04,208538
-multi_puzzle_solver-0.9.25.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-multi_puzzle_solver-0.9.25.dist-info/top_level.txt,sha256=exwVUQa-anK9vYrpKzBPvH8bX43iElWI4VeNiAyBGJY,14
-multi_puzzle_solver-0.9.25.dist-info/RECORD,,
+multi_puzzle_solver-0.9.26.dist-info/METADATA,sha256=iVRpKnMdTJNLrbdh9eP19RsPCloN1iEFwtlvcwy_peg,211081
+multi_puzzle_solver-0.9.26.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+multi_puzzle_solver-0.9.26.dist-info/top_level.txt,sha256=exwVUQa-anK9vYrpKzBPvH8bX43iElWI4VeNiAyBGJY,14
+multi_puzzle_solver-0.9.26.dist-info/RECORD,,

puzzle_solver/__init__.py

@@ -8,7 +8,7 @@ from puzzle_solver.puzzles.chess_range import chess_solo as chess_solo_solver
 from puzzle_solver.puzzles.chess_range import chess_melee as chess_melee_solver
 from puzzle_solver.puzzles.dominosa import dominosa as dominosa_solver
 from puzzle_solver.puzzles.filling import filling as filling_solver
-# from puzzle_solver.puzzles.flip import flip as flip_solver
+from puzzle_solver.puzzles.flip import flip as flip_solver
 from puzzle_solver.puzzles.galaxies import galaxies as galaxies_solver
 from puzzle_solver.puzzles.guess import guess as guess_solver
 from puzzle_solver.puzzles.inertia import inertia as inertia_solver
@@ -45,4 +45,4 @@ from puzzle_solver.puzzles.yin_yang import yin_yang as yin_yang_solver
 
 from puzzle_solver.puzzles.inertia.parse_map.parse_map import main as inertia_image_parser
 
-__version__ = '0.9.25'
+__version__ = '0.9.26'

puzzle_solver/core/utils.py

@@ -42,7 +42,9 @@ def get_next_pos(cur_pos: Pos, direction: Union[Direction, Direction8]) -> Pos:
     return get_pos(cur_pos.x+delta_x, cur_pos.y+delta_y)
 
 
-def get_neighbors4(pos: Pos, V: int, H: int) -> Iterable[Pos]:
+def get_neighbors4(pos: Pos, V: int, H: int, include_self: bool = False) -> Iterable[Pos]:
+    if include_self:
+        yield pos
     for dx, dy in ((1,0),(-1,0),(0,1),(0,-1)):
         p2 = get_pos(x=pos.x+dx, y=pos.y+dy)
         if in_bounds(p2, V, H):

puzzle_solver/puzzles/flip/flip.py

@@ -1,18 +1,41 @@
+from typing import Any, Optional
+
 import numpy as np
 from ortools.sat.python import cp_model
-from ortools.sat.python.cp_model import LinearExpr as lxp
 
-from puzzle_solver.core.utils import Pos, get_all_pos, set_char, get_char, get_neighbors8
+from puzzle_solver.core.utils import Pos, get_all_pos, get_neighbors4, set_char, get_char, Direction, get_next_pos
 from puzzle_solver.core.utils_ortools import generic_solve_all, SingleSolution
 
 
 class Board:
-    def __init__(self, board: np.array):
+    def __init__(self, board: np.array, random_mapping: Optional[dict[Pos, Any]] = None):
         assert board.ndim == 2, f'board must be 2d, got {board.ndim}'
-        assert board.shape[0] == board.shape[1], 'board must be square'
-        assert all((c.item() == ' ') or str(c.item()).isdecimal() for c in np.nditer(board)), 'board must contain only space or digits'
+        assert all((c.item() in ['B', 'W']) for c in np.nditer(board)), 'board must contain only B or W'
         self.board = board
-        self.N = board.shape[0]
+        self.V, self.H = board.shape
+
+        if random_mapping is None:
+            self.tap_mapping: dict[Pos, set[Pos]] = {pos: list(get_neighbors4(pos, self.V, self.H, include_self=True)) for pos in get_all_pos(self.V, self.H)}
+        else:
+            mapping_value = list(random_mapping.values())[0]
+            if isinstance(mapping_value, (set, list, tuple)) and isinstance(list(mapping_value)[0], Pos):
+                self.tap_mapping: dict[Pos, set[Pos]] = {pos: set(random_mapping[pos]) for pos in get_all_pos(self.V, self.H)}
+            elif isinstance(mapping_value, (set, list, tuple)) and isinstance(list(mapping_value)[0], str):  # strings like "L", "UR", etc.
+                def _to_pos(pos: Pos, s: str) -> Pos:
+                    d = {'L': Direction.LEFT, 'R': Direction.RIGHT, 'U': Direction.UP, 'D': Direction.DOWN}[s[0]]
+                    r = get_next_pos(pos, d)
+                    if len(s) == 1:
+                        return r
+                    else:
+                        return _to_pos(r, s[1:])
+                self.tap_mapping: dict[Pos, set[Pos]] = {pos: set(_to_pos(pos, s) for s in random_mapping[pos]) for pos in get_all_pos(self.V, self.H)}
+            else:
+                raise ValueError(f'invalid random_mapping: {random_mapping}')
+            for k, v in self.tap_mapping.items():
+                if k not in v:
+                    v.add(k)
+
+
         self.model = cp_model.CpModel()
         self.model_vars: dict[Pos, cp_model.IntVar] = {}
 
@@ -20,16 +43,22 @@ class Board:
         self.add_all_constraints()
 
     def create_vars(self):
-        for pos in get_all_pos(self.N):
-            self.model_vars[pos] = self.model.NewBoolVar(f'{pos}')
+        for pos in get_all_pos(self.V, self.H):
+            self.model_vars[pos] = self.model.NewBoolVar(f'tap:{pos}')
 
     def add_all_constraints(self):
-        for pos in get_all_pos(self.N):
+        for pos in get_all_pos(self.V, self.H):
+            # the state of a position is its starting state + if it is tapped + if any pos pointing to it is tapped
             c = get_char(self.board, pos)
-            if not str(c).isdecimal():
-                continue
-            neighbour_vars = [self.model_vars[p] for p in get_neighbors8(pos, self.N, include_self=True)]
-            self.model.Add(lxp.sum(neighbour_vars) == int(c))
+            pos_that_will_turn_me = [k for k,v in self.tap_mapping.items() if pos in v]
+            literals = [self.model_vars[p] for p in pos_that_will_turn_me]
+            if c == 'W':  # if started as white then needs an even number of taps while xor checks for odd number
+                literals.append(self.model.NewConstant(True))
+            elif c == 'B':
+                pass
+            else:
+                raise ValueError(f'invalid character: {c}')
+            self.model.AddBoolXOr(literals)
 
     def solve_and_print(self, verbose: bool = True):
         def board_to_solution(board: Board, solver: cp_model.CpSolverSolutionCallback) -> SingleSolution:
@@ -39,10 +68,10 @@ class Board:
             return SingleSolution(assignment=assignment)
         def callback(single_res: SingleSolution):
             print("Solution found")
-            res = np.full((self.N, self.N), ' ', dtype=object)
-            for pos in get_all_pos(self.N):
+            res = np.full((self.V, self.H), ' ', dtype=object)
+            for pos in get_all_pos(self.V, self.H):
                 c = get_char(self.board, pos)
-                c = 'B' if single_res.assignment[pos] == 1 else ' '
+                c = 'T' if single_res.assignment[pos] == 1 else ' '
                 set_char(res, pos, c)
             print(res)
         return generic_solve_all(self, board_to_solution, callback=callback if verbose else None, verbose=verbose)

puzzle_solver/puzzles/palisade/palisade.py

@@ -44,7 +44,7 @@ def get_valid_translations(shape: Shape, board: np.array) -> set[Pos]:
                 if c != ' ' and c != str(shape_borders[i]):  # there is a clue and it doesn't match my translated shape, skip
                     break
             else:
-                yield tuple(get_pos(x=p[0], y=p[1]) for p in body)
+                yield frozenset(get_pos(x=p[0], y=p[1]) for p in body)