mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/partitionSelect.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function partitionSelect
-
-Partition-based selection of an array or 1D matrix.
-Will find the kth smallest value, and mutates the input array.
-Uses Quickselect.
-
-
-## Syntax
-
-```js
-math.partitionSelect(x, k)
-math.partitionSelect(x, k, compare)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Matrix &#124; Array | A one dimensional matrix or array to sort
-`k` | Number | The kth smallest value to be retrieved zero-based index
-`compare` | Function &#124; 'asc' &#124; 'desc' |  An optional comparator function. 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
----- | -----------
-* | Returns the kth lowest value.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.partitionSelect([5, 10, 1], 2)           // returns 10
-math.partitionSelect(['C', 'B', 'A', 'D'], 1) // returns 'B'
-
-function sortByLength (a, b) {
-  return a.length - b.length
-}
-math.partitionSelect(['Langdon', 'Tom', 'Sara'], 2, sortByLength) // returns 'Langdon'
-```
-
-
-## See also
-
-[sort](sort.md)

package/docs/reference/functions/permutations.md

@@ -1,51 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function permutations
-
-Compute the number of ways of obtaining an ordered subset of `k` elements
-from a set of `n` elements.
-
-Permutations only takes integer arguments.
-The following condition must be enforced: k <= n.
-
-
-## Syntax
-
-```js
-math.permutations(n)
-math.permutations(n, k)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`n` | number &#124; BigNumber | The number of objects in total
-`k` | number &#124; BigNumber | The number of objects in the subset
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber | The number of permutations
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.permutations(5)     // 120
-math.permutations(5, 3)  // 60
-```
-
-
-## See also
-
-[combinations](combinations.md),
-[combinationsWithRep](combinationsWithRep.md),
-[factorial](factorial.md)

package/docs/reference/functions/pickRandom.md

@@ -1,59 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function pickRandom
-
-Random pick one or more values from a one dimensional array.
-Array elements are picked using a random function with uniform or weighted distribution.
-
-
-## Syntax
-
-```js
-math.pickRandom(array)
-math.pickRandom(array, number)
-math.pickRandom(array, weights)
-math.pickRandom(array, number, weights)
-math.pickRandom(array, weights, number)
-math.pickRandom(array, { weights, number, elementWise })
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`array` | Array &#124; Matrix | A one dimensional array
-`number` | Int | An int or float
-`weights` | Array &#124; Matrix | An array of ints or floats
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array | Returns a single random value from array when number is 1 or undefined. Returns an array with the configured number of elements when number is > 1.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.pickRandom([3, 6, 12, 2])                  // returns one of the values in the array
-math.pickRandom([3, 6, 12, 2], 2)               // returns an array of two of the values in the array
-math.pickRandom([3, 6, 12, 2], { number: 2 })   // returns an array of two of the values in the array
-math.pickRandom([3, 6, 12, 2], [1, 3, 2, 1])    // returns one of the values in the array with weighted distribution
-math.pickRandom([3, 6, 12, 2], 2, [1, 3, 2, 1]) // returns an array of two of the values in the array with weighted distribution
-math.pickRandom([3, 6, 12, 2], [1, 3, 2, 1], 2) // returns an array of two of the values in the array with weighted distribution
-
-math.pickRandom([{x: 1.0, y: 2.0}, {x: 1.1, y: 2.0}], { elementWise: false })
-    // returns one of the items in the array
-```
-
-
-## See also
-
-[random](random.md),
-[randomInt](randomInt.md)

package/docs/reference/functions/pinv.md

@@ -1,44 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function pinv
-
-Calculate the Moore–Penrose inverse of a matrix.
-
-
-## Syntax
-
-```js
-math.pinv(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; Complex &#124; Array &#124; Matrix | Matrix to be inversed
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Complex &#124; Array &#124; Matrix | The inverse of `x`.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.pinv([[1, 2], [3, 4]])          // returns [[-2, 1], [1.5, -0.5]]
-math.pinv([[1, 0], [0, 1], [0, 1]])  // returns [[1, 0, 0], [0, 0.5, 0.5]]
-math.pinv(4)                         // returns 0.25
-```
-
-
-## See also
-
-[inv](inv.md)

package/docs/reference/functions/pow.md

@@ -1,65 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function pow
-
-Calculates the power of x to y, `x ^ y`.
-
-Matrix exponentiation is supported for square matrices `x` and integers `y`:
-when `y` is nonnegative, `x` may be any square matrix; and when `y` is
-negative, `x` must be invertible, and then this function returns
-inv(x)^(-y).
-
-For cubic roots of negative numbers, the function returns the principal
-root by default. In order to let the function return the real root,
-math.js can be configured with `math.config({predictable: true})`.
-To retrieve all cubic roots of a value, use `math.cbrt(x, true)`.
-
-
-## Syntax
-
-```js
-math.pow(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 | The exponent
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | The value of `x` to the power `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.pow(2, 3)               // returns number 8
-
-const a = math.complex(2, 3)
-math.pow(a, 2)                // returns Complex -5 + 12i
-
-const b = [[1, 2], [4, 3]]
-math.pow(b, 2)               // returns Array [[9, 8], [16, 17]]
-
-const c = [[1, 2], [4, 3]]
-math.pow(c, -1)               // returns Array [[-0.6, 0.4], [0.8, -0.2]]
-```
-
-
-## See also
-
-[multiply](multiply.md),
-[sqrt](sqrt.md),
-[cbrt](cbrt.md),
-[nthRoot](nthRoot.md)

package/docs/reference/functions/print.md

@@ -1,64 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function print
-
-Interpolate values into a string template.
-
-
-## Syntax
-
-```js
-math.print(template, values)
-math.print(template, values, precision)
-math.print(template, values, options)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`template` | string | A string containing variable placeholders.
-`values` | Object &#124; Array &#124; Matrix | An object or array containing variables which will be filled in in the template.
-`options` | number &#124; Object | Formatting options, or the number of digits to format numbers. See function math.format for a description of all options.
-
-### Returns
-
-Type | Description
----- | -----------
-string | Interpolated string
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-// the following outputs: 'Lucy is 5 years old'
-math.print('Lucy is $age years old', {age: 5})
-
-// the following outputs: 'The value of pi is 3.141592654'
-math.print('The value of pi is $pi', {pi: math.pi}, 10)
-
-// the following outputs: 'hello Mary! The date is 2013-03-23'
-math.print('Hello $user.name! The date is $date', {
-  user: {
-    name: 'Mary',
-  },
-  date: new Date(2013, 2, 23).toISOString().substring(0, 10)
-})
-
-// the following outputs: 'My favorite fruits are apples and bananas !'
-math.print('My favorite fruits are $0 and $1 !', [
-  'apples',
-  'bananas'
-])
-```
-
-
-## See also
-
-[format](format.md)

package/docs/reference/functions/prod.md

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

package/docs/reference/functions/qr.md

@@ -1,65 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function qr
-
-Calculate the Matrix QR decomposition. Matrix `A` is decomposed in
-two matrices (`Q`, `R`) where `Q` is an
-orthogonal matrix and `R` is an upper triangular matrix.
-
-
-## Syntax
-
-```js
-math.qr(A)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`A` | Matrix &#124; Array | A two dimensional matrix or array for which to get the QR decomposition.
-
-### Returns
-
-Type | Description
----- | -----------
-{Q: Array &#124; Matrix, R: Array &#124; Matrix} | Q: the orthogonal matrix and R: the upper triangular matrix
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const m = [
-  [1, -1,  4],
-  [1,  4, -2],
-  [1,  4,  2],
-  [1,  -1, 0]
-]
-const result = math.qr(m)
-// r = {
-//   Q: [
-//     [0.5, -0.5,   0.5],
-//     [0.5,  0.5,  -0.5],
-//     [0.5,  0.5,   0.5],
-//     [0.5, -0.5,  -0.5],
-//   ],
-//   R: [
-//     [2, 3,  2],
-//     [0, 5, -2],
-//     [0, 0,  4],
-//     [0, 0,  0]
-//   ]
-// }
-```
-
-
-## See also
-
-[lup](lup.md),
-[lusolve](lusolve.md)

package/docs/reference/functions/quantileSeq.md

@@ -1,62 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function quantileSeq
-
-Compute the prob order quantile of a matrix or a list with values.
-The sequence is sorted and the middle value is returned.
-Supported types of sequence values are: Number, BigNumber, Unit
-Supported types of probability are: Number, BigNumber
-
-In case of a (multi dimensional) array or matrix, the prob order quantile
-of all elements will be calculated.
-
-
-## Syntax
-
-```js
-math.quantileSeq(A, prob[, sorted])
-math.quantileSeq(A, [prob1, prob2, ...][, sorted])
-math.quantileSeq(A, N[, sorted])
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`data` | Array, Matrix | A single matrix or Array
-`probOrN` | Number, BigNumber, Array | prob is the order of the quantile, while N is the amount of evenly distributed steps of probabilities; only one of these options can be provided
-`sorted` | Boolean | =false              is data sorted in ascending order
-
-### Returns
-
-Type | Description
----- | -----------
-Number, BigNumber, Unit, Array | Quantile(s)
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.quantileSeq([3, -1, 5, 7], 0.5)         // returns 4
-math.quantileSeq([3, -1, 5, 7], [1/3, 2/3])  // returns [3, 5]
-math.quantileSeq([3, -1, 5, 7], 2)           // returns [3, 5]
-math.quantileSeq([-1, 3, 5, 7], 0.5, true)   // returns 4
-```
-
-
-## See also
-
-[median](median.md),
-[mean](mean.md),
-[min](min.md),
-[max](max.md),
-[sum](sum.md),
-[prod](prod.md),
-[std](std.md),
-[variance](variance.md)

package/docs/reference/functions/random.md

@@ -1,54 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function random
-
-Return a random number larger or equal to `min` and smaller than `max`
-using a uniform distribution.
-
-
-## Syntax
-
-```js
-math.random()                // generate a random number between 0 and 1
-math.random(max)             // generate a random number between 0 and max
-math.random(min, max)        // generate a random number between min and max
-math.random(size)            // generate a matrix with random numbers between 0 and 1
-math.random(size, max)       // generate a matrix with random numbers between 0 and max
-math.random(size, min, max)  // generate a matrix with random numbers between min and max
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`size` | Array &#124; Matrix | If provided, an array or matrix with given size and filled with random values is returned
-`min` | number | Minimum boundary for the random value, included
-`max` | number | Maximum boundary for the random value, excluded
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array &#124; Matrix | A random number
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.random()       // returns a random number between 0 and 1
-math.random(100)    // returns a random number between 0 and 100
-math.random(30, 40) // returns a random number between 30 and 40
-math.random([2, 3]) // returns a 2x3 matrix with random numbers between 0 and 1
-```
-
-
-## See also
-
-[randomInt](randomInt.md),
-[pickRandom](pickRandom.md)

package/docs/reference/functions/randomInt.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function randomInt
-
-Return a random integer number larger or equal to `min` and smaller than `max`
-using a uniform distribution.
-
-
-## Syntax
-
-```js
-math.randomInt()                // generate a random integer between 0 and 1
-math.randomInt(max)             // generate a random integer between 0 and max
-math.randomInt(min, max)        // generate a random integer between min and max
-math.randomInt(size)            // generate a matrix with random integer between 0 and 1
-math.randomInt(size, max)       // generate a matrix with random integer between 0 and max
-math.randomInt(size, min, max)  // generate a matrix with random integer between min and max
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`size` | Array &#124; Matrix | If provided, an array or matrix with given size and filled with random values is returned
-`min` | number | Minimum boundary for the random value, included
-`max` | number | Maximum boundary for the random value, excluded
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array &#124; Matrix | A random integer value
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.randomInt(100)    // returns a random integer between 0 and 100
-math.randomInt(30, 40) // returns a random integer between 30 and 40
-math.randomInt([2, 3]) // returns a 2x3 matrix with random integers between 0 and 1
-```
-
-
-## See also
-
-[random](random.md),
-[pickRandom](pickRandom.md)

package/docs/reference/functions/range.md

@@ -1,70 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function range
-
-Create an array from a range.
-By default, the range end is excluded. This can be customized by providing
-an extra parameter `includeEnd`.
-
-
-## Syntax
-
-```js
-math.range(str [, includeEnd])               // Create a range from a string,
-                                             // where the string contains the
-                                             // start, optional step, and end,
-                                             // separated by a colon.
-math.range(start, end [, includeEnd])        // Create a range with start and
-                                             // end and a step size of 1.
-math.range(start, end, step [, includeEnd])  // Create a range with start, step,
-                                             // and end.
-```
-
-### Where
-
-- `str: string`
-  A string 'start:end' or 'start:step:end'
-- `start: {number | BigNumber}`
-  Start of the range
-- `end: number | BigNumber`
-  End of the range, excluded by default, included when parameter includeEnd=true
-- `step: number | BigNumber`
-  Step size. Default value is 1.
-- `includeEnd: boolean`
-  Option to specify whether to include the end or not. False by default.
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | * | Parameters describing the ranges `start`, `end`, and optional `step`.
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | range
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.range(2, 6)        // [2, 3, 4, 5]
-math.range(2, -3, -1)   // [2, 1, 0, -1, -2]
-math.range('2:1:6')     // [2, 3, 4, 5]
-math.range(2, 6, true)  // [2, 3, 4, 5, 6]
-```
-
-
-## See also
-
-[ones](ones.md),
-[zeros](zeros.md),
-[size](size.md),
-[subset](subset.md)