mathjs 10.5.2 → 10.6.1

package/docs/reference/functions/transpose.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function transpose
-
-Transpose a matrix. All values of the matrix are reflected over its
-main diagonal. Only applicable to two dimensional matrices containing
-a vector (i.e. having size `[1,n]` or `[n,1]`). One dimensional
-vectors and scalars return the input unchanged.
-
-
-## Syntax
-
-```js
-math.transpose(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Array &#124; Matrix | Matrix to be transposed
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | The transposed matrix
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const A = [[1, 2, 3], [4, 5, 6]]
-math.transpose(A)               // returns [[1, 4], [2, 5], [3, 6]]
-```
-
-
-## See also
-
-[diag](diag.md),
-[inv](inv.md),
-[subset](subset.md),
-[squeeze](squeeze.md)

package/docs/reference/functions/typeOf.md

@@ -1,81 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function typeOf
-
-Determine the type of a variable.
-
-Function `typeOf` recognizes the following types of objects:
-
-Object                 | Returns       | Example
----------------------- | ------------- | ------------------------------------------
-null                   | `'null'`      | `math.typeOf(null)`
-number                 | `'number'`    | `math.typeOf(3.5)`
-boolean                | `'boolean'`   | `math.typeOf(true)`
-string                 | `'string'`    | `math.typeOf('hello world')`
-Array                  | `'Array'`     | `math.typeOf([1, 2, 3])`
-Date                   | `'Date'`      | `math.typeOf(new Date())`
-Function               | `'Function'`  | `math.typeOf(function () {})`
-Object                 | `'Object'`    | `math.typeOf({a: 2, b: 3})`
-RegExp                 | `'RegExp'`    | `math.typeOf(/a regexp/)`
-undefined              | `'undefined'` | `math.typeOf(undefined)`
-math.BigNumber         | `'BigNumber'` | `math.typeOf(math.bignumber('2.3e500'))`
-math.Chain             | `'Chain'`     | `math.typeOf(math.chain(2))`
-math.Complex           | `'Complex'`   | `math.typeOf(math.complex(2, 3))`
-math.Fraction          | `'Fraction'`  | `math.typeOf(math.fraction(1, 3))`
-math.Help              | `'Help'`      | `math.typeOf(math.help('sqrt'))`
-math.Help              | `'Help'`      | `math.typeOf(math.help('sqrt'))`
-math.Index             | `'Index'`     | `math.typeOf(math.index(1, 3))`
-math.Matrix            | `'Matrix'`    | `math.typeOf(math.matrix([[1,2], [3, 4]]))`
-math.Range             | `'Range'`     | `math.typeOf(math.range(0, 10))`
-math.ResultSet         | `'ResultSet'` | `math.typeOf(math.evaluate('a=2\nb=3'))`
-math.Unit              | `'Unit'`      | `math.typeOf(math.unit('45 deg'))`
-math.AccessorNode            | `'AccessorNode'`            | `math.typeOf(math.parse('A[2]'))`
-math.ArrayNode               | `'ArrayNode'`               | `math.typeOf(math.parse('[1,2,3]'))`
-math.AssignmentNode          | `'AssignmentNode'`          | `math.typeOf(math.parse('x=2'))`
-math.BlockNode               | `'BlockNode'`               | `math.typeOf(math.parse('a=2; b=3'))`
-math.ConditionalNode         | `'ConditionalNode'`         | `math.typeOf(math.parse('x<0 ? -x : x'))`
-math.ConstantNode            | `'ConstantNode'`            | `math.typeOf(math.parse('2.3'))`
-math.FunctionAssignmentNode  | `'FunctionAssignmentNode'`  | `math.typeOf(math.parse('f(x)=x^2'))`
-math.FunctionNode            | `'FunctionNode'`            | `math.typeOf(math.parse('sqrt(4)'))`
-math.IndexNode               | `'IndexNode'`               | `math.typeOf(math.parse('A[2]').index)`
-math.ObjectNode              | `'ObjectNode'`              | `math.typeOf(math.parse('{a:2}'))`
-math.ParenthesisNode         | `'ParenthesisNode'`         | `math.typeOf(math.parse('(2+3)'))`
-math.RangeNode               | `'RangeNode'`               | `math.typeOf(math.parse('1:10'))`
-math.SymbolNode              | `'SymbolNode'`              | `math.typeOf(math.parse('x'))`
-
-
-## Syntax
-
-```js
-math.typeOf(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | * | The variable for which to test the type.
-
-### Returns
-
-Type | Description
----- | -----------
-string | Returns the name of the type. Primitive types are lower case, non-primitive types are upper-camel-case. For example 'number', 'string', 'Array', 'Date'.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.typeOf(3.5)                     // returns 'number'
-math.typeOf(math.complex('2-4i'))    // returns 'Complex'
-math.typeOf(math.unit('45 deg'))     // returns 'Unit'
-math.typeOf('hello world')           // returns 'string'
-```
-
-

package/docs/reference/functions/typed.md

@@ -1,56 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function typed
-
-Create a typed-function which checks the types of the arguments and
-can match them against multiple provided signatures. The typed-function
-automatically converts inputs in order to find a matching signature.
-Typed functions throw informative errors in case of wrong input arguments.
-
-See the library [typed-function](https://github.com/josdejong/typed-function)
-for detailed documentation.
-
-
-## Syntax
-
-```js
-math.typed(name, signatures) : function
-math.typed(signatures) : function
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`name` | string | Optional name for the typed-function
-`signatures` | Object&lt;string, function&gt; | Object with one or multiple function signatures
-
-### Returns
-
-Type | Description
----- | -----------
-function | The created typed-function.
-
-
-## Examples
-
-```js
-// create a typed function with multiple types per argument (type union)
-const fn2 = typed({
-  'number | boolean': function (b) {
-    return 'b is a number or boolean'
-  },
-  'string, number | boolean': function (a, b) {
-    return 'a is a string, b is a number or boolean'
-  }
-})
-
-// create a typed function with an any type argument
-const log = typed({
-  'string, any': function (event, data) {
-    console.log('event: ' + event + ', data: ' + JSON.stringify(data))
-  }
-})
-```
-
-

package/docs/reference/functions/unaryMinus.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function unaryMinus
-
-Inverse the sign of a value, apply a unary minus operation.
-
-For matrices, the function is evaluated element wise. Boolean values and
-strings will be converted to a number. For complex numbers, both real and
-complex value are inverted.
-
-
-## Syntax
-
-```js
-math.unaryMinus(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Number to be inverted.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Returns the value with inverted sign.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.unaryMinus(3.5)      // returns -3.5
-math.unaryMinus(-4.2)     // returns 4.2
-```
-
-
-## See also
-
-[add](add.md),
-[subtract](subtract.md),
-[unaryPlus](unaryPlus.md)

package/docs/reference/functions/unaryPlus.md

@@ -1,48 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function unaryPlus
-
-Unary plus operation.
-Boolean values and strings will be converted to a number, numeric values will be returned as is.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.unaryPlus(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; string &#124; Complex &#124; Unit &#124; Array &#124; Matrix |  Input value
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix |  Returns the input value when numeric, converts to a number when input is non-numeric.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.unaryPlus(3.5)      // returns 3.5
-math.unaryPlus(1)     // returns 1
-```
-
-
-## See also
-
-[unaryMinus](unaryMinus.md),
-[add](add.md),
-[subtract](subtract.md)

package/docs/reference/functions/unequal.md

@@ -1,74 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function unequal
-
-Test whether two values are unequal.
-
-The function tests whether 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.
-In case of complex numbers, x.re must unequal y.re, or x.im must unequal y.im.
-Strings are compared by their numerical value.
-
-Values `null` and `undefined` are compared strictly, thus `null` is unequal
-with everything except `null`, and `undefined` is unequal with everything
-except `undefined`.
-
-
-## Syntax
-
-```js
-math.unequal(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Complex &#124; Unit &#124; string &#124; Array &#124; Matrix &#124; undefined | First value to compare
-`y` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Complex &#124; Unit &#124; string &#124; Array &#124; Matrix &#124; undefined | Second value to compare
-
-### Returns
-
-Type | Description
----- | -----------
-boolean &#124; Array &#124; Matrix | Returns true when the compared values are unequal, else returns false
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.unequal(2 + 2, 3)       // returns true
-math.unequal(2 + 2, 4)       // returns false
-
-const a = math.unit('50 cm')
-const b = math.unit('5 m')
-math.unequal(a, b)           // returns false
-
-const c = [2, 5, 1]
-const d = [2, 7, 1]
-
-math.unequal(c, d)           // returns [false, true, false]
-math.deepEqual(c, d)         // returns false
-
-math.unequal(0, null)        // returns true
-```
-
-
-## See also
-
-[equal](equal.md),
-[deepEqual](deepEqual.md),
-[smaller](smaller.md),
-[smallerEq](smallerEq.md),
-[larger](larger.md),
-[largerEq](largerEq.md),
-[compare](compare.md)

package/docs/reference/functions/unit.md

@@ -1,48 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function unit
-
-Create a unit. Depending on the passed arguments, the function
-will create and return a new math.Unit object.
-When a matrix is provided, all elements will be converted to units.
-
-
-## Syntax
-
-```js
-math.unit(unit : string)
-math.unit(value : number, unit : string)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | * &#124; Array &#124; Matrix | A number and unit.
-
-### Returns
-
-Type | Description
----- | -----------
-Unit &#124; Array &#124; Matrix | The created unit
-
-
-## Examples
-
-```js
-const a = math.unit(5, 'cm')    // returns Unit 50 mm
-const b = math.unit('23 kg')    // returns Unit 23 kg
-a.to('m')                       // returns Unit 0.05 m
-```
-
-
-## See also
-
-[bignumber](bignumber.md),
-[boolean](boolean.md),
-[complex](complex.md),
-[index](index.md),
-[matrix](matrix.md),
-[number](number.md),
-[string](string.md),
-[createUnit](createUnit.md)

package/docs/reference/functions/usolve.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function usolve
-
-Finds one solution of a linear equation system by backward substitution. Matrix must be an upper triangular matrix. Throws an error if there's no solution.
-
-`U * x = b`
-
-
-## Syntax
-
-```js
-math.usolve(U, b)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`U` | Matrix, Array | A N x N matrix or array (U)
-`b` | Matrix, Array | A column vector with the b values
-
-### Returns
-
-Type | Description
----- | -----------
-DenseMatrix &#124; Array | A column vector with the linear system solution (x)
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const a = [[-2, 3], [2, 1]]
-const b = [11, 9]
-const x = usolve(a, b)  // [[8], [9]]
-```
-
-
-## See also
-
-[usolveAll](usolveAll.md),
-[lup](lup.md),
-[slu](slu.md),
-[usolve](usolve.md),
-[lusolve](lusolve.md)

package/docs/reference/functions/usolveAll.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function usolveAll
-
-Finds all solutions of a linear equation system by backward substitution. Matrix must be an upper triangular matrix.
-
-`U * x = b`
-
-
-## Syntax
-
-```js
-math.usolveAll(U, b)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`U` | Matrix, Array | A N x N matrix or array (U)
-`b` | Matrix, Array | A column vector with the b values
-
-### Returns
-
-Type | Description
----- | -----------
-DenseMatrix[] &#124; Array[] | An array of affine-independent column vectors (x) that solve the linear system
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const a = [[-2, 3], [2, 1]]
-const b = [11, 9]
-const x = usolveAll(a, b)  // [ [[8], [9]] ]
-```
-
-
-## See also
-
-[usolve](usolve.md),
-[lup](lup.md),
-[slu](slu.md),
-[usolve](usolve.md),
-[lusolve](lusolve.md)

package/docs/reference/functions/variance.md

@@ -1,78 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function variance
-
-Compute the variance of a matrix or a  list with values.
-In case of a (multi dimensional) array or matrix, the variance over all
-elements will be calculated.
-
-Additionally, it is possible to compute the variance along the rows
-or columns of a matrix by specifying the dimension as the second argument.
-
-Optionally, the type of normalization can be specified as the final
-parameter. The parameter `normalization` can be one of the following values:
-
-- 'unbiased' (default) The sum of squared errors is divided by (n - 1)
-- 'uncorrected'        The sum of squared errors is divided by n
-- 'biased'             The sum of squared errors is divided by (n + 1)
-
-
-Note that older browser may not like the variable name `var`. In that
-case, the function can be called as `math['var'](...)` instead of
-`math.var(...)`.
-
-
-## Syntax
-
-```js
-math.variance(a, b, c, ...)
-math.variance(A)
-math.variance(A, normalization)
-math.variance(A, dimension)
-math.variance(A, dimension, normalization)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`array` | Array &#124; Matrix |  A single matrix or or multiple scalar values
-`normalization` | string |  Determines how to normalize the variance. Choose 'unbiased' (default), 'uncorrected', or 'biased'. Default value: 'unbiased'.
-
-### Returns
-
-Type | Description
----- | -----------
-* | The variance
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.variance(2, 4, 6)                     // returns 4
-math.variance([2, 4, 6, 8])                // returns 6.666666666666667
-math.variance([2, 4, 6, 8], 'uncorrected') // returns 5
-math.variance([2, 4, 6, 8], 'biased')      // returns 4
-
-math.variance([[1, 2, 3], [4, 5, 6]])      // returns 3.5
-math.variance([[1, 2, 3], [4, 6, 8]], 0)   // returns [4.5, 8, 12.5]
-math.variance([[1, 2, 3], [4, 6, 8]], 1)   // returns [1, 4]
-math.variance([[1, 2, 3], [4, 6, 8]], 1, 'biased') // returns [0.5, 2]
-```
-
-
-## See also
-
-[mean](mean.md),
-[median](median.md),
-[max](max.md),
-[min](min.md),
-[prod](prod.md),
-[std](std.md),
-[sum](sum.md)

package/docs/reference/functions/xgcd.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function xgcd
-
-Calculate the extended greatest common divisor for two values.
-See https://en.wikipedia.org/wiki/Extended_Euclidean_algorithm.
-
-
-## Syntax
-
-```js
-math.xgcd(a, b)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a` | number &#124; BigNumber | An integer number
-`b` | number &#124; BigNumber | An integer number
-
-### Returns
-
-Type | Description
----- | -----------
-Array | Returns an array containing 3 integers `[div, m, n]` where `div = gcd(a, b)` and `a*m + b*n = div`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.xgcd(8, 12)             // returns [4, -1, 1]
-math.gcd(8, 12)              // returns 4
-math.xgcd(36163, 21199)      // returns [1247, -7, 12]
-```
-
-
-## See also
-
-[gcd](gcd.md),
-[lcm](lcm.md)

package/docs/reference/functions/xor.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function xor
-
-Logical `xor`. Test whether one and only one value is defined with a nonzero/nonempty value.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.xor(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | First value to check
-`y` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Second value to check
-
-### Returns
-
-Type | Description
----- | -----------
-boolean &#124; Array &#124; Matrix |  Returns true when one and only one input is defined with a nonzero/nonempty value.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.xor(2, 4)   // returns false
-
-a = [2, 0, 0]
-b = [2, 7, 0]
-c = 0
-
-math.xor(a, b)   // returns [false, true, false]
-math.xor(a, c)   // returns [true, false, false]
-```
-
-
-## See also
-
-[and](and.md),
-[not](not.md),
-[or](or.md)