@cortex-js/compute-engine 0.13.0 → 0.15.0

package/dist/math-json.esm.js

@@ -1,4 +1,4 @@
-/** CortexJS Compute Engine 0.13.0 */
+/** CortexJS Compute Engine 0.15.0 */
 
 // src/math-json/utils.ts
 function isSymbolObject(expr) {
@@ -239,7 +239,7 @@ function mapArgs(expr, fn) {
 }
 
 // src/math-json.ts
-var version = "0.13.0";
+var version = "0.15.0";
 export {
   applyRecursively,
   dictionary as getDictionary,

package/dist/math-json.js

@@ -1,4 +1,4 @@
-/** CortexJS MathJSON 0.13.0 */
+/** CortexJS MathJSON 0.15.0 */
     (function(global,factory){typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) : typeof define === 'function' && define.amd ? define(['exports'],factory):(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.MathJson = {}));})(this, (function (exports) { 'use strict';
 var MathJson = (() => {
   var __defProp = Object.defineProperty;
@@ -277,7 +277,7 @@ var MathJson = (() => {
   }
 
   // src/math-json.ts
-  var version = "0.13.0";
+  var version = "0.15.0";
   return __toCommonJS(math_json_exports);
 })();
 Object.assign(exports, MathJson); Object.defineProperty(exports, '__esModule', { value: true });}));

package/dist/math-json.min.esm.js

@@ -1,4 +1,4 @@
-/** CortexJS Compute Engine 0.13.0 */
+/** CortexJS Compute Engine 0.15.0 */
 
 // src/math-json/utils.ts
 function isSymbolObject(expr) {
@@ -239,7 +239,7 @@ function mapArgs(expr, fn) {
 }
 
 // src/math-json.ts
-var version = "0.13.0";
+var version = "0.15.0";
 export {
   applyRecursively,
   dictionary as getDictionary,

package/dist/math-json.min.js

@@ -1,4 +1,4 @@
-/** CortexJS MathJSON 0.13.0 */
+/** CortexJS MathJSON 0.15.0 */
     (function(global,factory){typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) : typeof define === 'function' && define.amd ? define(['exports'],factory):(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.MathJson = {}));})(this, (function (exports) { 'use strict';
 var MathJson = (() => {
   var __defProp = Object.defineProperty;
@@ -277,7 +277,7 @@ var MathJson = (() => {
   }
 
   // src/math-json.ts
-  var version = "0.13.0";
+  var version = "0.15.0";
   return __toCommonJS(math_json_exports);
 })();
 Object.assign(exports, MathJson); Object.defineProperty(exports, '__esModule', { value: true });}));

package/dist/types/common/grapheme-splitter.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 /**
  * Return a string or an array of graphemes.
  *

package/dist/types/common/signals.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export type SignalCode = RuntimeSignalCode | ('invalid-name' | 'expected-predicate' | 'expected-symbol' | 'operator-requires-one-operand' | 'postfix-operator-requires-one-operand' | 'prefix-operator-requires-one-operand' | 'unbalanced-symbols' | 'expected-argument' | 'unexpected-command' | 'cyclic-definition' | 'invalid-supersets' | 'expected-supersets' | 'unknown-domain' | 'duplicate-wikidata' | 'invalid-dictionary-entry' | 'syntax-error');
 export type SignalMessage = SignalCode | [SignalCode, ...any[]];
 export type SignalOrigin = {

package/dist/types/common/utils.d.ts

@@ -1 +1 @@
-/* 0.13.0 */
+/* 0.15.0 */

package/dist/types/compute-engine/assume.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 /**
  * Add an assumption, in the form of a predicate, for example:
  *

package/dist/types/compute-engine/boxed-expression/abstract-boxed-expression.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { Complex } from 'complex.js';
 import { Expression } from '../../math-json/math-json-format';
 import { BoxedExpression, BoxedFunctionDefinition, BoxedRuleSet, BoxedSymbolDefinition, BoxedDomain, EvaluateOptions, IComputeEngine, LatexString, Metadata, NOptions, PatternMatchOptions, SemiBoxedExpression, SimplifyOptions, Substitution, RuntimeScope, DomainCompatibility, DomainLiteral, BoxedBaseDefinition, Rational, BoxedSubstitution } from '../public';
@@ -118,5 +118,7 @@ export declare abstract class AbstractBoxedExpression implements BoxedExpression
     simplify(_options?: SimplifyOptions): BoxedExpression;
     evaluate(options?: EvaluateOptions): BoxedExpression;
     N(_options?: NOptions): BoxedExpression;
-    compile(): ((args: Record<string, number>) => number) | undefined;
+    compile(to?: string, options?: {
+        optimize: ('simplify' | 'evaluate')[];
+    }): ((args: Record<string, any>) => any | undefined) | undefined;
 }

package/dist/types/compute-engine/boxed-expression/box.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { Decimal } from 'decimal.js';
 import { IComputeEngine, SemiBoxedExpression, BoxedExpression, Metadata, Rational } from '../public';
 import { MathJsonNumber } from '../../math-json/math-json-format';

package/dist/types/compute-engine/boxed-expression/boxed-dictionary.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { BoxedExpression, IComputeEngine, EvaluateOptions, NOptions, BoxedRuleSet, SemiBoxedExpression, SimplifyOptions, ReplaceOptions, Substitution, Metadata, PatternMatchOptions, BoxedDomain, BoxedSubstitution } from '../public';
 import { AbstractBoxedExpression } from './abstract-boxed-expression';
 /**

package/dist/types/compute-engine/boxed-expression/boxed-domain.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { BoxedDomain, BoxedExpression, BoxedSubstitution, DomainCompatibility, DomainConstructor, DomainExpression, DomainLiteral, IComputeEngine, Metadata, PatternMatchOptions } from '../public';
 import { AbstractBoxedExpression } from './abstract-boxed-expression';
 /**

package/dist/types/compute-engine/boxed-expression/boxed-function-definition.d.ts

@@ -1,2 +1,2 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare function makeFunctionDefinition(engine: IComputeEngine, name: string, def: FunctionDefinition | BoxedFunctionDefinition): BoxedFunctionDefinition;

package/dist/types/compute-engine/boxed-expression/boxed-function.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { Expression } from '../../math-json/math-json-format';
 import { BoxedExpression, BoxedFunctionDefinition, IComputeEngine, NOptions, BoxedRuleSet, SemiBoxedExpression, SimplifyOptions, Substitution, ReplaceOptions, Metadata, PatternMatchOptions, BoxedDomain, RuntimeScope, BoxedSubstitution, EvaluateOptions } from '../public';
 /**

package/dist/types/compute-engine/boxed-expression/boxed-number.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { Complex } from 'complex.js';
 import { Expression } from '../../math-json/math-json-format';
 import { BoxedExpression, BoxedDomain, IComputeEngine, Metadata, NOptions, PatternMatchOptions, Rational, SimplifyOptions, BoxedSubstitution } from '../public';

package/dist/types/compute-engine/boxed-expression/boxed-patterns.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { AbstractBoxedExpression } from './abstract-boxed-expression';
 import { BoxedExpression, BoxedSubstitution, BoxedDomain, IComputeEngine, LatexString, Metadata, Pattern, PatternMatchOptions, SemiBoxedExpression, Substitution } from '../public';
 export declare class BoxedPattern extends AbstractBoxedExpression implements Pattern {

package/dist/types/compute-engine/boxed-expression/boxed-string.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { AbstractBoxedExpression } from './abstract-boxed-expression';
 import { BoxedExpression, BoxedDomain, IComputeEngine, Metadata, PatternMatchOptions, BoxedSubstitution } from '../public';
 /**

package/dist/types/compute-engine/boxed-expression/boxed-symbol-definition.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 /**
  * THEORY OF OPERATIONS
  *

package/dist/types/compute-engine/boxed-expression/boxed-symbol.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { AbstractBoxedExpression } from './abstract-boxed-expression';
 import { BoxedExpression, BoxedRuleSet, BoxedSymbolDefinition, IComputeEngine, EvaluateOptions, NOptions, ReplaceOptions, SimplifyOptions, Substitution, Metadata, PatternMatchOptions, BoxedDomain, RuntimeScope, BoxedFunctionDefinition, BoxedBaseDefinition, DomainExpression, BoxedSubstitution } from '../public';
 /**

package/dist/types/compute-engine/boxed-expression/expression-map.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare class ExpressionMap<U> implements ExpressionMapInterface<U> {
     readonly _items: Map<BoxedExpression, U>;
     constructor(source?: ExpressionMapInterface<U> | readonly (readonly [BoxedExpression, U])[]);

package/dist/types/compute-engine/boxed-expression/order.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export type Order = 'lex' | 'dexlex' | 'grevlex' | 'elim';
 export declare const DEFAULT_COMPLEXITY = 100000;
 /**

package/dist/types/compute-engine/boxed-expression/serialize.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import Decimal from 'decimal.js';
 import { Expression } from '../../math-json/math-json-format';
 import { BoxedExpression, IComputeEngine, Metadata, Rational } from '../public';

package/dist/types/compute-engine/boxed-expression/utils.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { Expression } from '../../math-json/math-json-format';
 import { BoxedExpression, IComputeEngine } from '../public';
 export declare function isLatexString(s: unknown): s is string;

package/dist/types/compute-engine/boxed-expression/validate.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare function validateArgumentCount(ce: IComputeEngine, ops: BoxedExpression[], count: number): BoxedExpression[];
 /**
  * Validation of arguments is normally done by checking the signature of the

package/dist/types/compute-engine/compile.d.ts

@@ -1,3 +1,10 @@
-/* 0.13.0 */
-export declare function compileToJavascript(expr: BoxedExpression): ((_: Record<string, number>) => number) | undefined;
+/* 0.15.0 */
+export type CompiledType = boolean | number | string | object;
+/** This is an extension of the Function class that allows us to pass
+ * a custom scope for "global" functions. */
+export declare class ComputeEngineFunction extends Function {
+    private sys;
+    constructor(body: any);
+}
+export declare function compileToJavascript(expr: BoxedExpression): ((_: Record<string, CompiledType>) => CompiledType) | undefined;
 export declare function compile(expr: BoxedExpression, freeVars?: string[], prec?: number): string;

package/dist/types/compute-engine/compute-engine.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { Complex } from 'complex.js';
 import { Expression, MathJsonNumber } from '../math-json/math-json-format';
 import type { LibraryCategory, LatexDictionary, LatexDictionaryEntry, LatexString, NumberFormattingOptions, ParseLatexOptions, SerializeLatexOptions } from './latex-syntax/public';
@@ -140,14 +140,15 @@ export declare class ComputeEngine implements IComputeEngine {
      * perform calculations using arbitrary precision floating point numbers.
      * Use `"auto"` or `"complex"` to allow calculations on complex numbers.
      *
-     * @param options.numericPrecision Specific how many digits of precision for the
-     * numeric calculations. Default is 100.
+     * @param options.numericPrecision Specific how many digits of precision
+     * for the numeric calculations. Default is 100.
      *
-     * @param options.tolerance If the absolute value of the difference of two numbers
-     * is less than `tolerance`, they are considered equal. Used by `chop()` as well.
+     * @param options.tolerance If the absolute value of the difference of two
+     * numbers is less than `tolerance`, they are considered equal. Used by
+     * `chop()` as well.
      *
-     * @param options.defaultDomain If an unknown symbol is encountered, assume it should
-     * be a variable in this domain. **Default** `ExtendedRealNumber`
+     * @param options.defaultDomain If an unknown symbol is encountered, assume
+     * this is its domain. **Default** `ExtendedRealNumber`
      */
     constructor(options?: {
         numericMode?: NumericMode;
@@ -318,7 +319,9 @@ export declare class ComputeEngine implements IComputeEngine {
     parse(latex: LatexString | string | null, options?: {
         canonical?: boolean;
     }): null | BoxedExpression;
-    serialize(x: Expression | BoxedExpression): string;
+    serialize(x: Expression | BoxedExpression, options?: {
+        canonical?: boolean;
+    }): string;
     get latexOptions(): NumberFormattingOptions & ParseLatexOptions & SerializeLatexOptions;
     set latexOptions(opts: Partial<NumberFormattingOptions> & Partial<ParseLatexOptions> & Partial<SerializeLatexOptions>);
     get jsonSerializationOptions(): Readonly<JsonSerializationOptions>;

package/dist/types/compute-engine/cost-function.d.ts

@@ -1,3 +1,3 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare function costFunction(expr: BoxedExpression): number;
 export declare const DEFAULT_COST_FUNCTION: typeof costFunction;

package/dist/types/compute-engine/domain-utils.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { Decimal } from 'decimal.js';
 import { BoxedExpression, Rational } from './public';
 /** Quickly determine the numeric domain of a number or constant

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-algebra.d.ts

@@ -1,2 +1,2 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare const DEFINITIONS_ALGEBRA: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-arithmetic.d.ts

@@ -1,2 +1,2 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare const DEFINITIONS_ARITHMETIC: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-calculus.d.ts

@@ -1,2 +1,2 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare const DEFINITIONS_CALCULUS: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-complex.d.ts

@@ -0,0 +1,2 @@
+/* 0.15.0 */
+export declare const DEFINITIONS_COMPLEX: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-core.d.ts

@@ -1,2 +1,2 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare const DEFINITIONS_CORE: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-inequalities.d.ts

@@ -1,2 +1,2 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare const DEFINITIONS_INEQUALITIES: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-logic.d.ts

@@ -1,2 +1,2 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare const DEFINITIONS_LOGIC: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-other.d.ts

@@ -1,2 +1,2 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare const DEFINITIONS_OTHERS: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-sets.d.ts

@@ -1,2 +1,2 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare const DEFINITIONS_SETS: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-statistics.d.ts

@@ -0,0 +1,2 @@
+/* 0.15.0 */
+export declare const DEFINITIONS_STATISTICS: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-symbols.d.ts

@@ -1,3 +1,3 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare const SYMBOLS: [string, string, number][];
 export declare const DEFINITIONS_SYMBOLS: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions-trigonometry.d.ts

@@ -1,2 +1,2 @@
-/* 0.13.0 */
+/* 0.15.0 */
 export declare const DEFINITIONS_TRIGONOMETRY: LatexDictionary;

package/dist/types/compute-engine/latex-syntax/dictionary/definitions.d.ts

@@ -1,18 +1,28 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { WarningSignal } from '../../../common/signals';
 export type CommonEntry = {
+    /** Note: a name is required if a serialize handler is provided */
     name?: string;
-    serialize: SerializeHandler | LatexString;
+    serialize?: SerializeHandler;
+    /** Note: not all kinds have a latexTrigger or identifierTrigger.
+     * For example, matchfix operators use openDelimiter/closeDelimiter
+     */
+    latexTrigger?: LatexString;
+    identifierTrigger?: string;
 };
 export type IndexedSymbolEntry = CommonEntry & {
     kind: 'symbol';
-    precedence: number;
+    precedence: Precedence;
     parse: ExpressionParseHandler;
 };
+/** @internal */
+export declare function isIndexedSymbolEntry(entry: IndexedLatexDictionaryEntry): entry is IndexedSymbolEntry;
 export type IndexedExpressionEntry = CommonEntry & {
     kind: 'expression';
     parse: ExpressionParseHandler;
 };
+/** @internal */
+export declare function isIndexedExpressionEntry(entry: IndexedLatexDictionaryEntry): entry is IndexedExpressionEntry;
 /**
  * A function has the following form:
  * - a prefix such as `\mathrm` or `\operatorname`
@@ -26,44 +36,49 @@ export type IndexedFunctionEntry = CommonEntry & {
     kind: 'function';
     parse: ExpressionParseHandler;
 };
+/** @internal */
+export declare function isIndexedFunctionEntry(entry: IndexedLatexDictionaryEntry): entry is IndexedFunctionEntry;
 export type IndexedMatchfixEntry = CommonEntry & {
     kind: 'matchfix';
     openDelimiter: Delimiter | LatexToken[];
     closeDelimiter: Delimiter | LatexToken[];
     parse: MatchfixParseHandler;
 };
+/** @internal */
+export declare function isIndexedMatchfixEntry(entry: IndexedLatexDictionaryEntry): entry is IndexedMatchfixEntry;
 export type IndexedInfixEntry = CommonEntry & {
     kind: 'infix';
     associativity: 'right' | 'left' | 'non' | 'both';
-    precedence: number;
+    precedence: Precedence;
     parse: InfixParseHandler;
 };
+/** @internal */
+export declare function isIndexedInfixdEntry(entry: IndexedLatexDictionaryEntry): entry is IndexedInfixEntry;
 export type IndexedPrefixEntry = CommonEntry & {
     kind: 'prefix';
-    precedence: number;
+    precedence: Precedence;
     parse: ExpressionParseHandler;
 };
+/** @internal */
+export declare function isIndexedPrefixedEntry(entry: IndexedLatexDictionaryEntry): entry is IndexedPostfixEntry;
 export type IndexedPostfixEntry = CommonEntry & {
     kind: 'postfix';
-    precedence: number;
+    precedence: Precedence;
     parse: PostfixParseHandler;
 };
-export type EnvironmentEntry = CommonEntry & {
+/** @internal */
+export declare function isIndexedPostfixEntry(entry: IndexedLatexDictionaryEntry): entry is IndexedPostfixEntry;
+export type IndexedEnvironmentEntry = CommonEntry & {
     kind: 'environment';
     parse: EnvironmentParseHandler;
 };
-export type IndexedLatexDictionaryEntry = IndexedExpressionEntry | IndexedFunctionEntry | IndexedSymbolEntry | IndexedMatchfixEntry | IndexedInfixEntry | IndexedPrefixEntry | IndexedPostfixEntry | EnvironmentEntry;
+/** @internal */
+export declare function isIndexedEnvironmentEntry(entry: IndexedLatexDictionaryEntry): entry is IndexedEnvironmentEntry;
+export type IndexedLatexDictionaryEntry = IndexedExpressionEntry | IndexedFunctionEntry | IndexedSymbolEntry | IndexedMatchfixEntry | IndexedInfixEntry | IndexedPrefixEntry | IndexedPostfixEntry | IndexedEnvironmentEntry;
 export type IndexedLatexDictionary = {
+    ids: Map<string, IndexedLatexDictionaryEntry>;
     lookahead: number;
-    name: Map<string, IndexedLatexDictionaryEntry>;
-    expression: (Map<LatexString, IndexedExpressionEntry[]> | null)[];
-    symbol: (Map<LatexString, IndexedSymbolEntry[]> | null)[];
-    prefix: (Map<LatexString, IndexedPrefixEntry[]> | null)[];
-    infix: (Map<LatexString, IndexedInfixEntry[]> | null)[];
-    postfix: (Map<LatexString, IndexedPostfixEntry[]> | null)[];
-    matchfix: IndexedMatchfixEntry[];
-    function: Map<string, IndexedFunctionEntry[]>;
-    environment: Map<string, EnvironmentEntry>;
+    defs: IndexedLatexDictionaryEntry[];
 };
 export declare function indexLatexDictionary(dic: readonly Partial<LatexDictionaryEntry>[], onError: (sig: WarningSignal) => void): IndexedLatexDictionary;
 export declare const DEFAULT_LATEX_DICTIONARY: {

package/dist/types/compute-engine/latex-syntax/latex-syntax.d.ts

@@ -1,4 +1,4 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { Serializer } from './serializer';
 import { Expression } from '../../math-json/math-json-format';
 import { WarningSignalHandler } from '../../common/signals';
@@ -21,6 +21,8 @@ export declare class LatexSyntax {
     updateOptions(opt: Partial<NumberFormattingOptions> & Partial<ParseLatexOptions> & Partial<SerializeLatexOptions>): void;
     static getDictionary(category?: LibraryCategory | 'all'): Readonly<LatexDictionary>;
     parse(latex: LatexString): Expression;
-    serialize(expr: Expression): LatexString;
+    serialize(expr: Expression, options?: {
+        canonical?: boolean;
+    }): LatexString;
     get serializer(): Serializer;
 }

package/dist/types/compute-engine/latex-syntax/parse-identifier.d.ts

@@ -1,15 +1,21 @@
-/* 0.13.0 */
+/* 0.15.0 */
 import { Parser } from './public';
 /** For error handling, if we have a identifier prefix, assume
  * the identifier is invalid (it would have been captured by
  * `mathIdentifier()` otherwise) and return an error expression */
 export declare function parseInvalidIdentifier(parser: Parser): Expression | null;
 /**
- * Match an identifier. It can be:
+ * Match an identifier.
+ *
+ * It can be:
  * - a sequence of emojis: `👍🏻👍🏻👍🏻`
- * - a single-letter identifier: `a`
+ * - a single-letter: `a`
  * - some LaTeX commands: `\alpha`
- * - a multi-letter identifier with a prefix: `\mathrm{speed}`
- * - an identifier with modifiers: `\mathrm{\alpha_{12}}` or `\mathit{speed\unicode{"2012}of\unicode{"2012}sound}`
+ * - a multi-letter id with a prefix: `\operatorname{speed}`
+ * - an id with multiple prefixes:
+ *  `\mathbin{\mathsf{T}}`
+ * - an id with modifiers:
+ *    - `\mathrm{\alpha_{12}}` or
+ *    - `\mathit{speed\unicode{"2012}of\unicode{"2012}sound}`
  */
-export declare function matchIdentifier(parser: Parser): string | null;
+export declare function parseIdentifier(parser: Parser): string | null;

package/dist/types/compute-engine/latex-syntax/parse.d.ts

@@ -1,5 +1,5 @@
-/* 0.13.0 */
-import { IndexedLatexDictionary, IndexedInfixEntry, IndexedPostfixEntry, IndexedPrefixEntry, IndexedSymbolEntry, IndexedExpressionEntry } from './dictionary/definitions';
+/* 0.15.0 */
+import { IndexedLatexDictionary, IndexedLatexDictionaryEntry, IndexedInfixEntry, IndexedPostfixEntry, IndexedPrefixEntry, IndexedSymbolEntry, IndexedExpressionEntry, IndexedFunctionEntry } from './dictionary/definitions';
 import { IComputeEngine } from '../public';
 import { Expression } from '../../math-json/math-json-format';
 export declare const DEFAULT_LATEX_NUMBER_OPTIONS: NumberFormattingOptions;
@@ -36,8 +36,11 @@ export declare class _Parser implements Parser {
      * - the `t.condition` function returns true
      * Note: the `minPrec` condition is not checked. It should be checked separately.
      */
-    atTerminator(t?: Partial<Terminator>): boolean;
-    /** True if the current token matches any of the boundaries we are waiting for */
+    atTerminator(t?: Readonly<Terminator>): boolean;
+    /**
+     * True if the current token matches any of the boundaries we are
+     * waiting for.
+     */
     get atBoundary(): boolean;
     addBoundary(boundary: LatexToken[]): void;
     removeBoundary(): void;
@@ -59,15 +62,23 @@ export declare class _Parser implements Parser {
      * `[empty, '\\sqrt', '\\sqrt{', '\\sqrt{2', '\\sqrt{2}']`
      *
      */
-    lookAhead(): string[];
-    /** Return all the definitions that potentially match the tokens ahead */
-    peekDefinitions(kind: 'expression'): [IndexedExpressionEntry, number][] | null;
-    peekDefinitions(kind: 'function'): [FunctionEntry, number][] | null;
-    peekDefinitions(kind: 'symbol'): [IndexedSymbolEntry, number][] | null;
-    peekDefinitions(kind: 'postfix'): [IndexedPostfixEntry, number][] | null;
-    peekDefinitions(kind: 'infix'): [IndexedInfixEntry, number][] | null;
-    peekDefinitions(kind: 'prefix'): [IndexedPrefixEntry, number][] | null;
-    peekDefinitions(kind: 'operator'): [IndexedInfixEntry | IndexedPrefixEntry | IndexedPostfixEntry, number][] | null;
+    lookAhead(): [count: number, tokens: string][];
+    /** Return all the definitions that match the tokens ahead
+     *
+     * The return value is an array of pairs `[def, n]` where `def` is the
+     * definition that matches the tokens ahead, and `n` is the number of tokens
+     * that matched.
+     *
+     * Note the 'operator' kind matches both infix, prefix and postfix operators.
+     *
+     */
+    peekDefinitions(kind: 'expression'): [IndexedExpressionEntry, number][];
+    peekDefinitions(kind: 'function'): [IndexedFunctionEntry, number][];
+    peekDefinitions(kind: 'symbol'): [IndexedSymbolEntry, number][];
+    peekDefinitions(kind: 'postfix'): [IndexedPostfixEntry, number][];
+    peekDefinitions(kind: 'infix'): [IndexedInfixEntry, number][];
+    peekDefinitions(kind: 'prefix'): [IndexedPrefixEntry, number][];
+    peekDefinitions(kind: 'operator'): [IndexedInfixEntry | IndexedPrefixEntry | IndexedPostfixEntry, number][];
     /** Skip strictly `<space>` tokens.
      * To also skip `{}` see `skipSpace()`.
      * To skip visual space (e.g. `\,`) see `skipVisualSpace()`.
@@ -83,6 +94,40 @@ export declare class _Parser implements Parser {
     matchAll(tokens: LatexToken[]): boolean;
     matchAny(tokens: LatexToken[]): LatexToken;
     matchChar(): string | null;
+    /** If the next token matches the open delimiter, set a boundary with
+     * the close token and return true.
+     *
+     * Note this method handles generic delimiters, i.e. '(' will math both
+     * '(', '\left(', '\bigl(', etc...
+     *
+     * Note that the definitions for matchfix may need to include synonyms
+     * for example:
+     *
+     * {
+     *    openDelimiter: '(',
+     *    closeDelimiter: ')'
+     * }
+     *
+     * and
+     *
+     * {
+     *   openDelimiter: '\\lparen',
+     *   closeDelimiter: '\\rparen'
+     * }
+     *
+     * For:
+     * - '[': '\\lbrack' and '\\['
+     * - ']': '\\rbrack' and '\\]'
+     * - '{': '\\lbrace' and '\\}'
+     * - '}': '\\rbrace' and '\\}'
+     * - '<': '\\langle'
+     * - '>': '\\rangle'
+     * - '|': '\\vert'
+     * - '||': '\\Vert'
+     * - '|': '\\lvert' and '\\rvert'
+     * - '||': '\\lVert' and '\\rVert'
+     */
+    private matchDelimiter;
     parseGroup(): Expression | null;
     parseToken(): Expression | null;
     parseOptionalGroup(): Expression | null;
@@ -135,10 +180,7 @@ export declare class _Parser implements Parser {
      *  (i.e. we interpret `\cos 2x + 1` as `\cos(2x) + 1`)
      *
      */
-    parseArguments(kind?: 'enclosure' | 'implicit', until?: Terminator): Expression[] | null;
-    /** A prime suffix is a sequence of `'`, `\prime` or `\doubleprime`
-     * after a function or in a superscript.
-     */
+    parseArguments(kind?: 'enclosure' | 'implicit', until?: Readonly<Terminator>): Expression[] | null;
     /** If matches the normalized open delimiter, return the
      * expected closing delimiter.
      *
@@ -146,6 +188,8 @@ export declare class _Parser implements Parser {
      * return `['\right', '\rparen']`, which can be matched with `matchAll()`
      *
      * If you need to match several tokens, use `matchAll()`
+     *
+     * @internal
      */
     private matchOpenDelimiter;
     /** For error handling, when there is potentially a mismatched delimiter.
@@ -176,7 +220,7 @@ export declare class _Parser implements Parser {
      * (`\prime`...) and some arguments.
      */
     private parseFunction;
-    parseSymbol(until?: Partial<Terminator>): Expression | null;
+    parseSymbol(until?: Readonly<Terminator>): Expression | null;
     /**
      * Parse a sequence superfix/subfix operator, e.g. `^{*}`
      *
@@ -189,7 +233,7 @@ export declare class _Parser implements Parser {
      *
      */
     private parseSupsub;
-    parsePostfixOperator(lhs: Expression | null, until?: Partial<Terminator>): Expression | null;
+    parsePostfixOperator(lhs: Expression | null, until?: Readonly<Terminator>): Expression | null;
     /** Match a string used as a LaTeX identifier, for example an environment
      * name.
      * Not suitable for general purpose text, e.g. argument of a `\text{}
@@ -252,11 +296,13 @@ export declare class _Parser implements Parser {
      * Stop when an operator of precedence less than `until.minPrec`
      * is encountered
      */
-    parseExpression(until?: Partial<Terminator>): Expression | null;
+    parseExpression(until?: Readonly<Terminator>): Expression | null;
     /**
      * Add LaTeX or other requested metadata to the expression
      */
     decorate(expr: Expression | null, start: number): Expression | null;
     error(code: string | [string, ...Expression[]], fromToken: number): Expression;
     private isFunctionHead;
+    /** Return all defs of the specified kind */
+    getDefs(kind: string): Iterable<IndexedLatexDictionaryEntry>;
 }