mathjs 10.5.2 → 10.6.1
Sign up to get free protection for your applications and to get access to all the features.
- package/HISTORY.md +28 -0
- package/lib/browser/math.js +6 -5
- package/lib/browser/math.js.map +1 -1
- package/lib/cjs/entry/dependenciesAny/dependenciesFft.generated.js +41 -0
- package/lib/cjs/entry/dependenciesAny/dependenciesIfft.generated.js +29 -0
- package/lib/cjs/entry/dependenciesAny.generated.js +16 -0
- package/lib/cjs/entry/impureFunctionsAny.generated.js +66 -64
- package/lib/cjs/entry/pureFunctionsAny.generated.js +189 -171
- package/lib/cjs/expression/embeddedDocs/embeddedDocs.js +6 -0
- package/lib/cjs/expression/embeddedDocs/function/matrix/fft.js +15 -0
- package/lib/cjs/expression/embeddedDocs/function/matrix/ifft.js +15 -0
- package/lib/cjs/factoriesAny.js +16 -0
- package/lib/cjs/function/algebra/derivative.js +1 -1
- package/lib/cjs/function/matrix/fft.js +128 -0
- package/lib/cjs/function/matrix/ifft.js +49 -0
- package/lib/cjs/header.js +2 -2
- package/lib/cjs/version.js +1 -1
- package/lib/esm/entry/dependenciesAny/dependenciesFft.generated.js +24 -0
- package/lib/esm/entry/dependenciesAny/dependenciesIfft.generated.js +16 -0
- package/lib/esm/entry/dependenciesAny.generated.js +2 -0
- package/lib/esm/entry/impureFunctionsAny.generated.js +63 -61
- package/lib/esm/entry/pureFunctionsAny.generated.js +161 -145
- package/lib/esm/expression/embeddedDocs/embeddedDocs.js +4 -0
- package/lib/esm/expression/embeddedDocs/function/matrix/fft.js +8 -0
- package/lib/esm/expression/embeddedDocs/function/matrix/ifft.js +8 -0
- package/lib/esm/factoriesAny.js +2 -0
- package/lib/esm/function/algebra/derivative.js +1 -1
- package/lib/esm/function/matrix/fft.js +104 -0
- package/lib/esm/function/matrix/ifft.js +38 -0
- package/lib/esm/version.js +1 -1
- package/package.json +22 -24
- package/types/index.d.ts +1052 -283
- package/types/index.ts +711 -7
- package/docs/command_line_interface.md +0 -87
- package/docs/core/chaining.md +0 -41
- package/docs/core/configuration.md +0 -144
- package/docs/core/extension.md +0 -263
- package/docs/core/index.md +0 -21
- package/docs/core/serialization.md +0 -50
- package/docs/custom_bundling.md +0 -116
- package/docs/datatypes/bignumbers.md +0 -102
- package/docs/datatypes/complex_numbers.md +0 -168
- package/docs/datatypes/fractions.md +0 -75
- package/docs/datatypes/index.md +0 -67
- package/docs/datatypes/matrices.md +0 -375
- package/docs/datatypes/numbers.md +0 -106
- package/docs/datatypes/units.md +0 -444
- package/docs/expressions/algebra.md +0 -110
- package/docs/expressions/customization.md +0 -379
- package/docs/expressions/expression_trees.md +0 -710
- package/docs/expressions/html_classes.md +0 -38
- package/docs/expressions/index.md +0 -21
- package/docs/expressions/parsing.md +0 -224
- package/docs/expressions/security.md +0 -89
- package/docs/expressions/syntax.md +0 -706
- package/docs/getting_started.md +0 -124
- package/docs/index.md +0 -39
- package/docs/reference/classes/densematrix.md +0 -247
- package/docs/reference/classes/fibonacciheap.md +0 -70
- package/docs/reference/classes/matrixindex.md +0 -133
- package/docs/reference/classes/matrixrange.md +0 -158
- package/docs/reference/classes/resultset.md +0 -47
- package/docs/reference/classes/sparsematrix.md +0 -245
- package/docs/reference/classes/unit.md +0 -242
- package/docs/reference/classes.md +0 -86
- package/docs/reference/constants.md +0 -29
- package/docs/reference/functions/abs.md +0 -46
- package/docs/reference/functions/acos.md +0 -49
- package/docs/reference/functions/acosh.md +0 -47
- package/docs/reference/functions/acot.md +0 -48
- package/docs/reference/functions/acoth.md +0 -46
- package/docs/reference/functions/acsc.md +0 -49
- package/docs/reference/functions/acsch.md +0 -46
- package/docs/reference/functions/add.md +0 -59
- package/docs/reference/functions/and.md +0 -53
- package/docs/reference/functions/apply.md +0 -56
- package/docs/reference/functions/arg.md +0 -53
- package/docs/reference/functions/asec.md +0 -49
- package/docs/reference/functions/asech.md +0 -46
- package/docs/reference/functions/asin.md +0 -49
- package/docs/reference/functions/asinh.md +0 -46
- package/docs/reference/functions/atan.md +0 -49
- package/docs/reference/functions/atan2.md +0 -56
- package/docs/reference/functions/atanh.md +0 -46
- package/docs/reference/functions/bellNumbers.md +0 -45
- package/docs/reference/functions/bignumber.md +0 -47
- package/docs/reference/functions/bin.md +0 -45
- package/docs/reference/functions/bitAnd.md +0 -51
- package/docs/reference/functions/bitNot.md +0 -51
- package/docs/reference/functions/bitOr.md +0 -52
- package/docs/reference/functions/bitXor.md +0 -51
- package/docs/reference/functions/boolean.md +0 -50
- package/docs/reference/functions/catalan.md +0 -45
- package/docs/reference/functions/cbrt.md +0 -60
- package/docs/reference/functions/ceil.md +0 -63
- package/docs/reference/functions/chain.md +0 -54
- package/docs/reference/functions/clone.md +0 -43
- package/docs/reference/functions/column.md +0 -45
- package/docs/reference/functions/combinations.md +0 -49
- package/docs/reference/functions/combinationsWithRep.md +0 -49
- package/docs/reference/functions/compare.md +0 -67
- package/docs/reference/functions/compareNatural.md +0 -92
- package/docs/reference/functions/compareText.md +0 -54
- package/docs/reference/functions/compile.md +0 -56
- package/docs/reference/functions/complex.md +0 -17
- package/docs/reference/functions/composition.md +0 -46
- package/docs/reference/functions/concat.md +0 -56
- package/docs/reference/functions/config.md +0 -44
- package/docs/reference/functions/conj.md +0 -50
- package/docs/reference/functions/cos.md +0 -51
- package/docs/reference/functions/cosh.md +0 -46
- package/docs/reference/functions/cot.md +0 -47
- package/docs/reference/functions/coth.md +0 -49
- package/docs/reference/functions/count.md +0 -45
- package/docs/reference/functions/createUnit.md +0 -52
- package/docs/reference/functions/cross.md +0 -58
- package/docs/reference/functions/csc.md +0 -47
- package/docs/reference/functions/csch.md +0 -49
- package/docs/reference/functions/ctranspose.md +0 -50
- package/docs/reference/functions/cube.md +0 -51
- package/docs/reference/functions/cumsum.md +0 -57
- package/docs/reference/functions/deepEqual.md +0 -53
- package/docs/reference/functions/derivative.md +0 -61
- package/docs/reference/functions/det.md +0 -49
- package/docs/reference/functions/diag.md +0 -61
- package/docs/reference/functions/diff.md +0 -70
- package/docs/reference/functions/distance.md +0 -80
- package/docs/reference/functions/divide.md +0 -55
- package/docs/reference/functions/dot.md +0 -48
- package/docs/reference/functions/dotDivide.md +0 -52
- package/docs/reference/functions/dotMultiply.md +0 -52
- package/docs/reference/functions/dotPow.md +0 -49
- package/docs/reference/functions/eigs.md +0 -54
- package/docs/reference/functions/equal.md +0 -75
- package/docs/reference/functions/equalText.md +0 -53
- package/docs/reference/functions/erf.md +0 -49
- package/docs/reference/functions/evaluate.md +0 -56
- package/docs/reference/functions/exp.md +0 -54
- package/docs/reference/functions/expm.md +0 -49
- package/docs/reference/functions/expm1.md +0 -54
- package/docs/reference/functions/factorial.md +0 -49
- package/docs/reference/functions/fft.md +0 -35
- package/docs/reference/functions/filter.md +0 -50
- package/docs/reference/functions/fix.md +0 -62
- package/docs/reference/functions/flatten.md +0 -46
- package/docs/reference/functions/floor.md +0 -66
- package/docs/reference/functions/forEach.md +0 -41
- package/docs/reference/functions/format.md +0 -127
- package/docs/reference/functions/fraction.md +0 -45
- package/docs/reference/functions/gamma.md +0 -49
- package/docs/reference/functions/gcd.md +0 -50
- package/docs/reference/functions/getMatrixDataType.md +0 -59
- package/docs/reference/functions/hasNumericValue.md +0 -55
- package/docs/reference/functions/help.md +0 -42
- package/docs/reference/functions/hex.md +0 -45
- package/docs/reference/functions/hypot.md +0 -51
- package/docs/reference/functions/identity.md +0 -57
- package/docs/reference/functions/ifft.md +0 -35
- package/docs/reference/functions/im.md +0 -53
- package/docs/reference/functions/import.md +0 -68
- package/docs/reference/functions/index.md +0 -55
- package/docs/reference/functions/intersect.md +0 -50
- package/docs/reference/functions/inv.md +0 -45
- package/docs/reference/functions/invmod.md +0 -47
- package/docs/reference/functions/isInteger.md +0 -55
- package/docs/reference/functions/isNaN.md +0 -56
- package/docs/reference/functions/isNegative.md +0 -55
- package/docs/reference/functions/isNumeric.md +0 -55
- package/docs/reference/functions/isPositive.md +0 -57
- package/docs/reference/functions/isPrime.md +0 -54
- package/docs/reference/functions/isZero.md +0 -59
- package/docs/reference/functions/kldivergence.md +0 -41
- package/docs/reference/functions/kron.md +0 -53
- package/docs/reference/functions/larger.md +0 -60
- package/docs/reference/functions/largerEq.md +0 -56
- package/docs/reference/functions/lcm.md +0 -54
- package/docs/reference/functions/leafCount.md +0 -52
- package/docs/reference/functions/leftShift.md +0 -52
- package/docs/reference/functions/lgamma.md +0 -46
- package/docs/reference/functions/log.md +0 -57
- package/docs/reference/functions/log10.md +0 -50
- package/docs/reference/functions/log1p.md +0 -54
- package/docs/reference/functions/log2.md +0 -50
- package/docs/reference/functions/lsolve.md +0 -51
- package/docs/reference/functions/lsolveAll.md +0 -51
- package/docs/reference/functions/lup.md +0 -52
- package/docs/reference/functions/lusolve.md +0 -59
- package/docs/reference/functions/mad.md +0 -50
- package/docs/reference/functions/map.md +0 -65
- package/docs/reference/functions/matrix.md +0 -56
- package/docs/reference/functions/matrixFromColumns.md +0 -49
- package/docs/reference/functions/matrixFromFunction.md +0 -54
- package/docs/reference/functions/matrixFromRows.md +0 -49
- package/docs/reference/functions/max.md +0 -61
- package/docs/reference/functions/mean.md +0 -57
- package/docs/reference/functions/median.md +0 -57
- package/docs/reference/functions/min.md +0 -61
- package/docs/reference/functions/mod.md +0 -59
- package/docs/reference/functions/mode.md +0 -50
- package/docs/reference/functions/multinomial.md +0 -46
- package/docs/reference/functions/multiply.md +0 -60
- package/docs/reference/functions/norm.md +0 -59
- package/docs/reference/functions/not.md +0 -50
- package/docs/reference/functions/nthRoot.md +0 -53
- package/docs/reference/functions/nthRoots.md +0 -58
- package/docs/reference/functions/number.md +0 -49
- package/docs/reference/functions/numeric.md +0 -52
- package/docs/reference/functions/oct.md +0 -45
- package/docs/reference/functions/ones.md +0 -59
- package/docs/reference/functions/or.md +0 -53
- package/docs/reference/functions/parse.md +0 -56
- package/docs/reference/functions/parser.md +0 -70
- package/docs/reference/functions/partitionSelect.md +0 -53
- package/docs/reference/functions/permutations.md +0 -51
- package/docs/reference/functions/pickRandom.md +0 -59
- package/docs/reference/functions/pinv.md +0 -44
- package/docs/reference/functions/pow.md +0 -65
- package/docs/reference/functions/print.md +0 -64
- package/docs/reference/functions/prod.md +0 -55
- package/docs/reference/functions/qr.md +0 -65
- package/docs/reference/functions/quantileSeq.md +0 -62
- package/docs/reference/functions/random.md +0 -54
- package/docs/reference/functions/randomInt.md +0 -53
- package/docs/reference/functions/range.md +0 -70
- package/docs/reference/functions/rationalize.md +0 -68
- package/docs/reference/functions/re.md +0 -53
- package/docs/reference/functions/reshape.md +0 -60
- package/docs/reference/functions/resize.md +0 -51
- package/docs/reference/functions/resolve.md +0 -46
- package/docs/reference/functions/rightArithShift.md +0 -52
- package/docs/reference/functions/rightLogShift.md +0 -52
- package/docs/reference/functions/rotate.md +0 -53
- package/docs/reference/functions/rotationMatrix.md +0 -57
- package/docs/reference/functions/round.md +0 -61
- package/docs/reference/functions/row.md +0 -45
- package/docs/reference/functions/sec.md +0 -47
- package/docs/reference/functions/sech.md +0 -49
- package/docs/reference/functions/setCartesian.md +0 -49
- package/docs/reference/functions/setDifference.md +0 -47
- package/docs/reference/functions/setDistinct.md +0 -43
- package/docs/reference/functions/setIntersect.md +0 -46
- package/docs/reference/functions/setIsSubset.md +0 -47
- package/docs/reference/functions/setMultiplicity.md +0 -46
- package/docs/reference/functions/setPowerset.md +0 -43
- package/docs/reference/functions/setSize.md +0 -47
- package/docs/reference/functions/setSymDifference.md +0 -47
- package/docs/reference/functions/setUnion.md +0 -46
- package/docs/reference/functions/sign.md +0 -52
- package/docs/reference/functions/simplify.md +0 -130
- package/docs/reference/functions/simplifyConstant.md +0 -52
- package/docs/reference/functions/simplifyCore.md +0 -50
- package/docs/reference/functions/sin.md +0 -51
- package/docs/reference/functions/sinh.md +0 -46
- package/docs/reference/functions/size.md +0 -50
- package/docs/reference/functions/slu.md +0 -57
- package/docs/reference/functions/smaller.md +0 -60
- package/docs/reference/functions/smallerEq.md +0 -56
- package/docs/reference/functions/sort.md +0 -56
- package/docs/reference/functions/sparse.md +0 -51
- package/docs/reference/functions/splitUnit.md +0 -37
- package/docs/reference/functions/sqrt.md +0 -50
- package/docs/reference/functions/sqrtm.md +0 -46
- package/docs/reference/functions/square.md +0 -51
- package/docs/reference/functions/squeeze.md +0 -53
- package/docs/reference/functions/std.md +0 -76
- package/docs/reference/functions/stirlingS2.md +0 -52
- package/docs/reference/functions/string.md +0 -49
- package/docs/reference/functions/subset.md +0 -65
- package/docs/reference/functions/subtract.md +0 -54
- package/docs/reference/functions/sum.md +0 -54
- package/docs/reference/functions/symbolicEqual.md +0 -62
- package/docs/reference/functions/tan.md +0 -49
- package/docs/reference/functions/tanh.md +0 -50
- package/docs/reference/functions/to.md +0 -47
- package/docs/reference/functions/trace.md +0 -50
- package/docs/reference/functions/transpose.md +0 -49
- package/docs/reference/functions/typeOf.md +0 -81
- package/docs/reference/functions/typed.md +0 -56
- package/docs/reference/functions/unaryMinus.md +0 -49
- package/docs/reference/functions/unaryPlus.md +0 -48
- package/docs/reference/functions/unequal.md +0 -74
- package/docs/reference/functions/unit.md +0 -48
- package/docs/reference/functions/usolve.md +0 -51
- package/docs/reference/functions/usolveAll.md +0 -51
- package/docs/reference/functions/variance.md +0 -78
- package/docs/reference/functions/xgcd.md +0 -47
- package/docs/reference/functions/xor.md +0 -53
- package/docs/reference/functions/zeros.md +0 -57
- package/docs/reference/functions.md +0 -297
- package/docs/reference/index.md +0 -5
- package/examples/advanced/convert_fraction_to_bignumber.js +0 -59
- package/examples/advanced/custom_argument_parsing.js +0 -98
- package/examples/advanced/custom_datatype.js +0 -56
- package/examples/advanced/custom_evaluate_using_factories.js +0 -19
- package/examples/advanced/custom_evaluate_using_import.js +0 -18
- package/examples/advanced/custom_loading.js +0 -33
- package/examples/advanced/custom_relational_functions.js +0 -62
- package/examples/advanced/custom_scope_objects.js +0 -115
- package/examples/advanced/expression_trees.js +0 -55
- package/examples/advanced/function_transform.js +0 -50
- package/examples/advanced/more_secure_eval.js +0 -36
- package/examples/advanced/use_bigint.js +0 -43
- package/examples/advanced/web_server/math_worker.js +0 -24
- package/examples/advanced/web_server/server.js +0 -80
- package/examples/algebra.js +0 -34
- package/examples/basic_usage.js +0 -49
- package/examples/bignumbers.js +0 -52
- package/examples/browser/angle_configuration.html +0 -134
- package/examples/browser/basic_usage.html +0 -39
- package/examples/browser/currency_conversion.html +0 -125
- package/examples/browser/custom_separators.html +0 -81
- package/examples/browser/plot.html +0 -78
- package/examples/browser/pretty_printing_with_mathjax.html +0 -122
- package/examples/browser/printing_html.html +0 -170
- package/examples/browser/requirejs_loading.html +0 -20
- package/examples/browser/rocket_trajectory_optimization.html +0 -301
- package/examples/browser/webworkers/webworkers.html +0 -80
- package/examples/browser/webworkers/worker.js +0 -28
- package/examples/chaining.js +0 -56
- package/examples/complex_numbers.js +0 -67
- package/examples/expressions.js +0 -188
- package/examples/fractions.js +0 -74
- package/examples/import.js +0 -95
- package/examples/matrices.js +0 -101
- package/examples/objects.js +0 -35
- package/examples/package.json +0 -3
- package/examples/serialization.js +0 -16
- package/examples/sparse_matrices.js +0 -19
- package/examples/units.js +0 -108
@@ -1,45 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function inv
|
4
|
-
|
5
|
-
Calculate the inverse of a square matrix.
|
6
|
-
|
7
|
-
|
8
|
-
## Syntax
|
9
|
-
|
10
|
-
```js
|
11
|
-
math.inv(x)
|
12
|
-
```
|
13
|
-
|
14
|
-
### Parameters
|
15
|
-
|
16
|
-
Parameter | Type | Description
|
17
|
-
--------- | ---- | -----------
|
18
|
-
`x` | number | Complex | Array | Matrix | Matrix to be inversed
|
19
|
-
|
20
|
-
### Returns
|
21
|
-
|
22
|
-
Type | Description
|
23
|
-
---- | -----------
|
24
|
-
number | Complex | Array | Matrix | The inverse of `x`.
|
25
|
-
|
26
|
-
|
27
|
-
### Throws
|
28
|
-
|
29
|
-
Type | Description
|
30
|
-
---- | -----------
|
31
|
-
|
32
|
-
|
33
|
-
## Examples
|
34
|
-
|
35
|
-
```js
|
36
|
-
math.inv([[1, 2], [3, 4]]) // returns [[-2, 1], [1.5, -0.5]]
|
37
|
-
math.inv(4) // returns 0.25
|
38
|
-
1 / 4 // returns 0.25
|
39
|
-
```
|
40
|
-
|
41
|
-
|
42
|
-
## See also
|
43
|
-
|
44
|
-
[det](det.md),
|
45
|
-
[transpose](transpose.md)
|
@@ -1,47 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function invmod
|
4
|
-
|
5
|
-
Calculate the (modular) multiplicative inverse of a modulo b. Solution to the equation `ax ≣ 1 (mod b)`
|
6
|
-
See https://en.wikipedia.org/wiki/Modular_multiplicative_inverse.
|
7
|
-
|
8
|
-
|
9
|
-
## Syntax
|
10
|
-
|
11
|
-
```js
|
12
|
-
math.invmod(a, b)
|
13
|
-
```
|
14
|
-
|
15
|
-
### Parameters
|
16
|
-
|
17
|
-
Parameter | Type | Description
|
18
|
-
--------- | ---- | -----------
|
19
|
-
`a` | number | BigNumber | An integer number
|
20
|
-
`b` | number | BigNumber | An integer number
|
21
|
-
|
22
|
-
### Returns
|
23
|
-
|
24
|
-
Type | Description
|
25
|
-
---- | -----------
|
26
|
-
number | BigNumber | Returns an integer number where `invmod(a,b)*a ≣ 1 (mod b)`
|
27
|
-
|
28
|
-
|
29
|
-
### Throws
|
30
|
-
|
31
|
-
Type | Description
|
32
|
-
---- | -----------
|
33
|
-
|
34
|
-
|
35
|
-
## Examples
|
36
|
-
|
37
|
-
```js
|
38
|
-
math.invmod(8, 12) // returns NaN
|
39
|
-
math.invmod(7, 13) // return 2
|
40
|
-
math.invmod(15151, 15122) // returns 10429
|
41
|
-
```
|
42
|
-
|
43
|
-
|
44
|
-
## See also
|
45
|
-
|
46
|
-
[gcd](gcd.md),
|
47
|
-
[xgcd](xgcd.md)
|
@@ -1,55 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function isInteger
|
4
|
-
|
5
|
-
Test whether a value is an integer number.
|
6
|
-
The function supports `number`, `BigNumber`, and `Fraction`.
|
7
|
-
|
8
|
-
The function is evaluated element-wise in case of Array or Matrix input.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
math.isInteger(x)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`x` | number | BigNumber | Fraction | Array | Matrix | Value to be tested
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
boolean | Returns true when `x` contains a numeric, integer value. Throws an error in case of an unknown data type.
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
math.isInteger(2) // returns true
|
40
|
-
math.isInteger(0) // returns true
|
41
|
-
math.isInteger(0.5) // returns false
|
42
|
-
math.isInteger(math.bignumber(500)) // returns true
|
43
|
-
math.isInteger(math.fraction(4)) // returns true
|
44
|
-
math.isInteger('3') // returns true
|
45
|
-
math.isInteger([3, 0.5, -2]) // returns [true, false, true]
|
46
|
-
math.isInteger(math.complex('2-4i') // throws an error
|
47
|
-
```
|
48
|
-
|
49
|
-
|
50
|
-
## See also
|
51
|
-
|
52
|
-
[isNumeric](isNumeric.md),
|
53
|
-
[isPositive](isPositive.md),
|
54
|
-
[isNegative](isNegative.md),
|
55
|
-
[isZero](isZero.md)
|
@@ -1,56 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function isNaN
|
4
|
-
|
5
|
-
Test whether a value is NaN (not a number).
|
6
|
-
The function supports types `number`, `BigNumber`, `Fraction`, `Unit` and `Complex`.
|
7
|
-
|
8
|
-
The function is evaluated element-wise in case of Array or Matrix input.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
math.isNaN(x)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`x` | number | BigNumber | Fraction | Unit | Array | Matrix | Value to be tested
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
boolean | Returns true when `x` is NaN. Throws an error in case of an unknown data type.
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
math.isNaN(3) // returns false
|
40
|
-
math.isNaN(NaN) // returns true
|
41
|
-
math.isNaN(0) // returns false
|
42
|
-
math.isNaN(math.bignumber(NaN)) // returns true
|
43
|
-
math.isNaN(math.bignumber(0)) // returns false
|
44
|
-
math.isNaN(math.fraction(-2, 5)) // returns false
|
45
|
-
math.isNaN('-2') // returns false
|
46
|
-
math.isNaN([2, 0, -3, NaN]') // returns [false, false, false, true]
|
47
|
-
```
|
48
|
-
|
49
|
-
|
50
|
-
## See also
|
51
|
-
|
52
|
-
[isNumeric](isNumeric.md),
|
53
|
-
[isNegative](isNegative.md),
|
54
|
-
[isPositive](isPositive.md),
|
55
|
-
[isZero](isZero.md),
|
56
|
-
[isInteger](isInteger.md)
|
@@ -1,55 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function isNegative
|
4
|
-
|
5
|
-
Test whether a value is negative: smaller than zero.
|
6
|
-
The function supports types `number`, `BigNumber`, `Fraction`, and `Unit`.
|
7
|
-
|
8
|
-
The function is evaluated element-wise in case of Array or Matrix input.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
math.isNegative(x)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`x` | number | BigNumber | Fraction | Unit | Array | Matrix | Value to be tested
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
boolean | Returns true when `x` is larger than zero. Throws an error in case of an unknown data type.
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
math.isNegative(3) // returns false
|
40
|
-
math.isNegative(-2) // returns true
|
41
|
-
math.isNegative(0) // returns false
|
42
|
-
math.isNegative(-0) // returns false
|
43
|
-
math.isNegative(math.bignumber(2)) // returns false
|
44
|
-
math.isNegative(math.fraction(-2, 5)) // returns true
|
45
|
-
math.isNegative('-2') // returns true
|
46
|
-
math.isNegative([2, 0, -3]') // returns [false, false, true]
|
47
|
-
```
|
48
|
-
|
49
|
-
|
50
|
-
## See also
|
51
|
-
|
52
|
-
[isNumeric](isNumeric.md),
|
53
|
-
[isPositive](isPositive.md),
|
54
|
-
[isZero](isZero.md),
|
55
|
-
[isInteger](isInteger.md)
|
@@ -1,55 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function isNumeric
|
4
|
-
|
5
|
-
Test whether a value is an numeric value.
|
6
|
-
|
7
|
-
The function is evaluated element-wise in case of Array or Matrix input.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.isNumeric(x)
|
14
|
-
```
|
15
|
-
|
16
|
-
### Parameters
|
17
|
-
|
18
|
-
Parameter | Type | Description
|
19
|
-
--------- | ---- | -----------
|
20
|
-
`x` | * | Value to be tested
|
21
|
-
|
22
|
-
### Returns
|
23
|
-
|
24
|
-
Type | Description
|
25
|
-
---- | -----------
|
26
|
-
boolean | Returns true when `x` is a `number`, `BigNumber`, `Fraction`, or `boolean`. Returns false for other types. Throws an error in case of unknown types.
|
27
|
-
|
28
|
-
|
29
|
-
### Throws
|
30
|
-
|
31
|
-
Type | Description
|
32
|
-
---- | -----------
|
33
|
-
|
34
|
-
|
35
|
-
## Examples
|
36
|
-
|
37
|
-
```js
|
38
|
-
math.isNumeric(2) // returns true
|
39
|
-
math.isNumeric('2') // returns false
|
40
|
-
math.hasNumericValue('2') // returns true
|
41
|
-
math.isNumeric(0) // returns true
|
42
|
-
math.isNumeric(math.bignumber(500)) // returns true
|
43
|
-
math.isNumeric(math.fraction(4)) // returns true
|
44
|
-
math.isNumeric(math.complex('2-4i') // returns false
|
45
|
-
math.isNumeric([2.3, 'foo', false]) // returns [true, false, true]
|
46
|
-
```
|
47
|
-
|
48
|
-
|
49
|
-
## See also
|
50
|
-
|
51
|
-
[isZero](isZero.md),
|
52
|
-
[isPositive](isPositive.md),
|
53
|
-
[isNegative](isNegative.md),
|
54
|
-
[isInteger](isInteger.md),
|
55
|
-
[hasNumericValue](hasNumericValue.md)
|
@@ -1,57 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function isPositive
|
4
|
-
|
5
|
-
Test whether a value is positive: larger than zero.
|
6
|
-
The function supports types `number`, `BigNumber`, `Fraction`, and `Unit`.
|
7
|
-
|
8
|
-
The function is evaluated element-wise in case of Array or Matrix input.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
math.isPositive(x)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`x` | number | BigNumber | Fraction | Unit | Array | Matrix | Value to be tested
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
boolean | Returns true when `x` is larger than zero. Throws an error in case of an unknown data type.
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
math.isPositive(3) // returns true
|
40
|
-
math.isPositive(-2) // returns false
|
41
|
-
math.isPositive(0) // returns false
|
42
|
-
math.isPositive(-0) // returns false
|
43
|
-
math.isPositive(0.5) // returns true
|
44
|
-
math.isPositive(math.bignumber(2)) // returns true
|
45
|
-
math.isPositive(math.fraction(-2, 5)) // returns false
|
46
|
-
math.isPositive(math.fraction(1,3)) // returns false
|
47
|
-
math.isPositive('2') // returns true
|
48
|
-
math.isPositive([2, 0, -3]) // returns [true, false, false]
|
49
|
-
```
|
50
|
-
|
51
|
-
|
52
|
-
## See also
|
53
|
-
|
54
|
-
[isNumeric](isNumeric.md),
|
55
|
-
[isZero](isZero.md),
|
56
|
-
[isNegative](isNegative.md),
|
57
|
-
[isInteger](isInteger.md)
|
@@ -1,54 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function isPrime
|
4
|
-
|
5
|
-
Test whether a value is prime: has no divisors other than itself and one.
|
6
|
-
The function supports type `number`, `bignumber`.
|
7
|
-
|
8
|
-
The function is evaluated element-wise in case of Array or Matrix input.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
math.isPrime(x)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`x` | number | BigNumber | Array | Matrix | Value to be tested
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
boolean | Returns true when `x` is larger than zero. Throws an error in case of an unknown data type.
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
math.isPrime(3) // returns true
|
40
|
-
math.isPrime(-2) // returns false
|
41
|
-
math.isPrime(0) // returns false
|
42
|
-
math.isPrime(-0) // returns false
|
43
|
-
math.isPrime(0.5) // returns false
|
44
|
-
math.isPrime('2') // returns true
|
45
|
-
math.isPrime([2, 17, 100]) // returns [true, true, false]
|
46
|
-
```
|
47
|
-
|
48
|
-
|
49
|
-
## See also
|
50
|
-
|
51
|
-
[isNumeric](isNumeric.md),
|
52
|
-
[isZero](isZero.md),
|
53
|
-
[isNegative](isNegative.md),
|
54
|
-
[isInteger](isInteger.md)
|
@@ -1,59 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function isZero
|
4
|
-
|
5
|
-
Test whether a value is zero.
|
6
|
-
The function can check for zero for types `number`, `BigNumber`, `Fraction`,
|
7
|
-
`Complex`, and `Unit`.
|
8
|
-
|
9
|
-
The function is evaluated element-wise in case of Array or Matrix input.
|
10
|
-
|
11
|
-
|
12
|
-
## Syntax
|
13
|
-
|
14
|
-
```js
|
15
|
-
math.isZero(x)
|
16
|
-
```
|
17
|
-
|
18
|
-
### Parameters
|
19
|
-
|
20
|
-
Parameter | Type | Description
|
21
|
-
--------- | ---- | -----------
|
22
|
-
`x` | number | BigNumber | Complex | Fraction | Unit | Array | Matrix | Value to be tested
|
23
|
-
|
24
|
-
### Returns
|
25
|
-
|
26
|
-
Type | Description
|
27
|
-
---- | -----------
|
28
|
-
boolean | Returns true when `x` is zero. Throws an error in case of an unknown data type.
|
29
|
-
|
30
|
-
|
31
|
-
### Throws
|
32
|
-
|
33
|
-
Type | Description
|
34
|
-
---- | -----------
|
35
|
-
|
36
|
-
|
37
|
-
## Examples
|
38
|
-
|
39
|
-
```js
|
40
|
-
math.isZero(0) // returns true
|
41
|
-
math.isZero(2) // returns false
|
42
|
-
math.isZero(0.5) // returns false
|
43
|
-
math.isZero(math.bignumber(0)) // returns true
|
44
|
-
math.isZero(math.fraction(0)) // returns true
|
45
|
-
math.isZero(math.fraction(1,3)) // returns false
|
46
|
-
math.isZero(math.complex('2 - 4i') // returns false
|
47
|
-
math.isZero(math.complex('0i') // returns true
|
48
|
-
math.isZero('0') // returns true
|
49
|
-
math.isZero('2') // returns false
|
50
|
-
math.isZero([2, 0, -3]') // returns [false, true, false]
|
51
|
-
```
|
52
|
-
|
53
|
-
|
54
|
-
## See also
|
55
|
-
|
56
|
-
[isNumeric](isNumeric.md),
|
57
|
-
[isPositive](isPositive.md),
|
58
|
-
[isNegative](isNegative.md),
|
59
|
-
[isInteger](isInteger.md)
|
@@ -1,41 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function kldivergence
|
4
|
-
|
5
|
-
Calculate the Kullback-Leibler (KL) divergence between two distributions
|
6
|
-
|
7
|
-
|
8
|
-
## Syntax
|
9
|
-
|
10
|
-
```js
|
11
|
-
math.kldivergence(x, y)
|
12
|
-
```
|
13
|
-
|
14
|
-
### Parameters
|
15
|
-
|
16
|
-
Parameter | Type | Description
|
17
|
-
--------- | ---- | -----------
|
18
|
-
`q` | Array | Matrix | First vector
|
19
|
-
`p` | Array | Matrix | Second vector
|
20
|
-
|
21
|
-
### Returns
|
22
|
-
|
23
|
-
Type | Description
|
24
|
-
---- | -----------
|
25
|
-
number | Returns distance between q and p
|
26
|
-
|
27
|
-
|
28
|
-
### Throws
|
29
|
-
|
30
|
-
Type | Description
|
31
|
-
---- | -----------
|
32
|
-
|
33
|
-
|
34
|
-
## Examples
|
35
|
-
|
36
|
-
```js
|
37
|
-
math.kldivergence([0.7,0.5,0.4], [0.2,0.9,0.5]) //returns 0.24376698773121153
|
38
|
-
|
39
|
-
```
|
40
|
-
|
41
|
-
|
@@ -1,53 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function kron
|
4
|
-
|
5
|
-
Calculates the kronecker product of 2 matrices or vectors.
|
6
|
-
|
7
|
-
NOTE: If a one dimensional vector / matrix is given, it will be
|
8
|
-
wrapped so its two dimensions.
|
9
|
-
See the examples.
|
10
|
-
|
11
|
-
|
12
|
-
## Syntax
|
13
|
-
|
14
|
-
```js
|
15
|
-
math.kron(x, y)
|
16
|
-
```
|
17
|
-
|
18
|
-
### Parameters
|
19
|
-
|
20
|
-
Parameter | Type | Description
|
21
|
-
--------- | ---- | -----------
|
22
|
-
`x` | Array | Matrix | First vector
|
23
|
-
`y` | Array | Matrix | Second vector
|
24
|
-
|
25
|
-
### Returns
|
26
|
-
|
27
|
-
Type | Description
|
28
|
-
---- | -----------
|
29
|
-
Array | Matrix | Returns the kronecker product of `x` and `y`
|
30
|
-
|
31
|
-
|
32
|
-
### Throws
|
33
|
-
|
34
|
-
Type | Description
|
35
|
-
---- | -----------
|
36
|
-
|
37
|
-
|
38
|
-
## Examples
|
39
|
-
|
40
|
-
```js
|
41
|
-
math.kron([[1, 0], [0, 1]], [[1, 2], [3, 4]])
|
42
|
-
// returns [ [ 1, 2, 0, 0 ], [ 3, 4, 0, 0 ], [ 0, 0, 1, 2 ], [ 0, 0, 3, 4 ] ]
|
43
|
-
|
44
|
-
math.kron([1,1], [2,3,4])
|
45
|
-
// returns [ [ 2, 3, 4, 2, 3, 4 ] ]
|
46
|
-
```
|
47
|
-
|
48
|
-
|
49
|
-
## See also
|
50
|
-
|
51
|
-
[multiply](multiply.md),
|
52
|
-
[dot](dot.md),
|
53
|
-
[cross](cross.md)
|
@@ -1,60 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function larger
|
4
|
-
|
5
|
-
Test whether value x is larger than y.
|
6
|
-
|
7
|
-
The function returns true when x is larger than y and the relative
|
8
|
-
difference between x and y is larger than the configured epsilon. The
|
9
|
-
function cannot be used to compare values smaller than approximately 2.22e-16.
|
10
|
-
|
11
|
-
For matrices, the function is evaluated element wise.
|
12
|
-
Strings are compared by their numerical value.
|
13
|
-
|
14
|
-
|
15
|
-
## Syntax
|
16
|
-
|
17
|
-
```js
|
18
|
-
math.larger(x, y)
|
19
|
-
```
|
20
|
-
|
21
|
-
### Parameters
|
22
|
-
|
23
|
-
Parameter | Type | Description
|
24
|
-
--------- | ---- | -----------
|
25
|
-
`x` | number | BigNumber | Fraction | boolean | Unit | string | Array | Matrix | First value to compare
|
26
|
-
`y` | number | BigNumber | Fraction | boolean | Unit | string | Array | Matrix | Second value to compare
|
27
|
-
|
28
|
-
### Returns
|
29
|
-
|
30
|
-
Type | Description
|
31
|
-
---- | -----------
|
32
|
-
boolean | Array | Matrix | Returns true when the x is larger than y, else returns false
|
33
|
-
|
34
|
-
|
35
|
-
### Throws
|
36
|
-
|
37
|
-
Type | Description
|
38
|
-
---- | -----------
|
39
|
-
|
40
|
-
|
41
|
-
## Examples
|
42
|
-
|
43
|
-
```js
|
44
|
-
math.larger(2, 3) // returns false
|
45
|
-
math.larger(5, 2 + 2) // returns true
|
46
|
-
|
47
|
-
const a = math.unit('5 cm')
|
48
|
-
const b = math.unit('2 inch')
|
49
|
-
math.larger(a, b) // returns false
|
50
|
-
```
|
51
|
-
|
52
|
-
|
53
|
-
## See also
|
54
|
-
|
55
|
-
[equal](equal.md),
|
56
|
-
[unequal](unequal.md),
|
57
|
-
[smaller](smaller.md),
|
58
|
-
[smallerEq](smallerEq.md),
|
59
|
-
[largerEq](largerEq.md),
|
60
|
-
[compare](compare.md)
|
@@ -1,56 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function largerEq
|
4
|
-
|
5
|
-
Test whether value x is larger or equal to y.
|
6
|
-
|
7
|
-
The function returns true when x is larger than y or the relative
|
8
|
-
difference between x and y is smaller than the configured epsilon. The
|
9
|
-
function cannot be used to compare values smaller than approximately 2.22e-16.
|
10
|
-
|
11
|
-
For matrices, the function is evaluated element wise.
|
12
|
-
Strings are compared by their numerical value.
|
13
|
-
|
14
|
-
|
15
|
-
## Syntax
|
16
|
-
|
17
|
-
```js
|
18
|
-
math.largerEq(x, y)
|
19
|
-
```
|
20
|
-
|
21
|
-
### Parameters
|
22
|
-
|
23
|
-
Parameter | Type | Description
|
24
|
-
--------- | ---- | -----------
|
25
|
-
`x` | number | BigNumber | Fraction | boolean | Unit | string | Array | Matrix | First value to compare
|
26
|
-
`y` | number | BigNumber | Fraction | boolean | Unit | string | Array | Matrix | Second value to compare
|
27
|
-
|
28
|
-
### Returns
|
29
|
-
|
30
|
-
Type | Description
|
31
|
-
---- | -----------
|
32
|
-
boolean | Array | Matrix | Returns true when the x is larger or equal to y, else returns false
|
33
|
-
|
34
|
-
|
35
|
-
### Throws
|
36
|
-
|
37
|
-
Type | Description
|
38
|
-
---- | -----------
|
39
|
-
|
40
|
-
|
41
|
-
## Examples
|
42
|
-
|
43
|
-
```js
|
44
|
-
math.larger(2, 1 + 1) // returns false
|
45
|
-
math.largerEq(2, 1 + 1) // returns true
|
46
|
-
```
|
47
|
-
|
48
|
-
|
49
|
-
## See also
|
50
|
-
|
51
|
-
[equal](equal.md),
|
52
|
-
[unequal](unequal.md),
|
53
|
-
[smaller](smaller.md),
|
54
|
-
[smallerEq](smallerEq.md),
|
55
|
-
[larger](larger.md),
|
56
|
-
[compare](compare.md)
|