mathjs 10.4.3 → 10.5.0

package/HISTORY.md

@@ -1,5 +1,20 @@
 # History
 
+# 2022-04-19, version 10.5.0
+
+- Implement #1563: function `pinv`, Moore–Penrose inverse (#2521). 
+  Thanks @HanchaiN.
+- Optimize function `det` for integers by switching to the Bareiss algorithm: 
+  no more round-off errors for integer input (#2516). Thanks @HanchaiN.
+- Implement #2463: allow negative integer powers of invertible square matrices
+  (#2517). Thanks @HanchaiN.
+- Implement the `lgamma` function (defined as log(gamma(z))) for number and
+  Complex types. Supersedes #320. (#2417). Thanks @yifanwww.
+- Fix #2523: update to the latest complex.js to improve `sin(z)` for small
+  `im(z)` (#2525). Thanks @gwhitney.
+- Fix #2526: update TypeScript definition of `ceil` (#2531). Thanks @simlaticak
+- Change mocha reporter to 'dot' to avoid excessively long log files. (#2520)
+
 
 # 2022-04-08, version 10.4.3
 

package/docs/reference/functions/lgamma.md

@@ -0,0 +1,46 @@
+<!-- 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/pinv.md

@@ -0,0 +1,44 @@
+<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
+
+# Function pinv
+
+Calculate the Moore–Penrose inverse of a matrix.
+
+
+## Syntax
+
+```js
+math.pinv(x)
+```
+
+### Parameters
+
+Parameter | Type | Description
+--------- | ---- | -----------
+`x` | number &#124; Complex &#124; Array &#124; Matrix | Matrix to be inversed
+
+### Returns
+
+Type | Description
+---- | -----------
+number &#124; Complex &#124; Array &#124; Matrix | The inverse of `x`.
+
+
+### Throws
+
+Type | Description
+---- | -----------
+
+
+## Examples
+
+```js
+math.pinv([[1, 2], [3, 4]])          // returns [[-2, 1], [1.5, -0.5]]
+math.pinv([[1, 0], [0, 1], [0, 1]])  // returns [[1, 0, 0], [0, 0.5, 0.5]]
+math.pinv(4)                         // returns 0.25
+```
+
+
+## See also
+
+[inv](inv.md)

package/docs/reference/functions/pow.md

@@ -3,8 +3,11 @@
 # Function pow
 
 Calculates the power of x to y, `x ^ y`.
-Matrix exponentiation is supported for square matrices `x`, and positive
-integer exponents `y`.
+
+Matrix exponentiation is supported for square matrices `x` and integers `y`:
+when `y` is nonnegative, `x` may be any square matrix; and when `y` is
+negative, `x` must be invertible, and then this function returns
+inv(x)^(-y).
 
 For cubic roots of negative numbers, the function returns the principal
 root by default. In order to let the function return the real root,
@@ -48,6 +51,9 @@ math.pow(a, 2)                // returns Complex -5 + 12i
 
 const b = [[1, 2], [4, 3]]
 math.pow(b, 2)               // returns Array [[9, 8], [16, 17]]
+
+const c = [[1, 2], [4, 3]]
+math.pow(c, -1)               // returns Array [[-0.6, 0.4], [0.8, -0.2]]
 ```
 
 

package/docs/reference/functions.md

@@ -144,6 +144,7 @@ Function | Description
 [math.matrixFromRows(...arr)](functions/matrixFromRows.md) | Create a dense matrix from vectors as individual rows.
 [math.ones(m, n, p, ...)](functions/ones.md) | Create a matrix filled with ones.
 [math.partitionSelect(x, k)](functions/partitionSelect.md) | Partition-based selection of an array or 1D matrix.
+[math.pinv(x)](functions/pinv.md) | Calculate the Moore–Penrose inverse of a matrix.
 [math.range(start, end [, step])](functions/range.md) | Create an array from a range.
 [math.reshape(x, sizes)](functions/reshape.md) | Reshape a multi dimensional array to fit the specified dimensions.
 [math.resize(x, size [, defaultValue])](functions/resize.md) | Resize a matrix.
@@ -168,6 +169,7 @@ Function | Description
 [math.factorial(n)](functions/factorial.md) | Compute the factorial of a value  Factorial only supports an integer value as argument.
 [math.gamma(n)](functions/gamma.md) | Compute the gamma function of a value using Lanczos approximation for small values, and an extended Stirling approximation for large values.
 [math.kldivergence(x, y)](functions/kldivergence.md) | Calculate the Kullback-Leibler (KL) divergence  between two distributions.
+[math.lgamma(n)](functions/lgamma.md) | Logarithm of the gamma function for real, positive numbers and complex numbers, using Lanczos approximation for numbers and Stirling series for complex numbers.
 [math.multinomial(a)](functions/multinomial.md) | Multinomial Coefficients compute the number of ways of picking a1, a2, .
 [math.permutations(n [, k])](functions/permutations.md) | Compute the number of ways of obtaining an ordered subset of `k` elements from a set of `n` elements.
 [math.pickRandom(array)](functions/pickRandom.md) | Random pick one or more values from a one dimensional array.