@danielsimonjr/mathts-functions 0.2.3 → 0.2.4

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

@@ -0,0 +1,282 @@
+import type { DenseMatrixData, DataType, MatrixValue, IndexInterface, ImmutableDenseMatrixJSON, ImmutableDenseMatrixConstructorData } from './types.js';
+export type { ImmutableDenseMatrixJSON };
+/**
+ * Interface for Index objects (local copy to avoid circular deps)
+ */
+interface Index extends IndexInterface {
+    isIndex: true;
+}
+/**
+ * Interface for DenseMatrix (local copy to avoid circular deps)
+ */
+interface _DenseMatrix {
+    type: string;
+    isDenseMatrix: boolean;
+    _data: DenseMatrixData;
+    _size: number[];
+    _datatype?: DataType;
+    storage(): string;
+    datatype(): DataType;
+    size(): number[];
+    clone(): _DenseMatrix;
+    toArray(): DenseMatrixData;
+    valueOf(): DenseMatrixData;
+    subset(index: Index, replacement?: DenseMatrixData | _DenseMatrix | MatrixValue, defaultValue?: MatrixValue): _DenseMatrix | MatrixValue;
+    forEach(callback: (value: MatrixValue, index?: number[], matrix?: _DenseMatrix) => void): void;
+}
+/**
+ * Comparison function type.
+ * INTENTIONAL ANY: typed-function resolves actual types at runtime.
+ */
+type CompareFunction = (a: MatrixValue, b: MatrixValue) => boolean;
+/**
+ * Dependencies for ImmutableDenseMatrix factory
+ */
+interface ImmutableDenseMatrixDependencies {
+    smaller: CompareFunction;
+    DenseMatrix: new (data?: DenseMatrixData | ImmutableDenseMatrixConstructorData, datatype?: DataType) => _DenseMatrix;
+}
+export declare const createImmutableDenseMatrixClass: import("../../utils/factory.js").FactoryFunction<ImmutableDenseMatrixDependencies, {
+    new (data?: DenseMatrixData | ImmutableDenseMatrixConstructorData | null, datatype?: DataType): {
+        /**
+         * Type identifier
+         */
+        readonly type: string;
+        /**
+         * ImmutableDenseMatrix type flag
+         */
+        readonly isImmutableDenseMatrix: boolean;
+        /**
+         * Internal matrix data storage
+         */
+        _data: DenseMatrixData;
+        /**
+         * Size of the matrix
+         */
+        _size: number[];
+        /**
+         * Data type of matrix elements
+         */
+        _datatype?: DataType;
+        /**
+         * Cached minimum value
+         * @template T - The element type (inferred from matrix data)
+         */
+        _min: MatrixValue | null;
+        /**
+         * Cached maximum value
+         * @template T - The element type (inferred from matrix data)
+         */
+        _max: MatrixValue | null;
+        /**
+         * Get a subset of the matrix, or replace a subset of the matrix.
+         *
+         * Usage:
+         *     const subset = matrix.subset(index)               // retrieve subset
+         *     const value = matrix.subset(index, replacement)   // replace subset
+         *
+         * @param {Index} index
+         * @param {Array | ImmutableDenseMatrix | MatrixValue} [replacement]
+         * @param {MatrixValue} [defaultValue=0] Default value, filled in on new entries when
+         *                             the matrix is resized. If not provided,
+         *                             new matrix elements will be filled with zeros.
+         */
+        subset(index: Index, _replacement?: DenseMatrixData | /*elided*/ any | MatrixValue, _defaultValue?: MatrixValue): /*elided*/ any | MatrixValue;
+        /**
+         * Replace a single element in the matrix.
+         * @param {Number[]} index Zero-based index
+         * @param {MatrixValue} value
+         * @param {MatrixValue} [defaultValue] Default value, filled in on new entries when
+         *                           the matrix is resized. If not provided,
+         *                           new matrix elements will be left undefined.
+         * @return {ImmutableDenseMatrix} self
+         */
+        set(_index: number[], _value: MatrixValue, _defaultValue?: MatrixValue): /*elided*/ any;
+        /**
+         * Resize the matrix to the given size. Returns a copy of the matrix when
+         * `copy=true`, otherwise return the matrix itself (resize in place).
+         *
+         * @param {Number[]} size The new size the matrix should have.
+         * @param {MatrixValue} [defaultValue=0] Default value, filled in on new entries.
+         *                             If not provided, the matrix elements will
+         *                             be filled with zeros.
+         * @param {boolean} [copy] Return a resized copy of the matrix
+         *
+         * @return {ImmutableDenseMatrix} The resized matrix
+         */
+        resize(_size: number[], _defaultValue?: MatrixValue, _copy?: boolean): /*elided*/ any;
+        /**
+         * Disallows reshaping in favor of immutability.
+         *
+         * @throws {Error} Operation not allowed
+         */
+        reshape(_size: number[], _copy?: boolean): /*elided*/ any;
+        /**
+         * Create a clone of the matrix
+         * @return {ImmutableDenseMatrix} clone
+         */
+        clone(): /*elided*/ any;
+        /**
+         * Get a JSON representation of the matrix.
+         *
+         * Note: min and max are intentionally excluded from the JSON output
+         * because they are computed lazily and caching them in JSON serialization
+         * would not be useful (they would need to be recomputed on deserialization
+         * anyway if the matrix data changed).
+         *
+         * @returns {ImmutableDenseMatrixJSON}
+         */
+        toJSON(): ImmutableDenseMatrixJSON;
+        /**
+         * Swap rows i and j in Matrix.
+         *
+         * @param {Number} i Matrix row index 1
+         * @param {Number} j Matrix row index 2
+         *
+         * @return {Matrix} The matrix reference
+         */
+        swapRows(_i: number, _j: number): /*elided*/ any;
+        /**
+         * Calculate the minimum value in the set
+         * @return {MatrixValue | undefined} min
+         */
+        min(): MatrixValue | undefined;
+        /**
+         * Calculate the maximum value in the set
+         * @return {MatrixValue | undefined} max
+         */
+        max(): MatrixValue | undefined;
+        isDenseMatrix: boolean;
+        storage(): string;
+        datatype(): DataType;
+        size(): number[];
+        toArray(): DenseMatrixData;
+        valueOf(): DenseMatrixData;
+        forEach(callback: (value: MatrixValue, index?: number[], matrix?: _DenseMatrix) => void): void;
+    };
+    /**
+     * Generate a matrix from a JSON object
+     * @param {Object} json An object structured like
+     *                      `{"mathjs": "ImmutableDenseMatrix", data: [], size: []}`,
+     *                      where mathjs is optional
+     * @returns {ImmutableDenseMatrix}
+     */
+    fromJSON(json: ImmutableDenseMatrixJSON): {
+        /**
+         * Type identifier
+         */
+        readonly type: string;
+        /**
+         * ImmutableDenseMatrix type flag
+         */
+        readonly isImmutableDenseMatrix: boolean;
+        /**
+         * Internal matrix data storage
+         */
+        _data: DenseMatrixData;
+        /**
+         * Size of the matrix
+         */
+        _size: number[];
+        /**
+         * Data type of matrix elements
+         */
+        _datatype?: DataType;
+        /**
+         * Cached minimum value
+         * @template T - The element type (inferred from matrix data)
+         */
+        _min: MatrixValue | null;
+        /**
+         * Cached maximum value
+         * @template T - The element type (inferred from matrix data)
+         */
+        _max: MatrixValue | null;
+        /**
+         * Get a subset of the matrix, or replace a subset of the matrix.
+         *
+         * Usage:
+         *     const subset = matrix.subset(index)               // retrieve subset
+         *     const value = matrix.subset(index, replacement)   // replace subset
+         *
+         * @param {Index} index
+         * @param {Array | ImmutableDenseMatrix | MatrixValue} [replacement]
+         * @param {MatrixValue} [defaultValue=0] Default value, filled in on new entries when
+         *                             the matrix is resized. If not provided,
+         *                             new matrix elements will be filled with zeros.
+         */
+        subset(index: Index, _replacement?: DenseMatrixData | /*elided*/ any | MatrixValue, _defaultValue?: MatrixValue): /*elided*/ any | MatrixValue;
+        /**
+         * Replace a single element in the matrix.
+         * @param {Number[]} index Zero-based index
+         * @param {MatrixValue} value
+         * @param {MatrixValue} [defaultValue] Default value, filled in on new entries when
+         *                           the matrix is resized. If not provided,
+         *                           new matrix elements will be left undefined.
+         * @return {ImmutableDenseMatrix} self
+         */
+        set(_index: number[], _value: MatrixValue, _defaultValue?: MatrixValue): /*elided*/ any;
+        /**
+         * Resize the matrix to the given size. Returns a copy of the matrix when
+         * `copy=true`, otherwise return the matrix itself (resize in place).
+         *
+         * @param {Number[]} size The new size the matrix should have.
+         * @param {MatrixValue} [defaultValue=0] Default value, filled in on new entries.
+         *                             If not provided, the matrix elements will
+         *                             be filled with zeros.
+         * @param {boolean} [copy] Return a resized copy of the matrix
+         *
+         * @return {ImmutableDenseMatrix} The resized matrix
+         */
+        resize(_size: number[], _defaultValue?: MatrixValue, _copy?: boolean): /*elided*/ any;
+        /**
+         * Disallows reshaping in favor of immutability.
+         *
+         * @throws {Error} Operation not allowed
+         */
+        reshape(_size: number[], _copy?: boolean): /*elided*/ any;
+        /**
+         * Create a clone of the matrix
+         * @return {ImmutableDenseMatrix} clone
+         */
+        clone(): /*elided*/ any;
+        /**
+         * Get a JSON representation of the matrix.
+         *
+         * Note: min and max are intentionally excluded from the JSON output
+         * because they are computed lazily and caching them in JSON serialization
+         * would not be useful (they would need to be recomputed on deserialization
+         * anyway if the matrix data changed).
+         *
+         * @returns {ImmutableDenseMatrixJSON}
+         */
+        toJSON(): ImmutableDenseMatrixJSON;
+        /**
+         * Swap rows i and j in Matrix.
+         *
+         * @param {Number} i Matrix row index 1
+         * @param {Number} j Matrix row index 2
+         *
+         * @return {Matrix} The matrix reference
+         */
+        swapRows(_i: number, _j: number): /*elided*/ any;
+        /**
+         * Calculate the minimum value in the set
+         * @return {MatrixValue | undefined} min
+         */
+        min(): MatrixValue | undefined;
+        /**
+         * Calculate the maximum value in the set
+         * @return {MatrixValue | undefined} max
+         */
+        max(): MatrixValue | undefined;
+        isDenseMatrix: boolean;
+        storage(): string;
+        datatype(): DataType;
+        size(): number[];
+        toArray(): DenseMatrixData;
+        valueOf(): DenseMatrixData;
+        forEach(callback: (value: MatrixValue, index?: number[], matrix?: _DenseMatrix) => void): void;
+    };
+}>;
+//# sourceMappingURL=ImmutableDenseMatrix.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ImmutableDenseMatrix.d.ts","sourceRoot":"","sources":["../../../src/type/matrix/ImmutableDenseMatrix.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,eAAe,EACf,QAAQ,EACR,WAAW,EACX,cAAc,EACd,wBAAwB,EACxB,mCAAmC,EACpC,MAAM,YAAY,CAAC;AAMpB,YAAY,EAAE,wBAAwB,EAAE,CAAC;AAEzC;;GAEG;AACH,UAAU,KAAM,SAAQ,cAAc;IACpC,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;GAEG;AACH,UAAU,YAAY;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,eAAe,CAAC;IACvB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,OAAO,IAAI,MAAM,CAAC;IAClB,QAAQ,IAAI,QAAQ,CAAC;IACrB,IAAI,IAAI,MAAM,EAAE,CAAC;IACjB,KAAK,IAAI,YAAY,CAAC;IACtB,OAAO,IAAI,eAAe,CAAC;IAC3B,OAAO,IAAI,eAAe,CAAC;IAC3B,MAAM,CACJ,KAAK,EAAE,KAAK,EACZ,WAAW,CAAC,EAAE,eAAe,GAAG,YAAY,GAAG,WAAW,EAC1D,YAAY,CAAC,EAAE,WAAW,GACzB,YAAY,GAAG,WAAW,CAAC;IAC9B,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI,CAAC;CAChG;AAED;;;GAGG;AACH,KAAK,eAAe,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC;AAEnE;;GAEG;AACH,UAAU,gCAAgC;IACxC,OAAO,EAAE,eAAe,CAAC;IACzB,WAAW,EAAE,KACX,IAAI,CAAC,EAAE,eAAe,GAAG,mCAAmC,EAC5D,QAAQ,CAAC,EAAE,QAAQ,KAChB,YAAY,CAAC;CACnB;AAED,eAAO,MAAM,+BAA+B;gBAkD7B,eAAe,GAAG,mCAAmC,GAAG,IAAI,aACxD,QAAQ;QAvCrB;;WAEG;uBACY,MAAM;QAErB;;WAEG;yCAC8B,OAAO;QAExC;;WAEG;eACI,eAAe;QAEtB;;WAEG;eACI,MAAM,EAAE;QAEf;;WAEG;oBACS,QAAQ;QAEpB;;;WAGG;cACG,WAAW,GAAG,IAAI;QAExB;;;WAGG;cACG,WAAW,GAAG,IAAI;QAgDxB;;;;;;;;;;;;WAYG;sBAEM,KAAK,iBACG,eAAe,oBAA0B,WAAW,kBACnD,WAAW,GAC1B,iBAAuB,WAAW;QA0BrC;;;;;;;;WAQG;oBAEO,MAAM,EAAE,UACR,WAAW,kBACH,WAAW;QAK7B;;;;;;;;;;;WAWG;sBACW,MAAM,EAAE,kBAAkB,WAAW,UAAU,OAAO;QAIpE;;;;WAIG;uBACY,MAAM,EAAE,UAAU,OAAO;QAIxC;;;WAGG;;QASH;;;;;;;;;WASG;kBACO,wBAAwB;QAoBlC;;;;;;;WAOG;qBACU,MAAM,MAAM,MAAM;QAI/B;;;WAGG;eACI,WAAW,GAAG,SAAS;QAiB9B;;;WAGG;eACI,WAAW,GAAG,SAAS;uBAtSnB,OAAO;mBAIX,MAAM;oBACL,QAAQ;gBACZ,MAAM,EAAE;mBAEL,eAAe;mBACf,eAAe;0BAMR,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;;IAuO1F;;;;;;OAMG;mBACmB,wBAAwB;QA9M9C;;WAEG;uBACY,MAAM;QAErB;;WAEG;yCAC8B,OAAO;QAExC;;WAEG;eACI,eAAe;QAEtB;;WAEG;eACI,MAAM,EAAE;QAEf;;WAEG;oBACS,QAAQ;QAEpB;;;WAGG;cACG,WAAW,GAAG,IAAI;QAExB;;;WAGG;cACG,WAAW,GAAG,IAAI;QAgDxB;;;;;;;;;;;;WAYG;sBAEM,KAAK,iBACG,eAAe,oBAA0B,WAAW,kBACnD,WAAW,GAC1B,iBAAuB,WAAW;QA0BrC;;;;;;;;WAQG;oBAEO,MAAM,EAAE,UACR,WAAW,kBACH,WAAW;QAK7B;;;;;;;;;;;WAWG;sBACW,MAAM,EAAE,kBAAkB,WAAW,UAAU,OAAO;QAIpE;;;;WAIG;uBACY,MAAM,EAAE,UAAU,OAAO;QAIxC;;;WAGG;;QASH;;;;;;;;;WASG;kBACO,wBAAwB;QAoBlC;;;;;;;WAOG;qBACU,MAAM,MAAM,MAAM;QAI/B;;;WAGG;eACI,WAAW,GAAG,SAAS;QAiB9B;;;WAGG;eACI,WAAW,GAAG,SAAS;uBAtSnB,OAAO;mBAIX,MAAM;oBACL,QAAQ;gBACZ,MAAM,EAAE;mBAEL,eAAe;mBACf,eAAe;0BAMR,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;;EAoT/F,CAAC"}

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"}