multi-puzzle-solver 0.9.30__py3-none-any.whl → 1.0.2__py3-none-any.whl

puzzle_solver/puzzles/sudoku/sudoku.py

@@ -1,4 +1,5 @@
 from typing import Union, Optional
+from collections import defaultdict
 
 import numpy as np
 from ortools.sat.python import cp_model
@@ -35,32 +36,77 @@ def get_block_pos(i: int, Bv: int, Bh: int) -> list[Pos]:
 
 
 class Board:
-    def __init__(self, board: np.array, block_size: Optional[tuple[int, int]] = None, sandwich: Optional[dict[str, list[int]]] = None, unique_diagonal: bool = False):
+    def __init__(self,
+            board: np.array,
+            constrain_blocks: bool = True,
+            block_size: Optional[tuple[int, int]] = None,
+            sandwich: Optional[dict[str, list[int]]] = None,
+            unique_diagonal: bool = False,
+            jigsaw: Optional[np.array] = None,
+            killer: Optional[tuple[np.array, dict[str, int]]] = None,
+            ):
+        """
+        board: 2d array of characters
+        constrain_blocks: whether to constrain the blocks. If True, each block must contain all numbers from 1 to 9 exactly once.
+        block_size: tuple of block size (vertical, horizontal). If not provided, the block size is the square root of the board size.
+        sandwich: dictionary of sandwich clues (side, bottom). If provided, the sum of the values between 1 and 9 for each row and column is equal to the clue.
+        unique_diagonal: whether to constrain the 2 diagonals to be unique. If True, each diagonal must contain all numbers from 1 to 9 exactly once.
+        killer: tuple of (killer board, killer clues). If provided, the killer board must be a 2d array of ids of the killer blocks. The killer clues must be a dictionary of killer block ids to clues.
+            Each numbers in a killer block must be unique and sum to the clue.
+        """
         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(isinstance(i.item(), str) and len(i.item()) == 1 and (i.item().isalnum() or i.item() == ' ') for i in np.nditer(board)), 'board must contain only alphanumeric characters or space'
         self.board = board
         self.V, self.H = board.shape
-        if block_size is None:
-            B = np.sqrt(self.V)  # block size
-            assert B.is_integer(), 'board size must be a perfect square or provide block_size'
-            Bv, Bh = int(B), int(B)
+        self.L = max(self.V, self.H)
+        self.constrain_blocks = constrain_blocks
+        self.unique_diagonal = unique_diagonal
+        self.sandwich = None
+        self.jigsaw_id_to_pos = None
+        self.killer = None
+
+        if self.constrain_blocks:
+            if block_size is None:
+                B = np.sqrt(self.V)  # block size
+                assert B.is_integer(), 'board size must be a perfect square or provide block_size'
+                Bv, Bh = int(B), int(B)
+            else:
+                Bv, Bh = block_size
+                assert Bv * Bh == self.V, 'block size must be a factor of board size'
+            # can be different in 4x3 for example
+            self.Bv = Bv
+            self.Bh = Bh
+            self.B = Bv * Bh  # block count
         else:
-            Bv, Bh = block_size
-            assert Bv * Bh == self.V, 'block size must be a factor of board size'
-        # can be different in 4x3 for example
-        self.Bv = Bv
-        self.Bh = Bh
-        self.B = Bv * Bh  # block count
+            assert block_size is None, 'cannot set block size if blocks are not constrained'
+
+        if jigsaw is not None:
+            if self.constrain_blocks is not None:
+                print('Warning: jigsaw and blocks are both constrained, are you sure you want to do this?')
+            assert jigsaw.ndim == 2, f'jigsaw must be 2d, got {jigsaw.ndim}'
+            assert jigsaw.shape[0] == self.V and jigsaw.shape[1] == self.H, 'jigsaw must be the same size as the board'
+            assert all(isinstance(i.item(), str) and i.item().isdecimal() for i in np.nditer(jigsaw)), 'jigsaw must contain only digits or space'
+            self.jigsaw_id_to_pos: dict[int, list[Pos]] = defaultdict(list)
+            for pos in get_all_pos(self.V, self.H):
+                v = get_char(jigsaw, pos)
+                if v.isdecimal():
+                    self.jigsaw_id_to_pos[int(v)].append(pos)
+            assert all(len(pos_list) <= self.L for pos_list in self.jigsaw_id_to_pos.values()), 'jigsaw areas cannot be larger than the number of digits'
+
         if sandwich is not None:
             assert set(sandwich.keys()) == set(['side', 'bottom']), 'sandwich must contain only side and bottom'
             assert len(sandwich['side']) == self.H, 'side must be equal to board width'
             assert len(sandwich['bottom']) == self.V, 'bottom must be equal to board height'
             self.sandwich = sandwich
-        else:
-            self.sandwich = None
-        self.unique_diagonal = unique_diagonal
-    
+
+        if killer is not None:
+            assert killer[0].ndim == 2, f'killer board must be 2d, got {killer[0].ndim}'
+            assert killer[0].shape[0] == self.V and killer[0].shape[1] == self.H, 'killer board must be the same size as the board'
+            assert all(isinstance(i.item(), str) and i.item().isdecimal() for i in np.nditer(killer[0])), 'killer board must contain only digits or space'
+            assert set(killer[1].keys()).issubset(set(killer[0].flatten())), f'killer clues must contain all killer block ids, {set(killer[0].flatten()) - set(killer[1].keys())}'
+            self.killer = killer
+
         self.model = cp_model.CpModel()
         self.model_vars: dict[Pos, cp_model.IntVar] = {}
 
@@ -69,7 +115,7 @@ class Board:
 
     def create_vars(self):
         for pos in get_all_pos(self.V, self.H):
-            self.model_vars[pos] = self.model.NewIntVar(1, self.B, f'{pos}')
+            self.model_vars[pos] = self.model.NewIntVar(1, self.L, f'{pos}')
 
     def add_all_constraints(self):
         # some squares are already filled
@@ -86,16 +132,21 @@ class Board:
         for col in range(self.H):
             col_vars = [self.model_vars[pos] for pos in get_col_pos(col, V=self.V)]
             self.model.AddAllDifferent(col_vars)
-        # each block
-        for block_i in range(self.B):
-            block_vars = [self.model_vars[p] for p in get_block_pos(block_i, Bv=self.Bv, Bh=self.Bh)]
-            self.model.AddAllDifferent(block_vars)
+        if self.constrain_blocks:  # each block must contain all numbers from 1 to 9 exactly once
+            for block_i in range(self.B):
+                block_vars = [self.model_vars[p] for p in get_block_pos(block_i, Bv=self.Bv, Bh=self.Bh)]
+                self.model.AddAllDifferent(block_vars)
         if self.sandwich is not None:
             self.add_sandwich_constraints()
         if self.unique_diagonal:
             self.add_unique_diagonal_constraints()
+        if self.jigsaw_id_to_pos is not None:
+            self.add_jigsaw_constraints()
+        if self.killer is not None:
+            self.add_killer_constraints()
 
     def add_sandwich_constraints(self):
+        """Sandwich constraints, enforce that the sum of the values between 1 and 9 for each row and column is equal to the clue."""
         for c, clue in enumerate(self.sandwich['bottom']):
             if clue is None or int(clue) < 0:
                 continue
@@ -113,6 +164,26 @@ class Board:
         anti_diagonal_vars = [self.model_vars[get_pos(x=i, y=self.V-i-1)] for i in range(min(self.V, self.H))]
         self.model.AddAllDifferent(anti_diagonal_vars)
 
+    def add_jigsaw_constraints(self):
+        """All digits in one jigsaw area must be unique."""
+        for pos_list in self.jigsaw_id_to_pos.values():
+            self.model.AddAllDifferent([self.model_vars[p] for p in pos_list])
+
+    def add_killer_constraints(self):
+        """Killer constraints, enforce that the sum of the values in each killer block is equal to the clue and all numbers in a block are unique."""
+        killer_board, killer_clues = self.killer
+        # change clue keys to ints
+        killer_clues = {int(k): v for k, v in killer_clues.items()}
+        killer_id_to_pos = defaultdict(list)
+        for pos in get_all_pos(self.V, self.H):
+            v = get_char(killer_board, pos)
+            if v.isdecimal():
+                killer_id_to_pos[int(v)].append(pos)
+        for killer_id, pos_list in killer_id_to_pos.items():
+            self.model.AddAllDifferent([self.model_vars[p] for p in pos_list])
+            clue = killer_clues[killer_id]
+            self.model.Add(sum([self.model_vars[p] for p in pos_list]) == clue)
+
     def solve_and_print(self, verbose: bool = True):
         def board_to_solution(board: Board, solver: cp_model.CpSolverSolutionCallback) -> SingleSolution:
             assignment: dict[Pos, int] = {}

puzzle_solver/puzzles/tents/tents.py

@@ -45,14 +45,14 @@ class Board:
                 if get_char(self.board, neighbour) != ' ':
                     continue
                 self.model.Add(self.is_tent[neighbour] == 0).OnlyEnforceIf(self.is_tent[pos])
-        # - the number of tents in each row and column matches the numbers around the edge of the grid 
+        # - the number of tents in each row and column matches the numbers around the edge of the grid
         for row in range(self.N):
             row_vars = [self.is_tent[pos] for pos in get_row_pos(row, self.N)]
             self.model.Add(lxp.sum(row_vars) == self.sides['side'][row])
         for col in range(self.N):
             col_vars = [self.is_tent[pos] for pos in get_col_pos(col, self.N)]
             self.model.Add(lxp.sum(col_vars) == self.sides['top'][col])
-        # - it is possible to match tents to trees so that each tree is orthogonally adjacent to its own tent (but may also be adjacent to other tents). 
+        # - it is possible to match tents to trees so that each tree is orthogonally adjacent to its own tent (but may also be adjacent to other tents).
         # for each tree, one of the following must be true:
         # a tent on its left has direction RIGHT
         # a tent on its right has direction LEFT

puzzle_solver/puzzles/thermometers/thermometers.py

@@ -47,7 +47,7 @@ class Board:
     def create_vars(self):
         for pos in get_all_pos(self.V, self.H):
             self.model_vars[pos] = self.model.NewBoolVar(f'{pos}')
-    
+
     def add_all_constraints(self):
         visited: set[Pos] = set()
         for cur_pos in self.tip:

puzzle_solver/puzzles/towers/towers.py

@@ -120,7 +120,7 @@ class Board:
         # create a single bool which decides if I can see it or not
         res = self.model.NewBoolVar(name)
         self.model.AddBoolAnd(lits).OnlyEnforceIf(res)
-        self.model.AddBoolOr([res] + [l.Not() for l in lits])
+        self.model.AddBoolOr([res] + [lit.Not() for lit in lits])
         return res
 
     def solve_and_print(self, verbose: bool = True):

puzzle_solver/puzzles/undead/undead.py

@@ -131,7 +131,7 @@ class Board:
             pos = get_pos(x=i, y=self.N-1)
             beam_result = beam(self.board, pos, Direction.UP)
             self.model.add(self.get_var(beam_result) == ground)
-        
+
         if self.monster_count is not None:
             for monster, count in self.monster_count.items():
                 if count == -1:

puzzle_solver/puzzles/unruly/unruly.py

@@ -49,7 +49,7 @@ class Board:
                 continue
             v = 1 if c == 'B' else 0
             self.model.Add(self.model_vars[pos] == v)
-        # no three consecutive squares, horizontally or vertically, are the same colour 
+        # no three consecutive squares, horizontally or vertically, are the same colour
         for pos in get_all_pos(self.V, self.H):
             horiz, vert = get_3_consecutive_horiz_and_vert(pos, self.V, self.H)
             if len(horiz) == 3:

puzzle_solver/puzzles/yin_yang/yin_yang.py

@@ -48,7 +48,7 @@ class Board:
                 continue
             self.model.AddBoolOr([self.B[tl], self.B[tr], self.B[bl], self.B[br]])
             self.model.AddBoolOr([self.B[tl].Not(), self.B[tr].Not(), self.B[bl].Not(), self.B[br].Not()])
-    
+
     def disallow_checkers(self):
         # from https://ralphwaldo.github.io/yinyang_summary.html
         for pos in get_all_pos(self.V, self.H):  # disallow (WB/BW) and (BW/WB)

puzzle_solver/utils/visualizer.py

@@ -152,4 +152,4 @@ if __name__ == '__main__':
     print('max i:', max(nums))
     if all(str(c).isdigit() for c in nums):
         print('skipped:', set(range(int(max(nums)) + 1)) - set(int(i) for i in nums))
-    render_board_image(board, colors)
+    render_board_image(board, colors)

multi_puzzle_solver-0.9.30.dist-info/RECORD

@@ -1,67 +0,0 @@
-puzzle_solver/__init__.py,sha256=f79JI0EQhfQi12yO6gvuzzLtxXQgojVrq-v8HZrzjS0,3693
-puzzle_solver/core/utils.py,sha256=XBW5j-IwtJMPMP-ycmY6SqRCM1NOVl5O6UeoGqNj618,8153
-puzzle_solver/core/utils_ortools.py,sha256=_i8cixHOB5XGqqcr-493bOiZgYJidnvxQMEfj--Trns,10278
-puzzle_solver/core/utils_visualizer.py,sha256=2jBnS2PeI4keFf-rneScSxX669zXu5F1lkClZ5EkMhE,21152
-puzzle_solver/puzzles/aquarium/aquarium.py,sha256=BUfkAS2d9eG3TdMoe1cOGGeNYgKUebRvn-z9nsC9gvE,5708
-puzzle_solver/puzzles/battleships/battleships.py,sha256=RuYCrs4j0vUjlU139NRYYP-uNPAgO0V7hAzbsHrRwD8,7446
-puzzle_solver/puzzles/binairo/binairo.py,sha256=4xgYd1ewYIQCqEzsHdgp6hWzyW_TF_2rt6PO8QLFKWU,6838
-puzzle_solver/puzzles/binairo/binairo_plus.py,sha256=TvLG3olwANtft3LuCF-y4OofpU9PNa4IXDqgZqsD-g0,267
-puzzle_solver/puzzles/black_box/black_box.py,sha256=ZnHDVt6PFS_r1kMNSsbz9hav1hxIrNDUvPyERGPjLjM,15635
-puzzle_solver/puzzles/bridges/bridges.py,sha256=15A9uV4xjoqPRo_9CTnoKeGRxS3z2aMF619T1n0dTOQ,5402
-puzzle_solver/puzzles/chess_range/chess_melee.py,sha256=D-_Oi8OyxsVe1j3dIKYwRlxgeb3NWLmDWGcv-oclY0c,195
-puzzle_solver/puzzles/chess_range/chess_range.py,sha256=uMQGTIwzGskHIhI-tPYjT9a3wHUBIkZ18eXjV9IpUE4,21071
-puzzle_solver/puzzles/chess_range/chess_solo.py,sha256=U3v766UsZHx_dC3gxqU90VbjAXn-OlYhtrnnvJYFvrQ,401
-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=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
-puzzle_solver/puzzles/heyawake/heyawake.py,sha256=qMnc_CuHn8K5Rw40tefjueI1pycpHQ7eN1R9Xg5WEuw,5601
-puzzle_solver/puzzles/inertia/inertia.py,sha256=gJBahkh69CrSWNscalKEoP1j4X-Q3XpbIBMiG9PUpU0,5657
-puzzle_solver/puzzles/inertia/tsp.py,sha256=gobiISHtARA4Elq0jr90p6Yhq11ULjGoqsS-rLFhYcc,15389
-puzzle_solver/puzzles/inertia/parse_map/parse_map.py,sha256=A9JQTNqamUdzlwqks0XQp3Hge3mzyTIVK6YtDJvqpL4,8422
-puzzle_solver/puzzles/kakurasu/kakurasu.py,sha256=VNGMJnBHDi6WkghLObRLhUvkmrPaGphTTUDMC0TkQvQ,2064
-puzzle_solver/puzzles/kakuro/kakuro.py,sha256=Jf0Iilv32EPcaWikX92_vgBOVRp5MAE27aFRmnLotGQ,4374
-puzzle_solver/puzzles/keen/keen.py,sha256=tDb6C5S3Q0JAKPsdw-84WQ6PxRADELZHr_BK8FDH-NA,5039
-puzzle_solver/puzzles/light_up/light_up.py,sha256=iSA1rjZMFsnI0V0Nxivxox4qZkB7PvUrROSHXcoUXds,4541
-puzzle_solver/puzzles/lits/lits.py,sha256=3fPIkhAIUz8JokcfaE_ZM3b0AFEnf5xPzGJ2qnm8SWY,7099
-puzzle_solver/puzzles/magnets/magnets.py,sha256=-Wl49JD_PKeq735zQVMQ3XSQX6gdHiY-7PKw-Sh16jw,6474
-puzzle_solver/puzzles/map/map.py,sha256=sxc57tapB8Tsgam-yoDitln1o-EB_SbIYvO6WEYy3us,2582
-puzzle_solver/puzzles/minesweeper/minesweeper.py,sha256=LiQVOGkWCsc1WtX8CdPgL_WwAcaeUFuoi5_eqH8U2Og,5876
-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/nurikabe/nurikabe.py,sha256=VMJjB9KAKmfBkG1mDT3Jf2I1PZJb--Qx0BicN8xL4eg,6519
-puzzle_solver/puzzles/palisade/palisade.py,sha256=T-LXlaLU5OwUQ24QWJWhBUFUktg0qDODTilNmBaXs4I,5014
-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=zaPg3qI9TNxr2iXmNi2kOL8R2RsS9DyQPUTY3ukgYIA,7033
-puzzle_solver/puzzles/shakashaka/shakashaka.py,sha256=PRpg_qI7XA3ysAo_g1TRJsT3VwB5Vial2UcFyBOMwKQ,9571
-puzzle_solver/puzzles/shingoki/shingoki.py,sha256=uwX1ZIGGDlshMtsZedlgGYE8hDB1ou3h6aBnZEr_l8I,7425
-puzzle_solver/puzzles/signpost/signpost.py,sha256=-0_S6ycwzwlUf9-ZhP127Rgo5gMBOHiTM6t08dLLDac,3869
-puzzle_solver/puzzles/singles/singles.py,sha256=KKn_Yl-eW874Bl1UmmcqoQ5vhNiO1JbM7fxKczOV5M4,2847
-puzzle_solver/puzzles/slant/slant.py,sha256=xF-N4PuXYfx638NP1f1mi6YncIZB4mLtXtdS79XyPbg,6122
-puzzle_solver/puzzles/slant/parse_map/parse_map.py,sha256=dxnALSDXe9wU0uSD0QEXnzoh1q801mj1ePTNLtG0n60,4796
-puzzle_solver/puzzles/slitherlink/slitherlink.py,sha256=e1A_f_3J-QXN9fmt_Nf3FsYnp-TmE9TRKN06Wn4NnAU,7056
-puzzle_solver/puzzles/star_battle/star_battle.py,sha256=IX6w4H3sifN01kPPtrAVRCK0Nl_xlXXSHvJKw8K1EuE,3718
-puzzle_solver/puzzles/star_battle/star_battle_shapeless.py,sha256=lj05V0Y3A3NjMo1boMkPIwBhMtm6SWydjgAMeCf5EIo,225
-puzzle_solver/puzzles/stitches/stitches.py,sha256=iK8t02q43gH3FPbuIDn4dK0sbaOgZOnw8yHNRNvNuIU,6534
-puzzle_solver/puzzles/stitches/parse_map/parse_map.py,sha256=f49ZGVBPXjAGgqZnqPab6PcO_DsFDFZnG3uA8b-1d7k,10441
-puzzle_solver/puzzles/sudoku/sudoku.py,sha256=SE4TM_gic6Jj0fkDR_NzUJdX2XKyQ8eeOnVAQ011Xbo,8870
-puzzle_solver/puzzles/tapa/tapa.py,sha256=TsOQhnEvlC1JxaWiEjQg2KxRXJR49GrN71DsMvPpia8,5337
-puzzle_solver/puzzles/tents/tents.py,sha256=iyVK2WXfIT5j_9qqlQg0WmwvixwXlZSsHGK3XA-KpII,6283
-puzzle_solver/puzzles/thermometers/thermometers.py,sha256=nsvJZkm7G8FALT27bpaB0lv5E_AWawqmvapQI8QcYXw,4015
-puzzle_solver/puzzles/towers/towers.py,sha256=QvL0Pp-Z2ewCeq9ZkNrh8MShKOh-Y52sFBSudve68wk,6496
-puzzle_solver/puzzles/tracks/tracks.py,sha256=98xds9SKNqtOLFTRUX_KSMC7XYmZo567LOFeqotVQaM,7237
-puzzle_solver/puzzles/undead/undead.py,sha256=IrCUfzQFBem658P5KKqldG7vd2TugTHehcwseCarerM,6604
-puzzle_solver/puzzles/unequal/unequal.py,sha256=ExY2XDCrqROCDpRLfHo8uVr1zuli1QvbCdNCiDhlCac,6978
-puzzle_solver/puzzles/unruly/unruly.py,sha256=sDF0oKT50G-NshyW2DYrvAgD9q9Ku9ANUyNhGSAu7cQ,3827
-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.30.dist-info/METADATA,sha256=yxPV6ZvkvGPOs1O2HpIob3e94uFQXjpm5JJKdCXyc2s,335384
-multi_puzzle_solver-0.9.30.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-multi_puzzle_solver-0.9.30.dist-info/top_level.txt,sha256=exwVUQa-anK9vYrpKzBPvH8bX43iElWI4VeNiAyBGJY,14
-multi_puzzle_solver-0.9.30.dist-info/RECORD,,