@danielsimonjr/mathts-functions 0.2.3 → 0.2.5

package/dist/type/matrix/MatrixIndex.d.ts

@@ -0,0 +1,386 @@
+import type { IndexJSON, MatrixValue } from './types.js';
+/**
+ * Type representing a single dimension in an Index.
+ * Can be a number, string (for object properties), Range, or ImmutableDenseMatrix.
+ *
+ * INTENTIONAL structural type: Range is defined as a structural type rather than
+ * importing RangeInterface to avoid circular dependencies. The Range class is created
+ * in a separate factory and its interface matches this structural definition.
+ */
+export type IndexDimension = number | string | ImmutableDenseMatrix | {
+    size(): number[];
+    min(): number | undefined;
+    max(): number | undefined;
+    toArray(): number[];
+    toString(): string;
+};
+interface IndexClass {
+    _dimensions: IndexDimension[];
+    _sourceSize: (number | null)[];
+    _isScalar: boolean;
+}
+/**
+ * Callback function for Index forEach operations
+ */
+export type IndexForEachCallback = (dimension: IndexDimension, index: number, indexObject: IndexClass) => void;
+export type { IndexJSON };
+/**
+ * Interface for ImmutableDenseMatrix (used internally)
+ */
+interface ImmutableDenseMatrix {
+    _data: MatrixValue[];
+    _size: number[];
+    valueOf(): MatrixValue[];
+    size(): number[];
+    toArray(): MatrixValue[];
+}
+export declare const createIndexClass: import("../../utils/factory.js").FactoryFunction<any, {
+    new (...ranges: any[]): {
+        /**
+         * Type identifier
+         */
+        readonly type: string;
+        /**
+         * Index type flag
+         */
+        readonly isIndex: boolean;
+        /**
+         * Internal array of dimensions
+         * @internal
+         */
+        _dimensions: IndexDimension[];
+        /**
+         * Source sizes for boolean array conversions
+         * @internal
+         */
+        _sourceSize: (number | null)[];
+        /**
+         * Flag indicating if this index represents a scalar value
+         * @internal
+         */
+        _isScalar: boolean;
+        /**
+         * Create a clone of the index
+         * @memberof Index
+         * @return {Index} clone
+         */
+        clone(): /*elided*/ any;
+        /**
+         * Retrieve the size of the index, the number of elements for each dimension.
+         * @memberof Index
+         * @returns {number[]} size
+         */
+        size(): number[];
+        /**
+         * Get the maximum value for each of the indexes ranges.
+         * @memberof Index
+         * @returns {number[]} max
+         */
+        max(): (number | string | undefined)[];
+        /**
+         * Get the minimum value for each of the indexes ranges.
+         * @memberof Index
+         * @returns {number[]} min
+         */
+        min(): (number | string | undefined)[];
+        /**
+         * Loop over each of the ranges of the index
+         * @memberof Index
+         * @param {Function} callback Called for each range with a Range as first
+         *                            argument, the dimension as second, and the
+         *                            index object as third.
+         */
+        forEach(callback: IndexForEachCallback): void;
+        /**
+         * Retrieve the dimension for the given index
+         * @memberof Index
+         * @param {Number} dim Number of the dimension
+         * @returns {Range | null} range
+         */
+        dimension(dim: number): IndexDimension | null;
+        /**
+         * Test whether this index contains an object property
+         * @returns {boolean} Returns true if the index is an object property
+         */
+        isObjectProperty(): boolean;
+        /**
+         * Returns the object property name when the Index holds a single object property,
+         * else returns null
+         * @returns {string | null}
+         */
+        getObjectProperty(): string | null;
+        /**
+         * Test whether this index contains only a single value.
+         *
+         * This is the case when the index is created with only scalar values as ranges,
+         * not for ranges resolving into a single value.
+         * @memberof Index
+         * @return {boolean} isScalar
+         */
+        isScalar(): boolean;
+        /**
+         * Expand the Index into an array.
+         * For example new Index([0,3], [2,7]) returns [[0,1,2], [2,3,4,5,6]]
+         * @memberof Index
+         * @returns {Array} array
+         */
+        toArray(): any[];
+        /**
+         * Get the primitive value of the Index, a two dimensional array.
+         * Equivalent to Index.toArray().
+         * @memberof Index
+         * @returns {Array} array
+         */
+        valueOf(): any[];
+        /**
+         * Get the string representation of the index, for example '[2:6]' or '[0:2:10, 4:7, [1,2,3]]'
+         * @memberof Index
+         * @returns {String} str
+         */
+        toString(): string;
+        /**
+         * Get a JSON representation of the Index
+         * @memberof Index
+         * @returns {Object} Returns a JSON object structured as:
+         *                   `{"mathjs": "Index", "ranges": [{"mathjs": "Range", start: 0, end: 10, step:1}, ...]}`
+         */
+        toJSON(): IndexJSON;
+    };
+    /**
+     * Create an index from an array with ranges/numbers
+     * @memberof Index
+     * @param {Array.<Array | number>} ranges
+     * @return {Index} index
+     * @private
+     */
+    create(ranges: any[]): {
+        /**
+         * Type identifier
+         */
+        readonly type: string;
+        /**
+         * Index type flag
+         */
+        readonly isIndex: boolean;
+        /**
+         * Internal array of dimensions
+         * @internal
+         */
+        _dimensions: IndexDimension[];
+        /**
+         * Source sizes for boolean array conversions
+         * @internal
+         */
+        _sourceSize: (number | null)[];
+        /**
+         * Flag indicating if this index represents a scalar value
+         * @internal
+         */
+        _isScalar: boolean;
+        /**
+         * Create a clone of the index
+         * @memberof Index
+         * @return {Index} clone
+         */
+        clone(): /*elided*/ any;
+        /**
+         * Retrieve the size of the index, the number of elements for each dimension.
+         * @memberof Index
+         * @returns {number[]} size
+         */
+        size(): number[];
+        /**
+         * Get the maximum value for each of the indexes ranges.
+         * @memberof Index
+         * @returns {number[]} max
+         */
+        max(): (number | string | undefined)[];
+        /**
+         * Get the minimum value for each of the indexes ranges.
+         * @memberof Index
+         * @returns {number[]} min
+         */
+        min(): (number | string | undefined)[];
+        /**
+         * Loop over each of the ranges of the index
+         * @memberof Index
+         * @param {Function} callback Called for each range with a Range as first
+         *                            argument, the dimension as second, and the
+         *                            index object as third.
+         */
+        forEach(callback: IndexForEachCallback): void;
+        /**
+         * Retrieve the dimension for the given index
+         * @memberof Index
+         * @param {Number} dim Number of the dimension
+         * @returns {Range | null} range
+         */
+        dimension(dim: number): IndexDimension | null;
+        /**
+         * Test whether this index contains an object property
+         * @returns {boolean} Returns true if the index is an object property
+         */
+        isObjectProperty(): boolean;
+        /**
+         * Returns the object property name when the Index holds a single object property,
+         * else returns null
+         * @returns {string | null}
+         */
+        getObjectProperty(): string | null;
+        /**
+         * Test whether this index contains only a single value.
+         *
+         * This is the case when the index is created with only scalar values as ranges,
+         * not for ranges resolving into a single value.
+         * @memberof Index
+         * @return {boolean} isScalar
+         */
+        isScalar(): boolean;
+        /**
+         * Expand the Index into an array.
+         * For example new Index([0,3], [2,7]) returns [[0,1,2], [2,3,4,5,6]]
+         * @memberof Index
+         * @returns {Array} array
+         */
+        toArray(): any[];
+        /**
+         * Get the primitive value of the Index, a two dimensional array.
+         * Equivalent to Index.toArray().
+         * @memberof Index
+         * @returns {Array} array
+         */
+        valueOf(): any[];
+        /**
+         * Get the string representation of the index, for example '[2:6]' or '[0:2:10, 4:7, [1,2,3]]'
+         * @memberof Index
+         * @returns {String} str
+         */
+        toString(): string;
+        /**
+         * Get a JSON representation of the Index
+         * @memberof Index
+         * @returns {Object} Returns a JSON object structured as:
+         *                   `{"mathjs": "Index", "ranges": [{"mathjs": "Range", start: 0, end: 10, step:1}, ...]}`
+         */
+        toJSON(): IndexJSON;
+    };
+    /**
+     * Instantiate an Index from a JSON object
+     * @memberof Index
+     * @param {Object} json A JSON object structured as:
+     *                     `{"mathjs": "Index", "dimensions": [{"mathjs": "Range", start: 0, end: 10, step:1}, ...]}`
+     * @return {Index}
+     */
+    fromJSON(json: IndexJSON): {
+        /**
+         * Type identifier
+         */
+        readonly type: string;
+        /**
+         * Index type flag
+         */
+        readonly isIndex: boolean;
+        /**
+         * Internal array of dimensions
+         * @internal
+         */
+        _dimensions: IndexDimension[];
+        /**
+         * Source sizes for boolean array conversions
+         * @internal
+         */
+        _sourceSize: (number | null)[];
+        /**
+         * Flag indicating if this index represents a scalar value
+         * @internal
+         */
+        _isScalar: boolean;
+        /**
+         * Create a clone of the index
+         * @memberof Index
+         * @return {Index} clone
+         */
+        clone(): /*elided*/ any;
+        /**
+         * Retrieve the size of the index, the number of elements for each dimension.
+         * @memberof Index
+         * @returns {number[]} size
+         */
+        size(): number[];
+        /**
+         * Get the maximum value for each of the indexes ranges.
+         * @memberof Index
+         * @returns {number[]} max
+         */
+        max(): (number | string | undefined)[];
+        /**
+         * Get the minimum value for each of the indexes ranges.
+         * @memberof Index
+         * @returns {number[]} min
+         */
+        min(): (number | string | undefined)[];
+        /**
+         * Loop over each of the ranges of the index
+         * @memberof Index
+         * @param {Function} callback Called for each range with a Range as first
+         *                            argument, the dimension as second, and the
+         *                            index object as third.
+         */
+        forEach(callback: IndexForEachCallback): void;
+        /**
+         * Retrieve the dimension for the given index
+         * @memberof Index
+         * @param {Number} dim Number of the dimension
+         * @returns {Range | null} range
+         */
+        dimension(dim: number): IndexDimension | null;
+        /**
+         * Test whether this index contains an object property
+         * @returns {boolean} Returns true if the index is an object property
+         */
+        isObjectProperty(): boolean;
+        /**
+         * Returns the object property name when the Index holds a single object property,
+         * else returns null
+         * @returns {string | null}
+         */
+        getObjectProperty(): string | null;
+        /**
+         * Test whether this index contains only a single value.
+         *
+         * This is the case when the index is created with only scalar values as ranges,
+         * not for ranges resolving into a single value.
+         * @memberof Index
+         * @return {boolean} isScalar
+         */
+        isScalar(): boolean;
+        /**
+         * Expand the Index into an array.
+         * For example new Index([0,3], [2,7]) returns [[0,1,2], [2,3,4,5,6]]
+         * @memberof Index
+         * @returns {Array} array
+         */
+        toArray(): any[];
+        /**
+         * Get the primitive value of the Index, a two dimensional array.
+         * Equivalent to Index.toArray().
+         * @memberof Index
+         * @returns {Array} array
+         */
+        valueOf(): any[];
+        /**
+         * Get the string representation of the index, for example '[2:6]' or '[0:2:10, 4:7, [1,2,3]]'
+         * @memberof Index
+         * @returns {String} str
+         */
+        toString(): string;
+        /**
+         * Get a JSON representation of the Index
+         * @memberof Index
+         * @returns {Object} Returns a JSON object structured as:
+         *                   `{"mathjs": "Index", "ranges": [{"mathjs": "Range", start: 0, end: 10, step:1}, ...]}`
+         */
+        toJSON(): IndexJSON;
+    };
+}>;
+//# sourceMappingURL=MatrixIndex.d.ts.map

package/dist/type/matrix/MatrixIndex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MatrixIndex.d.ts","sourceRoot":"","sources":["../../../src/type/matrix/MatrixIndex.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAkB,WAAW,EAAE,MAAM,YAAY,CAAC;AAKzE;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,MAAM,GACN,oBAAoB,GACpB;IACE,IAAI,IAAI,MAAM,EAAE,CAAC;IACjB,GAAG,IAAI,MAAM,GAAG,SAAS,CAAC;IAC1B,GAAG,IAAI,MAAM,GAAG,SAAS,CAAC;IAC1B,OAAO,IAAI,MAAM,EAAE,CAAC;IACpB,QAAQ,IAAI,MAAM,CAAC;CACpB,CAAC;AAIN,UAAU,UAAU;IAClB,WAAW,EAAE,cAAc,EAAE,CAAC;IAC9B,WAAW,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;IAC/B,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,SAAS,EAAE,cAAc,EACzB,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,UAAU,KACpB,IAAI,CAAC;AAGV,YAAY,EAAE,SAAS,EAAE,CAAC;AAE1B;;GAEG;AACH,UAAU,oBAAoB;IAC5B,KAAK,EAAE,WAAW,EAAE,CAAC;IACrB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,IAAI,WAAW,EAAE,CAAC;IACzB,IAAI,IAAI,MAAM,EAAE,CAAC;IACjB,OAAO,IAAI,WAAW,EAAE,CAAC;CAC1B;AAED,eAAO,MAAM,gBAAgB;oBAwEA,GAAG,EAAE;QA5B5B;;WAEG;uBACY,MAAM;QAErB;;WAEG;0BACe,OAAO;QAEzB;;;WAGG;qBACU,cAAc,EAAE;QAE7B;;;WAGG;qBACU,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE;QAE9B;;;WAGG;mBACQ,OAAO;QAsDlB;;;;WAIG;;QAoBH;;;;WAIG;gBACK,MAAM,EAAE;QAYhB;;;;WAIG;eACI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,EAAE;QActC;;;;WAIG;eACI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,EAAE;QActC;;;;;;WAMG;0BACe,oBAAoB,GAAG,IAAI;QAM7C;;;;;WAKG;uBACY,MAAM,GAAG,cAAc,GAAG,IAAI;QAQ7C;;;WAGG;4BACiB,OAAO;QAI3B;;;;WAIG;6BACkB,MAAM,GAAG,IAAI;QAIlC;;;;;;;WAOG;oBACS,OAAO;QAInB;;;;;WAKG;mBACQ,GAAG,EAAE;QAahB;;;;;WAKG;mBACQ,GAAG,EAAE;QAIhB;;;;WAIG;oBACS,MAAM;QAelB;;;;;WAKG;kBACO,SAAS;;IAjLnB;;;;;;OAMG;mBACmB,GAAG,EAAE;QApG3B;;WAEG;uBACY,MAAM;QAErB;;WAEG;0BACe,OAAO;QAEzB;;;WAGG;qBACU,cAAc,EAAE;QAE7B;;;WAGG;qBACU,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE;QAE9B;;;WAGG;mBACQ,OAAO;QAsDlB;;;;WAIG;;QAoBH;;;;WAIG;gBACK,MAAM,EAAE;QAYhB;;;;WAIG;eACI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,EAAE;QActC;;;;WAIG;eACI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,EAAE;QActC;;;;;;WAMG;0BACe,oBAAoB,GAAG,IAAI;QAM7C;;;;;WAKG;uBACY,MAAM,GAAG,cAAc,GAAG,IAAI;QAQ7C;;;WAGG;4BACiB,OAAO;QAI3B;;;;WAIG;6BACkB,MAAM,GAAG,IAAI;QAIlC;;;;;;;WAOG;oBACS,OAAO;QAInB;;;;;WAKG;mBACQ,GAAG,EAAE;QAahB;;;;;WAKG;mBACQ,GAAG,EAAE;QAIhB;;;;WAIG;oBACS,MAAM;QAelB;;;;;WAKG;kBACO,SAAS;;IAOnB;;;;;;OAMG;mBACmB,SAAS;QA5R/B;;WAEG;uBACY,MAAM;QAErB;;WAEG;0BACe,OAAO;QAEzB;;;WAGG;qBACU,cAAc,EAAE;QAE7B;;;WAGG;qBACU,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE;QAE9B;;;WAGG;mBACQ,OAAO;QAsDlB;;;;WAIG;;QAoBH;;;;WAIG;gBACK,MAAM,EAAE;QAYhB;;;;WAIG;eACI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,EAAE;QActC;;;;WAIG;eACI,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,EAAE;QActC;;;;;;WAMG;0BACe,oBAAoB,GAAG,IAAI;QAM7C;;;;;WAKG;uBACY,MAAM,GAAG,cAAc,GAAG,IAAI;QAQ7C;;;WAGG;4BACiB,OAAO;QAI3B;;;;WAIG;6BACkB,MAAM,GAAG,IAAI;QAIlC;;;;;;;WAOG;oBACS,OAAO;QAInB;;;;;WAKG;mBACQ,GAAG,EAAE;QAahB;;;;;WAKG;mBACQ,GAAG,EAAE;QAIhB;;;;WAIG;oBACS,MAAM;QAelB;;;;;WAKG;kBACO,SAAS;;EA2BxB,CAAC"}

package/dist/type/matrix/Spa.d.ts

@@ -0,0 +1,40 @@
+import type { FibonacciHeapNode, FibonacciHeapInterface, MatrixValue, EqualScalarFunction } from './types.js';
+/**
+ * Value type for Spa elements.
+ * Uses MatrixValue to represent any numeric type (number, BigNumber, Complex, etc.)
+ */
+type SpaValue = MatrixValue;
+/**
+ * Add scalar function type
+ * INTENTIONAL ANY: typed-function resolves the actual types at runtime.
+ */
+type AddScalarFunction = (a: MatrixValue, b: MatrixValue) => MatrixValue;
+/**
+ * Dependencies for Spa factory
+ */
+interface SpaDependencies {
+    addScalar: AddScalarFunction;
+    equalScalar: EqualScalarFunction;
+    FibonacciHeap: new () => FibonacciHeapInterface<SpaValue>;
+}
+export declare const createSpaClass: import("../../utils/factory.js").FactoryFunction<SpaDependencies, {
+    new (): {
+        type: string;
+        isSpa: boolean;
+        _values: (FibonacciHeapNode<SpaValue> | undefined)[];
+        _heap: FibonacciHeapInterface<SpaValue>;
+        /**
+         * Set the value for index i.
+         *
+         * @param {number} i                       The index
+         * @param {number | BigNumber | Complex}   The value at index i
+         */
+        set(i: number, v: SpaValue): void;
+        get(i: number): SpaValue;
+        accumulate(i: number, v: SpaValue): void;
+        forEach(from: number, to: number, callback: (key: number, value: SpaValue, spa: /*elided*/ any) => void): void;
+        swap(i: number, j: number): void;
+    };
+}>;
+export {};
+//# sourceMappingURL=Spa.d.ts.map

package/dist/type/matrix/Spa.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Spa.d.ts","sourceRoot":"","sources":["../../../src/type/matrix/Spa.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,iBAAiB,EACjB,sBAAsB,EACtB,WAAW,EACX,mBAAmB,EACpB,MAAM,YAAY,CAAC;AAKpB;;;GAGG;AACH,KAAK,QAAQ,GAAG,WAAW,CAAC;AAE5B;;;GAGG;AACH,KAAK,iBAAiB,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,KAAK,WAAW,CAAC;AAEzE;;GAEG;AACH,UAAU,eAAe;IACvB,SAAS,EAAE,iBAAiB,CAAC;IAC7B,WAAW,EAAE,mBAAmB,CAAC;IACjC,aAAa,EAAE,UAAU,sBAAsB,CAAC,QAAQ,CAAC,CAAC;CAC3D;AAED,eAAO,MAAM,cAAc;;cAUf,MAAM;eACL,OAAO;iBACL,CAAC,iBAAiB,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,EAAE;eAC7C,sBAAsB,CAAC,QAAQ,CAAC;QAQvC;;;;;WAKG;eACI,MAAM,KAAK,QAAQ,GAAG,IAAI;eAa1B,MAAM,GAAG,QAAQ;sBAQV,MAAM,KAAK,QAAQ,GAAG,IAAI;sBAehC,MAAM,MACR,MAAM,YACA,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,gBAAK,KAAK,IAAI,GACzD,IAAI;gBAsCC,MAAM,KAAK,MAAM,GAAG,IAAI;;EAiCrC,CAAC"}

package/dist/type/matrix/function/index.d.ts

@@ -0,0 +1,11 @@
+import type { TypedFunction } from '../../../core/function/typed.js';
+interface IndexConstructor {
+    new (...ranges: any[]): any;
+}
+interface IndexDependencies {
+    typed: TypedFunction;
+    Index: IndexConstructor;
+}
+export declare const createIndex: import("../../../utils/factory.js").FactoryFunction<IndexDependencies, unknown>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/type/matrix/function/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/type/matrix/function/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAErE,UAAU,gBAAgB;IACxB,KAAK,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;CAC7B;AAED,UAAU,iBAAiB;IACzB,KAAK,EAAE,aAAa,CAAC;IACrB,KAAK,EAAE,gBAAgB,CAAC;CACzB;AAKD,eAAO,MAAM,WAAW,iFA0DvB,CAAC"}