mathjs 10.1.1 → 10.2.0

package/docs/reference/functions/randomInt.md

@@ -32,6 +32,12 @@ Type | Description
 number | Array | Matrix | A random integer value
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/range.md

@@ -46,6 +46,12 @@ Type | Description
 Array | Matrix | range
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/rationalize.md

@@ -29,7 +29,13 @@ Parameter | Type | Description
 
 Type | Description
 ---- | -----------
-Object | Node | The rational polynomial of `expr` or na object {Object} {Expression Node} expression: node simplified expression {Expression Node} numerator: simplified numerator of expression {Expression Node | boolean} denominator: simplified denominator or false (if there is no denominator) {Array}           variables:  variable names {Array}           coefficients: coefficients of numerator sorted by increased exponent {Expression Node}  node simplified expression
+Object | Node | The rational polynomial of `expr` or an object `{expression, numerator, denominator, variables, coefficients}`, where `expression` is a `Node` with the node simplified expression, `numerator` is a `Node` with the simplified numerator of expression, `denominator` is a `Node` or `boolean` with the simplified denominator or `false` (if there is no denominator), `variables` is an array with variable names, and `coefficients` is an array with coefficients of numerator sorted by increased exponent {Expression Node}  node simplified expression
+
+
+### Throws
+
+Type | Description
+---- | -----------
 
 
 ## Examples

package/docs/reference/functions/re.md

@@ -27,6 +27,12 @@ Type | Description
 number | BigNumber | Array | Matrix | The real part of x
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/reshape.md

@@ -25,6 +25,13 @@ Type | Description
 * | Array | Matrix | A reshaped clone of matrix `x`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+TypeError | If `sizes` does not contain solely integers
+DimensionError | If the product of the new dimension sizes does not equal that of the old ones
+
 ## Examples
 
 ```js

package/docs/reference/functions/resize.md

@@ -27,6 +27,12 @@ Type | Description
 * | Array | Matrix | A resized clone of matrix `x`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/resolve.md

@@ -0,0 +1,46 @@
+<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
+
+# Function resolve
+
+resolve(expr, scope) replaces variable nodes with their scoped values
+
+
+## Syntax
+
+```js
+resolve(expr, scope)
+```
+
+### Parameters
+
+Parameter | Type | Description
+--------- | ---- | -----------
+`node` | Node |  The expression tree to be simplified
+`scope` | Object |  Scope specifying variables to be resolved
+
+### Returns
+
+Type | Description
+---- | -----------
+Node | Returns `node` with variables recursively substituted.
+
+
+### Throws
+
+Type | Description
+---- | -----------
+ReferenceError |  If there is a cyclic dependency among the variables in `scope`, resolution is impossible and a ReferenceError is thrown.
+
+## Examples
+
+```js
+math.resolve('x + y', {x:1, y:2})           // Node {1 + 2}
+math.resolve(math.parse('x+y'), {x:1, y:2}) // Node {1 + 2}
+math.simplify('x+y', {x:2, y:'x+x'}).toString()      // "6"
+```
+
+
+## See also
+
+[simplify](simplify.md),
+[evaluate](evaluate.md)

package/docs/reference/functions/rightArithShift.md

@@ -27,6 +27,12 @@ Type | Description
 number | BigNumber | Array | Matrix | `x` sign-filled shifted right `y` times
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/rightLogShift.md

@@ -27,6 +27,12 @@ Type | Description
 number | Array | Matrix | `x` zero-filled shifted right `y` times
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/rotate.md

@@ -28,6 +28,12 @@ Type | Description
 Array | Matrix | Multiplication of the rotation matrix and w
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/rotationMatrix.md

@@ -30,6 +30,12 @@ Type | Description
 Array | Matrix | Rotation matrix
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/round.md

@@ -27,6 +27,12 @@ Type | Description
 number | BigNumber | Fraction | Complex | Array | Matrix | Rounded value
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/row.md

@@ -25,6 +25,12 @@ Type | Description
 Array | Matrix | The retrieved row
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/sec.md

@@ -26,6 +26,12 @@ Type | Description
 number | Complex | Array | Matrix | Secant of x
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/sech.md

@@ -27,6 +27,12 @@ Type | Description
 number | Complex | Array | Matrix | Hyperbolic secant of x
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/setCartesian.md

@@ -27,6 +27,12 @@ Type | Description
 Array | Matrix | The cartesian product of two (multi)sets
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/setDifference.md

@@ -26,6 +26,12 @@ Type | Description
 Array | Matrix | The difference of two (multi)sets
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/setDistinct.md

@@ -25,6 +25,12 @@ Type | Description
 Array | Matrix | A set containing the distinc elements of the multiset
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/setIntersect.md

@@ -26,6 +26,12 @@ Type | Description
 Array | Matrix | The intersection of two (multi)sets
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/setIsSubset.md

@@ -26,6 +26,12 @@ Type | Description
 boolean | true | false
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/setMultiplicity.md

@@ -26,6 +26,12 @@ Type | Description
 number | The number of how many times the multiset contains the element
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/setPowerset.md

@@ -25,6 +25,12 @@ Type | Description
 Array | The powerset of the (multi)set
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/setSize.md

@@ -26,6 +26,12 @@ Type | Description
 number | The number of elements of the (multi)set
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/setSymDifference.md

@@ -26,6 +26,12 @@ Type | Description
 Array | Matrix | The symmetric difference of two (multi)sets
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/setUnion.md

@@ -26,6 +26,12 @@ Type | Description
 Array | Matrix | The union of two (multi)sets
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/sign.md

@@ -30,6 +30,12 @@ Type | Description
 number | BigNumber | Fraction | Complex | Array | Matrix | Unit | e The sign of `x`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/simplify.md

@@ -31,6 +31,19 @@ interpreted as wildcards:
 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)
@@ -39,12 +52,28 @@ For more details on the theory, see:
  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
+   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.
+   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`.
+   be expressed as fractions only when both numerator and denominator
+   are smaller than `fractionsLimit`.
 
 
 ## Syntax
@@ -73,6 +102,12 @@ Type | Description
 Node | Returns the simplified form of `expr`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js
@@ -87,7 +122,9 @@ math.simplify('0.4 * x', {}, {exactFractions: false}) // Node "0.4 * x"
 
 ## See also
 
+[simplifyCore](simplifyCore.md),
 [derivative](derivative.md),
-[parse](parse.md),
 [evaluate](evaluate.md),
-[rationalize](rationalize.md)
+[parse](parse.md),
+[rationalize](rationalize.md),
+[resolve](resolve.md)

package/docs/reference/functions/simplifyCore.md

@@ -0,0 +1,50 @@
+<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
+
+# Function simplifyCore
+
+simplifyCore() performs single pass simplification suitable for
+applications requiring ultimate performance. In contrast, simplify()
+extends simplifyCore() with additional passes to provide deeper
+simplification.
+
+
+## Syntax
+
+```js
+simplifyCore(expr)
+```
+
+### Parameters
+
+Parameter | Type | Description
+--------- | ---- | -----------
+`node` | Node |  The expression to be simplified
+`options` | Object |  Simplification options, as per simplify()
+
+### Returns
+
+Type | Description
+---- | -----------
+Node | Returns expression with basic simplifications applied
+
+
+### Throws
+
+Type | Description
+---- | -----------
+
+
+## Examples
+
+```js
+const f = math.parse('2 * 1 * x ^ (2 - 1)')
+math.simpifyCore(f)                          // Node {2 * x}
+math.simplify('2 * 1 * x ^ (2 - 1)', [math.simplifyCore]) // Node {2 * x}
+```
+
+
+## See also
+
+[simplify](simplify.md),
+[resolve](resolve.md),
+[derivative](derivative.md)

package/docs/reference/functions/sin.md

@@ -26,6 +26,12 @@ Type | Description
 number | BigNumber | Complex | Array | Matrix | Sine of x
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/sinh.md

@@ -27,6 +27,12 @@ Type | Description
 number | BigNumber | Complex | Array | Matrix | Hyperbolic sine of x
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/size.md

@@ -24,6 +24,12 @@ Type | Description
 Array | Matrix | A vector with size of `x`.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/slu.md

@@ -28,6 +28,12 @@ Type | Description
 Object | The lower triangular matrix, the upper triangular matrix and the permutation vectors.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/smaller.md

@@ -32,6 +32,12 @@ Type | Description
 boolean | Array | Matrix | Returns true when the x is smaller than y, else returns false
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/smallerEq.md

@@ -32,6 +32,12 @@ Type | Description
 boolean | Array | Matrix | Returns true when the x is smaller than y, else returns false
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/sort.md

@@ -26,6 +26,12 @@ Type | Description
 Matrix | Array | Returns the sorted matrix.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/sqrt.md

@@ -26,6 +26,12 @@ Type | Description
 number | BigNumber | Complex | Array | Matrix | Unit |  Returns the square root of `x`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/sqrtm.md

@@ -27,6 +27,12 @@ Type | Description
 Array | Matrix | The principal square root of matrix `A`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/square.md

@@ -25,6 +25,12 @@ Type | Description
 number | BigNumber | Fraction | Complex | Array | Matrix | Unit |  Squared value
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/squeeze.md

@@ -24,6 +24,12 @@ Type | Description
 Matrix | Array | Squeezed matrix
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js