Variant Descriptions and Various Fixes (#137)

* add variant descriptions * fix imports * bump up versions of packages with known security vulnerabilities * add build instructions for Cython-based Lights Out closed-form solver
GamesCrafters · Sep 26, 2023 · cf498e6 · cf498e6
1 parent 195fdde
commit cf498e6
Show file tree

Hide file tree

Showing 38 changed files with 138 additions and 120 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,12 @@ pip install -r requirements.txt
 pip install -e .
 ```
 
+To get optional closed-form solver for Lights Out, run the following commands from the project's root directory:
+```
+cd puzzlesolver/extern
+python setup.py build_ext --inplace
+```
+
 Run from the base directory of the repositiory
 ```
 cd puzzlesolver/players

diff --git a/puzzlesolver/extern/m4ri/brilliantrussian.h b/puzzlesolver/extern/m4ri/brilliantrussian.h
@@ -38,8 +38,8 @@
 #include <stdlib.h>
 #include <string.h>
 
-#include <m4ri/mzd.h>
-#include <m4ri/mzp.h>
+#include <mzd.h>
+#include <mzp.h>
 
 /**
  * \brief Constructs all possible \f$2^k\f$ row combinations using the gray

diff --git a/puzzlesolver/extern/m4ri/debug_dump.h b/puzzlesolver/extern/m4ri/debug_dump.h
@@ -24,7 +24,7 @@
 #ifndef M4RI_DEBUG_DUMP
 #define M4RI_DEBUG_DUMP
 
-#include <m4ri/misc.h>
+#include <misc.h>
 
 static inline word calculate_hash(word const *rowptr, wi_t wide) {
   word hash = 0;

diff --git a/puzzlesolver/extern/m4ri/djb.c b/puzzlesolver/extern/m4ri/djb.c
@@ -7,11 +7,11 @@
 #include "config.h"
 #endif
 
-#include <m4ri/djb.h>
-#include <m4ri/io.h>
-#include <m4ri/misc.h>
-#include <m4ri/mzd.h>
-#include <m4ri/xor.h>
+#include <djb.h>
+#include <io.h>
+#include <misc.h>
+#include <mzd.h>
+#include <xor.h>
 
 #ifndef _MSC_VER
 #include <unistd.h>

diff --git a/puzzlesolver/extern/m4ri/djb.h b/puzzlesolver/extern/m4ri/djb.h
@@ -17,7 +17,7 @@
 #ifndef M4RI_DJB_H
 #define M4RI_DJB_H
 
-#include <m4ri/mzd.h>
+#include <mzd.h>
 
 /**
  * \brief Specify source type of addition

diff --git a/puzzlesolver/extern/m4ri/echelonform.h b/puzzlesolver/extern/m4ri/echelonform.h
@@ -28,7 +28,7 @@
  *
  ********************************************************************/
 
-#include <m4ri/mzd.h>
+#include <mzd.h>
 
 /**
  * Density at which we switch to PLE decomposition.

diff --git a/puzzlesolver/extern/m4ri/io.h b/puzzlesolver/extern/m4ri/io.h
@@ -28,8 +28,8 @@
  *
  ********************************************************************/
 
-#include <m4ri/m4ri_config.h>
-#include <m4ri/mzd.h>
+#include <m4ri_config.h>
+#include <mzd.h>
 
 /**
  * \brief Print row i of M to an output stream.

diff --git a/puzzlesolver/extern/m4ri/m4ri.h b/puzzlesolver/extern/m4ri/m4ri.h
@@ -54,21 +54,21 @@
 extern "C" {
 #endif
 
-#include <m4ri/brilliantrussian.h>
-#include <m4ri/djb.h>
-#include <m4ri/echelonform.h>
-#include <m4ri/graycode.h>
-#include <m4ri/io.h>
-#include <m4ri/mp.h>
-#include <m4ri/mzd.h>
-#include <m4ri/mzp.h>
-#include <m4ri/parity.h>
-#include <m4ri/ple.h>
-#include <m4ri/ple_russian.h>
-#include <m4ri/solve.h>
-#include <m4ri/strassen.h>
-#include <m4ri/triangular.h>
-#include <m4ri/triangular_russian.h>
+#include <brilliantrussian.h>
+#include <djb.h>
+#include <echelonform.h>
+#include <graycode.h>
+#include <io.h>
+#include <mp.h>
+#include <mzd.h>
+#include <mzp.h>
+#include <parity.h>
+#include <ple.h>
+#include <ple_russian.h>
+#include <solve.h>
+#include <strassen.h>
+#include <triangular.h>
+#include <triangular_russian.h>
 
 #if defined(__cplusplus) && !defined(_MSC_VER)
 }

diff --git a/puzzlesolver/extern/m4ri/misc.h b/puzzlesolver/extern/m4ri/misc.h
@@ -33,7 +33,7 @@
  *
  ********************************************************************/
 
-#include <m4ri/m4ri_config.h>
+#include <m4ri_config.h>
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"

diff --git a/puzzlesolver/extern/m4ri/mmc.h b/puzzlesolver/extern/m4ri/mmc.h
@@ -31,7 +31,7 @@
  *
  ********************************************************************/
 
-#include <m4ri/misc.h>
+#include <misc.h>
 
 void *m4ri_mmc_malloc(size_t size);
 void m4ri_mmc_free(void *condemned, size_t size);

diff --git a/puzzlesolver/extern/m4ri/mp.h b/puzzlesolver/extern/m4ri/mp.h
@@ -29,7 +29,7 @@
  *
  ********************************************************************/
 
-#include <m4ri/mzd.h>
+#include <mzd.h>
 
 /**
  * \brief Matrix multiplication via the cubic multiplication algorithm on

diff --git a/puzzlesolver/extern/m4ri/mzd.h b/puzzlesolver/extern/m4ri/mzd.h
@@ -36,7 +36,7 @@
 #include "config.h"
 #endif
 
-#include <m4ri/m4ri_config.h>
+#include <m4ri_config.h>
 
 #include <assert.h>
 #include <math.h>
@@ -46,7 +46,7 @@
 #include <emmintrin.h>
 #endif
 
-#include <m4ri/debug_dump.h>
+#include <debug_dump.h>
 
 /**
  * \brief Matrix multiplication block-ing dimension.

diff --git a/puzzlesolver/extern/m4ri/mzp.h b/puzzlesolver/extern/m4ri/mzp.h
@@ -28,7 +28,7 @@
 #ifndef M4RI_MZP
 #define M4RI_MZP
 
-#include <m4ri/mzd.h>
+#include <mzd.h>
 
 /**
  * \brief Permutations.

diff --git a/puzzlesolver/extern/m4ri/parity.h b/puzzlesolver/extern/m4ri/parity.h
@@ -29,7 +29,7 @@
  * \author David Harvey
  */
 
-#include <m4ri/misc.h>
+#include <misc.h>
 
 /**
  * \brief Step for mixing two 64-bit words to compute their parity.

diff --git a/puzzlesolver/extern/m4ri/ple.h b/puzzlesolver/extern/m4ri/ple.h
@@ -30,8 +30,8 @@
  *
  ********************************************************************/
 
-#include <m4ri/mzd.h>
-#include <m4ri/mzp.h>
+#include <mzd.h>
+#include <mzp.h>
 
 /**
  * Crossover point for PLUQ factorization.

diff --git a/puzzlesolver/extern/m4ri/ple_russian.h b/puzzlesolver/extern/m4ri/ple_russian.h
@@ -30,8 +30,8 @@
  *
  ********************************************************************/
 
-#include <m4ri/mzd.h>
-#include <m4ri/mzp.h>
+#include <mzd.h>
+#include <mzp.h>
 
 /**
  * \brief PLE Elimination Tables

diff --git a/puzzlesolver/extern/m4ri/ple_russian_template.h b/puzzlesolver/extern/m4ri/ple_russian_template.h
@@ -1,4 +1,4 @@
-#include <m4ri/misc.h>
+#include <misc.h>
 
 void __M4RI_TEMPLATE_NAME(_mzd_process_rows_ple)(mzd_t *M, rci_t startrow, rci_t stoprow,
                                                  rci_t startcol, int const k[N],

diff --git a/puzzlesolver/extern/m4ri/solve.h b/puzzlesolver/extern/m4ri/solve.h
@@ -29,8 +29,8 @@
  *
  ********************************************************************/
 
-#include <m4ri/mzd.h>
-#include <m4ri/mzp.h>
+#include <mzd.h>
+#include <mzp.h>
 
 /**
  * \brief Solves A X = B with A and B matrices.

diff --git a/puzzlesolver/extern/m4ri/strassen.h b/puzzlesolver/extern/m4ri/strassen.h
@@ -32,8 +32,8 @@
  *
  ********************************************************************/
 
-#include <m4ri/brilliantrussian.h>
-#include <m4ri/mzd.h>
+#include <brilliantrussian.h>
+#include <mzd.h>
 #include <math.h>
 
 /**

diff --git a/puzzlesolver/extern/m4ri/triangular.h b/puzzlesolver/extern/m4ri/triangular.h
@@ -29,7 +29,7 @@
  *
  ********************************************************************/
 
-#include <m4ri/mzd.h>
+#include <mzd.h>
 
 /**
  * \brief Solves X U = B with X and B matrices and U upper triangular.

diff --git a/puzzlesolver/extern/m4ri/triangular_russian.h b/puzzlesolver/extern/m4ri/triangular_russian.h
@@ -28,7 +28,7 @@
  *
  ********************************************************************/
 
-#include <m4ri/mzd.h>
+#include <mzd.h>
 
 /**
  * \brief Solves L X = B with X and B matrices and L lower triangular using Gray code tables.

diff --git a/puzzlesolver/extern/m4ri/xor.h b/puzzlesolver/extern/m4ri/xor.h
@@ -28,13 +28,13 @@
  *
  ********************************************************************/
 
-#include <m4ri/m4ri_config.h>
+#include <m4ri_config.h>
 
 #if __M4RI_HAVE_SSE2
 #include <emmintrin.h>
 #endif
 
-#include <m4ri/misc.h>
+#include <misc.h>
 
 /**
  * Compute c[i] += t1[i] for 0 <= i < wide

diff --git a/puzzlesolver/extern/m4ri/xor_template.h b/puzzlesolver/extern/m4ri/xor_template.h
@@ -1,5 +1,5 @@
-#include <m4ri/m4ri_config.h>
-#include <m4ri/misc.h>
+#include <m4ri_config.h>
+#include <misc.h>
 
 /**
  * Compute c[i] += sum(t[j][i], 0 <= j < N) for 0 <= i < wide

diff --git a/puzzlesolver/puzzles/bishop.py b/puzzlesolver/puzzles/bishop.py
@@ -12,7 +12,8 @@ class Bishop(ServerPuzzle):
 	desc 	= """Swap the locations of two sets of bishops on opposite ends of a chessboard, without moving them into threatened positions."""
 	date 	= "October 30, 2020"
 	# Chessboard has y rows, 2x columns
-	variants = {str(i[0]) + "x" + str(i[1]): IndexSolver for i in ((2,5), (2,7), (3,7))}
+	variants = [str(i[0]) + "x" + str(i[1]) for i in ((2,5), (2,7), (3,7))]
+	variants_desc = variants
 	test_variants = {str(i[0]) + "x" + str(i[1]): IndexSolver for i in ((2,5), (2,7))}
 	startRandomized = False
 

diff --git a/puzzlesolver/puzzles/chairs.py b/puzzlesolver/puzzles/chairs.py
@@ -11,7 +11,8 @@ class Chairs(ServerPuzzle):
     desc    = """Move all pieces from one side of the board to the other by hopping over adjacent pieces. The end result should be a flipped version of the starting state."""
     date    = "April 25, 2020"
 
-    variants = {"10" : SqliteSolver}
+    variants = ["10"]
+    variants_desc = variants
     test_variants = variants
     startRandomized = False
 

diff --git a/puzzlesolver/puzzles/hanoi.py b/puzzlesolver/puzzles/hanoi.py
@@ -27,6 +27,8 @@ class Hanoi(ServerPuzzle):
     variants += ["4_1", "4_2", "4_3", "4_4", "4_5", "4_6"]
     variants += ["5_1", "5_2", "5_3", "5_4"]
 
+    variants_desc = variants
+
     test_variants = ["3_1", "3_2", "3_3"]
 
     startRandomized = False

diff --git a/puzzlesolver/puzzles/hopNdrop.py b/puzzlesolver/puzzles/hopNdrop.py
@@ -13,12 +13,8 @@ class HopNDrop(ServerPuzzle):
     desc    = """Clear all platforms before reaching the goal tile. Don't get stuck or fall!"""
     date    = "Oct 10, 2020"
 
-    variants = {
-        "map1" : SqliteSolver, 
-        "map2" : SqliteSolver, 
-        "map3" : SqliteSolver, 
-        # "map4" : SqliteSolver
-    }
+    variants = ["map1", "map2", "map3"]
+    variants_desc = variants
 
     test_variants = variants
 

diff --git a/puzzlesolver/puzzles/lightsout.py b/puzzlesolver/puzzles/lightsout.py
@@ -14,9 +14,11 @@ class LightsOut(ServerPuzzle):
         from ..extern import m4ri_utils
     except:
         variants = [str(i) for i in range(2, 6)]
+        variants_desc = ["{}x{}".format(i, i) for i in range(2, 6)]
         closed_form_variants = []
     else:
         variants = [str(i) for i in range(2, 9)]
+        variants_desc = ["{}x{}".format(i, i) for i in range(2, 9)]
         closed_form_variants = ['2', '3', '6', '7', '8']
     test_variants = [str(i) for i in range(2, 5)]
     startRandomized = True

diff --git a/puzzlesolver/puzzles/npuzzle.py b/puzzlesolver/puzzles/npuzzle.py
@@ -17,8 +17,9 @@ class Npuzzle(ServerPuzzle):
     desc    = "Shift pieces to get puzzle in ascending order."
     date    = "April 10, 2020"
 
-    variants = {str(i) : IndexSolver for i in range(2, 4)}
-    test_variants = {"2" : IndexSolver}
+    variants = [str(i) for i in range(2, 4)]
+    variants_desc = ["{}-puzzle".format(i * i - 1) for i in range(2, 4)]
+    test_variants = ["2"]
     startRandomized = True
 
     def __init__(self, size=3):

diff --git a/puzzlesolver/puzzles/nqueens.py b/puzzlesolver/puzzles/nqueens.py
@@ -14,6 +14,7 @@ class NQueens(ServerPuzzle):
     date = 'March 17, 2021'
 
     variants = ['4', '5']
+    variants_desc = ["4x4", "5x5"]
     test_variants = ['4']
     startRandomized = True
 

diff --git a/puzzlesolver/puzzles/pegSolitaire.py b/puzzlesolver/puzzles/pegSolitaire.py
@@ -18,7 +18,8 @@ class Peg(ServerPuzzle):
     desc    = """Jump over a peg with an adjacent peg, removing it from the board. Have one peg remaining by end of the game."""
     date    = "April 15, 2020"
 
-    variants = {"Triangle": SqliteSolver}
+    variants = ["Triangle"]
+    variants_desc = variants;
     test_variants = variants
     startRandomized = False
 

diff --git a/puzzlesolver/puzzles/rubiks.py b/puzzlesolver/puzzles/rubiks.py
@@ -22,7 +22,8 @@ class Rubiks(ServerPuzzle):
     desc    = """Solve the Rubiks cube by getting one color/number on each face using rotations.."""
     date    = "September 14th, 2020"
 
-    variants = {"2x2" : SqliteSolver}
+    variants = ["2x2"]
+    variants_desc = variants
     startRandomized = True
 
     def __init__(self, **kwargs):

diff --git a/puzzlesolver/puzzles/rushhour.py b/puzzlesolver/puzzles/rushhour.py
@@ -13,6 +13,7 @@ class RushHour(ServerPuzzle):
     date = "April 25, 2023"
 
     variants = ['basic', 'easy', 'medium', 'hard', 'expert']
+    variants_desc = variants
     # "True" would mean that the game would start at a random solvable board,
     # by looking at all solvable hashes -- hence False to ensure we fix a start position
     startRandomized = False

diff --git a/puzzlesolver/puzzles/topspin.py b/puzzlesolver/puzzles/topspin.py
@@ -11,7 +11,8 @@ class TopSpin(ServerPuzzle):
 	name 	      = "Top Spin"
 	desc 	      = "Move the beads along the track and spin the ones in the spinner until the beads are in order clock-wise, with 1 in the first spot in the spinner." 
 	date 	      = "Nov. 23, 2020"
-	variants      = {'6_2' : SqliteSolver}
+	variants      = ['6_2']
+	variants_desc = variants
 	test_variants = variants
 	startRandomized = True