mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/squeeze.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function squeeze
-
-Squeeze a matrix, remove inner and outer singleton dimensions from a matrix.
-
-
-## Syntax
-
-```js
-math.squeeze(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Matrix &#124; Array | Matrix to be squeezed
-
-### Returns
-
-Type | Description
----- | -----------
-Matrix &#124; Array | Squeezed matrix
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.squeeze([3])           // returns 3
-math.squeeze([[3]])         // returns 3
-
-const A = math.zeros(3, 1)    // returns [[0], [0], [0]] (size 3x1)
-math.squeeze(A)             // returns [0, 0, 0] (size 3)
-
-const B = math.zeros(1, 3)    // returns [[0, 0, 0]] (size 1x3)
-math.squeeze(B)             // returns [0, 0, 0] (size 3)
-
-// only inner and outer dimensions are removed
-const C = math.zeros(2, 1, 3) // returns [[[0, 0, 0]], [[0, 0, 0]]] (size 2x1x3)
-math.squeeze(C)             // returns [[[0, 0, 0]], [[0, 0, 0]]] (size 2x1x3)
-```
-
-
-## See also
-
-[subset](subset.md)

package/docs/reference/functions/std.md

@@ -1,76 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function std
-
-Compute the standard deviation of a matrix or a  list with values.
-The standard deviations is defined as the square root of the variance:
-`std(A) = sqrt(variance(A))`.
-In case of a (multi dimensional) array or matrix, the standard deviation
-over all elements will be calculated by default, unless an axis is specified
-in which case the standard deviation will be computed along that axis.
-
-Additionally, it is possible to compute the standard deviation along the rows
-or columns of a matrix by specifying the dimension as the second argument.
-
-Optionally, the type of normalization can be specified as the final
-parameter. The parameter `normalization` can be one of the following values:
-
-- 'unbiased' (default) The sum of squared errors is divided by (n - 1)
-- 'uncorrected'        The sum of squared errors is divided by n
-- 'biased'             The sum of squared errors is divided by (n + 1)
-
-
-## Syntax
-
-```js
-math.std(a, b, c, ...)
-math.std(A)
-math.std(A, normalization)
-math.std(A, dimension)
-math.std(A, dimension, normalization)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`array` | Array &#124; Matrix |  A single matrix or or multiple scalar values
-`normalization` | string |  Determines how to normalize the variance. Choose 'unbiased' (default), 'uncorrected', or 'biased'. Default value: 'unbiased'.
-
-### Returns
-
-Type | Description
----- | -----------
-* | The standard deviation
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.std(2, 4, 6)                     // returns 2
-math.std([2, 4, 6, 8])                // returns 2.581988897471611
-math.std([2, 4, 6, 8], 'uncorrected') // returns 2.23606797749979
-math.std([2, 4, 6, 8], 'biased')      // returns 2
-
-math.std([[1, 2, 3], [4, 5, 6]])      // returns 1.8708286933869707
-math.std([[1, 2, 3], [4, 6, 8]], 0)    // returns [2.1213203435596424, 2.8284271247461903, 3.5355339059327378]
-math.std([[1, 2, 3], [4, 6, 8]], 1)    // returns [1, 2]
-math.std([[1, 2, 3], [4, 6, 8]], 1, 'biased') // returns [0.7071067811865476, 1.4142135623730951]
-```
-
-
-## See also
-
-[mean](mean.md),
-[median](median.md),
-[max](max.md),
-[min](min.md),
-[prod](prod.md),
-[sum](sum.md),
-[variance](variance.md)

package/docs/reference/functions/stirlingS2.md

@@ -1,52 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function stirlingS2
-
-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
-
-```js
-math.stirlingS2(n, k)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`n` | Number &#124; BigNumber | Total number of objects in the set
-`k` | Number &#124; BigNumber | Number of objects in the subset
-
-### Returns
-
-Type | Description
----- | -----------
-Number &#124; BigNumber | S(n,k)
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.stirlingS2(5, 3) //returns 25
-```
-
-
-## See also
-
-[bellNumbers](bellNumbers.md)

package/docs/reference/functions/string.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function string
-
-Create a string or convert any object into a string.
-Elements of Arrays and Matrices are processed element wise.
-
-
-## Syntax
-
-```js
-math.string(value)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`value` | * &#124; Array &#124; Matrix &#124; null | A value to convert to a string
-
-### Returns
-
-Type | Description
----- | -----------
-string &#124; Array &#124; Matrix | The created string
-
-
-## Examples
-
-```js
-math.string(4.2)               // returns string '4.2'
-math.string(math.complex(3, 2) // returns string '3 + 2i'
-
-const u = math.unit(5, 'km')
-math.string(u.to('m'))         // returns string '5000 m'
-
-math.string([true, false])     // returns ['true', 'false']
-```
-
-
-## See also
-
-[bignumber](bignumber.md),
-[boolean](boolean.md),
-[complex](complex.md),
-[index](index.md),
-[matrix](matrix.md),
-[number](number.md),
-[unit](unit.md)

package/docs/reference/functions/subset.md

@@ -1,65 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function subset
-
-Get or set a subset of a matrix or string.
-
-
-## Syntax
-
-```js
-math.subset(value, index)                                // retrieve a subset
-math.subset(value, index, replacement [, defaultValue])  // replace a subset
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`matrix` | Array &#124; Matrix &#124; string | An array, matrix, or string
-`index` | Index |  For each dimension of the target, specifies an index or a list of indices to fetch or set. `subset` uses the cartesian product of the indices specified in each dimension.
-`replacement` | * | An array, matrix, or scalar. If provided, the subset is replaced with replacement. If not provided, the subset is returned
-`defaultValue` | * | Default value, filled in on new entries when the matrix is resized. If not provided, math.matrix elements will be left undefined. Default value: undefined.
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix &#124; string | Either the retrieved subset or the updated matrix.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-// get a subset
-const d = [[1, 2], [3, 4]]
-math.subset(d, math.index(1, 0))        // returns 3
-math.subset(d, math.index([0, 1], 1))   // returns [[2], [4]]
-
-// replace a subset
-const e = []
-const f = math.subset(e, math.index(0, [0, 2]), [5, 6])  // f = [[5, 6]] and e = [[5, 0, 6]]
-const g = math.subset(f, math.index(1, 1), 7, 0)         // g = [[5, 6], [0, 7]]
-
-// get submatrix using ranges
-const M = [
-  [1,2,3],
-  [4,5,6],
-  [7,8,9]
-]
-math.subset(M, math.index(math.range(0,2), math.range(0,3))) // [[1,2,3],[4,5,6]]
-```
-
-
-## See also
-
-[size](size.md),
-[resize](resize.md),
-[squeeze](squeeze.md),
-[index](index.md)

package/docs/reference/functions/subtract.md

@@ -1,54 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function subtract
-
-Subtract two values, `x - y`.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.subtract(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix |  Initial value
-`y` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix |  Value to subtract from `x`
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix |  Subtraction of `x` and `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.subtract(5.3, 2)        // returns number 3.3
-
-const a = math.complex(2, 3)
-const b = math.complex(4, 1)
-math.subtract(a, b)          // returns Complex -2 + 2i
-
-math.subtract([5, 7, 4], 4)  // returns Array [1, 3, 0]
-
-const c = math.unit('2.1 km')
-const d = math.unit('500m')
-math.subtract(c, d)          // returns Unit 1.6 km
-```
-
-
-## See also
-
-[add](add.md)

package/docs/reference/functions/sum.md

@@ -1,54 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function sum
-
-Compute the sum of a matrix or a list with values.
-In case of a (multi dimensional) array or matrix, the sum of all
-elements will be calculated.
-
-
-## Syntax
-
-```js
-math.sum(a, b, c, ...)
-math.sum(A)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | ... * | A single matrix or or multiple scalar values
-
-### Returns
-
-Type | Description
----- | -----------
-* | The sum of all values
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.sum(2, 1, 4, 3)               // returns 10
-math.sum([2, 1, 4, 3])             // returns 10
-math.sum([[2, 5], [4, 3], [1, 7]]) // returns 22
-```
-
-
-## See also
-
-[mean](mean.md),
-[median](median.md),
-[min](min.md),
-[max](max.md),
-[prod](prod.md),
-[std](std.md),
-[variance](variance.md),
-[cumsum](cumsum.md)

package/docs/reference/functions/symbolicEqual.md

@@ -1,62 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function symbolicEqual
-
-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
-
-```js
-symbolicEqual(expr1, expr2)
-symbolicEqual(expr1, expr2, options)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`expr1` | Node &#124; string | The first expression to compare
-`expr2` | Node &#124; string | The second expression to compare
-`options` | Object | Optional option object, passed to simplify
-
-### Returns
-
-Type | Description
----- | -----------
-boolean |  Returns true if a valid manipulation making the expressions equal is found.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-symbolicEqual('x*y', 'y*x') // true
-symbolicEqual('x*y', 'y*x', {context: {multiply: {commutative: false}}})
-    //false
-symbolicEqual('x/y', '(y*x^(-1))^(-1)') // true
-symbolicEqual('abs(x)','x') // false
-symbolicEqual('abs(x)','x', simplify.positiveContext) // true
-```
-
-
-## See also
-
-[simplify](simplify.md),
-[evaluate](evaluate.md)

package/docs/reference/functions/tan.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function tan
-
-Calculate the tangent of a value. `tan(x)` is equal to `sin(x) / cos(x)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.tan(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | Tangent of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.tan(0.5)                    // returns number 0.5463024898437905
-math.sin(0.5) / math.cos(0.5)    // returns number 0.5463024898437905
-math.tan(math.pi / 4)            // returns number 1
-math.tan(math.unit(45, 'deg'))   // returns number 1
-```
-
-
-## See also
-
-[atan](atan.md),
-[sin](sin.md),
-[cos](cos.md)

package/docs/reference/functions/tanh.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function tanh
-
-Calculate the hyperbolic tangent of a value,
-defined as `tanh(x) = (exp(2 * x) - 1) / (exp(2 * x) + 1)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.tanh(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | Hyperbolic tangent of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-// tanh(x) = sinh(x) / cosh(x) = 1 / coth(x)
-math.tanh(0.5)                   // returns 0.46211715726000974
-math.sinh(0.5) / math.cosh(0.5)  // returns 0.46211715726000974
-1 / math.coth(0.5)               // returns 0.46211715726000974
-```
-
-
-## See also
-
-[sinh](sinh.md),
-[cosh](cosh.md),
-[coth](coth.md)

package/docs/reference/functions/to.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function to
-
-Change the unit of a value.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.to(x, unit)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Unit &#124; Array &#124; Matrix | The unit to be converted.
-`unit` | Unit &#124; Array &#124; Matrix | New unit. Can be a string like "cm" or a unit without value.
-
-### Returns
-
-Type | Description
----- | -----------
-Unit &#124; Array &#124; Matrix | value with changed, fixed unit.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.to(math.unit('2 inch'), 'cm')                   // returns Unit 5.08 cm
-math.to(math.unit('2 inch'), math.unit(null, 'cm'))  // returns Unit 5.08 cm
-math.to(math.unit(16, 'bytes'), 'bits')              // returns Unit 128 bits
-```
-
-
-## See also
-
-[unit](unit.md)

package/docs/reference/functions/trace.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function trace
-
-Calculate the trace of a matrix: the sum of the elements on the main
-diagonal of a square matrix.
-
-
-## Syntax
-
-```js
-math.trace(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Array &#124; Matrix | A matrix
-
-### Returns
-
-Type | Description
----- | -----------
-number | The trace of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.trace([[1, 2], [3, 4]]) // returns 5
-
-const A = [
-  [1, 2, 3],
-  [-1, 2, 3],
-  [2, 0, 3]
-]
-math.trace(A) // returns 6
-```
-
-
-## See also
-
-[diag](diag.md)