mathjs 10.5.2 → 10.5.3

package/docs/reference/functions/multiply.md

@@ -1,60 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function multiply
-
-Multiply two or more values, `x * y`.
-For matrices, the matrix product is calculated.
-
-
-## Syntax
-
-```js
-math.multiply(x, y)
-math.multiply(x, y, z, ...)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | First value to multiply
-`y` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Second value to multiply
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Multiplication of `x` and `y`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.multiply(4, 5.2)        // returns number 20.8
-math.multiply(2, 3, 4)       // returns number 24
-
-const a = math.complex(2, 3)
-const b = math.complex(4, 1)
-math.multiply(a, b)          // returns Complex 5 + 14i
-
-const c = [[1, 2], [4, 3]]
-const d = [[1, 2, 3], [3, -4, 7]]
-math.multiply(c, d)          // returns Array [[7, -6, 17], [13, -4, 33]]
-
-const e = math.unit('2.1 km')
-math.multiply(3, e)          // returns Unit 6.3 km
-```
-
-
-## See also
-
-[divide](divide.md),
-[prod](prod.md),
-[cross](cross.md),
-[dot](dot.md)

package/docs/reference/functions/norm.md

@@ -1,59 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function norm
-
-Calculate the norm of a number, vector or matrix.
-
-The second parameter p is optional. If not provided, it defaults to 2.
-
-
-## Syntax
-
-```js
-math.norm(x)
-math.norm(x, p)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix |  Value for which to calculate the norm
-`p` | number &#124; BigNumber &#124; string |  Vector space. Supported numbers include Infinity and -Infinity. Supported strings are: 'inf', '-inf', and 'fro' (The Frobenius norm) Default value: 2.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber | the p-norm
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.abs(-3.5)                         // returns 3.5
-math.norm(-3.5)                        // returns 3.5
-
-math.norm(math.complex(3, -4))         // returns 5
-
-math.norm([1, 2, -3], Infinity)        // returns 3
-math.norm([1, 2, -3], -Infinity)       // returns 1
-
-math.norm([3, 4], 2)                   // returns 5
-
-math.norm([[1, 2], [3, 4]], 1)          // returns 6
-math.norm([[1, 2], [3, 4]], 'inf')     // returns 7
-math.norm([[1, 2], [3, 4]], 'fro')     // returns 5.477225575051661
-```
-
-
-## See also
-
-[abs](abs.md),
-[hypot](hypot.md)

package/docs/reference/functions/not.md

@@ -1,50 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function not
-
-Logical `not`. Flips boolean value of a given parameter.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.not(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Unit &#124; Array &#124; Matrix | First value to check
-
-### Returns
-
-Type | Description
----- | -----------
-boolean &#124; Array &#124; Matrix |  Returns true when input is a zero or empty value.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.not(2)      // returns false
-math.not(0)      // returns true
-math.not(true)   // returns false
-
-a = [2, -7, 0]
-math.not(a)      // returns [false, false, true]
-```
-
-
-## See also
-
-[and](and.md),
-[or](or.md),
-[xor](xor.md)

package/docs/reference/functions/nthRoot.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function nthRoot
-
-Calculate the nth root of a value.
-The principal nth root of a positive real number A, is the positive real
-solution of the equation
-
-    x^root = A
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.nthRoot(a)
-math.nthRoot(a, root)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a` | number &#124; BigNumber &#124; Array &#124; Matrix &#124; Complex |  Value for which to calculate the nth root
-`root` | number &#124; BigNumber | The root. Default value: 2.
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Complex &#124; Array &#124; Matrix | Returns the nth root of `a`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.nthRoot(9, 2)    // returns 3, as 3^2 == 9
-math.sqrt(9)          // returns 3, as 3^2 == 9
-math.nthRoot(64, 3)   // returns 4, as 4^3 == 64
-```
-
-
-## See also
-
-[sqrt](sqrt.md),
-[pow](pow.md)

package/docs/reference/functions/nthRoots.md

@@ -1,58 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function nthRoots
-
-Calculate the nth roots of a value.
-An nth root of a positive real number A,
-is a positive real solution of the equation "x^root = A".
-This function returns an array of complex values.
-
-
-## Syntax
-
-```js
-math.nthRoots(x)
-math.nthRoots(x, root)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex | Number to be rounded
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex | Rounded value
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.nthRoots(1)
-// returns [
-//   {re: 1, im: 0},
-//   {re: -1, im: 0}
-// ]
-nthRoots(1, 3)
-// returns [
-//   { re: 1, im: 0 },
-//   { re: -0.4999999999999998, im: 0.8660254037844387 },
-//   { re: -0.5000000000000004, im: -0.8660254037844385 }
-]
-```
-
-
-## See also
-
-[nthRoot](nthRoot.md),
-[pow](pow.md),
-[sqrt](sqrt.md)

package/docs/reference/functions/number.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function number
-
-Create a number or convert a string, boolean, or unit to a number.
-When value is a matrix, all elements will be converted to number.
-
-
-## Syntax
-
-```js
-math.number(value)
-math.number(unit, valuelessUnit)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`value` | string &#124; number &#124; BigNumber &#124; Fraction &#124; boolean &#124; Array &#124; Matrix &#124; Unit &#124; null | Value to be converted
-`valuelessUnit` | Unit &#124; string | A valueless unit, used to convert a unit to a number
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Array &#124; Matrix | The created number
-
-
-## Examples
-
-```js
-math.number(2)                         // returns number 2
-math.number('7.2')                     // returns number 7.2
-math.number(true)                      // returns number 1
-math.number([true, false, true, true]) // returns [1, 0, 1, 1]
-math.number(math.unit('52cm'), 'm')    // returns 0.52
-```
-
-
-## See also
-
-[bignumber](bignumber.md),
-[boolean](boolean.md),
-[complex](complex.md),
-[index](index.md),
-[matrix](matrix.md),
-[string](string.md),
-[unit](unit.md)

package/docs/reference/functions/numeric.md

@@ -1,52 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function numeric
-
-Convert a numeric input to a specific numeric type: number, BigNumber, or Fraction.
-
-
-## Syntax
-
-```js
-math.numeric(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`value` | string &#124; number &#124; BigNumber &#124; Fraction |  A numeric value or a string containing a numeric value
-`outputType` | string |  Desired numeric output type. Available values: 'number', 'BigNumber', or 'Fraction'
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction |  Returns an instance of the numeric in the requested type
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.numeric('4')                           // returns number 4
-math.numeric('4', 'number')                 // returns number 4
-math.numeric('4', 'BigNumber')              // returns BigNumber 4
-math.numeric('4', 'Fraction')               // returns Fraction 4
-math.numeric(4, 'Fraction')                 // returns Fraction 4
-math.numeric(math.fraction(2, 5), 'number') // returns number 0.4
-```
-
-
-## See also
-
-[number](number.md),
-[fraction](fraction.md),
-[bignumber](bignumber.md),
-[string](string.md),
-[format](format.md)

package/docs/reference/functions/oct.md

@@ -1,45 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function oct
-
-Format a number as octal.
-
-
-## Syntax
-
-```js
-math.oct(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 "0o70"
-math.oct(56)
-```
-
-
-## See also
-
-[bin](bin.md),
-[hex](hex.md)

package/docs/reference/functions/ones.md

@@ -1,59 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function ones
-
-Create a matrix filled with ones. The created matrix can have one or
-multiple dimensions.
-
-
-## Syntax
-
-```js
-math.ones(m)
-math.ones(m, format)
-math.ones(m, n)
-math.ones(m, n, format)
-math.ones([m, n])
-math.ones([m, n], format)
-math.ones([m, n, p, ...])
-math.ones([m, n, p, ...], format)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`size` | ...number &#124; Array | The size of each dimension of the matrix
-`format` | string | The Matrix storage format
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix &#124; number | A matrix filled with ones
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.ones(3)                   // returns [1, 1, 1]
-math.ones(3, 2)                // returns [[1, 1], [1, 1], [1, 1]]
-math.ones(3, 2, 'dense')       // returns Dense Matrix [[1, 1], [1, 1], [1, 1]]
-
-const A = [[1, 2, 3], [4, 5, 6]]
-math.ones(math.size(A))       // returns [[1, 1, 1], [1, 1, 1]]
-```
-
-
-## See also
-
-[zeros](zeros.md),
-[identity](identity.md),
-[size](size.md),
-[range](range.md)

package/docs/reference/functions/or.md

@@ -1,53 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function or
-
-Logical `or`. Test if at least one value is defined with a nonzero/nonempty value.
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.or(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 one of the inputs is defined with a nonzero/nonempty value.
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.or(2, 4)   // returns true
-
-a = [2, 5, 0]
-b = [0, 22, 0]
-c = 0
-
-math.or(a, b)   // returns [true, true, false]
-math.or(b, c)   // returns [false, true, false]
-```
-
-
-## See also
-
-[and](and.md),
-[not](not.md),
-[xor](xor.md)

package/docs/reference/functions/parse.md

@@ -1,56 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function parse
-
-Parse an expression. Returns a node tree, which can be evaluated by
-invoking node.evaluate().
-
-Note the evaluating arbitrary expressions may involve security risks,
-see [https://mathjs.org/docs/expressions/security.html](https://mathjs.org/docs/expressions/security.html) for more information.
-
-
-## Syntax
-
-```js
-math.parse(expr)
-math.parse(expr, options)
-math.parse([expr1, expr2, expr3, ...])
-math.parse([expr1, expr2, expr3, ...], options)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`expr` | string &#124; string[] &#124; Matrix | Expression to be parsed
-`options` | {nodes: Object&lt;string, Node&gt;} | Available options:</br>- `nodes` a set of custom nodes
-
-### Returns
-
-Type | Description
----- | -----------
-Node &#124; Node[] | node
-
-
-## Examples
-
-```js
-const node1 = math.parse('sqrt(3^2 + 4^2)')
-node1.compile().evaluate() // 5
-
-let scope = {a:3, b:4}
-const node2 = math.parse('a * b') // 12
-const code2 = node2.compile()
-code2.evaluate(scope) // 12
-scope.a = 5
-code2.evaluate(scope) // 20
-
-const nodes = math.parse(['a = 3', 'b = 4', 'a * b'])
-nodes[2].compile().evaluate() // 12
-```
-
-
-## See also
-
-[evaluate](evaluate.md),
-[compile](compile.md)

package/docs/reference/functions/parser.md

@@ -1,70 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function parser
-
-Create a parser. The function creates a new `math.Parser` object.
-
-
-## Syntax
-
-```js
-math.parser()
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-
-
-### Returns
-
-Type | Description
----- | -----------
-Parser | Parser
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-const parser = new math.parser()
-
-// evaluate expressions
-const a = parser.evaluate('sqrt(3^2 + 4^2)') // 5
-const b = parser.evaluate('sqrt(-4)')        // 2i
-const c = parser.evaluate('2 inch in cm')    // 5.08 cm
-const d = parser.evaluate('cos(45 deg)')     // 0.7071067811865476
-
-// define variables and functions
-parser.evaluate('x = 7 / 2')             // 3.5
-parser.evaluate('x + 3')                 // 6.5
-parser.evaluate('f(x, y) = x^y')         // f(x, y)
-parser.evaluate('f(2, 3)')               // 8
-
-// get and set variables and functions
-const x = parser.get('x')                // 7
-const f = parser.get('f')                // function
-const g = f(3, 2)                        // 9
-parser.set('h', 500)
-const i = parser.evaluate('h / 2')       // 250
-parser.set('hello', function (name) {
-  return 'hello, ' + name + '!'
-})
-parser.evaluate('hello("user")')         // "hello, user!"
-
-// clear defined functions and variables
-parser.clear()
-```
-
-
-## See also
-
-[evaluate](evaluate.md),
-[compile](compile.md),
-[parse](parse.md)