mathjs-min 11.7.2

package/lib/esm/function/algebra/sparse/csSymperm.js

@@ -0,0 +1,92 @@
+import { csCumsum } from './csCumsum.js';
+import { factory } from '../../../utils/factory.js';
+var name = 'csSymperm';
+var dependencies = ['conj', 'SparseMatrix'];
+export var createCsSymperm = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    conj,
+    SparseMatrix
+  } = _ref;
+  /**
+   * Computes the symmetric permutation of matrix A accessing only
+   * the upper triangular part of A.
+   *
+   * C = P * A * P'
+   *
+   * @param {Matrix}  a               The A matrix
+   * @param {Array}   pinv            The inverse of permutation vector
+   * @param {boolean} values          Process matrix values (true)
+   *
+   * @return {Matrix}                 The C matrix, C = P * A * P'
+   *
+   * Reference: http://faculty.cse.tamu.edu/davis/publications.html
+   */
+  return function csSymperm(a, pinv, values) {
+    // A matrix arrays
+    var avalues = a._values;
+    var aindex = a._index;
+    var aptr = a._ptr;
+    var asize = a._size;
+    // columns
+    var n = asize[1];
+    // C matrix arrays
+    var cvalues = values && avalues ? [] : null;
+    var cindex = []; // (nz)
+    var cptr = []; // (n + 1)
+    // variables
+    var i, i2, j, j2, p, p0, p1;
+    // create workspace vector
+    var w = []; // (n)
+    // count entries in each column of C
+    for (j = 0; j < n; j++) {
+      // column j of A is column j2 of C
+      j2 = pinv ? pinv[j] : j;
+      // loop values in column j
+      for (p0 = aptr[j], p1 = aptr[j + 1], p = p0; p < p1; p++) {
+        // row
+        i = aindex[p];
+        // skip lower triangular part of A
+        if (i > j) {
+          continue;
+        }
+        // row i of A is row i2 of C
+        i2 = pinv ? pinv[i] : i;
+        // column count of C
+        w[Math.max(i2, j2)]++;
+      }
+    }
+    // compute column pointers of C
+    csCumsum(cptr, w, n);
+    // loop columns
+    for (j = 0; j < n; j++) {
+      // column j of A is column j2 of C
+      j2 = pinv ? pinv[j] : j;
+      // loop values in column j
+      for (p0 = aptr[j], p1 = aptr[j + 1], p = p0; p < p1; p++) {
+        // row
+        i = aindex[p];
+        // skip lower triangular part of A
+        if (i > j) {
+          continue;
+        }
+        // row i of A is row i2 of C
+        i2 = pinv ? pinv[i] : i;
+        // C index for column j2
+        var q = w[Math.max(i2, j2)]++;
+        // update C index for entry q
+        cindex[q] = Math.min(i2, j2);
+        // check we need to process values
+        if (cvalues) {
+          cvalues[q] = i2 <= j2 ? avalues[p] : conj(avalues[p]);
+        }
+      }
+    }
+    // return C matrix
+    return new SparseMatrix({
+      values: cvalues,
+      index: cindex,
+      ptr: cptr,
+      size: [n, n]
+    });
+  };
+});

package/lib/esm/function/algebra/sparse/csTdfs.js

@@ -0,0 +1,40 @@
+/**
+ * Depth-first search and postorder of a tree rooted at node j
+ *
+ * @param {Number}  j               The tree node
+ * @param {Number}  k
+ * @param {Array}   w               The workspace array
+ * @param {Number}  head            The index offset within the workspace for the head array
+ * @param {Number}  next            The index offset within the workspace for the next array
+ * @param {Array}   post            The post ordering array
+ * @param {Number}  stack           The index offset within the workspace for the stack array
+ *
+ * Reference: http://faculty.cse.tamu.edu/davis/publications.html
+ */
+export function csTdfs(j, k, w, head, next, post, stack) {
+  // variables
+  var top = 0;
+  // place j on the stack
+  w[stack] = j;
+  // while (stack is not empty)
+  while (top >= 0) {
+    // p = top of stack
+    var p = w[stack + top];
+    // i = youngest child of p
+    var i = w[head + p];
+    if (i === -1) {
+      // p has no unordered children left
+      top--;
+      // node p is the kth postordered node
+      post[k++] = p;
+    } else {
+      // remove i from children of p
+      w[head + p] = w[next + i];
+      // increment top
+      ++top;
+      // start dfs on child node i
+      w[stack + top] = i;
+    }
+  }
+  return k;
+}

package/lib/esm/function/algebra/sparse/csUnflip.js

@@ -0,0 +1,13 @@
+import { csFlip } from './csFlip.js';
+
+/**
+ * Flips the value if it is negative of returns the same value otherwise.
+ *
+ * @param {Number}  i               The value to flip
+ *
+ * Reference: http://faculty.cse.tamu.edu/davis/publications.html
+ */
+export function csUnflip(i) {
+  // flip the value if it is negative
+  return i < 0 ? csFlip(i) : i;
+}

package/lib/esm/function/algebra/sylvester.js

@@ -0,0 +1,118 @@
+import { factory } from '../../utils/factory.js';
+var name = 'sylvester';
+var dependencies = ['typed', 'schur', 'matrixFromColumns', 'matrix', 'multiply', 'range', 'concat', 'transpose', 'index', 'subset', 'add', 'subtract', 'identity', 'lusolve', 'abs'];
+export var createSylvester = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed,
+    schur,
+    matrixFromColumns,
+    matrix,
+    multiply,
+    range,
+    concat,
+    transpose,
+    index,
+    subset,
+    add,
+    subtract,
+    identity,
+    lusolve,
+    abs
+  } = _ref;
+  /**
+   *
+   * 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. Notice that other
+   * equivalent definitions for the Sylvester equation exist and this function
+   * assumes the one presented in the original publication of the the Bartels-
+   * Stewart algorithm, which is implemented by this function.
+   * https://en.wikipedia.org/wiki/Sylvester_equation
+   *
+   * Syntax:
+   *
+   *     math.sylvester(A, B, C)
+   *
+   * Examples:
+   *
+   *     const A = [[-1, -2], [1, 1]]
+   *     const B = [[2, -1], [1, -2]]
+   *     const C = [[-3, 2], [3, 0]]
+   *     math.sylvester(A, B, C)      // returns DenseMatrix [[-0.25, 0.25], [1.5, -1.25]]
+   *
+   * See also:
+   *
+   *     schur, lyap
+   *
+   * @param {Matrix | Array} A  Matrix A
+   * @param {Matrix | Array} B  Matrix B
+   * @param {Matrix | Array} C  Matrix C
+   * @return {Matrix | Array}   Matrix X, solving the Sylvester equation
+   */
+  return typed(name, {
+    'Matrix, Matrix, Matrix': _sylvester,
+    'Array, Matrix, Matrix': function ArrayMatrixMatrix(A, B, C) {
+      return _sylvester(matrix(A), B, C);
+    },
+    'Array, Array, Matrix': function ArrayArrayMatrix(A, B, C) {
+      return _sylvester(matrix(A), matrix(B), C);
+    },
+    'Array, Matrix, Array': function ArrayMatrixArray(A, B, C) {
+      return _sylvester(matrix(A), B, matrix(C));
+    },
+    'Matrix, Array, Matrix': function MatrixArrayMatrix(A, B, C) {
+      return _sylvester(A, matrix(B), C);
+    },
+    'Matrix, Array, Array': function MatrixArrayArray(A, B, C) {
+      return _sylvester(A, matrix(B), matrix(C));
+    },
+    'Matrix, Matrix, Array': function MatrixMatrixArray(A, B, C) {
+      return _sylvester(A, B, matrix(C));
+    },
+    'Array, Array, Array': function ArrayArrayArray(A, B, C) {
+      return _sylvester(matrix(A), matrix(B), matrix(C)).toArray();
+    }
+  });
+  function _sylvester(A, B, C) {
+    var n = B.size()[0];
+    var m = A.size()[0];
+    var sA = schur(A);
+    var F = sA.T;
+    var U = sA.U;
+    var sB = schur(multiply(-1, B));
+    var G = sB.T;
+    var V = sB.U;
+    var D = multiply(multiply(transpose(U), C), V);
+    var all = range(0, m);
+    var y = [];
+    var hc = (a, b) => concat(a, b, 1);
+    var vc = (a, b) => concat(a, b, 0);
+    for (var k = 0; k < n; k++) {
+      if (k < n - 1 && abs(subset(G, index(k + 1, k))) > 1e-5) {
+        var RHS = vc(subset(D, index(all, k)), subset(D, index(all, k + 1)));
+        for (var j = 0; j < k; j++) {
+          RHS = add(RHS, vc(multiply(y[j], subset(G, index(j, k))), multiply(y[j], subset(G, index(j, k + 1)))));
+        }
+        var gkk = multiply(identity(m), multiply(-1, subset(G, index(k, k))));
+        var gmk = multiply(identity(m), multiply(-1, subset(G, index(k + 1, k))));
+        var gkm = multiply(identity(m), multiply(-1, subset(G, index(k, k + 1))));
+        var gmm = multiply(identity(m), multiply(-1, subset(G, index(k + 1, k + 1))));
+        var LHS = vc(hc(add(F, gkk), gmk), hc(gkm, add(F, gmm)));
+        var yAux = lusolve(LHS, RHS);
+        y[k] = yAux.subset(index(range(0, m), 0));
+        y[k + 1] = yAux.subset(index(range(m, 2 * m), 0));
+        k++;
+      } else {
+        var _RHS = subset(D, index(all, k));
+        for (var _j = 0; _j < k; _j++) {
+          _RHS = add(_RHS, multiply(y[_j], subset(G, index(_j, k))));
+        }
+        var _gkk = subset(G, index(k, k));
+        var _LHS = subtract(F, multiply(_gkk, identity(m)));
+        y[k] = lusolve(_LHS, _RHS);
+      }
+    }
+    var Y = matrix(matrixFromColumns(...y));
+    var X = multiply(U, multiply(Y, transpose(V)));
+    return X;
+  }
+});

package/lib/esm/function/algebra/symbolicEqual.js

@@ -0,0 +1,60 @@
+import { isConstantNode } from '../../utils/is.js';
+import { factory } from '../../utils/factory.js';
+var name = 'symbolicEqual';
+var dependencies = ['parse', 'simplify', 'typed', 'OperatorNode'];
+export var createSymbolicEqual = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    parse,
+    simplify,
+    typed,
+    OperatorNode
+  } = _ref;
+  /**
+   * Attempts to determine if two expressions are symbolically equal, i.e.
+   * one is the result of valid algebraic manipulations on the other.
+   * Currently, this simply checks if the difference of the two expressions
+   * simplifies down to 0. So there are two important caveats:
+   * 1. whether two expressions are symbolically equal depends on the
+   *     manipulations allowed. Therefore, this function takes an optional
+   *     third argument, which are the options that control the behavior
+   *     as documented for the `simplify()` function.
+   * 2. it is in general intractable to find the minimal simplification of
+   *     an arbitrarily complicated expression. So while a `true` value
+   *     of `symbolicEqual` ensures that the two expressions can be manipulated
+   *     to match each other, a `false` value does not absolutely rule this out.
+   *
+   * Syntax:
+   *
+   *    symbolicEqual(expr1, expr2)
+   *    symbolicEqual(expr1, expr2, options)
+   *
+   * Examples:
+   *
+   *    symbolicEqual('x*y', 'y*x') // Returns true
+   *    symbolicEqual('x*y', 'y*x', {context: {multiply: {commutative: false}}}) // Returns false
+   *    symbolicEqual('x/y', '(y*x^(-1))^(-1)') // Returns true
+   *    symbolicEqual('abs(x)','x') // Returns false
+   *    symbolicEqual('abs(x)','x', simplify.positiveContext) // Returns true
+   *
+   * See also:
+   *
+   *    simplify, evaluate
+   *
+   * @param {Node|string} expr1  The first expression to compare
+   * @param {Node|string} expr2  The second expression to compare
+   * @param {Object} [options] Optional option object, passed to simplify
+   * @returns {boolean}
+   *     Returns true if a valid manipulation making the expressions equal
+   *     is found.
+   */
+  function _symbolicEqual(e1, e2) {
+    var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+    var diff = new OperatorNode('-', 'subtract', [e1, e2]);
+    var simplified = simplify(diff, {}, options);
+    return isConstantNode(simplified) && !simplified.value;
+  }
+  return typed(name, {
+    'Node, Node': _symbolicEqual,
+    'Node, Node, Object': _symbolicEqual
+  });
+});

package/lib/esm/function/arithmetic/abs.js

@@ -0,0 +1,40 @@
+import { factory } from '../../utils/factory.js';
+import { deepMap } from '../../utils/collection.js';
+import { absNumber } from '../../plain/number/index.js';
+var name = 'abs';
+var dependencies = ['typed'];
+export var createAbs = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed
+  } = _ref;
+  /**
+   * Calculate the absolute value of a number. For matrices, the function is
+   * evaluated element wise.
+   *
+   * Syntax:
+   *
+   *    math.abs(x)
+   *
+   * Examples:
+   *
+   *    math.abs(3.5)                // returns number 3.5
+   *    math.abs(-4.2)               // returns number 4.2
+   *
+   *    math.abs([3, -5, -1, 0, 2])  // returns Array [3, 5, 1, 0, 2]
+   *
+   * See also:
+   *
+   *    sign
+   *
+   * @param  {number | BigNumber | Fraction | Complex | Array | Matrix | Unit} x
+   *            A number or matrix for which to get the absolute value
+   * @return {number | BigNumber | Fraction | Complex | Array | Matrix | Unit}
+   *            Absolute value of `x`
+   */
+  return typed(name, {
+    number: absNumber,
+    'Complex | BigNumber | Fraction | Unit': x => x.abs(),
+    // deep map collection, skip zeros since abs(0) = 0
+    'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self, true))
+  });
+});

package/lib/esm/function/arithmetic/add.js

@@ -0,0 +1,83 @@
+import { factory } from '../../utils/factory.js';
+import { createMatAlgo01xDSid } from '../../type/matrix/utils/matAlgo01xDSid.js';
+import { createMatAlgo04xSidSid } from '../../type/matrix/utils/matAlgo04xSidSid.js';
+import { createMatAlgo10xSids } from '../../type/matrix/utils/matAlgo10xSids.js';
+import { createMatrixAlgorithmSuite } from '../../type/matrix/utils/matrixAlgorithmSuite.js';
+var name = 'add';
+var dependencies = ['typed', 'matrix', 'addScalar', 'equalScalar', 'DenseMatrix', 'SparseMatrix', 'concat'];
+export var createAdd = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed,
+    matrix,
+    addScalar,
+    equalScalar,
+    DenseMatrix,
+    SparseMatrix,
+    concat
+  } = _ref;
+  var matAlgo01xDSid = createMatAlgo01xDSid({
+    typed
+  });
+  var matAlgo04xSidSid = createMatAlgo04xSidSid({
+    typed,
+    equalScalar
+  });
+  var matAlgo10xSids = createMatAlgo10xSids({
+    typed,
+    DenseMatrix
+  });
+  var matrixAlgorithmSuite = createMatrixAlgorithmSuite({
+    typed,
+    matrix,
+    concat
+  });
+  /**
+  * Add two or more values, `x + y`.
+  * For matrices, the function is evaluated element wise.
+  *
+  * Syntax:
+  *
+  *    math.add(x, y)
+  *    math.add(x, y, z, ...)
+  *
+  * Examples:
+  *
+  *    math.add(2, 3)               // returns number 5
+  *    math.add(2, 3, 4)            // returns number 9
+  *
+  *    const a = math.complex(2, 3)
+  *    const b = math.complex(-4, 1)
+  *    math.add(a, b)               // returns Complex -2 + 4i
+  *
+  *    math.add([1, 2, 3], 4)       // returns Array [5, 6, 7]
+  *
+  *    const c = math.unit('5 cm')
+  *    const d = math.unit('2.1 mm')
+  *    math.add(c, d)               // returns Unit 52.1 mm
+  *
+  *    math.add("2.3", "4")         // returns number 6.3
+  *
+  * See also:
+  *
+  *    subtract, sum
+  *
+  * @param  {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} x First value to add
+  * @param  {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} y Second value to add
+  * @return {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} Sum of `x` and `y`
+  */
+  return typed(name, {
+    'any, any': addScalar,
+    'any, any, ...any': typed.referToSelf(self => (x, y, rest) => {
+      var result = self(x, y);
+      for (var i = 0; i < rest.length; i++) {
+        result = self(result, rest[i]);
+      }
+      return result;
+    })
+  }, matrixAlgorithmSuite({
+    elop: addScalar,
+    DS: matAlgo01xDSid,
+    SS: matAlgo04xSidSid,
+    Ss: matAlgo10xSids
+  }));
+});

package/lib/esm/function/arithmetic/addScalar.js

@@ -0,0 +1,46 @@
+import { factory } from '../../utils/factory.js';
+import { addNumber } from '../../plain/number/index.js';
+var name = 'addScalar';
+var dependencies = ['typed'];
+export var createAddScalar = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed
+  } = _ref;
+  /**
+   * Add two scalar values, `x + y`.
+   * This function is meant for internal use: it is used by the public function
+   * `add`
+   *
+   * This function does not support collections (Array or Matrix).
+   *
+   * @param  {number | BigNumber | Fraction | Complex | Unit} x   First value to add
+   * @param  {number | BigNumber | Fraction | Complex} y          Second value to add
+   * @return {number | BigNumber | Fraction | Complex | Unit}     Sum of `x` and `y`
+   * @private
+   */
+  return typed(name, {
+    'number, number': addNumber,
+    'Complex, Complex': function ComplexComplex(x, y) {
+      return x.add(y);
+    },
+    'BigNumber, BigNumber': function BigNumberBigNumber(x, y) {
+      return x.plus(y);
+    },
+    'Fraction, Fraction': function FractionFraction(x, y) {
+      return x.add(y);
+    },
+    'Unit, Unit': typed.referToSelf(self => (x, y) => {
+      if (x.value === null || x.value === undefined) {
+        throw new Error('Parameter x contains a unit with undefined value');
+      }
+      if (y.value === null || y.value === undefined) {
+        throw new Error('Parameter y contains a unit with undefined value');
+      }
+      if (!x.equalBase(y)) throw new Error('Units do not match');
+      var res = x.clone();
+      res.value = typed.find(self, [res.valueType(), y.valueType()])(res.value, y.value);
+      res.fixPrefix = false;
+      return res;
+    })
+  });
+});

package/lib/esm/function/arithmetic/cbrt.js

@@ -0,0 +1,131 @@
+import { factory } from '../../utils/factory.js';
+import { isBigNumber, isComplex, isFraction } from '../../utils/is.js';
+import { cbrtNumber } from '../../plain/number/index.js';
+var name = 'cbrt';
+var dependencies = ['config', 'typed', 'isNegative', 'unaryMinus', 'matrix', 'Complex', 'BigNumber', 'Fraction'];
+export var createCbrt = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    config,
+    typed,
+    isNegative,
+    unaryMinus,
+    matrix,
+    Complex,
+    BigNumber,
+    Fraction
+  } = _ref;
+  /**
+   * Calculate the cubic root of a value.
+   *
+   * To avoid confusion with the matrix cube root, this function does not
+   * apply to matrices. For a matrix, to take the cube root elementwise,
+   * see the examples.
+   *
+   * Syntax:
+   *
+   *    math.cbrt(x)
+   *    math.cbrt(x, allRoots)
+   *
+   * Examples:
+   *
+   *    math.cbrt(27)                  // returns 3
+   *    math.cube(3)                   // returns 27
+   *    math.cbrt(-64)                 // returns -4
+   *    math.cbrt(math.unit('27 m^3')) // returns Unit 3 m
+   *    math.map([27, 64, 125], x => math.cbrt(x))       // returns [3, 4, 5]
+   *
+   *    const x = math.complex('8i')
+   *    math.cbrt(x)                   // returns Complex 1.7320508075689 + i
+   *    math.cbrt(x, true)             // returns Matrix [
+   *                                    //    1.7320508075689 + i
+   *                                    //   -1.7320508075689 + i
+   *                                    //   -2i
+   *                                    // ]
+   *
+   * See also:
+   *
+   *    square, sqrt, cube
+   *
+   * @param {number | BigNumber | Complex | Unit} x
+   *            Value for which to calculate the cubic root.
+   * @param {boolean} [allRoots]  Optional, false by default. Only applicable
+   *            when `x` is a number or complex number. If true, all complex
+   *            roots are returned, if false (default) the principal root is
+   *            returned.
+   * @return {number | BigNumber | Complex | Unit}
+   *            Returns the cubic root of `x`
+   */
+  return typed(name, {
+    number: cbrtNumber,
+    // note: signature 'number, boolean' is also supported,
+    //       created by typed as it knows how to convert number to Complex
+
+    Complex: _cbrtComplex,
+    'Complex, boolean': _cbrtComplex,
+    BigNumber: function BigNumber(x) {
+      return x.cbrt();
+    },
+    Unit: _cbrtUnit
+  });
+
+  /**
+   * Calculate the cubic root for a complex number
+   * @param {Complex} x
+   * @param {boolean} [allRoots]   If true, the function will return an array
+   *                               with all three roots. If false or undefined,
+   *                               the principal root is returned.
+   * @returns {Complex | Array.<Complex> | Matrix.<Complex>} Returns the cubic root(s) of x
+   * @private
+   */
+  function _cbrtComplex(x, allRoots) {
+    // https://www.wikiwand.com/en/Cube_root#/Complex_numbers
+
+    var arg3 = x.arg() / 3;
+    var abs = x.abs();
+
+    // principal root:
+    var principal = new Complex(cbrtNumber(abs), 0).mul(new Complex(0, arg3).exp());
+    if (allRoots) {
+      var all = [principal, new Complex(cbrtNumber(abs), 0).mul(new Complex(0, arg3 + Math.PI * 2 / 3).exp()), new Complex(cbrtNumber(abs), 0).mul(new Complex(0, arg3 - Math.PI * 2 / 3).exp())];
+      return config.matrix === 'Array' ? all : matrix(all);
+    } else {
+      return principal;
+    }
+  }
+
+  /**
+   * Calculate the cubic root for a Unit
+   * @param {Unit} x
+   * @return {Unit} Returns the cubic root of x
+   * @private
+   */
+  function _cbrtUnit(x) {
+    if (x.value && isComplex(x.value)) {
+      var result = x.clone();
+      result.value = 1.0;
+      result = result.pow(1.0 / 3); // Compute the units
+      result.value = _cbrtComplex(x.value); // Compute the value
+      return result;
+    } else {
+      var negate = isNegative(x.value);
+      if (negate) {
+        x.value = unaryMinus(x.value);
+      }
+
+      // TODO: create a helper function for this
+      var third;
+      if (isBigNumber(x.value)) {
+        third = new BigNumber(1).div(3);
+      } else if (isFraction(x.value)) {
+        third = new Fraction(1, 3);
+      } else {
+        third = 1 / 3;
+      }
+      var _result = x.pow(third);
+      if (negate) {
+        _result.value = unaryMinus(_result.value);
+      }
+      return _result;
+    }
+  }
+});