mathjs 11.3.2 → 11.4.0

package/types/index.d.ts

@@ -287,8 +287,8 @@ declare namespace math {
   interface FunctionNodeCtor {
     new <TFn = SymbolNode, TArgs extends MathNode[] = MathNode[]>(
       fn: TFn,
-      args: SymbolNode
-    ): FunctionNode<TransferFunction, TArgs>
+      args: TArgs
+    ): FunctionNode<TFn, TArgs>
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     onUndefinedFunction: (name: string) => any
   }
@@ -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
@@ -1807,6 +1828,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 +3628,9 @@ declare namespace math {
     invDependencies: FactoryFunctionMap
     expmDependencies: FactoryFunctionMap
     sqrtmDependencies: FactoryFunctionMap
+    sylvesterDependencies: FactoryFunctionMap
+    schurDependencies: FactoryFunctionMap
+    lyapDependencies: FactoryFunctionMap
     divideDependencies: FactoryFunctionMap
     distanceDependencies: FactoryFunctionMap
     intersectDependencies: FactoryFunctionMap
@@ -3977,8 +4036,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 +4130,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 +5331,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 +5401,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.