mathjs 10.1.0 → 10.3.0

package/docs/reference/functions/isNegative.md

@@ -27,6 +27,12 @@ Type | Description
 boolean | Returns true when `x` is larger than zero. Throws an error in case of an unknown data type.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/isNumeric.md

@@ -26,6 +26,12 @@ Type | Description
 boolean | Returns true when `x` is a `number`, `BigNumber`, `Fraction`, or `boolean`. Returns false for other types. Throws an error in case of unknown types.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/isPositive.md

@@ -27,6 +27,12 @@ Type | Description
 boolean | Returns true when `x` is larger than zero. Throws an error in case of an unknown data type.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/isPrime.md

@@ -27,6 +27,12 @@ Type | Description
 boolean | Returns true when `x` is larger than zero. Throws an error in case of an unknown data type.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/isZero.md

@@ -28,6 +28,12 @@ Type | Description
 boolean | Returns true when `x` is zero. Throws an error in case of an unknown data type.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/kldivergence.md

@@ -25,6 +25,12 @@ Type | Description
 number | Returns distance between q and p
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/kron.md

@@ -29,6 +29,12 @@ Type | Description
 Array | Matrix | Returns the kronecker product of `x` and `y`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/larger.md

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

package/docs/reference/functions/largerEq.md

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

package/docs/reference/functions/lcm.md

@@ -31,6 +31,12 @@ Type | Description
 number | BigNumber | Array | Matrix | The least common multiple
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/leafCount.md

@@ -0,0 +1,52 @@
+<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
+
+# Function leafCount
+
+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. Note that `5!` has just one leaf, the '5'; the
+unary factorial operator does not add a leaf. On the other hand,
+function symbols do add leaves, so `sin(x)/cos(x)` has four leaves.
+
+The `simplify()` function should generally not increase the `leafCount()`
+of an expression, although currently there is no guarantee that it never
+does so. In many cases, `simplify()` reduces the leaf count.
+
+
+## Syntax
+
+```js
+leafCount(expr)
+```
+
+### Parameters
+
+Parameter | Type | Description
+--------- | ---- | -----------
+`expr` | Node &#124; string | The expression to count the leaves of
+
+### Returns
+
+Type | Description
+---- | -----------
+number | The number of leaves of `expr`
+
+
+### Throws
+
+Type | Description
+---- | -----------
+
+
+## Examples
+
+```js
+math.leafCount('x') // 1
+math.leafCount(math.parse('a*d-b*c')) // 4
+math.leafCount('[a,b;c,d][0,1]') // 6
+```
+
+
+## See also
+
+[simplify](simplify.md)

package/docs/reference/functions/leftShift.md

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

package/docs/reference/functions/log.md

@@ -28,6 +28,12 @@ Type | Description
 number | BigNumber | Complex | Array | Matrix |  Returns the logarithm of `x`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/log10.md

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

package/docs/reference/functions/log1p.md

@@ -28,6 +28,12 @@ Type | Description
 number | BigNumber | Complex | Array | Matrix |  Returns the logarithm of `x+1`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/log2.md

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

package/docs/reference/functions/lsolve.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/lsolveAll.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/lup.md

@@ -25,6 +25,12 @@ Type | Description
 {L: Array | Matrix, U: Array | Matrix, P: Array.<number>} | The lower triangular matrix, the upper triangular matrix and the permutation matrix.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/lusolve.md

@@ -28,6 +28,12 @@ Type | Description
 DenseMatrix | Array | Column vector with the solution to the linear system A * x = b
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/mad.md

@@ -27,6 +27,12 @@ Type | Description
 * | The median absolute deviation.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/map.md

@@ -2,8 +2,15 @@
 
 # Function map
 
-Create a new matrix or array with the results of the callback function executed on
-each entry of the matrix/array.
+Create a new matrix or array with the results of a callback function executed on
+each entry of a given matrix/array.
+
+For each entry of the input, the callback is invoked with three arguments:
+the value of the entry, the index at which that entry occurs, and the full
+matrix/array being traversed. Note that because the matrix/array might be
+multidimensional, the "index" argument is always an array of numbers giving
+the index in each dimension. This is true even for vectors: the "index"
+argument is an array of length 1, rather than simply a number.
 
 
 ## Syntax
@@ -16,14 +23,20 @@ math.map(x, callback)
 
 Parameter | Type | Description
 --------- | ---- | -----------
-`x` | Matrix | Array | The matrix to iterate on.
-`callback` | Function | The callback method is invoked with three parameters: the value of the element, the index of the element, and the matrix being traversed.
+`x` | Matrix | Array | The input to iterate on.
+`callback` | Function |  The function to call (as described above) on each entry of the input
 
 ### Returns
 
 Type | Description
 ---- | -----------
-Matrix | array | Transformed map of x
+Matrix | array |  Transformed map of x; always has the same type and shape as x
+
+
+### Throws
+
+Type | Description
+---- | -----------
 
 
 ## Examples
@@ -32,6 +45,16 @@ Matrix | array | Transformed map of x
 math.map([1, 2, 3], function(value) {
   return value * value
 })  // returns [1, 4, 9]
+
+// The calling convention for the callback can cause subtleties:
+math.map([1, 2, 3], math.format)
+// throws TypeError: map attempted to call 'format(1,[0])' but argument 2 of type Array does not match expected type number or function or Object or string or boolean
+// [This happens because `format` _can_ take a second argument,
+// but its semantics don't match that of the 2nd argument `map` provides]
+
+// To avoid this error, use a function that takes exactly the
+// desired arguments:
+math.map([1, 2, 3], x => math.format(x)) // returns ['1', '2', '3']
 ```
 
 

package/docs/reference/functions/matrixFromColumns.md

@@ -27,6 +27,12 @@ Type | Description
 number[][] | Matrix | if at least one of the arguments is an array, an array will be returned
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/matrixFromFunction.md

@@ -33,6 +33,12 @@ Type | Description
 Array | Matrix | Returns the created matrix
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/matrixFromRows.md

@@ -27,6 +27,12 @@ Type | Description
 number[][] | Matrix | if at least one of the arguments is an array, an array will be returned
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/max.md

@@ -29,6 +29,12 @@ Type | Description
 * | The maximum value
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/mean.md

@@ -29,6 +29,12 @@ Type | Description
 * | The mean of all values
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/median.md

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

package/docs/reference/functions/min.md

@@ -29,6 +29,12 @@ Type | Description
 * | The minimum value
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/mod.md

@@ -33,6 +33,12 @@ Type | Description
 number | BigNumber | Fraction | Array | Matrix | Returns the remainder of `x` divided by `y`.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/mode.md

@@ -26,6 +26,12 @@ Type | Description
 * | The mode of all values
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/multinomial.md

@@ -27,6 +27,12 @@ Type | Description
 Number | BigNumber | Multinomial coefficient.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/multiply.md

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

package/docs/reference/functions/norm.md

@@ -28,6 +28,12 @@ Type | Description
 number | BigNumber | the p-norm
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/not.md

@@ -25,6 +25,12 @@ Type | Description
 boolean | Array | Matrix |  Returns true when input is a zero or empty value.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/nthRoot.md

@@ -32,6 +32,12 @@ Type | Description
 number | Complex | Array | Matrix | Returns the nth root of `a`
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/nthRoots.md

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

package/docs/reference/functions/numeric.md

@@ -25,6 +25,12 @@ Type | Description
 number | BigNumber | Fraction |  Returns an instance of the numeric in the requested type
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/oct.md

@@ -25,6 +25,12 @@ Type | Description
 string | The formatted value
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/ones.md

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

package/docs/reference/functions/or.md

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

package/docs/reference/functions/parser.md

@@ -24,6 +24,12 @@ Type | Description
 Parser | Parser
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js

package/docs/reference/functions/partitionSelect.md

@@ -29,6 +29,12 @@ Type | Description
 * | Returns the kth lowest value.
 
 
+### Throws
+
+Type | Description
+---- | -----------
+
+
 ## Examples
 
 ```js