mathjs 11.4.0 → 11.5.1

package/lib/cjs/expression/embeddedDocs/function/arithmetic/invmod.js

@@ -9,7 +9,7 @@ var invmodDocs = {
   category: 'Arithmetic',
   syntax: ['invmod(a, b)'],
   description: 'Calculate the (modular) multiplicative inverse of a modulo b. Solution to the equation ax ≣ 1 (mod b)',
-  examples: ['invmod(8, 12)=NaN', 'invmod(7, 13)=2', 'math.invmod(15151, 15122)=10429'],
+  examples: ['invmod(8, 12)=NaN', 'invmod(7, 13)=2', 'invmod(15151, 15122)=10429'],
   seealso: ['gcd', 'xgcd']
 };
 exports.invmodDocs = invmodDocs;

package/lib/cjs/expression/embeddedDocs/function/arithmetic/pow.js

@@ -9,7 +9,7 @@ var powDocs = {
   category: 'Operators',
   syntax: ['x ^ y', 'pow(x, y)'],
   description: 'Calculates the power of x to y, x^y.',
-  examples: ['2^3', '2*2*2', '1 + e ^ (pi * i)', 'math.pow([[1, 2], [4, 3]], 2)', 'math.pow([[1, 2], [4, 3]], -1)'],
+  examples: ['2^3', '2*2*2', '1 + e ^ (pi * i)', 'pow([[1, 2], [4, 3]], 2)', 'pow([[1, 2], [4, 3]], -1)'],
   seealso: ['multiply', 'nthRoot', 'nthRoots', 'sqrt']
 };
 exports.powDocs = powDocs;

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

@@ -7,7 +7,7 @@ exports.matrixFromColumnsDocs = void 0;
 var matrixFromColumnsDocs = {
   name: 'matrixFromColumns',
   category: 'Matrix',
-  syntax: ['math.matrixFromColumns(...arr)', 'math.matrixFromColumns(row1, row2)', 'math.matrixFromColumns(row1, row2, row3)'],
+  syntax: ['matrixFromColumns(...arr)', 'matrixFromColumns(row1, row2)', 'matrixFromColumns(row1, row2, row3)'],
   description: 'Create a dense matrix from vectors as individual columns.',
   examples: ['matrixFromColumns([1, 2, 3], [[4],[5],[6]])'],
   seealso: ['matrix', 'matrixFromRows', 'matrixFromFunction', 'zeros']

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

@@ -7,7 +7,7 @@ exports.matrixFromFunctionDocs = void 0;
 var matrixFromFunctionDocs = {
   name: 'matrixFromFunction',
   category: 'Matrix',
-  syntax: ['math.matrixFromFunction(size, fn)', 'math.matrixFromFunction(size, fn, format)', 'math.matrixFromFunction(size, fn, format, datatype)', 'math.matrixFromFunction(size, format, fn)', 'math.matrixFromFunction(size, format, datatype, fn)'],
+  syntax: ['matrixFromFunction(size, fn)', 'matrixFromFunction(size, fn, format)', 'matrixFromFunction(size, fn, format, datatype)', 'matrixFromFunction(size, format, fn)', 'matrixFromFunction(size, format, datatype, fn)'],
   description: 'Create a matrix by evaluating a generating function at each index.',
   examples: ['f(I) = I[1] - I[2]', 'matrixFromFunction([3,3], f)', 'g(I) = I[1] - I[2] == 1 ? 4 : 0', 'matrixFromFunction([100, 100], "sparse", g)', 'matrixFromFunction([5], random)'],
   seealso: ['matrix', 'matrixFromRows', 'matrixFromColumns', 'zeros']

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

@@ -7,7 +7,7 @@ exports.matrixFromRowsDocs = void 0;
 var matrixFromRowsDocs = {
   name: 'matrixFromRows',
   category: 'Matrix',
-  syntax: ['math.matrixFromRows(...arr)', 'math.matrixFromRows(row1, row2)', 'math.matrixFromRows(row1, row2, row3)'],
+  syntax: ['matrixFromRows(...arr)', 'matrixFromRows(row1, row2)', 'matrixFromRows(row1, row2, row3)'],
   description: 'Create a dense matrix from vectors as individual rows.',
   examples: ['matrixFromRows([1, 2, 3], [[4],[5],[6]])'],
   seealso: ['matrix', 'matrixFromColumns', 'matrixFromFunction', 'zeros']

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

@@ -9,7 +9,7 @@ var reshapeDocs = {
   category: 'Matrix',
   syntax: ['reshape(x, sizes)'],
   description: 'Reshape a multi dimensional array to fit the specified dimensions.',
-  examples: ['reshape([1, 2, 3, 4, 5, 6], [2, 3])', 'reshape([[1, 2], [3, 4]], [1, 4])', 'reshape([[1, 2], [3, 4]], [4])'],
+  examples: ['reshape([1, 2, 3, 4, 5, 6], [2, 3])', 'reshape([[1, 2], [3, 4]], [1, 4])', 'reshape([[1, 2], [3, 4]], [4])', 'reshape([1, 2, 3, 4], [-1, 2])'],
   seealso: ['size', 'squeeze', 'resize']
 };
 exports.reshapeDocs = reshapeDocs;

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

@@ -9,7 +9,7 @@ var rotateDocs = {
   category: 'Matrix',
   syntax: ['rotate(w, theta)', 'rotate(w, theta, v)'],
   description: 'Returns a 2-D rotation matrix (2x2) for a given angle (in radians). ' + 'Returns a 2-D rotation matrix (3x3) of a given angle (in radians) around given axis.',
-  examples: ['rotate([1, 0], math.pi / 2)', 'rotate(matrix([1, 0]), unit("35deg"))', 'rotate([1, 0, 0], unit("90deg"), [0, 0, 1])', 'rotate(matrix([1, 0, 0]), unit("90deg"), matrix([0, 0, 1]))'],
+  examples: ['rotate([1, 0], pi / 2)', 'rotate(matrix([1, 0]), unit("35deg"))', 'rotate([1, 0, 0], unit("90deg"), [0, 0, 1])', 'rotate(matrix([1, 0, 0]), unit("90deg"), matrix([0, 0, 1]))'],
   seealso: ['matrix', 'rotationMatrix']
 };
 exports.rotateDocs = rotateDocs;

package/lib/cjs/expression/embeddedDocs/function/probability/lgamma.js

@@ -9,7 +9,7 @@ var lgammaDocs = {
   category: 'Probability',
   syntax: ['lgamma(n)'],
   description: 'Logarithm of the gamma function for real, positive numbers and complex numbers, ' + 'using Lanczos approximation for numbers and Stirling series for complex numbers.',
-  examples: ['lgamma(4)', 'lgamma(1/2)', 'lgamma(math.i)', 'lgamma(complex(1.1, 2))'],
+  examples: ['lgamma(4)', 'lgamma(1/2)', 'lgamma(i)', 'lgamma(complex(1.1, 2))'],
   seealso: ['gamma']
 };
 exports.lgammaDocs = lgammaDocs;

package/lib/cjs/expression/embeddedDocs/function/statistics/max.js

@@ -7,7 +7,7 @@ exports.maxDocs = void 0;
 var maxDocs = {
   name: 'max',
   category: 'Statistics',
-  syntax: ['max(a, b, c, ...)', 'max(A)', 'max(A, dim)'],
+  syntax: ['max(a, b, c, ...)', 'max(A)', 'max(A, dimension)'],
   description: 'Compute the maximum value of a list of values.',
   examples: ['max(2, 3, 4, 1)', 'max([2, 3, 4, 1])', 'max([2, 5; 4, 3])', 'max([2, 5; 4, 3], 1)', 'max([2, 5; 4, 3], 2)', 'max(2.7, 7.1, -4.5, 2.0, 4.1)', 'min(2.7, 7.1, -4.5, 2.0, 4.1)'],
   seealso: ['mean', 'median', 'min', 'prod', 'std', 'sum', 'variance']

package/lib/cjs/expression/embeddedDocs/function/statistics/mean.js

@@ -7,7 +7,7 @@ exports.meanDocs = void 0;
 var meanDocs = {
   name: 'mean',
   category: 'Statistics',
-  syntax: ['mean(a, b, c, ...)', 'mean(A)', 'mean(A, dim)'],
+  syntax: ['mean(a, b, c, ...)', 'mean(A)', 'mean(A, dimension)'],
   description: 'Compute the arithmetic mean of a list of values.',
   examples: ['mean(2, 3, 4, 1)', 'mean([2, 3, 4, 1])', 'mean([2, 5; 4, 3])', 'mean([2, 5; 4, 3], 1)', 'mean([2, 5; 4, 3], 2)', 'mean([1.0, 2.7, 3.2, 4.0])'],
   seealso: ['max', 'median', 'min', 'prod', 'std', 'sum', 'variance']

package/lib/cjs/expression/embeddedDocs/function/statistics/min.js

@@ -7,7 +7,7 @@ exports.minDocs = void 0;
 var minDocs = {
   name: 'min',
   category: 'Statistics',
-  syntax: ['min(a, b, c, ...)', 'min(A)', 'min(A, dim)'],
+  syntax: ['min(a, b, c, ...)', 'min(A)', 'min(A, dimension)'],
   description: 'Compute the minimum value of a list of values.',
   examples: ['min(2, 3, 4, 1)', 'min([2, 3, 4, 1])', 'min([2, 5; 4, 3])', 'min([2, 5; 4, 3], 1)', 'min([2, 5; 4, 3], 2)', 'min(2.7, 7.1, -4.5, 2.0, 4.1)', 'max(2.7, 7.1, -4.5, 2.0, 4.1)'],
   seealso: ['max', 'mean', 'median', 'prod', 'std', 'sum', 'variance']

package/lib/cjs/expression/embeddedDocs/function/statistics/std.js

@@ -7,7 +7,7 @@ exports.stdDocs = void 0;
 var stdDocs = {
   name: 'std',
   category: 'Statistics',
-  syntax: ['std(a, b, c, ...)', 'std(A)', 'std(A, normalization)'],
+  syntax: ['std(a, b, c, ...)', 'std(A)', 'std(A, dimension)', 'std(A, normalization)', 'std(A, dimension, normalization)'],
   description: 'Compute the standard deviation of all values, defined as std(A) = sqrt(variance(A)). Optional parameter normalization can be "unbiased" (default), "uncorrected", or "biased".',
   examples: ['std(2, 4, 6)', 'std([2, 4, 6, 8])', 'std([2, 4, 6, 8], "uncorrected")', 'std([2, 4, 6, 8], "biased")', 'std([1, 2, 3; 4, 5, 6])'],
   seealso: ['max', 'mean', 'min', 'median', 'prod', 'sum', 'variance']

package/lib/cjs/expression/embeddedDocs/function/statistics/sum.js

@@ -7,7 +7,7 @@ exports.sumDocs = void 0;
 var sumDocs = {
   name: 'sum',
   category: 'Statistics',
-  syntax: ['sum(a, b, c, ...)', 'sum(A)'],
+  syntax: ['sum(a, b, c, ...)', 'sum(A)', 'sum(A, dimension)'],
   description: 'Compute the sum of all values.',
   examples: ['sum(2, 3, 4, 1)', 'sum([2, 3, 4, 1])', 'sum([2, 5; 4, 3])'],
   seealso: ['max', 'mean', 'median', 'min', 'prod', 'std', 'sum', 'variance']

package/lib/cjs/expression/embeddedDocs/function/statistics/variance.js

@@ -7,7 +7,7 @@ exports.varianceDocs = void 0;
 var varianceDocs = {
   name: 'variance',
   category: 'Statistics',
-  syntax: ['variance(a, b, c, ...)', 'variance(A)', 'variance(A, normalization)'],
+  syntax: ['variance(a, b, c, ...)', 'variance(A)', 'variance(A, dimension)', 'variance(A, normalization)', 'variance(A, dimension, normalization)'],
   description: 'Compute the variance of all values. Optional parameter normalization can be "unbiased" (default), "uncorrected", or "biased".',
   examples: ['variance(2, 4, 6)', 'variance([2, 4, 6, 8])', 'variance([2, 4, 6, 8], "uncorrected")', 'variance([2, 4, 6, 8], "biased")', 'variance([1, 2, 3; 4, 5, 6])'],
   seealso: ['max', 'mean', 'min', 'median', 'min', 'prod', 'std', 'sum']

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

@@ -421,9 +421,17 @@ var createSimplify = /* #__PURE__ */(0, _factory.factory)(name, dependencies, fu
   }, {
     l: 'n3^(-n4)*n1 + n3^n5 * n2',
     r: 'n3^(-n4)*(n1 + n3^(n4+n5)*n2)'
-  }, {
+  },
+  // noncommutative additional cases (term collection & factoring)
+  {
     s: 'n*vd + vd -> (n+1)*vd',
-    // noncommutative additional cases
+    assuming: {
+      multiply: {
+        commutative: false
+      }
+    }
+  }, {
+    s: 'vd + n*vd -> (1+n)*vd',
     assuming: {
       multiply: {
         commutative: false
@@ -436,6 +444,16 @@ var createSimplify = /* #__PURE__ */(0, _factory.factory)(name, dependencies, fu
         commutative: false
       }
     }
+  }, {
+    s: 'n^n1 * n -> n^(n1+1)',
+    assuming: {
+      divide: {
+        total: true
+      },
+      multiply: {
+        commutative: false
+      }
+    }
   }, {
     s: 'n1*n3^(-n4) + n2 * n3    -> (n1 + n2*n3^(n4 +  1))*n3^(-n4)',
     assuming: {
@@ -460,6 +478,13 @@ var createSimplify = /* #__PURE__ */(0, _factory.factory)(name, dependencies, fu
         commutative: false
       }
     }
+  }, {
+    s: 'cd + cd*n -> cd*(1+n)',
+    assuming: {
+      multiply: {
+        commutative: false
+      }
+    }
   }, simplifyConstant,
   // Second: before returning expressions to "standard form"
 
@@ -616,15 +641,33 @@ var createSimplify = /* #__PURE__ */(0, _factory.factory)(name, dependencies, fu
       newRule.evaluate = parse(ruleObject.evaluate);
     }
     if (isAssociative(newRule.l, context)) {
+      var nonCommutative = !isCommutative(newRule.l, context);
+      var leftExpandsym;
+      // Gen. the LHS placeholder used in this NC-context specific expansion rules
+      if (nonCommutative) leftExpandsym = _getExpandPlaceholderSymbol();
       var makeNode = createMakeNodeFunction(newRule.l);
       var expandsym = _getExpandPlaceholderSymbol();
       newRule.expanded = {};
-      newRule.expanded.l = makeNode([newRule.l.clone(), expandsym]);
+      newRule.expanded.l = makeNode([newRule.l, expandsym]);
       // Push the expandsym into the deepest possible branch.
       // This helps to match the newRule against nodes returned from getSplits() later on.
       flatten(newRule.expanded.l, context);
       unflattenr(newRule.expanded.l, context);
       newRule.expanded.r = makeNode([newRule.r, expandsym]);
+
+      // In and for a non-commutative context, attempting with yet additional expansion rules makes
+      // way for more matches cases of multi-arg expressions; such that associative rules (such as
+      // 'n*n -> n^2') can be applied to exprs. such as 'a * b * b' and 'a * b * b * a'.
+      if (nonCommutative) {
+        // 'Non-commutative' 1: LHS (placeholder) only
+        newRule.expandedNC1 = {};
+        newRule.expandedNC1.l = makeNode([leftExpandsym, newRule.l]);
+        newRule.expandedNC1.r = makeNode([leftExpandsym, newRule.r]);
+        // 'Non-commutative' 2: farmost LHS and RHS placeholders
+        newRule.expandedNC2 = {};
+        newRule.expandedNC2.l = makeNode([leftExpandsym, newRule.expanded.l]);
+        newRule.expandedNC2.r = makeNode([leftExpandsym, newRule.expanded.r]);
+      }
     }
     return newRule;
   }
@@ -830,6 +873,16 @@ var createSimplify = /* #__PURE__ */(0, _factory.factory)(name, dependencies, fu
       repl = rule.expanded.r;
       matches = _ruleMatch(rule.expanded.l, res, mergedContext)[0];
     }
+    // Additional, non-commutative context expansion-rules
+    if (!matches && rule.expandedNC1) {
+      repl = rule.expandedNC1.r;
+      matches = _ruleMatch(rule.expandedNC1.l, res, mergedContext)[0];
+      if (!matches) {
+        // Existence of NC1 implies NC2
+        repl = rule.expandedNC2.r;
+        matches = _ruleMatch(rule.expandedNC2.l, res, mergedContext)[0];
+      }
+    }
     if (matches) {
       // const before = res.toString({parenthesis: 'all'})
 
@@ -1047,8 +1100,8 @@ var createSimplify = /* #__PURE__ */(0, _factory.factory)(name, dependencies, fu
         res = mergeChildMatches(childMatches);
       } else if (node.args.length >= 2 && rule.args.length === 2) {
         // node is flattened, rule is not
-        // Associative operators/functions can be split in different ways so we check if the rule matches each
-        // them and return their union.
+        // Associative operators/functions can be split in different ways so we check if the rule
+        // matches for each of them and return their union.
         var splits = getSplits(node, context);
         var splitMatches = [];
         for (var _i3 = 0; _i3 < splits.length; _i3++) {

package/lib/cjs/function/matrix/reshape.js

@@ -53,7 +53,7 @@ var createReshape = /* #__PURE__ */(0, _factory.factory)(name, dependencies, fun
    */
   return typed(name, {
     'Matrix, Array': function MatrixArray(x, sizes) {
-      return x.reshape(sizes);
+      return x.reshape(sizes, true);
     },
     'Array, Array': function ArrayArray(x, sizes) {
       sizes.forEach(function (size) {

package/lib/cjs/function/statistics/max.js

@@ -16,7 +16,7 @@ var createMax = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functio
     larger = _ref.larger;
   /**
    * Compute the maximum value of a matrix or a  list with values.
-   * In case of a multi dimensional array, the maximum of the flattened array
+   * In case of a multidimensional array, the maximum of the flattened array
    * will be calculated. When `dim` is provided, the maximum over the selected
    * dimension will be calculated. Parameter `dim` is zero-based.
    *
@@ -24,7 +24,7 @@ var createMax = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functio
    *
    *     math.max(a, b, c, ...)
    *     math.max(A)
-   *     math.max(A, dim)
+   *     math.max(A, dimension)
    *
    * Examples:
    *

package/lib/cjs/function/statistics/mean.js

@@ -16,7 +16,7 @@ var createMean = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
     divide = _ref.divide;
   /**
    * Compute the mean value of matrix or a list with values.
-   * In case of a multi dimensional array, the mean of the flattened array
+   * In case of a multidimensional array, the mean of the flattened array
    * will be calculated. When `dim` is provided, the maximum over the selected
    * dimension will be calculated. Parameter `dim` is zero-based.
    *
@@ -24,7 +24,7 @@ var createMean = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
    *
    *     math.mean(a, b, c, ...)
    *     math.mean(A)
-   *     math.mean(A, dim)
+   *     math.mean(A, dimension)
    *
    * Examples:
    *

package/lib/cjs/function/statistics/min.js

@@ -16,7 +16,7 @@ var createMin = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functio
     smaller = _ref.smaller;
   /**
    * Compute the minimum value of a matrix or a  list of values.
-   * In case of a multi dimensional array, the minimum of the flattened array
+   * In case of a multidimensional array, the minimum of the flattened array
    * will be calculated. When `dim` is provided, the minimum over the selected
    * dimension will be calculated. Parameter `dim` is zero-based.
    *
@@ -24,7 +24,7 @@ var createMin = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functio
    *
    *     math.min(a, b, c, ...)
    *     math.min(A)
-   *     math.min(A, dim)
+   *     math.min(A, dimension)
    *
    * Examples:
    *

package/lib/cjs/function/statistics/mode.js

@@ -14,7 +14,7 @@ var createMode = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
     isNumeric = _ref.isNumeric;
   /**
   * Computes the mode of a set of numbers or a list with values(numbers or characters).
-  * If there are more than one modes, it returns a list of those values.
+  * If there are multiple modes, it returns a list of those values.
   *
   * Syntax:
   *

package/lib/cjs/function/statistics/prod.js

@@ -16,7 +16,7 @@ var createProd = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functi
     numeric = _ref.numeric;
   /**
    * Compute the product of a matrix or a list with values.
-   * In case of a (multi dimensional) array or matrix, the sum of all
+   * In case of a multidimensional array or matrix, the sum of all
    * elements will be calculated.
    *
    * Syntax:

package/lib/cjs/function/statistics/quantileSeq.js

@@ -22,7 +22,7 @@ var createQuantileSeq = /* #__PURE__ */(0, _factory.factory)(name, dependencies,
    * Supported types of sequence values are: Number, BigNumber, Unit
    * Supported types of probability are: Number, BigNumber
    *
-   * In case of a (multi dimensional) array or matrix, the prob order quantile
+   * In case of a multidimensional array or matrix, the prob order quantile
    * of all elements will be calculated.
    *
    * Syntax:

package/lib/cjs/function/statistics/sum.js

@@ -16,13 +16,14 @@ var createSum = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functio
     numeric = _ref.numeric;
   /**
    * Compute the sum of a matrix or a list with values.
-   * In case of a (multi dimensional) array or matrix, the sum of all
+   * In case of a multidimensional array or matrix, the sum of all
    * elements will be calculated.
    *
    * Syntax:
    *
    *     math.sum(a, b, c, ...)
    *     math.sum(A)
+   *     math.sum(A, dimension)
    *
    * Examples:
    *
@@ -34,7 +35,7 @@ var createSum = /* #__PURE__ */(0, _factory.factory)(name, dependencies, functio
    *
    *    mean, median, min, max, prod, std, variance, cumsum
    *
-   * @param {... *} args  A single matrix or or multiple scalar values
+   * @param {... *} args  A single matrix or multiple scalar values
    * @return {*} The sum of all values
    */
   return typed(name, {

package/lib/cjs/function/statistics/variance.js

@@ -21,7 +21,7 @@ var createVariance = /* #__PURE__ */(0, _factory.factory)(name, dependencies, fu
     isNaN = _ref.isNaN;
   /**
    * Compute the variance of a matrix or a  list with values.
-   * In case of a (multi dimensional) array or matrix, the variance over all
+   * In case of a multidimensional array or matrix, the variance over all
    * elements will be calculated.
    *
    * Additionally, it is possible to compute the variance along the rows

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

@@ -28,53 +28,53 @@ var createFormat = /* #__PURE__ */(0, _factory.factory)(name, dependencies, func
    *    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/cjs/header.js

@@ -6,11 +6,11 @@
  * It features real and complex numbers, units, matrices, a large set of
  * mathematical functions, and a flexible expression parser.
  *
- * @version 11.4.0
- * @date    2022-11-18
+ * @version 11.5.1
+ * @date    2023-01-31
  *
  * @license
- * Copyright (C) 2013-2022 Jos de Jong <wjosdejong@gmail.com>
+ * Copyright (C) 2013-2023 Jos de Jong <wjosdejong@gmail.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  * use this file except in compliance with the License. You may obtain a copy

package/lib/cjs/version.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.version = void 0;
-var version = '11.4.0';
+var version = '11.5.1';
 // Note: This file is automatically generated when building math.js.
 // Changes made in this file will be overwritten.
 exports.version = version;

package/lib/esm/expression/embeddedDocs/function/arithmetic/invmod.js

@@ -3,6 +3,6 @@ export var invmodDocs = {
   category: 'Arithmetic',
   syntax: ['invmod(a, b)'],
   description: 'Calculate the (modular) multiplicative inverse of a modulo b. Solution to the equation ax ≣ 1 (mod b)',
-  examples: ['invmod(8, 12)=NaN', 'invmod(7, 13)=2', 'math.invmod(15151, 15122)=10429'],
+  examples: ['invmod(8, 12)=NaN', 'invmod(7, 13)=2', 'invmod(15151, 15122)=10429'],
   seealso: ['gcd', 'xgcd']
 };

package/lib/esm/expression/embeddedDocs/function/arithmetic/pow.js

@@ -3,6 +3,6 @@ export var powDocs = {
   category: 'Operators',
   syntax: ['x ^ y', 'pow(x, y)'],
   description: 'Calculates the power of x to y, x^y.',
-  examples: ['2^3', '2*2*2', '1 + e ^ (pi * i)', 'math.pow([[1, 2], [4, 3]], 2)', 'math.pow([[1, 2], [4, 3]], -1)'],
+  examples: ['2^3', '2*2*2', '1 + e ^ (pi * i)', 'pow([[1, 2], [4, 3]], 2)', 'pow([[1, 2], [4, 3]], -1)'],
   seealso: ['multiply', 'nthRoot', 'nthRoots', 'sqrt']
 };

package/lib/esm/expression/embeddedDocs/function/matrix/matrixFromColumns.js

@@ -1,7 +1,7 @@
 export var matrixFromColumnsDocs = {
   name: 'matrixFromColumns',
   category: 'Matrix',
-  syntax: ['math.matrixFromColumns(...arr)', 'math.matrixFromColumns(row1, row2)', 'math.matrixFromColumns(row1, row2, row3)'],
+  syntax: ['matrixFromColumns(...arr)', 'matrixFromColumns(row1, row2)', 'matrixFromColumns(row1, row2, row3)'],
   description: 'Create a dense matrix from vectors as individual columns.',
   examples: ['matrixFromColumns([1, 2, 3], [[4],[5],[6]])'],
   seealso: ['matrix', 'matrixFromRows', 'matrixFromFunction', 'zeros']

package/lib/esm/expression/embeddedDocs/function/matrix/matrixFromFunction.js

@@ -1,7 +1,7 @@
 export var matrixFromFunctionDocs = {
   name: 'matrixFromFunction',
   category: 'Matrix',
-  syntax: ['math.matrixFromFunction(size, fn)', 'math.matrixFromFunction(size, fn, format)', 'math.matrixFromFunction(size, fn, format, datatype)', 'math.matrixFromFunction(size, format, fn)', 'math.matrixFromFunction(size, format, datatype, fn)'],
+  syntax: ['matrixFromFunction(size, fn)', 'matrixFromFunction(size, fn, format)', 'matrixFromFunction(size, fn, format, datatype)', 'matrixFromFunction(size, format, fn)', 'matrixFromFunction(size, format, datatype, fn)'],
   description: 'Create a matrix by evaluating a generating function at each index.',
   examples: ['f(I) = I[1] - I[2]', 'matrixFromFunction([3,3], f)', 'g(I) = I[1] - I[2] == 1 ? 4 : 0', 'matrixFromFunction([100, 100], "sparse", g)', 'matrixFromFunction([5], random)'],
   seealso: ['matrix', 'matrixFromRows', 'matrixFromColumns', 'zeros']

package/lib/esm/expression/embeddedDocs/function/matrix/matrixFromRows.js

@@ -1,7 +1,7 @@
 export var matrixFromRowsDocs = {
   name: 'matrixFromRows',
   category: 'Matrix',
-  syntax: ['math.matrixFromRows(...arr)', 'math.matrixFromRows(row1, row2)', 'math.matrixFromRows(row1, row2, row3)'],
+  syntax: ['matrixFromRows(...arr)', 'matrixFromRows(row1, row2)', 'matrixFromRows(row1, row2, row3)'],
   description: 'Create a dense matrix from vectors as individual rows.',
   examples: ['matrixFromRows([1, 2, 3], [[4],[5],[6]])'],
   seealso: ['matrix', 'matrixFromColumns', 'matrixFromFunction', 'zeros']

package/lib/esm/expression/embeddedDocs/function/matrix/reshape.js

@@ -3,6 +3,6 @@ export var reshapeDocs = {
   category: 'Matrix',
   syntax: ['reshape(x, sizes)'],
   description: 'Reshape a multi dimensional array to fit the specified dimensions.',
-  examples: ['reshape([1, 2, 3, 4, 5, 6], [2, 3])', 'reshape([[1, 2], [3, 4]], [1, 4])', 'reshape([[1, 2], [3, 4]], [4])'],
+  examples: ['reshape([1, 2, 3, 4, 5, 6], [2, 3])', 'reshape([[1, 2], [3, 4]], [1, 4])', 'reshape([[1, 2], [3, 4]], [4])', 'reshape([1, 2, 3, 4], [-1, 2])'],
   seealso: ['size', 'squeeze', 'resize']
 };

package/lib/esm/expression/embeddedDocs/function/matrix/rotate.js

@@ -3,6 +3,6 @@ export var rotateDocs = {
   category: 'Matrix',
   syntax: ['rotate(w, theta)', 'rotate(w, theta, v)'],
   description: 'Returns a 2-D rotation matrix (2x2) for a given angle (in radians). ' + 'Returns a 2-D rotation matrix (3x3) of a given angle (in radians) around given axis.',
-  examples: ['rotate([1, 0], math.pi / 2)', 'rotate(matrix([1, 0]), unit("35deg"))', 'rotate([1, 0, 0], unit("90deg"), [0, 0, 1])', 'rotate(matrix([1, 0, 0]), unit("90deg"), matrix([0, 0, 1]))'],
+  examples: ['rotate([1, 0], pi / 2)', 'rotate(matrix([1, 0]), unit("35deg"))', 'rotate([1, 0, 0], unit("90deg"), [0, 0, 1])', 'rotate(matrix([1, 0, 0]), unit("90deg"), matrix([0, 0, 1]))'],
   seealso: ['matrix', 'rotationMatrix']
 };

package/lib/esm/expression/embeddedDocs/function/probability/lgamma.js

@@ -3,6 +3,6 @@ export var lgammaDocs = {
   category: 'Probability',
   syntax: ['lgamma(n)'],
   description: 'Logarithm of the gamma function for real, positive numbers and complex numbers, ' + 'using Lanczos approximation for numbers and Stirling series for complex numbers.',
-  examples: ['lgamma(4)', 'lgamma(1/2)', 'lgamma(math.i)', 'lgamma(complex(1.1, 2))'],
+  examples: ['lgamma(4)', 'lgamma(1/2)', 'lgamma(i)', 'lgamma(complex(1.1, 2))'],
   seealso: ['gamma']
 };

package/lib/esm/expression/embeddedDocs/function/statistics/max.js

@@ -1,7 +1,7 @@
 export var maxDocs = {
   name: 'max',
   category: 'Statistics',
-  syntax: ['max(a, b, c, ...)', 'max(A)', 'max(A, dim)'],
+  syntax: ['max(a, b, c, ...)', 'max(A)', 'max(A, dimension)'],
   description: 'Compute the maximum value of a list of values.',
   examples: ['max(2, 3, 4, 1)', 'max([2, 3, 4, 1])', 'max([2, 5; 4, 3])', 'max([2, 5; 4, 3], 1)', 'max([2, 5; 4, 3], 2)', 'max(2.7, 7.1, -4.5, 2.0, 4.1)', 'min(2.7, 7.1, -4.5, 2.0, 4.1)'],
   seealso: ['mean', 'median', 'min', 'prod', 'std', 'sum', 'variance']

package/lib/esm/expression/embeddedDocs/function/statistics/mean.js

@@ -1,7 +1,7 @@
 export var meanDocs = {
   name: 'mean',
   category: 'Statistics',
-  syntax: ['mean(a, b, c, ...)', 'mean(A)', 'mean(A, dim)'],
+  syntax: ['mean(a, b, c, ...)', 'mean(A)', 'mean(A, dimension)'],
   description: 'Compute the arithmetic mean of a list of values.',
   examples: ['mean(2, 3, 4, 1)', 'mean([2, 3, 4, 1])', 'mean([2, 5; 4, 3])', 'mean([2, 5; 4, 3], 1)', 'mean([2, 5; 4, 3], 2)', 'mean([1.0, 2.7, 3.2, 4.0])'],
   seealso: ['max', 'median', 'min', 'prod', 'std', 'sum', 'variance']

package/lib/esm/expression/embeddedDocs/function/statistics/min.js

@@ -1,7 +1,7 @@
 export var minDocs = {
   name: 'min',
   category: 'Statistics',
-  syntax: ['min(a, b, c, ...)', 'min(A)', 'min(A, dim)'],
+  syntax: ['min(a, b, c, ...)', 'min(A)', 'min(A, dimension)'],
   description: 'Compute the minimum value of a list of values.',
   examples: ['min(2, 3, 4, 1)', 'min([2, 3, 4, 1])', 'min([2, 5; 4, 3])', 'min([2, 5; 4, 3], 1)', 'min([2, 5; 4, 3], 2)', 'min(2.7, 7.1, -4.5, 2.0, 4.1)', 'max(2.7, 7.1, -4.5, 2.0, 4.1)'],
   seealso: ['max', 'mean', 'median', 'prod', 'std', 'sum', 'variance']

package/lib/esm/expression/embeddedDocs/function/statistics/std.js

@@ -1,7 +1,7 @@
 export var stdDocs = {
   name: 'std',
   category: 'Statistics',
-  syntax: ['std(a, b, c, ...)', 'std(A)', 'std(A, normalization)'],
+  syntax: ['std(a, b, c, ...)', 'std(A)', 'std(A, dimension)', 'std(A, normalization)', 'std(A, dimension, normalization)'],
   description: 'Compute the standard deviation of all values, defined as std(A) = sqrt(variance(A)). Optional parameter normalization can be "unbiased" (default), "uncorrected", or "biased".',
   examples: ['std(2, 4, 6)', 'std([2, 4, 6, 8])', 'std([2, 4, 6, 8], "uncorrected")', 'std([2, 4, 6, 8], "biased")', 'std([1, 2, 3; 4, 5, 6])'],
   seealso: ['max', 'mean', 'min', 'median', 'prod', 'sum', 'variance']