mathjs 10.1.1 → 10.4.0

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

package/docs/reference/functions/std.md

@@ -44,6 +44,12 @@ Type | Description
 * | The standard deviation
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/stirlingS2.md

@@ -30,6 +30,12 @@ Type | Description
 Number | BigNumber | S(n,k)
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/subset.md

@@ -17,7 +17,7 @@ math.subset(value, index, replacement [, defaultValue])  // replace a subset
 Parameter | Type | Description
 --------- | ---- | -----------
 `matrix` | Array | Matrix | string | An array, matrix, or string
-`index` | Index | An index containing ranges for each dimension
+`index` | Index |  For each dimension of the target, specifies an index or a list of indices to fetch or set. `subset` uses the cartesian product of the indices specified in each dimension.
 `replacement` | * | An array, matrix, or scalar. If provided, the subset is replaced with replacement. If not provided, the subset is returned
 `defaultValue` | * | Default value, filled in on new entries when the matrix is resized. If not provided, math.matrix elements will be left undefined. Default value: undefined.
 
@@ -28,6 +28,12 @@ Type | Description
 Array | Matrix | string | Either the retrieved subset or the updated matrix.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js
@@ -38,8 +44,16 @@ math.subset(d, math.index([0, 1], 1))   // returns [[2], [4]]
 
 // replace a subset
 const e = []
-const f = math.subset(e, math.index(0, [0, 2]), [5, 6])  // f = [[5, 6]]
+const f = math.subset(e, math.index(0, [0, 2]), [5, 6])  // f = [[5, 6]] and e = [[5, 0, 6]]
 const g = math.subset(f, math.index(1, 1), 7, 0)         // g = [[5, 6], [0, 7]]
+
+// get submatrix using ranges
+const M = [
+  [1,2,3],
+  [4,5,6],
+  [7,8,9]
+]
+math.subset(M, math.index(math.range(0,2), math.range(0,3))) // [[1,2,3],[4,5,6]]
 ```
 
 

package/docs/reference/functions/subtract.md

@@ -26,6 +26,12 @@ Type | Description
 number | BigNumber | Fraction | Complex | Unit | Array | Matrix |  Subtraction of `x` and `y`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/sum.md

@@ -27,6 +27,12 @@ Type | Description
 * | The sum of all values
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js
@@ -44,4 +50,5 @@ math.sum([[2, 5], [4, 3], [1, 7]]) // returns 22
 [max](max.md),
 [prod](prod.md),
 [std](std.md),
-[variance](variance.md)
+[variance](variance.md),
+[cumsum](cumsum.md)

package/docs/reference/functions/symbolicEqual.md

@@ -0,0 +1,62 @@
+<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
+
+# Function symbolicEqual
+
+Attempts to determine if two expressions are symbolically equal, i.e.
+one is the result of valid algebraic manipulations on the other.
+Currently, this simply checks if the difference of the two expressions
+simplifies down to 0. So there are two important caveats:
+1. whether two expressions are symbolically equal depends on the
+    manipulations allowed. Therefore, this function takes an optional
+    third argument, which are the options that control the behavior
+    as documented for the `simplify()` function.
+2. it is in general intractable to find the minimal simplification of
+    an arbitrarily complicated expression. So while a `true` value
+    of `symbolicEqual` ensures that the two expressions can be manipulated
+    to match each other, a `false` value does not absolutely rule this out.
+
+
+## Syntax
+
+```js
+symbolicEqual(expr1, expr2)
+symbolicEqual(expr1, expr2, options)
+```
+
+### Parameters
+
+Parameter | Type | Description
+--------- | ---- | -----------
+`expr1` | Node &#124; string | The first expression to compare
+`expr2` | Node &#124; string | The second expression to compare
+`options` | Object | Optional option object, passed to simplify
+
+### Returns
+
+Type | Description
+---- | -----------
+boolean |  Returns true if a valid manipulation making the expressions equal is found.
+
+
+### Throws
+
+Type | Description
+---- | -----------
+
+
+## Examples
+
+```js
+symbolicEqual('x*y', 'y*x') // true
+symbolicEqual('x*y', 'y*x', {context: {multiply: {commutative: false}}})
+    //false
+symbolicEqual('x/y', '(y*x^(-1))^(-1)') // true
+symbolicEqual('abs(x)','x') // false
+symbolicEqual('abs(x)','x', simplify.positiveContext) // true
+```
+
+
+## See also
+
+[simplify](simplify.md),
+[evaluate](evaluate.md)

package/docs/reference/functions/tan.md

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

package/docs/reference/functions/tanh.md

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

package/docs/reference/functions/to.md

@@ -27,6 +27,12 @@ Type | Description
 Unit | Array | Matrix | value with changed, fixed unit.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/trace.md

@@ -25,6 +25,12 @@ Type | Description
 number | The trace of `x`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/transpose.md

@@ -27,6 +27,12 @@ Type | Description
 Array | Matrix | The transposed matrix
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/typeOf.md

@@ -63,6 +63,12 @@ Type | Description
 string | Returns the name of the type. Primitive types are lower case, non-primitive types are upper-camel-case. For example 'number', 'string', 'Array', 'Date'.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/unaryMinus.md

@@ -28,6 +28,12 @@ Type | Description
 number | BigNumber | Fraction | Complex | Unit | Array | Matrix | Returns the value with inverted sign.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/unaryPlus.md

@@ -27,6 +27,12 @@ Type | Description
 number | BigNumber | Fraction | Complex | Unit | Array | Matrix |  Returns the input value when numeric, converts to a number when input is non-numeric.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/unequal.md

@@ -37,6 +37,12 @@ Type | Description
 boolean | Array | Matrix | Returns true when the compared values are unequal, else returns false
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/usolve.md

@@ -27,6 +27,12 @@ Type | Description
 DenseMatrix | Array | A column vector with the linear system solution (x)
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/usolveAll.md

@@ -27,6 +27,12 @@ Type | Description
 DenseMatrix[] | Array[] | An array of affine-independent column vectors (x) that solve the linear system
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/variance.md

@@ -46,6 +46,12 @@ Type | Description
 * | The variance
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/xgcd.md

@@ -26,6 +26,12 @@ Type | Description
 Array | Returns an array containing 3 integers `[div, m, n]` where `div = gcd(a, b)` and `a*m + b*n = div`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/xor.md

@@ -26,6 +26,12 @@ Type | Description
 boolean | Array | Matrix |  Returns true when one and only one input is defined with a nonzero/nonempty value.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/zeros.md

@@ -31,6 +31,12 @@ Type | Description
 Array | Matrix | A matrix filled with zeros
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions.md

@@ -14,14 +14,18 @@ Function | Description
 Function | Description
 ---- | -----------
 [derivative(expr, variable)](functions/derivative.md) | Takes the derivative of an expression expressed in parser Nodes.
+[leafCount(expr)](functions/leafCount.md) | Gives the number of "leaf nodes" in the parse tree of the given expression A leaf node is one that has no subexpressions, essentially either a symbol or a constant.
 [math.lsolve(L, b)](functions/lsolve.md) | Finds one solution of a linear equation system by forwards substitution.
 [math.lsolveAll(L, b)](functions/lsolveAll.md) | Finds all solutions of a linear equation system by forwards substitution.
 [math.lup(A)](functions/lup.md) | Calculate the Matrix LU decomposition with partial pivoting.
 [math.lusolve(A, b)](functions/lusolve.md) | Solves the linear system `A * x = b` where `A` is an [n x n] matrix and `b` is a [n] column vector.
 [math.qr(A)](functions/qr.md) | Calculate the Matrix QR decomposition.
 [rationalize(expr)](functions/rationalize.md) | Transform a rationalizable expression in a rational fraction.
+[resolve(expr, scope)](functions/resolve.md) | resolve(expr, scope) replaces variable nodes with their scoped values.
 [simplify(expr)](functions/simplify.md) | Simplify an expression tree.
+[simplifyCore(expr)](functions/simplifyCore.md) | simplifyCore() performs single pass simplification suitable for applications requiring ultimate performance.
 [math.slu(A, order, threshold)](functions/slu.md) | Calculate the Sparse Matrix LU decomposition with full pivoting.
+[symbolicEqual(expr1, expr2)](functions/symbolicEqual.md) | Attempts to determine if two expressions are symbolically equal, i.
 [math.usolve(U, b)](functions/usolve.md) | Finds one solution of a linear equation system by backward substitution.
 [math.usolveAll(U, b)](functions/usolveAll.md) | Finds all solutions of a linear equation system by backward substitution.
 
@@ -134,7 +138,7 @@ Function | Description
 [math.identity(n)](functions/identity.md) | Create a 2-dimensional identity matrix with size m x n or n x n.
 [math.inv(x)](functions/inv.md) | Calculate the inverse of a square matrix.
 [math.kron(x, y)](functions/kron.md) | Calculates the kronecker product of 2 matrices or vectors.
-[math.map(x, callback)](functions/map.md) | Create a new matrix or array with the results of the callback function executed on each entry of the matrix/array.
+[math.map(x, callback)](functions/map.md) | Create a new matrix or array with the results of a callback function executed on each entry of a given matrix/array.
 [math.matrixFromColumns(...arr)](functions/matrixFromColumns.md) | Create a dense matrix from vectors as individual columns.
 [math.matrixFromFunction(size, fn)](functions/matrixFromFunction.md) | Create a matrix by evaluating a generating function at each index.
 [math.matrixFromRows(...arr)](functions/matrixFromRows.md) | Create a dense matrix from vectors as individual rows.
@@ -211,6 +215,7 @@ Function | Description
 
 Function | Description
 ---- | -----------
+[math.cumsum(a, b, c, ...)](functions/cumsum.md) | Compute the cumulative sum of a matrix or a list with values.
 [math.mad(a, b, c, ...)](functions/mad.md) | Compute the median absolute deviation of a matrix or a list with values.
 [math.max(a, b, c, ...)](functions/max.md) | Compute the maximum value of a matrix or a  list with values.
 [math.mean(a, b, c, ...)](functions/mean.md) | Compute the mean value of matrix or a list with values.