mathjs 10.0.0 → 10.6.4

package/docs/reference/functions/floor.md

@@ -1,56 +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
-
-
-## 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]
-```
-
-
-## See also
-
-[ceil](ceil.md),
-[fix](fix.md),
-[round](round.md)

package/docs/reference/functions/forEach.md

@@ -1,35 +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.
-
-## 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,118 +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.
-- `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
-
-
-## 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)

package/docs/reference/functions/gamma.md

@@ -1,43 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function gamma
-
-Compute the gamma function of a value using Lanczos approximation for
-small values, and an extended Stirling approximation for large values.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.gamma(n)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`n` | number &#124; Array &#124; Matrix | A real or complex number
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array &#124; Matrix | The gamma of `n`
-
-
-## Examples
-
-```js
-math.gamma(5)       // returns 24
-math.gamma(-0.5)    // returns -3.5449077018110335
-math.gamma(math.i)  // returns -0.15494982830180973 - 0.49801566811835596i
-```
-
-
-## See also
-
-[combinations](combinations.md),
-[factorial](factorial.md),
-[permutations](permutations.md)

package/docs/reference/functions/gcd.md

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

package/docs/reference/functions/getMatrixDataType.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function getMatrixDataType
-
-Find the data type of all elements in a matrix or array,
-for example 'number' if all items are a number and 'Complex' if all values
-are complex numbers.
-If a matrix contains more than one data type, it will return 'mixed'.
-
-
-## Syntax
-
-```js
-math.getMatrixDataType(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | ...Matrix &#124; Array | The Matrix with values.
-
-### Returns
-
-Type | Description
----- | -----------
-string | A string representation of the matrix type
-
-
-## Examples
-
-```js
-const x = [ [1, 2, 3], [4, 5, 6] ]
-const mixedX = [ [1, true], [2, 3] ]
-const fractionX = [ [math.fraction(1, 3)], [math.fraction(1, 3] ]
-const unitX = [ [math.unit('5cm')], [math.unit('5cm')] ]
-const bigNumberX = [ [math.bignumber(1)], [math.bignumber(0)] ]
-const sparse = math.sparse(x)
-const dense = math.matrix(x)
-math.getMatrixDataType(x)   // returns 'number'
-math.getMatrixDataType(sparse)   // returns 'number'
-math.getMatrixDataType(dense)   // returns 'number'
-math.getMatrixDataType(mixedX) // returns 'mixed'
-math.getMatrixDataType(fractionX) // returns 'Fraction'
-math.getMatrixDataType(unitX) // returns 'Unit'
-math.getMatrixDataType(bigNumberX) // return 'BigNumber'
-```
-
-
-## See also
-
-[SparseMatrix](SparseMatrix.md),
-[DenseMatrix](DenseMatrix.md)

package/docs/reference/functions/hasNumericValue.md

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

package/docs/reference/functions/help.md

@@ -1,36 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function help
-
-Retrieve help on a function or data type.
-Help files are retrieved from the embedded documentation in math.docs.
-
-
-## Syntax
-
-```js
-math.help(search)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`search` | Function &#124; string &#124; Object | A function or function name for which to get help
-
-### Returns
-
-Type | Description
----- | -----------
-Help | A help object
-
-
-## Examples
-
-```js
-console.log(math.help('sin').toString())
-console.log(math.help(math.add).toString())
-console.log(math.help(math.add).toJSON())
-```
-
-

package/docs/reference/functions/hex.md

@@ -1,39 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function hex
-
-Format a number as hexadecimal.
-
-
-## Syntax
-
-```js
-math.hex(value)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`value` | number | Value to be stringified
-`wordSize` | number | Optional word size (see `format`)
-
-### Returns
-
-Type | Description
----- | -----------
-string | The formatted value
-
-
-## Examples
-
-```js
-//the following outputs "0xF0"
-math.hex(240)
-```
-
-
-## See also
-
-[oct](oct.md),
-[bin](bin.md)

package/docs/reference/functions/hypot.md

@@ -1,45 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function hypot
-
-Calculate the hypotenusa of a list with values. The hypotenusa is defined as:
-
-    hypot(a, b, c, ...) = sqrt(a^2 + b^2 + c^2 + ...)
-
-For matrix input, the hypotenusa is calculated for all values in the matrix.
-
-
-## Syntax
-
-```js
-math.hypot(a, b, ...)
-math.hypot([a, b, c, ...])
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | ... number &#124; BigNumber &#124; Array &#124; Matrix | A list with numeric values or an Array or Matrix. Matrix and Array input is flattened and returns a single number for the whole matrix.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber | Returns the hypothenusa of the input values.
-
-
-## Examples
-
-```js
-math.hypot(3, 4)      // 5
-math.hypot(3, 4, 5)   // 7.0710678118654755
-math.hypot([3, 4, 5]) // 7.0710678118654755
-math.hypot(-2)        // 2
-```
-
-
-## See also
-
-[abs](abs.md),
-[norm](norm.md)

package/docs/reference/functions/identity.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function identity
-
-Create a 2-dimensional identity matrix with size m x n or n x n.
-The matrix has ones on the diagonal and zeros elsewhere.
-
-
-## Syntax
-
-```js
-math.identity(n)
-math.identity(n, format)
-math.identity(m, n)
-math.identity(m, n, format)
-math.identity([m, n])
-math.identity([m, n], format)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`size` | ...number &#124; Matrix &#124; Array | The size for the matrix
-`format` | string | The Matrix storage format
-
-### Returns
-
-Type | Description
----- | -----------
-Matrix &#124; Array &#124; number | A matrix with ones on the diagonal.
-
-
-## Examples
-
-```js
-math.identity(3)                    // returns [[1, 0, 0], [0, 1, 0], [0, 0, 1]]
-math.identity(3, 2)                 // returns [[1, 0], [0, 1], [0, 0]]
-
-const A = [[1, 2, 3], [4, 5, 6]]
-math.identity(math.size(A))         // returns [[1, 0, 0], [0, 1, 0]]
-```
-
-
-## See also
-
-[diag](diag.md),
-[ones](ones.md),
-[zeros](zeros.md),
-[size](size.md),
-[range](range.md)

package/docs/reference/functions/im.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function im
-
-Get the imaginary part of a complex number.
-For a complex number `a + bi`, the function returns `b`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.im(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  A complex number or array with complex numbers
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Array &#124; Matrix | The imaginary part of x
-
-
-## Examples
-
-```js
-const a = math.complex(2, 3)
-math.re(a)                     // returns number 2
-math.im(a)                     // returns number 3
-
-math.re(math.complex('-5.2i')) // returns number -5.2
-math.re(math.complex(2.4))     // returns number 0
-```
-
-
-## See also
-
-[re](re.md),
-[conj](conj.md),
-[abs](abs.md),
-[arg](arg.md)