@cortex-js/compute-engine 0.27.0 → 0.29.0

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

@@ -1,8 +1,4 @@
-/* 0.27.0 */
-/**
- * @category Boxed Expression
- */
-export type Rational = [SmallInteger, SmallInteger] | [bigint, bigint];
+/* 0.29.0 */
 export declare function isRational(x: any | null): x is Rational;
 export declare function isMachineRational(x: any | null): x is [SmallInteger, SmallInteger];
 export declare function isBigRational(x: any | null): x is [bigint, bigint];

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

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

package/dist/types/compute-engine/numerics/special-functions.d.ts

@@ -1,5 +1,5 @@
-/* 0.27.0 */
-import { BigNum } from './bignum';
+/* 0.29.0 */
+import type { BigNum } from './types';
 export declare function gammaln(z: number): number;
 export declare function gamma(z: number): number;
 /**
@@ -24,5 +24,5 @@ export declare function erfc(x: number): number;
  * - NIST: https://dlmf.nist.gov/7.24#i
  */
 export declare function erf(x: number): number;
-export declare function bigGammaln(ce: IComputeEngine, z: BigNum): BigNum;
-export declare function bigGamma(ce: IComputeEngine, z: BigNum): BigNum;
+export declare function bigGammaln(ce: ComputeEngine, z: BigNum): BigNum;
+export declare function bigGamma(ce: ComputeEngine, z: BigNum): BigNum;

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

@@ -1,5 +1,5 @@
-/* 0.27.0 */
-import { BigNum } from './bignum';
+/* 0.29.0 */
+import type { BigNum } from './types';
 export declare function mean(values: Iterable<number>): number;
 export declare function bigMean(bignum: BigNumFactory, values: Iterable<BigNum>): BigNum;
 export declare function median(values: Iterable<number>): number;

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

@@ -1,2 +1,2 @@
-/* 0.27.0 */
+/* 0.29.0 */
 export declare function numberToString(num: number | bigint, fractionalDigits?: number | string): string;

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

@@ -0,0 +1,30 @@
+/* 0.29.0 */
+type IsInteger<N extends number> = `${N}` extends `${string}.${string}` ? never : `${N}` extends `-${string}.${string}` ? never : number;
+/** A `SmallInteger` is an integer < 1e6
+ * @category Numerics
+ */
+export type SmallInteger = IsInteger<number>;
+/**
+ * A rational number is a number that can be expressed as the quotient or fraction p/q of two integers,
+ * a numerator p and a non-zero denominator q.
+ *
+ * A rational can either be represented as a pair of small integers or
+ * a pair of big integers.
+ *
+ * @category Numerics
+ */
+export type Rational = [SmallInteger, SmallInteger] | [bigint, bigint];
+/** @category Numerics */
+export type BigNum = Decimal;
+/** @category Numerics */
+export interface IBigNum {
+    readonly _BIGNUM_NAN: BigNum;
+    readonly _BIGNUM_ZERO: BigNum;
+    readonly _BIGNUM_ONE: BigNum;
+    readonly _BIGNUM_TWO: BigNum;
+    readonly _BIGNUM_HALF: BigNum;
+    readonly _BIGNUM_PI: BigNum;
+    readonly _BIGNUM_NEGATIVE_ONE: BigNum;
+    bignum(value: string | number | bigint | BigNum): BigNum;
+}
+export {};

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

@@ -1,4 +1,4 @@
-/* 0.27.0 */
+/* 0.29.0 */
 /**
  *
  * @param fn The function to differentiate, a `["Function"]` expression or

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

@@ -1,4 +1,4 @@
-/* 0.27.0 */
+/* 0.29.0 */
 /**
  *
  */

package/dist/types/compute-engine/symbolic/simplify-rules.d.ts

@@ -1,4 +1,4 @@
-/* 0.27.0 */
+/* 0.29.0 */
 /**
  * @todo: a set to "tidy" an expression. Different from a canonical form, but
  * inline with the user's expectations.

package/dist/types/compute-engine/{boxed-expression → tensor}/tensor-fields.d.ts

@@ -1,18 +1,8 @@
-/* 0.27.0 */
-import type { BoxedExpression, IComputeEngine } from '../public';
-export type DataTypeMap = {
-    float64: number;
-    float32: number;
-    int32: number;
-    uint8: number;
-    complex128: Complex;
-    complex64: Complex;
-    bool: boolean;
-    string: string;
-    expression: BoxedExpression;
-};
-export type TensorDataType = keyof DataTypeMap;
-export declare function makeTensorField<DT extends keyof DataTypeMap>(ce: IComputeEngine, dtype: DT): TensorField<DataTypeMap[DT]>;
+/* 0.29.0 */
+import { BoxedExpression, ComputeEngine, DataTypeMap, TensorDataType } from '../global-types';
+/** @category Tensors */
+export declare function makeTensorField<DT extends keyof DataTypeMap>(ce: ComputeEngine, dtype: DT): TensorField<DataTypeMap[DT]>;
+/** @category Tensors */
 export interface TensorField<T extends number | Complex | BoxedExpression | boolean | string = number> {
     readonly one: T;
     readonly zero: T;
@@ -50,12 +40,13 @@ export interface TensorField<T extends number | Complex | BoxedExpression | bool
     pow(rhs: T, n: number): T;
     conjugate(x: T): T;
 }
+/** @category Tensors */
 export declare class TensorFieldNumber implements TensorField<number> {
     private ce;
     one: number;
     zero: number;
     nan: number;
-    constructor(ce: IComputeEngine);
+    constructor(ce: ComputeEngine);
     cast(x: number, dtype: 'float64'): undefined | number;
     cast(x: number, dtype: 'float32'): undefined | number;
     cast(x: number, dtype: 'int32'): undefined | number;
@@ -88,12 +79,13 @@ export declare class TensorFieldNumber implements TensorField<number> {
     pow(lhs: number, rhs: number): number;
     conjugate(x: number): number;
 }
+/** @category Tensors */
 export declare class TensorFieldExpression implements TensorField<BoxedExpression> {
     one: BoxedExpression;
     zero: BoxedExpression;
     nan: BoxedExpression;
     private ce;
-    constructor(ce: IComputeEngine);
+    constructor(ce: ComputeEngine);
     cast(x: BoxedExpression, dtype: 'float64'): undefined | number;
     cast(x: BoxedExpression, dtype: 'float32'): undefined | number;
     cast(x: BoxedExpression, dtype: 'int32'): undefined | number;
@@ -126,12 +118,13 @@ export declare class TensorFieldExpression implements TensorField<BoxedExpressio
     pow(lhs: BoxedExpression, rhs: number): BoxedExpression;
     conjugate(x: BoxedExpression): BoxedExpression;
 }
+/** @category Tensors */
 export declare class TensorFieldComplex implements TensorField<Complex> {
     one: Complex;
     zero: Complex;
     nan: Complex;
     private ce;
-    constructor(ce: IComputeEngine);
+    constructor(ce: ComputeEngine);
     cast(x: Complex, dtype: 'float64'): undefined | number;
     cast(x: Complex, dtype: 'float32'): undefined | number;
     cast(x: Complex, dtype: 'int32'): undefined | number;
@@ -164,5 +157,13 @@ export declare class TensorFieldComplex implements TensorField<Complex> {
     pow(lhs: Complex, rhs: number): Complex;
     conjugate(z: Complex): Complex;
 }
+/**
+ * @category Tensors
+ * @internal
+ */
 export declare function getSupertype(t1: TensorDataType | undefined, t2: TensorDataType): TensorDataType;
+/**
+ * @category Tensors
+ * @internal
+ */
 export declare function getExpressionDatatype(expr: BoxedExpression): TensorDataType;

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

@@ -1,15 +1,10 @@
-/* 0.27.0 */
-import { DataTypeMap, TensorDataType, TensorField } from '../boxed-expression/tensor-fields';
-/**
- * @noInheritDoc
- */
-export interface TensorData<DT extends keyof DataTypeMap = 'float64'> {
-    dtype: DT;
-    shape: number[];
-    data: DataTypeMap[DT][];
-}
+/* 0.29.0 */
+import type { BoxedExpression, ComputeEngine, DataTypeMap, TensorData, TensorDataType } from '../global-types';
+/** @internal */
 export type NestedArray<T> = NestedArray_<T>[];
+/** @internal */
 export type NestedArray_<T> = T | NestedArray_<T>[];
+/** @category Tensors */
 export declare abstract class AbstractTensor<DT extends keyof DataTypeMap> implements TensorData<DT> {
     private ce;
     /**
@@ -40,7 +35,7 @@ export declare abstract class AbstractTensor<DT extends keyof DataTypeMap> imple
     readonly shape: number[];
     readonly rank: number;
     private readonly _strides;
-    constructor(ce: IComputeEngine, tensorData: TensorData<DT>);
+    constructor(ce: ComputeEngine, tensorData: TensorData<DT>);
     abstract get dtype(): DT;
     abstract get data(): DataTypeMap[DT][];
     get expression(): BoxedExpression;
@@ -98,9 +93,11 @@ export declare abstract class AbstractTensor<DT extends keyof DataTypeMap> imple
     power(rhs: AbstractTensor<DT> | DataTypeMap[DT]): AbstractTensor<DT>;
     equals(rhs: AbstractTensor<DT>): boolean;
 }
-export declare function makeTensor<T extends TensorDataType>(ce: IComputeEngine, data: TensorData<T> | {
+/** @category Tensors */
+export declare function makeTensor<T extends TensorDataType>(ce: ComputeEngine, data: TensorData<T> | {
     operator: string;
     ops: BoxedExpression[];
     dtype: T;
     shape: number[];
 }): AbstractTensor<T>;
+export { TensorData };

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

@@ -0,0 +1,11 @@
+/* 0.29.0 */
+export * from '../math-json/types';
+export * from '../common/type/boxed-type';
+export * from '../common/type/types';
+export type { LatexString, SerializeLatexOptions, NumberSerializationFormat, DelimiterScale, NumberFormat, } from './latex-syntax/types';
+export * from './latex-syntax/dictionary/definitions';
+export * from './numerics/types';
+export * from './numeric-value/types';
+export * from './tensor/tensors';
+export * from './tensor/tensor-fields';
+export * from './global-types';

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

@@ -1,5 +1,3 @@
-/* 0.27.0 */
-export declare const version = "0.27.0";
-export { ComputeEngine } from './compute-engine/compute-engine';
-export { terminal } from './common/terminal';
-export { highlightCodeSpan, highlightCodeBlock, } from './common/syntax-highlighter';
+/* 0.29.0 */
+export { ComputeEngine } from './compute-engine/index';
+export * from './compute-engine/types';

package/dist/types/math-json/identifiers.d.ts

@@ -1,4 +1,4 @@
-/* 0.27.0 */
+/* 0.29.0 */
  * Return true if the string is a valid identifier.
  *
  * Check for identifiers matching a profile of [Unicode UAX31](https://unicode.org/reports/tr31/)

package/dist/types/math-json/types.d.ts

@@ -1,6 +1,5 @@
-/* 0.27.0 */
-/** @category MathJSON */
-export type Attributes = {
+/* 0.29.0 */
+export type MathJsonAttributes = {
     /** A human readable string to annotate this expression, since JSON does not
      * allow comments in its encoding */
     comment?: string;
@@ -85,19 +84,22 @@ export type MathJsonIdentifier = string;
  */
 export type MathJsonNumber = {
     num: 'NaN' | '-Infinity' | '+Infinity' | string;
-} & Attributes;
+} & MathJsonAttributes;
 /** @category MathJSON */
 export type MathJsonSymbol = {
     sym: MathJsonIdentifier;
-} & Attributes;
+} & MathJsonAttributes;
 /** @category MathJSON */
 export type MathJsonString = {
     str: string;
-} & Attributes;
+} & MathJsonAttributes;
 /** @category MathJSON */
 export type MathJsonFunction = {
     fn: [MathJsonIdentifier, ...Expression[]];
-} & Attributes;
+} & MathJsonAttributes;
+/**
+ * @category MathJSON
+ */
 export type ExpressionObject = MathJsonNumber | MathJsonString | MathJsonSymbol | MathJsonFunction;
 /**
  * A MathJSON expression is a recursive data structure.

package/dist/types/math-json/utils.d.ts

@@ -1,4 +1,4 @@
-/* 0.27.0 */
+/* 0.29.0 */
 export declare const MISSING: Expression;
 export declare function isNumberExpression(expr: Expression | null): expr is number | string | MathJsonNumber;
 export declare function isNumberObject(expr: Expression | null): expr is MathJsonNumber;
@@ -31,8 +31,8 @@ export declare function operand(expr: Expression | null, n: 1 | 2 | 3): Expressi
 export declare function nops(expr: Expression | null | undefined): number;
 export declare function unhold(expr: Expression | null): Expression | null;
 export declare function symbol(expr: Expression | null | undefined): string | null;
-export declare function dictionary(expr: Expression | null): null | Record<string, Expression>;
-export declare function dictionaryFrom(dict: Record<string, Expression>): Expression;
+export declare function dictionaryFromExpression(expr: Expression | null): null | Record<string, Expression>;
+export declare function dictionaryFromEntries(dict: Record<string, Expression>): Expression;
 /**
  *  CAUTION: `machineValue()` will return a truncated value if the number
  *  has a precision outside of the machine range.

package/dist/types/math-json.d.ts

@@ -1,3 +1,3 @@
-/* 0.27.0 */
-export { isSymbolObject, isStringObject, isFunctionObject, stringValue as getStringValue, operator, operand, symbol, mapArgs, dictionary as getDictionary, } from './math-json/utils';
-export declare const version = "0.27.0";
+/* 0.29.0 */
+export { isSymbolObject, isStringObject, isFunctionObject, stringValue, operator, operand, symbol, mapArgs, dictionaryFromExpression, } from './math-json/utils';
+export declare const version = "0.29.0";

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.27.0",
+  "version": "0.29.0",
   "scripts": {
     "doc": "bash ./scripts/doc.sh",
     "build": "bash ./scripts/build.sh",
@@ -43,17 +43,17 @@
   "exports": {
     ".": {
       "types": "./dist/types/compute-engine.d.ts",
-      "require": "./dist/compute-engine.min.js",
+      "require": "./dist/compute-engine.min.cjs",
       "import": "./dist/compute-engine.min.esm.js",
-      "default": "./dist/compute-engine.min.js"
+      "default": "./dist/compute-engine.min.cjs"
     }
   },
-  "main": "./dist/compute-engine.min.js",
+  "main": "./dist/compute-engine.min.cjs",
   "module": "./dist/compute-engine.min.esm.js",
   "types": "./dist/types/compute-engine.d.ts",
   "engines": {
-    "npm": ">=8.5.0",
-    "node": ">=16.14.2"
+    "npm": ">=10.5.0",
+    "node": ">=21.7.3"
   },
   "devDependencies": {
     "@cortex-js/prettier-config": "^1.2.0",
@@ -80,9 +80,9 @@
     "serve-http": "^1.0.7",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.26.2",
-    "typedoc-plugin-markdown": "^4.0.0-next.53",
-    "typedoc-plugin-no-inherit": "^1.4.0",
+    "typedoc": "^0.27.6",
+    "typedoc-plugin-markdown": "^4.4.1",
+    "typedoc-plugin-no-inherit": "^1.5.0",
     "typescript": "^5.2.2",
     "update-notifier": "^7.0.0"
   },