mathjs 10.5.2 → 10.6.1

package/docs/reference/functions/bitAnd.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function bitAnd
-
-Bitwise AND two values, `x & y`.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.bitAnd(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Array &#124; Matrix | First value to and
-`y` | number &#124; BigNumber &#124; Array &#124; Matrix | Second value to and
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Array &#124; Matrix | AND of `x` and `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.bitAnd(53, 131)               // returns number 1
-
-math.bitAnd([1, 12, 31], 42)       // returns Array [0, 8, 10]
-```
-
-
-## See also
-
-[bitNot](bitNot.md),
-[bitOr](bitOr.md),
-[bitXor](bitXor.md),
-[leftShift](leftShift.md),
-[rightArithShift](rightArithShift.md),
-[rightLogShift](rightLogShift.md)

package/docs/reference/functions/bitNot.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function bitNot
-
-Bitwise NOT value, `~x`.
-For matrices, the function is evaluated element wise.
-For units, the function is evaluated on the best prefix base.
-
-
-## Syntax
-
-```js
-math.bitNot(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Array &#124; Matrix | Value to not
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Array &#124; Matrix | NOT of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.bitNot(1)               // returns number -2
-
-math.bitNot([2, -3, 4])      // returns Array [-3, 2, 5]
-```
-
-
-## See also
-
-[bitAnd](bitAnd.md),
-[bitOr](bitOr.md),
-[bitXor](bitXor.md),
-[leftShift](leftShift.md),
-[rightArithShift](rightArithShift.md),
-[rightLogShift](rightLogShift.md)

package/docs/reference/functions/bitOr.md

@@ -1,52 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function bitOr
-
-Bitwise OR two values, `x | y`.
-For matrices, the function is evaluated element wise.
-For units, the function is evaluated on the lowest print base.
-
-
-## Syntax
-
-```js
-math.bitOr(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Array &#124; Matrix | First value to or
-`y` | number &#124; BigNumber &#124; Array &#124; Matrix | Second value to or
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Array &#124; Matrix | OR of `x` and `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.bitOr(1, 2)               // returns number 3
-
-math.bitOr([1, 2, 3], 4)       // returns Array [5, 6, 7]
-```
-
-
-## See also
-
-[bitAnd](bitAnd.md),
-[bitNot](bitNot.md),
-[bitXor](bitXor.md),
-[leftShift](leftShift.md),
-[rightArithShift](rightArithShift.md),
-[rightLogShift](rightLogShift.md)

package/docs/reference/functions/bitXor.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function bitXor
-
-Bitwise XOR two values, `x ^ y`.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.bitXor(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Array &#124; Matrix | First value to xor
-`y` | number &#124; BigNumber &#124; Array &#124; Matrix | Second value to xor
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Array &#124; Matrix | XOR of `x` and `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.bitXor(1, 2)               // returns number 3
-
-math.bitXor([2, 3, 4], 4)       // returns Array [6, 7, 0]
-```
-
-
-## See also
-
-[bitAnd](bitAnd.md),
-[bitNot](bitNot.md),
-[bitOr](bitOr.md),
-[leftShift](leftShift.md),
-[rightArithShift](rightArithShift.md),
-[rightLogShift](rightLogShift.md)

package/docs/reference/functions/boolean.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function boolean
-
-Create a boolean or convert a string or number to a boolean.
-In case of a number, `true` is returned for non-zero numbers, and `false` in
-case of zero.
-Strings can be `'true'` or `'false'`, or can contain a number.
-When value is a matrix, all elements will be converted to boolean.
-
-
-## Syntax
-
-```js
-math.boolean(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`value` | string &#124; number &#124; boolean &#124; Array &#124; Matrix &#124; null | A value of any type
-
-### Returns
-
-Type | Description
----- | -----------
-boolean &#124; Array &#124; Matrix | The boolean value
-
-
-## Examples
-
-```js
-math.boolean(0)     // returns false
-math.boolean(1)     // returns true
-math.boolean(-3)     // returns true
-math.boolean('true')     // returns true
-math.boolean('false')     // returns false
-math.boolean([1, 0, 1, 1])     // returns [true, false, true, true]
-```
-
-
-## See also
-
-[bignumber](bignumber.md),
-[complex](complex.md),
-[index](index.md),
-[matrix](matrix.md),
-[string](string.md),
-[unit](unit.md)

package/docs/reference/functions/catalan.md

@@ -1,45 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function catalan
-
-The Catalan Numbers enumerate combinatorial structures of many different types.
-catalan only takes integer arguments.
-The following condition must be enforced: n >= 0
-
-
-## Syntax
-
-```js
-math.catalan(n)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`n` | Number &#124; BigNumber | nth Catalan number
-
-### Returns
-
-Type | Description
----- | -----------
-Number &#124; BigNumber | Cn(n)
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.catalan(3) // returns 5
-math.catalan(8) // returns 1430
-```
-
-
-## See also
-
-[bellNumbers](bellNumbers.md)

package/docs/reference/functions/cbrt.md

@@ -1,60 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function cbrt
-
-Calculate the cubic root of a value.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.cbrt(x)
-math.cbrt(x, allRoots)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix |  Value for which to calculate the cubic root.
-`allRoots` | boolean | Optional, false by default. Only applicable when `x` is a number or complex number. If true, all complex roots are returned, if false (default) the principal root is returned.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix |  Returns the cubic root of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.cbrt(27)                  // returns 3
-math.cube(3)                   // returns 27
-math.cbrt(-64)                 // returns -4
-math.cbrt(math.unit('27 m^3')) // returns Unit 3 m
-math.cbrt([27, 64, 125])       // returns [3, 4, 5]
-
-const x = math.complex('8i')
-math.cbrt(x)                   // returns Complex 1.7320508075689 + i
-math.cbrt(x, true)             // returns Matrix [
-                                //    1.7320508075689 + i
-                                //   -1.7320508075689 + i
-                                //   -2i
-                                // ]
-```
-
-
-## See also
-
-[square](square.md),
-[sqrt](sqrt.md),
-[cube](cube.md)

package/docs/reference/functions/ceil.md

@@ -1,63 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function ceil
-
-Round a value towards plus infinity
-If `x` is complex, both real and imaginary part are rounded towards plus infinity.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.ceil(x)
-math.ceil(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.ceil(3.2)               // returns number 4
-math.ceil(3.8)               // returns number 4
-math.ceil(-4.2)              // returns number -4
-math.ceil(-4.7)              // returns number -4
-
-math.ceil(3.212, 2)          // returns number 3.22
-math.ceil(3.288, 2)          // returns number 3.29
-math.ceil(-4.212, 2)         // returns number -4.21
-math.ceil(-4.782, 2)         // returns number -4.78
-
-const c = math.complex(3.24, -2.71)
-math.ceil(c)                 // returns Complex 4 - 2i
-math.ceil(c, 1)              // returns Complex 3.3 - 2.7i
-
-math.ceil([3.2, 3.8, -4.7])  // returns Array [4, 4, -4]
-math.ceil([3.21, 3.82, -4.71], 1)  // returns Array [3.3, 3.9, -4.7]
-```
-
-
-## See also
-
-[floor](floor.md),
-[fix](fix.md),
-[round](round.md)

package/docs/reference/functions/chain.md

@@ -1,54 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function chain
-
-Wrap any value in a chain, allowing to perform chained operations on
-the value.
-
-All methods available in the math.js library can be called upon the chain,
-and then will be evaluated with the value itself as first argument.
-The chain can be closed by executing `chain.done()`, which returns
-the final value.
-
-The chain has a number of special functions:
-
-- `done()`     Finalize the chain and return the chain's value.
-- `valueOf()`  The same as `done()`
-- `toString()` Executes `math.format()` onto the chain's value, returning
-               a string representation of the value.
-
-
-## Syntax
-
-```js
-math.chain(value)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`value` | * | A value of any type on which to start a chained operation.
-
-### Returns
-
-Type | Description
----- | -----------
-math.Chain | The created chain
-
-
-## Examples
-
-```js
-math.chain(3)
-    .add(4)
-    .subtract(2)
-    .done()     // 5
-
-math.chain( [[1, 2], [3, 4]] )
-    .subset(math.index(0, 0), 8)
-    .multiply(3)
-    .done()     // [[24, 6], [9, 12]]
-```
-
-

package/docs/reference/functions/clone.md

@@ -1,43 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function clone
-
-Clone an object. Will make a deep copy of the data.
-
-
-## Syntax
-
-```js
-math.clone(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | * | Object to be cloned
-
-### Returns
-
-Type | Description
----- | -----------
-* | A clone of object x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.clone(3.5)                   // returns number 3.5
-math.clone(math.complex('2-4i') // returns Complex 2 - 4i
-math.clone(math.unit(45, 'deg'))  // returns Unit 45 deg
-math.clone([[1, 2], [3, 4]])      // returns Array [[1, 2], [3, 4]]
-math.clone("hello world")         // returns string "hello world"
-```
-
-

package/docs/reference/functions/column.md

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

package/docs/reference/functions/combinations.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function combinations
-
-Compute the number of ways of picking `k` unordered outcomes from `n`
-possibilities.
-
-Combinations only takes integer arguments.
-The following condition must be enforced: k <= n.
-
-
-## Syntax
-
-```js
-math.combinations(n, k)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`n` | number &#124; BigNumber | Total number of objects in the set
-`k` | number &#124; BigNumber | Number of objects in the subset
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber | Number of possible combinations.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.combinations(7, 5) // returns 21
-```
-
-
-## See also
-
-[combinationsWithRep](combinationsWithRep.md),
-[permutations](permutations.md),
-[factorial](factorial.md)

package/docs/reference/functions/combinationsWithRep.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function combinationsWithRep
-
-Compute the number of ways of picking `k` unordered outcomes from `n`
-possibilities, allowing individual outcomes to be repeated more than once.
-
-CombinationsWithRep only takes integer arguments.
-The following condition must be enforced: k <= n + k -1.
-
-
-## Syntax
-
-```js
-math.combinationsWithRep(n, k)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`n` | number &#124; BigNumber | Total number of objects in the set
-`k` | number &#124; BigNumber | Number of objects in the subset
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber | Number of possible combinations with replacement.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.combinationsWithRep(7, 5) // returns 462
-```
-
-
-## See also
-
-[combinations](combinations.md),
-[permutations](permutations.md),
-[factorial](factorial.md)