mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/diff.md

@@ -1,70 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function diff
-
-Create a new matrix or array of the difference between elements of the given array
-The optional dim parameter lets you specify the dimension to evaluate the difference of
-If no dimension parameter is passed it is assumed as dimension 0
-
-Dimension is zero-based in javascript and one-based in the parser and can be a number or bignumber
-Arrays must be 'rectangular' meaning arrays like [1, 2]
-If something is passed as a matrix it will be returned as a matrix but other than that all matrices are converted to arrays
-
-
-## Syntax
-
-```js
-math.diff(arr)
-math.diff(arr, dim)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`arr` | Array &#124; Matrix | An array or matrix
-`dim` | number | Dimension
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | Difference between array elements in given dimension
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const arr = [1, 2, 4, 7, 0]
-math.diff(arr) // returns [1, 2, 3, -7] (no dimension passed so 0 is assumed)
-math.diff(math.matrix(arr)) // returns math.matrix([1, 2, 3, -7])
-
-const arr = [[1, 2, 3, 4, 5], [1, 2, 3, 4, 5], [9, 8, 7, 6, 4]]
-math.diff(arr) // returns [[0, 0, 0, 0, 0], [8, 6, 4, 2, -1]]
-math.diff(arr, 0) // returns [[0, 0, 0, 0, 0], [8, 6, 4, 2, -1]]
-math.diff(arr, 1) // returns [[1, 1, 1, 1], [1, 1, 1, 1], [-1, -1, -1, -2]]
-math.diff(arr, math.bignumber(1)) // returns [[1, 1, 1, 1], [1, 1, 1, 1], [-1, -1, -1, -2]]
-
-math.diff(arr, 2) // throws RangeError as arr is 2 dimensional not 3
-math.diff(arr, -1) // throws RangeError as negative dimensions are not allowed
-
-// These will all produce the same result
-math.diff([[1, 2], [3, 4]])
-math.diff([math.matrix([1, 2]), math.matrix([3, 4])])
-math.diff([[1, 2], math.matrix([3, 4])])
-math.diff([math.matrix([1, 2]), [3, 4]])
-// They do not produce the same result as  math.diff(math.matrix([[1, 2], [3, 4]])) as this returns a matrix
-```
-
-
-## See also
-
-[sum](sum.md),
-[subtract](subtract.md),
-[partitionSelect](partitionSelect.md)

package/docs/reference/functions/distance.md

@@ -1,80 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function distance
-
-Calculates:
-   The eucledian distance between two points in N-dimensional spaces.
-   Distance between point and a line in 2 and 3 dimensional spaces.
-   Pairwise distance between a set of 2D or 3D points
-NOTE:
-   When substituting coefficients of a line(a, b and c), use ax + by + c = 0 instead of ax + by = c
-   For parametric equation of a 3D line, x0, y0, z0, a, b, c are from: (x−x0, y−y0, z−z0) = t(a, b, c)
-
-
-## Syntax
-
-```js
-math.distance([x1, y1], [x2, y2])
- math.distance({pointOneX: 4, pointOneY: 5}, {pointTwoX: 2, pointTwoY: 7})
-math.distance([x1, y1, z1], [x2, y2, z2])
-math.distance({pointOneX: 4, pointOneY: 5, pointOneZ: 8}, {pointTwoX: 2, pointTwoY: 7, pointTwoZ: 9})
-math.distance([x1, y1, ... , N1], [x2, y2, ... , N2])
-math.distance([[A], [B], [C]...])
-math.distance([x1, y1], [LinePtX1, LinePtY1], [LinePtX2, LinePtY2])
-math.distance({pointX: 1, pointY: 4}, {lineOnePtX: 6, lineOnePtY: 3}, {lineTwoPtX: 2, lineTwoPtY: 8})
-math.distance([x1, y1, z1], [LinePtX1, LinePtY1, LinePtZ1], [LinePtX2, LinePtY2, LinePtZ2])
-math.distance({pointX: 1, pointY: 4, pointZ: 7}, {lineOnePtX: 6, lineOnePtY: 3, lineOnePtZ: 4}, {lineTwoPtX: 2, lineTwoPtY: 8, lineTwoPtZ: 5})
-math.distance([x1, y1], [xCoeffLine, yCoeffLine, constant])
-math.distance({pointX: 10, pointY: 10}, {xCoeffLine: 8, yCoeffLine: 1, constant: 3})
-math.distance([x1, y1, z1], [x0, y0, z0, a-tCoeff, b-tCoeff, c-tCoeff]) point and parametric equation of 3D line
-math.distance([x, y, z], [x0, y0, z0, a, b, c])
-math.distance({pointX: 2, pointY: 5, pointZ: 9}, {x0: 4, y0: 6, z0: 3, a: 4, b: 2, c: 0})
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Array &#124; Matrix &#124; Object | Co-ordinates of first point
-`y` | Array &#124; Matrix &#124; Object | Co-ordinates of second point
-
-### Returns
-
-Type | Description
----- | -----------
-Number &#124; BigNumber | Returns the distance from two/three points
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.distance([0,0], [4,4])                     // Returns 5.6569
-math.distance(
- {pointOneX: 0, pointOneY: 0},
- {pointTwoX: 10, pointTwoY: 10})                // Returns 14.142135623730951
-math.distance([1, 0, 1], [4, -2, 2])            // Returns 3.74166
-math.distance(
- {pointOneX: 4, pointOneY: 5, pointOneZ: 8},
- {pointTwoX: 2, pointTwoY: 7, pointTwoZ: 9})    // Returns 3
-math.distance([1, 0, 1, 0], [0, -1, 0, -1])     // Returns 2
-math.distance([[1, 2], [1, 2], [1, 3]])         // Returns [0, 1, 1]
-math.distance([[1,2,4], [1,2,6], [8,1,3]])      // Returns [2, 7.14142842854285, 7.681145747868608]
-math.distance([10, 10], [8, 1, 3])              // Returns 11.535230316796387
-math.distance([10, 10], [2, 3], [-8, 0])        // Returns 8.759953130362847
-math.distance(
- {pointX: 1, pointY: 4},
- {lineOnePtX: 6, lineOnePtY: 3},
- {lineTwoPtX: 2, lineTwoPtY: 8})                // Returns 2.720549372624744
-math.distance([2, 3, 1], [1, 1, 2, 5, 0, 1])    // Returns 2.3204774044612857
-math.distance(
- {pointX: 2, pointY: 3, pointZ: 1},
- {x0: 1, y0: 1, z0: 2, a: 5, b: 0, c: 1}        // Returns 2.3204774044612857
-```
-
-

package/docs/reference/functions/divide.md

@@ -1,55 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function divide
-
-Divide two values, `x / y`.
-To divide matrices, `x` is multiplied with the inverse of `y`: `x * inv(y)`.
-
-
-## Syntax
-
-```js
-math.divide(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Numerator
-`y` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix | Denominator
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Quotient, `x / y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.divide(2, 3)            // returns number 0.6666666666666666
-
-const a = math.complex(5, 14)
-const b = math.complex(4, 1)
-math.divide(a, b)            // returns Complex 2 + 3i
-
-const c = [[7, -6], [13, -4]]
-const d = [[1, 2], [4, 3]]
-math.divide(c, d)            // returns Array [[-9, 4], [-11, 6]]
-
-const e = math.unit('18 km')
-math.divide(e, 4.5)          // returns Unit 4 km
-```
-
-
-## See also
-
-[multiply](multiply.md)

package/docs/reference/functions/dot.md

@@ -1,48 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function dot
-
-Calculate the dot product of two vectors. The dot product of
-`A = [a1, a2, ..., an]` and `B = [b1, b2, ..., bn]` is defined as:
-
-   dot(A, B) = conj(a1) * b1 + conj(a2) * b2 + ... + conj(an) * bn
-
-
-## Syntax
-
-```js
-math.dot(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Array &#124; Matrix | First vector
-`y` | Array &#124; Matrix | Second vector
-
-### Returns
-
-Type | Description
----- | -----------
-number | Returns the dot product of `x` and `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.dot([2, 4, 1], [2, 2, 3])       // returns number 15
-math.multiply([2, 4, 1], [2, 2, 3])  // returns number 15
-```
-
-
-## See also
-
-[multiply](multiply.md),
-[cross](cross.md)

package/docs/reference/functions/dotDivide.md

@@ -1,52 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function dotDivide
-
-Divide two matrices element wise. The function accepts both matrices and
-scalar values.
-
-
-## Syntax
-
-```js
-math.dotDivide(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Numerator
-`y` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Denominator
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Quotient, `x ./ y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.dotDivide(2, 4)   // returns 0.5
-
-a = [[9, 5], [6, 1]]
-b = [[3, 2], [5, 2]]
-
-math.dotDivide(a, b)   // returns [[3, 2.5], [1.2, 0.5]]
-math.divide(a, b)      // returns [[1.75, 0.75], [-1.75, 2.25]]
-```
-
-
-## See also
-
-[divide](divide.md),
-[multiply](multiply.md),
-[dotMultiply](dotMultiply.md)

package/docs/reference/functions/dotMultiply.md

@@ -1,52 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function dotMultiply
-
-Multiply two matrices element wise. The function accepts both matrices and
-scalar values.
-
-
-## Syntax
-
-```js
-math.dotMultiply(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Left hand value
-`y` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Right hand value
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Multiplication of `x` and `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.dotMultiply(2, 4) // returns 8
-
-a = [[9, 5], [6, 1]]
-b = [[3, 2], [5, 2]]
-
-math.dotMultiply(a, b) // returns [[27, 10], [30, 2]]
-math.multiply(a, b)    // returns [[52, 28], [23, 14]]
-```
-
-
-## See also
-
-[multiply](multiply.md),
-[divide](divide.md),
-[dotDivide](dotDivide.md)

package/docs/reference/functions/dotPow.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function dotPow
-
-Calculates the power of x to y element wise.
-
-
-## Syntax
-
-```js
-math.dotPow(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | The base
-`y` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | The exponent
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | The value of `x` to the power `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.dotPow(2, 3)            // returns number 8
-
-const a = [[1, 2], [4, 3]]
-math.dotPow(a, 2)            // returns Array [[1, 4], [16, 9]]
-math.pow(a, 2)               // returns Array [[9, 8], [16, 17]]
-```
-
-
-## See also
-
-[pow](pow.md),
-[sqrt](sqrt.md),
-[multiply](multiply.md)

package/docs/reference/functions/eigs.md

@@ -1,54 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function eigs
-
-Compute eigenvalues and eigenvectors of a matrix. The eigenvalues are sorted by their absolute value, ascending.
-An eigenvalue with multiplicity k will be listed k times. The eigenvectors are returned as columns of a matrix –
-the eigenvector that belongs to the j-th eigenvalue in the list (eg. `values[j]`) is the j-th column (eg. `column(vectors, j)`).
-If the algorithm fails to converge, it will throw an error – in that case, however, you may still find useful information
-in `err.values` and `err.vectors`.
-
-
-## Syntax
-
-```js
-math.eigs(x, [prec])
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Array &#124; Matrix | Matrix to be diagonalized
-`prec` | number &#124; BigNumber | Precision, default value: 1e-15
-
-### Returns
-
-Type | Description
----- | -----------
-{values: Array &#124; Matrix, vectors: Array &#124; Matrix} | Object containing an array of eigenvalues and a matrix with eigenvectors as columns.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const { eigs, multiply, column, transpose } = math
-const H = [[5, 2.3], [2.3, 1]]
-const ans = eigs(H) // returns {values: [E1,E2...sorted], vectors: [v1,v2.... corresponding vectors as columns]}
-const E = ans.values
-const U = ans.vectors
-multiply(H, column(U, 0)) // returns multiply(E[0], column(U, 0))
-const UTxHxU = multiply(transpose(U), H, U) // diagonalizes H
-E[0] == UTxHxU[0][0]  // returns true
-```
-
-
-## See also
-
-[inv](inv.md)

package/docs/reference/functions/equal.md

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

package/docs/reference/functions/equalText.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function equalText
-
-Check equality of two strings. Comparison is case sensitive.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.equalText(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | string &#124; Array &#124; DenseMatrix | First string to compare
-`y` | string &#124; Array &#124; DenseMatrix | Second string to compare
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array &#124; DenseMatrix | Returns true if the values are equal, and false if not.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.equalText('Hello', 'Hello')     // returns true
-math.equalText('a', 'A')             // returns false
-math.equal('2e3', '2000')            // returns true
-math.equalText('2e3', '2000')        // returns false
-
-math.equalText('B', ['A', 'B', 'C']) // returns [false, true, false]
-```
-
-
-## See also
-
-[equal](equal.md),
-[compareText](compareText.md),
-[compare](compare.md),
-[compareNatural](compareNatural.md)

package/docs/reference/functions/erf.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function erf
-
-Compute the erf function of a value using a rational Chebyshev
-approximations for different intervals of x.
-
-This is a translation of W. J. Cody's Fortran implementation from 1987
-( https://www.netlib.org/specfun/erf ). See the AMS publication
-"Rational Chebyshev Approximations for the Error Function" by W. J. Cody
-for an explanation of this process.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.erf(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; Array &#124; Matrix | A real number
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array &#124; Matrix | The erf of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.erf(0.2)    // returns 0.22270258921047847
-math.erf(-0.5)   // returns -0.5204998778130465
-math.erf(4)      // returns 0.9999999845827421
-```
-
-

package/docs/reference/functions/evaluate.md

@@ -1,56 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function evaluate
-
-Evaluate an expression.
-
-Note the evaluating arbitrary expressions may involve security risks,
-see [https://mathjs.org/docs/expressions/security.html](https://mathjs.org/docs/expressions/security.html) for more information.
-
-
-## Syntax
-
-```js
-math.evaluate(expr)
-math.evaluate(expr, scope)
-math.evaluate([expr1, expr2, expr3, ...])
-math.evaluate([expr1, expr2, expr3, ...], scope)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`expr` | string &#124; string[] &#124; Matrix | The expression to be evaluated
-`scope` | Object | Scope to read/write variables
-
-### Returns
-
-Type | Description
----- | -----------
-* | The result of the expression
-
-
-### Throws
-
-Type | Description
----- | -----------
-Error | 
-
-## Examples
-
-```js
-math.evaluate('(2+3)/4')                // 1.25
-math.evaluate('sqrt(3^2 + 4^2)')        // 5
-math.evaluate('sqrt(-4)')               // 2i
-math.evaluate(['a=3', 'b=4', 'a*b'])    // [3, 4, 12]
-
-let scope = {a:3, b:4}
-math.evaluate('a * b', scope)           // 12
-```
-
-
-## See also
-
-[parse](parse.md),
-[compile](compile.md)