Make randomization configurable

torjusti · Sep 10, 2023 · 3d5f575 · 3d5f575
1 parent 67ea14f
commit 3d5f575
Show file tree

Hide file tree

Showing 19 changed files with 57 additions and 31 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1,12 +1,16 @@
-type Scrambler = '3x3' | '2gll' | 'cmll' | 'corners' | 'edges' | 'lse' | 'lsll' | 'pll' | 'zbll' | 'zzls';
+export type Scrambler = '3x3' | '2gll' | 'cmll' | 'corners' | 'edges' | 'lse' | 'lsll' | 'pll' | 'zbll' | 'zzls';
 
-type Solver = 'kociemba' | 'cross' | 'eoline' | 'fb' | 'xcross';
+export type Solver = 'kociemba' | 'cross' | 'eoline' | 'fb' | 'xcross';
+
+export interface Settings {
+  randomize: boolean;
+}
 
 declare module 'cube-solver' {
   // Main method for generating scrambles.
-  export const scramble: (scrambler: Scrambler) => string;
+  export const scramble: (scrambler: Scrambler, settings: Setings) => string;
   // Solve specific subset of a given cube.
-  export const solve: (scramble: string, type: Solver) => string;
+  export const solve: (scramble: string, type: Solver, settings: Settings) => string;
   // Initialize given solver.
   export const initialize: (solver: Solver) => void;
 };
diff --git a/src/Search.js b/src/Search.js
@@ -50,7 +50,7 @@ class Search {
     };
   }
 
-  search(indexes, depth, lastMove, solution) {
+  search(indexes, depth, lastMove, solution, randomize) {
     let minimumDistance = 0;
 
     for (let i = 0; i < this.pruningTables.length; i += 1) {
@@ -111,10 +111,13 @@ class Search {
   solve(settings) {
     this.initialize();
 
-    this.settings = { maxDepth: 22, // For the Kociemba solver.
+    this.settings = { 
+      maxDepth: 22, // For the Kociemba solver.
       lastMove: null,
       format: true,
-      ...settings };
+      randomize: false,
+      ...settings,
+    };
 
     const indexes = this.settings.indexes || [];
 
@@ -139,7 +142,7 @@ class Search {
     }
 
     for (let depth = 0; depth <= this.settings.maxDepth; depth += 1) {
-      const solution = this.search(indexes, depth, this.settings.lastMove, []);
+      const solution = this.search(indexes, depth, this.settings.lastMove, [], this.settings.randomize);
 
       if (solution) {
         if (this.settings.format) {

diff --git a/src/index.js b/src/index.js
@@ -15,7 +15,7 @@ import getZBLLScramble from './scramblers/zbll';
 import getZZLSScramble from './scramblers/zzls';
 
 export default {
-  solve: (scramble, solver = 'kociemba') => {
+  solve: (scramble, solver = 'kociemba', settings) => {
     const solvers = {
       kociemba,
       cross: crossSolver,
@@ -25,7 +25,7 @@ export default {
     };
 
     if (solvers[solver]) {
-      return solvers[solver](scramble);
+      return solvers[solver](scramble, settings);
     }
 
     throw new Error('Specified solver does not exist.');
@@ -46,7 +46,7 @@ export default {
     };
 
     if (scramblers[scrambler]) {
-      return scramblers[scrambler]();
+      return scramblers[scrambler](settings);
     }
 
     throw new Error('Specified scrambler does not exist.');

diff --git a/src/scramblers/2gll.js b/src/scramblers/2gll.js
@@ -1,7 +1,9 @@
 import getScrambleForPieces from './scramblePieces';
 import { Edges, Corners } from '../cube';
 
-const getScramble = () => getScrambleForPieces(
+const getScramble = (settings) => getScrambleForPieces(
+  settings,
+
   [Edges.UR, Edges.UF, Edges.UL, Edges.UB],
 
   [],

diff --git a/src/scramblers/3x3.js b/src/scramblers/3x3.js
@@ -15,7 +15,7 @@ import { solveCoordinates } from '../solvers/kociemba';
  * of the cube. This guarantees valid orientations, but we have to
  * ensure the parity of the generated cube is valid.
  */
-const getRandomScramble = () => {
+const getRandomScramble = (settings) => {
   let eo;
   let ep;
   let co;
@@ -39,7 +39,7 @@ const getRandomScramble = () => {
     );
   } while (getParity(ep) !== getParity(cp));
 
-  return solveCoordinates(eo, ep, co, cp);
+  return solveCoordinates(eo, ep, co, cp, settings);
 };
 
 export default getRandomScramble;
diff --git a/src/scramblers/cmll.js b/src/scramblers/cmll.js
@@ -1,7 +1,9 @@
 import getScrambleForPieces from './scramblePieces';
 import { Edges, Corners } from '../cube';
 
-const getScramble = () => getScrambleForPieces(
+const getScramble = (settings) => getScrambleForPieces(
+  settings,
+
   [Edges.UR, Edges.UF, Edges.UL, Edges.UB, Edges.DF, Edges.DB],
 
   [Corners.URF, Corners.UFL, Corners.ULB, Corners.UBR],

diff --git a/src/scramblers/corners.js b/src/scramblers/corners.js
@@ -1,6 +1,8 @@
 import getScrambleForPieces from './scramblePieces';
 
 const getScramble = () => getScrambleForPieces(
+  settings,
+
   [],
 
   [0, 1, 2, 3, 4, 5, 6, 7],

diff --git a/src/scramblers/edges.js b/src/scramblers/edges.js
@@ -1,6 +1,8 @@
 import getScrambleForPieces from './scramblePieces';
 
-const getScramble = () => getScrambleForPieces(
+const getScramble = (settings) => getScrambleForPieces(
+  settings,
+
   [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11],
 
   [],

diff --git a/src/scramblers/lse.js b/src/scramblers/lse.js
@@ -3,7 +3,9 @@ import { Edges } from '../cube';
 
 const LSE_EDGES = [Edges.UR, Edges.UF, Edges.UL, Edges.UB, Edges.DF, Edges.DB];
 
-const getScramble = () => getScrambleForPieces(
+const getScramble = (settings) => getScrambleForPieces(
+  settings,
+
   LSE_EDGES,
 
   [],

diff --git a/src/scramblers/lsll.js b/src/scramblers/lsll.js
@@ -1,7 +1,9 @@
 import getScrambleForPieces from './scramblePieces';
 import { Edges, Corners } from '../cube';
 
-const getScramble = () => getScrambleForPieces(
+const getScramble = (settings) => getScrambleForPieces(
+  settings,
+
   [Edges.UR, Edges.UF, Edges.UL, Edges.UB, Edges.FR],
 
   [Corners.URF, Corners.UFL, Corners.ULB, Corners.UBR, Corners.DFR],

diff --git a/src/scramblers/pll.js b/src/scramblers/pll.js
@@ -1,7 +1,9 @@
 import getScrambleForPieces from './scramblePieces';
 import { Edges, Corners } from '../cube';
 
-const getScramble = () => getScrambleForPieces(
+const getScramble = (settings) => getScrambleForPieces(
+  settings,
+
   [Edges.UR, Edges.UF, Edges.UL, Edges.UB],
 
   [Corners.URF, Corners.UFL, Corners.ULB, Corners.UBR],

diff --git a/src/scramblers/scramblePieces.js b/src/scramblers/scramblePieces.js
@@ -65,6 +65,7 @@ export const adjustUpperFace = (pieces, amount) => {
  * for the provided edges and corners, which will be scrambled randomly.
  */
 export const getScrambleForPieces = (
+  settings,
   permutationEdges,
   permutationCorners,
   orientationEdges = permutationEdges,
@@ -95,7 +96,7 @@ export const getScrambleForPieces = (
     }
   } while (getParity(ep) !== getParity(cp));
 
-  return solveCoordinates(eo, ep, co, cp);
+  return solveCoordinates(eo, ep, co, cp, settings);
 };
 
 export default getScrambleForPieces;
diff --git a/src/scramblers/zbll.js b/src/scramblers/zbll.js
@@ -5,7 +5,9 @@ const EDGES = [Edges.UR, Edges.UF, Edges.UL, Edges.UB];
 
 const CORNERS = [Corners.URF, Corners.UFL, Corners.ULB, Corners.UBR];
 
-const getScramble = () => getScrambleForPieces(
+const getScramble = (settings) => getScrambleForPieces(
+  settings,
+
   EDGES,
 
   CORNERS,

diff --git a/src/scramblers/zzls.js b/src/scramblers/zzls.js
@@ -9,7 +9,9 @@ const CORNERS = [
   Corners.DFR,
 ];
 
-const getScramble = () => getScrambleForPieces(
+const getScramble = (settings) => getScrambleForPieces(
+  settings,
+
   [Edges.UR, Edges.UF, Edges.UL, Edges.UB, Edges.FR],
 
   CORNERS,

diff --git a/src/solvers/EOLineSolver.js b/src/solvers/EOLineSolver.js
@@ -21,6 +21,6 @@ export const EOLineSearch = new Search(() => ({
   pruningTables: [['EdgeOrientation'], ['EdgePermutation']],
 }));
 
-const EOLineSolver = (scramble) => EOLineSearch.solve({ scramble });
+const EOLineSolver = (scramble, settings) => EOLineSearch.solve({ scramble, ...settings });
 
 export default EOLineSolver;
diff --git a/src/solvers/XCrossSolver.js b/src/solvers/XCrossSolver.js
@@ -36,6 +36,6 @@ export const XCrossSearch = new Search(() => ({
   ],
 }));
 
-const XCrossSolver = (scramble) => XCrossSearch.solve({ scramble });
+const XCrossSolver = (scramble, settings) => XCrossSearch.solve({ scramble, settings });
 
 export default XCrossSolver;
diff --git a/src/solvers/crossSolver.js b/src/solvers/crossSolver.js
@@ -21,6 +21,6 @@ export const CrossSearch = new Search(() => ({
   pruningTables: [['EdgePermutation'], ['EdgeOrientation']],
 }));
 
-const crossSolver = (scramble) => CrossSearch.solve({ scramble });
+const crossSolver = (scramble, settings) => CrossSearch.solve({ scramble, ...settings });
 
 export default crossSolver;
diff --git a/src/solvers/firstBlockSolver.js b/src/solvers/firstBlockSolver.js
@@ -37,6 +37,6 @@ export const FirstBlockSearch = new Search(() => ({
   ],
 }));
 
-const firstBlockSolver = (scramble) => FirstBlockSearch.solve({ scramble });
+const firstBlockSolver = (scramble, settings) => FirstBlockSearch.solve({ scramble, ...settings });
 
 export default firstBlockSolver;
diff --git a/src/solvers/kociemba.js b/src/solvers/kociemba.js
@@ -229,23 +229,23 @@ class PhaseOneSearch extends Search {
 
 export const phaseOne = new PhaseOneSearch(phaseOneTables);
 
-const kociemba = (scramble, maxDepth = 22) => {
+const kociemba = (scramble, settings) => {
   if (Array.isArray(scramble)) {
     return phaseOne.solve({
       indexes: scramble,
-      maxDepth,
+      ...settings,
     });
   }
 
   return phaseOne.solve({
     scramble,
-    maxDepth,
+    ...settings
   });
 };
 
 export default kociemba;
 
-export const solveCoordinates = (eo, ep, co, cp) => kociemba([
+export const solveCoordinates = (eo, ep, co, cp, settings) => kociemba([
   Math.floor(getIndexFromPermutation(ep, [8, 9, 10, 11], true) / 24),
   getIndexFromOrientation(co, 3),
   getIndexFromOrientation(eo, 2),
@@ -254,4 +254,4 @@ export const solveCoordinates = (eo, ep, co, cp) => kociemba([
   getIndexFromPermutation(cp, [0, 1, 2, 3, 4, 5]),
   getIndexFromPermutation(ep, [0, 1, 2]),
   getIndexFromPermutation(ep, [3, 4, 5]),
-]);
+], settings);