@turing-machine-js/machine 2.0.2 → 3.0.1

package/dist/utilities/equivalence.d.ts

@@ -0,0 +1,31 @@
+import State from '../classes/State';
+import TapeBlock from '../classes/TapeBlock';
+export type Runnable = {
+    state: State;
+    getTapeBlock: () => TapeBlock;
+};
+export type EquivalenceCase = string | {
+    reference: string;
+    candidate: string;
+};
+export type EquivalenceResult = {
+    case: {
+        reference: string;
+        candidate: string;
+    };
+    agree: boolean;
+    referenceOutput: string;
+    candidateOutput: string;
+    referenceSteps: number;
+    candidateSteps: number;
+    firstDivergenceStep: number | null;
+};
+export type EquivalenceReport = {
+    results: EquivalenceResult[];
+    allAgree: boolean;
+};
+export declare function equivalentOn(reference: Runnable, candidate: Runnable, cases: EquivalenceCase[], options?: {
+    compareOutputs?: (refOutput: string, candOutput: string) => boolean;
+    compareSnapshots?: ((refSnap: string, candSnap: string) => boolean) | null;
+    stepsLimit?: number;
+}): EquivalenceReport;

package/dist/utilities/graph.d.ts

@@ -0,0 +1,29 @@
+export type GraphCommand = {
+    symbol: string;
+    movement: string;
+};
+export type GraphTransition = {
+    pattern: string;
+    command: GraphCommand[];
+    nextStateId: number;
+};
+export type GraphNode = {
+    id: number;
+    name: string;
+    isHalt: boolean;
+    transitions: GraphTransition[];
+    overrodeHaltStateId: number | null;
+};
+export type Graph = {
+    initialId: number;
+    alphabets: string[][];
+    nodes: Record<number, GraphNode>;
+};
+export declare function decodePatternDescription(description: string | undefined, alphabets: string[][]): string;
+export declare function decodeMovement(description: string | undefined): string;
+export type ParsedPattern = null | (string | null)[][];
+export declare function splitUnescaped(s: string, sep: string): string[];
+export declare function parsePatternString(s: string, alphabets: string[][]): ParsedPattern;
+export declare function parseMovementLabel(label: string): symbol;
+export declare function parseWriteSymbolLabel(label: string): string | symbol;
+export declare function decodeWriteSymbol(symbol: string | symbol): string;

package/dist/utilities/graphFormats.d.ts

@@ -0,0 +1,3 @@
+import { type Graph } from './graph';
+export declare function toMermaid(graph: Graph): string;
+export declare function fromMermaid(text: string): Graph;

package/dist/utilities/introspection.d.ts

@@ -0,0 +1,15 @@
+import State from '../classes/State';
+import TapeBlock from '../classes/TapeBlock';
+import { type Graph } from './graph';
+export type GraphSummary = {
+    stateCount: number;
+    transitionCount: number;
+    compositionEdgeCount: number;
+    maxCompositionDepth: number;
+    selfLoopCount: number;
+    hasCycles: boolean;
+    tapeCount: number;
+    alphabetCardinalities: number[];
+};
+export declare function summarizeGraph(graph: Graph): GraphSummary;
+export declare function summarize(state: State, tapeBlock: TapeBlock): GraphSummary;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turing-machine-js/machine",
-  "version": "2.0.2",
+  "version": "3.0.1",
   "description": "A convenient Turing machine",
   "engines": {
     "npm": ">=7.0.0"
@@ -32,13 +32,7 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs",
       "default": "./dist/index.mjs"
-    },
-    "./src": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs",
-      "default": "./dist/index.mjs"
     }
   },
-  "gitHead": "54da1870a45fd78496c6ba56ce1de728d766470b"
+  "gitHead": "0a8d7ff87a3a73ea7ee1844f7f4602cbb23d20fe"
 }

package/dist/classes/Alphabet.js

@@ -1,50 +0,0 @@
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _Alphabet_symbols;
-import { uniquePredicate } from '../utilities/functions';
-class Alphabet {
-    constructor(symbols) {
-        _Alphabet_symbols.set(this, void 0);
-        if (symbols instanceof Alphabet) {
-            symbols = symbols.symbols;
-        }
-        const uniqueSymbols = symbols.filter(uniquePredicate);
-        if (uniqueSymbols.length < 2) {
-            throw new Error('Invalid symbols length');
-        }
-        const isSymbolsValid = uniqueSymbols.every((symbol) => symbol.length === 1);
-        if (!isSymbolsValid) {
-            throw new Error('symbols contains invalid symbol');
-        }
-        __classPrivateFieldSet(this, _Alphabet_symbols, Array.from(uniqueSymbols), "f");
-    }
-    get symbols() {
-        return Array.from(__classPrivateFieldGet(this, _Alphabet_symbols, "f"));
-    }
-    get blankSymbol() {
-        return __classPrivateFieldGet(this, _Alphabet_symbols, "f")[0];
-    }
-    has(symbol) {
-        return __classPrivateFieldGet(this, _Alphabet_symbols, "f").indexOf(symbol) >= 0;
-    }
-    get(index) {
-        if (index < 0 || index >= __classPrivateFieldGet(this, _Alphabet_symbols, "f").length) {
-            throw new Error('Invalid index');
-        }
-        return __classPrivateFieldGet(this, _Alphabet_symbols, "f")[index];
-    }
-    index(symbol) {
-        return __classPrivateFieldGet(this, _Alphabet_symbols, "f").indexOf(symbol);
-    }
-}
-_Alphabet_symbols = new WeakMap();
-export default Alphabet;

package/dist/classes/Command.js

@@ -1,38 +0,0 @@
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _Command_tapesCommands;
-import TapeCommand from './TapeCommand';
-class Command {
-    constructor(tapesCommands) {
-        _Command_tapesCommands.set(this, void 0);
-        if (tapesCommands.length === 0) {
-            throw new Error('invalid parameter');
-        }
-        try {
-            __classPrivateFieldSet(this, _Command_tapesCommands, tapesCommands.map((tapeCommand) => {
-                if (tapeCommand instanceof TapeCommand) {
-                    return tapeCommand;
-                }
-                return new TapeCommand(tapeCommand);
-            }), "f");
-        }
-        catch (error) {
-            void error;
-            throw new Error('invalid tapeCommand');
-        }
-    }
-    get tapesCommands() {
-        return [...__classPrivateFieldGet(this, _Command_tapesCommands, "f")];
-    }
-}
-_Command_tapesCommands = new WeakMap();
-export default Command;

package/dist/classes/Lock.js

@@ -1,34 +0,0 @@
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var _Lock_lockSymbol;
-class Lock {
-    constructor() {
-        _Lock_lockSymbol.set(this, null);
-    }
-    lock(symbol) {
-        if (__classPrivateFieldGet(this, _Lock_lockSymbol, "f") === null) {
-            __classPrivateFieldSet(this, _Lock_lockSymbol, symbol, "f");
-        }
-    }
-    unlock(symbol) {
-        if (__classPrivateFieldGet(this, _Lock_lockSymbol, "f") === symbol) {
-            __classPrivateFieldSet(this, _Lock_lockSymbol, null, "f");
-        }
-    }
-    check(symbol) {
-        if (__classPrivateFieldGet(this, _Lock_lockSymbol, "f") && __classPrivateFieldGet(this, _Lock_lockSymbol, "f") !== symbol) {
-            throw new Error('Lock check failed');
-        }
-    }
-}
-_Lock_lockSymbol = new WeakMap();
-export default Lock;

package/dist/classes/Reference.js

@@ -1,31 +0,0 @@
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var _Reference_referenceBinding;
-class Reference {
-    constructor() {
-        _Reference_referenceBinding.set(this, null);
-    }
-    get ref() {
-        if (!__classPrivateFieldGet(this, _Reference_referenceBinding, "f")) {
-            throw new Error('unbounded reference');
-        }
-        return __classPrivateFieldGet(this, _Reference_referenceBinding, "f");
-    }
-    bind(state) {
-        if (__classPrivateFieldGet(this, _Reference_referenceBinding, "f") == null) {
-            __classPrivateFieldSet(this, _Reference_referenceBinding, state, "f");
-        }
-        return __classPrivateFieldGet(this, _Reference_referenceBinding, "f");
-    }
-}
-_Reference_referenceBinding = new WeakMap();
-export default Reference;

package/dist/classes/State.js

@@ -1,113 +0,0 @@
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var _State_id, _State_name, _State_overrodeHaltState, _State_symbolToDataMap;
-import Command from './Command';
-import Reference from './Reference';
-import TapeCommand from './TapeCommand';
-import { id } from '../utilities/functions';
-export const ifOtherSymbol = Symbol('other symbol');
-class State {
-    constructor(stateDefinition = null, name) {
-        _State_id.set(this, id(this));
-        _State_name.set(this, void 0);
-        _State_overrodeHaltState.set(this, null);
-        _State_symbolToDataMap.set(this, new Map());
-        if (stateDefinition) {
-            const keys = Object.getOwnPropertyNames(stateDefinition);
-            if (keys.length) {
-                throw new Error(`invalid state definition while constructing state #${__classPrivateFieldGet(this, _State_id, "f")}`);
-            }
-            const symbols = Object.getOwnPropertySymbols(stateDefinition);
-            if (symbols.length === 0) {
-                throw new Error(`invalid state definition while constructing state #${__classPrivateFieldGet(this, _State_id, "f")}`);
-            }
-            symbols.forEach((symbol) => {
-                const { nextState } = stateDefinition[symbol];
-                const nextStateLocal = nextState !== null && nextState !== void 0 ? nextState : this;
-                if (!(nextStateLocal instanceof State) && !(nextStateLocal instanceof Reference)) {
-                    throw new Error('invalid nextState');
-                }
-                let { command } = stateDefinition[symbol];
-                if (command == null) {
-                    command = new Command([
-                        new TapeCommand({}),
-                    ]);
-                }
-                if (!(command instanceof Command) && !Array.isArray(command)) {
-                    command = [command];
-                }
-                let commandLocal = command;
-                if (Array.isArray(command)) {
-                    try {
-                        commandLocal = new Command(command);
-                    }
-                    catch (error) {
-                        void error;
-                    }
-                }
-                if (!(commandLocal instanceof Command)) {
-                    throw new Error('invalid command');
-                }
-                __classPrivateFieldGet(this, _State_symbolToDataMap, "f").set(symbol, {
-                    command: commandLocal,
-                    nextState: nextStateLocal,
-                });
-            });
-        }
-        __classPrivateFieldSet(this, _State_name, name !== null && name !== void 0 ? name : `id:${__classPrivateFieldGet(this, _State_id, "f")}`, "f");
-    }
-    get id() {
-        return __classPrivateFieldGet(this, _State_id, "f");
-    }
-    get name() {
-        return __classPrivateFieldGet(this, _State_name, "f");
-    }
-    get isHalt() {
-        return __classPrivateFieldGet(this, _State_id, "f") === 0;
-    }
-    get overrodeHaltState() {
-        return __classPrivateFieldGet(this, _State_overrodeHaltState, "f");
-    }
-    get ref() {
-        return this;
-    }
-    getSymbol(tapeBlock) {
-        const symbol = [...__classPrivateFieldGet(this, _State_symbolToDataMap, "f").keys()].find((currentSymbol) => tapeBlock.isMatched({
-            symbol: currentSymbol,
-        }));
-        if (symbol) {
-            return symbol;
-        }
-        return ifOtherSymbol;
-    }
-    getCommand(symbol) {
-        if (__classPrivateFieldGet(this, _State_symbolToDataMap, "f").has(symbol)) {
-            return __classPrivateFieldGet(this, _State_symbolToDataMap, "f").get(symbol).command;
-        }
-        throw new Error(`No command for symbol at state named ${__classPrivateFieldGet(this, _State_name, "f")}`);
-    }
-    getNextState(symbol) {
-        if (__classPrivateFieldGet(this, _State_symbolToDataMap, "f").has(symbol)) {
-            return __classPrivateFieldGet(this, _State_symbolToDataMap, "f").get(symbol).nextState;
-        }
-        throw new Error(`No nextState for symbol at state named ${__classPrivateFieldGet(this, _State_id, "f")}`);
-    }
-    withOverrodeHaltState(overrodeHaltState) {
-        const state = new State(null, `${this.name}>${overrodeHaltState.name}`);
-        __classPrivateFieldSet(state, _State_symbolToDataMap, __classPrivateFieldGet(this, _State_symbolToDataMap, "f"), "f");
-        __classPrivateFieldSet(state, _State_overrodeHaltState, overrodeHaltState, "f");
-        return state;
-    }
-}
-_State_id = new WeakMap(), _State_name = new WeakMap(), _State_overrodeHaltState = new WeakMap(), _State_symbolToDataMap = new WeakMap();
-export default State;
-export const haltState = new State(null);

package/dist/classes/Tape.js

@@ -1,95 +0,0 @@
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _Tape_alphabet, _Tape_symbols, _Tape_position, _Tape_viewportWidth;
-import Alphabet from './Alphabet';
-class Tape {
-    constructor({ alphabet, symbols = [], position = 0, viewportWidth = 1, }) {
-        _Tape_alphabet.set(this, void 0);
-        _Tape_symbols.set(this, void 0);
-        _Tape_position.set(this, void 0);
-        _Tape_viewportWidth.set(this, void 0);
-        const isSymbolsValid = symbols.every((symbol) => alphabet.has(symbol));
-        if (!isSymbolsValid) {
-            throw new Error('symbolList contains invalid symbol');
-        }
-        __classPrivateFieldSet(this, _Tape_alphabet, new Alphabet(alphabet), "f");
-        __classPrivateFieldSet(this, _Tape_position, position, "f");
-        __classPrivateFieldSet(this, _Tape_viewportWidth, viewportWidth, "f");
-        const symbolsCopy = Array.from(symbols);
-        if (symbolsCopy.length === 0) {
-            symbolsCopy.push(__classPrivateFieldGet(this, _Tape_alphabet, "f").blankSymbol);
-        }
-        __classPrivateFieldSet(this, _Tape_symbols, symbolsCopy.map((symbol) => __classPrivateFieldGet(this, _Tape_alphabet, "f").index(symbol)), "f");
-    }
-    get alphabet() {
-        return __classPrivateFieldGet(this, _Tape_alphabet, "f");
-    }
-    get extraCellsCount() {
-        return (__classPrivateFieldGet(this, _Tape_viewportWidth, "f") - 1) / 2;
-    }
-    get position() {
-        return __classPrivateFieldGet(this, _Tape_position, "f");
-    }
-    get symbol() {
-        return __classPrivateFieldGet(this, _Tape_alphabet, "f").get(__classPrivateFieldGet(this, _Tape_symbols, "f")[__classPrivateFieldGet(this, _Tape_position, "f")]);
-    }
-    set symbol(symbol) {
-        if (!__classPrivateFieldGet(this, _Tape_alphabet, "f").has(symbol)) {
-            throw new Error('Invalid symbol');
-        }
-        __classPrivateFieldGet(this, _Tape_symbols, "f")[__classPrivateFieldGet(this, _Tape_position, "f")] = __classPrivateFieldGet(this, _Tape_alphabet, "f").index(symbol);
-    }
-    get symbols() {
-        return __classPrivateFieldGet(this, _Tape_symbols, "f")
-            .map((index) => __classPrivateFieldGet(this, _Tape_alphabet, "f").get(index));
-    }
-    get viewport() {
-        const startIx = __classPrivateFieldGet(this, _Tape_position, "f") - this.extraCellsCount;
-        const endIx = __classPrivateFieldGet(this, _Tape_position, "f") + this.extraCellsCount + 1;
-        return __classPrivateFieldGet(this, _Tape_symbols, "f")
-            .slice(startIx, endIx)
-            .map((index) => __classPrivateFieldGet(this, _Tape_alphabet, "f").get(index));
-    }
-    get viewportWidth() {
-        return __classPrivateFieldGet(this, _Tape_viewportWidth, "f");
-    }
-    set viewportWidth(width) {
-        let finalWidth = width;
-        if (finalWidth < 1) {
-            throw new Error('Invalid viewportWidth');
-        }
-        if (finalWidth % 2 === 0) {
-            finalWidth += 1;
-        }
-        __classPrivateFieldSet(this, _Tape_viewportWidth, finalWidth, "f");
-        this.normalise();
-    }
-    left() {
-        __classPrivateFieldSet(this, _Tape_position, __classPrivateFieldGet(this, _Tape_position, "f") - 1, "f");
-        this.normalise();
-    }
-    normalise() {
-        while (__classPrivateFieldGet(this, _Tape_position, "f") - this.extraCellsCount < 0) {
-            __classPrivateFieldGet(this, _Tape_symbols, "f").unshift(0);
-            __classPrivateFieldSet(this, _Tape_position, __classPrivateFieldGet(this, _Tape_position, "f") + 1, "f");
-        }
-        while (__classPrivateFieldGet(this, _Tape_position, "f") + this.extraCellsCount >= __classPrivateFieldGet(this, _Tape_symbols, "f").length) {
-            __classPrivateFieldGet(this, _Tape_symbols, "f").push(0);
-        }
-    }
-    right() {
-        __classPrivateFieldSet(this, _Tape_position, __classPrivateFieldGet(this, _Tape_position, "f") + 1, "f");
-        this.normalise();
-    }
-}
-_Tape_alphabet = new WeakMap(), _Tape_symbols = new WeakMap(), _Tape_position = new WeakMap(), _Tape_viewportWidth = new WeakMap();
-export default Tape;