mathjs 10.0.0 → 10.6.4

package/docs/reference/functions/prod.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function prod
-
-Compute the product of a matrix or a list with values.
-In case of a (multi dimensional) array or matrix, the sum of all
-elements will be calculated.
-
-
-## Syntax
-
-```js
-math.prod(a, b, c, ...)
-math.prod(A)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | ... * | A single matrix or or multiple scalar values
-
-### Returns
-
-Type | Description
----- | -----------
-* | The product of all values
-
-
-## Examples
-
-```js
-math.multiply(2, 3)           // returns 6
-math.prod(2, 3)               // returns 6
-math.prod(2, 3, 4)            // returns 24
-math.prod([2, 3, 4])          // returns 24
-math.prod([[2, 5], [4, 3]])   // returns 120
-```
-
-
-## See also
-
-[mean](mean.md),
-[median](median.md),
-[min](min.md),
-[max](max.md),
-[sum](sum.md),
-[std](std.md),
-[variance](variance.md)

package/docs/reference/functions/qr.md

@@ -1,59 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function qr
-
-Calculate the Matrix QR decomposition. Matrix `A` is decomposed in
-two matrices (`Q`, `R`) where `Q` is an
-orthogonal matrix and `R` is an upper triangular matrix.
-
-
-## Syntax
-
-```js
-math.qr(A)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`A` | Matrix &#124; Array | A two dimensional matrix or array for which to get the QR decomposition.
-
-### Returns
-
-Type | Description
----- | -----------
-{Q: Array &#124; Matrix, R: Array &#124; Matrix} | Q: the orthogonal matrix and R: the upper triangular matrix
-
-
-## Examples
-
-```js
-const m = [
-  [1, -1,  4],
-  [1,  4, -2],
-  [1,  4,  2],
-  [1,  -1, 0]
-]
-const result = math.qr(m)
-// r = {
-//   Q: [
-//     [0.5, -0.5,   0.5],
-//     [0.5,  0.5,  -0.5],
-//     [0.5,  0.5,   0.5],
-//     [0.5, -0.5,  -0.5],
-//   ],
-//   R: [
-//     [2, 3,  2],
-//     [0, 5, -2],
-//     [0, 0,  4],
-//     [0, 0,  0]
-//   ]
-// }
-```
-
-
-## See also
-
-[lup](lup.md),
-[lusolve](lusolve.md)

package/docs/reference/functions/quantileSeq.md

@@ -1,56 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function quantileSeq
-
-Compute the prob order quantile of a matrix or a list with values.
-The sequence is sorted and the middle value is returned.
-Supported types of sequence values are: Number, BigNumber, Unit
-Supported types of probability are: Number, BigNumber
-
-In case of a (multi dimensional) array or matrix, the prob order quantile
-of all elements will be calculated.
-
-
-## Syntax
-
-```js
-math.quantileSeq(A, prob[, sorted])
-math.quantileSeq(A, [prob1, prob2, ...][, sorted])
-math.quantileSeq(A, N[, sorted])
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`data` | Array, Matrix | A single matrix or Array
-`probOrN` | Number, BigNumber, Array | prob is the order of the quantile, while N is the amount of evenly distributed steps of probabilities; only one of these options can be provided
-`sorted` | Boolean | =false              is data sorted in ascending order
-
-### Returns
-
-Type | Description
----- | -----------
-Number, BigNumber, Unit, Array | Quantile(s)
-
-
-## Examples
-
-```js
-math.quantileSeq([3, -1, 5, 7], 0.5)         // returns 4
-math.quantileSeq([3, -1, 5, 7], [1/3, 2/3])  // returns [3, 5]
-math.quantileSeq([3, -1, 5, 7], 2)           // returns [3, 5]
-math.quantileSeq([-1, 3, 5, 7], 0.5, true)   // returns 4
-```
-
-
-## See also
-
-[median](median.md),
-[mean](mean.md),
-[min](min.md),
-[max](max.md),
-[sum](sum.md),
-[prod](prod.md),
-[std](std.md),
-[variance](variance.md)

package/docs/reference/functions/random.md

@@ -1,48 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function random
-
-Return a random number larger or equal to `min` and smaller than `max`
-using a uniform distribution.
-
-
-## Syntax
-
-```js
-math.random()                // generate a random number between 0 and 1
-math.random(max)             // generate a random number between 0 and max
-math.random(min, max)        // generate a random number between min and max
-math.random(size)            // generate a matrix with random numbers between 0 and 1
-math.random(size, max)       // generate a matrix with random numbers between 0 and max
-math.random(size, min, max)  // generate a matrix with random numbers between min and max
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`size` | Array &#124; Matrix | If provided, an array or matrix with given size and filled with random values is returned
-`min` | number | Minimum boundary for the random value, included
-`max` | number | Maximum boundary for the random value, excluded
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array &#124; Matrix | A random number
-
-
-## Examples
-
-```js
-math.random()       // returns a random number between 0 and 1
-math.random(100)    // returns a random number between 0 and 100
-math.random(30, 40) // returns a random number between 30 and 40
-math.random([2, 3]) // returns a 2x3 matrix with random numbers between 0 and 1
-```
-
-
-## See also
-
-[randomInt](randomInt.md),
-[pickRandom](pickRandom.md)

package/docs/reference/functions/randomInt.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function randomInt
-
-Return a random integer number larger or equal to `min` and smaller than `max`
-using a uniform distribution.
-
-
-## Syntax
-
-```js
-math.randomInt()                // generate a random integer between 0 and 1
-math.randomInt(max)             // generate a random integer between 0 and max
-math.randomInt(min, max)        // generate a random integer between min and max
-math.randomInt(size)            // generate a matrix with random integer between 0 and 1
-math.randomInt(size, max)       // generate a matrix with random integer between 0 and max
-math.randomInt(size, min, max)  // generate a matrix with random integer between min and max
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`size` | Array &#124; Matrix | If provided, an array or matrix with given size and filled with random values is returned
-`min` | number | Minimum boundary for the random value, included
-`max` | number | Maximum boundary for the random value, excluded
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array &#124; Matrix | A random integer value
-
-
-## Examples
-
-```js
-math.randomInt(100)    // returns a random integer between 0 and 100
-math.randomInt(30, 40) // returns a random integer between 30 and 40
-math.randomInt([2, 3]) // returns a 2x3 matrix with random integers between 0 and 1
-```
-
-
-## See also
-
-[random](random.md),
-[pickRandom](pickRandom.md)

package/docs/reference/functions/range.md

@@ -1,64 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function range
-
-Create an array from a range.
-By default, the range end is excluded. This can be customized by providing
-an extra parameter `includeEnd`.
-
-
-## Syntax
-
-```js
-math.range(str [, includeEnd])               // Create a range from a string,
-                                             // where the string contains the
-                                             // start, optional step, and end,
-                                             // separated by a colon.
-math.range(start, end [, includeEnd])        // Create a range with start and
-                                             // end and a step size of 1.
-math.range(start, end, step [, includeEnd])  // Create a range with start, step,
-                                             // and end.
-```
-
-### Where
-
-- `str: string`
-  A string 'start:end' or 'start:step:end'
-- `start: {number | BigNumber}`
-  Start of the range
-- `end: number | BigNumber`
-  End of the range, excluded by default, included when parameter includeEnd=true
-- `step: number | BigNumber`
-  Step size. Default value is 1.
-- `includeEnd: boolean`
-  Option to specify whether to include the end or not. False by default.
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | * | Parameters describing the ranges `start`, `end`, and optional `step`.
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | range
-
-
-## Examples
-
-```js
-math.range(2, 6)        // [2, 3, 4, 5]
-math.range(2, -3, -1)   // [2, 1, 0, -1, -2]
-math.range('2:1:6')     // [2, 3, 4, 5]
-math.range(2, 6, true)  // [2, 3, 4, 5, 6]
-```
-
-
-## See also
-
-[ones](ones.md),
-[zeros](zeros.md),
-[size](size.md),
-[subset](subset.md)

package/docs/reference/functions/rationalize.md

@@ -1,62 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function rationalize
-
-Transform a rationalizable expression in a rational fraction.
-If rational fraction is one variable polynomial then converts
-the numerator and denominator in canonical form, with decreasing
-exponents, returning the coefficients of numerator.
-
-
-## Syntax
-
-```js
-rationalize(expr)
-rationalize(expr, detailed)
-rationalize(expr, scope)
-rationalize(expr, scope, detailed)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`expr` | Node &#124; string | The expression to check if is a polynomial expression
-`optional` | Object &#124; boolean | scope of expression or true for already evaluated rational expression at input
-`detailed` | Boolean | optional True if return an object, false if return expression node (default)
-
-### Returns
-
-Type | Description
----- | -----------
-Object &#124; Node | The rational polynomial of `expr` or na object {Object} {Expression Node} expression: node simplified expression {Expression Node} numerator: simplified numerator of expression {Expression Node | boolean} denominator: simplified denominator or false (if there is no denominator) {Array}           variables:  variable names {Array}           coefficients: coefficients of numerator sorted by increased exponent {Expression Node}  node simplified expression
-
-
-## Examples
-
-```js
-math.rationalize('sin(x)+y')
-              //  Error: There is an unsolved function call
-math.rationalize('2x/y - y/(x+1)')
-              // (2*x^2-y^2+2*x)/(x*y+y)
-math.rationalize('(2x+1)^6')
-              // 64*x^6+192*x^5+240*x^4+160*x^3+60*x^2+12*x+1
-math.rationalize('2x/( (2x-1) / (3x+2) ) - 5x/ ( (3x+4) / (2x^2-5) ) + 3')
-              // -20*x^4+28*x^3+104*x^2+6*x-12)/(6*x^2+5*x-4)
-math.rationalize('x/(1-x)/(x-2)/(x-3)/(x-4) + 2x/ ( (1-2x)/(2-3x) )/ ((3-4x)/(4-5x) )') =
-              // (-30*x^7+344*x^6-1506*x^5+3200*x^4-3472*x^3+1846*x^2-381*x)/
-              //     (-8*x^6+90*x^5-383*x^4+780*x^3-797*x^2+390*x-72)
-
-math.rationalize('x+x+x+y',{y:1}) // 3*x+1
-math.rationalize('x+x+x+y',{})    // 3*x+y
-
-const ret = math.rationalize('x+x+x+y',{},true)
-              // ret.expression=3*x+y, ret.variables = ["x","y"]
-const ret = math.rationalize('-2+5x^2',{},true)
-              // ret.expression=5*x^2-2, ret.variables = ["x"], ret.coefficients=[-2,0,5]
-```
-
-
-## See also
-
-[simplify](simplify.md)

package/docs/reference/functions/re.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function re
-
-Get the real part of a complex number.
-For a complex number `a + bi`, the function returns `a`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.re(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 real 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 0
-math.re(math.complex(2.4))     // returns number 2.4
-```
-
-
-## See also
-
-[im](im.md),
-[conj](conj.md),
-[abs](abs.md),
-[arg](arg.md)

package/docs/reference/functions/reshape.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function reshape
-
-Reshape a multi dimensional array to fit the specified dimensions
-
-
-## Syntax
-
-```js
-math.reshape(x, sizes)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Array &#124; Matrix &#124; * | Matrix to be reshaped
-`sizes` | number[] | One dimensional array with integral sizes for each dimension. One -1 is allowed as wildcard, which calculates this dimension automatically.
-
-### Returns
-
-Type | Description
----- | -----------
-* &#124; Array &#124; Matrix | A reshaped clone of matrix `x`
-
-
-## Examples
-
-```js
- math.reshape([1, 2, 3, 4, 5, 6], [2, 3])
- // returns Array  [[1, 2, 3], [4, 5, 6]]
-
- math.reshape([[1, 2], [3, 4]], [1, 4])
- // returns Array  [[1, 2, 3, 4]]
-
- math.reshape([[1, 2], [3, 4]], [4])
- // returns Array [1, 2, 3, 4]
-
- const x = math.matrix([1, 2, 3, 4, 5, 6, 7, 8])
- math.reshape(x, [2, 2, 2])
- // returns Matrix [[[1, 2], [3, 4]], [[5, 6], [7, 8]]]
-
-math.reshape([1, 2, 3, 4], [-1, 2])
-// returns Matrix [[1, 2], [3, 4]]
-```
-
-
-## See also
-
-[size](size.md),
-[squeeze](squeeze.md),
-[resize](resize.md)

package/docs/reference/functions/resize.md

@@ -1,45 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function resize
-
-Resize a matrix
-
-
-## Syntax
-
-```js
-math.resize(x, size)
-math.resize(x, size, defaultValue)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Array &#124; Matrix &#124; * | Matrix to be resized
-`size` | Array &#124; Matrix | One dimensional array with numbers
-`defaultValue` | number &#124; string | Zero by default, except in case of a string, in that case defaultValue = ' ' Default value: 0.
-
-### Returns
-
-Type | Description
----- | -----------
-* &#124; Array &#124; Matrix | A resized clone of matrix `x`
-
-
-## Examples
-
-```js
-math.resize([1, 2, 3, 4, 5], [3]) // returns Array  [1, 2, 3]
-math.resize([1, 2, 3], [5], 0)    // returns Array  [1, 2, 3, 0, 0]
-math.resize(2, [2, 3], 0)         // returns Matrix [[2, 0, 0], [0, 0, 0]]
-math.resize("hello", [8], "!")    // returns string 'hello!!!'
-```
-
-
-## See also
-
-[size](size.md),
-[squeeze](squeeze.md),
-[subset](subset.md),
-[reshape](reshape.md)

package/docs/reference/functions/rightArithShift.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function rightArithShift
-
-Bitwise right arithmetic shift of a value x by y number of bits, `x >> y`.
-For matrices, the function is evaluated element wise.
-For units, the function is evaluated on the best prefix base.
-
-
-## Syntax
-
-```js
-math.rightArithShift(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Array &#124; Matrix | Value to be shifted
-`y` | number &#124; BigNumber | Amount of shifts
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Array &#124; Matrix | `x` sign-filled shifted right `y` times
-
-
-## Examples
-
-```js
-math.rightArithShift(4, 2)               // returns number 1
-
-math.rightArithShift([16, -32, 64], 4)   // returns Array [1, -2, 3]
-```
-
-
-## See also
-
-[bitAnd](bitAnd.md),
-[bitNot](bitNot.md),
-[bitOr](bitOr.md),
-[bitXor](bitXor.md),
-[rightArithShift](rightArithShift.md),
-[rightLogShift](rightLogShift.md)

package/docs/reference/functions/rightLogShift.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function rightLogShift
-
-Bitwise right logical shift of value x by y number of bits, `x >>> y`.
-For matrices, the function is evaluated element wise.
-For units, the function is evaluated on the best prefix base.
-
-
-## Syntax
-
-```js
-math.rightLogShift(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; Array &#124; Matrix | Value to be shifted
-`y` | number | Amount of shifts
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array &#124; Matrix | `x` zero-filled shifted right `y` times
-
-
-## Examples
-
-```js
-math.rightLogShift(4, 2)               // returns number 1
-
-math.rightLogShift([16, -32, 64], 4)   // returns Array [1, 2, 3]
-```
-
-
-## See also
-
-[bitAnd](bitAnd.md),
-[bitNot](bitNot.md),
-[bitOr](bitOr.md),
-[bitXor](bitXor.md),
-[leftShift](leftShift.md),
-[rightLogShift](rightLogShift.md)

package/docs/reference/functions/rotate.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function rotate
-
-Rotate a vector of size 1x2 counter-clockwise by a given angle
-Rotate a vector of size 1x3 counter-clockwise by a given angle around the given axis
-
-
-## Syntax
-
-```js
-math.rotate(w, theta)
-math.rotate(w, theta, v)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`w` | Array &#124; Matrix | Vector to rotate
-`theta` | number &#124; BigNumber &#124; Complex &#124; Unit | Rotation angle
-`v` | Array &#124; Matrix | Rotation axis
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | Multiplication of the rotation matrix and w
-
-
-## Examples
-
-```js
-math.rotate([11, 12], math.pi / 2)                           // returns matrix([-12, 11])
-math.rotate(matrix([11, 12]), math.pi / 2)                   // returns matrix([-12, 11])
-
-math.rotate([1, 0, 0], unit('90deg'), [0, 0, 1])             // returns matrix([0, 1, 0])
-math.rotate(matrix([1, 0, 0]), unit('90deg'), [0, 0, 1])     // returns matrix([0, 1, 0])
-
-math.rotate([1, 0], math.complex(1 + i))                     // returns matrix([cos(1 + i) - sin(1 + i), sin(1 + i) + cos(1 + i)])
-```
-
-
-## See also
-
-[matrix](matrix.md),
-[rotationMatrix](rotationMatrix.md)