mathjs 11.5.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/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/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/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.5.0
- * @date    2022-12-05
+ * @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.5.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/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']

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

@@ -1,7 +1,7 @@
 export 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/esm/expression/embeddedDocs/function/statistics/variance.js

@@ -1,7 +1,7 @@
 export 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/esm/function/statistics/max.js

@@ -12,7 +12,7 @@ export var createMax = /* #__PURE__ */factory(name, dependencies, _ref => {
   } = _ref;
   /**
    * 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.
    *
@@ -20,7 +20,7 @@ export var createMax = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    *     math.max(a, b, c, ...)
    *     math.max(A)
-   *     math.max(A, dim)
+   *     math.max(A, dimension)
    *
    * Examples:
    *

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

@@ -12,7 +12,7 @@ export var createMean = /* #__PURE__ */factory(name, dependencies, _ref => {
   } = _ref;
   /**
    * 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.
    *
@@ -20,7 +20,7 @@ export var createMean = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    *     math.mean(a, b, c, ...)
    *     math.mean(A)
-   *     math.mean(A, dim)
+   *     math.mean(A, dimension)
    *
    * Examples:
    *

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

@@ -12,7 +12,7 @@ export var createMin = /* #__PURE__ */factory(name, dependencies, _ref => {
   } = _ref;
   /**
    * 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.
    *
@@ -20,7 +20,7 @@ export var createMin = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    *     math.min(a, b, c, ...)
    *     math.min(A)
-   *     math.min(A, dim)
+   *     math.min(A, dimension)
    *
    * Examples:
    *

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

@@ -10,7 +10,7 @@ export var createMode = /* #__PURE__ */factory(name, dependencies, _ref => {
   } = _ref;
   /**
   * 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/esm/function/statistics/prod.js

@@ -12,7 +12,7 @@ export var createProd = /* #__PURE__ */factory(name, dependencies, _ref => {
   } = _ref;
   /**
    * 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/esm/function/statistics/quantileSeq.js

@@ -18,7 +18,7 @@ export var createQuantileSeq = /* #__PURE__ */factory(name, dependencies, _ref =
    * 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/esm/function/statistics/sum.js

@@ -12,13 +12,14 @@ export var createSum = /* #__PURE__ */factory(name, dependencies, _ref => {
   } = _ref;
   /**
    * 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:
    *
@@ -30,7 +31,7 @@ export var createSum = /* #__PURE__ */factory(name, dependencies, _ref => {
    *
    *    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/esm/function/statistics/variance.js

@@ -17,7 +17,7 @@ export var createVariance = /* #__PURE__ */factory(name, dependencies, _ref => {
   } = _ref;
   /**
    * 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/esm/header.js

@@ -10,7 +10,7 @@
  * @date    @@date
  *
  * @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/esm/version.js

@@ -1,3 +1,3 @@
-export var version = '11.5.0';
+export var version = '11.5.1';
 // Note: This file is automatically generated when building math.js.
 // Changes made in this file will be overwritten.