mathjs 13.0.2 → 13.1.0

package/lib/esm/utils/is.js

@@ -12,6 +12,7 @@
 //   for security reasons, so these functions are not exposed in the expression
 //   parser.
 
+import { ObjectWrappingMap } from './map.js';
 export function isNumber(x) {
   return typeof x === 'number';
 }
@@ -88,6 +89,29 @@ export function isRegExp(x) {
 export function isObject(x) {
   return !!(x && typeof x === 'object' && x.constructor === Object && !isComplex(x) && !isFraction(x));
 }
+
+/**
+ * Returns `true` if the passed object appears to be a Map (i.e. duck typing).
+ *
+ * Methods looked for are `get`, `set`, `keys` and `has`.
+ *
+ * @param {Map | object} object
+ * @returns
+ */
+export function isMap(object) {
+  // We can use the fast instanceof, or a slower duck typing check.
+  // The duck typing method needs to cover enough methods to not be confused with DenseMatrix.
+  if (!object) {
+    return false;
+  }
+  return object instanceof Map || object instanceof ObjectWrappingMap || typeof object.set === 'function' && typeof object.get === 'function' && typeof object.keys === 'function' && typeof object.has === 'function';
+}
+export function isPartitionedMap(object) {
+  return isMap(object) && isMap(object.a) && isMap(object.b);
+}
+export function isObjectWrappingMap(object) {
+  return isMap(object) && isObject(object.wrappedObject);
+}
 export function isNull(x) {
   return x === null;
 }

package/lib/esm/utils/map.js

@@ -1,5 +1,5 @@
-import { setSafeProperty, hasSafeProperty, getSafeProperty } from './customs.js';
-import { isObject } from './is.js';
+import { getSafeProperty, hasSafeProperty, setSafeProperty } from './customs.js';
+import { isMap, isObject } from './is.js';
 
 /**
  * A map facade on a bare object.
@@ -172,23 +172,6 @@ export function toObject(map) {
   return object;
 }
 
-/**
- * Returns `true` if the passed object appears to be a Map (i.e. duck typing).
- *
- * Methods looked for are `get`, `set`, `keys` and `has`.
- *
- * @param {Map | object} object
- * @returns
- */
-export function isMap(object) {
-  // We can use the fast instanceof, or a slower duck typing check.
-  // The duck typing method needs to cover enough methods to not be confused with DenseMatrix.
-  if (!object) {
-    return false;
-  }
-  return object instanceof Map || object instanceof ObjectWrappingMap || typeof object.set === 'function' && typeof object.get === 'function' && typeof object.keys === 'function' && typeof object.has === 'function';
-}
-
 /**
  * Copies the contents of key-value pairs from each `objects` in to `map`.
  *

package/lib/esm/version.js

@@ -1,3 +1,3 @@
-export var version = '13.0.2';
+export var version = '13.1.0';
 // Note: This file is automatically generated when building math.js.
 // Changes made in this file will be overwritten.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mathjs",
-  "version": "13.0.2",
+  "version": "13.1.0",
   "description": "Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with different data types like numbers, big numbers, complex numbers, fractions, units, and matrices.",
   "author": "Jos de Jong <wjosdejong@gmail.com> (https://github.com/josdejong)",
   "homepage": "https://mathjs.org",
@@ -25,7 +25,7 @@
     "unit"
   ],
   "dependencies": {
-    "@babel/runtime": "^7.24.7",
+    "@babel/runtime": "^7.25.4",
     "complex.js": "^2.1.1",
     "decimal.js": "^10.4.3",
     "escape-latex": "^1.2.0",
@@ -36,48 +36,48 @@
     "typed-function": "^4.2.1"
   },
   "devDependencies": {
-    "@babel/core": "7.24.7",
+    "@babel/core": "7.25.2",
     "@babel/plugin-transform-object-assign": "7.24.7",
     "@babel/plugin-transform-optional-catch-binding": "7.24.7",
-    "@babel/plugin-transform-runtime": "7.24.7",
-    "@babel/preset-env": "7.24.7",
+    "@babel/plugin-transform-runtime": "7.25.4",
+    "@babel/preset-env": "7.25.4",
     "@babel/register": "7.24.6",
     "@types/assert": "1.5.10",
     "@types/mocha": "10.0.7",
-    "@typescript-eslint/eslint-plugin": "7.15.0",
-    "@typescript-eslint/parser": "7.15.0",
+    "@typescript-eslint/eslint-plugin": "7.16.1",
+    "@typescript-eslint/parser": "7.16.1",
     "assert": "2.1.0",
     "babel-loader": "9.1.3",
     "benchmark": "2.1.4",
     "c8": "10.1.2",
     "codecov": "3.8.3",
-    "core-js": "3.37.1",
+    "core-js": "3.38.1",
     "del": "7.1.0",
     "dtslint": "4.2.1",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-config-standard": "17.1.0",
     "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-mocha": "10.4.3",
+    "eslint-plugin-mocha": "10.5.0",
     "eslint-plugin-n": "16.6.2",
-    "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-promise": "6.4.0",
-    "expect-type": "0.19.0",
+    "eslint-plugin-prettier": "5.2.1",
+    "eslint-plugin-promise": "6.6.0",
+    "expect-type": "0.20.0",
     "expr-eval": "2.0.2",
     "fancy-log": "2.0.0",
-    "glob": "10.4.2",
+    "glob": "11.0.0",
     "gulp": "5.0.0",
     "gulp-babel": "8.0.0",
     "handlebars": "4.7.8",
-    "jsep": "1.3.8",
-    "karma": "6.4.3",
+    "jsep": "1.3.9",
+    "karma": "6.4.4",
     "karma-browserstack-launcher": "1.6.0",
     "karma-firefox-launcher": "2.1.3",
     "karma-mocha": "2.0.1",
     "karma-mocha-reporter": "2.2.5",
     "karma-webpack": "5.0.1",
     "mkdirp": "3.0.1",
-    "mocha": "10.6.0",
+    "mocha": "10.7.3",
     "mocha-junit-reporter": "2.2.1",
     "ndarray": "1.0.19",
     "ndarray-determinant": "1.0.0",
@@ -86,13 +86,13 @@
     "ndarray-pack": "1.2.1",
     "numericjs": "1.2.6",
     "pad-right": "0.2.2",
-    "prettier": "3.3.2",
+    "prettier": "3.3.3",
     "process": "0.11.10",
     "sinon": "18.0.0",
     "sylvester": "0.0.21",
     "ts-node": "10.9.2",
-    "typescript": "5.5.3",
-    "webpack": "5.92.1",
+    "typescript": "5.5.4",
+    "webpack": "5.94.0",
     "zeros": "1.0.0"
   },
   "type": "module",

package/types/index.d.ts

@@ -508,6 +508,7 @@ export interface MathJsInstance extends MathJsFactory {
   RelationalNode: RelationalNodeCtor
   SymbolNode: SymbolNodeCtor
 
+  Unit: UnitCtor
   Matrix: MatrixCtor
 
   /**
@@ -1244,9 +1245,9 @@ export interface MathJsInstance extends MathJsFactory {
   gcd<T extends number | BigNumber | Fraction | Matrix>(args: T[]): T
 
   /**
-   * Calculate the hypotenusa of a list with values. The hypotenusa is
+   * Calculate the hypotenuse of a list with values. The hypotenuse is
    * defined as: hypot(a, b, c, ...) = sqrt(a^2 + b^2 + c^2 + ...) For
-   * matrix input, the hypotenusa is calculated for all values in the
+   * matrix input, the hypotenuse is calculated for all values in the
    * matrix.
    * @param args A list with numeric values or an Array or Matrix. Matrix
    * and Array input is flattened and returns a single number for the
@@ -1947,10 +1948,10 @@ export interface MathJsInstance extends MathJsFactory {
   inv<T extends number | Complex | MathCollection>(x: T): NoLiteralType<T>
 
   /**
-   * Calculate the kronecker product of two matrices or vectors
+   * Calculate the Kronecker product of two matrices or vectors
    * @param x First vector
    * @param y Second vector
-   * @returns Returns the kronecker product of x and y
+   * @returns Returns the Kronecker product of x and y
    */
   kron(x: MathCollection, y: MathCollection): Matrix
 
@@ -1966,7 +1967,29 @@ export interface MathJsInstance extends MathJsFactory {
   map<T extends MathCollection>(
     x: T,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    callback: (value: any, index: any, matrix: T) => MathType | string
+    callback: (value: any, index: number[], matrix: T) => MathType | string
+  ): T
+
+  /**
+   * Iterate over all elements of multiple matrices/arrays, and executes the given
+   * callback function.
+   * @param x The first matrix to iterate on.
+   * @param args The rest of the matrices and at the end the callback function is invoked with multiple
+   * parameters: the values of the elements, the indices of the elements, and
+   * the matrices/arrays being traversed.
+   * @returns Transformed map of matrices
+   */
+  map<T extends MathCollection>(
+    x: T,
+    ...args: Array<
+      | T
+      | ((
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          value: any,
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          ...args: Array<any | number[] | T>
+        ) => MathType | string)
+    >
   ): T
 
   /**
@@ -2240,16 +2263,16 @@ export interface MathJsInstance extends MathJsFactory {
    **/
 
   /**
-   * Calculate N-dimensional fourier transform
+   * Calculate N-dimensional Fourier transform
    * @param {Array | Matrix} arr    An array or matrix
-   * @return {Array | Matrix}       N-dimensional fourier transformation of the array
+   * @return {Array | Matrix}       N-dimensional Fourier transformation of the array
    */
   fft<T extends MathCollection>(arr: T): T
 
   /**
-   * Calculate N-dimensional inverse fourier transform
+   * Calculate N-dimensional inverse Fourier transform
    * @param {Array | Matrix} arr    An array or matrix
-   * @return {Array | Matrix}       N-dimensional fourier transformation of the array
+   * @return {Array | Matrix}       N-dimensional Fourier transformation of the array
    */
   ifft<T extends MathCollection>(arr: T): T
 
@@ -3135,10 +3158,10 @@ export interface MathJsInstance extends MathJsFactory {
   acot<T extends BigNumber | Complex>(x: T): T
 
   /**
-   * Calculate the hyperbolic arccotangent of a value, defined as acoth(x)
+   * Calculate the inverse hyperbolic tangent of a value, defined as acoth(x)
    * = (ln((x+1)/x) + ln(x/(x-1))) / 2.
    * @param x Function input
-   * @returns The hyperbolic arccotangent of x
+   * @returns The inverse hyperbolic tangent of x
    */
   acoth(x: number): number
   acoth<T extends BigNumber | Complex>(x: T): T
@@ -3152,10 +3175,10 @@ export interface MathJsInstance extends MathJsFactory {
   acsc<T extends BigNumber | Complex>(x: T): T
 
   /**
-   * Calculate the hyperbolic arccosecant of a value, defined as acsch(x)
+   * Calculate the inverse hyperbolic cosecant of a value, defined as acsch(x)
    * = ln(1/x + sqrt(1/x^2 + 1)).
    * @param x Function input
-   * @returns The hyperbolic arccosecant of x
+   * @returns The inverse hyperbolic cosecant of x
    */
   acsch(x: number): number
   acsch<T extends BigNumber | Complex>(x: T): T
@@ -3380,6 +3403,14 @@ export interface MathJsInstance extends MathJsFactory {
 
   isObject(x: unknown): boolean
 
+  isMap<T, U>(x: unknown): x is Map<T, U>
+
+  isPartitionedMap<T, U>(x: unknown): x is PartitionedMap<T, U>
+
+  isObjectWrappingMap<T extends string | number | symbol, U>(
+    x: unknown
+  ): x is ObjectWrappingMap<T, U>
+
   isNull(x: unknown): x is null
 
   isUndefined(x: unknown): x is undefined
@@ -3989,15 +4020,17 @@ export interface MathJSON {
   fixPrefix?: boolean
 }
 
+export interface BaseUnit {
+  dimensions: number[]
+  key: string
+}
+
 export interface UnitComponent {
   power: number
   prefix: string
   unit: {
     name: string
-    base: {
-      dimensions: number[]
-      key: string
-    }
+    base: BaseUnit
     prefixes: Record<string, UnitPrefix>
     value: number
     offset: number
@@ -4014,8 +4047,7 @@ export interface UnitPrefix {
 export interface Unit {
   valueOf(): string
   clone(): Unit
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  hasBase(base: any): boolean
+  hasBase(base: BaseUnit | string | undefined): boolean
   equalBase(unit: Unit): boolean
   equals(unit: Unit): boolean
   multiply(unit: Unit): Unit
@@ -4040,6 +4072,40 @@ export interface Unit {
   skipAutomaticSimplification: true
 }
 
+export type UnitSystemName = 'si' | 'cgs' | 'us' | 'auto'
+
+export interface UnitStatic {
+  PREFIXES: Record<string, UnitPrefix>
+  BASE_DIMENSIONS: string[]
+  BASE_UNITS: Record<string, BaseUnit>
+  UNIT_SYSTEMS: Record<
+    UnitSystemName,
+    Record<string, { unit: Unit; prefix: UnitPrefix }>
+  >
+  UNITS: Record<string, Unit>
+  parse(str: string): Unit
+  isValuelessUnit(name: string): boolean
+  fromJSON(json: MathJSON): Unit
+  isValidAlpha(c: string): boolean
+  createUnit(
+    obj: Record<string, string | Unit | UnitDefinition>,
+    options?: { override: boolean }
+  ): Unit
+  createUnitSingle(
+    name: string,
+    definition: string | Unit | UnitDefinition
+  ): Unit
+  getUnitSystem(): UnitSystemName
+  setUnitSystem(name: UnitSystemName): void
+}
+
+export interface UnitCtor extends UnitStatic {
+  new (
+    value: number | BigNumber | Fraction | Complex | boolean,
+    name: string
+  ): Unit
+}
+
 export interface CreateUnitOptions {
   prefixes?: 'none' | 'short' | 'long' | 'binary_short' | 'binary_long'
   aliases?: string[]
@@ -4121,6 +4187,15 @@ export interface UnitDefinition {
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface Index {}
 
+export interface PartitionedMap<T, U> {
+  a: Map<T, U>
+  b: Map<T, U>
+}
+
+export interface ObjectWrappingMap<T extends string | number | symbol, U> {
+  wrappedObject: Record<T, U>
+}
+
 export interface EvalFunction {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   evaluate(scope?: any): any
@@ -4352,7 +4427,14 @@ export interface FormatOptions {
    * elsewhere. Lower bound is included, upper bound is excluded. For
    * example '123.4' and '1.4e7'.
    */
-  notation?: 'fixed' | 'exponential' | 'engineering' | 'auto'
+  notation?:
+    | 'fixed'
+    | 'exponential'
+    | 'engineering'
+    | 'auto'
+    | 'hex'
+    | 'bin'
+    | 'oct'
 
   /**
    * A number between 0 and 16 to round the digits of the number. In case
@@ -5016,9 +5098,9 @@ export interface MathJsChain<TValue> {
   ): MathJsChain<T>
 
   /**
-   * Calculate the hypotenusa of a list with values. The hypotenusa is
+   * Calculate the hypotenuse of a list with values. The hypotenuse is
    * defined as: hypot(a, b, c, ...) = sqrt(a^2 + b^2 + c^2 + ...) For
-   * matrix input, the hypotenusa is calculated for all values in the
+   * matrix input, the hypotenuse is calculated for all values in the
    * matrix.
    */
   hypot<T extends number | BigNumber>(this: MathJsChain<T[]>): MathJsChain<T>
@@ -5627,7 +5709,7 @@ export interface MathJsChain<TValue> {
   ): MathJsChain<NoLiteralType<T>>
 
   /**
-   * Calculate the kronecker product of two matrices or vectors
+   * Calculate the Kronecker product of two matrices or vectors
    * @param y Second vector
    */
   kron(
@@ -6485,7 +6567,7 @@ export interface MathJsChain<TValue> {
   ): MathJsChain<T>
 
   /**
-   * Calculate the hyperbolic arccotangent of a value, defined as acoth(x)
+   * Calculate the inverse hyperbolic tangent of a value, defined as acoth(x)
    * = (ln((x+1)/x) + ln(x/(x-1))) / 2. For matrices, the function is
    * evaluated element wise.
    */
@@ -6504,7 +6586,7 @@ export interface MathJsChain<TValue> {
   ): MathJsChain<T>
 
   /**
-   * Calculate the hyperbolic arccosecant of a value, defined as acsch(x)
+   * Calculate the inverse hyperbolic cosecant of a value, defined as acsch(x)
    * = ln(1/x + sqrt(1/x^2 + 1)). For matrices, the function is evaluated
    * element wise.
    */
@@ -6846,6 +6928,7 @@ export const {
   RelationalNode,
   SymbolNode,
   Matrix,
+  Unit,
 
   uninitialized,
   version,