@dallaylaen/ski-interpreter 2.8.0 → 2.8.2

package/lib/types/extras.d.ts

@@ -51,17 +51,33 @@ export type SearchResult = {
     gen: number;
     cache?: Expr[][];
 };
-declare function search(seed: Expr[], options: SearchOptions, predicate: SearchCallback): SearchResult;
+export type EquivResult = {
+    steps: number;
+    equal: boolean;
+    normal: boolean;
+    canonical: [Expr | null, Expr | null];
+};
 /**
- *  Recursively replace all instances of Expr in a data structure with
- *       respective string representation using the format() options.
- *       Objects of other types and primitive values are eft as is.
+ *   Converts an unknown object into a FormatOptions, or returns an error it it is not valid.
+ *   A null/undefined counts as an empty options object (and is thus valid).
+ */
+declare function checkFormatOptions(raw: unknown): {
+    value: FormatOptions;
+} | {
+    error: Record<string, string>;
+};
+/**
+ * Find out if two expressions are computationally equivalent.
  *
- *       May be useful for debugging or diagnostic output.
+ * Unlike equals(), this function will attempt to normalize both expressions
+ * before comparing.
  *
  * @experimental
+ * @param e1
+ * @param e2
+ * @param options
  */
-declare function deepFormat(obj: any, options?: FormatOptions): any;
+declare function equiv(e1: Expr, e2: Expr, options?: {}): EquivResult;
 /**
  *   Given an expression and a hash of named terms,
  *   return a semicolon-separated string that declares said expression
@@ -75,19 +91,27 @@ declare function deepFormat(obj: any, options?: FormatOptions): any;
  */
 declare function declare(expr: Expr, env?: Record<string, Named>): string;
 /**
- *   Converts an unknown object into a FormatOptions, or returns an error it it is not valid.
- *   A null/undefined counts as an empty options object (and is thus valid).
+ *  Recursively replace all instances of Expr in a data structure with
+ *       respective string representation using the format() options.
+ *       Objects of other types and primitive values are eft as is.
+ *
+ *       May be useful for debugging or diagnostic output.
+ *
+ * @experimental
  */
-declare function checkFormatOptions(raw: unknown): {
-    value: FormatOptions;
-} | {
-    error: Record<string, string>;
-};
+declare function deepFormat(obj: any, options?: FormatOptions): any;
+/**
+ * @experimental
+ *   Look for an expression that matches the predicate,
+ *        starting with the seed and applying the terms to one another.
+ */
+declare function search(seed: Expr[], options: SearchOptions, predicate: SearchCallback): SearchResult;
 export declare const extras: {
     search: typeof search;
     deepFormat: typeof deepFormat;
     declare: typeof declare;
     toposort: typeof toposort;
     checkFormatOptions: typeof checkFormatOptions;
+    equiv: typeof equiv;
 };
 export {};

package/lib/types/index.d.ts

@@ -50,6 +50,7 @@ export declare class SKI extends Parser {
         } | {
             error: Record<string, string>;
         };
+        equiv: (e1: import("./expr").Expr, e2: import("./expr").Expr, options?: {}) => import("./extras").EquivResult;
     };
     static Quest: typeof Quest;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dallaylaen/ski-interpreter",
-  "version": "2.8.0",
+  "version": "2.8.2",
   "description": "Simple Kombinator Interpreter - a combinatory logic & lambda calculus parser and interpreter. Supports SKI, BCKW, Church numerals, and setting up assertions ('quests') involving all of the above.",
   "keywords": [
     "combinatory logic",
@@ -40,6 +40,7 @@
     "README.md",
     "LICENSE",
     "CHANGELOG.md",
+    "example",
     "lib"
   ],
   "repository": {

package/lib/types/toposort.d.ts

@@ -1,29 +0,0 @@
-import { Expr, Named } from './expr';
-/**
- *        Sort a list in such a way that dependent terms come after the (named) terms they depend on.
- *        If env is given, only terms listed there are taken into account.
- *        If env is omitted, it will be implied from the list.
- *        If list is omitted, it will default to values of env.
- *        If just one term is given instead of a list, it will be coerced into a list.
- *
- *        No terms outside env + list may ever appear in the result.
- *
- *        The terms in env must be named and their names must match their keys.
- *
- * @param {Expr|Expr[]} list
- * @param {{[s:string]: Named}} env
- * @returns {{list: Expr[], env: {[s:string]: Named}}}
- *
- * @example
- *    const expr = ski.parse(src);
- *    toposort([expr], ski.getTerms()); // returns all terms appearing in Expr in correct order
- */
-export type ToposortResult = {
-    list: Expr[];
-    env: {
-        [s: string]: Named;
-    };
-};
-export declare function toposort(list: Expr[] | Expr | undefined, env: {
-    [s: string]: Named;
-} | undefined): ToposortResult;