Class Alg

Deprecated

Expands all Grouping, Commutator, and Conjugate parts nested inside the alg.

// F R U R' U' F'
new Alg("[F: [R, U]]").expand().log();

// F [R, U] F'
new Alg("[F: [R, U]]").expand(({ depth: 1 }).log();
Copy

Avoid calling this on a user-provided alg unless the user explicitly asks to see the expanded alg. Otherwise, it's easy to make your program freeze when someone passes in an alg like: (R U)10000000

Generally, if you want to perform an operation on an entire alg, you'll want to use something based on the Traversal mechanism, like countMoves() from cubing/notation.

Deprecated

Use Alg.expand instead.

Deprecated

Deprecated

Deprecated

experimentalSimplify can perform several mostly-syntactic simplifications on an alg:

// Logs: R' U3
import { Alg } from "cubing/alg";
new Alg("R R2' U U2").experimentalSimplify({ cancel: true }).log()
Copy

You can pass in a PuzzleLoader (currently only for 3x3x3) for puzzle-specific simplifications:

// Logs: R' U'
import { Alg } from "cubing/alg";
import { cube3x3x3 } from "cubing/puzzles";
new Alg("R R2' U U2").experimentalSimplify({ cancel: true, puzzleLoader: cube3x3x3 }).log()
Copy

You can also cancel only moves that are in the same direction:

// Logs: R R2' U'
import { Alg } from "cubing/alg";
import { cube3x3x3 } from "cubing/puzzles";
new Alg("R R2' U U2").experimentalSimplify({
  cancel: { directional: "same-direction" },
  puzzleLoader: cube3x3x3
}).log()
Copy

Additionally, you can specify how moves are "wrapped":

import { Alg } from "cubing/alg";
import { cube3x3x3 } from "cubing/puzzles";

function example(puzzleSpecificModWrap) {
  alg.experimentalSimplify({
    cancel: { puzzleSpecificModWrap },
    puzzleLoader: cube3x3x3
  }).log()
}

const alg = new Alg("R7' . R6' . R5' . R6")
example("none")               // R7' . R6' . R5' . R6
example("gravity")            // R . R2' . R' . R2
example("canonical-centered") // R . R2 . R' . R2
example("canonical-positive") // R . R2 . R3 . R2
example("preserve-sign")      // R3' . R2' . R' . R2
Copy

Same-axis and simultaneous move canonicalization is not implemented yet:

// Logs: R L R
import { Alg } from "cubing/alg";
import { cube3x3x3 } from "cubing/puzzles";
new Alg("R L R").experimentalSimplify({ cancel: true, puzzleLoader: cube3x3x3 }).log()
Copy

Returns the inverse of the given alg.

Note that that this does not make any assumptions about what puzzle the alg is for. For example, U2 is its own inverse on a cube, but U2' has the same effect U3 (and not U2) on Megaminx:

// Outputs: R U2' L'
new Alg("L U2 R'").invert().log();
Copy

Checks whether this Alg is structurally identical to another Alg. This essentially means that they are written identically apart from whitespace.

const alg1 = new Alg("R U L'");
const alg2 = new Alg("L U' R'").invert();
// true
alg1.isIdentical(alg2);

// false
new Alg("[R, U]").isIdentical(new Alg("R U R' U'"));
// true
new Alg("[R, U]").expand().isIdentical(new Alg("R U R' U'"));
Copy

Note that .isIdentical() efficiently compares algorithms, but mainly exists to help optimize code when the structure of an algorithm hasn't changed. There are many ways to write the "same" alg on most puzzles, but is highly recommended to avoid expanding two Alg instances to compare them, since that can easily slow your program to a crawl if someone inputs an alg containing a large repetition. In general, you should use cubing/kpuzzle to compare if two algs have the same effect on a puzzle.

Also note that parser annotations are not taken into account while comparing algs:

const alg = new Alg([new Move("R"), new Move("U2")]);
// true, even though one of the algs has parser annotations
alg.isIdentical(new Alg("R U2"))
Copy

Deprecated

See experimentalSimplify

Converts the Alg to a string:

const alg = new Alg([new Move("R"), new Move("U2"), new Move("L")])
// R U2 L
console.log(alg.toString())
Copy

Deprecated