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,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 lcm
|
4
|
-
|
5
|
-
Calculate the least common multiple for two or more values or arrays.
|
6
|
-
|
7
|
-
lcm is defined as:
|
8
|
-
|
9
|
-
lcm(a, b) = abs(a * b) / gcd(a, b)
|
10
|
-
|
11
|
-
For matrices, the function is evaluated element wise.
|
12
|
-
|
13
|
-
|
14
|
-
## Syntax
|
15
|
-
|
16
|
-
```js
|
17
|
-
math.lcm(a, b)
|
18
|
-
math.lcm(a, b, c, ...)
|
19
|
-
```
|
20
|
-
|
21
|
-
### Parameters
|
22
|
-
|
23
|
-
Parameter | Type | Description
|
24
|
-
--------- | ---- | -----------
|
25
|
-
`args` | ... number | BigNumber | Array | Matrix | Two or more integer numbers
|
26
|
-
|
27
|
-
### Returns
|
28
|
-
|
29
|
-
Type | Description
|
30
|
-
---- | -----------
|
31
|
-
number | BigNumber | Array | Matrix | The least common multiple
|
32
|
-
|
33
|
-
|
34
|
-
### Throws
|
35
|
-
|
36
|
-
Type | Description
|
37
|
-
---- | -----------
|
38
|
-
|
39
|
-
|
40
|
-
## Examples
|
41
|
-
|
42
|
-
```js
|
43
|
-
math.lcm(4, 6) // returns 12
|
44
|
-
math.lcm(6, 21) // returns 42
|
45
|
-
math.lcm(6, 21, 5) // returns 210
|
46
|
-
|
47
|
-
math.lcm([4, 6], [6, 21]) // returns [12, 42]
|
48
|
-
```
|
49
|
-
|
50
|
-
|
51
|
-
## See also
|
52
|
-
|
53
|
-
[gcd](gcd.md),
|
54
|
-
[xgcd](xgcd.md)
|
@@ -1,52 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function leafCount
|
4
|
-
|
5
|
-
Gives the number of "leaf nodes" in the parse tree of the given expression
|
6
|
-
A leaf node is one that has no subexpressions, essentially either a
|
7
|
-
symbol or a constant. Note that `5!` has just one leaf, the '5'; the
|
8
|
-
unary factorial operator does not add a leaf. On the other hand,
|
9
|
-
function symbols do add leaves, so `sin(x)/cos(x)` has four leaves.
|
10
|
-
|
11
|
-
The `simplify()` function should generally not increase the `leafCount()`
|
12
|
-
of an expression, although currently there is no guarantee that it never
|
13
|
-
does so. In many cases, `simplify()` reduces the leaf count.
|
14
|
-
|
15
|
-
|
16
|
-
## Syntax
|
17
|
-
|
18
|
-
```js
|
19
|
-
leafCount(expr)
|
20
|
-
```
|
21
|
-
|
22
|
-
### Parameters
|
23
|
-
|
24
|
-
Parameter | Type | Description
|
25
|
-
--------- | ---- | -----------
|
26
|
-
`expr` | Node | string | The expression to count the leaves of
|
27
|
-
|
28
|
-
### Returns
|
29
|
-
|
30
|
-
Type | Description
|
31
|
-
---- | -----------
|
32
|
-
number | The number of leaves of `expr`
|
33
|
-
|
34
|
-
|
35
|
-
### Throws
|
36
|
-
|
37
|
-
Type | Description
|
38
|
-
---- | -----------
|
39
|
-
|
40
|
-
|
41
|
-
## Examples
|
42
|
-
|
43
|
-
```js
|
44
|
-
math.leafCount('x') // 1
|
45
|
-
math.leafCount(math.parse('a*d-b*c')) // 4
|
46
|
-
math.leafCount('[a,b;c,d][0,1]') // 6
|
47
|
-
```
|
48
|
-
|
49
|
-
|
50
|
-
## See also
|
51
|
-
|
52
|
-
[simplify](simplify.md)
|
@@ -1,52 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function leftShift
|
4
|
-
|
5
|
-
Bitwise left logical shift of a value x by y number of bits, `x << y`.
|
6
|
-
For matrices, the function is evaluated element wise.
|
7
|
-
For units, the function is evaluated on the best prefix base.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.leftShift(x, y)
|
14
|
-
```
|
15
|
-
|
16
|
-
### Parameters
|
17
|
-
|
18
|
-
Parameter | Type | Description
|
19
|
-
--------- | ---- | -----------
|
20
|
-
`x` | number | BigNumber | Array | Matrix | Value to be shifted
|
21
|
-
`y` | number | BigNumber | Amount of shifts
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
number | BigNumber | Array | Matrix | `x` shifted left `y` times
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
math.leftShift(1, 2) // returns number 4
|
40
|
-
|
41
|
-
math.leftShift([1, 2, 3], 4) // returns Array [16, 32, 64]
|
42
|
-
```
|
43
|
-
|
44
|
-
|
45
|
-
## See also
|
46
|
-
|
47
|
-
[leftShift](leftShift.md),
|
48
|
-
[bitNot](bitNot.md),
|
49
|
-
[bitOr](bitOr.md),
|
50
|
-
[bitXor](bitXor.md),
|
51
|
-
[rightArithShift](rightArithShift.md),
|
52
|
-
[rightLogShift](rightLogShift.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 lgamma
|
4
|
-
|
5
|
-
Logarithm of the gamma function for real, positive numbers and complex numbers,
|
6
|
-
using Lanczos approximation for numbers and Stirling series for complex numbers.
|
7
|
-
|
8
|
-
|
9
|
-
## Syntax
|
10
|
-
|
11
|
-
```js
|
12
|
-
math.lgamma(n)
|
13
|
-
```
|
14
|
-
|
15
|
-
### Parameters
|
16
|
-
|
17
|
-
Parameter | Type | Description
|
18
|
-
--------- | ---- | -----------
|
19
|
-
`n` | number | Complex | A real or complex number
|
20
|
-
|
21
|
-
### Returns
|
22
|
-
|
23
|
-
Type | Description
|
24
|
-
---- | -----------
|
25
|
-
number | Complex | The log gamma of `n`
|
26
|
-
|
27
|
-
|
28
|
-
### Throws
|
29
|
-
|
30
|
-
Type | Description
|
31
|
-
---- | -----------
|
32
|
-
|
33
|
-
|
34
|
-
## Examples
|
35
|
-
|
36
|
-
```js
|
37
|
-
math.lgamma(5) // returns 3.178053830347945
|
38
|
-
math.lgamma(0) // returns Infinity
|
39
|
-
math.lgamma(-0.5) // returns NaN
|
40
|
-
math.lgamma(math.i) // returns -0.6509231993018536 - 1.8724366472624294i
|
41
|
-
```
|
42
|
-
|
43
|
-
|
44
|
-
## See also
|
45
|
-
|
46
|
-
[gamma](gamma.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 log
|
4
|
-
|
5
|
-
Calculate the logarithm of a value.
|
6
|
-
|
7
|
-
For matrices, the function is evaluated element wise.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.log(x)
|
14
|
-
math.log(x, base)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`x` | number | BigNumber | Complex | Array | Matrix | Value for which to calculate the logarithm.
|
22
|
-
`base` | number | BigNumber | Complex | Optional base for the logarithm. If not provided, the natural logarithm of `x` is calculated. Default value: e.
|
23
|
-
|
24
|
-
### Returns
|
25
|
-
|
26
|
-
Type | Description
|
27
|
-
---- | -----------
|
28
|
-
number | BigNumber | Complex | Array | Matrix | Returns the logarithm of `x`
|
29
|
-
|
30
|
-
|
31
|
-
### Throws
|
32
|
-
|
33
|
-
Type | Description
|
34
|
-
---- | -----------
|
35
|
-
|
36
|
-
|
37
|
-
## Examples
|
38
|
-
|
39
|
-
```js
|
40
|
-
math.log(3.5) // returns 1.252762968495368
|
41
|
-
math.exp(math.log(2.4)) // returns 2.4
|
42
|
-
|
43
|
-
math.pow(10, 4) // returns 10000
|
44
|
-
math.log(10000, 10) // returns 4
|
45
|
-
math.log(10000) / math.log(10) // returns 4
|
46
|
-
|
47
|
-
math.log(1024, 2) // returns 10
|
48
|
-
math.pow(2, 10) // returns 1024
|
49
|
-
```
|
50
|
-
|
51
|
-
|
52
|
-
## See also
|
53
|
-
|
54
|
-
[exp](exp.md),
|
55
|
-
[log2](log2.md),
|
56
|
-
[log10](log10.md),
|
57
|
-
[log1p](log1p.md)
|
@@ -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 log10
|
4
|
-
|
5
|
-
Calculate the 10-base logarithm of a value. This is the same as calculating `log(x, 10)`.
|
6
|
-
|
7
|
-
For matrices, the function is evaluated element wise.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.log10(x)
|
14
|
-
```
|
15
|
-
|
16
|
-
### Parameters
|
17
|
-
|
18
|
-
Parameter | Type | Description
|
19
|
-
--------- | ---- | -----------
|
20
|
-
`x` | number | BigNumber | Complex | Array | Matrix | Value for which to calculate the logarithm.
|
21
|
-
|
22
|
-
### Returns
|
23
|
-
|
24
|
-
Type | Description
|
25
|
-
---- | -----------
|
26
|
-
number | BigNumber | Complex | Array | Matrix | Returns the 10-base logarithm of `x`
|
27
|
-
|
28
|
-
|
29
|
-
### Throws
|
30
|
-
|
31
|
-
Type | Description
|
32
|
-
---- | -----------
|
33
|
-
|
34
|
-
|
35
|
-
## Examples
|
36
|
-
|
37
|
-
```js
|
38
|
-
math.log10(0.00001) // returns -5
|
39
|
-
math.log10(10000) // returns 4
|
40
|
-
math.log(10000) / math.log(10) // returns 4
|
41
|
-
math.pow(10, 4) // returns 10000
|
42
|
-
```
|
43
|
-
|
44
|
-
|
45
|
-
## See also
|
46
|
-
|
47
|
-
[exp](exp.md),
|
48
|
-
[log](log.md),
|
49
|
-
[log1p](log1p.md),
|
50
|
-
[log2](log2.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 log1p
|
4
|
-
|
5
|
-
Calculate the logarithm of a `value+1`.
|
6
|
-
|
7
|
-
For matrices, the function is evaluated element wise.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.log1p(x)
|
14
|
-
math.log1p(x, base)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`x` | number | BigNumber | Complex | Array | Matrix | Value for which to calculate the logarithm of `x+1`.
|
22
|
-
`base` | number | BigNumber | Complex | Optional base for the logarithm. If not provided, the natural logarithm of `x+1` is calculated. Default value: e.
|
23
|
-
|
24
|
-
### Returns
|
25
|
-
|
26
|
-
Type | Description
|
27
|
-
---- | -----------
|
28
|
-
number | BigNumber | Complex | Array | Matrix | Returns the logarithm of `x+1`
|
29
|
-
|
30
|
-
|
31
|
-
### Throws
|
32
|
-
|
33
|
-
Type | Description
|
34
|
-
---- | -----------
|
35
|
-
|
36
|
-
|
37
|
-
## Examples
|
38
|
-
|
39
|
-
```js
|
40
|
-
math.log1p(2.5) // returns 1.252762968495368
|
41
|
-
math.exp(math.log1p(1.4)) // returns 2.4
|
42
|
-
|
43
|
-
math.pow(10, 4) // returns 10000
|
44
|
-
math.log1p(9999, 10) // returns 4
|
45
|
-
math.log1p(9999) / math.log(10) // returns 4
|
46
|
-
```
|
47
|
-
|
48
|
-
|
49
|
-
## See also
|
50
|
-
|
51
|
-
[exp](exp.md),
|
52
|
-
[log](log.md),
|
53
|
-
[log2](log2.md),
|
54
|
-
[log10](log10.md)
|
@@ -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 log2
|
4
|
-
|
5
|
-
Calculate the 2-base of a value. This is the same as calculating `log(x, 2)`.
|
6
|
-
|
7
|
-
For matrices, the function is evaluated element wise.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.log2(x)
|
14
|
-
```
|
15
|
-
|
16
|
-
### Parameters
|
17
|
-
|
18
|
-
Parameter | Type | Description
|
19
|
-
--------- | ---- | -----------
|
20
|
-
`x` | number | BigNumber | Complex | Array | Matrix | Value for which to calculate the logarithm.
|
21
|
-
|
22
|
-
### Returns
|
23
|
-
|
24
|
-
Type | Description
|
25
|
-
---- | -----------
|
26
|
-
number | BigNumber | Complex | Array | Matrix | Returns the 2-base logarithm of `x`
|
27
|
-
|
28
|
-
|
29
|
-
### Throws
|
30
|
-
|
31
|
-
Type | Description
|
32
|
-
---- | -----------
|
33
|
-
|
34
|
-
|
35
|
-
## Examples
|
36
|
-
|
37
|
-
```js
|
38
|
-
math.log2(0.03125) // returns -5
|
39
|
-
math.log2(16) // returns 4
|
40
|
-
math.log2(16) / math.log2(2) // returns 4
|
41
|
-
math.pow(2, 4) // returns 16
|
42
|
-
```
|
43
|
-
|
44
|
-
|
45
|
-
## See also
|
46
|
-
|
47
|
-
[exp](exp.md),
|
48
|
-
[log](log.md),
|
49
|
-
[log1p](log1p.md),
|
50
|
-
[log10](log10.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 lsolve
|
4
|
-
|
5
|
-
Finds one solution of a linear equation system by forwards substitution. Matrix must be a lower triangular matrix. Throws an error if there's no solution.
|
6
|
-
|
7
|
-
`L * x = b`
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.lsolve(L, b)
|
14
|
-
```
|
15
|
-
|
16
|
-
### Parameters
|
17
|
-
|
18
|
-
Parameter | Type | Description
|
19
|
-
--------- | ---- | -----------
|
20
|
-
`L` | Matrix, Array | A N x N matrix or array (L)
|
21
|
-
`b` | Matrix, Array | A column vector with the b values
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
DenseMatrix | Array | A column vector with the linear system solution (x)
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
const a = [[-2, 3], [2, 1]]
|
40
|
-
const b = [11, 9]
|
41
|
-
const x = lsolve(a, b) // [[-5.5], [20]]
|
42
|
-
```
|
43
|
-
|
44
|
-
|
45
|
-
## See also
|
46
|
-
|
47
|
-
[lsolveAll](lsolveAll.md),
|
48
|
-
[lup](lup.md),
|
49
|
-
[slu](slu.md),
|
50
|
-
[usolve](usolve.md),
|
51
|
-
[lusolve](lusolve.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 lsolveAll
|
4
|
-
|
5
|
-
Finds all solutions of a linear equation system by forwards substitution. Matrix must be a lower triangular matrix.
|
6
|
-
|
7
|
-
`L * x = b`
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.lsolveAll(L, b)
|
14
|
-
```
|
15
|
-
|
16
|
-
### Parameters
|
17
|
-
|
18
|
-
Parameter | Type | Description
|
19
|
-
--------- | ---- | -----------
|
20
|
-
`L` | Matrix, Array | A N x N matrix or array (L)
|
21
|
-
`b` | Matrix, Array | A column vector with the b values
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
DenseMatrix[] | Array[] | An array of affine-independent column vectors (x) that solve the linear system
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
const a = [[-2, 3], [2, 1]]
|
40
|
-
const b = [11, 9]
|
41
|
-
const x = lsolveAll(a, b) // [ [[-5.5], [20]] ]
|
42
|
-
```
|
43
|
-
|
44
|
-
|
45
|
-
## See also
|
46
|
-
|
47
|
-
[lsolve](lsolve.md),
|
48
|
-
[lup](lup.md),
|
49
|
-
[slu](slu.md),
|
50
|
-
[usolve](usolve.md),
|
51
|
-
[lusolve](lusolve.md)
|
@@ -1,52 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function lup
|
4
|
-
|
5
|
-
Calculate the Matrix LU decomposition with partial pivoting. Matrix `A` is decomposed in two matrices (`L`, `U`) and a
|
6
|
-
row permutation vector `p` where `A[p,:] = L * U`
|
7
|
-
|
8
|
-
|
9
|
-
## Syntax
|
10
|
-
|
11
|
-
```js
|
12
|
-
math.lup(A)
|
13
|
-
```
|
14
|
-
|
15
|
-
### Parameters
|
16
|
-
|
17
|
-
Parameter | Type | Description
|
18
|
-
--------- | ---- | -----------
|
19
|
-
`A` | Matrix | Array | A two dimensional matrix or array for which to get the LUP decomposition.
|
20
|
-
|
21
|
-
### Returns
|
22
|
-
|
23
|
-
Type | Description
|
24
|
-
---- | -----------
|
25
|
-
{L: Array | Matrix, U: Array | Matrix, P: Array.<number>} | The lower triangular matrix, the upper triangular matrix and the permutation matrix.
|
26
|
-
|
27
|
-
|
28
|
-
### Throws
|
29
|
-
|
30
|
-
Type | Description
|
31
|
-
---- | -----------
|
32
|
-
|
33
|
-
|
34
|
-
## Examples
|
35
|
-
|
36
|
-
```js
|
37
|
-
const m = [[2, 1], [1, 4]]
|
38
|
-
const r = math.lup(m)
|
39
|
-
// r = {
|
40
|
-
// L: [[1, 0], [0.5, 1]],
|
41
|
-
// U: [[2, 1], [0, 3.5]],
|
42
|
-
// P: [0, 1]
|
43
|
-
// }
|
44
|
-
```
|
45
|
-
|
46
|
-
|
47
|
-
## See also
|
48
|
-
|
49
|
-
[slu](slu.md),
|
50
|
-
[lsolve](lsolve.md),
|
51
|
-
[lusolve](lusolve.md),
|
52
|
-
[usolve](usolve.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 lusolve
|
4
|
-
|
5
|
-
Solves the linear system `A * x = b` where `A` is an [n x n] matrix and `b` is a [n] column vector.
|
6
|
-
|
7
|
-
|
8
|
-
## Syntax
|
9
|
-
|
10
|
-
```js
|
11
|
-
math.lusolve(A, b) // returns column vector with the solution to the linear system A * x = b
|
12
|
-
math.lusolve(lup, b) // returns column vector with the solution to the linear system A * x = b, lup = math.lup(A)
|
13
|
-
```
|
14
|
-
|
15
|
-
### Parameters
|
16
|
-
|
17
|
-
Parameter | Type | Description
|
18
|
-
--------- | ---- | -----------
|
19
|
-
`A` | Matrix | Array | Object | Invertible Matrix or the Matrix LU decomposition
|
20
|
-
`b` | Matrix | Array | Column Vector
|
21
|
-
`order` | number | The Symbolic Ordering and Analysis order, see slu for details. Matrix must be a SparseMatrix
|
22
|
-
`threshold` | Number | Partial pivoting threshold (1 for partial pivoting), see slu for details. Matrix must be a SparseMatrix.
|
23
|
-
|
24
|
-
### Returns
|
25
|
-
|
26
|
-
Type | Description
|
27
|
-
---- | -----------
|
28
|
-
DenseMatrix | Array | Column vector with the solution to the linear system A * x = b
|
29
|
-
|
30
|
-
|
31
|
-
### Throws
|
32
|
-
|
33
|
-
Type | Description
|
34
|
-
---- | -----------
|
35
|
-
|
36
|
-
|
37
|
-
## Examples
|
38
|
-
|
39
|
-
```js
|
40
|
-
const m = [[1, 0, 0, 0], [0, 2, 0, 0], [0, 0, 3, 0], [0, 0, 0, 4]]
|
41
|
-
|
42
|
-
const x = math.lusolve(m, [-1, -1, -1, -1]) // x = [[-1], [-0.5], [-1/3], [-0.25]]
|
43
|
-
|
44
|
-
const f = math.lup(m)
|
45
|
-
const x1 = math.lusolve(f, [-1, -1, -1, -1]) // x1 = [[-1], [-0.5], [-1/3], [-0.25]]
|
46
|
-
const x2 = math.lusolve(f, [1, 2, 1, -1]) // x2 = [[1], [1], [1/3], [-0.25]]
|
47
|
-
|
48
|
-
const a = [[-2, 3], [2, 1]]
|
49
|
-
const b = [11, 9]
|
50
|
-
const x = math.lusolve(a, b) // [[2], [5]]
|
51
|
-
```
|
52
|
-
|
53
|
-
|
54
|
-
## See also
|
55
|
-
|
56
|
-
[lup](lup.md),
|
57
|
-
[slu](slu.md),
|
58
|
-
[lsolve](lsolve.md),
|
59
|
-
[usolve](usolve.md)
|
@@ -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 mad
|
4
|
-
|
5
|
-
Compute the median absolute deviation of a matrix or a list with values.
|
6
|
-
The median absolute deviation is defined as the median of the absolute
|
7
|
-
deviations from the median.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.mad(a, b, c, ...)
|
14
|
-
math.mad(A)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`array` | Array | Matrix | A single matrix or multiple scalar values.
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
* | The median absolute deviation.
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
math.mad(10, 20, 30) // returns 10
|
40
|
-
math.mad([1, 2, 3]) // returns 1
|
41
|
-
math.mad([[1, 2, 3], [4, 5, 6]]) // returns 1.5
|
42
|
-
```
|
43
|
-
|
44
|
-
|
45
|
-
## See also
|
46
|
-
|
47
|
-
[median](median.md),
|
48
|
-
[mean](mean.md),
|
49
|
-
[std](std.md),
|
50
|
-
[abs](abs.md)
|