mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/map.md

@@ -1,65 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function map
-
-Create a new matrix or array with the results of a callback function executed on
-each entry of a given matrix/array.
-
-For each entry of the input, the callback is invoked with three arguments:
-the value of the entry, the index at which that entry occurs, and the full
-matrix/array being traversed. Note that because the matrix/array might be
-multidimensional, the "index" argument is always an array of numbers giving
-the index in each dimension. This is true even for vectors: the "index"
-argument is an array of length 1, rather than simply a number.
-
-
-## Syntax
-
-```js
-math.map(x, callback)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | Matrix &#124; Array | The input to iterate on.
-`callback` | Function |  The function to call (as described above) on each entry of the input
-
-### Returns
-
-Type | Description
----- | -----------
-Matrix &#124; array |  Transformed map of x; always has the same type and shape as x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.map([1, 2, 3], function(value) {
-  return value * value
-})  // returns [1, 4, 9]
-
-// The calling convention for the callback can cause subtleties:
-math.map([1, 2, 3], math.format)
-// throws TypeError: map attempted to call 'format(1,[0])' but argument 2 of type Array does not match expected type number or function or Object or string or boolean
-// [This happens because `format` _can_ take a second argument,
-// but its semantics don't match that of the 2nd argument `map` provides]
-
-// To avoid this error, use a function that takes exactly the
-// desired arguments:
-math.map([1, 2, 3], x => math.format(x)) // returns ['1', '2', '3']
-```
-
-
-## See also
-
-[filter](filter.md),
-[forEach](forEach.md),
-[sort](sort.md)

package/docs/reference/functions/matrix.md

@@ -1,56 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function matrix
-
-Create a 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.
-Supported storage formats are 'dense' and 'sparse'.
-
-
-## Syntax
-
-```js
-math.matrix()                         // creates an empty matrix using default storage format (dense).
-math.matrix(data)                     // creates a matrix with initial data using default storage format (dense).
-math.matrix('dense')                  // creates an empty matrix using the given storage format.
-math.matrix(data, 'dense')            // creates a matrix with initial data using the given storage format.
-math.matrix(data, 'sparse')           // creates a sparse matrix with initial data.
-math.matrix(data, 'sparse', 'number') // creates a sparse matrix with initial data, number data type.
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`data` | Array &#124; Matrix | A multi dimensional array
-`format` | string | The Matrix storage format
-
-### Returns
-
-Type | Description
----- | -----------
-Matrix | The created matrix
-
-
-## Examples
-
-```js
-let m = math.matrix([[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),
-[sparse](sparse.md)

package/docs/reference/functions/matrixFromColumns.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function matrixFromColumns
-
-Create a dense matrix from vectors as individual columns.
-If you pass row vectors, they will be transposed (but not conjugated!)
-
-
-## Syntax
-
-```js
-math.matrixFromColumns(...arr)
-math.matrixFromColumns(col1, col2)
-math.matrixFromColumns(col1, col2, col3)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`cols` | ... Array &#124; Matrix | Multiple columns
-
-### Returns
-
-Type | Description
----- | -----------
-number[][] &#124; Matrix | if at least one of the arguments is an array, an array will be returned
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.matrixFromColumns([1, 2, 3], [[4],[5],[6]])
-math.matrixFromColumns(...vectors)
-```
-
-
-## See also
-
-[matrix](matrix.md),
-[matrixFromRows](matrixFromRows.md),
-[matrixFromFunction](matrixFromFunction.md),
-[zeros](zeros.md)

package/docs/reference/functions/matrixFromFunction.md

@@ -1,54 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function matrixFromFunction
-
-Create a matrix by evaluating a generating function at each index.
-The simplest overload returns a multi-dimensional array as long as `size` is an array.
-Passing `size` as a Matrix or specifying a `format` will result in returning a Matrix.
-
-
-## Syntax
-
-```js
-math.matrixFromFunction(size, fn)
-math.matrixFromFunction(size, fn, format)
-math.matrixFromFunction(size, fn, format, datatype)
-math.matrixFromFunction(size, format, fn)
-math.matrixFromFunction(size, format, datatype, fn)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`size` | Array &#124; Matrix | The size of the matrix to be created
-`fn` | function | Callback function invoked for every entry in the matrix
-`format` | string | The Matrix storage format, either `'dense'` or `'sparse'`
-`datatype` | string | Type of the values
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | Returns the created matrix
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.matrixFromFunction([3,3], i => i[0] - i[1]) // an antisymmetric matrix
-math.matrixFromFunction([100, 100], 'sparse', i => i[0] - i[1] === 1 ? 4 : 0) // a sparse subdiagonal matrix
-math.matrixFromFunction([5], i => math.random()) // a random vector
-```
-
-
-## See also
-
-[matrix](matrix.md),
-[zeros](zeros.md)

package/docs/reference/functions/matrixFromRows.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function matrixFromRows
-
-Create a dense matrix from vectors as individual rows.
-If you pass column vectors, they will be transposed (but not conjugated!)
-
-
-## Syntax
-
-```js
-math.matrixFromRows(...arr)
-math.matrixFromRows(row1, row2)
-math.matrixFromRows(row1, row2, row3)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`rows` | ... Array &#124; Matrix | Multiple rows
-
-### Returns
-
-Type | Description
----- | -----------
-number[][] &#124; Matrix | if at least one of the arguments is an array, an array will be returned
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.matrixFromRows([1, 2, 3], [[4],[5],[6]])
-math.matrixFromRows(...vectors)
-```
-
-
-## See also
-
-[matrix](matrix.md),
-[matrixFromColumns](matrixFromColumns.md),
-[matrixFromFunction](matrixFromFunction.md),
-[zeros](zeros.md)

package/docs/reference/functions/max.md

@@ -1,61 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function max
-
-Compute the maximum value of a matrix or a  list with values.
-In case of a multi dimensional array, the maximum of the flattened array
-will be calculated. When `dim` is provided, the maximum over the selected
-dimension will be calculated. Parameter `dim` is zero-based.
-
-
-## Syntax
-
-```js
-math.max(a, b, c, ...)
-math.max(A)
-math.max(A, dim)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | ... * | A single matrix or or multiple scalar values
-
-### Returns
-
-Type | Description
----- | -----------
-* | The maximum value
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.max(2, 1, 4, 3)                  // returns 4
-math.max([2, 1, 4, 3])                // returns 4
-
-// maximum over a specified dimension (zero-based)
-math.max([[2, 5], [4, 3], [1, 7]], 0) // returns [4, 7]
-math.max([[2, 5], [4, 3]], [1, 7], 1) // returns [5, 4, 7]
-
-math.max(2.7, 7.1, -4.5, 2.0, 4.1)    // returns 7.1
-math.min(2.7, 7.1, -4.5, 2.0, 4.1)    // returns -4.5
-```
-
-
-## See also
-
-[mean](mean.md),
-[median](median.md),
-[min](min.md),
-[prod](prod.md),
-[std](std.md),
-[sum](sum.md),
-[variance](variance.md)

package/docs/reference/functions/mean.md

@@ -1,57 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function mean
-
-Compute the mean value of matrix or a list with values.
-In case of a multi dimensional array, the mean of the flattened array
-will be calculated. When `dim` is provided, the maximum over the selected
-dimension will be calculated. Parameter `dim` is zero-based.
-
-
-## Syntax
-
-```js
-math.mean(a, b, c, ...)
-math.mean(A)
-math.mean(A, dim)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | ... * | A single matrix or or multiple scalar values
-
-### Returns
-
-Type | Description
----- | -----------
-* | The mean of all values
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.mean(2, 1, 4, 3)                     // returns 2.5
-math.mean([1, 2.7, 3.2, 4])               // returns 2.725
-
-math.mean([[2, 5], [6, 3], [1, 7]], 0)    // returns [3, 5]
-math.mean([[2, 5], [6, 3], [1, 7]], 1)    // returns [3.5, 4.5, 4]
-```
-
-
-## See also
-
-[median](median.md),
-[min](min.md),
-[max](max.md),
-[sum](sum.md),
-[prod](prod.md),
-[std](std.md),
-[variance](variance.md)

package/docs/reference/functions/median.md

@@ -1,57 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function median
-
-Compute the median of a matrix or a list with values. The values are
-sorted and the middle value is returned. In case of an even number of
-values, the average of the two middle values is returned.
-Supported types of values are: Number, BigNumber, Unit
-
-In case of a (multi dimensional) array or matrix, the median of all
-elements will be calculated.
-
-
-## Syntax
-
-```js
-math.median(a, b, c, ...)
-math.median(A)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | ... * | A single matrix or or multiple scalar values
-
-### Returns
-
-Type | Description
----- | -----------
-* | The median
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.median(5, 2, 7)        // returns 5
-math.median([3, -1, 5, 7])  // returns 4
-```
-
-
-## See also
-
-[mean](mean.md),
-[min](min.md),
-[max](max.md),
-[sum](sum.md),
-[prod](prod.md),
-[std](std.md),
-[variance](variance.md),
-[quantileSeq](quantileSeq.md)

package/docs/reference/functions/min.md

@@ -1,61 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function min
-
-Compute the minimum value of a matrix or a  list of values.
-In case of a multi dimensional array, the minimum of the flattened array
-will be calculated. When `dim` is provided, the minimum over the selected
-dimension will be calculated. Parameter `dim` is zero-based.
-
-
-## Syntax
-
-```js
-math.min(a, b, c, ...)
-math.min(A)
-math.min(A, dim)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | ... * | A single matrix or or multiple scalar values
-
-### Returns
-
-Type | Description
----- | -----------
-* | The minimum value
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.min(2, 1, 4, 3)                  // returns 1
-math.min([2, 1, 4, 3])                // returns 1
-
-// minimum over a specified dimension (zero-based)
-math.min([[2, 5], [4, 3], [1, 7]], 0) // returns [1, 3]
-math.min([[2, 5], [4, 3], [1, 7]], 1) // returns [2, 3, 1]
-
-math.max(2.7, 7.1, -4.5, 2.0, 4.1)    // returns 7.1
-math.min(2.7, 7.1, -4.5, 2.0, 4.1)    // returns -4.5
-```
-
-
-## See also
-
-[mean](mean.md),
-[median](median.md),
-[max](max.md),
-[prod](prod.md),
-[std](std.md),
-[sum](sum.md),
-[variance](variance.md)

package/docs/reference/functions/mod.md

@@ -1,59 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function mod
-
-Calculates the modulus, the remainder of an integer division.
-
-For matrices, the function is evaluated element wise.
-
-The modulus is defined as:
-
-    x - y * floor(x / y)
-
-See https://en.wikipedia.org/wiki/Modulo_operation.
-
-
-## Syntax
-
-```js
-math.mod(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Array &#124; Matrix | Dividend
-`y` | number &#124; BigNumber &#124; Fraction &#124; Array &#124; Matrix | Divisor
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Array &#124; Matrix | Returns the remainder of `x` divided by `y`.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.mod(8, 3)                // returns 2
-math.mod(11, 2)               // returns 1
-
-function isOdd(x) {
-  return math.mod(x, 2) != 0
-}
-
-isOdd(2)                      // returns false
-isOdd(3)                      // returns true
-```
-
-
-## See also
-
-[divide](divide.md)

package/docs/reference/functions/mode.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function mode
-
-Computes the mode of a set of numbers or a list with values(numbers or characters).
-If there are more than one modes, it returns a list of those values.
-
-
-## Syntax
-
-```js
-math.mode(a, b, c, ...)
-math.mode(A)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | ... * | A single matrix
-
-### Returns
-
-Type | Description
----- | -----------
-* | The mode of all values
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.mode(2, 1, 4, 3, 1)                            // returns [1]
-math.mode([1, 2.7, 3.2, 4, 2.7])                    // returns [2.7]
-math.mode(1, 4, 6, 1, 6)                             // returns [1, 6]
-math.mode('a','a','b','c')                           // returns ["a"]
-math.mode(1, 1.5, 'abc')                             // returns [1, 1.5, "abc"]
-```
-
-
-## See also
-
-[median](median.md),
-[](.md),
-[mean](mean.md)

package/docs/reference/functions/multinomial.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function multinomial
-
-Multinomial Coefficients compute the number of ways of picking a1, a2, ..., ai unordered outcomes from `n` possibilities.
-
-multinomial takes one array of integers as an argument.
-The following condition must be enforced: every ai <= 0
-
-
-## Syntax
-
-```js
-math.multinomial(a) // a is an array type
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a` | number[] &#124; BigNumber[] | Integer numbers of objects in the subset
-
-### Returns
-
-Type | Description
----- | -----------
-Number &#124; BigNumber | Multinomial coefficient.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.multinomial([1,2,1]) // returns 12
-```
-
-
-## See also
-
-[combinations](combinations.md),
-[factorial](factorial.md)