mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/exp.md

@@ -1,54 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function exp
-
-Calculate the exponent of a value.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.exp(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | A number or matrix to exponentiate
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | Exponent of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.exp(2)                  // returns number 7.3890560989306495
-math.pow(math.e, 2)          // returns number 7.3890560989306495
-math.log(math.exp(2))        // returns number 2
-
-math.exp([1, 2, 3])
-// returns Array [
-//   2.718281828459045,
-//   7.3890560989306495,
-//   20.085536923187668
-// ]
-```
-
-
-## See also
-
-[expm1](expm1.md),
-[log](log.md),
-[pow](pow.md)

package/docs/reference/functions/expm.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function expm
-
-Compute the matrix exponential, expm(A) = e^A. The matrix must be square.
-Not to be confused with exp(a), which performs element-wise
-exponentiation.
-
-The exponential is calculated using the Padé approximant with scaling and
-squaring; see "Nineteen Dubious Ways to Compute the Exponential of a
-Matrix," by Moler and Van Loan.
-
-
-## Syntax
-
-```js
-math.expm(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Matrix | A square Matrix
-
-### Returns
-
-Type | Description
----- | -----------
-Matrix | The exponential of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const A = [[0,2],[0,0]]
-math.expm(A)        // returns [[1,2],[0,1]]
-```
-
-
-## See also
-
-[exp](exp.md)

package/docs/reference/functions/expm1.md

@@ -1,54 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function expm1
-
-Calculate the value of subtracting 1 from the exponential value.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.expm1(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | A number or matrix to apply expm1
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | Exponent of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.expm1(2)                      // returns number 6.38905609893065
-math.pow(math.e, 2) - 1            // returns number 6.3890560989306495
-math.log(math.expm1(2) + 1)        // returns number 2
-
-math.expm1([1, 2, 3])
-// returns Array [
-//   1.718281828459045,
-//   6.3890560989306495,
-//   19.085536923187668
-// ]
-```
-
-
-## See also
-
-[exp](exp.md),
-[log](log.md),
-[pow](pow.md)

package/docs/reference/functions/factorial.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function factorial
-
-Compute the factorial of a value
-
-Factorial only supports an integer value as argument.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.factorial(n)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`n` | number &#124; BigNumber &#124; Array &#124; Matrix | An integer number
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Array &#124; Matrix | The factorial of `n`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.factorial(5)    // returns 120
-math.factorial(3)    // returns 6
-```
-
-
-## See also
-
-[combinations](combinations.md),
-[combinationsWithRep](combinationsWithRep.md),
-[gamma](gamma.md),
-[permutations](permutations.md)

package/docs/reference/functions/fft.md

@@ -1,35 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function fft
-
-Calculate N-dimensional fourier transform
-
-
-## Syntax
-
-```js
-math.fft(arr)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`arr` | Array &#124; Matrix | An array or matrix
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | N-dimensional fourier transformation of the array
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## See also
-
-[ifft](ifft.md)

package/docs/reference/functions/filter.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function filter
-
-Filter the items in an array or one dimensional matrix.
-
-
-## Syntax
-
-```js
-math.filter(x, test)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Matrix &#124; Array | A one dimensional matrix or array to filter
-`test` | Function &#124; RegExp |  A function or regular expression to test items. All entries for which `test` returns true are returned. When `test` is a function, it is invoked with three parameters: the value of the element, the index of the element, and the matrix/array being traversed. The function must return a boolean.
-
-### Returns
-
-Type | Description
----- | -----------
-Matrix &#124; Array | Returns the filtered matrix.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-function isPositive (x) {
-  return x > 0
-}
-math.filter([6, -2, -1, 4, 3], isPositive) // returns [6, 4, 3]
-
-math.filter(["23", "foo", "100", "55", "bar"], /[0-9]+/) // returns ["23", "100", "55"]
-```
-
-
-## See also
-
-[forEach](forEach.md),
-[map](map.md),
-[sort](sort.md)

package/docs/reference/functions/fix.md

@@ -1,62 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function fix
-
-Round a value towards zero.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.fix(x)
-math.fix(x,n)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix | Number to be rounded
-`n` | number &#124; BigNumber &#124; Array | Number of decimals Default value: 0.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix | Rounded value
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.fix(3.2)                // returns number 3
-math.fix(3.8)                // returns number 3
-math.fix(-4.2)               // returns number -4
-math.fix(-4.7)               // returns number -4
-
-math.fix(3.12, 1)                // returns number 3.1
-math.fix(3.18, 1)                // returns number 3.1
-math.fix(-4.12, 1)               // returns number -4.1
-math.fix(-4.17, 1)               // returns number -4.1
-
-const c = math.complex(3.22, -2.78)
-math.fix(c)                  // returns Complex 3 - 2i
-math.fix(c, 1)               // returns Complex 3.2 - 2.7i
-
-math.fix([3.2, 3.8, -4.7])      // returns Array [3, 3, -4]
-math.fix([3.2, 3.8, -4.7], 1)   // returns Array [3.2, 3.8, -4.7]
-```
-
-
-## See also
-
-[ceil](ceil.md),
-[floor](floor.md),
-[round](round.md)

package/docs/reference/functions/flatten.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function flatten
-
-Flatten a multi dimensional matrix into a single dimensional matrix.
-It is guaranteed to always return a clone of the argument.
-
-
-## Syntax
-
-```js
-math.flatten(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Matrix &#124; Array | Matrix to be flattened
-
-### Returns
-
-Type | Description
----- | -----------
-Matrix &#124; Array | Returns the flattened matrix
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.flatten([[1,2], [3,4]])   // returns [1, 2, 3, 4]
-```
-
-
-## See also
-
-[concat](concat.md),
-[resize](resize.md),
-[size](size.md),
-[squeeze](squeeze.md)

package/docs/reference/functions/floor.md

@@ -1,66 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function floor
-
-Round a value towards minus infinity.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.floor(x)
-math.floor(x, n)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix | Number to be rounded
-`n` | number &#124; BigNumber &#124; Array | Number of decimals Default value: 0.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix | Rounded value
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.floor(3.2)              // returns number 3
-math.floor(3.8)              // returns number 3
-math.floor(-4.2)             // returns number -5
-math.floor(-4.7)             // returns number -5
-
-math.floor(3.212, 2)          // returns number 3.21
-math.floor(3.288, 2)          // returns number 3.28
-math.floor(-4.212, 2)         // returns number -4.22
-math.floor(-4.782, 2)         // returns number -4.79
-
-const c = math.complex(3.24, -2.71)
-math.floor(c)                 // returns Complex 3 - 3i
-math.floor(c, 1)              // returns Complex 3.2 - 2.8i
-
-math.floor([3.2, 3.8, -4.7])       // returns Array [3, 3, -5]
-math.floor([3.21, 3.82, -4.71], 1)  // returns Array [3.2, 3.8, -4.8]
-
-math.floor(math.tau, [2, 3])  // returns Array [6.28, 6.283]
-
-// Note that floor(array, array) currently not implemented.
-```
-
-
-## See also
-
-[ceil](ceil.md),
-[fix](fix.md),
-[round](round.md)

package/docs/reference/functions/forEach.md

@@ -1,41 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function forEach
-
-Iterate over all elements of a matrix/array, and executes the given callback function.
-
-
-## Syntax
-
-```js
-math.forEach(x, callback)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Matrix &#124; Array | The matrix to iterate on.
-`callback` | Function | The callback function is invoked with three parameters: the value of the element, the index of the element, and the Matrix/array being traversed.
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.forEach([1, 2, 3], function(value) {
-  console.log(value)
-})
-// outputs 1, 2, 3
-```
-
-
-## See also
-
-[filter](filter.md),
-[map](map.md),
-[sort](sort.md)

package/docs/reference/functions/format.md

@@ -1,127 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function format
-
-Format a value of any type into a string.
-
-
-## Syntax
-
-```js
-math.format(value)
-math.format(value, options)
-math.format(value, precision)
-math.format(value, callback)
-```
-
-### Where
-
- - `value: *`
-   The value to be formatted
- - `options: Object`
-   An object with formatting options. Available options:
-   - `notation: string`
-     Number notation. Choose from:
-     - 'fixed'
-       Always use regular number notation.
-       For example '123.40' and '14000000'
-     - 'exponential'
-       Always use exponential notation.
-       For example '1.234e+2' and '1.4e+7'
-     - 'engineering'
-       Always use engineering notation: always have exponential notation,
-       and select the exponent to be a multiple of 3.
-       For example '123.4e+0' and '14.0e+6'
-     - 'auto' (default)
-       Regular number notation for numbers having an absolute value between
-       `lower` and `upper` bounds, and uses exponential notation elsewhere.
-       Lower bound is included, upper bound is excluded.
-       For example '123.4' and '1.4e7'.
-     - 'bin', 'oct, or 'hex'
-       Format the number using binary, octal, or hexadecimal notation.
-       For example '0b1101' and '0x10fe'.
-   - `wordSize: number`
-     The word size in bits to use for formatting in binary, octal, or
-     hexadecimal notation. To be used only with 'bin', 'oct', or 'hex'
-     values for 'notation' option. When this option is defined the value
-     is formatted as a signed twos complement integer of the given word
-     size and the size suffix is appended to the output.
-     For example format(-1, {notation: 'hex', wordSize: 8}) === '0xffi8'.
-     Default value is undefined.
-   - `precision: number`
-     Limit the number of digits of the formatted value.
-     For regular numbers, must be a number between 0 and 16.
-     For bignumbers, the maximum depends on the configured precision,
-     see function `config()`.
-     In case of notations 'exponential', 'engineering', and 'auto', `precision`
-     defines the total number of significant digits returned.
-     In case of notation 'fixed', `precision` defines the number of
-     significant digits after the decimal point.
-     `precision` is undefined by default.
-   - `lowerExp: number`
-     Exponent determining the lower boundary for formatting a value with
-     an exponent when `notation='auto`. Default value is `-3`.
-   - `upperExp: number`
-     Exponent determining the upper boundary for formatting a value with
-     an exponent when `notation='auto`. Default value is `5`.
-   - `fraction: string`. Available values: 'ratio' (default) or 'decimal'.
-     For example `format(fraction(1, 3))` will output '1/3' when 'ratio' is
-     configured, and will output `0.(3)` when 'decimal' is configured.
-   - `truncate: number`. Specifies the maximum allowed length of the
-     returned string. If it would have been longer, the excess characters
-     are deleted and replaced with `'...'`.
-- `callback: function`
-  A custom formatting function, invoked for all numeric elements in `value`,
-  for example all elements of a matrix, or the real and imaginary
-  parts of a complex number. This callback can be used to override the
-  built-in numeric notation with any type of formatting. Function `callback`
-  is called with `value` as parameter and must return a string.
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`value` | * | Value to be stringified
-`options` | Object &#124; Function &#124; number | Formatting options
-
-### Returns
-
-Type | Description
----- | -----------
-string | The formatted value
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.format(6.4)                                        // returns '6.4'
-math.format(1240000)                                    // returns '1.24e6'
-math.format(1/3)                                        // returns '0.3333333333333333'
-math.format(1/3, 3)                                     // returns '0.333'
-math.format(21385, 2)                                   // returns '21000'
-math.format(12e8, {notation: 'fixed'})                  // returns '1200000000'
-math.format(2.3,  {notation: 'fixed', precision: 4})    // returns '2.3000'
-math.format(52.8, {notation: 'exponential'})            // returns '5.28e+1'
-math.format(12400,{notation: 'engineering'})            // returns '12.400e+3'
-math.format(2000, {lowerExp: -2, upperExp: 2})          // returns '2e+3'
-
-function formatCurrency(value) {
-  // return currency notation with two digits:
-  return '$' + value.toFixed(2)
-
-  // you could also use math.format inside the callback:
-  // return '$' + math.format(value, {notation: 'fixed', precision: 2})
-}
-math.format([2.1, 3, 0.016], formatCurrency)            // returns '[$2.10, $3.00, $0.02]'
-```
-
-
-## See also
-
-[print](print.md)

package/docs/reference/functions/fraction.md

@@ -1,45 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function fraction
-
-Create a fraction convert a value to a fraction.
-
-
-## Syntax
-
-```js
-math.fraction(numerator, denominator)
-math.fraction({n: numerator, d: denominator})
-math.fraction(matrix: Array | Matrix)         Turn all matrix entries
-                                              into fractions
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | number &#124; string &#124; Fraction &#124; BigNumber &#124; Array &#124; Matrix |  Arguments specifying the numerator and denominator of the fraction
-
-### Returns
-
-Type | Description
----- | -----------
-Fraction &#124; Array &#124; Matrix | Returns a fraction
-
-
-## Examples
-
-```js
-math.fraction(1, 3)
-math.fraction('2/3')
-math.fraction({n: 2, d: 3})
-math.fraction([0.2, 0.25, 1.25])
-```
-
-
-## See also
-
-[bignumber](bignumber.md),
-[number](number.md),
-[string](string.md),
-[unit](unit.md)