mathjs 10.5.2 → 10.6.1

package/docs/reference/functions/add.md

@@ -1,59 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function add
-
-Add two or more values, `x + y`.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.add(x, y)
-math.add(x, y, z, ...)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | First value to add
-`y` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Second value to add
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Sum of `x` and `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.add(2, 3)               // returns number 5
-math.add(2, 3, 4)            // returns number 9
-
-const a = math.complex(2, 3)
-const b = math.complex(-4, 1)
-math.add(a, b)               // returns Complex -2 + 4i
-
-math.add([1, 2, 3], 4)       // returns Array [5, 6, 7]
-
-const c = math.unit('5 cm')
-const d = math.unit('2.1 mm')
-math.add(c, d)               // returns Unit 52.1 mm
-
-math.add("2.3", "4")         // returns number 6.3
-```
-
-
-## See also
-
-[subtract](subtract.md),
-[sum](sum.md)

package/docs/reference/functions/and.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function and
-
-Logical `and`. Test whether two values are both defined with a nonzero/nonempty value.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.and(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | First value to check
-`y` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Second value to check
-
-### Returns
-
-Type | Description
----- | -----------
-boolean &#124; Array &#124; Matrix |  Returns true when both inputs are defined with a nonzero/nonempty value.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.and(2, 4)   // returns true
-
-a = [2, 0, 0]
-b = [3, 7, 0]
-c = 0
-
-math.and(a, b)   // returns [true, false, false]
-math.and(a, c)   // returns [false, false, false]
-```
-
-
-## See also
-
-[not](not.md),
-[or](or.md),
-[xor](xor.md)

package/docs/reference/functions/apply.md

@@ -1,56 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function apply
-
-Apply a function that maps an array to a scalar
-along a given axis of a matrix or array.
-Returns a new matrix or array with one less dimension than the input.
-
-
-## Syntax
-
-```js
-math.apply(A, dim, callback)
-```
-
-### Where
-
-- `dim: number` is a zero-based dimension over which to concatenate the matrices.
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`array` | Array &#124; Matrix | The input Matrix
-`dim` | number | The dimension along which the callback is applied
-`callback` | Function | The callback function that is applied. This Function should take an array or 1-d matrix as an input and return a number.
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | res    The residual matrix with the function applied over some dimension.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const A = [[1, 2], [3, 4]]
-const sum = math.sum
-
-math.apply(A, 0, sum)             // returns [4, 6]
-math.apply(A, 1, sum)             // returns [3, 7]
-```
-
-
-## See also
-
-[map](map.md),
-[filter](filter.md),
-[forEach](forEach.md)

package/docs/reference/functions/arg.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function arg
-
-Compute the argument of a complex value.
-For a complex number `a + bi`, the argument is computed as `atan2(b, a)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.arg(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 argument of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const a = math.complex(2, 2)
-math.arg(a) / math.pi          // returns number 0.25
-
-const b = math.complex('2 + 3i')
-math.arg(b)                    // returns number 0.982793723247329
-math.atan2(3, 2)               // returns number 0.982793723247329
-```
-
-
-## See also
-
-[re](re.md),
-[im](im.md),
-[conj](conj.md),
-[abs](abs.md)

package/docs/reference/functions/asec.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function asec
-
-Calculate the inverse secant of a value. Defined as `asec(x) = acos(1/x)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.asec(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; Complex &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Complex &#124; Array &#124; Matrix | The arc secant of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.asec(0.5)           // returns 1.0471975511965979
-math.asec(math.sec(1.5)) // returns 1.5
-
-math.asec(2)             // returns 0 + 1.3169578969248166 i
-```
-
-
-## See also
-
-[acos](acos.md),
-[acot](acot.md),
-[acsc](acsc.md)

package/docs/reference/functions/asech.md

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

package/docs/reference/functions/asin.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function asin
-
-Calculate the inverse sine of a value.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.asin(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | The arc sine of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.asin(0.5)           // returns number 0.5235987755982989
-math.asin(math.sin(1.5)) // returns number ~1.5
-
-math.asin(2)             // returns Complex 1.5707963267948966 -1.3169578969248166 i
-```
-
-
-## See also
-
-[sin](sin.md),
-[atan](atan.md),
-[acos](acos.md)

package/docs/reference/functions/asinh.md

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

package/docs/reference/functions/atan.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function atan
-
-Calculate the inverse tangent of a value.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.atan(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | The arc tangent of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.atan(0.5)           // returns number 0.4636476090008061
-math.atan(math.tan(1.5)) // returns number 1.5
-
-math.atan(2)             // returns Complex 1.5707963267948966 -1.3169578969248166 i
-```
-
-
-## See also
-
-[tan](tan.md),
-[asin](asin.md),
-[acos](acos.md)

package/docs/reference/functions/atan2.md

@@ -1,56 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function atan2
-
-Calculate the inverse tangent function with two arguments, y/x.
-By providing two arguments, the right quadrant of the computed angle can be
-determined.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.atan2(y, x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`y` | number &#124; Array &#124; Matrix | Second dimension
-`x` | number &#124; Array &#124; Matrix | First dimension
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array &#124; Matrix | Four-quadrant inverse tangent
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.atan2(2, 2) / math.pi       // returns number 0.25
-
-const angle = math.unit(60, 'deg') // returns Unit 60 deg
-const x = math.cos(angle)
-const y = math.sin(angle)
-
-math.atan(2)             // returns Complex 1.5707963267948966 -1.3169578969248166 i
-```
-
-
-## See also
-
-[tan](tan.md),
-[atan](atan.md),
-[sin](sin.md),
-[cos](cos.md)

package/docs/reference/functions/atanh.md

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

package/docs/reference/functions/bellNumbers.md

@@ -1,45 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function bellNumbers
-
-The Bell Numbers count the number of partitions of a set. A partition is a pairwise disjoint subset of S whose union is S.
-bellNumbers only takes integer arguments.
-The following condition must be enforced: n >= 0
-
-
-## Syntax
-
-```js
-math.bellNumbers(n)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`n` | Number &#124; BigNumber | Total number of objects in the set
-
-### Returns
-
-Type | Description
----- | -----------
-Number &#124; BigNumber | B(n)
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.bellNumbers(3) // returns 5
-math.bellNumbers(8) // returns 4140
-```
-
-
-## See also
-
-[stirlingS2](stirlingS2.md)

package/docs/reference/functions/bignumber.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function bignumber
-
-Create a BigNumber, which can store numbers with arbitrary precision.
-When a matrix is provided, all elements will be converted to BigNumber.
-
-
-## Syntax
-
-```js
-math.bignumber(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`value` | number &#124; string &#124; Fraction &#124; BigNumber &#124; Array &#124; Matrix &#124; boolean &#124; null | Value for the big number, 0 by default.
-
-### Returns
-
-Type | Description
----- | -----------
-BigNumber | The created bignumber
-
-
-## Examples
-
-```js
-0.1 + 0.2                                  // returns number 0.30000000000000004
-math.bignumber(0.1) + math.bignumber(0.2)  // returns BigNumber 0.3
-
-
-7.2e500                                    // returns number Infinity
-math.bignumber('7.2e500')                  // returns BigNumber 7.2e500
-```
-
-
-## See also
-
-[boolean](boolean.md),
-[complex](complex.md),
-[index](index.md),
-[matrix](matrix.md),
-[string](string.md),
-[unit](unit.md)

package/docs/reference/functions/bin.md

@@ -1,45 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function bin
-
-Format a number as binary.
-
-
-## Syntax
-
-```js
-math.bin(value)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`value` | number | Value to be stringified
-`wordSize` | number | Optional word size (see `format`)
-
-### Returns
-
-Type | Description
----- | -----------
-string | The formatted value
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-//the following outputs "0b10"
-math.bin(2)
-```
-
-
-## See also
-
-[oct](oct.md),
-[hex](hex.md)