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,67 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function compare
|
4
|
-
|
5
|
-
Compare two values. Returns 1 when x > y, -1 when x < y, and 0 when x == y.
|
6
|
-
|
7
|
-
x and y are considered equal when the relative difference between x and y
|
8
|
-
is smaller than the configured epsilon. The function cannot be used to
|
9
|
-
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.compare(x, y)
|
19
|
-
```
|
20
|
-
|
21
|
-
### Parameters
|
22
|
-
|
23
|
-
Parameter | Type | Description
|
24
|
-
--------- | ---- | -----------
|
25
|
-
`x` | number | BigNumber | Fraction | Unit | string | Array | Matrix | First value to compare
|
26
|
-
`y` | number | BigNumber | Fraction | Unit | string | Array | Matrix | Second value to compare
|
27
|
-
|
28
|
-
### Returns
|
29
|
-
|
30
|
-
Type | Description
|
31
|
-
---- | -----------
|
32
|
-
number | BigNumber | Fraction | Array | Matrix | Returns the result of the comparison: 1 when x > y, -1 when x < y, and 0 when x == y.
|
33
|
-
|
34
|
-
|
35
|
-
### Throws
|
36
|
-
|
37
|
-
Type | Description
|
38
|
-
---- | -----------
|
39
|
-
|
40
|
-
|
41
|
-
## Examples
|
42
|
-
|
43
|
-
```js
|
44
|
-
math.compare(6, 1) // returns 1
|
45
|
-
math.compare(2, 3) // returns -1
|
46
|
-
math.compare(7, 7) // returns 0
|
47
|
-
math.compare('10', '2') // returns 1
|
48
|
-
math.compare('1000', '1e3') // returns 0
|
49
|
-
|
50
|
-
const a = math.unit('5 cm')
|
51
|
-
const b = math.unit('40 mm')
|
52
|
-
math.compare(a, b) // returns 1
|
53
|
-
|
54
|
-
math.compare(2, [1, 2, 3]) // returns [1, 0, -1]
|
55
|
-
```
|
56
|
-
|
57
|
-
|
58
|
-
## See also
|
59
|
-
|
60
|
-
[equal](equal.md),
|
61
|
-
[unequal](unequal.md),
|
62
|
-
[smaller](smaller.md),
|
63
|
-
[smallerEq](smallerEq.md),
|
64
|
-
[larger](larger.md),
|
65
|
-
[largerEq](largerEq.md),
|
66
|
-
[compareNatural](compareNatural.md),
|
67
|
-
[compareText](compareText.md)
|
@@ -1,92 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function compareNatural
|
4
|
-
|
5
|
-
Compare two values of any type in a deterministic, natural way.
|
6
|
-
|
7
|
-
For numeric values, the function works the same as `math.compare`.
|
8
|
-
For types of values that can't be compared mathematically,
|
9
|
-
the function compares in a natural way.
|
10
|
-
|
11
|
-
For numeric values, x and y are considered equal when the relative
|
12
|
-
difference between x and y is smaller than the configured epsilon.
|
13
|
-
The function cannot be used to compare values smaller than
|
14
|
-
approximately 2.22e-16.
|
15
|
-
|
16
|
-
For Complex numbers, first the real parts are compared. If equal,
|
17
|
-
the imaginary parts are compared.
|
18
|
-
|
19
|
-
Strings are compared with a natural sorting algorithm, which
|
20
|
-
orders strings in a "logic" way following some heuristics.
|
21
|
-
This differs from the function `compare`, which converts the string
|
22
|
-
into a numeric value and compares that. The function `compareText`
|
23
|
-
on the other hand compares text lexically.
|
24
|
-
|
25
|
-
Arrays and Matrices are compared value by value until there is an
|
26
|
-
unequal pair of values encountered. Objects are compared by sorted
|
27
|
-
keys until the keys or their values are unequal.
|
28
|
-
|
29
|
-
|
30
|
-
## Syntax
|
31
|
-
|
32
|
-
```js
|
33
|
-
math.compareNatural(x, y)
|
34
|
-
```
|
35
|
-
|
36
|
-
### Parameters
|
37
|
-
|
38
|
-
Parameter | Type | Description
|
39
|
-
--------- | ---- | -----------
|
40
|
-
`x` | * | First value to compare
|
41
|
-
`y` | * | Second value to compare
|
42
|
-
|
43
|
-
### Returns
|
44
|
-
|
45
|
-
Type | Description
|
46
|
-
---- | -----------
|
47
|
-
number | Returns the result of the comparison: 1 when x > y, -1 when x < y, and 0 when x == y.
|
48
|
-
|
49
|
-
|
50
|
-
### Throws
|
51
|
-
|
52
|
-
Type | Description
|
53
|
-
---- | -----------
|
54
|
-
|
55
|
-
|
56
|
-
## Examples
|
57
|
-
|
58
|
-
```js
|
59
|
-
math.compareNatural(6, 1) // returns 1
|
60
|
-
math.compareNatural(2, 3) // returns -1
|
61
|
-
math.compareNatural(7, 7) // returns 0
|
62
|
-
|
63
|
-
math.compareNatural('10', '2') // returns 1
|
64
|
-
math.compareText('10', '2') // returns -1
|
65
|
-
math.compare('10', '2') // returns 1
|
66
|
-
|
67
|
-
math.compareNatural('Answer: 10', 'Answer: 2') // returns 1
|
68
|
-
math.compareText('Answer: 10', 'Answer: 2') // returns -1
|
69
|
-
math.compare('Answer: 10', 'Answer: 2')
|
70
|
-
// Error: Cannot convert "Answer: 10" to a number
|
71
|
-
|
72
|
-
const a = math.unit('5 cm')
|
73
|
-
const b = math.unit('40 mm')
|
74
|
-
math.compareNatural(a, b) // returns 1
|
75
|
-
|
76
|
-
const c = math.complex('2 + 3i')
|
77
|
-
const d = math.complex('2 + 4i')
|
78
|
-
math.compareNatural(c, d) // returns -1
|
79
|
-
|
80
|
-
math.compareNatural([1, 2, 4], [1, 2, 3]) // returns 1
|
81
|
-
math.compareNatural([1, 2, 3], [1, 2]) // returns 1
|
82
|
-
math.compareNatural([1, 5], [1, 2, 3]) // returns 1
|
83
|
-
math.compareNatural([1, 2], [1, 2]) // returns 0
|
84
|
-
|
85
|
-
math.compareNatural({a: 2}, {a: 4}) // returns -1
|
86
|
-
```
|
87
|
-
|
88
|
-
|
89
|
-
## See also
|
90
|
-
|
91
|
-
[compare](compare.md),
|
92
|
-
[compareText](compareText.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 compareText
|
4
|
-
|
5
|
-
Compare two strings lexically. Comparison is case sensitive.
|
6
|
-
Returns 1 when x > y, -1 when x < y, and 0 when x == y.
|
7
|
-
|
8
|
-
For matrices, the function is evaluated element wise.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
math.compareText(x, y)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`x` | string | Array | DenseMatrix | First string to compare
|
22
|
-
`y` | string | Array | DenseMatrix | Second string to compare
|
23
|
-
|
24
|
-
### Returns
|
25
|
-
|
26
|
-
Type | Description
|
27
|
-
---- | -----------
|
28
|
-
number | Array | DenseMatrix | Returns the result of the comparison: 1 when x > y, -1 when x < y, and 0 when x == y.
|
29
|
-
|
30
|
-
|
31
|
-
### Throws
|
32
|
-
|
33
|
-
Type | Description
|
34
|
-
---- | -----------
|
35
|
-
|
36
|
-
|
37
|
-
## Examples
|
38
|
-
|
39
|
-
```js
|
40
|
-
math.compareText('B', 'A') // returns 1
|
41
|
-
math.compareText('2', '10') // returns 1
|
42
|
-
math.compare('2', '10') // returns -1
|
43
|
-
math.compareNatural('2', '10') // returns -1
|
44
|
-
|
45
|
-
math.compareText('B', ['A', 'B', 'C']) // returns [1, 0, -1]
|
46
|
-
```
|
47
|
-
|
48
|
-
|
49
|
-
## See also
|
50
|
-
|
51
|
-
[equal](equal.md),
|
52
|
-
[equalText](equalText.md),
|
53
|
-
[compare](compare.md),
|
54
|
-
[compareNatural](compareNatural.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 compile
|
4
|
-
|
5
|
-
Parse and compile an expression.
|
6
|
-
Returns a an object with a function `evaluate([scope])` to evaluate the
|
7
|
-
compiled expression.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.compile(expr) // returns one node
|
14
|
-
math.compile([expr1, expr2, expr3, ...]) // returns an array with nodes
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`expr` | string | string[] | Array | Matrix | The expression to be compiled
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
{evaluate: Function} | Array.<{evaluate: Function}> | code An object with the compiled expression
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
Error |
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
const code1 = math.compile('sqrt(3^2 + 4^2)')
|
40
|
-
code1.evaluate() // 5
|
41
|
-
|
42
|
-
let scope = {a: 3, b: 4}
|
43
|
-
const code2 = math.compile('a * b') // 12
|
44
|
-
code2.evaluate(scope) // 12
|
45
|
-
scope.a = 5
|
46
|
-
code2.evaluate(scope) // 20
|
47
|
-
|
48
|
-
const nodes = math.compile(['a = 3', 'b = 4', 'a * b'])
|
49
|
-
nodes[2].evaluate() // 12
|
50
|
-
```
|
51
|
-
|
52
|
-
|
53
|
-
## See also
|
54
|
-
|
55
|
-
[parse](parse.md),
|
56
|
-
[evaluate](evaluate.md)
|
@@ -1,17 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function complex
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
### Parameters
|
9
|
-
|
10
|
-
Parameter | Type | Description
|
11
|
-
--------- | ---- | -----------
|
12
|
-
`arr` | number[][] | the matrix to find eigenvalues of
|
13
|
-
`N` | number | size of the matrix
|
14
|
-
`prec` | number | BigNumber | precision, anything lower will be considered zero
|
15
|
-
`type` | 'number' | 'BigNumber' | 'Complex' |
|
16
|
-
`findVectors` | boolean | should we find eigenvectors?
|
17
|
-
|
@@ -1,46 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function composition
|
4
|
-
|
5
|
-
The composition counts of n into k parts.
|
6
|
-
|
7
|
-
composition only takes integer arguments.
|
8
|
-
The following condition must be enforced: k <= n.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
math.composition(n, k)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`n` | Number | BigNumber | Total number of objects in the set
|
22
|
-
`k` | Number | BigNumber | Number of objects in the subset
|
23
|
-
|
24
|
-
### Returns
|
25
|
-
|
26
|
-
Type | Description
|
27
|
-
---- | -----------
|
28
|
-
Number | BigNumber | Returns the composition counts of n into k parts.
|
29
|
-
|
30
|
-
|
31
|
-
### Throws
|
32
|
-
|
33
|
-
Type | Description
|
34
|
-
---- | -----------
|
35
|
-
|
36
|
-
|
37
|
-
## Examples
|
38
|
-
|
39
|
-
```js
|
40
|
-
math.composition(5, 3) // returns 6
|
41
|
-
```
|
42
|
-
|
43
|
-
|
44
|
-
## See also
|
45
|
-
|
46
|
-
[combinations](combinations.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 concat
|
4
|
-
|
5
|
-
Concatenate two or more matrices.
|
6
|
-
|
7
|
-
|
8
|
-
## Syntax
|
9
|
-
|
10
|
-
```js
|
11
|
-
math.concat(A, B, C, ...)
|
12
|
-
math.concat(A, B, C, ..., dim)
|
13
|
-
```
|
14
|
-
|
15
|
-
### Where
|
16
|
-
|
17
|
-
- `dim: number` is a zero-based dimension over which to concatenate the matrices.
|
18
|
-
By default the last dimension of the matrices.
|
19
|
-
|
20
|
-
### Parameters
|
21
|
-
|
22
|
-
Parameter | Type | Description
|
23
|
-
--------- | ---- | -----------
|
24
|
-
`args` | ... Array | Matrix | Two or more matrices
|
25
|
-
|
26
|
-
### Returns
|
27
|
-
|
28
|
-
Type | Description
|
29
|
-
---- | -----------
|
30
|
-
Array | Matrix | Concatenated matrix
|
31
|
-
|
32
|
-
|
33
|
-
### Throws
|
34
|
-
|
35
|
-
Type | Description
|
36
|
-
---- | -----------
|
37
|
-
|
38
|
-
|
39
|
-
## Examples
|
40
|
-
|
41
|
-
```js
|
42
|
-
const A = [[1, 2], [5, 6]]
|
43
|
-
const B = [[3, 4], [7, 8]]
|
44
|
-
|
45
|
-
math.concat(A, B) // returns [[1, 2, 3, 4], [5, 6, 7, 8]]
|
46
|
-
math.concat(A, B, 0) // returns [[1, 2], [5, 6], [3, 4], [7, 8]]
|
47
|
-
math.concat('hello', ' ', 'world') // returns 'hello world'
|
48
|
-
```
|
49
|
-
|
50
|
-
|
51
|
-
## See also
|
52
|
-
|
53
|
-
[size](size.md),
|
54
|
-
[squeeze](squeeze.md),
|
55
|
-
[subset](subset.md),
|
56
|
-
[transpose](transpose.md)
|
@@ -1,44 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function config
|
4
|
-
|
5
|
-
Set configuration options for math.js, and get current options.
|
6
|
-
Will emit a 'config' event, with arguments (curr, prev, changes).
|
7
|
-
|
8
|
-
This function is only available on a mathjs instance created using `create`.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
math.config(config: Object): Object
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`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.
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
Object | Returns the current configuration
|
28
|
-
|
29
|
-
|
30
|
-
## Examples
|
31
|
-
|
32
|
-
```js
|
33
|
-
import { create, all } from 'mathjs'
|
34
|
-
|
35
|
-
// create a mathjs instance
|
36
|
-
const math = create(all)
|
37
|
-
|
38
|
-
math.config().number // outputs 'number'
|
39
|
-
math.evaluate('0.4') // outputs number 0.4
|
40
|
-
math.config({number: 'Fraction'})
|
41
|
-
math.evaluate('0.4') // outputs Fraction 2/5
|
42
|
-
```
|
43
|
-
|
44
|
-
|
@@ -1,50 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function conj
|
4
|
-
|
5
|
-
Compute the complex conjugate of a complex value.
|
6
|
-
If `x = a+bi`, the complex conjugate of `x` is `a - bi`.
|
7
|
-
|
8
|
-
For matrices, the function is evaluated element wise.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
math.conj(x)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`x` | number | BigNumber | Complex | Array | Matrix | A complex number or array with complex numbers
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
number | BigNumber | Complex | Array | Matrix | The complex conjugate of x
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
math.conj(math.complex('2 + 3i')) // returns Complex 2 - 3i
|
40
|
-
math.conj(math.complex('2 - 3i')) // returns Complex 2 + 3i
|
41
|
-
math.conj(math.complex('-5.2i')) // returns Complex 5.2i
|
42
|
-
```
|
43
|
-
|
44
|
-
|
45
|
-
## See also
|
46
|
-
|
47
|
-
[re](re.md),
|
48
|
-
[im](im.md),
|
49
|
-
[arg](arg.md),
|
50
|
-
[abs](abs.md)
|
@@ -1,51 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function cos
|
4
|
-
|
5
|
-
Calculate the cosine of a value.
|
6
|
-
|
7
|
-
For matrices, the function is evaluated element wise.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.cos(x)
|
14
|
-
```
|
15
|
-
|
16
|
-
### Parameters
|
17
|
-
|
18
|
-
Parameter | Type | Description
|
19
|
-
--------- | ---- | -----------
|
20
|
-
`x` | number | BigNumber | Complex | Unit | Array | Matrix | Function input
|
21
|
-
|
22
|
-
### Returns
|
23
|
-
|
24
|
-
Type | Description
|
25
|
-
---- | -----------
|
26
|
-
number | BigNumber | Complex | Array | Matrix | Cosine of x
|
27
|
-
|
28
|
-
|
29
|
-
### Throws
|
30
|
-
|
31
|
-
Type | Description
|
32
|
-
---- | -----------
|
33
|
-
|
34
|
-
|
35
|
-
## Examples
|
36
|
-
|
37
|
-
```js
|
38
|
-
math.cos(2) // returns number -0.4161468365471422
|
39
|
-
math.cos(math.pi / 4) // returns number 0.7071067811865475
|
40
|
-
math.cos(math.unit(180, 'deg')) // returns number -1
|
41
|
-
math.cos(math.unit(60, 'deg')) // returns number 0.5
|
42
|
-
|
43
|
-
const angle = 0.2
|
44
|
-
math.pow(math.sin(angle), 2) + math.pow(math.cos(angle), 2) // returns number ~1
|
45
|
-
```
|
46
|
-
|
47
|
-
|
48
|
-
## See also
|
49
|
-
|
50
|
-
[cos](cos.md),
|
51
|
-
[tan](tan.md)
|
@@ -1,46 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function cosh
|
4
|
-
|
5
|
-
Calculate the hyperbolic cosine of a value,
|
6
|
-
defined as `cosh(x) = 1/2 * (exp(x) + exp(-x))`.
|
7
|
-
|
8
|
-
For matrices, the function is evaluated element wise.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
math.cosh(x)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`x` | number | BigNumber | Complex | Unit | Array | Matrix | Function input
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
number | BigNumber | Complex | Array | Matrix | Hyperbolic cosine of x
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
math.cosh(0.5) // returns number 1.1276259652063807
|
40
|
-
```
|
41
|
-
|
42
|
-
|
43
|
-
## See also
|
44
|
-
|
45
|
-
[sinh](sinh.md),
|
46
|
-
[tanh](tanh.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 cot
|
4
|
-
|
5
|
-
Calculate the cotangent of a value. Defined as `cot(x) = 1 / tan(x)`.
|
6
|
-
|
7
|
-
For matrices, the function is evaluated element wise.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.cot(x)
|
14
|
-
```
|
15
|
-
|
16
|
-
### Parameters
|
17
|
-
|
18
|
-
Parameter | Type | Description
|
19
|
-
--------- | ---- | -----------
|
20
|
-
`x` | number | Complex | Unit | Array | Matrix | Function input
|
21
|
-
|
22
|
-
### Returns
|
23
|
-
|
24
|
-
Type | Description
|
25
|
-
---- | -----------
|
26
|
-
number | Complex | Array | Matrix | Cotangent of x
|
27
|
-
|
28
|
-
|
29
|
-
### Throws
|
30
|
-
|
31
|
-
Type | Description
|
32
|
-
---- | -----------
|
33
|
-
|
34
|
-
|
35
|
-
## Examples
|
36
|
-
|
37
|
-
```js
|
38
|
-
math.cot(2) // returns number -0.45765755436028577
|
39
|
-
1 / math.tan(2) // returns number -0.45765755436028577
|
40
|
-
```
|
41
|
-
|
42
|
-
|
43
|
-
## See also
|
44
|
-
|
45
|
-
[tan](tan.md),
|
46
|
-
[sec](sec.md),
|
47
|
-
[csc](csc.md)
|
@@ -1,49 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function coth
|
4
|
-
|
5
|
-
Calculate the hyperbolic cotangent of a value,
|
6
|
-
defined as `coth(x) = 1 / tanh(x)`.
|
7
|
-
|
8
|
-
For matrices, the function is evaluated element wise.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
math.coth(x)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`x` | number | Complex | Unit | Array | Matrix | Function input
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
number | Complex | Array | Matrix | Hyperbolic cotangent of x
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
// coth(x) = 1 / tanh(x)
|
40
|
-
math.coth(2) // returns 1.0373147207275482
|
41
|
-
1 / math.tanh(2) // returns 1.0373147207275482
|
42
|
-
```
|
43
|
-
|
44
|
-
|
45
|
-
## See also
|
46
|
-
|
47
|
-
[sinh](sinh.md),
|
48
|
-
[tanh](tanh.md),
|
49
|
-
[cosh](cosh.md)
|