mathjs 10.3.0 → 10.4.0

package/HISTORY.md

@@ -1,5 +1,19 @@
 # History
 
+# 2022-03-07, version 10.4.0
+
+- Fix #2461: make sure `simplifyCore` recurses over all binary nodes (#2462).
+  Thanks @gwhitney.
+- Fix #2429: fix the TypeScript definitions of functions `std` and `variance`
+  (#2455). Thanks @NattapongSiri.
+- Fix #1633: implement a `cumsum` function generating cumulative sums of a list
+  of values or a matrix. (#1870). Thanks @hjonasson.
+- Upgrade to the latest version of `Fraction.js`, having more strict input, 
+  only accepting an integer numerator and denominator. See #2427.
+- Fix typo in documentation example for `format`. (#2468) Thanks @abranhe.
+- Write unit tests for all jsdoc examples. See #2452. Thanks @gwhitney. 
+
+
 # 2021-03-02, version 10.3.0
 
 - Fix #1260: implement function `symbolicEqual` (#2424). Thanks @gwhitney.

package/docs/reference/functions/cumsum.md

@@ -0,0 +1,57 @@
+<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
+
+# Function cumsum
+
+Compute the cumulative sum of a matrix or a list with values.
+In case of a (multi dimensional) array or matrix, the cumulative sums
+along a specified dimension (defaulting to the first) will be calculated.
+
+
+## Syntax
+
+```js
+math.cumsum(a, b, c, ...)
+math.cumsum(A)
+```
+
+### Parameters
+
+Parameter | Type | Description
+--------- | ---- | -----------
+`args` | ... * | A single matrix or or multiple scalar values
+
+### Returns
+
+Type | Description
+---- | -----------
+* | The cumulative sum of all values
+
+
+### Throws
+
+Type | Description
+---- | -----------
+
+
+## Examples
+
+```js
+math.cumsum(2, 1, 4, 3)               // returns [2, 3, 7, 10]
+math.cumsum([2, 1, 4, 3])             // returns [2, 3, 7, 10]
+math.cumsum([[1, 2], [3, 4]])         // returns [[1, 2], [4, 6]]
+math.cumsum([[1, 2], [3, 4]], 0)      // returns [[1, 2], [4, 6]]
+math.cumsum([[1, 2], [3, 4]], 1)      // returns [[1, 3], [3, 7]]
+math.cumsum([[2, 5], [4, 3], [1, 7]]) // returns [[2, 5], [6, 8], [7, 15]]
+```
+
+
+## See also
+
+[mean](mean.md),
+[median](median.md),
+[min](min.md),
+[max](max.md),
+[prod](prod.md),
+[std](std.md),
+[variance](variance.md),
+[sum](sum.md)

package/docs/reference/functions/format.md

@@ -115,7 +115,7 @@ function formatCurrency(value) {
   // you could also use math.format inside the callback:
   // return '$' + math.format(value, {notation: 'fixed', precision: 2})
 }
-math.format([2.1, 3, 0.016], formatCurrency}            // returns '[$2.10, $3.00, $0.02]'
+math.format([2.1, 3, 0.016], formatCurrency)            // returns '[$2.10, $3.00, $0.02]'
 ```
 
 

package/docs/reference/functions/sum.md

@@ -50,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.md

@@ -215,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.