mathjs 10.5.0 → 10.5.1

package/HISTORY.md

@@ -1,5 +1,17 @@
 # History
 
+# 2022-05-02 version 10.5.1
+
+- Fix #2526, #2529: improve TypeScript definitions of function `round`, `fix`,
+  `floor`, `ceil`, and `nthRoot`, and improved the number only implementations 
+  of those functions  (#2531, #2539). Thanks @simlaticak and @gwhitney.
+- Fix #2532: matrix index symbol `end` not working when used inside
+  a sub-expression.
+- Fix #2524: In generating AUTHORS list, ignore a list of specific commits
+  (e.g., to avoid spurious duplicates in list). (#2543)
+- Add type definitions of function `resolve` (#2536). Thanks @mattvague.
+
+
 # 2022-04-19, version 10.5.0
 
 - Implement #1563: function `pinv`, Moore–Penrose inverse (#2521). 

package/docs/datatypes/matrices.md

@@ -342,6 +342,23 @@ const m1 = math.matrix([[0, 1], [0, 0]], 'sparse')
 const m2 = math.identity(1000, 1000, 'sparse')
 ```
 
+You can also coerce an array or matrix into sparse storage format with the
+`sparse` function.
+```js
+const md = math.matrix([[0, 1], [0,0]])  // dense
+const ms = math.sparse(md)               // sparse
+```
+
+Caution: `sparse` called on a JavaScript array of _n_ plain numbers produces
+a matrix with one column and _n_ rows -- in contrast to `matrix`, which
+produces a 1-dimensional matrix object with _n_ entries, i.e., a vector
+(_not_ a 1 by _n_ "row vector" nor an _n_ by 1 "column vector", but just a plain
+vector of length _n_).
+```js
+const mv = math.matrix([0, 0, 1])  // Has size [3]
+const mc = math.sparse([0, 0, 1])  // A "column vector," has size [3, 1]
+```
+
 ## API
 
 All relevant functions in math.js support Matrices and Arrays. Functions like `math.add` and `math.subtract`, `math.sqrt` handle matrices element wise. There is a set of functions specifically for creating or manipulating matrices, such as:

package/docs/expressions/syntax.md

@@ -549,8 +549,11 @@ can be replaced by using indexes. Indexes are enclosed in square brackets, and
 contain a number or a range for each of the matrix dimensions. A range can have
 its start and/or end undefined. When the start is undefined, the range will start
 at 1, when the end is undefined, the range will end at the end of the matrix.
+
 There is a context variable `end` available as well to denote the end of the
-matrix.
+matrix. This variable cannot be used in multiple nested indices. In that case,
+`end` will be resolved as the end of the innermost matrix. To solve this, 
+resolving of the nested index needs to be split in two separate operations.
 
 *IMPORTANT: matrix indexes and ranges work differently from the math.js indexes
 in JavaScript: They are one-based with an included upper-bound, similar to most

package/docs/reference/functions/fix.md

@@ -10,6 +10,7 @@ For matrices, the function is evaluated element wise.
 
 ```js
 math.fix(x)
+math.fix(x,n)
 ```
 
 ### Parameters

package/docs/reference/functions/floor.md

@@ -52,6 +52,10 @@ math.floor(c, 1)              // returns Complex 3.2 - 2.8i
 
 math.floor([3.2, 3.8, -4.7])       // returns Array [3, 3, -5]
 math.floor([3.21, 3.82, -4.71], 1)  // returns Array [3.2, 3.8, -4.8]
+
+math.floor(math.tau, [2, 3])  // returns Array [6.28, 6.283]
+
+// Note that floor(array, array) currently not implemented.
 ```
 
 

package/docs/reference/functions/resolve.md

@@ -15,14 +15,14 @@ resolve(expr, scope)
 
 Parameter | Type | Description
 --------- | ---- | -----------
-`node` | Node |  The expression tree to be simplified
+`node` | Node | Node[] |  The expression tree (or trees) to be simplified
 `scope` | Object |  Scope specifying variables to be resolved
 
 ### Returns
 
 Type | Description
 ---- | -----------
-Node | Returns `node` with variables recursively substituted.
+Node | Node[] | Returns `node` with variables recursively substituted.
 
 
 ### Throws

package/docs/reference/functions/simplifyConstant.md

@@ -0,0 +1,52 @@
+<!-- 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)