mathjs 10.0.0 → 10.1.1

package/HISTORY.md

@@ -1,5 +1,42 @@
 # History
 
+# 2022-02-02, version 10.1.1
+
+- Improvements and fixes in function `simplify`, thanks @gwhitney:
+  - Fix #2393: regression bug in `simplify('2-(x+1)')`.
+  - Ad option `consoleDebug` to `simplify` to see what is going on.
+- Fix TypeScript definition of `ConfigOptions`, which was missing option 
+  `predictable`.
+
+
+# 2022-01-15, version 10.1.0
+
+- Implemented function `invmod`, see #2368, #1744. Thanks @thetazero.
+- Improvements and fixes in function `simplify`, thanks @gwhitney:
+  - Fix #1179, #1290: improve collection of non-constant like terms (#2384).
+  - Fix #2152: do not transform strings into numbers (#2372).
+  - Fix #1913: implement support for array and object simplification (#2382).
+- Fix #2379: add embedded documentation for function `print`.
+- Remove broken example from the embedded documentation of function `forEach`.
+
+
+# 2021-12-29, version 10.0.2
+
+- Fix #2156: simplify expressions like `-1 / (-x)` to `1/x`. Thanks @ony3000.
+- Fix #2363: remove a redundant part of the regex to split a number.
+- Fix #2291: add support for fractions in function `intersect`. 
+  Thanks @thetazero.
+- Fix #2358: bug in `SparseMatrix` when replacing a subset of a matrix with
+  a non-consecutive index. Thanks @Al-0.
+
+
+# 2021-12-22, version 10.0.1
+
+- Fix #1681: function `gamma` giving inaccurate complex results in some cases.
+  Thanks @kmdrGroch.
+- Fixed a typo in an example, see #2366. Thanks @blackwindforce.
+
+
 # 2021-11-03, version 10.0.0
 
 !!! BE CAREFUL: BREAKING CHANGES IN THE TYPESCRIPT DEFINITIONS !!!

package/NOTICE

@@ -1,7 +1,7 @@
 math.js
 https://github.com/josdejong/mathjs
 
-Copyright (C) 2013-2021 Jos de Jong <wjosdejong@gmail.com>
+Copyright (C) 2013-2022 Jos de Jong <wjosdejong@gmail.com>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/README.md

@@ -7,7 +7,7 @@ Math.js is an extensive math library for JavaScript and Node.js. It features a f
 [![Version](https://img.shields.io/npm/v/mathjs.svg)](https://www.npmjs.com/package/mathjs)
 [![Downloads](https://img.shields.io/npm/dm/mathjs.svg)](https://www.npmjs.com/package/mathjs)
 [![Build Status](https://github.com/josdejong/mathjs/workflows/Node.js%20CI/badge.svg)](https://github.com/josdejong/mathjs/actions)
-[![Maintenance](https://img.shields.io/maintenance/yes/2021.svg)](https://github.com/josdejong/mathjs/graphs/commit-activity)
+[![Maintenance](https://img.shields.io/maintenance/yes/2022.svg)](https://github.com/josdejong/mathjs/graphs/commit-activity)
 [![License](https://img.shields.io/github/license/josdejong/mathjs.svg)](https://github.com/josdejong/mathjs/blob/master/LICENSE)
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fjosdejong%2Fmathjs.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fjosdejong%2Fmathjs?ref=badge_shield)
 [![Codecov](https://codecov.io/gh/josdejong/mathjs/branch/develop/graph/badge.svg)](https://codecov.io/gh/josdejong/mathjs)
@@ -155,6 +155,14 @@ To run the tests remotely on BrowserStack, first set the environment variables `
 
     npm run test:browserstack
 
+You can separately run the code linter, though it is also executed with `npm test`:
+
+    npm run lint
+
+To automatically fix linting issue, run:
+
+    npm run format
+
 To test code coverage of the tests:
 
     npm run coverage
@@ -174,7 +182,7 @@ Thanks Github Actions and BrowserStack for the generous free hosting of this ope
 
 ## License
 
-Copyright (C) 2013-2021 Jos de Jong <wjosdejong@gmail.com>
+Copyright (C) 2013-2022 Jos de Jong <wjosdejong@gmail.com>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/bin/cli.js

@@ -30,7 +30,7 @@
  *     cat script.txt | mathjs > results.txt  Run input stream, output to file
  *
  * @license
- * Copyright (C) 2013-2021 Jos de Jong <wjosdejong@gmail.com>
+ * Copyright (C) 2013-2022 Jos de Jong <wjosdejong@gmail.com>
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
  * use this file except in compliance with the License. You may obtain a copy

package/docs/expressions/syntax.md

@@ -547,7 +547,7 @@ parser.evaluate('c[end - 1 : -1 : 2]')    // Matrix, [8, 7, 6]
 ## Objects
 
 Objects in math.js work the same as in languages like JavaScript and Python.
-An object is enclosed by square brackets `{`, `}`, and contains a set of
+An object is enclosed by curly brackets `{`, `}`, and contains a set of
 comma separated key/value pairs. Keys and values are separated by a colon `:`.
 Keys can be a symbol like `prop` or a string like `"prop"`.
 

package/docs/reference/constants.md

@@ -5,7 +5,7 @@ Math.js contains the following constants.
 Constant        | Description | Value
 --------------- | ----------- | -----
 `e`, `E`        | Euler's number, the base of the natural logarithm. | 2.718281828459045
-`i`             | Imaginary unit, defined as i*i=-1. A complex number is described as a + b*i, where a is the real part, and b is the imaginary part. | `sqrt(-1)`
+`i`             | Imaginary unit, defined as `i * i = -1`. A complex number is described as `a + b * i`, where a is the real part, and b is the imaginary part. | `sqrt(-1)`
 `Infinity`      | Infinity, a number which is larger than the maximum number that can be handled by a floating point number. | `Infinity`
 `LN2`           | Returns the natural logarithm of 2. | `0.6931471805599453`
 `LN10`          | Returns the natural logarithm of 10. | `2.302585092994046`

package/docs/reference/functions/invmod.md

@@ -0,0 +1,41 @@
+<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
+
+# Function invmod
+
+Calculate the (modular) multiplicative inverse of a modulo b. Solution to the equation `ax ≣ 1 (mod b)`
+See https://en.wikipedia.org/wiki/Modular_multiplicative_inverse.
+
+
+## Syntax
+
+```js
+math.invmod(a, b)
+```
+
+### Parameters
+
+Parameter | Type | Description
+--------- | ---- | -----------
+`a` | number &#124; BigNumber | An integer number
+`b` | number &#124; BigNumber | An integer number
+
+### Returns
+
+Type | Description
+---- | -----------
+number &#124; BigNumber | Returns an integer number where `invmod(a,b)*a ≣ 1 (mod b)`
+
+
+## Examples
+
+```js
+math.invmod(8, 12)             // returns NaN
+math.invmod(7, 13)             // return 2
+math.invmod(15151, 15122)      // returns 10429
+```
+
+
+## See also
+
+[gcd](gcd.md),
+[xgcd](xgcd.md)

package/docs/reference/functions/simplify.md

@@ -37,11 +37,14 @@ For more details on the theory, see:
 - [Symbolic computation - Simplification (Wikipedia)](https://en.wikipedia.org/wiki/Symbolic_computation#Simplification)
 
  An optional `options` argument can be passed as last argument of `simplify`.
- There is currently one option available:
- - `exactFractions`: a boolean which is `true` by default.
- - `fractionsLimit`: when `exactFractions` is true, a fraction will be returned
-   only when both numerator and denominator are smaller than `fractionsLimit`.
-   Default value is 10000.
+ 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
+ - `exactFractions` (true): whether to try to convert all constants to
+        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`.
 
 
 ## Syntax

package/docs/reference/functions.md

@@ -44,6 +44,7 @@ Function | Description
 [math.floor(x)](functions/floor.md) | Round a value towards minus infinity.
 [math.gcd(a, b)](functions/gcd.md) | Calculate the greatest common divisor for two or more values or arrays.
 [math.hypot(a, b, ...)](functions/hypot.md) | Calculate the hypotenusa of a list with values.
+[math.invmod(a, b)](functions/invmod.md) | Calculate the (modular) multiplicative inverse of a modulo b.
 [math.lcm(a, b)](functions/lcm.md) | Calculate the least common multiple for two or more values or arrays.
 [math.log(x [, base])](functions/log.md) | Calculate the logarithm of a value.
 [math.log10(x)](functions/log10.md) | Calculate the 10-base logarithm of a value.

package/examples/expressions.js

@@ -91,7 +91,7 @@ const scope2 = {
 print(code2.evaluate(scope2)) // 9
 
 // change a value in the scope and re-evaluate the node
-scope.a = 3
+scope2.a = 3
 print(code2.evaluate(scope2)) // 27
 
 // 3. using function math.compile