mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/rationalize.md

@@ -1,68 +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 an object `{expression, numerator, denominator, variables, coefficients}`, where `expression` is a `Node` with the node simplified expression, `numerator` is a `Node` with the simplified numerator of expression, `denominator` is a `Node` or `boolean` with the simplified denominator or `false` (if there is no denominator), `variables` is an array with variable names, and `coefficients` is an array with coefficients of numerator sorted by increased exponent {Expression Node}  node simplified expression
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## 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,53 +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
-
-
-### 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 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,60 +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`
-
-
-### Throws
-
-Type | Description
----- | -----------
-TypeError | If `sizes` does not contain solely integers
-DimensionError | If the product of the new dimension sizes does not equal that of the old ones
-
-## 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,51 +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`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## 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/resolve.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function resolve
-
-resolve(expr, scope) replaces variable nodes with their scoped values
-
-
-## Syntax
-
-```js
-resolve(expr, scope)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`node` | Node &#124; Node[] |  The expression tree (or trees) to be simplified
-`scope` | Object |  Scope specifying variables to be resolved
-
-### Returns
-
-Type | Description
----- | -----------
-Node &#124; Node[] | Returns `node` with variables recursively substituted.
-
-
-### Throws
-
-Type | Description
----- | -----------
-ReferenceError |  If there is a cyclic dependency among the variables in `scope`, resolution is impossible and a ReferenceError is thrown.
-
-## Examples
-
-```js
-math.resolve('x + y', {x:1, y:2})           // Node {1 + 2}
-math.resolve(math.parse('x+y'), {x:1, y:2}) // Node {1 + 2}
-math.simplify('x+y', {x:2, y:'x+x'}).toString()      // "6"
-```
-
-
-## See also
-
-[simplify](simplify.md),
-[evaluate](evaluate.md)

package/docs/reference/functions/rightArithShift.md

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

package/docs/reference/functions/rotationMatrix.md

@@ -1,57 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function rotationMatrix
-
-Create a 2-dimensional counter-clockwise rotation matrix (2x2) for a given angle (expressed in radians).
-Create a 2-dimensional counter-clockwise rotation matrix (3x3) by a given angle (expressed in radians) around a given axis (1x3).
-
-
-## Syntax
-
-```js
-math.rotationMatrix(theta)
-math.rotationMatrix(theta, format)
-math.rotationMatrix(theta, [v])
-math.rotationMatrix(theta, [v], format)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`theta` | number &#124; BigNumber &#124; Complex &#124; Unit | Rotation angle
-`v` | Array &#124; Matrix | Rotation axis
-`format` | string | Result Matrix storage format
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | Rotation matrix
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.rotationMatrix(math.pi / 2)                      // returns [[0, -1], [1, 0]]
-math.rotationMatrix(math.bignumber(1))                // returns [[bignumber(cos(1)), bignumber(-sin(1))], [bignumber(sin(1)), bignumber(cos(1))]]
-math.rotationMatrix(math.complex(1 + i))              // returns [[cos(1 + i), -sin(1 + i)], [sin(1 + i), cos(1 + i)]]
-math.rotationMatrix(math.unit('1rad'))                // returns [[cos(1), -sin(1)], [sin(1), cos(1)]]
-
-math.rotationMatrix(math.pi / 2, [0, 1, 0])           // returns [[0, 0, 1], [0, 1, 0], [-1, 0, 0]]
-math.rotationMatrix(math.pi / 2, matrix([0, 1, 0]))   // returns matrix([[0, 0, 1], [0, 1, 0], [-1, 0, 0]])
-
-```
-
-
-## See also
-
-[matrix](matrix.md),
-[cos](cos.md),
-[sin](sin.md)

package/docs/reference/functions/round.md

@@ -1,61 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function round
-
-Round a value towards the nearest integer.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.round(x)
-math.round(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.round(3.22)             // returns number 3
-math.round(3.82)             // returns number 4
-math.round(-4.2)             // returns number -4
-math.round(-4.7)             // returns number -5
-math.round(3.22, 1)          // returns number 3.2
-math.round(3.88, 1)          // returns number 3.9
-math.round(-4.21, 1)         // returns number -4.2
-math.round(-4.71, 1)         // returns number -4.7
-math.round(math.pi, 3)       // returns number 3.142
-math.round(123.45678, 2)     // returns number 123.46
-
-const c = math.complex(3.2, -2.7)
-math.round(c)                // returns Complex 3 - 3i
-
-math.round([3.2, 3.8, -4.7]) // returns Array [3, 4, -5]
-```
-
-
-## See also
-
-[ceil](ceil.md),
-[fix](fix.md),
-[floor](floor.md)

package/docs/reference/functions/row.md

@@ -1,45 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function row
-
-Return a row from a Matrix.
-
-
-## Syntax
-
-```js
-math.row(value, index)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`value` | Array &#124; Matrix | An array or matrix
-`row` | number | The index of the row
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | The retrieved row
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-// get a row
-const d = [[1, 2], [3, 4]]
-math.row(d, 1) // returns [[3, 4]]
-```
-
-
-## See also
-
-[column](column.md)

package/docs/reference/functions/sec.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function sec
-
-Calculate the secant of a value, defined as `sec(x) = 1/cos(x)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.sec(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Complex &#124; Array &#124; Matrix | Secant of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.sec(2)      // returns number -2.4029979617223822
-1 / math.cos(2)  // returns number -2.4029979617223822
-```
-
-
-## See also
-
-[cos](cos.md),
-[csc](csc.md),
-[cot](cot.md)

package/docs/reference/functions/sech.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function sech
-
-Calculate the hyperbolic secant of a value,
-defined as `sech(x) = 1 / cosh(x)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.sech(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Complex &#124; Array &#124; Matrix | Hyperbolic secant of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-// sech(x) = 1/ cosh(x)
-math.sech(0.5)       // returns 0.886818883970074
-1 / math.cosh(0.5)   // returns 0.886818883970074
-```
-
-
-## See also
-
-[cosh](cosh.md),
-[csch](csch.md),
-[coth](coth.md)