mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/gamma.md

@@ -1,49 +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`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## 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,50 +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
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## 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,59 +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
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## 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,55 +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.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## 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,42 +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
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## 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,45 +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
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-//the following outputs "0xF0"
-math.hex(240)
-```
-
-
-## See also
-
-[oct](oct.md),
-[bin](bin.md)

package/docs/reference/functions/hypot.md

@@ -1,51 +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.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## 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,57 +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.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## 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/ifft.md

@@ -1,35 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function ifft
-
-Calculate N-dimensional inverse fourier transform
-
-
-## Syntax
-
-```js
-math.ifft(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
-
-[fft](fft.md)

package/docs/reference/functions/im.md

@@ -1,53 +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
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## 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)

package/docs/reference/functions/import.md

@@ -1,68 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function import
-
-Import functions from an object or a module.
-
-This function is only available on a mathjs instance created using `create`.
-
-
-## Syntax
-
-```js
-math.import(functions)
-math.import(functions, options)
-```
-
-### Where
-
-- `functions: Object`
-  An object with functions or factories to be imported.
-- `options: Object` An object with import options. Available options:
-  - `override: boolean`
-    If true, existing functions will be overwritten. False by default.
-  - `silent: boolean`
-    If true, the function will not throw errors on duplicates or invalid
-    types. False by default.
-  - `wrap: boolean`
-    If true, the functions will be wrapped in a wrapper function
-    which converts data types like Matrix to primitive data types like Array.
-    The wrapper is needed when extending math.js with libraries which do not
-    support these data type. False by default.
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`functions` | Object &#124; Array | Object with functions to be imported.
-`options` | Object | Import options.
-
-## Examples
-
-```js
-import { create, all } from 'mathjs'
-import * as numbers from 'numbers'
-
-// create a mathjs instance
-const math = create(all)
-
-// define new functions and variables
-math.import({
-  myvalue: 42,
-  hello: function (name) {
-    return 'hello, ' + name + '!'
-  }
-})
-
-// use the imported function and variable
-math.myvalue * 2               // 84
-math.hello('user')             // 'hello, user!'
-
-// import the npm module 'numbers'
-// (must be installed first with `npm install numbers`)
-math.import(numbers, {wrap: true})
-
-math.fibonacci(7) // returns 13
-```
-
-

package/docs/reference/functions/index.md

@@ -1,55 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function index
-
-Create an index. An Index can store ranges having start, step, and end
-for multiple dimensions.
-Matrix.get, Matrix.set, and math.subset accept an Index as input.
-
-
-## Syntax
-
-```js
-math.index(range1, range2, ...)
-```
-
-### Where
-
-- A number
-- A string for getting/setting an object property
-- An instance of `Range`
-- A one-dimensional Array or a Matrix with numbers
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`ranges` | ...* | Zero or more ranges or numbers.
-
-### Returns
-
-Type | Description
----- | -----------
-Index | Returns the created index
-
-
-## Examples
-
-```js
-const b = [1, 2, 3, 4, 5]
-math.subset(b, math.index([1, 2, 3]))     // returns [2, 3, 4]
-
-const a = math.matrix([[1, 2], [3, 4]])
-a.subset(math.index(0, 1))             // returns 2
-```
-
-
-## See also
-
-[bignumber](bignumber.md),
-[boolean](boolean.md),
-[complex](complex.md),
-[matrix](matrix.md),
-[number](number.md),
-[string](string.md),
-[unit](unit.md)

package/docs/reference/functions/intersect.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function intersect
-
-Calculates the point of intersection of two lines in two or three dimensions
-and of a line and a plane in three dimensions. The inputs are in the form of
-arrays or 1 dimensional matrices. The line intersection functions return null
-if the lines do not meet.
-
-Note: Fill the plane coefficients as `x + y + z = c` and not as `x + y + z + c = 0`.
-
-
-## Syntax
-
-```js
-math.intersect(endPoint1Line1, endPoint2Line1, endPoint1Line2, endPoint2Line2)
-math.intersect(endPoint1, endPoint2, planeCoefficients)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`w` | Array &#124; Matrix | Co-ordinates of first end-point of first line
-`x` | Array &#124; Matrix | Co-ordinates of second end-point of first line
-`y` | Array &#124; Matrix | Co-ordinates of first end-point of second line OR Co-efficients of the plane's equation
-`z` | Array &#124; Matrix | Co-ordinates of second end-point of second line OR undefined if the calculation is for line and plane
-
-### Returns
-
-Type | Description
----- | -----------
-Array | Returns the point of intersection of lines/lines-planes
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.intersect([0, 0], [10, 10], [10, 0], [0, 10])              // Returns [5, 5]
-math.intersect([0, 0, 0], [10, 10, 0], [10, 0, 0], [0, 10, 0])  // Returns [5, 5, 0]
-math.intersect([1, 0, 1],  [4, -2, 2], [1, 1, 1, 6])            // Returns [7, -4, 3]
-```
-
-