mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/lcm.md

@@ -1,54 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function lcm
-
-Calculate the least common multiple for two or more values or arrays.
-
-lcm is defined as:
-
-    lcm(a, b) = abs(a * b) / gcd(a, b)
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.lcm(a, b)
-math.lcm(a, b, c, ...)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | ... number &#124; BigNumber &#124; Array &#124; Matrix | Two or more integer numbers
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Array &#124; Matrix | The least common multiple
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.lcm(4, 6)               // returns 12
-math.lcm(6, 21)              // returns 42
-math.lcm(6, 21, 5)           // returns 210
-
-math.lcm([4, 6], [6, 21])    // returns [12, 42]
-```
-
-
-## See also
-
-[gcd](gcd.md),
-[xgcd](xgcd.md)

package/docs/reference/functions/leafCount.md

@@ -1,52 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function leafCount
-
-Gives the number of "leaf nodes" in the parse tree of the given expression
-A leaf node is one that has no subexpressions, essentially either a
-symbol or a constant. Note that `5!` has just one leaf, the '5'; the
-unary factorial operator does not add a leaf. On the other hand,
-function symbols do add leaves, so `sin(x)/cos(x)` has four leaves.
-
-The `simplify()` function should generally not increase the `leafCount()`
-of an expression, although currently there is no guarantee that it never
-does so. In many cases, `simplify()` reduces the leaf count.
-
-
-## Syntax
-
-```js
-leafCount(expr)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`expr` | Node &#124; string | The expression to count the leaves of
-
-### Returns
-
-Type | Description
----- | -----------
-number | The number of leaves of `expr`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.leafCount('x') // 1
-math.leafCount(math.parse('a*d-b*c')) // 4
-math.leafCount('[a,b;c,d][0,1]') // 6
-```
-
-
-## See also
-
-[simplify](simplify.md)

package/docs/reference/functions/leftShift.md

@@ -1,52 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function leftShift
-
-Bitwise left logical shift of a 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
-
-```js
-math.leftShift(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Array &#124; Matrix | Value to be shifted
-`y` | number &#124; BigNumber | Amount of shifts
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Array &#124; Matrix | `x` shifted left `y` times
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.leftShift(1, 2)               // returns number 4
-
-math.leftShift([1, 2, 3], 4)       // returns Array [16, 32, 64]
-```
-
-
-## See also
-
-[leftShift](leftShift.md),
-[bitNot](bitNot.md),
-[bitOr](bitOr.md),
-[bitXor](bitXor.md),
-[rightArithShift](rightArithShift.md),
-[rightLogShift](rightLogShift.md)

package/docs/reference/functions/lgamma.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function lgamma
-
-Logarithm of the gamma function for real, positive numbers and complex numbers,
-using Lanczos approximation for numbers and Stirling series for complex numbers.
-
-
-## Syntax
-
-```js
-math.lgamma(n)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`n` | number &#124; Complex | A real or complex number
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Complex | The log gamma of `n`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.lgamma(5)       // returns 3.178053830347945
-math.lgamma(0)       // returns Infinity
-math.lgamma(-0.5)    // returns NaN
-math.lgamma(math.i)  // returns -0.6509231993018536 - 1.8724366472624294i
-```
-
-
-## See also
-
-[gamma](gamma.md)

package/docs/reference/functions/log.md

@@ -1,57 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function log
-
-Calculate the logarithm of a value.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.log(x)
-math.log(x, base)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  Value for which to calculate the logarithm.
-`base` | number &#124; BigNumber &#124; Complex |  Optional base for the logarithm. If not provided, the natural logarithm of `x` is calculated. Default value: e.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  Returns the logarithm of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.log(3.5)                  // returns 1.252762968495368
-math.exp(math.log(2.4))        // returns 2.4
-
-math.pow(10, 4)                // returns 10000
-math.log(10000, 10)            // returns 4
-math.log(10000) / math.log(10) // returns 4
-
-math.log(1024, 2)              // returns 10
-math.pow(2, 10)                // returns 1024
-```
-
-
-## See also
-
-[exp](exp.md),
-[log2](log2.md),
-[log10](log10.md),
-[log1p](log1p.md)

package/docs/reference/functions/log10.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function log10
-
-Calculate the 10-base logarithm of a value. This is the same as calculating `log(x, 10)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.log10(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  Value for which to calculate the logarithm.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  Returns the 10-base logarithm of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.log10(0.00001)            // returns -5
-math.log10(10000)              // returns 4
-math.log(10000) / math.log(10) // returns 4
-math.pow(10, 4)                // returns 10000
-```
-
-
-## See also
-
-[exp](exp.md),
-[log](log.md),
-[log1p](log1p.md),
-[log2](log2.md)

package/docs/reference/functions/log1p.md

@@ -1,54 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function log1p
-
-Calculate the logarithm of a `value+1`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.log1p(x)
-math.log1p(x, base)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  Value for which to calculate the logarithm of `x+1`.
-`base` | number &#124; BigNumber &#124; Complex |  Optional base for the logarithm. If not provided, the natural logarithm of `x+1` is calculated. Default value: e.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  Returns the logarithm of `x+1`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.log1p(2.5)                 // returns 1.252762968495368
-math.exp(math.log1p(1.4))       // returns 2.4
-
-math.pow(10, 4)                 // returns 10000
-math.log1p(9999, 10)            // returns 4
-math.log1p(9999) / math.log(10) // returns 4
-```
-
-
-## See also
-
-[exp](exp.md),
-[log](log.md),
-[log2](log2.md),
-[log10](log10.md)

package/docs/reference/functions/log2.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function log2
-
-Calculate the 2-base of a value. This is the same as calculating `log(x, 2)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.log2(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  Value for which to calculate the logarithm.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  Returns the 2-base logarithm of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.log2(0.03125)           // returns -5
-math.log2(16)                // returns 4
-math.log2(16) / math.log2(2) // returns 4
-math.pow(2, 4)               // returns 16
-```
-
-
-## See also
-
-[exp](exp.md),
-[log](log.md),
-[log1p](log1p.md),
-[log10](log10.md)

package/docs/reference/functions/lsolve.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function lsolve
-
-Finds one solution of a linear equation system by forwards substitution. Matrix must be a lower triangular matrix. Throws an error if there's no solution.
-
-`L * x = b`
-
-
-## Syntax
-
-```js
-math.lsolve(L, b)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`L` | Matrix, Array | A N x N matrix or array (L)
-`b` | Matrix, Array | A column vector with the b values
-
-### Returns
-
-Type | Description
----- | -----------
-DenseMatrix &#124; Array | A column vector with the linear system solution (x)
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const a = [[-2, 3], [2, 1]]
-const b = [11, 9]
-const x = lsolve(a, b)  // [[-5.5], [20]]
-```
-
-
-## See also
-
-[lsolveAll](lsolveAll.md),
-[lup](lup.md),
-[slu](slu.md),
-[usolve](usolve.md),
-[lusolve](lusolve.md)

package/docs/reference/functions/lsolveAll.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function lsolveAll
-
-Finds all solutions of a linear equation system by forwards substitution. Matrix must be a lower triangular matrix.
-
-`L * x = b`
-
-
-## Syntax
-
-```js
-math.lsolveAll(L, b)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`L` | Matrix, Array | A N x N matrix or array (L)
-`b` | Matrix, Array | A column vector with the b values
-
-### Returns
-
-Type | Description
----- | -----------
-DenseMatrix[] &#124; Array[] | An array of affine-independent column vectors (x) that solve the linear system
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const a = [[-2, 3], [2, 1]]
-const b = [11, 9]
-const x = lsolveAll(a, b)  // [ [[-5.5], [20]] ]
-```
-
-
-## See also
-
-[lsolve](lsolve.md),
-[lup](lup.md),
-[slu](slu.md),
-[usolve](usolve.md),
-[lusolve](lusolve.md)

package/docs/reference/functions/lup.md

@@ -1,52 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function lup
-
-Calculate the Matrix LU decomposition with partial pivoting. Matrix `A` is decomposed in two matrices (`L`, `U`) and a
-row permutation vector `p` where `A[p,:] = L * U`
-
-
-## Syntax
-
-```js
-math.lup(A)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`A` | Matrix &#124; Array | A two dimensional matrix or array for which to get the LUP decomposition.
-
-### Returns
-
-Type | Description
----- | -----------
-{L: Array &#124; Matrix, U: Array &#124; Matrix, P: Array.&lt;number&gt;} | The lower triangular matrix, the upper triangular matrix and the permutation matrix.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const m = [[2, 1], [1, 4]]
-const r = math.lup(m)
-// r = {
-//   L: [[1, 0], [0.5, 1]],
-//   U: [[2, 1], [0, 3.5]],
-//   P: [0, 1]
-// }
-```
-
-
-## See also
-
-[slu](slu.md),
-[lsolve](lsolve.md),
-[lusolve](lusolve.md),
-[usolve](usolve.md)

package/docs/reference/functions/lusolve.md

@@ -1,59 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function lusolve
-
-Solves the linear system `A * x = b` where `A` is an [n x n] matrix and `b` is a [n] column vector.
-
-
-## Syntax
-
-```js
-math.lusolve(A, b)     // returns column vector with the solution to the linear system A * x = b
-math.lusolve(lup, b)   // returns column vector with the solution to the linear system A * x = b, lup = math.lup(A)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`A` | Matrix &#124; Array &#124; Object | Invertible Matrix or the Matrix LU decomposition
-`b` | Matrix &#124; Array | Column Vector
-`order` | number | The Symbolic Ordering and Analysis order, see slu for details. Matrix must be a SparseMatrix
-`threshold` | Number | Partial pivoting threshold (1 for partial pivoting), see slu for details. Matrix must be a SparseMatrix.
-
-### Returns
-
-Type | Description
----- | -----------
-DenseMatrix &#124; Array | Column vector with the solution to the linear system A * x = b
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const m = [[1, 0, 0, 0], [0, 2, 0, 0], [0, 0, 3, 0], [0, 0, 0, 4]]
-
-const x = math.lusolve(m, [-1, -1, -1, -1])        // x = [[-1], [-0.5], [-1/3], [-0.25]]
-
-const f = math.lup(m)
-const x1 = math.lusolve(f, [-1, -1, -1, -1])       // x1 = [[-1], [-0.5], [-1/3], [-0.25]]
-const x2 = math.lusolve(f, [1, 2, 1, -1])          // x2 = [[1], [1], [1/3], [-0.25]]
-
-const a = [[-2, 3], [2, 1]]
-const b = [11, 9]
-const x = math.lusolve(a, b)  // [[2], [5]]
-```
-
-
-## See also
-
-[lup](lup.md),
-[slu](slu.md),
-[lsolve](lsolve.md),
-[usolve](usolve.md)

package/docs/reference/functions/mad.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function mad
-
-Compute the median absolute deviation of a matrix or a list with values.
-The median absolute deviation is defined as the median of the absolute
-deviations from the median.
-
-
-## Syntax
-
-```js
-math.mad(a, b, c, ...)
-math.mad(A)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`array` | Array &#124; Matrix |  A single matrix or multiple scalar values.
-
-### Returns
-
-Type | Description
----- | -----------
-* | The median absolute deviation.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.mad(10, 20, 30)             // returns 10
-math.mad([1, 2, 3])              // returns 1
-math.mad([[1, 2, 3], [4, 5, 6]]) // returns 1.5
-```
-
-
-## See also
-
-[median](median.md),
-[mean](mean.md),
-[std](std.md),
-[abs](abs.md)