mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/count.md

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

package/docs/reference/functions/createUnit.md

@@ -1,52 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function createUnit
-
-Create a user-defined unit and register it with the Unit type.
-
-
-## Syntax
-
-```js
-math.createUnit({
-  baseUnit1: {
-    aliases: [string, ...]
-    prefixes: object
-  },
-  unit2: {
-    definition: string,
-    aliases: [string, ...]
-    prefixes: object,
-    offset: number
-  },
-  unit3: string    // Shortcut
-})
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`name` | string | The name of the new unit. Must be unique. Example: 'knot'
-`definition` | string, Unit | Definition of the unit in terms of existing units. For example, '0.514444444 m / s'.
-`options` | Object | (optional) An object containing any of the following properties:</br>- `prefixes {string}` "none", "short", "long", "binary_short", or "binary_long". The default is "none".</br>- `aliases {Array}` Array of strings. Example: ['knots', 'kt', 'kts']</br>- `offset {Numeric}` An offset to apply when converting from the unit. For example, the offset for celsius is 273.15. Default is 0.
-
-### Returns
-
-Type | Description
----- | -----------
-Unit | The new unit
-
-
-## Examples
-
-```js
-math.createUnit('foo')
-math.createUnit('knot', {definition: '0.514444444 m/s', aliases: ['knots', 'kt', 'kts']})
-math.createUnit('mph', '1 mile/hour')
-```
-
-
-## See also
-
-[unit](unit.md)

package/docs/reference/functions/cross.md

@@ -1,58 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function cross
-
-Calculate the cross product for two vectors in three dimensional space.
-The cross product of `A = [a1, a2, a3]` and `B = [b1, b2, b3]` is defined
-as:
-
-   cross(A, B) = [
-     a2 * b3 - a3 * b2,
-     a3 * b1 - a1 * b3,
-     a1 * b2 - a2 * b1
-   ]
-
-If one of the input vectors has a dimension greater than 1, the output
-vector will be a 1x3 (2-dimensional) matrix.
-
-
-## Syntax
-
-```js
-math.cross(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Array &#124; Matrix | First vector
-`y` | Array &#124; Matrix | Second vector
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | Returns the cross product of `x` and `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.cross([1, 1, 0],   [0, 1, 1])       // Returns [1, -1, 1]
-math.cross([3, -3, 1],  [4, 9, 2])       // Returns [-15, -2, 39]
-math.cross([2, 3, 4],   [5, 6, 7])       // Returns [-3, 6, -3]
-math.cross([[1, 2, 3]], [[4], [5], [6]]) // Returns [[-3, 6, -3]]
-```
-
-
-## See also
-
-[dot](dot.md),
-[multiply](multiply.md)

package/docs/reference/functions/csc.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function csc
-
-Calculate the cosecant of a value, defined as `csc(x) = 1/sin(x)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.csc(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 | Cosecant of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.csc(2)      // returns number 1.099750170294617
-1 / math.sin(2)  // returns number 1.099750170294617
-```
-
-
-## See also
-
-[sin](sin.md),
-[sec](sec.md),
-[cot](cot.md)

package/docs/reference/functions/csch.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function csch
-
-Calculate the hyperbolic cosecant of a value,
-defined as `csch(x) = 1 / sinh(x)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.csch(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 cosecant of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-// csch(x) = 1/ sinh(x)
-math.csch(0.5)       // returns 1.9190347513349437
-1 / math.sinh(0.5)   // returns 1.9190347513349437
-```
-
-
-## See also
-
-[sinh](sinh.md),
-[sech](sech.md),
-[coth](coth.md)

package/docs/reference/functions/ctranspose.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function ctranspose
-
-Transpose and complex conjugate a matrix. All values of the matrix are
-reflected over its main diagonal and then the complex conjugate is
-taken. This is equivalent to complex conjugation for scalars and
-vectors.
-
-
-## Syntax
-
-```js
-math.ctranspose(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Array &#124; Matrix | Matrix to be ctransposed
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | The ctransposed matrix
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const A = [[1, 2, 3], [4, 5, math.complex(6,7)]]
-math.ctranspose(A)               // returns [[1, 4], [2, 5], [3, {re:6,im:7}]]
-```
-
-
-## See also
-
-[transpose](transpose.md),
-[diag](diag.md),
-[inv](inv.md),
-[subset](subset.md),
-[squeeze](squeeze.md)

package/docs/reference/functions/cube.md

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

package/docs/reference/functions/cumsum.md

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

package/docs/reference/functions/deepEqual.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function deepEqual
-
-Test element wise whether two matrices are equal.
-The function accepts both matrices and scalar values.
-
-Strings are compared by their numerical value.
-
-
-## Syntax
-
-```js
-math.deepEqual(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | First matrix to compare
-`y` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Second matrix to compare
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix |  Returns true when the input matrices have the same size and each of their elements is equal.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.deepEqual(2, 4)   // returns false
-
-a = [2, 5, 1]
-b = [2, 7, 1]
-
-math.deepEqual(a, b)   // returns false
-math.equal(a, b)       // returns [true, false, true]
-```
-
-
-## See also
-
-[equal](equal.md),
-[unequal](unequal.md)

package/docs/reference/functions/derivative.md

@@ -1,61 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function derivative
-
-Takes the derivative of an expression expressed in parser Nodes.
-The derivative will be taken over the supplied variable in the
-second parameter. If there are multiple variables in the expression,
-it will return a partial derivative.
-
-This uses rules of differentiation which can be found here:
-
-- [Differentiation rules (Wikipedia)](https://en.wikipedia.org/wiki/Differentiation_rules)
-
-
-## Syntax
-
-```js
-derivative(expr, variable)
-derivative(expr, variable, options)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`expr` | Node &#124; string | The expression to differentiate
-`variable` | SymbolNode &#124; string | The variable over which to differentiate
-`options` | {simplify: boolean} |  There is one option available, `simplify`, which is true by default. When false, output will not be simplified.
-
-### Returns
-
-Type | Description
----- | -----------
-ConstantNode &#124; SymbolNode &#124; ParenthesisNode &#124; FunctionNode &#124; OperatorNode | The derivative of `expr`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.derivative('x^2', 'x')                     // Node {2 * x}
-math.derivative('x^2', 'x', {simplify: false})  // Node {2 * 1 * x ^ (2 - 1)
-math.derivative('sin(2x)', 'x'))                // Node {2 * cos(2 * x)}
-math.derivative('2*x', 'x').evaluate()          // number 2
-math.derivative('x^2', 'x').evaluate({x: 4})    // number 8
-const f = math.parse('x^2')
-const x = math.parse('x')
-math.derivative(f, x)                           // Node {2 * x}
-```
-
-
-## See also
-
-[simplify](simplify.md),
-[parse](parse.md),
-[evaluate](evaluate.md)

package/docs/reference/functions/det.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function det
-
-Calculate the determinant of a matrix.
-
-
-## Syntax
-
-```js
-math.det(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Array &#124; Matrix | A matrix
-
-### Returns
-
-Type | Description
----- | -----------
-number | The determinant of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.det([[1, 2], [3, 4]]) // returns -2
-
-const A = [
-  [-2, 2, 3],
-  [-1, 1, 3],
-  [2, 0, -1]
-]
-math.det(A) // returns 6
-```
-
-
-## See also
-
-[inv](inv.md)

package/docs/reference/functions/diag.md

@@ -1,61 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function diag
-
-Create a diagonal matrix or retrieve the diagonal of a matrix
-
-When `x` is a vector, a matrix with vector `x` on the diagonal will be returned.
-When `x` is a two dimensional matrix, the matrixes `k`th diagonal will be returned as vector.
-When k is positive, the values are placed on the super diagonal.
-When k is negative, the values are placed on the sub diagonal.
-
-
-## Syntax
-
-```js
-math.diag(X)
-math.diag(X, format)
-math.diag(X, k)
-math.diag(X, k, format)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Matrix &#124; Array | A two dimensional matrix or a vector
-`k` | number &#124; BigNumber | The diagonal where the vector will be filled in or retrieved. Default value: 0.
-`format` | string | The matrix storage format. Default value: 'dense'.
-
-### Returns
-
-Type | Description
----- | -----------
-Matrix &#124; Array | Diagonal matrix from input vector, or diagonal from input matrix.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
- // create a diagonal matrix
- math.diag([1, 2, 3])      // returns [[1, 0, 0], [0, 2, 0], [0, 0, 3]]
- math.diag([1, 2, 3], 1)   // returns [[0, 1, 0, 0], [0, 0, 2, 0], [0, 0, 0, 3]]
- math.diag([1, 2, 3], -1)  // returns [[0, 0, 0], [1, 0, 0], [0, 2, 0], [0, 0, 3]]
-
-// retrieve the diagonal from a matrix
-const a = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
-math.diag(a)   // returns [1, 5, 9]
-```
-
-
-## See also
-
-[ones](ones.md),
-[zeros](zeros.md),
-[identity](identity.md)