mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/inv.md

@@ -1,45 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function inv
-
-Calculate the inverse of a square matrix.
-
-
-## Syntax
-
-```js
-math.inv(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.inv([[1, 2], [3, 4]])  // returns [[-2, 1], [1.5, -0.5]]
-math.inv(4)                 // returns 0.25
-1 / 4                       // returns 0.25
-```
-
-
-## See also
-
-[det](det.md),
-[transpose](transpose.md)

package/docs/reference/functions/invmod.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function invmod
-
-Calculate the (modular) multiplicative inverse of a modulo b. Solution to the equation `ax ≣ 1 (mod b)`
-See https://en.wikipedia.org/wiki/Modular_multiplicative_inverse.
-
-
-## Syntax
-
-```js
-math.invmod(a, b)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a` | number &#124; BigNumber | An integer number
-`b` | number &#124; BigNumber | An integer number
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber | Returns an integer number where `invmod(a,b)*a ≣ 1 (mod b)`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.invmod(8, 12)             // returns NaN
-math.invmod(7, 13)             // return 2
-math.invmod(15151, 15122)      // returns 10429
-```
-
-
-## See also
-
-[gcd](gcd.md),
-[xgcd](xgcd.md)

package/docs/reference/functions/isInteger.md

@@ -1,55 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function isInteger
-
-Test whether a value is an integer number.
-The function supports `number`, `BigNumber`, and `Fraction`.
-
-The function is evaluated element-wise in case of Array or Matrix input.
-
-
-## Syntax
-
-```js
-math.isInteger(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Array &#124; Matrix | Value to be tested
-
-### Returns
-
-Type | Description
----- | -----------
-boolean | Returns true when `x` contains a numeric, integer value. Throws an error in case of an unknown data type.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.isInteger(2)                     // returns true
-math.isInteger(0)                     // returns true
-math.isInteger(0.5)                   // returns false
-math.isInteger(math.bignumber(500))   // returns true
-math.isInteger(math.fraction(4))      // returns true
-math.isInteger('3')                   // returns true
-math.isInteger([3, 0.5, -2])          // returns [true, false, true]
-math.isInteger(math.complex('2-4i')   // throws an error
-```
-
-
-## See also
-
-[isNumeric](isNumeric.md),
-[isPositive](isPositive.md),
-[isNegative](isNegative.md),
-[isZero](isZero.md)

package/docs/reference/functions/isNaN.md

@@ -1,56 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function isNaN
-
-Test whether a value is NaN (not a number).
-The function supports types `number`, `BigNumber`, `Fraction`, `Unit` and `Complex`.
-
-The function is evaluated element-wise in case of Array or Matrix input.
-
-
-## Syntax
-
-```js
-math.isNaN(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Unit &#124; Array &#124; Matrix | Value to be tested
-
-### Returns
-
-Type | Description
----- | -----------
-boolean | Returns true when `x` is NaN. Throws an error in case of an unknown data type.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.isNaN(3)                     // returns false
-math.isNaN(NaN)                   // returns true
-math.isNaN(0)                     // returns false
-math.isNaN(math.bignumber(NaN))   // returns true
-math.isNaN(math.bignumber(0))     // returns false
-math.isNaN(math.fraction(-2, 5))  // returns false
-math.isNaN('-2')                  // returns false
-math.isNaN([2, 0, -3, NaN]')      // returns [false, false, false, true]
-```
-
-
-## See also
-
-[isNumeric](isNumeric.md),
-[isNegative](isNegative.md),
-[isPositive](isPositive.md),
-[isZero](isZero.md),
-[isInteger](isInteger.md)

package/docs/reference/functions/isNegative.md

@@ -1,55 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function isNegative
-
-Test whether a value is negative: smaller than zero.
-The function supports types `number`, `BigNumber`, `Fraction`, and `Unit`.
-
-The function is evaluated element-wise in case of Array or Matrix input.
-
-
-## Syntax
-
-```js
-math.isNegative(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Unit &#124; Array &#124; Matrix | Value to be tested
-
-### Returns
-
-Type | Description
----- | -----------
-boolean | Returns true when `x` is larger than zero. Throws an error in case of an unknown data type.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.isNegative(3)                     // returns false
-math.isNegative(-2)                    // returns true
-math.isNegative(0)                     // returns false
-math.isNegative(-0)                    // returns false
-math.isNegative(math.bignumber(2))     // returns false
-math.isNegative(math.fraction(-2, 5))  // returns true
-math.isNegative('-2')                  // returns true
-math.isNegative([2, 0, -3]')           // returns [false, false, true]
-```
-
-
-## See also
-
-[isNumeric](isNumeric.md),
-[isPositive](isPositive.md),
-[isZero](isZero.md),
-[isInteger](isInteger.md)

package/docs/reference/functions/isNumeric.md

@@ -1,55 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function isNumeric
-
-Test whether a value is an numeric value.
-
-The function is evaluated element-wise in case of Array or Matrix input.
-
-
-## Syntax
-
-```js
-math.isNumeric(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | * | Value to be tested
-
-### Returns
-
-Type | Description
----- | -----------
-boolean | Returns true when `x` is a `number`, `BigNumber`, `Fraction`, or `boolean`. Returns false for other types. Throws an error in case of unknown types.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.isNumeric(2)                     // returns true
-math.isNumeric('2')                   // returns false
-math.hasNumericValue('2')             // returns true
-math.isNumeric(0)                     // returns true
-math.isNumeric(math.bignumber(500))   // returns true
-math.isNumeric(math.fraction(4))      // returns true
-math.isNumeric(math.complex('2-4i')   // returns false
-math.isNumeric([2.3, 'foo', false])   // returns [true, false, true]
-```
-
-
-## See also
-
-[isZero](isZero.md),
-[isPositive](isPositive.md),
-[isNegative](isNegative.md),
-[isInteger](isInteger.md),
-[hasNumericValue](hasNumericValue.md)

package/docs/reference/functions/isPositive.md

@@ -1,57 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function isPositive
-
-Test whether a value is positive: larger than zero.
-The function supports types `number`, `BigNumber`, `Fraction`, and `Unit`.
-
-The function is evaluated element-wise in case of Array or Matrix input.
-
-
-## Syntax
-
-```js
-math.isPositive(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Unit &#124; Array &#124; Matrix | Value to be tested
-
-### Returns
-
-Type | Description
----- | -----------
-boolean | Returns true when `x` is larger than zero. Throws an error in case of an unknown data type.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.isPositive(3)                     // returns true
-math.isPositive(-2)                    // returns false
-math.isPositive(0)                     // returns false
-math.isPositive(-0)                    // returns false
-math.isPositive(0.5)                   // returns true
-math.isPositive(math.bignumber(2))     // returns true
-math.isPositive(math.fraction(-2, 5))  // returns false
-math.isPositive(math.fraction(1,3))    // returns false
-math.isPositive('2')                   // returns true
-math.isPositive([2, 0, -3])            // returns [true, false, false]
-```
-
-
-## See also
-
-[isNumeric](isNumeric.md),
-[isZero](isZero.md),
-[isNegative](isNegative.md),
-[isInteger](isInteger.md)

package/docs/reference/functions/isPrime.md

@@ -1,54 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function isPrime
-
-Test whether a value is prime: has no divisors other than itself and one.
-The function supports type `number`, `bignumber`.
-
-The function is evaluated element-wise in case of Array or Matrix input.
-
-
-## Syntax
-
-```js
-math.isPrime(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Array &#124; Matrix | Value to be tested
-
-### Returns
-
-Type | Description
----- | -----------
-boolean | Returns true when `x` is larger than zero. Throws an error in case of an unknown data type.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.isPrime(3)                     // returns true
-math.isPrime(-2)                    // returns false
-math.isPrime(0)                     // returns false
-math.isPrime(-0)                    // returns false
-math.isPrime(0.5)                   // returns false
-math.isPrime('2')                   // returns true
-math.isPrime([2, 17, 100])           // returns [true, true, false]
-```
-
-
-## See also
-
-[isNumeric](isNumeric.md),
-[isZero](isZero.md),
-[isNegative](isNegative.md),
-[isInteger](isInteger.md)

package/docs/reference/functions/isZero.md

@@ -1,59 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function isZero
-
-Test whether a value is zero.
-The function can check for zero for types `number`, `BigNumber`, `Fraction`,
-`Complex`, and `Unit`.
-
-The function is evaluated element-wise in case of Array or Matrix input.
-
-
-## Syntax
-
-```js
-math.isZero(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Fraction &#124; Unit &#124; Array &#124; Matrix | Value to be tested
-
-### Returns
-
-Type | Description
----- | -----------
-boolean | Returns true when `x` is zero. Throws an error in case of an unknown data type.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.isZero(0)                     // returns true
-math.isZero(2)                     // returns false
-math.isZero(0.5)                   // returns false
-math.isZero(math.bignumber(0))     // returns true
-math.isZero(math.fraction(0))      // returns true
-math.isZero(math.fraction(1,3))    // returns false
-math.isZero(math.complex('2 - 4i') // returns false
-math.isZero(math.complex('0i')     // returns true
-math.isZero('0')                   // returns true
-math.isZero('2')                   // returns false
-math.isZero([2, 0, -3]')           // returns [false, true, false]
-```
-
-
-## See also
-
-[isNumeric](isNumeric.md),
-[isPositive](isPositive.md),
-[isNegative](isNegative.md),
-[isInteger](isInteger.md)

package/docs/reference/functions/kldivergence.md

@@ -1,41 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function kldivergence
-
-Calculate the Kullback-Leibler (KL) divergence  between two distributions
-
-
-## Syntax
-
-```js
-math.kldivergence(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`q` | Array &#124; Matrix | First vector
-`p` | Array &#124; Matrix | Second vector
-
-### Returns
-
-Type | Description
----- | -----------
-number | Returns distance between q and p
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.kldivergence([0.7,0.5,0.4], [0.2,0.9,0.5])   //returns 0.24376698773121153
-
-```
-
-

package/docs/reference/functions/kron.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function kron
-
-Calculates the kronecker product of 2 matrices or vectors.
-
-NOTE: If a one dimensional vector / matrix is given, it will be
-wrapped so its two dimensions.
-See the examples.
-
-
-## Syntax
-
-```js
-math.kron(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Array &#124; Matrix | First vector
-`y` | Array &#124; Matrix | Second vector
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | Returns the kronecker product of `x` and `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.kron([[1, 0], [0, 1]], [[1, 2], [3, 4]])
-// returns [ [ 1, 2, 0, 0 ], [ 3, 4, 0, 0 ], [ 0, 0, 1, 2 ], [ 0, 0, 3, 4 ] ]
-
-math.kron([1,1], [2,3,4])
-// returns [ [ 2, 3, 4, 2, 3, 4 ] ]
-```
-
-
-## See also
-
-[multiply](multiply.md),
-[dot](dot.md),
-[cross](cross.md)

package/docs/reference/functions/larger.md

@@ -1,60 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function larger
-
-Test whether value x is larger than y.
-
-The function returns true when x is larger than y and the relative
-difference between x and y is larger than the configured epsilon. The
-function cannot be used to compare values smaller than approximately 2.22e-16.
-
-For matrices, the function is evaluated element wise.
-Strings are compared by their numerical value.
-
-
-## Syntax
-
-```js
-math.larger(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Unit &#124; string &#124; Array &#124; Matrix | First value to compare
-`y` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Unit &#124; string &#124; Array &#124; Matrix | Second value to compare
-
-### Returns
-
-Type | Description
----- | -----------
-boolean &#124; Array &#124; Matrix | Returns true when the x is larger than y, else returns false
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.larger(2, 3)             // returns false
-math.larger(5, 2 + 2)         // returns true
-
-const a = math.unit('5 cm')
-const b = math.unit('2 inch')
-math.larger(a, b)             // returns false
-```
-
-
-## See also
-
-[equal](equal.md),
-[unequal](unequal.md),
-[smaller](smaller.md),
-[smallerEq](smallerEq.md),
-[largerEq](largerEq.md),
-[compare](compare.md)

package/docs/reference/functions/largerEq.md

@@ -1,56 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function largerEq
-
-Test whether value x is larger or equal to y.
-
-The function returns true when x is larger than y or the relative
-difference between x and y is smaller than the configured epsilon. The
-function cannot be used to compare values smaller than approximately 2.22e-16.
-
-For matrices, the function is evaluated element wise.
-Strings are compared by their numerical value.
-
-
-## Syntax
-
-```js
-math.largerEq(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Unit &#124; string &#124; Array &#124; Matrix | First value to compare
-`y` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Unit &#124; string &#124; Array &#124; Matrix | Second value to compare
-
-### Returns
-
-Type | Description
----- | -----------
-boolean &#124; Array &#124; Matrix | Returns true when the x is larger or equal to y, else returns false
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.larger(2, 1 + 1)         // returns false
-math.largerEq(2, 1 + 1)       // returns true
-```
-
-
-## See also
-
-[equal](equal.md),
-[unequal](unequal.md),
-[smaller](smaller.md),
-[smallerEq](smallerEq.md),
-[larger](larger.md),
-[compare](compare.md)