cubing 0.23.0 → 0.24.0-pre1

package/src/cubing/alg/units/containers/Commutator.ts

@@ -1,85 +0,0 @@
-import { Alg, experimentalEnsureAlg, FlexibleAlgSource } from "../../Alg";
-import { AlgCommon, Comparable } from "../../common";
-import { IterationDirection } from "../../iteration";
-import type { LeafUnit } from "../Unit";
-
-export class Commutator extends AlgCommon<Commutator> {
-  readonly #A: Alg;
-  readonly #B: Alg;
-
-  constructor(aSource: FlexibleAlgSource, bSource: FlexibleAlgSource) {
-    super();
-    this.#A = experimentalEnsureAlg(aSource);
-    this.#B = experimentalEnsureAlg(bSource);
-  }
-
-  get A(): Alg {
-    return this.#A;
-  }
-
-  get B(): Alg {
-    return this.#B;
-  }
-
-  isIdentical(other: Comparable): boolean {
-    const otherAsCommutator = other.as(Commutator);
-    return !!(
-      otherAsCommutator?.A.isIdentical(this.A) &&
-      otherAsCommutator?.B.isIdentical(this.B)
-    );
-  }
-
-  invert(): Commutator {
-    return new Commutator(this.#B, this.#A);
-  }
-
-  *experimentalExpand(
-    iterDir: IterationDirection = IterationDirection.Forwards,
-    depth?: number,
-  ): Generator<LeafUnit> {
-    depth ??= Infinity;
-    if (depth === 0) {
-      yield iterDir === IterationDirection.Forwards ? this : this.invert();
-    } else {
-      if (iterDir === IterationDirection.Forwards) {
-        yield* this.A.experimentalExpand(
-          IterationDirection.Forwards,
-          depth - 1,
-        );
-        yield* this.B.experimentalExpand(
-          IterationDirection.Forwards,
-          depth - 1,
-        );
-        yield* this.A.experimentalExpand(
-          IterationDirection.Backwards,
-          depth - 1,
-        );
-        yield* this.B.experimentalExpand(
-          IterationDirection.Backwards,
-          depth - 1,
-        );
-      } else {
-        yield* this.B.experimentalExpand(
-          IterationDirection.Forwards,
-          depth - 1,
-        );
-        yield* this.A.experimentalExpand(
-          IterationDirection.Forwards,
-          depth - 1,
-        );
-        yield* this.B.experimentalExpand(
-          IterationDirection.Backwards,
-          depth - 1,
-        );
-        yield* this.A.experimentalExpand(
-          IterationDirection.Backwards,
-          depth - 1,
-        );
-      }
-    }
-  }
-
-  toString(): string {
-    return `[${this.#A.toString()}, ${this.#B.toString()}]`;
-  }
-}

package/src/cubing/alg/units/containers/Conjugate.ts

@@ -1,53 +0,0 @@
-import { Alg, experimentalEnsureAlg, FlexibleAlgSource } from "../../Alg";
-import { AlgCommon, Comparable } from "../../common";
-import { IterationDirection } from "../../iteration";
-import type { LeafUnit } from "../Unit";
-
-export class Conjugate extends AlgCommon<Conjugate> {
-  readonly #A: Alg;
-  readonly #B: Alg;
-
-  constructor(aSource: FlexibleAlgSource, bSource: FlexibleAlgSource) {
-    super();
-    this.#A = experimentalEnsureAlg(aSource);
-    this.#B = experimentalEnsureAlg(bSource);
-  }
-
-  get A(): Alg {
-    return this.#A;
-  }
-
-  get B(): Alg {
-    return this.#B;
-  }
-
-  isIdentical(other: Comparable): boolean {
-    const otherAsConjugate = other.as(Conjugate);
-    return !!(
-      otherAsConjugate?.A.isIdentical(this.A) &&
-      otherAsConjugate?.B.isIdentical(this.B)
-    );
-  }
-
-  invert(): Conjugate {
-    return new Conjugate(this.#A, this.#B.invert());
-  }
-
-  *experimentalExpand(
-    iterDir: IterationDirection,
-    depth?: number,
-  ): Generator<LeafUnit> {
-    depth ??= Infinity;
-    if (depth === 0) {
-      yield iterDir === IterationDirection.Forwards ? this : this.invert();
-    } else {
-      yield* this.A.experimentalExpand(IterationDirection.Forwards, depth - 1);
-      yield* this.B.experimentalExpand(iterDir, depth - 1);
-      yield* this.A.experimentalExpand(IterationDirection.Backwards, depth - 1);
-    }
-  }
-
-  toString(): string {
-    return `[${this.A}: ${this.B}]`;
-  }
-}

package/src/cubing/alg/units/containers/Grouping.ts

@@ -1,116 +0,0 @@
-import { Alg, experimentalEnsureAlg, FlexibleAlgSource } from "../../Alg";
-import { AlgCommon, Comparable } from "../../common";
-import { IterationDirection } from "../../iteration";
-import { Move, QuantumMove } from "../leaves/Move";
-import { QuantumWithAmount } from "../QuantumWithAmount";
-import type { LeafUnit } from "../Unit";
-
-// This is a workaround for `jest`, which doesn't handle cycles of imports inside `cubing/alg`.
-// We need to lazy-initialize the reusable quantum moves for Square-1, so we create this wrapper for it.
-class Square1TupleFormatter {
-  quantumU_SQ_: QuantumMove | null = null;
-  quantumD_SQ_: QuantumMove | null = null;
-
-  format(grouping: Grouping): string | null {
-    const amounts = this.tuple(grouping);
-    if (!amounts) {
-      return null;
-    }
-    return `(${amounts.map((move) => move.amount).join(", ")})`;
-  }
-
-  tuple(grouping: Grouping): [moveU: Move, moveD: Move] | null {
-    this.quantumU_SQ_ ||= new QuantumMove("U_SQ_");
-    this.quantumD_SQ_ ||= new QuantumMove("D_SQ_");
-
-    const quantumAlg = grouping.alg;
-    if (quantumAlg.experimentalNumUnits() === 2) {
-      const [U, D] = quantumAlg.units();
-      if (
-        U.as(Move)?.quantum.isIdentical(this.quantumU_SQ_) &&
-        D.as(Move)?.quantum.isIdentical(this.quantumD_SQ_)
-      ) {
-        if (grouping.amount !== 1) {
-          throw new Error(
-            "Square-1 tuples cannot have an amount other than 1.",
-          );
-        }
-        return [U as Move, D as Move]; // TODO: can we reuse the casting from above?
-      }
-    }
-    return null;
-  }
-}
-const square1TupleFormatterInstance = new Square1TupleFormatter();
-
-export class Grouping extends AlgCommon<Grouping> {
-  readonly #quantumWithAmount: QuantumWithAmount<Alg>;
-
-  constructor(algSource: FlexibleAlgSource, amount?: number) {
-    super();
-    const alg = experimentalEnsureAlg(algSource);
-    this.#quantumWithAmount = new QuantumWithAmount(alg, amount);
-  }
-
-  isIdentical(other: Comparable): boolean {
-    const otherAsGrouping = other as Grouping;
-    return (
-      other.is(Grouping) &&
-      this.#quantumWithAmount.isIdentical(otherAsGrouping.#quantumWithAmount)
-    );
-  }
-
-  get alg(): Alg {
-    return this.#quantumWithAmount.quantum;
-  }
-
-  get amount(): number {
-    return this.#quantumWithAmount.amount;
-  }
-
-  /** @deprecated */
-  get experimentalRepetitionSuffix(): string {
-    return this.#quantumWithAmount.suffix();
-  }
-
-  invert(): Grouping {
-    return new Grouping(
-      this.#quantumWithAmount.quantum,
-      -this.#quantumWithAmount.amount,
-    );
-  }
-
-  *experimentalExpand(
-    iterDir: IterationDirection = IterationDirection.Forwards,
-    depth?: number,
-  ): Generator<LeafUnit> {
-    depth ??= Infinity;
-    if (depth === 0) {
-      yield iterDir === IterationDirection.Forwards ? this : this.invert();
-    } else {
-      yield* this.#quantumWithAmount.experimentalExpand(iterDir, depth - 1);
-    }
-  }
-
-  static fromString(): Grouping {
-    throw new Error("unimplemented");
-  }
-
-  toString(): string {
-    return (
-      square1TupleFormatterInstance.format(this) ??
-      `(${this.#quantumWithAmount.quantum.toString()})${this.#quantumWithAmount.suffix()}`
-    );
-  }
-
-  experimentalAsSquare1Tuple(): [moveU: Move, moveD: Move] | null {
-    return square1TupleFormatterInstance.tuple(this);
-  }
-
-  // toJSON(): GroupingJSON {
-  //   return {
-  //     type: "grouping",
-  //     alg: this.#quanta.quantum.toJSON(),
-  //   };
-  // }
-}

package/src/cubing/alg/units/index.ts

@@ -1,8 +0,0 @@
-export { Grouping } from "./containers/Grouping";
-export { LineComment } from "./leaves/LineComment";
-export { Commutator } from "./containers/Commutator";
-export { Conjugate } from "./containers/Conjugate";
-export { Move, QuantumMove } from "./leaves/Move";
-export { Newline } from "./leaves/Newline";
-export { Pause } from "./leaves/Pause";
-export type { Unit } from "./Unit";

package/src/cubing/alg/units/leaves/LineComment.spec.ts

@@ -1,35 +0,0 @@
-import { LineComment } from "./LineComment";
-
-describe("LineComment", () => {
-  const expectedErrorMessage = "LineComment cannot contain newline";
-
-  it("throws an error when a newline is provided in the input", () => {
-    expect(
-      () => new LineComment("This is a comment \n with a newline"),
-    ).toThrow(expectedErrorMessage);
-    expect(() => new LineComment("A newline character \r")).toThrow(
-      expectedErrorMessage,
-    );
-  });
-
-  it("does not throw an error when emojis are provided in the input", () => {
-    expect(
-      () => new LineComment("This string contains emojis 😀 😅"),
-    ).not.toThrow(expectedErrorMessage);
-  });
-
-  it("does not throw an error when text characters are provided in the input", () => {
-    expect(
-      () =>
-        new LineComment(
-          "This is just a bunch of text characters in a comment.",
-        ),
-    ).not.toThrow(expectedErrorMessage);
-  });
-
-  it("does not throw an error when special characters are provided in the input", () => {
-    expect(() => new LineComment("Th!s cont@in$ $pec!@l ch@r$")).not.toThrow(
-      expectedErrorMessage,
-    );
-  });
-});

package/src/cubing/alg/units/leaves/LineComment.ts

@@ -1,48 +0,0 @@
-import { AlgCommon, Comparable } from "../../common";
-import { IterationDirection } from "../../iteration";
-import type { LeafUnit } from "../Unit";
-
-// TODO: hash
-// TODO: this conflicts with the HTML `LineComment` class
-export class LineComment extends AlgCommon<LineComment> {
-  readonly #text: string;
-
-  constructor(commentText: string) {
-    super();
-    if (commentText.includes("\n") || commentText.includes("\r")) {
-      throw new Error("LineComment cannot contain newline");
-    }
-    this.#text = commentText;
-  }
-
-  get text(): string {
-    return this.#text;
-  }
-
-  isIdentical(other: Comparable): boolean {
-    const otherAsLineComment = other as LineComment;
-    return other.is(LineComment) && this.#text === otherAsLineComment.#text;
-  }
-
-  invert(): LineComment {
-    return this;
-  }
-
-  *experimentalExpand(
-    _iterDir: IterationDirection = IterationDirection.Forwards,
-    _depth: number = Infinity,
-  ): Generator<LeafUnit> {
-    yield this;
-  }
-
-  toString(): string {
-    return `//${this.#text}`;
-  }
-
-  // toJSON(): LineCommentJSON {
-  //   return {
-  //     type: "comment",
-  //     text: this.#text,
-  //   };
-  // }
-}

package/src/cubing/alg/units/leaves/Move.spec.ts

@@ -1,15 +0,0 @@
-import { Move } from "./Move";
-
-describe("Move", () => {
-  it("can be modified", () => {
-    expect(new Move("R").modified({ amount: 2 }).toString()).toBe("R2");
-    expect(
-      new Move("4r", 3)
-        .modified({
-          family: "u",
-          outerLayer: 2,
-        })
-        .toString(),
-    ).toBe("2-4u3");
-  });
-});

package/src/cubing/alg/units/leaves/Move.ts

@@ -1,265 +0,0 @@
-import { AlgCommon, Comparable } from "../../common";
-import { IterationDirection } from "../../iteration";
-import { MAX_INT, MAX_INT_DESCRIPTION } from "../../limits";
-import { parseMove, parseQuantumMove, transferCharIndex } from "../../parse";
-import { warnOnce } from "../../warnOnce";
-import { QuantumWithAmount } from "../QuantumWithAmount";
-import type { LeafUnit } from "../Unit";
-
-interface QuantumMoveModifications {
-  outerLayer?: number;
-  innerLayer?: number;
-  family?: string;
-}
-
-export class QuantumMove extends Comparable {
-  readonly #family: string;
-  readonly #innerLayer: number | null;
-  readonly #outerLayer: number | null;
-
-  constructor(
-    family: string,
-    innerLayer?: number | null,
-    outerLayer?: number | null,
-  ) {
-    super();
-    this.#family = family;
-    this.#innerLayer = innerLayer ?? null;
-    this.#outerLayer = outerLayer ?? null;
-    Object.freeze(this);
-
-    if (
-      this.#innerLayer !== null &&
-      (!Number.isInteger(this.#innerLayer) ||
-        this.#innerLayer < 1 ||
-        this.#innerLayer > MAX_INT)
-    ) {
-      throw new Error(
-        `QuantumMove inner layer must be a positive integer below ${MAX_INT_DESCRIPTION}.`,
-      );
-    }
-
-    if (
-      this.#outerLayer !== null &&
-      (!Number.isInteger(this.#outerLayer) ||
-        this.#outerLayer < 1 ||
-        this.#outerLayer > MAX_INT)
-    ) {
-      throw new Error(
-        `QuantumMove outer layer must be a positive integer below ${MAX_INT_DESCRIPTION}.`,
-      );
-    }
-
-    if (
-      this.#outerLayer !== null &&
-      this.#innerLayer !== null &&
-      this.#innerLayer <= this.#outerLayer
-    ) {
-      throw new Error(
-        "QuantumMove outer layer must be smaller than inner layer.",
-      );
-    }
-
-    if (this.#outerLayer !== null && this.#innerLayer === null) {
-      throw new Error(
-        "QuantumMove with an outer layer must have an inner layer",
-      ); // TODO: test
-    }
-  }
-
-  static fromString(s: string): QuantumMove {
-    return parseQuantumMove(s);
-  }
-
-  // TODO: `modify`?
-  modified(modifications: QuantumMoveModifications): QuantumMove {
-    return new QuantumMove(
-      modifications.family ?? this.#family,
-      modifications.innerLayer ?? this.#innerLayer,
-      modifications.outerLayer ?? this.#outerLayer,
-    );
-  }
-
-  isIdentical(other: QuantumMove): boolean {
-    const otherAsQuantumMove = other;
-    return (
-      other.is(QuantumMove) &&
-      this.#family === otherAsQuantumMove.#family &&
-      this.#innerLayer === otherAsQuantumMove.#innerLayer &&
-      this.#outerLayer === otherAsQuantumMove.#outerLayer
-    );
-  }
-
-  // TODO: provide something more useful on average.
-  /** @deprecated */
-  get family(): string {
-    return this.#family;
-  }
-
-  // TODO: provide something more useful on average.
-  /** @deprecated */
-  get outerLayer(): number | null {
-    return this.#outerLayer;
-  }
-
-  // TODO: provide something more useful on average.
-  /** @deprecated */
-  get innerLayer(): number | null {
-    return this.#innerLayer;
-  }
-
-  experimentalExpand(): Generator<LeafUnit> {
-    throw new Error(
-      "experimentalExpand() cannot be called on a `QuantumMove` directly.",
-    );
-  }
-
-  toString(): string {
-    let s = this.#family;
-    if (this.#innerLayer !== null) {
-      s = String(this.#innerLayer) + s;
-      if (this.#outerLayer !== null) {
-        s = String(this.#outerLayer) + "-" + s;
-      }
-    }
-    return s;
-  }
-}
-
-export interface MoveModifications {
-  outerLayer?: number;
-  innerLayer?: number;
-  family?: string;
-  amount?: number;
-}
-
-export class Move extends AlgCommon<Move> {
-  readonly #quantumWithAmount: QuantumWithAmount<QuantumMove>;
-
-  constructor(
-    ...args: [QuantumMove] | [QuantumMove, number] | [string] | [string, number]
-  ) {
-    super();
-    if (typeof args[0] === "string") {
-      if (args[1] ?? null) {
-        this.#quantumWithAmount = new QuantumWithAmount(
-          QuantumMove.fromString(args[0]),
-          args[1],
-        );
-        return;
-      } else {
-        return Move.fromString(args[0]); // TODO: can we return here?
-      }
-    }
-    this.#quantumWithAmount = new QuantumWithAmount<QuantumMove>(
-      args[0],
-      args[1],
-    );
-  }
-
-  isIdentical(other: Comparable): boolean {
-    const otherAsMove = other.as(Move);
-    return (
-      !!otherAsMove &&
-      this.#quantumWithAmount.isIdentical(otherAsMove.#quantumWithAmount)
-    );
-  }
-
-  invert(): Move {
-    // TODO: handle char indices more consistently among units.
-    return transferCharIndex(
-      this,
-      new Move(this.#quantumWithAmount.quantum, -this.amount),
-    );
-  }
-
-  *experimentalExpand(
-    iterDir: IterationDirection = IterationDirection.Forwards,
-  ): Generator<LeafUnit> {
-    if (iterDir === IterationDirection.Forwards) {
-      yield this;
-    } else {
-      yield this.modified({
-        amount: -this.amount,
-      });
-    }
-  }
-
-  get quantum(): QuantumMove {
-    return this.#quantumWithAmount.quantum;
-  }
-
-  // TODO: `modify`?
-  modified(modifications: MoveModifications): Move {
-    // TODO: Avoid creating a new quantum move
-    return new Move(
-      this.#quantumWithAmount.quantum.modified(modifications),
-      modifications.amount ?? this.amount,
-    );
-  }
-
-  static fromString(s: string): Move {
-    return parseMove(s);
-  }
-
-  get amount(): number {
-    return this.#quantumWithAmount.amount;
-  }
-
-  /** @deprecated */
-  get type(): string {
-    warnOnce("deprecated: type");
-    return "blockMove";
-  }
-
-  /** @deprecated */
-  get family(): string {
-    return this.#quantumWithAmount.quantum.family ?? undefined;
-  }
-
-  /** @deprecated */
-  get outerLayer(): number | undefined {
-    return this.#quantumWithAmount.quantum.outerLayer ?? undefined;
-  }
-
-  /** @deprecated */
-  get innerLayer(): number | undefined {
-    return this.#quantumWithAmount.quantum.innerLayer ?? undefined;
-  }
-
-  toString(): string {
-    if (this.family === "_SLASH_") {
-      return "/"; // TODO: validate no amount
-    }
-    if (this.family.endsWith("_PLUS_")) {
-      return (
-        this.#quantumWithAmount.quantum.toString().slice(0, -6) +
-        Math.abs(this.amount) +
-        (this.amount < 0 ? "-" : "+")
-      ); // TODO
-    }
-    if (this.family.endsWith("_PLUSPLUS_")) {
-      const absAmount = Math.abs(this.amount);
-      return (
-        this.#quantumWithAmount.quantum.toString().slice(0, -10) +
-        (absAmount === 1 ? "" : absAmount) +
-        (this.amount < 0 ? "--" : "++")
-      ); // TODO
-    }
-
-    return (
-      this.#quantumWithAmount.quantum.toString() +
-      this.#quantumWithAmount.suffix()
-    );
-  }
-
-  // // TODO: Serialize as a string?
-  // toJSON(): MoveJSON {
-  //   return {
-  //     type: "move",
-  //     family: this.family,
-  //     innerLayer: this.innerLayer,
-  //     outerLayer: this.outerLayer,
-  //   };
-  // }
-}

package/src/cubing/alg/units/leaves/Newline.ts

@@ -1,24 +0,0 @@
-import { AlgCommon, Comparable } from "../../common";
-import { IterationDirection } from "../../iteration";
-import type { LeafUnit } from "../Unit";
-
-export class Newline extends AlgCommon<Newline> {
-  toString(): string {
-    return `\n`;
-  }
-
-  isIdentical(other: Comparable): boolean {
-    return other.is(Newline);
-  }
-
-  invert(): Newline {
-    return this;
-  }
-
-  *experimentalExpand(
-    _iterDir: IterationDirection = IterationDirection.Forwards,
-    _depth: number = Infinity,
-  ): Generator<LeafUnit> {
-    yield this;
-  }
-}

package/src/cubing/alg/units/leaves/Pause.ts

@@ -1,24 +0,0 @@
-import { AlgCommon, Comparable } from "../../common";
-import { IterationDirection } from "../../iteration";
-import type { LeafUnit } from "../Unit";
-
-export class Pause extends AlgCommon<Pause> {
-  toString(): string {
-    return `.`;
-  }
-
-  isIdentical(other: Comparable): boolean {
-    return other.is(Pause);
-  }
-
-  invert(): Pause {
-    return this;
-  }
-
-  *experimentalExpand(
-    _iterDir: IterationDirection = IterationDirection.Forwards,
-    _depth: number = Infinity,
-  ): Generator<LeafUnit> {
-    yield this;
-  }
-}

package/src/cubing/alg/url.spec.ts

@@ -1,10 +0,0 @@
-import { Alg } from "./Alg";
-import { algCubingNetLink } from "./url";
-
-describe("algCubingNetLink", () => {
-  it("algCubingNetLink to generate proper URLs", () => {
-    expect(algCubingNetLink({ alg: Alg.fromString("R U R'") })).toEqual(
-      "https://alg.cubing.net/?alg=R_U_R-",
-    );
-  });
-});