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,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 simplifyCore
|
4
|
-
|
5
|
-
simplifyCore() performs single pass simplification suitable for
|
6
|
-
applications requiring ultimate performance. In contrast, simplify()
|
7
|
-
extends simplifyCore() with additional passes to provide deeper
|
8
|
-
simplification.
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
simplifyCore(expr)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`node` | Node | The expression to be simplified
|
22
|
-
`options` | Object | Simplification options, as per simplify()
|
23
|
-
|
24
|
-
### Returns
|
25
|
-
|
26
|
-
Type | Description
|
27
|
-
---- | -----------
|
28
|
-
Node | Returns expression with basic simplifications applied
|
29
|
-
|
30
|
-
|
31
|
-
### Throws
|
32
|
-
|
33
|
-
Type | Description
|
34
|
-
---- | -----------
|
35
|
-
|
36
|
-
|
37
|
-
## Examples
|
38
|
-
|
39
|
-
```js
|
40
|
-
const f = math.parse('2 * 1 * x ^ (2 - 1)')
|
41
|
-
math.simpifyCore(f) // Node {2 * x}
|
42
|
-
math.simplify('2 * 1 * x ^ (2 - 1)', [math.simplifyCore]) // Node {2 * x}
|
43
|
-
```
|
44
|
-
|
45
|
-
|
46
|
-
## See also
|
47
|
-
|
48
|
-
[simplify](simplify.md),
|
49
|
-
[resolve](resolve.md),
|
50
|
-
[derivative](derivative.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 sin
|
4
|
-
|
5
|
-
Calculate the sine of a value.
|
6
|
-
|
7
|
-
For matrices, the function is evaluated element wise.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.sin(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 | Sine of x
|
27
|
-
|
28
|
-
|
29
|
-
### Throws
|
30
|
-
|
31
|
-
Type | Description
|
32
|
-
---- | -----------
|
33
|
-
|
34
|
-
|
35
|
-
## Examples
|
36
|
-
|
37
|
-
```js
|
38
|
-
math.sin(2) // returns number 0.9092974268256813
|
39
|
-
math.sin(math.pi / 4) // returns number 0.7071067811865475
|
40
|
-
math.sin(math.unit(90, 'deg')) // returns number 1
|
41
|
-
math.sin(math.unit(30, '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 sinh
|
4
|
-
|
5
|
-
Calculate the hyperbolic sine of a value,
|
6
|
-
defined as `sinh(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.sinh(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 sine of x
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
math.sinh(0.5) // returns number 0.5210953054937474
|
40
|
-
```
|
41
|
-
|
42
|
-
|
43
|
-
## See also
|
44
|
-
|
45
|
-
[cosh](cosh.md),
|
46
|
-
[tanh](tanh.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 size
|
4
|
-
|
5
|
-
Calculate the size of a matrix or scalar.
|
6
|
-
|
7
|
-
|
8
|
-
## Syntax
|
9
|
-
|
10
|
-
```js
|
11
|
-
math.size(x)
|
12
|
-
```
|
13
|
-
|
14
|
-
### Parameters
|
15
|
-
|
16
|
-
Parameter | Type | Description
|
17
|
-
--------- | ---- | -----------
|
18
|
-
`x` | boolean | number | Complex | Unit | string | Array | Matrix | A matrix
|
19
|
-
|
20
|
-
### Returns
|
21
|
-
|
22
|
-
Type | Description
|
23
|
-
---- | -----------
|
24
|
-
Array | Matrix | A vector with size of `x`.
|
25
|
-
|
26
|
-
|
27
|
-
### Throws
|
28
|
-
|
29
|
-
Type | Description
|
30
|
-
---- | -----------
|
31
|
-
|
32
|
-
|
33
|
-
## Examples
|
34
|
-
|
35
|
-
```js
|
36
|
-
math.size(2.3) // returns []
|
37
|
-
math.size('hello world') // returns [11]
|
38
|
-
|
39
|
-
const A = [[1, 2, 3], [4, 5, 6]]
|
40
|
-
math.size(A) // returns [2, 3]
|
41
|
-
math.size(math.range(1,6)) // returns [5]
|
42
|
-
```
|
43
|
-
|
44
|
-
|
45
|
-
## See also
|
46
|
-
|
47
|
-
[count](count.md),
|
48
|
-
[resize](resize.md),
|
49
|
-
[squeeze](squeeze.md),
|
50
|
-
[subset](subset.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 slu
|
4
|
-
|
5
|
-
Calculate the Sparse Matrix LU decomposition with full pivoting. Sparse Matrix `A` is decomposed in two matrices (`L`, `U`) and two permutation vectors (`pinv`, `q`) where
|
6
|
-
|
7
|
-
`P * A * Q = L * U`
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.slu(A, order, threshold)
|
14
|
-
```
|
15
|
-
|
16
|
-
### Parameters
|
17
|
-
|
18
|
-
Parameter | Type | Description
|
19
|
-
--------- | ---- | -----------
|
20
|
-
`A` | SparseMatrix | A two dimensional sparse matrix for which to get the LU decomposition.
|
21
|
-
`order` | Number | The Symbolic Ordering and Analysis order: 0 - Natural ordering, no permutation vector q is returned 1 - Matrix must be square, symbolic ordering and analisis is performed on M = A + A' 2 - Symbolic ordering and analisis is performed on M = A' * A. Dense columns from A' are dropped, A recreated from A'. This is appropriatefor LU factorization of unsymmetric matrices. 3 - Symbolic ordering and analisis is performed on M = A' * A. This is best used for LU factorization is matrix M has no dense rows. A dense row is a row with more than 10*sqr(columns) entries.
|
22
|
-
`threshold` | Number | Partial pivoting threshold (1 for partial pivoting)
|
23
|
-
|
24
|
-
### Returns
|
25
|
-
|
26
|
-
Type | Description
|
27
|
-
---- | -----------
|
28
|
-
Object | The lower triangular matrix, the upper triangular matrix and the permutation vectors.
|
29
|
-
|
30
|
-
|
31
|
-
### Throws
|
32
|
-
|
33
|
-
Type | Description
|
34
|
-
---- | -----------
|
35
|
-
|
36
|
-
|
37
|
-
## Examples
|
38
|
-
|
39
|
-
```js
|
40
|
-
const A = math.sparse([[4,3], [6, 3]])
|
41
|
-
math.slu(A, 1, 0.001)
|
42
|
-
// returns:
|
43
|
-
// {
|
44
|
-
// L: [[1, 0], [1.5, 1]]
|
45
|
-
// U: [[4, 3], [0, -1.5]]
|
46
|
-
// p: [0, 1]
|
47
|
-
// q: [0, 1]
|
48
|
-
// }
|
49
|
-
```
|
50
|
-
|
51
|
-
|
52
|
-
## See also
|
53
|
-
|
54
|
-
[lup](lup.md),
|
55
|
-
[lsolve](lsolve.md),
|
56
|
-
[usolve](usolve.md),
|
57
|
-
[lusolve](lusolve.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 smaller
|
4
|
-
|
5
|
-
Test whether value x is smaller than y.
|
6
|
-
|
7
|
-
The function returns true when x is smaller than y and 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.smaller(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 smaller than y, else returns false
|
33
|
-
|
34
|
-
|
35
|
-
### Throws
|
36
|
-
|
37
|
-
Type | Description
|
38
|
-
---- | -----------
|
39
|
-
|
40
|
-
|
41
|
-
## Examples
|
42
|
-
|
43
|
-
```js
|
44
|
-
math.smaller(2, 3) // returns true
|
45
|
-
math.smaller(5, 2 * 2) // returns false
|
46
|
-
|
47
|
-
const a = math.unit('5 cm')
|
48
|
-
const b = math.unit('2 inch')
|
49
|
-
math.smaller(a, b) // returns true
|
50
|
-
```
|
51
|
-
|
52
|
-
|
53
|
-
## See also
|
54
|
-
|
55
|
-
[equal](equal.md),
|
56
|
-
[unequal](unequal.md),
|
57
|
-
[smallerEq](smallerEq.md),
|
58
|
-
[smaller](smaller.md),
|
59
|
-
[smallerEq](smallerEq.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 smallerEq
|
4
|
-
|
5
|
-
Test whether value x is smaller or equal to y.
|
6
|
-
|
7
|
-
The function returns true when x is smaller 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.smallerEq(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 smaller than y, else returns false
|
33
|
-
|
34
|
-
|
35
|
-
### Throws
|
36
|
-
|
37
|
-
Type | Description
|
38
|
-
---- | -----------
|
39
|
-
|
40
|
-
|
41
|
-
## Examples
|
42
|
-
|
43
|
-
```js
|
44
|
-
math.smaller(1 + 2, 3) // returns false
|
45
|
-
math.smallerEq(1 + 2, 3) // returns true
|
46
|
-
```
|
47
|
-
|
48
|
-
|
49
|
-
## See also
|
50
|
-
|
51
|
-
[equal](equal.md),
|
52
|
-
[unequal](unequal.md),
|
53
|
-
[smaller](smaller.md),
|
54
|
-
[larger](larger.md),
|
55
|
-
[largerEq](largerEq.md),
|
56
|
-
[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 sort
|
4
|
-
|
5
|
-
Sort the items in a matrix.
|
6
|
-
|
7
|
-
|
8
|
-
## Syntax
|
9
|
-
|
10
|
-
```js
|
11
|
-
math.sort(x)
|
12
|
-
math.sort(x, compare)
|
13
|
-
```
|
14
|
-
|
15
|
-
### Parameters
|
16
|
-
|
17
|
-
Parameter | Type | Description
|
18
|
-
--------- | ---- | -----------
|
19
|
-
`x` | Matrix | Array | A one dimensional matrix or array to sort
|
20
|
-
`compare` | Function | 'asc' | 'desc' | 'natural' | An optional _comparator function or name. The function is called as `compare(a, b)`, and must return 1 when a > b, -1 when a < b, and 0 when a == b. Default value: 'asc'.
|
21
|
-
|
22
|
-
### Returns
|
23
|
-
|
24
|
-
Type | Description
|
25
|
-
---- | -----------
|
26
|
-
Matrix | Array | Returns the sorted matrix.
|
27
|
-
|
28
|
-
|
29
|
-
### Throws
|
30
|
-
|
31
|
-
Type | Description
|
32
|
-
---- | -----------
|
33
|
-
|
34
|
-
|
35
|
-
## Examples
|
36
|
-
|
37
|
-
```js
|
38
|
-
math.sort([5, 10, 1]) // returns [1, 5, 10]
|
39
|
-
math.sort(['C', 'B', 'A', 'D'], math.compareNatural)
|
40
|
-
// returns ['A', 'B', 'C', 'D']
|
41
|
-
|
42
|
-
function sortByLength (a, b) {
|
43
|
-
return a.length - b.length
|
44
|
-
}
|
45
|
-
math.sort(['Langdon', 'Tom', 'Sara'], sortByLength)
|
46
|
-
// returns ['Tom', 'Sara', 'Langdon']
|
47
|
-
```
|
48
|
-
|
49
|
-
|
50
|
-
## See also
|
51
|
-
|
52
|
-
[filter](filter.md),
|
53
|
-
[forEach](forEach.md),
|
54
|
-
[map](map.md),
|
55
|
-
[compare](compare.md),
|
56
|
-
[compareNatural](compareNatural.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 sparse
|
4
|
-
|
5
|
-
Create a Sparse Matrix. The function creates a new `math.Matrix` object from
|
6
|
-
an `Array`. A Matrix has utility functions to manipulate the data in the
|
7
|
-
matrix, like getting the size and getting or setting values in the matrix.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.sparse() // creates an empty sparse matrix.
|
14
|
-
math.sparse(data) // creates a sparse matrix with initial data.
|
15
|
-
math.sparse(data, 'number') // creates a sparse matrix with initial data, number datatype.
|
16
|
-
```
|
17
|
-
|
18
|
-
### Parameters
|
19
|
-
|
20
|
-
Parameter | Type | Description
|
21
|
-
--------- | ---- | -----------
|
22
|
-
`data` | Array | Matrix | A two dimensional array
|
23
|
-
|
24
|
-
### Returns
|
25
|
-
|
26
|
-
Type | Description
|
27
|
-
---- | -----------
|
28
|
-
Matrix | The created matrix
|
29
|
-
|
30
|
-
|
31
|
-
## Examples
|
32
|
-
|
33
|
-
```js
|
34
|
-
let m = math.sparse([[1, 2], [3, 4]])
|
35
|
-
m.size() // Array [2, 2]
|
36
|
-
m.resize([3, 2], 5)
|
37
|
-
m.valueOf() // Array [[1, 2], [3, 4], [5, 5]]
|
38
|
-
m.get([1, 0]) // number 3
|
39
|
-
```
|
40
|
-
|
41
|
-
|
42
|
-
## See also
|
43
|
-
|
44
|
-
[bignumber](bignumber.md),
|
45
|
-
[boolean](boolean.md),
|
46
|
-
[complex](complex.md),
|
47
|
-
[index](index.md),
|
48
|
-
[number](number.md),
|
49
|
-
[string](string.md),
|
50
|
-
[unit](unit.md),
|
51
|
-
[matrix](matrix.md)
|
@@ -1,37 +0,0 @@
|
|
1
|
-
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
2
|
-
|
3
|
-
# Function splitUnit
|
4
|
-
|
5
|
-
Split a unit in an array of units whose sum is equal to the original unit.
|
6
|
-
|
7
|
-
|
8
|
-
## Syntax
|
9
|
-
|
10
|
-
```js
|
11
|
-
splitUnit(unit: Unit, parts: Array.<Unit>)
|
12
|
-
```
|
13
|
-
|
14
|
-
### Parameters
|
15
|
-
|
16
|
-
Parameter | Type | Description
|
17
|
-
--------- | ---- | -----------
|
18
|
-
`parts` | Array | An array of strings or valueless units.
|
19
|
-
|
20
|
-
### Returns
|
21
|
-
|
22
|
-
Type | Description
|
23
|
-
---- | -----------
|
24
|
-
Array | An array of units.
|
25
|
-
|
26
|
-
|
27
|
-
## Examples
|
28
|
-
|
29
|
-
```js
|
30
|
-
math.splitUnit(new Unit(1, 'm'), ['feet', 'inch'])
|
31
|
-
// [ 3 feet, 3.3700787401575 inch ]
|
32
|
-
```
|
33
|
-
|
34
|
-
|
35
|
-
## See also
|
36
|
-
|
37
|
-
[unit](unit.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 sqrt
|
4
|
-
|
5
|
-
Calculate the square root of a value.
|
6
|
-
|
7
|
-
For matrices, the function is evaluated element wise.
|
8
|
-
|
9
|
-
|
10
|
-
## Syntax
|
11
|
-
|
12
|
-
```js
|
13
|
-
math.sqrt(x)
|
14
|
-
```
|
15
|
-
|
16
|
-
### Parameters
|
17
|
-
|
18
|
-
Parameter | Type | Description
|
19
|
-
--------- | ---- | -----------
|
20
|
-
`x` | number | BigNumber | Complex | Array | Matrix | Unit | Value for which to calculate the square root.
|
21
|
-
|
22
|
-
### Returns
|
23
|
-
|
24
|
-
Type | Description
|
25
|
-
---- | -----------
|
26
|
-
number | BigNumber | Complex | Array | Matrix | Unit | Returns the square root of `x`
|
27
|
-
|
28
|
-
|
29
|
-
### Throws
|
30
|
-
|
31
|
-
Type | Description
|
32
|
-
---- | -----------
|
33
|
-
|
34
|
-
|
35
|
-
## Examples
|
36
|
-
|
37
|
-
```js
|
38
|
-
math.sqrt(25) // returns 5
|
39
|
-
math.square(5) // returns 25
|
40
|
-
math.sqrt(-4) // returns Complex 2i
|
41
|
-
```
|
42
|
-
|
43
|
-
|
44
|
-
## See also
|
45
|
-
|
46
|
-
[square](square.md),
|
47
|
-
[multiply](multiply.md),
|
48
|
-
[cube](cube.md),
|
49
|
-
[cbrt](cbrt.md),
|
50
|
-
[sqrtm](sqrtm.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 sqrtm
|
4
|
-
|
5
|
-
Calculate the principal square root of a square matrix.
|
6
|
-
The principal square root matrix `X` of another matrix `A` is such that `X * X = A`.
|
7
|
-
|
8
|
-
https://en.wikipedia.org/wiki/Square_root_of_a_matrix
|
9
|
-
|
10
|
-
|
11
|
-
## Syntax
|
12
|
-
|
13
|
-
```js
|
14
|
-
X = math.sqrtm(A)
|
15
|
-
```
|
16
|
-
|
17
|
-
### Parameters
|
18
|
-
|
19
|
-
Parameter | Type | Description
|
20
|
-
--------- | ---- | -----------
|
21
|
-
`A` | Array | Matrix | The square matrix `A`
|
22
|
-
|
23
|
-
### Returns
|
24
|
-
|
25
|
-
Type | Description
|
26
|
-
---- | -----------
|
27
|
-
Array | Matrix | The principal square root of matrix `A`
|
28
|
-
|
29
|
-
|
30
|
-
### Throws
|
31
|
-
|
32
|
-
Type | Description
|
33
|
-
---- | -----------
|
34
|
-
|
35
|
-
|
36
|
-
## Examples
|
37
|
-
|
38
|
-
```js
|
39
|
-
math.sqrtm([[1, 2], [3, 4]]) // returns [[-2, 1], [1.5, -0.5]]
|
40
|
-
```
|
41
|
-
|
42
|
-
|
43
|
-
## See also
|
44
|
-
|
45
|
-
[sqrt](sqrt.md),
|
46
|
-
[pow](pow.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 square
|
4
|
-
|
5
|
-
Compute the square of a value, `x * x`.
|
6
|
-
For matrices, the function is evaluated element wise.
|
7
|
-
|
8
|
-
|
9
|
-
## Syntax
|
10
|
-
|
11
|
-
```js
|
12
|
-
math.square(x)
|
13
|
-
```
|
14
|
-
|
15
|
-
### Parameters
|
16
|
-
|
17
|
-
Parameter | Type | Description
|
18
|
-
--------- | ---- | -----------
|
19
|
-
`x` | number | BigNumber | Fraction | Complex | Array | Matrix | Unit | Number for which to calculate the square
|
20
|
-
|
21
|
-
### Returns
|
22
|
-
|
23
|
-
Type | Description
|
24
|
-
---- | -----------
|
25
|
-
number | BigNumber | Fraction | Complex | Array | Matrix | Unit | Squared value
|
26
|
-
|
27
|
-
|
28
|
-
### Throws
|
29
|
-
|
30
|
-
Type | Description
|
31
|
-
---- | -----------
|
32
|
-
|
33
|
-
|
34
|
-
## Examples
|
35
|
-
|
36
|
-
```js
|
37
|
-
math.square(2) // returns number 4
|
38
|
-
math.square(3) // returns number 9
|
39
|
-
math.pow(3, 2) // returns number 9
|
40
|
-
math.multiply(3, 3) // returns number 9
|
41
|
-
|
42
|
-
math.square([1, 2, 3, 4]) // returns Array [1, 4, 9, 16]
|
43
|
-
```
|
44
|
-
|
45
|
-
|
46
|
-
## See also
|
47
|
-
|
48
|
-
[multiply](multiply.md),
|
49
|
-
[cube](cube.md),
|
50
|
-
[sqrt](sqrt.md),
|
51
|
-
[pow](pow.md)
|