@danielsimonjr/mathts-core 0.14.1 → 0.15.0

package/dist/types/matrix/Range.d.ts

@@ -0,0 +1,767 @@
+interface BigNumber {
+    toNumber(): number;
+}
+/**
+ * Callback function for Range forEach operations
+ */
+export type RangeForEachCallback = (value: number, index: number[], range: unknown) => void;
+/**
+ * Callback function for Range map operations
+ */
+export type RangeMapCallback<T> = (value: number, index: number[], range: unknown) => T;
+/**
+ * Formatting options for Range display
+ */
+export interface RangeFormatOptions {
+    precision?: number;
+    notation?: 'fixed' | 'exponential' | 'engineering' | 'auto';
+    [key: string]: unknown;
+}
+/**
+ * JSON representation of a Range
+ */
+export interface RangeJSON {
+    mathjs: 'Range';
+    start: number;
+    end: number;
+    step: number;
+}
+export declare const createRangeClass: import("../../factory.js").FactoryFunction<{
+    new (start?: number | bigint | BigNumber | null, end?: number | bigint | BigNumber | null, step?: number | bigint | BigNumber | null): {
+        /**
+         * Type identifier
+         */
+        readonly type: string;
+        /**
+         * Range type flag
+         */
+        readonly isRange: boolean;
+        /**
+         * Start value of the range (inclusive)
+         */
+        start: number;
+        /**
+         * End value of the range (exclusive)
+         */
+        end: number;
+        /**
+         * Step size for the range
+         */
+        step: number;
+        /**
+         * Cached primitive array representation.
+         *
+         * @internal Not part of the public API.
+         *
+         * These four were ES-private (`#cache`) until TypeScript 7. This class is
+         * returned from a `factory()` call, so declaration emit describes it as an
+         * ANONYMOUS class type -- and TS4094 forbids private or protected members
+         * there, because an anonymous type has no name to refer them to. The
+         * underscore prefix keeps the "do not touch" signal without the emit
+         * failure. Restore `#` if the class is ever hoisted out of the factory.
+         */
+        _cache: number[] | null;
+        _cacheStart?: number;
+        _cacheEnd?: number;
+        _cacheStep?: number;
+        /**
+         * Create a clone of the range
+         * @return {Range} clone
+         */
+        clone(): /*elided*/ any;
+        /**
+         * Retrieve the size of the range.
+         * Returns an array containing one number, the number of elements in the range.
+         * @memberof Range
+         * @returns {number[]} size
+         */
+        size(): number[];
+        /**
+         * Calculate the minimum value in the range
+         * @memberof Range
+         * @return {number | undefined} min
+         */
+        min(): number | undefined;
+        /**
+         * Calculate the maximum value in the range
+         * @memberof Range
+         * @return {number | undefined} max
+         */
+        max(): number | undefined;
+        /**
+         * Execute a callback function for each value in the range.
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Range being traversed.
+         */
+        forEach(callback: RangeForEachCallback): void;
+        /**
+         * Execute a callback function for each value in the Range, and return the
+         * results as an array
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Matrix being traversed.
+         * @returns {Array} array
+         */
+        map<T>(callback: RangeMapCallback<T>): T[];
+        /**
+         * Create an Array with a copy of the Ranges data
+         * @memberof Range
+         * @returns {Array} array
+         */
+        toArray(): number[];
+        /**
+         * Get the primitive value of the Range, a one dimensional array
+         * @memberof Range
+         * @returns {Array} array
+         */
+        valueOf(): number[];
+        /**
+         * Get a string representation of the range, with optional formatting options.
+         * Output is formatted as 'start:step:end', for example '2:6' or '0:0.2:11'
+         * @memberof Range
+         * @param {Object | number | function} [options] Formatting options. See
+         *                                               lib/utils/number:format for a
+         *                                               description of the available
+         *                                               options.
+         * @returns {string} str
+         */
+        format(options?: RangeFormatOptions | number | ((value: number) => string)): string;
+        /**
+         * Get a string representation of the range.
+         * @memberof Range
+         * @returns {string}
+         */
+        toString(): string;
+        /**
+         * Get a JSON representation of the range
+         * @memberof Range
+         * @returns {Object} Returns a JSON object structured as:
+         *                   `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`
+         */
+        toJSON(): RangeJSON;
+    };
+    /**
+     * Parse a string into a range,
+     * The string contains the start, optional step, and end, separated by a colon.
+     * If the string does not contain a valid range, null is returned.
+     * For example str='0:2:11'.
+     * @memberof Range
+     * @param {string} str
+     * @return {Range | null} range
+     */
+    parse(str: string): {
+        /**
+         * Type identifier
+         */
+        readonly type: string;
+        /**
+         * Range type flag
+         */
+        readonly isRange: boolean;
+        /**
+         * Start value of the range (inclusive)
+         */
+        start: number;
+        /**
+         * End value of the range (exclusive)
+         */
+        end: number;
+        /**
+         * Step size for the range
+         */
+        step: number;
+        /**
+         * Cached primitive array representation.
+         *
+         * @internal Not part of the public API.
+         *
+         * These four were ES-private (`#cache`) until TypeScript 7. This class is
+         * returned from a `factory()` call, so declaration emit describes it as an
+         * ANONYMOUS class type -- and TS4094 forbids private or protected members
+         * there, because an anonymous type has no name to refer them to. The
+         * underscore prefix keeps the "do not touch" signal without the emit
+         * failure. Restore `#` if the class is ever hoisted out of the factory.
+         */
+        _cache: number[] | null;
+        _cacheStart?: number;
+        _cacheEnd?: number;
+        _cacheStep?: number;
+        /**
+         * Create a clone of the range
+         * @return {Range} clone
+         */
+        clone(): /*elided*/ any;
+        /**
+         * Retrieve the size of the range.
+         * Returns an array containing one number, the number of elements in the range.
+         * @memberof Range
+         * @returns {number[]} size
+         */
+        size(): number[];
+        /**
+         * Calculate the minimum value in the range
+         * @memberof Range
+         * @return {number | undefined} min
+         */
+        min(): number | undefined;
+        /**
+         * Calculate the maximum value in the range
+         * @memberof Range
+         * @return {number | undefined} max
+         */
+        max(): number | undefined;
+        /**
+         * Execute a callback function for each value in the range.
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Range being traversed.
+         */
+        forEach(callback: RangeForEachCallback): void;
+        /**
+         * Execute a callback function for each value in the Range, and return the
+         * results as an array
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Matrix being traversed.
+         * @returns {Array} array
+         */
+        map<T>(callback: RangeMapCallback<T>): T[];
+        /**
+         * Create an Array with a copy of the Ranges data
+         * @memberof Range
+         * @returns {Array} array
+         */
+        toArray(): number[];
+        /**
+         * Get the primitive value of the Range, a one dimensional array
+         * @memberof Range
+         * @returns {Array} array
+         */
+        valueOf(): number[];
+        /**
+         * Get a string representation of the range, with optional formatting options.
+         * Output is formatted as 'start:step:end', for example '2:6' or '0:0.2:11'
+         * @memberof Range
+         * @param {Object | number | function} [options] Formatting options. See
+         *                                               lib/utils/number:format for a
+         *                                               description of the available
+         *                                               options.
+         * @returns {string} str
+         */
+        format(options?: RangeFormatOptions | number | ((value: number) => string)): string;
+        /**
+         * Get a string representation of the range.
+         * @memberof Range
+         * @returns {string}
+         */
+        toString(): string;
+        /**
+         * Get a JSON representation of the range
+         * @memberof Range
+         * @returns {Object} Returns a JSON object structured as:
+         *                   `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`
+         */
+        toJSON(): RangeJSON;
+    } | null;
+    /**
+     * Instantiate a Range from a JSON object
+     * @memberof Range
+     * @param {Object} json A JSON object structured as:
+     *                      `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`
+     * @return {Range}
+     */
+    fromJSON(json: RangeJSON): {
+        /**
+         * Type identifier
+         */
+        readonly type: string;
+        /**
+         * Range type flag
+         */
+        readonly isRange: boolean;
+        /**
+         * Start value of the range (inclusive)
+         */
+        start: number;
+        /**
+         * End value of the range (exclusive)
+         */
+        end: number;
+        /**
+         * Step size for the range
+         */
+        step: number;
+        /**
+         * Cached primitive array representation.
+         *
+         * @internal Not part of the public API.
+         *
+         * These four were ES-private (`#cache`) until TypeScript 7. This class is
+         * returned from a `factory()` call, so declaration emit describes it as an
+         * ANONYMOUS class type -- and TS4094 forbids private or protected members
+         * there, because an anonymous type has no name to refer them to. The
+         * underscore prefix keeps the "do not touch" signal without the emit
+         * failure. Restore `#` if the class is ever hoisted out of the factory.
+         */
+        _cache: number[] | null;
+        _cacheStart?: number;
+        _cacheEnd?: number;
+        _cacheStep?: number;
+        /**
+         * Create a clone of the range
+         * @return {Range} clone
+         */
+        clone(): /*elided*/ any;
+        /**
+         * Retrieve the size of the range.
+         * Returns an array containing one number, the number of elements in the range.
+         * @memberof Range
+         * @returns {number[]} size
+         */
+        size(): number[];
+        /**
+         * Calculate the minimum value in the range
+         * @memberof Range
+         * @return {number | undefined} min
+         */
+        min(): number | undefined;
+        /**
+         * Calculate the maximum value in the range
+         * @memberof Range
+         * @return {number | undefined} max
+         */
+        max(): number | undefined;
+        /**
+         * Execute a callback function for each value in the range.
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Range being traversed.
+         */
+        forEach(callback: RangeForEachCallback): void;
+        /**
+         * Execute a callback function for each value in the Range, and return the
+         * results as an array
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Matrix being traversed.
+         * @returns {Array} array
+         */
+        map<T>(callback: RangeMapCallback<T>): T[];
+        /**
+         * Create an Array with a copy of the Ranges data
+         * @memberof Range
+         * @returns {Array} array
+         */
+        toArray(): number[];
+        /**
+         * Get the primitive value of the Range, a one dimensional array
+         * @memberof Range
+         * @returns {Array} array
+         */
+        valueOf(): number[];
+        /**
+         * Get a string representation of the range, with optional formatting options.
+         * Output is formatted as 'start:step:end', for example '2:6' or '0:0.2:11'
+         * @memberof Range
+         * @param {Object | number | function} [options] Formatting options. See
+         *                                               lib/utils/number:format for a
+         *                                               description of the available
+         *                                               options.
+         * @returns {string} str
+         */
+        format(options?: RangeFormatOptions | number | ((value: number) => string)): string;
+        /**
+         * Get a string representation of the range.
+         * @memberof Range
+         * @returns {string}
+         */
+        toString(): string;
+        /**
+         * Get a JSON representation of the range
+         * @memberof Range
+         * @returns {Object} Returns a JSON object structured as:
+         *                   `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`
+         */
+        toJSON(): RangeJSON;
+    };
+}>;
+/**
+ * Ready-made `Range` class (the factory instantiated with no dependencies),
+ * exported for direct use from the package index — mirrors how core ships a
+ * ready-made `Complex`/`Fraction`/`Unit` alongside its factory.
+ */
+export declare const Range: {
+    new (start?: number | bigint | BigNumber | null, end?: number | bigint | BigNumber | null, step?: number | bigint | BigNumber | null): {
+        /**
+         * Type identifier
+         */
+        readonly type: string;
+        /**
+         * Range type flag
+         */
+        readonly isRange: boolean;
+        /**
+         * Start value of the range (inclusive)
+         */
+        start: number;
+        /**
+         * End value of the range (exclusive)
+         */
+        end: number;
+        /**
+         * Step size for the range
+         */
+        step: number;
+        /**
+         * Cached primitive array representation.
+         *
+         * @internal Not part of the public API.
+         *
+         * These four were ES-private (`#cache`) until TypeScript 7. This class is
+         * returned from a `factory()` call, so declaration emit describes it as an
+         * ANONYMOUS class type -- and TS4094 forbids private or protected members
+         * there, because an anonymous type has no name to refer them to. The
+         * underscore prefix keeps the "do not touch" signal without the emit
+         * failure. Restore `#` if the class is ever hoisted out of the factory.
+         */
+        _cache: number[] | null;
+        _cacheStart?: number;
+        _cacheEnd?: number;
+        _cacheStep?: number;
+        /**
+         * Create a clone of the range
+         * @return {Range} clone
+         */
+        clone(): /*elided*/ any;
+        /**
+         * Retrieve the size of the range.
+         * Returns an array containing one number, the number of elements in the range.
+         * @memberof Range
+         * @returns {number[]} size
+         */
+        size(): number[];
+        /**
+         * Calculate the minimum value in the range
+         * @memberof Range
+         * @return {number | undefined} min
+         */
+        min(): number | undefined;
+        /**
+         * Calculate the maximum value in the range
+         * @memberof Range
+         * @return {number | undefined} max
+         */
+        max(): number | undefined;
+        /**
+         * Execute a callback function for each value in the range.
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Range being traversed.
+         */
+        forEach(callback: RangeForEachCallback): void;
+        /**
+         * Execute a callback function for each value in the Range, and return the
+         * results as an array
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Matrix being traversed.
+         * @returns {Array} array
+         */
+        map<T>(callback: RangeMapCallback<T>): T[];
+        /**
+         * Create an Array with a copy of the Ranges data
+         * @memberof Range
+         * @returns {Array} array
+         */
+        toArray(): number[];
+        /**
+         * Get the primitive value of the Range, a one dimensional array
+         * @memberof Range
+         * @returns {Array} array
+         */
+        valueOf(): number[];
+        /**
+         * Get a string representation of the range, with optional formatting options.
+         * Output is formatted as 'start:step:end', for example '2:6' or '0:0.2:11'
+         * @memberof Range
+         * @param {Object | number | function} [options] Formatting options. See
+         *                                               lib/utils/number:format for a
+         *                                               description of the available
+         *                                               options.
+         * @returns {string} str
+         */
+        format(options?: RangeFormatOptions | number | ((value: number) => string)): string;
+        /**
+         * Get a string representation of the range.
+         * @memberof Range
+         * @returns {string}
+         */
+        toString(): string;
+        /**
+         * Get a JSON representation of the range
+         * @memberof Range
+         * @returns {Object} Returns a JSON object structured as:
+         *                   `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`
+         */
+        toJSON(): RangeJSON;
+    };
+    /**
+     * Parse a string into a range,
+     * The string contains the start, optional step, and end, separated by a colon.
+     * If the string does not contain a valid range, null is returned.
+     * For example str='0:2:11'.
+     * @memberof Range
+     * @param {string} str
+     * @return {Range | null} range
+     */
+    parse(str: string): {
+        /**
+         * Type identifier
+         */
+        readonly type: string;
+        /**
+         * Range type flag
+         */
+        readonly isRange: boolean;
+        /**
+         * Start value of the range (inclusive)
+         */
+        start: number;
+        /**
+         * End value of the range (exclusive)
+         */
+        end: number;
+        /**
+         * Step size for the range
+         */
+        step: number;
+        /**
+         * Cached primitive array representation.
+         *
+         * @internal Not part of the public API.
+         *
+         * These four were ES-private (`#cache`) until TypeScript 7. This class is
+         * returned from a `factory()` call, so declaration emit describes it as an
+         * ANONYMOUS class type -- and TS4094 forbids private or protected members
+         * there, because an anonymous type has no name to refer them to. The
+         * underscore prefix keeps the "do not touch" signal without the emit
+         * failure. Restore `#` if the class is ever hoisted out of the factory.
+         */
+        _cache: number[] | null;
+        _cacheStart?: number;
+        _cacheEnd?: number;
+        _cacheStep?: number;
+        /**
+         * Create a clone of the range
+         * @return {Range} clone
+         */
+        clone(): /*elided*/ any;
+        /**
+         * Retrieve the size of the range.
+         * Returns an array containing one number, the number of elements in the range.
+         * @memberof Range
+         * @returns {number[]} size
+         */
+        size(): number[];
+        /**
+         * Calculate the minimum value in the range
+         * @memberof Range
+         * @return {number | undefined} min
+         */
+        min(): number | undefined;
+        /**
+         * Calculate the maximum value in the range
+         * @memberof Range
+         * @return {number | undefined} max
+         */
+        max(): number | undefined;
+        /**
+         * Execute a callback function for each value in the range.
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Range being traversed.
+         */
+        forEach(callback: RangeForEachCallback): void;
+        /**
+         * Execute a callback function for each value in the Range, and return the
+         * results as an array
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Matrix being traversed.
+         * @returns {Array} array
+         */
+        map<T>(callback: RangeMapCallback<T>): T[];
+        /**
+         * Create an Array with a copy of the Ranges data
+         * @memberof Range
+         * @returns {Array} array
+         */
+        toArray(): number[];
+        /**
+         * Get the primitive value of the Range, a one dimensional array
+         * @memberof Range
+         * @returns {Array} array
+         */
+        valueOf(): number[];
+        /**
+         * Get a string representation of the range, with optional formatting options.
+         * Output is formatted as 'start:step:end', for example '2:6' or '0:0.2:11'
+         * @memberof Range
+         * @param {Object | number | function} [options] Formatting options. See
+         *                                               lib/utils/number:format for a
+         *                                               description of the available
+         *                                               options.
+         * @returns {string} str
+         */
+        format(options?: RangeFormatOptions | number | ((value: number) => string)): string;
+        /**
+         * Get a string representation of the range.
+         * @memberof Range
+         * @returns {string}
+         */
+        toString(): string;
+        /**
+         * Get a JSON representation of the range
+         * @memberof Range
+         * @returns {Object} Returns a JSON object structured as:
+         *                   `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`
+         */
+        toJSON(): RangeJSON;
+    } | null;
+    /**
+     * Instantiate a Range from a JSON object
+     * @memberof Range
+     * @param {Object} json A JSON object structured as:
+     *                      `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`
+     * @return {Range}
+     */
+    fromJSON(json: RangeJSON): {
+        /**
+         * Type identifier
+         */
+        readonly type: string;
+        /**
+         * Range type flag
+         */
+        readonly isRange: boolean;
+        /**
+         * Start value of the range (inclusive)
+         */
+        start: number;
+        /**
+         * End value of the range (exclusive)
+         */
+        end: number;
+        /**
+         * Step size for the range
+         */
+        step: number;
+        /**
+         * Cached primitive array representation.
+         *
+         * @internal Not part of the public API.
+         *
+         * These four were ES-private (`#cache`) until TypeScript 7. This class is
+         * returned from a `factory()` call, so declaration emit describes it as an
+         * ANONYMOUS class type -- and TS4094 forbids private or protected members
+         * there, because an anonymous type has no name to refer them to. The
+         * underscore prefix keeps the "do not touch" signal without the emit
+         * failure. Restore `#` if the class is ever hoisted out of the factory.
+         */
+        _cache: number[] | null;
+        _cacheStart?: number;
+        _cacheEnd?: number;
+        _cacheStep?: number;
+        /**
+         * Create a clone of the range
+         * @return {Range} clone
+         */
+        clone(): /*elided*/ any;
+        /**
+         * Retrieve the size of the range.
+         * Returns an array containing one number, the number of elements in the range.
+         * @memberof Range
+         * @returns {number[]} size
+         */
+        size(): number[];
+        /**
+         * Calculate the minimum value in the range
+         * @memberof Range
+         * @return {number | undefined} min
+         */
+        min(): number | undefined;
+        /**
+         * Calculate the maximum value in the range
+         * @memberof Range
+         * @return {number | undefined} max
+         */
+        max(): number | undefined;
+        /**
+         * Execute a callback function for each value in the range.
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Range being traversed.
+         */
+        forEach(callback: RangeForEachCallback): void;
+        /**
+         * Execute a callback function for each value in the Range, and return the
+         * results as an array
+         * @memberof Range
+         * @param {function} callback The callback method is invoked with three
+         *                            parameters: the value of the element, the index
+         *                            of the element, and the Matrix being traversed.
+         * @returns {Array} array
+         */
+        map<T>(callback: RangeMapCallback<T>): T[];
+        /**
+         * Create an Array with a copy of the Ranges data
+         * @memberof Range
+         * @returns {Array} array
+         */
+        toArray(): number[];
+        /**
+         * Get the primitive value of the Range, a one dimensional array
+         * @memberof Range
+         * @returns {Array} array
+         */
+        valueOf(): number[];
+        /**
+         * Get a string representation of the range, with optional formatting options.
+         * Output is formatted as 'start:step:end', for example '2:6' or '0:0.2:11'
+         * @memberof Range
+         * @param {Object | number | function} [options] Formatting options. See
+         *                                               lib/utils/number:format for a
+         *                                               description of the available
+         *                                               options.
+         * @returns {string} str
+         */
+        format(options?: RangeFormatOptions | number | ((value: number) => string)): string;
+        /**
+         * Get a string representation of the range.
+         * @memberof Range
+         * @returns {string}
+         */
+        toString(): string;
+        /**
+         * Get a JSON representation of the range
+         * @memberof Range
+         * @returns {Object} Returns a JSON object structured as:
+         *                   `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`
+         */
+        toJSON(): RangeJSON;
+    };
+};
+export {};
+//# sourceMappingURL=Range.d.ts.map