@cortex-js/compute-engine 0.24.0 → 0.25.0

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

@@ -1,6 +1,12 @@
-/* 0.24.0 */
-import { NumberFormattingOptions } from './public';
-export declare function serializeNumber(expr: Expression | null, options: NumberFormattingOptions): string;
+/* 0.25.0 */
+import { NumberSerializationFormat } from './public';
+/**
+ * @param expr - A number, can be represented as a string
+ *  particularly useful for arbitrary precision numbers) or a number (-12.45)
+ * @return A textual representation of the number, formatted according to the
+ * `options`
+ */
+export declare function serializeNumber(expr: Expression | null, options: NumberSerializationFormat): string;
 /**
  * `value` is a base-10 number, possibly a floating point number with an
  * exponent, i.e. "0.31415e1"

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

@@ -1,4 +1,4 @@
-/* 0.24.0 */
+/* 0.25.0 */
 import { DelimiterScale } from './public';
 export declare function getApplyFunctionStyle(_expr: Expression, _level: number): DelimiterScale;
 export declare function getGroupStyle(_expr: Expression, _level: number): DelimiterScale;

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

@@ -1,15 +1,11 @@
-/* 0.24.0 */
-import { WarningSignalHandler } from '../../common/signals';
-import { NumberFormattingOptions, LatexString, SerializeLatexOptions, DelimiterScale } from './public';
+/* 0.25.0 */
+import { LatexString, SerializeLatexOptions, DelimiterScale } from './public';
 import { IndexedLatexDictionary, IndexedLatexDictionaryEntry } from './dictionary/definitions';
 export declare class Serializer {
-    readonly onError: WarningSignalHandler;
-    options: NumberFormattingOptions & SerializeLatexOptions;
+    options: SerializeLatexOptions;
     readonly dictionary: IndexedLatexDictionary;
     level: number;
-    canonical: undefined | boolean;
-    constructor(options: NumberFormattingOptions & SerializeLatexOptions, dictionary: IndexedLatexDictionary, onError: WarningSignalHandler);
-    updateOptions(opt: Partial<NumberFormattingOptions> & Partial<SerializeLatexOptions>): void;
+    constructor(dictionary: IndexedLatexDictionary, options: SerializeLatexOptions);
     /**
      * Serialize the expression, and if the expression is an operator
      * of precedence less than or equal to prec, wrap it in some parens.
@@ -31,9 +27,7 @@ export declare class Serializer {
     serializeDictionary(dict: {
         [key: string]: Expression;
     }): string;
-    serialize(expr: Expression | null, options?: {
-        canonical?: boolean;
-    }): LatexString;
+    serialize(expr: Expression | null): LatexString;
     applyFunctionStyle(expr: Expression, level: number): DelimiterScale;
     groupStyle(expr: Expression, level: number): DelimiterScale;
     rootStyle(expr: Expression, level: number): 'radical' | 'quotient' | 'solidus';
@@ -43,3 +37,4 @@ export declare class Serializer {
     numericSetStyle(expr: Expression, level: number): 'compact' | 'regular' | 'interval' | 'set-builder';
 }
 export declare function appendLatex(src: string, s: string): string;
+export declare function serializeLatex(expr: Expression | null, dict: IndexedLatexDictionary, options: SerializeLatexOptions): string;

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

@@ -1,4 +1,4 @@
-/* 0.24.0 */
+/* 0.25.0 */
  * ## Reference
  * TeX source code:
  * {@link  http://tug.org/texlive/devsrc/Build/source/texk/web2c/tex.web | Tex.web}
@@ -11,7 +11,8 @@ export type Token = string;
  * @param s - A string of LaTeX. It can include comments (with the `%`
  * marker) and multiple lines.
  */
-export declare function tokenize(s: string, args: string[]): Token[];
+export declare function tokenize(s: string, args?: string[]): Token[];
 export declare function countTokens(s: string): number;
 export declare function joinLatex(segments: Iterable<string>): string;
+export declare function supsub(c: '_' | '^', x: string): string;
 export declare function tokensToString(tokens: Token | Token[] | [Token[] | Token][]): string;

package/dist/types/compute-engine/library/arithmetic-add.d.ts

@@ -1,14 +1,14 @@
-/* 0.24.0 */
+/* 0.25.0 */
 /** The canonical form of `Add`:
  * - removes `0`
  * - capture complex numbers (a + ib or ai +b)
  * */
-export declare function canonicalAdd(ce: IComputeEngine, ops: BoxedExpression[]): BoxedExpression;
+export declare function canonicalAdd(ce: IComputeEngine, ops: ReadonlyArray<BoxedExpression>): BoxedExpression;
 export declare function domainAdd(_ce: IComputeEngine, args: (undefined | BoxedDomain)[]): BoxedDomain | null | undefined;
-export declare function simplifyAdd(ce: IComputeEngine, args: BoxedExpression[]): BoxedExpression;
-export declare function evalAdd(ce: IComputeEngine, ops: BoxedExpression[], mode?: 'N' | 'evaluate'): BoxedExpression;
+export declare function simplifyAdd(ce: IComputeEngine, args: ReadonlyArray<BoxedExpression>): BoxedExpression;
+export declare function evalAdd(ce: IComputeEngine, ops: ReadonlyArray<BoxedExpression>, mode?: 'N' | 'evaluate'): BoxedExpression;
 export declare function canonicalSummation(ce: IComputeEngine, body: BoxedExpression, indexingSet: BoxedExpression | undefined): BoxedExpression | null;
-export declare function evalSummation(ce: IComputeEngine, summationEquation: BoxedExpression[], mode: 'simplify' | 'N' | 'evaluate'): BoxedExpression | undefined;
+export declare function evalSummation(ce: IComputeEngine, summationEquation: ReadonlyArray<BoxedExpression>, mode: 'simplify' | 'N' | 'evaluate'): BoxedExpression | undefined;
 /**
  * Return a multiple of the imaginary unit, e.g.
  * - 'ImaginaryUnit'  -> 1

package/dist/types/compute-engine/library/arithmetic-divide.d.ts

@@ -1,4 +1,4 @@
-/* 0.24.0 */
+/* 0.25.0 */
 /**
  * Canonical form of 'Divide' (and 'Rational')
  * - remove denominator of 1
@@ -14,3 +14,4 @@ export declare function canonicalDivide(ce: IComputeEngine, op1: BoxedExpression
  */
 export declare function simplifyDivide(ce: IComputeEngine, op1: BoxedExpression, op2: BoxedExpression): BoxedExpression | undefined;
 export declare function evalDivide(ce: IComputeEngine, op1: BoxedExpression, op2: BoxedExpression): BoxedExpression;
+export declare function evalNDivide(ce: IComputeEngine, op1: BoxedExpression, op2: BoxedExpression): BoxedExpression;

package/dist/types/compute-engine/library/arithmetic-multiply.d.ts

@@ -1,4 +1,4 @@
-/* 0.24.0 */
+/* 0.25.0 */
 /** The canonical form of `Multiply`:
  * - remove `1`
  * - simplify the signs:
@@ -9,8 +9,8 @@
  *
  * The ops must be canonical, the result is canonical.
  */
-export declare function canonicalMultiply(ce: IComputeEngine, ops: BoxedExpression[]): BoxedExpression;
+export declare function canonicalMultiply(ce: IComputeEngine, ops: ReadonlyArray<BoxedExpression>): BoxedExpression;
 export declare function simplifyMultiply(ce: IComputeEngine, ops: BoxedExpression[]): BoxedExpression;
-export declare function evalMultiply(ce: IComputeEngine, ops: BoxedExpression[], mode?: 'N' | 'evaluate'): BoxedExpression;
+export declare function evalMultiply(ce: IComputeEngine, ops: ReadonlyArray<BoxedExpression>, mode?: 'N' | 'evaluate'): BoxedExpression;
 export declare function canonicalProduct(ce: IComputeEngine, body: BoxedExpression | undefined, indexingSet: BoxedExpression | undefined): BoxedExpression | null;
-export declare function evalMultiplication(ce: IComputeEngine, summationEquation: BoxedExpression[], mode: 'simplify' | 'N' | 'evaluate'): BoxedExpression | undefined;
+export declare function evalMultiplication(ce: IComputeEngine, summationEquation: ReadonlyArray<BoxedExpression>, mode: 'simplify' | 'N' | 'evaluate'): BoxedExpression | undefined;

package/dist/types/compute-engine/library/arithmetic-power.d.ts

@@ -1,4 +1,5 @@
-/* 0.24.0 */
+/* 0.25.0 */
+import { BoxedExpression, IComputeEngine, Metadata } from '../public';
 /**
  *
  */

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

@@ -1,3 +1,3 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export type CanonicalArithmeticFunctions = 'Add' | 'Negate' | 'Sqrt' | 'Multiply' | 'Divide' | 'Power' | 'Ln';
 export declare const ARITHMETIC_LIBRARY: IdentifierDefinitions[];

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

@@ -1,2 +1,2 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const CALCULUS_LIBRARY: IdentifierDefinitions[];

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

@@ -1,3 +1,3 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const DEFAULT_LINSPACE_COUNT = 50;
 export declare const COLLECTIONS_LIBRARY: IdentifierDefinitions;

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

@@ -1,2 +1,2 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const COMPLEX_LIBRARY: IdentifierDefinitions[];

package/dist/types/compute-engine/library/control-structures.d.ts

@@ -1,2 +1,2 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const CONTROL_STRUCTURES_LIBRARY: IdentifierDefinitions[];

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

@@ -1,3 +1,4 @@
-/* 0.24.0 */
+/* 0.25.0 */
+import { BoxedExpression } from '../boxed-expression/public';
 export declare const CORE_LIBRARY: IdentifierDefinitions[];
-export declare function canonicalInvisibleOperator(ce: IComputeEngine, ops: BoxedExpression[]): BoxedExpression | null;
+export declare function canonicalInvisibleOperator(ce: IComputeEngine, ops: ReadonlyArray<BoxedExpression>): BoxedExpression | null;

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

@@ -1,4 +1,4 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const DOMAIN_CONSTRUCTORS: string[];
 export declare const DOMAIN_ALIAS: {
     Functions: (string | string[])[];

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

@@ -1,4 +1,4 @@
-/* 0.24.0 */
+/* 0.25.0 */
 import { FunctionDefinition, IComputeEngine, IdentifierDefinitions, SymbolDefinition } from '../public';
 export declare function getStandardLibrary(categories: LibraryCategory[] | LibraryCategory | 'all'): readonly IdentifierDefinitions[];
 export declare const LIBRARIES: {

package/dist/types/compute-engine/library/linear-algebra.d.ts

@@ -1,2 +1,2 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const LINEAR_ALGEBRA_LIBRARY: IdentifierDefinitions[];

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

@@ -1,2 +1,2 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const LOGIC_LIBRARY: IdentifierDefinitions;

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

@@ -1,2 +1,2 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const POLYNOMIALS_LIBRARY: IdentifierDefinitions[];

package/dist/types/compute-engine/library/random-expression.d.ts

@@ -1,2 +1,2 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare function randomExpression(level?: number): Expression;

package/dist/types/compute-engine/library/relational-operator.d.ts

@@ -1,3 +1,2 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const RELOP_LIBRARY: IdentifierDefinitions;
-export declare function isInequality(expr: BoxedExpression): boolean;

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

@@ -1,2 +1,2 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const SETS_LIBRARY: IdentifierDefinitions;

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

@@ -1,2 +1,2 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const STATISTICS_LIBRARY: IdentifierDefinitions[];

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

@@ -1,2 +1,2 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare const TRIGONOMETRY_LIBRARY: IdentifierDefinitions[];

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

@@ -1,4 +1,4 @@
-/* 0.24.0 */
+/* 0.25.0 */
 /**
  * Assume the caller has setup a scope. The index
  * variable will be declared in that scope.
@@ -12,7 +12,7 @@
  * \sum_{i=1,j=1}^{10,10} x and returns an array of expressions
  * ["Sum","x",["Triple","i",1,10],["Triple","j",1,10]
  */
-export declare function MultiIndexingSet(indexingSet: BoxedExpression | undefined): BoxedExpression[] | undefined;
+export declare function MultiIndexingSet(indexingSet: BoxedExpression | undefined): ReadonlyArray<BoxedExpression> | undefined;
 /**
  * Assume the caller has setup a scope. The index
  * variable will be declared in that scope.

package/dist/types/compute-engine/numerics/numeric-bigint.d.ts

@@ -1,4 +1,4 @@
-/* 0.24.0 */
+/* 0.25.0 */
 import { Expression } from '../../math-json';
 export declare function bigintValue(expr: Expression | null | undefined): bigint | null;
 export declare function bigint(a: Decimal | number | bigint | string): bigint;
@@ -12,3 +12,9 @@ export declare function primeFactors(d: bigint): Map<bigint, number>;
  *
  */
 export declare function factorPower(n: bigint, exponent: number): [factor: bigint, root: bigint];
+/**
+ * Return a, b, c such that n = a * b^c
+ * @param n
+ *
+ */
+export declare function canonicalInteger(n: bigint): [a: bigint, b: bigint, c: bigint];

package/dist/types/compute-engine/numerics/numeric-bignum.d.ts

@@ -1,4 +1,4 @@
-/* 0.24.0 */
+/* 0.25.0 */
 import { IComputeEngine } from '../public';
 export declare function gcd(a: Decimal, b: Decimal): Decimal;
 export declare function lcm(a: Decimal, b: Decimal): Decimal;

package/dist/types/compute-engine/numerics/numeric-complex.d.ts

@@ -1,3 +1,3 @@
-/* 0.24.0 */
+/* 0.25.0 */
 export declare function gamma(c: Complex): Complex;
 export declare function gammaln(c: Complex): Complex;

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

@@ -1,6 +1,5 @@
-/* 0.24.0 */
+/* 0.25.0 */
 import { Decimal } from 'decimal.js';
-import { BoxedExpression } from '../public';
 export declare const MACHINE_PRECISION_BITS = 53;
 export declare const MACHINE_PRECISION: number;
 export declare const MACHINE_TOLERANCE_BITS = 7;
@@ -15,11 +14,12 @@ export declare const MAX_SYMBOLIC_TERMS = 200;
  */
 export declare function nextUp(x: number): number;
 export declare function nextDown(x: number): number;
-export declare const SMALL_PRIMES: Set<number>;
-export declare const LARGEST_SMALL_PRIME = 7919;
-export declare function primeFactors(n: number): {
-    [factor: number]: number;
-};
+/**
+ * Return a, b, c such that n = a * b^c
+ * @param n
+ *
+ */
+export declare function canonicalInteger(n: number): [a: number, b: number, c: number];
 /** Return `[factor, root]` such that
  * pow(n, 1/exponent) = factor * pow(root, 1/exponent)
  *
@@ -33,9 +33,6 @@ export declare function factorial(n: number): number;
 export declare function factorial2(n: number): number;
 export declare function gammaln(z: number): number;
 export declare function gamma(z: number): number;
-export declare function asFloat(expr: BoxedExpression | undefined): number | null;
-export declare function asBignum(expr: BoxedExpression | undefined): Decimal | null;
-export declare function asSmallInteger(expr: BoxedExpression | undefined): number | null;
 export declare function chop(n: number, tolerance: number): number;
 export declare function chop(n: Decimal, tolerance: number): 0 | Decimal;
 export declare function chop(n: Complex, tolerance: number): 0 | Complex;
@@ -109,10 +106,3 @@ export declare function monteCarloEstimate(f: (x: number) => number, a: number,
 export declare function limit(f: (x: number) => number, x: number, dir?: number): number;
 export declare function fromRoman(roman: string): [result: number, rest: string];
 export declare function fromDigits(s: string, baseInput?: string | number): [result: number, rest: string];
-/**
- *
- * @param lhs
- * @param rhs
- * @returns the sign (-1, 0, 1) of the difference between `lhs` and `rhs`
- */
-export declare function signDiff(lhs: BoxedExpression, rhs: BoxedExpression, tolerance?: number): -1 | 0 | 1 | undefined;

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

@@ -1,2 +1,7 @@
-/* 0.24.0 */
+/* 0.25.0 */
+export declare const SMALL_PRIMES: Set<number>;
+export declare const LARGEST_SMALL_PRIME = 7919;
+export declare function primeFactors(n: number): {
+    [factor: number]: number;
+};
 export declare function isPrime(n: number): boolean | undefined;

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

@@ -1,4 +1,7 @@
-/* 0.24.0 */
+/* 0.25.0 */
+ * @category Boxed Expression
+ */
+export type Rational = [number, number] | [bigint, bigint];
 export declare function isRational(x: any | null): x is Rational;
 export declare function isMachineRational(x: any | null): x is [number, number];
 export declare function isBigRational(x: any | null): x is [bigint, bigint];
@@ -15,18 +18,6 @@ export declare function neg(x: Rational): Rational;
 export declare function inverse(x: [number, number]): [number, number];
 export declare function inverse(x: [bigint, bigint]): [bigint, bigint];
 export declare function inverse(x: Rational): Rational;
-export declare function asRational(expr: BoxedExpression): Rational | undefined;
-/**
- * Add a literal numeric value to a rational.
- * If the rational is a bigint, this is a hint to do the calculation in bigint
- * (no need to check `bignumPreferred()`).
- * @param lhs
- * @param rhs
- * @returns
- */
-export declare function add(lhs: Rational, rhs: BoxedExpression | Rational): Rational;
-export declare function mul(lhs: Rational, rhs: BoxedExpression | Rational): Rational;
-export declare function div(lhs: Rational, rhs: Rational): Rational;
 export declare function pow(r: Rational, exp: number): Rational;
 export declare function sqrt(r: Rational): Rational | undefined;
 export declare function reducedRational(r: [number, number]): [number, number];

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

@@ -1,4 +1,4 @@
-/* 0.24.0 */
+/* 0.25.0 */
 
     Translated from https://github.com/JuliaMath/Richardson.jl/blob/master/src/Richardson.jl
 

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

@@ -1,14 +1,17 @@
-/* 0.24.0 */
+/* 0.25.0 */
+import { Rational } from './rationals';
 export declare class Terms {
     private engine;
     private terms;
-    constructor(ce: IComputeEngine, terms: BoxedExpression[]);
+    constructor(ce: IComputeEngine, terms: ReadonlyArray<BoxedExpression>);
     sub(term: BoxedExpression): void;
     add(term2: BoxedExpression, coef2?: Rational): void;
     find(term: BoxedExpression): number;
     /** If `exact` is true, keep exact numbers */
-    reduceNumbers({ exact }?: {
+    reduceNumbers({ exact }: {
         exact: boolean;
     }): void;
-    asExpression(): BoxedExpression;
+    asExpression(options: {
+        exact: boolean;
+    }): BoxedExpression;
 }