mathjs 10.0.0 → 10.6.4

package/docs/reference/functions/compareNatural.md

@@ -1,86 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function compareNatural
-
-Compare two values of any type in a deterministic, natural way.
-
-For numeric values, the function works the same as `math.compare`.
-For types of values that can't be compared mathematically,
-the function compares in a natural way.
-
-For numeric values, x and y are considered equal when the relative
-difference between x and y is smaller than the configured epsilon.
-The function cannot be used to compare values smaller than
-approximately 2.22e-16.
-
-For Complex numbers, first the real parts are compared. If equal,
-the imaginary parts are compared.
-
-Strings are compared with a natural sorting algorithm, which
-orders strings in a "logic" way following some heuristics.
-This differs from the function `compare`, which converts the string
-into a numeric value and compares that. The function `compareText`
-on the other hand compares text lexically.
-
-Arrays and Matrices are compared value by value until there is an
-unequal pair of values encountered. Objects are compared by sorted
-keys until the keys or their values are unequal.
-
-
-## Syntax
-
-```js
-math.compareNatural(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | * | First value to compare
-`y` | * | Second value to compare
-
-### Returns
-
-Type | Description
----- | -----------
-number | Returns the result of the comparison: 1 when x > y, -1 when x < y, and 0 when x == y.
-
-
-## Examples
-
-```js
-math.compareNatural(6, 1)              // returns 1
-math.compareNatural(2, 3)              // returns -1
-math.compareNatural(7, 7)              // returns 0
-
-math.compareNatural('10', '2')         // returns 1
-math.compareText('10', '2')            // returns -1
-math.compare('10', '2')                // returns 1
-
-math.compareNatural('Answer: 10', 'Answer: 2') // returns 1
-math.compareText('Answer: 10', 'Answer: 2')    // returns -1
-math.compare('Answer: 10', 'Answer: 2')
-    // Error: Cannot convert "Answer: 10" to a number
-
-const a = math.unit('5 cm')
-const b = math.unit('40 mm')
-math.compareNatural(a, b)              // returns 1
-
-const c = math.complex('2 + 3i')
-const d = math.complex('2 + 4i')
-math.compareNatural(c, d)              // returns -1
-
-math.compareNatural([1, 2, 4], [1, 2, 3]) // returns 1
-math.compareNatural([1, 2, 3], [1, 2])    // returns 1
-math.compareNatural([1, 5], [1, 2, 3])    // returns 1
-math.compareNatural([1, 2], [1, 2])       // returns 0
-
-math.compareNatural({a: 2}, {a: 4})       // returns -1
-```
-
-
-## See also
-
-[compare](compare.md),
-[compareText](compareText.md)

package/docs/reference/functions/compareText.md

@@ -1,48 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function compareText
-
-Compare two strings lexically. Comparison is case sensitive.
-Returns 1 when x > y, -1 when x < y, and 0 when x == y.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.compareText(x, y)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | string &#124; Array &#124; DenseMatrix | First string to compare
-`y` | string &#124; Array &#124; DenseMatrix | Second string to compare
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array &#124; DenseMatrix | Returns the result of the comparison: 1 when x > y, -1 when x < y, and 0 when x == y.
-
-
-## Examples
-
-```js
-math.compareText('B', 'A')     // returns 1
-math.compareText('2', '10')    // returns 1
-math.compare('2', '10')        // returns -1
-math.compareNatural('2', '10') // returns -1
-
-math.compareText('B', ['A', 'B', 'C']) // returns [1, 0, -1]
-```
-
-
-## See also
-
-[equal](equal.md),
-[equalText](equalText.md),
-[compare](compare.md),
-[compareNatural](compareNatural.md)

package/docs/reference/functions/compile.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function compile
-
-Parse and compile an expression.
-Returns a an object with a function `evaluate([scope])` to evaluate the
-compiled expression.
-
-
-## Syntax
-
-```js
-math.compile(expr)                       // returns one node
-math.compile([expr1, expr2, expr3, ...]) // returns an array with nodes
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`expr` | string &#124; string[] &#124; Array &#124; Matrix |  The expression to be compiled
-
-### Returns
-
-Type | Description
----- | -----------
-{evaluate: Function} &#124; Array.&lt;{evaluate: Function}&gt; | code An object with the compiled expression
-
-
-## Examples
-
-```js
-const code1 = math.compile('sqrt(3^2 + 4^2)')
-code1.evaluate() // 5
-
-let scope = {a: 3, b: 4}
-const code2 = math.compile('a * b') // 12
-code2.evaluate(scope) // 12
-scope.a = 5
-code2.evaluate(scope) // 20
-
-const nodes = math.compile(['a = 3', 'b = 4', 'a * b'])
-nodes[2].evaluate() // 12
-```
-
-
-## See also
-
-[parse](parse.md),
-[evaluate](evaluate.md)

package/docs/reference/functions/complex.md

@@ -1,17 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function complex
-
-
-
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`arr` | number[][] | the matrix to find eigenvalues of
-`N` | number | size of the matrix
-`prec` | number &#124; BigNumber | precision, anything lower will be considered zero
-`type` | 'number' &#124; 'BigNumber' &#124; 'Complex' | 
-`findVectors` | boolean | should we find eigenvectors?
-

package/docs/reference/functions/composition.md

@@ -1,40 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function composition
-
-The composition counts of n into k parts.
-
-composition only takes integer arguments.
-The following condition must be enforced: k <= n.
-
-
-## Syntax
-
-```js
-math.composition(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 | Returns the composition counts of n into k parts.
-
-
-## Examples
-
-```js
-math.composition(5, 3) // returns 6
-```
-
-
-## See also
-
-[combinations](combinations.md)

package/docs/reference/functions/concat.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function concat
-
-Concatenate two or more matrices.
-
-
-## Syntax
-
-```js
-math.concat(A, B, C, ...)
-math.concat(A, B, C, ..., dim)
-```
-
-### Where
-
-- `dim: number` is a zero-based dimension over which to concatenate the matrices.
-  By default the last dimension of the matrices.
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`args` | ... Array &#124; Matrix | Two or more matrices
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | Concatenated matrix
-
-
-## Examples
-
-```js
-const A = [[1, 2], [5, 6]]
-const B = [[3, 4], [7, 8]]
-
-math.concat(A, B)                  // returns [[1, 2, 3, 4], [5, 6, 7, 8]]
-math.concat(A, B, 0)               // returns [[1, 2], [5, 6], [3, 4], [7, 8]]
-math.concat('hello', ' ', 'world') // returns 'hello world'
-```
-
-
-## See also
-
-[size](size.md),
-[squeeze](squeeze.md),
-[subset](subset.md),
-[transpose](transpose.md)

package/docs/reference/functions/config.md

@@ -1,44 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function config
-
-Set configuration options for math.js, and get current options.
-Will emit a 'config' event, with arguments (curr, prev, changes).
-
-This function is only available on a mathjs instance created using `create`.
-
-
-## Syntax
-
-```js
-math.config(config: Object): Object
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`options` | Object | Available options: {number} epsilon Minimum relative difference between two compared values, used by all comparison functions. {string} matrix A string 'Matrix' (default) or 'Array'. {string} number A string 'number' (default), 'BigNumber', or 'Fraction' {number} precision The number of significant digits for BigNumbers. Not applicable for Numbers. {string} parenthesis How to display parentheses in LaTeX and string output. {string} randomSeed Random seed for seeded pseudo random number generator. Set to null to randomly seed.
-
-### Returns
-
-Type | Description
----- | -----------
-Object | Returns the current configuration
-
-
-## Examples
-
-```js
-import { create, all } from 'mathjs'
-
-// create a mathjs instance
-const math = create(all)
-
-math.config().number                // outputs 'number'
-math.evaluate('0.4')                // outputs number 0.4
-math.config({number: 'Fraction'})
-math.evaluate('0.4')                // outputs Fraction 2/5
-```
-
-

package/docs/reference/functions/conj.md

@@ -1,44 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function conj
-
-Compute the complex conjugate of a complex value.
-If `x = a+bi`, the complex conjugate of `x` is `a - bi`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.conj(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; Complex &#124; Array &#124; Matrix |  The complex conjugate of x
-
-
-## Examples
-
-```js
-math.conj(math.complex('2 + 3i'))  // returns Complex 2 - 3i
-math.conj(math.complex('2 - 3i'))  // returns Complex 2 + 3i
-math.conj(math.complex('-5.2i'))  // returns Complex 5.2i
-```
-
-
-## See also
-
-[re](re.md),
-[im](im.md),
-[arg](arg.md),
-[abs](abs.md)

package/docs/reference/functions/cos.md

@@ -1,45 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function cos
-
-Calculate the cosine of a value.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.cos(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | Cosine of x
-
-
-## Examples
-
-```js
-math.cos(2)                      // returns number -0.4161468365471422
-math.cos(math.pi / 4)            // returns number  0.7071067811865475
-math.cos(math.unit(180, 'deg'))  // returns number -1
-math.cos(math.unit(60, 'deg'))   // returns number  0.5
-
-const angle = 0.2
-math.pow(math.sin(angle), 2) + math.pow(math.cos(angle), 2) // returns number ~1
-```
-
-
-## See also
-
-[cos](cos.md),
-[tan](tan.md)

package/docs/reference/functions/cosh.md

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

package/docs/reference/functions/cot.md

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

package/docs/reference/functions/coth.md

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

package/docs/reference/functions/count.md

@@ -1,39 +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`.
-
-
-## 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,52 +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`
-
-
-## 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)