mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/simplifyCore.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function simplifyCore
-
-simplifyCore() performs single pass simplification suitable for
-applications requiring ultimate performance. In contrast, simplify()
-extends simplifyCore() with additional passes to provide deeper
-simplification.
-
-
-## Syntax
-
-```js
-simplifyCore(expr)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`node` | Node |  The expression to be simplified
-`options` | Object |  Simplification options, as per simplify()
-
-### Returns
-
-Type | Description
----- | -----------
-Node | Returns expression with basic simplifications applied
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const f = math.parse('2 * 1 * x ^ (2 - 1)')
-math.simpifyCore(f)                          // Node {2 * x}
-math.simplify('2 * 1 * x ^ (2 - 1)', [math.simplifyCore]) // Node {2 * x}
-```
-
-
-## See also
-
-[simplify](simplify.md),
-[resolve](resolve.md),
-[derivative](derivative.md)

package/docs/reference/functions/sin.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function sin
-
-Calculate the sine of a value.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.sin(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | Sine of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.sin(2)                      // returns number 0.9092974268256813
-math.sin(math.pi / 4)            // returns number 0.7071067811865475
-math.sin(math.unit(90, 'deg'))   // returns number 1
-math.sin(math.unit(30, 'deg'))   // returns number 0.5
-
-const angle = 0.2
-math.pow(math.sin(angle), 2) + math.pow(math.cos(angle), 2) // returns number ~1
-```
-
-
-## See also
-
-[cos](cos.md),
-[tan](tan.md)

package/docs/reference/functions/sinh.md

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

package/docs/reference/functions/size.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function size
-
-Calculate the size of a matrix or scalar.
-
-
-## Syntax
-
-```js
-math.size(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | boolean &#124; number &#124; Complex &#124; Unit &#124; string &#124; Array &#124; Matrix | A matrix
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | A vector with size of `x`.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.size(2.3)                  // returns []
-math.size('hello world')        // returns [11]
-
-const A = [[1, 2, 3], [4, 5, 6]]
-math.size(A)                    // returns [2, 3]
-math.size(math.range(1,6))      // returns [5]
-```
-
-
-## See also
-
-[count](count.md),
-[resize](resize.md),
-[squeeze](squeeze.md),
-[subset](subset.md)

package/docs/reference/functions/slu.md

@@ -1,57 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function slu
-
-Calculate the Sparse Matrix LU decomposition with full pivoting. Sparse Matrix `A` is decomposed in two matrices (`L`, `U`) and two permutation vectors (`pinv`, `q`) where
-
-`P * A * Q = L * U`
-
-
-## Syntax
-
-```js
-math.slu(A, order, threshold)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`A` | SparseMatrix | A two dimensional sparse matrix for which to get the LU decomposition.
-`order` | Number | The Symbolic Ordering and Analysis order: 0 - Natural ordering, no permutation vector q is returned 1 - Matrix must be square, symbolic ordering and analisis is performed on M = A + A' 2 - Symbolic ordering and analisis is performed on M = A' * A. Dense columns from A' are dropped, A recreated from A'. This is appropriatefor LU factorization of unsymmetric matrices. 3 - Symbolic ordering and analisis is performed on M = A' * A. This is best used for LU factorization is matrix M has no dense rows. A dense row is a row with more than 10*sqr(columns) entries.
-`threshold` | Number | Partial pivoting threshold (1 for partial pivoting)
-
-### Returns
-
-Type | Description
----- | -----------
-Object | The lower triangular matrix, the upper triangular matrix and the permutation vectors.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const A = math.sparse([[4,3], [6, 3]])
-math.slu(A, 1, 0.001)
-// returns:
-// {
-//   L: [[1, 0], [1.5, 1]]
-//   U: [[4, 3], [0, -1.5]]
-//   p: [0, 1]
-//   q: [0, 1]
-// }
-```
-
-
-## See also
-
-[lup](lup.md),
-[lsolve](lsolve.md),
-[usolve](usolve.md),
-[lusolve](lusolve.md)

package/docs/reference/functions/smaller.md

@@ -1,60 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function smaller
-
-Test whether value x is smaller than y.
-
-The function returns true when x is smaller than y and 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.
-Strings are compared by their numerical value.
-
-
-## Syntax
-
-```js
-math.smaller(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Unit &#124; string &#124; Array &#124; Matrix | First value to compare
-`y` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Unit &#124; string &#124; Array &#124; Matrix | Second value to compare
-
-### Returns
-
-Type | Description
----- | -----------
-boolean &#124; Array &#124; Matrix | Returns true when the x is smaller than y, else returns false
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.smaller(2, 3)            // returns true
-math.smaller(5, 2 * 2)        // returns false
-
-const a = math.unit('5 cm')
-const b = math.unit('2 inch')
-math.smaller(a, b)            // returns true
-```
-
-
-## See also
-
-[equal](equal.md),
-[unequal](unequal.md),
-[smallerEq](smallerEq.md),
-[smaller](smaller.md),
-[smallerEq](smallerEq.md),
-[compare](compare.md)

package/docs/reference/functions/smallerEq.md

@@ -1,56 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function smallerEq
-
-Test whether value x is smaller or equal to y.
-
-The function returns true when x is smaller than y or 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.
-Strings are compared by their numerical value.
-
-
-## Syntax
-
-```js
-math.smallerEq(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Unit &#124; string &#124; Array &#124; Matrix | First value to compare
-`y` | number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Unit &#124; string &#124; Array &#124; Matrix | Second value to compare
-
-### Returns
-
-Type | Description
----- | -----------
-boolean &#124; Array &#124; Matrix | Returns true when the x is smaller than y, else returns false
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.smaller(1 + 2, 3)        // returns false
-math.smallerEq(1 + 2, 3)      // returns true
-```
-
-
-## See also
-
-[equal](equal.md),
-[unequal](unequal.md),
-[smaller](smaller.md),
-[larger](larger.md),
-[largerEq](largerEq.md),
-[compare](compare.md)

package/docs/reference/functions/sort.md

@@ -1,56 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function sort
-
-Sort the items in a matrix.
-
-
-## Syntax
-
-```js
-math.sort(x)
-math.sort(x, compare)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Matrix &#124; Array | A one dimensional matrix or array to sort
-`compare` | Function &#124; 'asc' &#124; 'desc' &#124; 'natural' |  An optional _comparator function or name. The function is called as `compare(a, b)`, and must return 1 when a > b, -1 when a < b, and 0 when a == b. Default value: 'asc'.
-
-### Returns
-
-Type | Description
----- | -----------
-Matrix &#124; Array | Returns the sorted matrix.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.sort([5, 10, 1]) // returns [1, 5, 10]
-math.sort(['C', 'B', 'A', 'D'], math.compareNatural)
-// returns ['A', 'B', 'C', 'D']
-
-function sortByLength (a, b) {
-  return a.length - b.length
-}
-math.sort(['Langdon', 'Tom', 'Sara'], sortByLength)
-// returns ['Tom', 'Sara', 'Langdon']
-```
-
-
-## See also
-
-[filter](filter.md),
-[forEach](forEach.md),
-[map](map.md),
-[compare](compare.md),
-[compareNatural](compareNatural.md)

package/docs/reference/functions/sparse.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function sparse
-
-Create a Sparse Matrix. The function creates a new `math.Matrix` object from
-an `Array`. A Matrix has utility functions to manipulate the data in the
-matrix, like getting the size and getting or setting values in the matrix.
-
-
-## Syntax
-
-```js
-math.sparse()               // creates an empty sparse matrix.
-math.sparse(data)           // creates a sparse matrix with initial data.
-math.sparse(data, 'number') // creates a sparse matrix with initial data, number datatype.
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`data` | Array &#124; Matrix | A two dimensional array
-
-### Returns
-
-Type | Description
----- | -----------
-Matrix | The created matrix
-
-
-## Examples
-
-```js
-let m = math.sparse([[1, 2], [3, 4]])
-m.size()                        // Array [2, 2]
-m.resize([3, 2], 5)
-m.valueOf()                     // Array [[1, 2], [3, 4], [5, 5]]
-m.get([1, 0])                    // number 3
-```
-
-
-## See also
-
-[bignumber](bignumber.md),
-[boolean](boolean.md),
-[complex](complex.md),
-[index](index.md),
-[number](number.md),
-[string](string.md),
-[unit](unit.md),
-[matrix](matrix.md)

package/docs/reference/functions/splitUnit.md

@@ -1,37 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function splitUnit
-
-Split a unit in an array of units whose sum is equal to the original unit.
-
-
-## Syntax
-
-```js
-splitUnit(unit: Unit, parts: Array.<Unit>)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`parts` | Array | An array of strings or valueless units.
-
-### Returns
-
-Type | Description
----- | -----------
-Array | An array of units.
-
-
-## Examples
-
-```js
-math.splitUnit(new Unit(1, 'm'), ['feet', 'inch'])
-// [ 3 feet, 3.3700787401575 inch ]
-```
-
-
-## See also
-
-[unit](unit.md)

package/docs/reference/functions/sqrt.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function sqrt
-
-Calculate the square root of a value.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.sqrt(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix &#124; Unit |  Value for which to calculate the square root.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix &#124; Unit |  Returns the square root of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.sqrt(25)                // returns 5
-math.square(5)               // returns 25
-math.sqrt(-4)                // returns Complex 2i
-```
-
-
-## See also
-
-[square](square.md),
-[multiply](multiply.md),
-[cube](cube.md),
-[cbrt](cbrt.md),
-[sqrtm](sqrtm.md)

package/docs/reference/functions/sqrtm.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function sqrtm
-
-Calculate the principal square root of a square matrix.
-The principal square root matrix `X` of another matrix `A` is such that `X * X = A`.
-
-https://en.wikipedia.org/wiki/Square_root_of_a_matrix
-
-
-## Syntax
-
-```js
-X = math.sqrtm(A)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`A` | Array &#124; Matrix | The square matrix `A`
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | The principal square root of matrix `A`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.sqrtm([[1, 2], [3, 4]]) // returns [[-2, 1], [1.5, -0.5]]
-```
-
-
-## See also
-
-[sqrt](sqrt.md),
-[pow](pow.md)

package/docs/reference/functions/square.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function square
-
-Compute the square of a value, `x * x`.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.square(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix &#124; Unit |  Number for which to calculate the square
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix &#124; Unit |  Squared value
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.square(2)           // returns number 4
-math.square(3)           // returns number 9
-math.pow(3, 2)           // returns number 9
-math.multiply(3, 3)      // returns number 9
-
-math.square([1, 2, 3, 4])  // returns Array [1, 4, 9, 16]
-```
-
-
-## See also
-
-[multiply](multiply.md),
-[cube](cube.md),
-[sqrt](sqrt.md),
-[pow](pow.md)