mathjs 10.5.2 → 10.6.1

package/docs/reference/functions/setCartesian.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function setCartesian
-
-Create the cartesian product of two (multi)sets.
-Multi-dimension arrays will be converted to single-dimension arrays
-and the values will be sorted in ascending order before the operation.
-
-
-## Syntax
-
-```js
-math.setCartesian(set1, set2)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a1` | Array &#124; Matrix | A (multi)set
-`a2` | Array &#124; Matrix | A (multi)set
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | The cartesian product of two (multi)sets
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.setCartesian([1, 2], [3, 4])        // returns [[1, 3], [1, 4], [2, 3], [2, 4]]
-math.setCartesian([4, 3], [2, 1])        // returns [[3, 1], [3, 2], [4, 1], [4, 2]]
-```
-
-
-## See also
-
-[setUnion](setUnion.md),
-[setIntersect](setIntersect.md),
-[setDifference](setDifference.md),
-[setPowerset](setPowerset.md)

package/docs/reference/functions/setDifference.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function setDifference
-
-Create the difference of two (multi)sets: every element of set1, that is not the element of set2.
-Multi-dimension arrays will be converted to single-dimension arrays before the operation.
-
-
-## Syntax
-
-```js
-math.setDifference(set1, set2)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a1` | Array &#124; Matrix | A (multi)set
-`a2` | Array &#124; Matrix | A (multi)set
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | The difference of two (multi)sets
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.setDifference([1, 2, 3, 4], [3, 4, 5, 6])            // returns [1, 2]
-math.setDifference([[1, 2], [3, 4]], [[3, 4], [5, 6]])    // returns [1, 2]
-```
-
-
-## See also
-
-[setUnion](setUnion.md),
-[setIntersect](setIntersect.md),
-[setSymDifference](setSymDifference.md)

package/docs/reference/functions/setDistinct.md

@@ -1,43 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function setDistinct
-
-Collect the distinct elements of a multiset.
-A multi-dimension array will be converted to a single-dimension array before the operation.
-
-
-## Syntax
-
-```js
-math.setDistinct(set)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a` | Array &#124; Matrix | A multiset
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | A set containing the distinc elements of the multiset
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.setDistinct([1, 1, 1, 2, 2, 3])        // returns [1, 2, 3]
-```
-
-
-## See also
-
-[setMultiplicity](setMultiplicity.md)

package/docs/reference/functions/setIntersect.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function setIntersect
-
-Create the intersection of two (multi)sets.
-Multi-dimension arrays will be converted to single-dimension arrays before the operation.
-
-
-## Syntax
-
-```js
-math.setIntersect(set1, set2)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a1` | Array &#124; Matrix | A (multi)set
-`a2` | Array &#124; Matrix | A (multi)set
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | The intersection of two (multi)sets
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.setIntersect([1, 2, 3, 4], [3, 4, 5, 6])            // returns [3, 4]
-math.setIntersect([[1, 2], [3, 4]], [[3, 4], [5, 6]])    // returns [3, 4]
-```
-
-
-## See also
-
-[setUnion](setUnion.md),
-[setDifference](setDifference.md)

package/docs/reference/functions/setIsSubset.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function setIsSubset
-
-Check whether a (multi)set is a subset of another (multi)set. (Every element of set1 is the element of set2.)
-Multi-dimension arrays will be converted to single-dimension arrays before the operation.
-
-
-## Syntax
-
-```js
-math.setIsSubset(set1, set2)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a1` | Array &#124; Matrix | A (multi)set
-`a2` | Array &#124; Matrix | A (multi)set
-
-### Returns
-
-Type | Description
----- | -----------
-boolean | true | false
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.setIsSubset([1, 2], [3, 4, 5, 6])        // returns false
-math.setIsSubset([3, 4], [3, 4, 5, 6])        // returns true
-```
-
-
-## See also
-
-[setUnion](setUnion.md),
-[setIntersect](setIntersect.md),
-[setDifference](setDifference.md)

package/docs/reference/functions/setMultiplicity.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function setMultiplicity
-
-Count the multiplicity of an element in a multiset.
-A multi-dimension array will be converted to a single-dimension array before the operation.
-
-
-## Syntax
-
-```js
-math.setMultiplicity(element, set)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`e` | number &#124; BigNumber &#124; Fraction &#124; Complex | An element in the multiset
-`a` | Array &#124; Matrix | A multiset
-
-### Returns
-
-Type | Description
----- | -----------
-number | The number of how many times the multiset contains the element
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.setMultiplicity(1, [1, 2, 2, 4])    // returns 1
-math.setMultiplicity(2, [1, 2, 2, 4])    // returns 2
-```
-
-
-## See also
-
-[setDistinct](setDistinct.md),
-[setSize](setSize.md)

package/docs/reference/functions/setPowerset.md

@@ -1,43 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function setPowerset
-
-Create the powerset of a (multi)set. (The powerset contains very possible subsets of a (multi)set.)
-A multi-dimension array will be converted to a single-dimension array before the operation.
-
-
-## Syntax
-
-```js
-math.setPowerset(set)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a` | Array &#124; Matrix | A (multi)set
-
-### Returns
-
-Type | Description
----- | -----------
-Array | The powerset of the (multi)set
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.setPowerset([1, 2, 3])        // returns [[], [1], [2], [3], [1, 2], [1, 3], [2, 3], [1, 2, 3]]
-```
-
-
-## See also
-
-[setCartesian](setCartesian.md)

package/docs/reference/functions/setSize.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function setSize
-
-Count the number of elements of a (multi)set. When a second parameter is 'true', count only the unique values.
-A multi-dimension array will be converted to a single-dimension array before the operation.
-
-
-## Syntax
-
-```js
-math.setSize(set)
-math.setSize(set, unique)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a` | Array &#124; Matrix | A multiset
-
-### Returns
-
-Type | Description
----- | -----------
-number | The number of elements of the (multi)set
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.setSize([1, 2, 2, 4])          // returns 4
-math.setSize([1, 2, 2, 4], true)    // returns 3
-```
-
-
-## See also
-
-[setUnion](setUnion.md),
-[setIntersect](setIntersect.md),
-[setDifference](setDifference.md)

package/docs/reference/functions/setSymDifference.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function setSymDifference
-
-Create the symmetric difference of two (multi)sets.
-Multi-dimension arrays will be converted to single-dimension arrays before the operation.
-
-
-## Syntax
-
-```js
-math.setSymDifference(set1, set2)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a1` | Array &#124; Matrix | A (multi)set
-`a2` | Array &#124; Matrix | A (multi)set
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | The symmetric difference of two (multi)sets
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.setSymDifference([1, 2, 3, 4], [3, 4, 5, 6])            // returns [1, 2, 5, 6]
-math.setSymDifference([[1, 2], [3, 4]], [[3, 4], [5, 6]])    // returns [1, 2, 5, 6]
-```
-
-
-## See also
-
-[setUnion](setUnion.md),
-[setIntersect](setIntersect.md),
-[setDifference](setDifference.md)

package/docs/reference/functions/setUnion.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function setUnion
-
-Create the union of two (multi)sets.
-Multi-dimension arrays will be converted to single-dimension arrays before the operation.
-
-
-## Syntax
-
-```js
-math.setUnion(set1, set2)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`a1` | Array &#124; Matrix | A (multi)set
-`a2` | Array &#124; Matrix | A (multi)set
-
-### Returns
-
-Type | Description
----- | -----------
-Array &#124; Matrix | The union of two (multi)sets
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.setUnion([1, 2, 3, 4], [3, 4, 5, 6])            // returns [1, 2, 3, 4, 5, 6]
-math.setUnion([[1, 2], [3, 4]], [[3, 4], [5, 6]])    // returns [1, 2, 3, 4, 5, 6]
-```
-
-
-## See also
-
-[setIntersect](setIntersect.md),
-[setDifference](setDifference.md)

package/docs/reference/functions/sign.md

@@ -1,52 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function sign
-
-Compute the sign of a value. The sign of a value x is:
-
--  1 when x > 0
-- -1 when x < 0
--  0 when x == 0
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.sign(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix &#124; Unit |  The number for which to determine the sign
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix &#124; Unit | e The sign of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.sign(3.5)               // returns 1
-math.sign(-4.2)              // returns -1
-math.sign(0)                 // returns 0
-
-math.sign([3, 5, -2, 0, 2])  // returns [1, 1, -1, 0, 1]
-```
-
-
-## See also
-
-[abs](abs.md)

package/docs/reference/functions/simplify.md

@@ -1,130 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function simplify
-
-Simplify an expression tree.
-
-A list of rules are applied to an expression, repeating over the list until
-no further changes are made.
-It's possible to pass a custom set of rules to the function as second
-argument. A rule can be specified as an object, string, or function:
-
-    const rules = [
-      { l: 'n1*n3 + n2*n3', r: '(n1+n2)*n3' },
-      'n1*n3 + n2*n3 -> (n1+n2)*n3',
-      function (node) {
-        // ... return a new node or return the node unchanged
-        return node
-      }
-    ]
-
-String and object rules consist of a left and right pattern. The left is
-used to match against the expression and the right determines what matches
-are replaced with. The main difference between a pattern and a normal
-expression is that variables starting with the following characters are
-interpreted as wildcards:
-
-- 'n' - matches any Node
-- 'c' - matches any ConstantNode
-- 'v' - matches any Node that is not a ConstantNode
-
-The default list of rules is exposed on the function as `simplify.rules`
-and can be used as a basis to built a set of custom rules.
-
-To specify a rule as a string, separate the left and right pattern by '->'
-When specifying a rule as an object, the following keys are meaningful:
-- l - the left pattern
-- r - the right pattern
-- s - in lieu of l and r, the string form that is broken at -> to give them
-- repeat - whether to repeat this rule until the expression stabilizes
-- assuming - gives a context object, as in the 'context' option to
-    simplify. Every property in the context object must match the current
-    context in order, or else the rule will not be applied.
-- imposeContext - gives a context object, as in the 'context' option to
-    simplify. Any settings specified will override the incoming context
-    for all matches of this rule.
-
-For more details on the theory, see:
-
-- [Strategies for simplifying math expressions (Stackoverflow)](https://stackoverflow.com/questions/7540227/strategies-for-simplifying-math-expressions)
-- [Symbolic computation - Simplification (Wikipedia)](https://en.wikipedia.org/wiki/Symbolic_computation#Simplification)
-
- An optional `options` argument can be passed as last argument of `simplify`.
- Currently available options (defaults in parentheses):
- - `consoleDebug` (false): whether to write the expression being simplified
-   and any changes to it, along with the rule responsible, to console
- - `context` (simplify.defaultContext): an object giving properties of
-   each operator, which determine what simplifications are allowed. The
-   currently meaningful properties are commutative, associative,
-   total (whether the operation is defined for all arguments), and
-   trivial (whether the operation applied to a single argument leaves
-   that argument unchanged). The default context is very permissive and
-   allows almost all simplifications. Only properties differing from
-   the default need to be specified; the default context is used as a
-   fallback. Additional contexts `simplify.realContext` and
-   `simplify.positiveContext` are supplied to cause simplify to perform
-   just simplifications guaranteed to preserve all values of the expression
-   assuming all variables and subexpressions are real numbers or
-   positive real numbers, respectively. (Note that these are in some cases
-   more restrictive than the default context; for example, the default
-   context will allow `x/x` to simplify to 1, whereas
-   `simplify.realContext` will not, as `0/0` is not equal to 1.)
- - `exactFractions` (true): whether to try to convert all constants to
-   exact rational numbers.
- - `fractionsLimit` (10000): when `exactFractions` is true, constants will
-   be expressed as fractions only when both numerator and denominator
-   are smaller than `fractionsLimit`.
-
-
-## Syntax
-
-```js
-simplify(expr)
-simplify(expr, rules)
-simplify(expr, rules)
-simplify(expr, rules, scope)
-simplify(expr, rules, scope, options)
-simplify(expr, scope)
-simplify(expr, scope, options)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`expr` | Node &#124; string |  The expression to be simplified
-`rules` | Array&lt;{l:string, r: string} &#124; string &#124; function&gt; |  Optional list with custom rules
-
-### Returns
-
-Type | Description
----- | -----------
-Node | Returns the simplified form of `expr`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.simplify('2 * 1 * x ^ (2 - 1)')      // Node "2 * x"
-math.simplify('2 * 3 * x', {x: 4})        // Node "24"
-const f = math.parse('2 * 1 * x ^ (2 - 1)')
-math.simplify(f)                          // Node "2 * x"
-math.simplify('0.4 * x', {}, {exactFractions: true})  // Node "x * 2 / 5"
-math.simplify('0.4 * x', {}, {exactFractions: false}) // Node "0.4 * x"
-```
-
-
-## See also
-
-[simplifyCore](simplifyCore.md),
-[derivative](derivative.md),
-[evaluate](evaluate.md),
-[parse](parse.md),
-[rationalize](rationalize.md),
-[resolve](resolve.md)

package/docs/reference/functions/simplifyConstant.md

@@ -1,52 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function simplifyConstant
-
-simplifyConstant() takes a mathjs expression (either a Node representing
-a parse tree or a string which it parses to produce a node), and replaces
-any subexpression of it consisting entirely of constants with the computed
-value of that subexpression.
-
-
-## Syntax
-
-```js
-simplifyConstant(expr)
-simplifyConstant(expr, options)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`node` | Node &#124; string |  The expression to be simplified
-`options` | Object |  Simplification options, as per simplify()
-
-### Returns
-
-Type | Description
----- | -----------
-Node | Returns expression with constant subexpressions evaluated
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.simplifyConstant('x + 4*3/6')  // Node "x + 2"
-math.simplifyConstant('z cos(0)')   // Node "z 1"
-math.simplifyConstant('(5.2 + 1.08)t', {exactFractions: false})  // Node "6.28 t"
-```
-
-
-## See also
-
-[simplify](simplify.md),
-[simplifyCore](simplifyCore.md),
-[resolve](resolve.md),
-[derivative](derivative.md)