@danielsimonjr/mathts-core 0.15.0 → 0.15.1

package/dist/array.d.ts

@@ -1,5 +1,14 @@
 import { Index, Matrix } from './is.js';
+/**
+ * A value of type T, or an array of such values nested to any depth.
+ */
 export type NestedArray<T> = T | NestedArray<T>[];
+/**
+ * A value paired with a numeric identifier.
+ *
+ * `identify` sets `identifier` to the count of equal values that come
+ * directly before this value in the sorted input. The first value of each run has identifier 0.
+ */
 export interface IdentifiedValue<T> {
     value: T;
     identifier: number;
@@ -8,42 +17,42 @@ export interface IdentifiedValue<T> {
  * Calculate the size of a multi dimensional array.
  * This function checks the size of the first entry, it does not validate
  * whether all dimensions match. (use function `validate` for that)
- * @param {Array} x
+ * @param x
  * @return {number[]} size
  */
 export declare function arraySize<T>(x: NestedArray<T>): number[];
 /**
  * Validate whether each element in a multi dimensional array has
  * a size corresponding to the provided size array.
- * @param {Array} array    Array to be validated
- * @param {number[]} size  Array with the size of each dimension
+ * @param array - Array to be validated
+ * @param size - Array with the size of each dimension
  * @throws DimensionError
  */
 export declare function validate<T>(array: NestedArray<T>, size: number[]): void;
 /**
  * Validate whether the source of the index matches the size of the Array
- * @param {Array | Matrix} value    Array to be validated
- * @param {Index} index  Index with the source information to validate
+ * @param value - Array to be validated
+ * @param index - Index with the source information to validate
  * @throws DimensionError
  */
 export declare function validateIndexSourceSize(value: unknown[] | Matrix, index: Index): void;
 /**
  * Test whether index is an integer number with index >= 0 and index < length
  * when length is provided
- * @param {number} index    Zero-based index
- * @param {number} [length] Length of the array
+ * @param index - Zero-based index
+ * @param length - Optional. Length of the array
  */
 export declare function validateIndex(index: number | undefined, length?: number): void;
 /**
  * Test if an index has empty values
- * @param {Index} index    Zero-based index
+ * @param index - Zero-based index
  */
 export declare function isEmptyIndex(index: Index): boolean;
 /**
  * Resize a multi dimensional array. The resized array is returned.
- * @param {Array | number} array         Array to be resized
- * @param {number[]} size Array with the size of each dimension
- * @param {*} [defaultValue=0]  Value to be filled in new entries,
+ * @param array - Array to be resized
+ * @param size - Array with the size of each dimension
+ * @param defaultValue - Optional. Default is 0. Value to be filled in new entries,
  *                              zero by default. Specify for example `null`,
  *                              to clearly see entries that are not explicitly
  *                              set.
@@ -52,8 +61,8 @@ export declare function isEmptyIndex(index: Index): boolean;
 export declare function resize<T = unknown>(array: T | T[] | NestedArray<T>, size: number[], defaultValue?: T): NestedArray<T>;
 /**
  * Re-shape a multi dimensional array to fit the specified dimensions
- * @param {Array} array           Array to be reshaped
- * @param {number[]} sizes        List of sizes for each dimension
+ * @param array - Array to be reshaped
+ * @param sizes - List of sizes for each dimension
  * @returns {Array}               Array whose data has been formatted to fit the
  *                                specified dimensions
  *
@@ -63,16 +72,16 @@ export declare function resize<T = unknown>(array: T | T[] | NestedArray<T>, siz
 export declare function reshape<T = unknown>(array: NestedArray<T>, sizes: number[]): NestedArray<T>;
 /**
  * Replaces the wildcard -1 in the sizes array.
- * @param {number[]} sizes  List of sizes for each dimension. At most one wildcard.
- * @param {number} currentLength  Number of elements in the array.
+ * @param sizes - List of sizes for each dimension. At most one wildcard.
+ * @param currentLength - Number of elements in the array.
  * @throws {Error}                If more than one wildcard or unable to replace it.
  * @returns {number[]}      The sizes array with wildcard replaced.
  */
 export declare function processSizesWildcard(sizes: number[], currentLength: number): number[];
 /**
  * Squeeze a multi dimensional array
- * @param {Array} array
- * @param {Array} [size]
+ * @param array
+ * @param size - Optional.
  * @returns {Array} returns the array itself
  */
 export declare function squeeze<T>(array: NestedArray<T>, size?: number[]): T | NestedArray<T>;
@@ -81,10 +90,10 @@ export declare function squeeze<T>(array: NestedArray<T>, size?: number[]): T |
  *
  * Parameter `size` will be mutated to match the new, unsqueezed matrix size.
  *
- * @param {Array} array
- * @param {number} dims       Desired number of dimensions of the array
- * @param {number} [outer]    Number of outer dimensions to be added
- * @param {Array} [size] Current size of array.
+ * @param array
+ * @param dims - Desired number of dimensions of the array
+ * @param outer - Optional. Number of outer dimensions to be added
+ * @param size - Optional. Current size of array.
  * @returns {Array} returns the array itself
  * @private
  */
@@ -92,52 +101,52 @@ export declare function unsqueeze<T>(array: NestedArray<T>, dims: number, outer?
 /**
  * Flatten a multi dimensional array, put all elements in a one dimensional
  * array
- * @param {Array} array   A multi dimensional array
- * @param {boolean} isRectangular Optional. If the array is rectangular (not jagged)
+ * @param array - A multi dimensional array
+ * @param isRectangular - Optional. If the array is rectangular (not jagged)
  * @return {Array}        The flattened array (1 dimensional)
  */
 export declare function flatten<T>(array: NestedArray<T>, isRectangular?: boolean): T[];
 /**
  * A safe map
- * @param {Array} array
- * @param {function} callback
+ * @param array
+ * @param callback
  */
 export declare function map<T, U>(array: T[], callback: (value: T, index: number, array: T[]) => U): U[];
 /**
  * A safe forEach
- * @param {Array} array
- * @param {function} callback
+ * @param array
+ * @param callback
  */
 export declare function forEach<T>(array: T[], callback: (value: T, index: number, array: T[]) => void): void;
 /**
  * A safe filter
- * @param {Array} array
- * @param {function} callback
+ * @param array
+ * @param callback
  */
 export declare function filter<T>(array: T[], callback: (value: T, index: number, array: T[]) => boolean): T[];
 /**
  * Filter values in an array given a regular expression
- * @param {Array} array
- * @param {RegExp} regexp
+ * @param array
+ * @param regexp
  * @return {Array} Returns the filtered array
  * @private
  */
 export declare function filterRegExp(array: string[], regexp: RegExp): string[];
 /**
  * A safe join
- * @param {Array} array
- * @param {string} separator
+ * @param array
+ * @param separator
  */
 export declare function join<T>(array: T[], separator: string): string;
 /**
  * Assign a numeric identifier to every element of a sorted array
- * @param {Array} a  An array
+ * @param a - An array
  * @return {Array} An array of objects containing the original value and its identifier
  */
 export declare function identify<T>(a: T[]): IdentifiedValue<T>[];
 /**
  * Remove the numeric identifier from the elements
- * @param {array} a  An array
+ * @param a - An array
  * @return {array} An array of values without identifiers
  */
 export declare function generalize<T>(a: IdentifiedValue<T>[]): T[];
@@ -146,14 +155,14 @@ export declare function generalize<T>(a: IdentifiedValue<T>[]): T[];
  * This is a low level implementation that should only be used by
  * parent Matrix classes such as SparseMatrix or DenseMatrix
  * This method does not validate Array Matrix shape
- * @param {Array} array
- * @param {function} typeOf   Callback function to use to determine the type of a value
+ * @param array
+ * @param typeOf - Callback function to use to determine the type of a value
  * @return {string}
  */
 export declare function getArrayDataType(array: unknown[], typeOf: (value: unknown) => string): string | undefined;
 /**
  * Return the last item from an array
- * @param {Array} array
+ * @param array
  * @returns {*}
  */
 export declare function last<T>(array: T[]): T;
@@ -164,55 +173,58 @@ export declare function last<T>(array: T[]): T;
  * this; `functions/src/utils/array.ts` never defined it, and it was dead code
  * even in expression (unused outside its own definition). Re-exported from
  * expression's shim only — see the module header.
- * @param {Array} array
+ * @param array
  * @returns {Array}
  */
 export declare function initial<T>(array: T[]): T[];
 /**
  * Concatenates many arrays in the specified direction
- * @param {...Array} arrays All the arrays to concatenate
- * @param {number} concatDim The dimension on which to concatenate (zero-based)
+ *
+ * With one array, the function returns that array without a copy.
+ *
+ * @param args - All the arrays to concatenate, then the dimension on which to concatenate (zero-based) as the last element
  * @returns {Array}
+ * @throws Error when `args` contains no array.
  */
 export declare function concat<T>(...args: [...NestedArray<T>[], number]): NestedArray<T>[];
 /**
  * Receives two or more sizes and gets the broadcasted size for both.
- * @param  {...number[]} sizes Sizes to broadcast together
+ * @param  sizes - Sizes to broadcast together
  * @returns {number[]} The broadcasted size
  */
 export declare function broadcastSizes(...sizes: number[][]): number[];
 /**
  * Checks if it's possible to broadcast a size to another size
- * @param {number[]} size The size of the array to check
- * @param {number[]} toSize The size of the array to validate if it can be broadcasted to
+ * @param size - The size of the array to check
+ * @param toSize - The size of the array to validate if it can be broadcasted to
  */
 export declare function checkBroadcastingRules(size: number[], toSize: number[]): void;
 /**
  * Broadcasts a single array to a certain size
- * @param {Array} array Array to be broadcasted
- * @param {number[]} toSize Size to broadcast the array
+ * @param array - Array to be broadcasted
+ * @param toSize - Size to broadcast the array
  * @returns {Array} The broadcasted array
  */
 export declare function broadcastTo<T>(array: NestedArray<T>, toSize: number[]): NestedArray<T>;
 /**
  * Broadcasts arrays and returns the broadcasted arrays in an array
- * @param  {...Array | any} arrays
+ * @param  arrays
  * @returns {Array[]} The broadcasted arrays
  */
 export declare function broadcastArrays<T>(...arrays: NestedArray<T>[]): NestedArray<T>[];
 /**
  * Stretches a matrix up to a certain size in a certain dimension
- * @param {Array} arrayToStretch
- * @param {number[]} sizeToStretch
- * @param {number} dimToStretch
+ * @param arrayToStretch
+ * @param sizeToStretch
+ * @param dimToStretch
  * @returns {Array} The stretched array
  */
 export declare function stretch<T>(arrayToStretch: NestedArray<T>, sizeToStretch: number, dimToStretch: number): NestedArray<T>;
 /**
  * Retrieves a single element from an array given an index.
  *
- * @param {Array} array - The array from which to retrieve the value.
- * @param {Array<number>} index - An array of indices specifying the position of the desired element in each dimension.
+ * @param array - The array from which to retrieve the value.
+ * @param index - An array of indices specifying the position of the desired element in each dimension.
  * @returns {*} - The value at the specified position in the array.
  *
  * @example
@@ -224,29 +236,29 @@ export declare function get<T>(array: NestedArray<T>, index: number[]): T;
 /**
  * Recursively maps over each element of nested array using a provided callback function.
  *
- * @param {Array} array - The array to be mapped.
- * @param {Function} callback - The function to execute on each element, taking three arguments:
+ * @param array - The array to be mapped.
+ * @param callback - The function to execute on each element, taking three arguments:
  *   - `value` (any): The current element being processed in the array.
  *   - `index` (Array<number>): The index of the current element being processed in the array.
  *   - `array` (Array): The array `deepMap` was called upon.
- * @param {boolean} [skipIndex=false] - If true, the callback function is called with only the value.
+ * @param skipIndex - Optional. Default is false. If true, the callback function is called with only the value.
  * @returns {Array} A new array with each element being the result of the callback function.
  */
 export declare function deepMap<T, U>(array: NestedArray<T>, callback: ((value: T, index: number[], array: NestedArray<T>) => U) | ((value: T) => U), skipIndex?: boolean): NestedArray<U>;
 /**
  * Recursively iterates over each element in a multi-dimensional array and applies a callback function.
  *
- * @param {Array} array - The multi-dimensional array to iterate over.
- * @param {Function} callback - The function to execute for each element. It receives three arguments:
+ * @param array - The multi-dimensional array to iterate over.
+ * @param callback - The function to execute for each element. It receives three arguments:
  *   - {any} value: The current element being processed in the array.
  *   - {Array<number>} index: The index of the current element in each dimension.
  *   - {Array} array: The original array being processed.
- * @param {boolean} [skipIndex=false] - If true, the callback function is called with only the value.
+ * @param skipIndex - Optional. Default is false. If true, the callback function is called with only the value.
  */
 export declare function deepForEach<T>(array: NestedArray<T>, callback: ((value: T, index: number[], array: NestedArray<T>) => void) | ((value: T) => void), skipIndex?: boolean): void;
 /**
  * Deep clones a multidimensional array
- * @param {Array} array
+ * @param array
  * @returns {Array} cloned array
  */
 export declare function clone<T>(array: T[]): T[];

package/dist/array.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../src/array.ts"],"names":[],"mappings":"AAsBA,OAAO,EAA4C,KAAK,EAAE,MAAM,EAAkB,MAAM,SAAS,CAAC;AAOlG,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;AAGlD,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC;IACT,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,CAUxD;AAuCD;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAWvE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CASrF;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAS9E;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAqBlD;AAED;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,CAAC,GAAG,OAAO,EAChC,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,EAC/B,IAAI,EAAE,MAAM,EAAE,EACd,YAAY,CAAC,EAAE,CAAC,GACf,WAAW,CAAC,CAAC,CAAC,CA6BhB;AAgED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CA4B3F;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE,CAwBrF;AAyCD;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAwBrF;AA2BD;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EACrB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,MAAM,EAAE,GACd,WAAW,CAAC,CAAC,CAAC,CAoBhB;AA2BD;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,aAAa,GAAE,OAAe,GAAG,CAAC,EAAE,CAwCrF;AAED;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAI/F;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,KAAK,EAAE,CAAC,EAAE,EACV,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,IAAI,GACtD,IAAI,CAEN;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,CAAC,EACtB,KAAK,EAAE,CAAC,EAAE,EACV,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,OAAO,GACzD,CAAC,EAAE,CAML;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAMtE;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,EAAE,CAqBxD;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAc1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,OAAO,EAAE,EAChB,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,GACjC,MAAM,GAAG,SAAS,CAgCpB;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,CAErC;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAE1C;AAwCD;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAclF;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,CAmB7D;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAW7E;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAyBtF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAgBhF;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,cAAc,EAAE,WAAW,CAAC,CAAC,CAAC,EAC9B,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,GACnB,WAAW,CAAC,CAAC,CAAC,CAEhB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAYhE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAC1B,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EACrB,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,EACvF,SAAS,GAAE,OAAe,GACzB,WAAW,CAAC,CAAC,CAAC,CA0ChB;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EACrB,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC,EAC7F,SAAS,GAAE,OAAe,GACzB,IAAI,CAsCN;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAExC"}
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../src/array.ts"],"names":[],"mappings":"AAsBA,OAAO,EAA4C,KAAK,EAAE,MAAM,EAAkB,MAAM,SAAS,CAAC;AAOlG;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;AAGlD;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC;IACT,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,CAUxD;AAuCD;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAWvE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CASrF;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAS9E;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAqBlD;AAED;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,CAAC,GAAG,OAAO,EAChC,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,EAC/B,IAAI,EAAE,MAAM,EAAE,EACd,YAAY,CAAC,EAAE,CAAC,GACf,WAAW,CAAC,CAAC,CAAC,CA6BhB;AAgED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CA4B3F;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE,CAwBrF;AAyCD;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAwBrF;AA2BD;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACzB,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EACrB,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,MAAM,EAAE,GACd,WAAW,CAAC,CAAC,CAAC,CAoBhB;AA2BD;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,aAAa,GAAE,OAAe,GAAG,CAAC,EAAE,CAwCrF;AAED;;;;GAIG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAI/F;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,KAAK,EAAE,CAAC,EAAE,EACV,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,IAAI,GACtD,IAAI,CAEN;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,CAAC,EACtB,KAAK,EAAE,CAAC,EAAE,EACV,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,OAAO,GACzD,CAAC,EAAE,CAML;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAMtE;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,EAAE,CAqBxD;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAc1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,OAAO,EAAE,EAChB,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,GACjC,MAAM,GAAG,SAAS,CAgCpB;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,CAErC;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAE1C;AAwCD;;;;;;;;GAQG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAclF;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,CAmB7D;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAW7E;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAyBtF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAgBhF;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,CAAC,EACvB,cAAc,EAAE,WAAW,CAAC,CAAC,CAAC,EAC9B,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,GACnB,WAAW,CAAC,CAAC,CAAC,CAEhB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAYhE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAC1B,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EACrB,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC,EACvF,SAAS,GAAE,OAAe,GACzB,WAAW,CAAC,CAAC,CAAC,CA0ChB;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,EACrB,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC,EAC7F,SAAS,GAAE,OAAe,GACzB,IAAI,CAsCN;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAExC"}

package/dist/bignumber-formatter.d.ts

@@ -105,21 +105,21 @@ export interface BigNumberValue {
  *    format(52.8,   {notation: 'exponential'})          // returns '5.28e+1'
  *    format(12400,  {notation: 'engineering'})          // returns '12.400e+3'
  *
- * @param {BigNumber} value
- * @param {Object | Function | number | BigNumber} [options]
+ * @param value
+ * @param options - Optional.
  * @return {string} str The formatted value
  */
 export declare function format(value: unknown, options?: unknown): string;
 /**
  * Format a BigNumber in engineering notation. Like '1.23e+6', '2.3e+0', '3.500e-3'
- * @param {BigNumber} value
- * @param {number} [precision]        Optional number of significant figures to return.
+ * @param value
+ * @param precision - Optional number of significant figures to return.
  */
 export declare function toEngineering(value: BigNumberValue, precision?: number): string;
 /**
  * Format a number in exponential notation. Like '1.23e+5', '2.3e+0', '3.500e-3'
- * @param {BigNumber} value
- * @param {number} [precision]  Number of digits in formatted output.
+ * @param value
+ * @param precision - Optional. Number of digits in formatted output.
  *                              If not provided, the maximum available digits
  *                              is used.
  * @returns {string} str
@@ -127,8 +127,8 @@ export declare function toEngineering(value: BigNumberValue, precision?: number)
 export declare function toExponential(value: BigNumberValue, precision?: number): string;
 /**
  * Format a number with fixed notation.
- * @param {BigNumber} value
- * @param {number} [precision=undefined] Optional number of decimals after the
+ * @param value
+ * @param precision - Optional number of decimals after the
  *                                       decimal point. Undefined by default.
  */
 export declare function toFixed(value: BigNumberValue, precision?: number): string;

package/dist/config.d.ts

@@ -12,6 +12,9 @@ export interface ConfigOptions {
     randomSeed: string | null;
     legacySubset: boolean;
 }
+/**
+ * Alias of `ConfigOptions`, kept for backward compatibility.
+ */
 export type MathJsConfig = ConfigOptions;
 export declare const DEFAULT_CONFIG: ConfigOptions;
 //# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAG5B,MAAM,EAAE,MAAM,CAAC;IAIf,MAAM,EAAE,MAAM,CAAC;IAGf,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC;IAG3B,MAAM,EAAE,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;IAIvD,cAAc,EAAE,QAAQ,GAAG,WAAW,CAAC;IAGvC,SAAS,EAAE,MAAM,CAAC;IAMlB,WAAW,EAAE,OAAO,CAAC;IAIrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAK1B,YAAY,EAAE,OAAO,CAAC;CACvB;AAGD,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC;AAEzC,eAAO,MAAM,cAAc,EAAE,aAoC5B,CAAC"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAG5B,MAAM,EAAE,MAAM,CAAC;IAIf,MAAM,EAAE,MAAM,CAAC;IAGf,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC;IAG3B,MAAM,EAAE,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;IAIvD,cAAc,EAAE,QAAQ,GAAG,WAAW,CAAC;IAGvC,SAAS,EAAE,MAAM,CAAC;IAMlB,WAAW,EAAE,OAAO,CAAC;IAIrB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAK1B,YAAY,EAAE,OAAO,CAAC;CACvB;AAGD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC;AAEzC,eAAO,MAAM,cAAc,EAAE,aAoC5B,CAAC"}

package/dist/error/DimensionError.d.ts

@@ -17,6 +17,8 @@ export declare class DimensionError extends RangeError {
     relation?: string;
     isDimensionError: true;
     /**
+     * Create a DimensionError. When `actual` is a string and `expected` is not given, the string is the message.
+     *
      * @param actual - The actual size or custom error message
      * @param expected - The expected size (optional if actual is a custom message)
      * @param relation - Optional relation between actual and expected size: '!=', '<', etc.

package/dist/error/DimensionError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DimensionError.d.ts","sourceRoot":"","sources":["../../src/error/DimensionError.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAe,SAAQ,UAAU;IAC5C,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,OAAiB;IAEjC;;;;OAIG;IACH,YAAY,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,EAwC9F;CACF"}
+{"version":3,"file":"DimensionError.d.ts","sourceRoot":"","sources":["../../src/error/DimensionError.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAe,SAAQ,UAAU;IAC5C,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,OAAiB;IAEjC;;;;;;OAMG;IACH,YAAY,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,EAwC9F;CACF"}

package/dist/error/IndexError.d.ts

@@ -29,5 +29,13 @@ export declare class IndexError extends RangeError {
      */
     constructor(index: number, min?: number, max?: number);
 }
+/**
+ * Create an IndexError without the `new` operator.
+ *
+ * @param index - The actual index.
+ * @param min - The minimum index (included). When `max` is not given, this value is the maximum and the minimum is 0.
+ * @param max - The maximum index (excluded).
+ * @returns A new IndexError.
+ */
 export declare function createIndexError(index: number, min?: number, max?: number): IndexError;
 //# sourceMappingURL=IndexError.d.ts.map

package/dist/error/IndexError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IndexError.d.ts","sourceRoot":"","sources":["../../src/error/IndexError.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,YAAY,OAAiB;IAE7B;;;;;;;;;;OAUG;IACH,YAAY,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAqCpD;CACF;AAID,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,UAAU,CAEtF"}
+{"version":3,"file":"IndexError.d.ts","sourceRoot":"","sources":["../../src/error/IndexError.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,YAAY,OAAiB;IAE7B;;;;;;;;;;OAUG;IACH,YAAY,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAqCpD;CACF;AAID;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,UAAU,CAEtF"}

package/dist/factory.d.ts

@@ -78,6 +78,16 @@ export declare function factory<TDeps extends Record<string, unknown> = Record<s
  * @returns Returns a new array with the sorted factories
  */
 export declare function sortFactories(factories: Array<FactoryFunction | LegacyFactory>): Array<FactoryFunction | LegacyFactory>;
+/**
+ * Run the factory functions in dependency order on one scope object.
+ *
+ * The function sorts the factories with `sortFactories`. It then calls each
+ * non-legacy factory with the scope. It does not call legacy factories.
+ *
+ * @param factories - The factory functions and legacy factories.
+ * @param scope - The object that the factories receive. The function changes this object.
+ * @returns The same scope object.
+ */
 export declare function create(factories: Array<FactoryFunction | LegacyFactory>, scope?: Record<string, unknown>): Record<string, unknown>;
 /**
  * Test whether an object is a factory. This is the case when it has

package/dist/factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,OAAO,GAAG,OAAO;IAChD,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC;IAC1C,SAAS,EAAE,IAAI,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;IACzC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,IAAI,CAC3E,YAAY,EAAE,KAAK,KAChB,OAAO,CAAC;AAEb;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,OAAO,CACrB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/D,OAAO,GAAG,OAAO,EAEjB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,cAAc,EAAE,EAC9B,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,EACtC,IAAI,CAAC,EAAE,WAAW,GACjB,eAAe,CAAC,OAAO,CAAC,CAoB1B;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,KAAK,CAAC,eAAe,GAAG,aAAa,CAAC,GAChD,KAAK,CAAC,eAAe,GAAG,aAAa,CAAC,CA0FxC;AAGD,wBAAgB,MAAM,CACpB,SAAS,EAAE,KAAK,CAAC,eAAe,GAAG,aAAa,CAAC,EACjD,KAAK,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAClC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAQzB;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,eAAe,CAG9D;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,cAAc,EAAE,EAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,IAAI,CAeN;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAIxE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,cAAc,GAAG,MAAM,CAExE"}
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,OAAO,GAAG,OAAO;IAChD,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC;IAC1C,SAAS,EAAE,IAAI,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;IACzC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,IAAI,CAC3E,YAAY,EAAE,KAAK,KAChB,OAAO,CAAC;AAEb;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,OAAO,CACrB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/D,OAAO,GAAG,OAAO,EAEjB,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,cAAc,EAAE,EAC9B,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,EACtC,IAAI,CAAC,EAAE,WAAW,GACjB,eAAe,CAAC,OAAO,CAAC,CAoB1B;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,SAAS,EAAE,KAAK,CAAC,eAAe,GAAG,aAAa,CAAC,GAChD,KAAK,CAAC,eAAe,GAAG,aAAa,CAAC,CA0FxC;AAGD;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CACpB,SAAS,EAAE,KAAK,CAAC,eAAe,GAAG,aAAa,CAAC,EACjD,KAAK,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAClC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAQzB;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,eAAe,CAG9D;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,cAAc,EAAE,EAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7B,IAAI,CAeN;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO,CAIxE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,cAAc,GAAG,MAAM,CAExE"}

package/dist/index.js

@@ -90,6 +90,15 @@ var createRangeClass = /* @__PURE__ */ factory(
       _cacheStart;
       _cacheEnd;
       _cacheStep;
+      /**
+       * Create a range from start to end with a step.
+       *
+       * @param start - Included lower bound. Default is 0.
+       * @param end - Excluded upper bound. Default is 0.
+       * @param step - Optional step size. Default is 1.
+       * @throws TypeError when start, end or step is not a number, bigint or BigNumber.
+       * @throws Error when step is zero.
+       */
       constructor(start, end, step) {
         if (!(this instanceof Range2)) {
           throw new SyntaxError("Constructor must be called with the new operator");
@@ -140,7 +149,7 @@ var createRangeClass = /* @__PURE__ */ factory(
        * If the string does not contain a valid range, null is returned.
        * For example str='0:2:11'.
        * @memberof Range
-       * @param {string} str
+       * @param str
        * @return {Range | null} range
        */
       static parse(str) {
@@ -232,7 +241,7 @@ var createRangeClass = /* @__PURE__ */ factory(
       /**
        * Execute a callback function for each value in the range.
        * @memberof Range
-       * @param {function} callback The callback method is invoked with three
+       * @param callback - The callback method is invoked with three
        *                            parameters: the value of the element, the index
        *                            of the element, and the Range being traversed.
        */
@@ -259,7 +268,7 @@ var createRangeClass = /* @__PURE__ */ factory(
        * 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
+       * @param 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
@@ -302,7 +311,7 @@ var createRangeClass = /* @__PURE__ */ factory(
        * 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
+       * @param options - Optional. Formatting options. See
        *                                               lib/utils/number:format for a
        *                                               description of the available
        *                                               options.
@@ -341,7 +350,7 @@ var createRangeClass = /* @__PURE__ */ factory(
       /**
        * Instantiate a Range from a JSON object
        * @memberof Range
-       * @param {Object} json A JSON object structured as:
+       * @param json - A JSON object structured as:
        *                      `{"mathjs": "Range", "start": 2, "end": 4, "step": 1}`
        * @return {Range}
        */
@@ -1377,7 +1386,7 @@ function neumaierCumsum(xs, out) {
 }
 
 // src/index.ts
-var VERSION = "0.15.0";
+var VERSION = "0.15.1";
 export {
   ALL_UNITS,
   BASE_UNITS,

package/dist/internal.js

@@ -87,6 +87,8 @@ var DimensionError = class _DimensionError extends RangeError {
   relation;
   isDimensionError = true;
   /**
+   * Create a DimensionError. When `actual` is a string and `expected` is not given, the string is the message.
+   *
    * @param actual - The actual size or custom error message
    * @param expected - The expected size (optional if actual is a custom message)
    * @param relation - Optional relation between actual and expected size: '!=', '<', etc.
@@ -1196,7 +1198,6 @@ var ObjectWrappingMap = class {
   [Symbol.iterator]() {
     return this.entries();
   }
-  // @ts-expect-error: Implementation is compatible but TS can't infer it
   keys() {
     return Object.keys(this.wrappedObject).filter((key) => this.has(key)).values();
   }
@@ -1210,11 +1211,25 @@ var ObjectWrappingMap = class {
   has(key) {
     return isSafeProperty(this.wrappedObject, key) && key in this.wrappedObject;
   }
-  // @ts-expect-error: Implementation is compatible but TS can't infer it
+  /**
+   * Return the value for `key`; when the key is absent, set it to `defaultValue` first.
+   * Declared because the ESNext `Map` (TC39 upsert) has it, and `implements Map` requires it.
+   */
+  getOrInsert(key, defaultValue) {
+    if (!this.has(key)) this.set(key, defaultValue);
+    return this.get(key);
+  }
+  /**
+   * Return the value for `key`; when the key is absent, set it to `callback(key)` first.
+   * Declared because the ESNext `Map` (TC39 upsert) has it, and `implements Map` requires it.
+   */
+  getOrInsertComputed(key, callback) {
+    if (!this.has(key)) this.set(key, callback(key));
+    return this.get(key);
+  }
   entries() {
     return mapIterator(this.keys(), (key) => [key, this.get(key)]);
   }
-  // @ts-expect-error: Implementation is compatible but TS can't infer it
   *values() {
     for (const key of this.keys()) {
       yield this.get(key);
@@ -1247,6 +1262,8 @@ var PartitionedMap = class {
   bKeys;
   [Symbol.toStringTag] = "PartitionedMap";
   /**
+   * Create a PartitionedMap over two maps.
+   *
    * @param a - Primary map
    * @param b - Secondary map
    * @param bKeys - Set of keys that should be read/written to map b
@@ -1274,17 +1291,30 @@ var PartitionedMap = class {
   has(key) {
     return this.b.has(key) || this.a.has(key);
   }
-  // @ts-expect-error: Implementation is compatible but TS can't infer it
+  /**
+   * Return the value for `key`; when the key is absent, set it to `defaultValue` first.
+   * Declared because the ESNext `Map` (TC39 upsert) has it, and `implements Map` requires it.
+   */
+  getOrInsert(key, defaultValue) {
+    if (!this.has(key)) this.set(key, defaultValue);
+    return this.get(key);
+  }
+  /**
+   * Return the value for `key`; when the key is absent, set it to `callback(key)` first.
+   * Declared because the ESNext `Map` (TC39 upsert) has it, and `implements Map` requires it.
+   */
+  getOrInsertComputed(key, callback) {
+    if (!this.has(key)) this.set(key, callback(key));
+    return this.get(key);
+  }
   keys() {
     return (/* @__PURE__ */ new Set([...this.a.keys(), ...this.b.keys()]))[Symbol.iterator]();
   }
-  // @ts-expect-error: Implementation is compatible but TS can't infer it
   *values() {
     for (const key of this.keys()) {
       yield this.get(key);
     }
   }
-  // @ts-expect-error: Implementation is compatible but TS can't infer it
   entries() {
     return mapIterator(this.keys(), (key) => [key, this.get(key)]);
   }