mathjs 11.3.3 → 11.5.0

package/lib/cjs/expression/embeddedDocs/function/matrix/sylvester.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sylvesterDocs = void 0;
+var sylvesterDocs = {
+  name: 'sylvester',
+  category: 'Matrix',
+  syntax: ['sylvester(A,B,C)'],
+  description: 'Solves the real-valued Sylvester equation AX+XB=C for X',
+  examples: ['sylvester([[-1, -2], [1, 1]], [[-2, 1], [-1, 2]], [[-3, 2], [3, 0]])', 'sylvester(A,B,C)'],
+  seealso: ['schur', 'lyap']
+};
+exports.sylvesterDocs = sylvesterDocs;

package/lib/cjs/factoriesAny.js

@@ -1083,6 +1083,12 @@ Object.defineProperty(exports, "createLusolve", {
     return _lusolve.createLusolve;
   }
 });
+Object.defineProperty(exports, "createLyap", {
+  enumerable: true,
+  get: function get() {
+    return _lyap.createLyap;
+  }
+});
 Object.defineProperty(exports, "createMad", {
   enumerable: true,
   get: function get() {
@@ -1431,6 +1437,12 @@ Object.defineProperty(exports, "createPlanckTime", {
     return _physicalConstants.createPlanckTime;
   }
 });
+Object.defineProperty(exports, "createPolynomialRoot", {
+  enumerable: true,
+  get: function get() {
+    return _polynomialRoot.createPolynomialRoot;
+  }
+});
 Object.defineProperty(exports, "createPow", {
   enumerable: true,
   get: function get() {
@@ -1635,6 +1647,12 @@ Object.defineProperty(exports, "createSackurTetrode", {
     return _physicalConstants.createSackurTetrode;
   }
 });
+Object.defineProperty(exports, "createSchur", {
+  enumerable: true,
+  get: function get() {
+    return _schur.createSchur;
+  }
+});
 Object.defineProperty(exports, "createSec", {
   enumerable: true,
   get: function get() {
@@ -1893,6 +1911,12 @@ Object.defineProperty(exports, "createSumTransform", {
     return _sumTransform.createSumTransform;
   }
 });
+Object.defineProperty(exports, "createSylvester", {
+  enumerable: true,
+  get: function get() {
+    return _sylvester.createSylvester;
+  }
+});
 Object.defineProperty(exports, "createSymbolNode", {
   enumerable: true,
   get: function get() {
@@ -2285,6 +2309,7 @@ var _lup = require("./function/algebra/decomposition/lup.js");
 var _qr = require("./function/algebra/decomposition/qr.js");
 var _slu = require("./function/algebra/decomposition/slu.js");
 var _lusolve = require("./function/algebra/solver/lusolve.js");
+var _polynomialRoot = require("./function/algebra/polynomialRoot.js");
 var _Help = require("./expression/Help.js");
 var _Chain = require("./type/chain/Chain.js");
 var _help = require("./expression/function/help.js");
@@ -2295,6 +2320,9 @@ var _pinv = require("./function/matrix/pinv.js");
 var _eigs = require("./function/matrix/eigs.js");
 var _expm2 = require("./function/matrix/expm.js");
 var _sqrtm = require("./function/matrix/sqrtm.js");
+var _sylvester = require("./function/algebra/sylvester.js");
+var _schur = require("./function/algebra/decomposition/schur.js");
+var _lyap = require("./function/algebra/lyap.js");
 var _divide = require("./function/arithmetic/divide.js");
 var _distance = require("./function/geometry/distance.js");
 var _intersect = require("./function/geometry/intersect.js");

package/lib/cjs/function/algebra/decomposition/schur.js

@@ -0,0 +1,75 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createSchur = void 0;
+var _factory = require("../../../utils/factory.js");
+var name = 'schur';
+var dependencies = ['typed', 'matrix', 'identity', 'multiply', 'qr', 'norm', 'subtract'];
+var createSchur = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
+  var typed = _ref.typed,
+    matrix = _ref.matrix,
+    identity = _ref.identity,
+    multiply = _ref.multiply,
+    qr = _ref.qr,
+    norm = _ref.norm,
+    subtract = _ref.subtract;
+  /**
+   *
+   * 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
+   *
+   * Syntax:
+   *
+   *     math.schur(A)
+   *
+   * Examples:
+   *
+   *     const A = [[1, 0], [-4, 3]]
+   *     math.schur(A) // returns {T: [[3, 4], [0, 1]], R: [[0, 1], [-1, 0]]}
+   *
+   * See also:
+   *
+   *     sylvester, lyap, qr
+   *
+   * @param {Array | Matrix} A  Matrix A
+   * @return {{U: Array | Matrix, T: Array | Matrix}} Object containing both matrix U and T of the Schur Decomposition A=UTU'
+   */
+  return typed(name, {
+    Array: function Array(X) {
+      var r = _schur(matrix(X));
+      return {
+        U: r.U.valueOf(),
+        T: r.T.valueOf()
+      };
+    },
+    Matrix: function Matrix(X) {
+      return _schur(X);
+    }
+  });
+  function _schur(X) {
+    var n = X.size()[0];
+    var A = X;
+    var U = identity(n);
+    var k = 0;
+    var A0;
+    do {
+      A0 = A;
+      var QR = qr(A);
+      var Q = QR.Q;
+      var R = QR.R;
+      A = multiply(R, Q);
+      U = multiply(U, Q);
+      if (k++ > 100) {
+        break;
+      }
+    } while (norm(subtract(A, A0)) > 1e-4);
+    return {
+      U: U,
+      T: A
+    };
+  }
+});
+exports.createSchur = createSchur;

package/lib/cjs/function/algebra/lyap.js

@@ -0,0 +1,57 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createLyap = void 0;
+var _factory = require("../../utils/factory.js");
+var name = 'lyap';
+var dependencies = ['typed', 'matrix', 'sylvester', 'multiply', 'transpose'];
+var createLyap = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
+  var typed = _ref.typed,
+    matrix = _ref.matrix,
+    sylvester = _ref.sylvester,
+    multiply = _ref.multiply,
+    transpose = _ref.transpose;
+  /**
+   *
+   * Solves the Continuous-time Lyapunov equation AP+PA'+Q=0 for P, where
+   * Q is an input matrix. When Q is symmetric, P is also symmetric. Notice
+   * that different equivalent definitions exist for the Continuous-time
+   * Lyapunov equation.
+   * https://en.wikipedia.org/wiki/Lyapunov_equation
+   *
+   * Syntax:
+   *
+   *     math.lyap(A, Q)
+   *
+   * Examples:
+   *
+   *     const A = [[-2, 0], [1, -4]]
+   *     const Q = [[3, 1], [1, 3]]
+   *     const P = math.lyap(A, Q)
+   *
+   * See also:
+   *
+   *     sylvester, schur
+   *
+   * @param {Matrix | Array} A  Matrix A
+   * @param {Matrix | Array} Q  Matrix Q
+   * @return {Matrix | Array} Matrix P solution to the Continuous-time Lyapunov equation AP+PA'=Q
+   */
+  return typed(name, {
+    'Matrix, Matrix': function MatrixMatrix(A, Q) {
+      return sylvester(A, transpose(A), multiply(-1, Q));
+    },
+    'Array, Matrix': function ArrayMatrix(A, Q) {
+      return sylvester(matrix(A), transpose(matrix(A)), multiply(-1, Q));
+    },
+    'Matrix, Array': function MatrixArray(A, Q) {
+      return sylvester(A, transpose(matrix(A)), matrix(multiply(-1, Q)));
+    },
+    'Array, Array': function ArrayArray(A, Q) {
+      return sylvester(matrix(A), transpose(matrix(A)), matrix(multiply(-1, Q))).toArray();
+    }
+  });
+});
+exports.createLyap = createLyap;

package/lib/cjs/function/algebra/polynomialRoot.js

@@ -0,0 +1,139 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createPolynomialRoot = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _factory = require("../../utils/factory.js");
+var name = 'polynomialRoot';
+var dependencies = ['typed', 'isZero', 'equalScalar', 'add', 'subtract', 'multiply', 'divide', 'sqrt', 'unaryMinus', 'cbrt', 'typeOf', 'im', 're'];
+var createPolynomialRoot = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
+  var typed = _ref.typed,
+    isZero = _ref.isZero,
+    equalScalar = _ref.equalScalar,
+    add = _ref.add,
+    subtract = _ref.subtract,
+    multiply = _ref.multiply,
+    divide = _ref.divide,
+    sqrt = _ref.sqrt,
+    unaryMinus = _ref.unaryMinus,
+    cbrt = _ref.cbrt,
+    typeOf = _ref.typeOf,
+    im = _ref.im,
+    re = _ref.re;
+  /**
+   * Finds the numerical values of the distinct roots of a polynomial with real or complex coefficients.
+   * Currently operates only on linear, quadratic, and cubic polynomials using the standard
+   * formulas for the roots.
+   *
+   * Syntax:
+   *
+   *     polynomialRoot(constant, linearCoeff, quadraticCoeff, cubicCoeff)
+   *
+   * Examples:
+   *     // linear
+   *     math.polynomialRoot(6, 3)                                        // [-2]
+   *     math.polynomialRoot(math.complex(6,3), 3)                        // [-2 - i]
+   *     math.polynomialRoot(math.complex(6,3), math.complex(2,1))        // [-3 + 0i]
+   *     // quadratic
+   *     math.polynomialRoot(2, -3, 1)                                    // [2, 1]
+   *     math.polynomialRoot(8, 8, 2)                                     // [-2]
+   *     math.polynomialRoot(-2, 0, 1)                                    // [1.4142135623730951, -1.4142135623730951]
+   *     math.polynomialRoot(2, -2, 1)                                    // [1 + i, 1 - i]
+   *     math.polynomialRoot(math.complex(1,3), math.complex(-3, -2), 1)  // [2 + i, 1 + i]
+   *     // cubic
+   *     math.polynomialRoot(-6, 11, -6, 1)                               // [1, 3, 2]
+   *     math.polynomialRoot(-8, 0, 0, 1)                                 // [-1 - 1.7320508075688774i, 2, -1 + 1.7320508075688774i]
+   *     math.polynomialRoot(0, 8, 8, 2)                                  // [0, -2]
+   *     math.polynomialRoot(1, 1, 1, 1)                                  // [-1 + 0i, 0 - i, 0 + i]
+   *
+   * See also:
+   *     cbrt, sqrt
+   *
+   * @param {... number | Complex} coeffs
+   *     The coefficients of the polynomial, starting with with the constant coefficent, followed
+   *     by the linear coefficient and subsequent coefficients of increasing powers.
+   * @return {Array} The distinct roots of the polynomial
+   */
+
+  return typed(name, {
+    'number|Complex, ...number|Complex': function numberComplexNumberComplex(constant, restCoeffs) {
+      var coeffs = [constant].concat((0, _toConsumableArray2["default"])(restCoeffs));
+      while (coeffs.length > 0 && isZero(coeffs[coeffs.length - 1])) {
+        coeffs.pop();
+      }
+      if (coeffs.length < 2) {
+        throw new RangeError("Polynomial [".concat(constant, ", ").concat(restCoeffs, "] must have a non-zero non-constant coefficient"));
+      }
+      switch (coeffs.length) {
+        case 2:
+          // linear
+          return [unaryMinus(divide(coeffs[0], coeffs[1]))];
+        case 3:
+          {
+            // quadratic
+            var _coeffs = (0, _slicedToArray2["default"])(coeffs, 3),
+              c = _coeffs[0],
+              b = _coeffs[1],
+              a = _coeffs[2];
+            var denom = multiply(2, a);
+            var d1 = multiply(b, b);
+            var d2 = multiply(4, a, c);
+            if (equalScalar(d1, d2)) return [divide(unaryMinus(b), denom)];
+            var discriminant = sqrt(subtract(d1, d2));
+            return [divide(subtract(discriminant, b), denom), divide(subtract(unaryMinus(discriminant), b), denom)];
+          }
+        case 4:
+          {
+            // cubic, cf. https://en.wikipedia.org/wiki/Cubic_equation
+            var _coeffs2 = (0, _slicedToArray2["default"])(coeffs, 4),
+              d = _coeffs2[0],
+              _c = _coeffs2[1],
+              _b = _coeffs2[2],
+              _a = _coeffs2[3];
+            var _denom = unaryMinus(multiply(3, _a));
+            var D0_1 = multiply(_b, _b);
+            var D0_2 = multiply(3, _a, _c);
+            var D1_1 = add(multiply(2, _b, _b, _b), multiply(27, _a, _a, d));
+            var D1_2 = multiply(9, _a, _b, _c);
+            if (equalScalar(D0_1, D0_2) && equalScalar(D1_1, D1_2)) {
+              return [divide(_b, _denom)];
+            }
+            var Delta0 = subtract(D0_1, D0_2);
+            var Delta1 = subtract(D1_1, D1_2);
+            var discriminant1 = add(multiply(18, _a, _b, _c, d), multiply(_b, _b, _c, _c));
+            var discriminant2 = add(multiply(4, _b, _b, _b, d), multiply(4, _a, _c, _c, _c), multiply(27, _a, _a, d, d));
+            if (equalScalar(discriminant1, discriminant2)) {
+              return [divide(subtract(multiply(4, _a, _b, _c), add(multiply(9, _a, _a, d), multiply(_b, _b, _b))), multiply(_a, Delta0)),
+              // simple root
+              divide(subtract(multiply(9, _a, d), multiply(_b, _c)), multiply(2, Delta0)) // double root
+              ];
+            }
+            // OK, we have three distinct roots
+            var Ccubed;
+            if (equalScalar(D0_1, D0_2)) {
+              Ccubed = Delta1;
+            } else {
+              Ccubed = divide(add(Delta1, sqrt(subtract(multiply(Delta1, Delta1), multiply(4, Delta0, Delta0, Delta0)))), 2);
+            }
+            var allRoots = true;
+            var rawRoots = cbrt(Ccubed, allRoots).toArray().map(function (C) {
+              return divide(add(_b, C, divide(Delta0, C)), _denom);
+            });
+            return rawRoots.map(function (r) {
+              if (typeOf(r) === 'Complex' && equalScalar(re(r), re(r) + im(r))) {
+                return re(r);
+              }
+              return r;
+            });
+          }
+        default:
+          throw new RangeError("only implemented for cubic or lower-order polynomials, not ".concat(coeffs));
+      }
+    }
+  });
+});
+exports.createPolynomialRoot = createPolynomialRoot;

package/lib/cjs/function/algebra/simplify/wildcards.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isConstantExpression = isConstantExpression;
+Object.defineProperty(exports, "isConstantNode", {
+  enumerable: true,
+  get: function get() {
+    return _is.isConstantNode;
+  }
+});
+exports.isNumericNode = isNumericNode;
+Object.defineProperty(exports, "isVariableNode", {
+  enumerable: true,
+  get: function get() {
+    return _is.isSymbolNode;
+  }
+});
+var _is = require("../../../utils/is.js");
+function isNumericNode(x) {
+  return (0, _is.isConstantNode)(x) || (0, _is.isOperatorNode)(x) && x.isUnary() && (0, _is.isConstantNode)(x.args[0]);
+}
+function isConstantExpression(x) {
+  if ((0, _is.isConstantNode)(x)) {
+    // Basic Constant types
+    return true;
+  }
+  if (((0, _is.isFunctionNode)(x) || (0, _is.isOperatorNode)(x)) && x.args.every(isConstantExpression)) {
+    // Can be constant depending on arguments
+    return true;
+  }
+  if ((0, _is.isParenthesisNode)(x) && isConstantExpression(x.content)) {
+    // Parenthesis are transparent
+    return true;
+  }
+  return false; // Probably missing some edge cases
+}