mathjs-min 11.7.2

package/lib/esm/function/bitwise/rightLogShift.js

@@ -0,0 +1,115 @@
+import { createMatAlgo02xDS0 } from '../../type/matrix/utils/matAlgo02xDS0.js';
+import { createMatAlgo11xS0s } from '../../type/matrix/utils/matAlgo11xS0s.js';
+import { createMatAlgo14xDs } from '../../type/matrix/utils/matAlgo14xDs.js';
+import { createMatAlgo01xDSid } from '../../type/matrix/utils/matAlgo01xDSid.js';
+import { createMatAlgo10xSids } from '../../type/matrix/utils/matAlgo10xSids.js';
+import { createMatAlgo08xS0Sid } from '../../type/matrix/utils/matAlgo08xS0Sid.js';
+import { factory } from '../../utils/factory.js';
+import { createMatrixAlgorithmSuite } from '../../type/matrix/utils/matrixAlgorithmSuite.js';
+import { rightLogShiftNumber } from '../../plain/number/index.js';
+import { createUseMatrixForArrayScalar } from './useMatrixForArrayScalar.js';
+var name = 'rightLogShift';
+var dependencies = ['typed', 'matrix', 'equalScalar', 'zeros', 'DenseMatrix', 'concat'];
+export var createRightLogShift = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed,
+    matrix,
+    equalScalar,
+    zeros,
+    DenseMatrix,
+    concat
+  } = _ref;
+  var matAlgo01xDSid = createMatAlgo01xDSid({
+    typed
+  });
+  var matAlgo02xDS0 = createMatAlgo02xDS0({
+    typed,
+    equalScalar
+  });
+  var matAlgo08xS0Sid = createMatAlgo08xS0Sid({
+    typed,
+    equalScalar
+  });
+  var matAlgo10xSids = createMatAlgo10xSids({
+    typed,
+    DenseMatrix
+  });
+  var matAlgo11xS0s = createMatAlgo11xS0s({
+    typed,
+    equalScalar
+  });
+  var matAlgo14xDs = createMatAlgo14xDs({
+    typed
+  });
+  var matrixAlgorithmSuite = createMatrixAlgorithmSuite({
+    typed,
+    matrix,
+    concat
+  });
+  var useMatrixForArrayScalar = createUseMatrixForArrayScalar({
+    typed,
+    matrix
+  });
+
+  /**
+   * Bitwise right logical shift of value x by y number of bits, `x >>> y`.
+   * For matrices, the function is evaluated element wise.
+   * For units, the function is evaluated on the best prefix base.
+   *
+   * Syntax:
+   *
+   *    math.rightLogShift(x, y)
+   *
+   * Examples:
+   *
+   *    math.rightLogShift(4, 2)               // returns number 1
+   *
+   *    math.rightLogShift([16, 32, 64], 4)    // returns Array [1, 2, 4]
+   *
+   * See also:
+   *
+   *    bitAnd, bitNot, bitOr, bitXor, leftShift, rightLogShift
+   *
+   * @param  {number | Array | Matrix} x Value to be shifted
+   * @param  {number} y Amount of shifts
+   * @return {number | Array | Matrix} `x` zero-filled shifted right `y` times
+   */
+
+  return typed(name, {
+    'number, number': rightLogShiftNumber,
+    // 'BigNumber, BigNumber': ..., // TODO: implement BigNumber support for rightLogShift
+
+    'SparseMatrix, number | BigNumber': typed.referToSelf(self => (x, y) => {
+      // check scalar
+      if (equalScalar(y, 0)) {
+        return x.clone();
+      }
+      return matAlgo11xS0s(x, y, self, false);
+    }),
+    'DenseMatrix, number | BigNumber': typed.referToSelf(self => (x, y) => {
+      // check scalar
+      if (equalScalar(y, 0)) {
+        return x.clone();
+      }
+      return matAlgo14xDs(x, y, self, false);
+    }),
+    'number | BigNumber, SparseMatrix': typed.referToSelf(self => (x, y) => {
+      // check scalar
+      if (equalScalar(x, 0)) {
+        return zeros(y.size(), y.storage());
+      }
+      return matAlgo10xSids(y, x, self, true);
+    }),
+    'number | BigNumber, DenseMatrix': typed.referToSelf(self => (x, y) => {
+      // check scalar
+      if (equalScalar(x, 0)) {
+        return zeros(y.size(), y.storage());
+      }
+      return matAlgo14xDs(y, x, self, true);
+    })
+  }, useMatrixForArrayScalar, matrixAlgorithmSuite({
+    SS: matAlgo08xS0Sid,
+    DS: matAlgo01xDSid,
+    SD: matAlgo02xDS0
+  }));
+});

package/lib/esm/function/bitwise/useMatrixForArrayScalar.js

@@ -0,0 +1,13 @@
+import { factory } from '../../utils/factory.js';
+export var createUseMatrixForArrayScalar = /* #__PURE__ */factory('useMatrixForArrayScalar', ['typed', 'matrix'], _ref => {
+  var {
+    typed,
+    matrix
+  } = _ref;
+  return {
+    'Array, number': typed.referTo('DenseMatrix, number', selfDn => (x, y) => selfDn(matrix(x), y).valueOf()),
+    'Array, BigNumber': typed.referTo('DenseMatrix, BigNumber', selfDB => (x, y) => selfDB(matrix(x), y).valueOf()),
+    'number, Array': typed.referTo('number, DenseMatrix', selfnD => (x, y) => selfnD(x, matrix(y)).valueOf()),
+    'BigNumber, Array': typed.referTo('BigNumber, DenseMatrix', selfBD => (x, y) => selfBD(x, matrix(y)).valueOf())
+  };
+});

package/lib/esm/function/combinatorics/bellNumbers.js

@@ -0,0 +1,47 @@
+import { factory } from '../../utils/factory.js';
+var name = 'bellNumbers';
+var dependencies = ['typed', 'addScalar', 'isNegative', 'isInteger', 'stirlingS2'];
+export var createBellNumbers = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed,
+    addScalar,
+    isNegative,
+    isInteger,
+    stirlingS2
+  } = _ref;
+  /**
+   * The Bell Numbers count the number of partitions of a set. A partition is a pairwise disjoint subset of S whose union is S.
+   * bellNumbers only takes integer arguments.
+   * The following condition must be enforced: n >= 0
+   *
+   * Syntax:
+   *
+   *   math.bellNumbers(n)
+   *
+   * Examples:
+   *
+   *    math.bellNumbers(3) // returns 5
+   *    math.bellNumbers(8) // returns 4140
+   *
+   * See also:
+   *
+   *    stirlingS2
+   *
+   * @param {Number | BigNumber} n    Total number of objects in the set
+   * @return {Number | BigNumber}     B(n)
+   */
+  return typed(name, {
+    'number | BigNumber': function numberBigNumber(n) {
+      if (!isInteger(n) || isNegative(n)) {
+        throw new TypeError('Non-negative integer value expected in function bellNumbers');
+      }
+
+      // Sum (k=0, n) S(n,k).
+      var result = 0;
+      for (var i = 0; i <= n; i++) {
+        result = addScalar(result, stirlingS2(n, i));
+      }
+      return result;
+    }
+  });
+});

package/lib/esm/function/combinatorics/catalan.js

@@ -0,0 +1,43 @@
+import { factory } from '../../utils/factory.js';
+var name = 'catalan';
+var dependencies = ['typed', 'addScalar', 'divideScalar', 'multiplyScalar', 'combinations', 'isNegative', 'isInteger'];
+export var createCatalan = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed,
+    addScalar,
+    divideScalar,
+    multiplyScalar,
+    combinations,
+    isNegative,
+    isInteger
+  } = _ref;
+  /**
+   * The Catalan Numbers enumerate combinatorial structures of many different types.
+   * catalan only takes integer arguments.
+   * The following condition must be enforced: n >= 0
+   *
+   * Syntax:
+   *
+   *   math.catalan(n)
+   *
+   * Examples:
+   *
+   *    math.catalan(3) // returns 5
+   *    math.catalan(8) // returns 1430
+   *
+   * See also:
+   *
+   *    bellNumbers
+   *
+   * @param {Number | BigNumber} n    nth Catalan number
+   * @return {Number | BigNumber}     Cn(n)
+   */
+  return typed(name, {
+    'number | BigNumber': function numberBigNumber(n) {
+      if (!isInteger(n) || isNegative(n)) {
+        throw new TypeError('Non-negative integer value expected in function catalan');
+      }
+      return divideScalar(combinations(multiplyScalar(n, 2), n), addScalar(n, 1));
+    }
+  });
+});

package/lib/esm/function/combinatorics/composition.js

@@ -0,0 +1,46 @@
+import { factory } from '../../utils/factory.js';
+var name = 'composition';
+var dependencies = ['typed', 'addScalar', 'combinations', 'isNegative', 'isPositive', 'isInteger', 'larger'];
+export var createComposition = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed,
+    addScalar,
+    combinations,
+    isPositive,
+    isNegative,
+    isInteger,
+    larger
+  } = _ref;
+  /**
+   * The composition counts of n into k parts.
+   *
+   * composition only takes integer arguments.
+   * The following condition must be enforced: k <= n.
+   *
+   * Syntax:
+   *
+   *   math.composition(n, k)
+   *
+   * Examples:
+   *
+   *    math.composition(5, 3) // returns 6
+   *
+   * See also:
+   *
+   *    combinations
+   *
+   * @param {Number | BigNumber} n    Total number of objects in the set
+   * @param {Number | BigNumber} k    Number of objects in the subset
+   * @return {Number | BigNumber}     Returns the composition counts of n into k parts.
+   */
+  return typed(name, {
+    'number | BigNumber, number | BigNumber': function numberBigNumberNumberBigNumber(n, k) {
+      if (!isInteger(n) || !isPositive(n) || !isInteger(k) || !isPositive(k)) {
+        throw new TypeError('Positive integer value expected in function composition');
+      } else if (larger(k, n)) {
+        throw new TypeError('k must be less than or equal to n in function composition');
+      }
+      return combinations(addScalar(n, -1), addScalar(k, -1));
+    }
+  });
+});

package/lib/esm/function/combinatorics/stirlingS2.js

@@ -0,0 +1,86 @@
+import { factory } from '../../utils/factory.js';
+import { isNumber } from '../../utils/is.js';
+var name = 'stirlingS2';
+var dependencies = ['typed', 'addScalar', 'subtract', 'multiplyScalar', 'divideScalar', 'pow', 'factorial', 'combinations', 'isNegative', 'isInteger', 'number', '?bignumber', 'larger'];
+export var createStirlingS2 = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed,
+    addScalar,
+    subtract,
+    multiplyScalar,
+    divideScalar,
+    pow,
+    factorial,
+    combinations,
+    isNegative,
+    isInteger,
+    number,
+    bignumber,
+    larger
+  } = _ref;
+  var smallCache = [];
+  var bigCache = [];
+  /**
+   * The Stirling numbers of the second kind, counts the number of ways to partition
+   * a set of n labelled objects into k nonempty unlabelled subsets.
+   * stirlingS2 only takes integer arguments.
+   * The following condition must be enforced: k <= n.
+   *
+   *  If n = k or k = 1 <= n, then s(n,k) = 1
+   *  If k = 0 < n, then s(n,k) = 0
+   *
+   * Note that if either n or k is supplied as a BigNumber, the result will be
+   * as well.
+   *
+   * Syntax:
+   *
+   *   math.stirlingS2(n, k)
+   *
+   * Examples:
+   *
+   *    math.stirlingS2(5, 3) //returns 25
+   *
+   * See also:
+   *
+   *    bellNumbers
+   *
+   * @param {Number | BigNumber} n    Total number of objects in the set
+   * @param {Number | BigNumber} k    Number of objects in the subset
+   * @return {Number | BigNumber}     S(n,k)
+   */
+  return typed(name, {
+    'number | BigNumber, number | BigNumber': function numberBigNumberNumberBigNumber(n, k) {
+      if (!isInteger(n) || isNegative(n) || !isInteger(k) || isNegative(k)) {
+        throw new TypeError('Non-negative integer value expected in function stirlingS2');
+      } else if (larger(k, n)) {
+        throw new TypeError('k must be less than or equal to n in function stirlingS2');
+      }
+      var big = !(isNumber(n) && isNumber(k));
+      var cache = big ? bigCache : smallCache;
+      var make = big ? bignumber : number;
+      var nn = number(n);
+      var nk = number(k);
+      /* See if we already have the value: */
+      if (cache[nn] && cache[nn].length > nk) {
+        return cache[nn][nk];
+      }
+      /* Fill the cache */
+      for (var m = 0; m <= nn; ++m) {
+        if (!cache[m]) {
+          cache[m] = [m === 0 ? make(1) : make(0)];
+        }
+        if (m === 0) continue;
+        var row = cache[m];
+        var prev = cache[m - 1];
+        for (var i = row.length; i <= m && i <= nk; ++i) {
+          if (i === m) {
+            row[i] = 1;
+          } else {
+            row[i] = addScalar(multiplyScalar(make(i), prev[i]), prev[i - 1]);
+          }
+        }
+      }
+      return cache[nn][nk];
+    }
+  });
+});

package/lib/esm/function/complex/arg.js

@@ -0,0 +1,50 @@
+import { factory } from '../../utils/factory.js';
+import { deepMap } from '../../utils/collection.js';
+var name = 'arg';
+var dependencies = ['typed'];
+export var createArg = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed
+  } = _ref;
+  /**
+   * Compute the argument of a complex value.
+   * For a complex number `a + bi`, the argument is computed as `atan2(b, a)`.
+   *
+   * For matrices, the function is evaluated element wise.
+   *
+   * Syntax:
+   *
+   *    math.arg(x)
+   *
+   * Examples:
+   *
+   *    const a = math.complex(2, 2)
+   *    math.arg(a) / math.pi          // returns number 0.25
+   *
+   *    const b = math.complex('2 + 3i')
+   *    math.arg(b)                    // returns number 0.982793723247329
+   *    math.atan2(3, 2)               // returns number 0.982793723247329
+   *
+   * See also:
+   *
+   *    re, im, conj, abs
+   *
+   * @param {number | BigNumber | Complex | Array | Matrix} x
+   *            A complex number or array with complex numbers
+   * @return {number | BigNumber | Array | Matrix} The argument of x
+   */
+  return typed(name, {
+    number: function number(x) {
+      return Math.atan2(0, x);
+    },
+    BigNumber: function BigNumber(x) {
+      return x.constructor.atan2(0, x);
+    },
+    Complex: function Complex(x) {
+      return x.arg();
+    },
+    // TODO: implement BigNumber support for function arg
+
+    'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
+  });
+});

package/lib/esm/function/complex/conj.js

@@ -0,0 +1,39 @@
+import { factory } from '../../utils/factory.js';
+import { deepMap } from '../../utils/collection.js';
+var name = 'conj';
+var dependencies = ['typed'];
+export var createConj = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed
+  } = _ref;
+  /**
+   * Compute the complex conjugate of a complex value.
+   * If `x = a+bi`, the complex conjugate of `x` is `a - bi`.
+   *
+   * For matrices, the function is evaluated element wise.
+   *
+   * Syntax:
+   *
+   *    math.conj(x)
+   *
+   * Examples:
+   *
+   *    math.conj(math.complex('2 + 3i'))  // returns Complex 2 - 3i
+   *    math.conj(math.complex('2 - 3i'))  // returns Complex 2 + 3i
+   *    math.conj(math.complex('-5.2i'))  // returns Complex 5.2i
+   *
+   * See also:
+   *
+   *    re, im, arg, abs
+   *
+   * @param {number | BigNumber | Complex | Array | Matrix} x
+   *            A complex number or array with complex numbers
+   * @return {number | BigNumber | Complex | Array | Matrix}
+   *            The complex conjugate of x
+   */
+  return typed(name, {
+    'number | BigNumber | Fraction': x => x,
+    Complex: x => x.conjugate(),
+    'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
+  });
+});

package/lib/esm/function/complex/im.js

@@ -0,0 +1,42 @@
+import { factory } from '../../utils/factory.js';
+import { deepMap } from '../../utils/collection.js';
+var name = 'im';
+var dependencies = ['typed'];
+export var createIm = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed
+  } = _ref;
+  /**
+   * Get the imaginary part of a complex number.
+   * For a complex number `a + bi`, the function returns `b`.
+   *
+   * For matrices, the function is evaluated element wise.
+   *
+   * Syntax:
+   *
+   *    math.im(x)
+   *
+   * Examples:
+   *
+   *    const a = math.complex(2, 3)
+   *    math.re(a)                     // returns number 2
+   *    math.im(a)                     // returns number 3
+   *
+   *    math.re(math.complex('-5.2i')) // returns number -5.2
+   *    math.re(math.complex(2.4))     // returns number 0
+   *
+   * See also:
+   *
+   *    re, conj, abs, arg
+   *
+   * @param {number | BigNumber | Complex | Array | Matrix} x
+   *            A complex number or array with complex numbers
+   * @return {number | BigNumber | Array | Matrix} The imaginary part of x
+   */
+  return typed(name, {
+    number: () => 0,
+    'BigNumber | Fraction': x => x.mul(0),
+    Complex: x => x.im,
+    'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
+  });
+});

package/lib/esm/function/complex/re.js

@@ -0,0 +1,41 @@
+import { factory } from '../../utils/factory.js';
+import { deepMap } from '../../utils/collection.js';
+var name = 're';
+var dependencies = ['typed'];
+export var createRe = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed
+  } = _ref;
+  /**
+   * Get the real part of a complex number.
+   * For a complex number `a + bi`, the function returns `a`.
+   *
+   * For matrices, the function is evaluated element wise.
+   *
+   * Syntax:
+   *
+   *    math.re(x)
+   *
+   * Examples:
+   *
+   *    const a = math.complex(2, 3)
+   *    math.re(a)                     // returns number 2
+   *    math.im(a)                     // returns number 3
+   *
+   *    math.re(math.complex('-5.2i')) // returns number 0
+   *    math.re(math.complex(2.4))     // returns number 2.4
+   *
+   * See also:
+   *
+   *    im, conj, abs, arg
+   *
+   * @param {number | BigNumber | Complex | Array | Matrix} x
+   *            A complex number or array with complex numbers
+   * @return {number | BigNumber | Array | Matrix} The real part of x
+   */
+  return typed(name, {
+    'number | BigNumber | Fraction': x => x,
+    Complex: x => x.re,
+    'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
+  });
+});