mathjs 11.3.3 → 11.5.0

package/lib/esm/function/string/format.js

@@ -24,53 +24,53 @@ export var createFormat = /* #__PURE__ */factory(name, dependencies, _ref => {
    *    An object with formatting options. Available options:
    *    - `notation: string`
    *      Number notation. Choose from:
-   *      - 'fixed'
+   *      - `'fixed'`
    *        Always use regular number notation.
-   *        For example '123.40' and '14000000'
-   *      - 'exponential'
+   *        For example `'123.40'` and `'14000000'`
+   *      - `'exponential'`
    *        Always use exponential notation.
-   *        For example '1.234e+2' and '1.4e+7'
-   *      - 'engineering'
+   *        For example `'1.234e+2'` and `'1.4e+7'`
+   *      - `'engineering'`
    *        Always use engineering notation: always have exponential notation,
-   *        and select the exponent to be a multiple of 3.
-   *        For example '123.4e+0' and '14.0e+6'
-   *      - 'auto' (default)
+   *        and select the exponent to be a multiple of `3`.
+   *        For example `'123.4e+0'` and `'14.0e+6'`
+   *      - `'auto'` (default)
    *        Regular number notation for numbers having an absolute value between
    *        `lower` and `upper` bounds, and uses exponential notation elsewhere.
    *        Lower bound is included, upper bound is excluded.
-   *        For example '123.4' and '1.4e7'.
-   *      - 'bin', 'oct, or 'hex'
+   *        For example `'123.4'` and `'1.4e7'`.
+   *      - `'bin'`, `'oct'`, or `'hex'`
    *        Format the number using binary, octal, or hexadecimal notation.
-   *        For example '0b1101' and '0x10fe'.
+   *        For example `'0b1101'` and `'0x10fe'`.
    *    - `wordSize: number`
    *      The word size in bits to use for formatting in binary, octal, or
-   *      hexadecimal notation. To be used only with 'bin', 'oct', or 'hex'
-   *      values for 'notation' option. When this option is defined the value
+   *      hexadecimal notation. To be used only with `'bin'`, `'oct'`, or `'hex'`
+   *      values for `notation` option. When this option is defined the value
    *      is formatted as a signed twos complement integer of the given word
    *      size and the size suffix is appended to the output.
-   *      For example format(-1, {notation: 'hex', wordSize: 8}) === '0xffi8'.
+   *      For example `format(-1, {notation: 'hex', wordSize: 8}) === '0xffi8'`.
    *      Default value is undefined.
    *    - `precision: number`
    *      Limit the number of digits of the formatted value.
-   *      For regular numbers, must be a number between 0 and 16.
+   *      For regular numbers, must be a number between `0` and `16`.
    *      For bignumbers, the maximum depends on the configured precision,
    *      see function `config()`.
-   *      In case of notations 'exponential', 'engineering', and 'auto', `precision`
-   *      defines the total number of significant digits returned.
-   *      In case of notation 'fixed', `precision` defines the number of
+   *      In case of notations `'exponential'`, `'engineering'`, and `'auto'`,
+   *      `precision` defines the total number of significant digits returned.
+   *      In case of notation `'fixed'`, `precision` defines the number of
    *      significant digits after the decimal point.
    *      `precision` is undefined by default.
    *    - `lowerExp: number`
    *      Exponent determining the lower boundary for formatting a value with
-   *      an exponent when `notation='auto`. Default value is `-3`.
+   *      an exponent when `notation='auto'`. Default value is `-3`.
    *    - `upperExp: number`
    *      Exponent determining the upper boundary for formatting a value with
-   *      an exponent when `notation='auto`. Default value is `5`.
-   *    - `fraction: string`. Available values: 'ratio' (default) or 'decimal'.
-   *      For example `format(fraction(1, 3))` will output '1/3' when 'ratio' is
-   *      configured, and will output `0.(3)` when 'decimal' is configured.
+   *      an exponent when `notation='auto'`. Default value is `5`.
+   *    - `fraction: string`. Available values: `'ratio'` (default) or `'decimal'`.
+   *      For example `format(fraction(1, 3))` will output `'1/3'` when `'ratio'`
+   *      is configured, and will output `'0.(3)'` when `'decimal'` is configured.
    *    - `truncate: number`. Specifies the maximum allowed length of the
-   *      returned string. If it would have been longer, the excess characters
+   *      returned string. If it had been longer, the excess characters
    *      are deleted and replaced with `'...'`.
    * - `callback: function`
    *   A custom formatting function, invoked for all numeric elements in `value`,

package/lib/esm/version.js

@@ -1,3 +1,3 @@
-export var version = '11.3.3';
+export var version = '11.5.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": "11.3.3",
+  "version": "11.5.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,9 +25,9 @@
     "unit"
   ],
   "dependencies": {
-    "@babel/runtime": "^7.20.1",
+    "@babel/runtime": "^7.20.6",
     "complex.js": "^2.1.1",
-    "decimal.js": "^10.4.2",
+    "decimal.js": "^10.4.3",
     "escape-latex": "^1.2.0",
     "fraction.js": "^4.2.0",
     "javascript-natural-sort": "^0.7.1",
@@ -36,28 +36,28 @@
     "typed-function": "^4.1.0"
   },
   "devDependencies": {
-    "@babel/core": "7.20.2",
+    "@babel/core": "7.20.5",
     "@babel/plugin-transform-object-assign": "7.18.6",
     "@babel/plugin-transform-runtime": "7.19.6",
     "@babel/preset-env": "7.20.2",
     "@babel/register": "7.18.9",
     "@types/assert": "1.5.6",
-    "@types/mocha": "10.0.0",
-    "@typescript-eslint/eslint-plugin": "5.42.0",
-    "@typescript-eslint/parser": "5.42.0",
+    "@types/mocha": "10.0.1",
+    "@typescript-eslint/eslint-plugin": "5.45.0",
+    "@typescript-eslint/parser": "5.45.0",
     "assert": "2.0.0",
     "babel-loader": "9.1.0",
     "benchmark": "2.1.4",
     "codecov": "3.8.3",
-    "core-js": "3.26.0",
+    "core-js": "3.26.1",
     "del": "6.1.1",
     "dtslint": "4.2.1",
-    "eslint": "8.27.0",
+    "eslint": "8.29.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-config-standard": "17.0.0",
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-mocha": "10.1.0",
-    "eslint-plugin-n": "15.5.0",
+    "eslint-plugin-n": "15.6.0",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-promise": "6.1.1",
     "expect-type": "0.15.0",
@@ -78,7 +78,7 @@
     "math-expression-evaluator": "1.4.0",
     "mkdirp": "1.0.4",
     "mocha": "10.1.0",
-    "mocha-junit-reporter": "2.1.1",
+    "mocha-junit-reporter": "2.2.0",
     "ndarray": "1.0.19",
     "ndarray-determinant": "1.0.0",
     "ndarray-gemm": "1.0.0",
@@ -87,12 +87,12 @@
     "numericjs": "1.2.6",
     "nyc": "15.1.0",
     "pad-right": "0.2.2",
-    "prettier": "2.7.1",
+    "prettier": "2.8.0",
     "process": "0.11.10",
     "sylvester": "0.0.21",
     "ts-node": "10.9.1",
-    "typescript": "4.8.4",
-    "webpack": "5.74.0",
+    "typescript": "4.9.3",
+    "webpack": "5.75.0",
     "zeros": "1.0.0"
   },
   "type": "module",

package/types/index.d.ts

@@ -465,6 +465,11 @@ declare namespace math {
     R: MathCollection
   }
 
+  interface SchurDecomposition {
+    U: MathCollection
+    T: MathCollection
+  }
+
   interface FractionDefinition {
     a: number
     b: number
@@ -894,6 +899,22 @@ declare namespace math {
       threshold?: number
     ): MathArray
 
+    /* Finds the roots of a polynomial of degree three or less. Coefficients are given constant first
+     * followed by linear and higher powers in order; coefficients beyond the degree of the polynomial
+     * need not be specified.
+     * @param {number|Complex} constantCoeff
+     * @param {number|Complex} linearCoeff
+     * @param {number|Complex} quadraticCoeff
+     * @param {number|Complex} cubicCoeff
+     * @returns {Array<number|Complex>} array of roots of specified polynomial
+     */
+    polynomialRoot(
+      constantCoeff: number | Complex,
+      linearCoeff: number | Complex,
+      quadraticCoeff?: number | Complex,
+      cubicCoeff?: number | Complex
+    ): (number | Complex)[]
+
     /**
      * Calculate the Matrix QR decomposition. Matrix A is decomposed in two
      * matrices (Q, R) where Q is an orthogonal matrix and R is an upper
@@ -1276,9 +1297,13 @@ declare namespace math {
     multiply<T extends Matrix>(x: T, y: MathType): Matrix
     multiply<T extends Matrix>(x: MathType, y: T): Matrix
 
+    multiply<T extends MathNumericType[]>(x: T, y: T[]): T
+    multiply<T extends MathNumericType[]>(x: T[], y: T): T
+
+    multiply<T extends MathArray>(x: T, y: T): T
+
     multiply(x: Unit, y: Unit): Unit
     multiply(x: number, y: number): number
-    multiply(x: MathArray, y: MathArray): MathArray
     multiply(x: MathType, y: MathType): MathType
 
     /**
@@ -1807,6 +1832,41 @@ declare namespace math {
      */
     expm(x: Matrix): Matrix
 
+    /**
+     * Solves the real-valued Sylvester equation AX-XB=C for X, where A, B and C are
+     * matrices of appropriate dimensions, being A and B squared. The method used is
+     * the Bartels-Stewart algorithm.
+     * https://en.wikipedia.org/wiki/Sylvester_equation
+     * @param A  Matrix A
+     * @param B  Matrix B
+     * @param C  Matrix C
+     * @returns  Matrix X, solving the Sylvester equation
+     */
+    sylvester(
+      A: Matrix | MathArray,
+      B: Matrix | MathArray,
+      C: Matrix | MathArray
+    ): Matrix | MathArray
+
+    /**
+     * Performs a real Schur decomposition of the real matrix A = UTU' where U is orthogonal
+     * and T is upper quasi-triangular.
+     * https://en.wikipedia.org/wiki/Schur_decomposition
+     * @param A  Matrix A
+     * @returns Object containing both matrix U and T of the Schur Decomposition A=UTU'
+     */
+    schur(A: Matrix | MathArray): SchurDecomposition
+
+    /**
+     * Solves the Continuous-time Lyapunov equation AP+PA'=Q for P, where Q is a positive semidefinite
+     * matrix.
+     * https://en.wikipedia.org/wiki/Lyapunov_equation
+     * @param A  Matrix A
+     * @param Q  Matrix Q
+     * @returns  Matrix P solution to the Continuous-time Lyapunov equation AP+PA'=Q
+     */
+    lyap(A: Matrix | MathArray, Q: Matrix | MathArray): Matrix | MathArray
+
     /**
      * Create a 2-dimensional identity matrix with size m x n or n x n. The
      * matrix has ones on the diagonal and zeros elsewhere.
@@ -3572,6 +3632,9 @@ declare namespace math {
     invDependencies: FactoryFunctionMap
     expmDependencies: FactoryFunctionMap
     sqrtmDependencies: FactoryFunctionMap
+    sylvesterDependencies: FactoryFunctionMap
+    schurDependencies: FactoryFunctionMap
+    lyapDependencies: FactoryFunctionMap
     divideDependencies: FactoryFunctionMap
     distanceDependencies: FactoryFunctionMap
     intersectDependencies: FactoryFunctionMap
@@ -3977,8 +4040,8 @@ declare namespace math {
      */
     forEach(
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      callback: (node: MathNode, path: string, parent: MathNode) => any
-    ): MathNode[]
+      callback: (node: MathNode, path: string, parent: MathNode) => void
+    ): void
 
     /**
      * Transform a node. Creates a new MathNode having it’s child's be the
@@ -4071,8 +4134,7 @@ declare namespace math {
      */
     traverse(
       callback: (node: MathNode, path: string, parent: MathNode) => void
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    ): any
+    ): void
   }
 
   interface Parser {
@@ -5273,6 +5335,26 @@ declare namespace math {
 
     expm(this: MathJsChain<Matrix>): MathJsChain<Matrix>
 
+    /**
+     * Performs a real Schur decomposition of the real matrix A = UTU' where U is orthogonal
+     * and T is upper quasi-triangular.
+     * https://en.wikipedia.org/wiki/Schur_decomposition
+     * @returns Object containing both matrix U and T of the Schur Decomposition A=UTU'
+     */
+    schur(this: MathJsChain<Matrix | MathArray>): SchurDecomposition
+
+    /**
+     * Solves the Continuous-time Lyapunov equation AP+PA'=Q for P, where Q is a positive semidefinite
+     * matrix.
+     * https://en.wikipedia.org/wiki/Lyapunov_equation
+     * @param Q  Matrix Q
+     * @returns  Matrix P solution to the Continuous-time Lyapunov equation AP+PA'=Q
+     */
+    lyap(
+      this: MathJsChain<Matrix | MathArray>,
+      Q: Matrix | MathArray
+    ): MathJsChain<Matrix | MathArray>
+
     /**
      * Create a 2-dimensional identity matrix with size m x n or n x n. The
      * matrix has ones on the diagonal and zeros elsewhere.
@@ -5323,7 +5405,7 @@ declare namespace math {
       this: MathJsChain<T>,
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       callback: (value: any, index: any, matrix: T) => void
-    ): MathJsChain<T>
+    ): void
 
     /**
      * Calculate the inverse of a square matrix.