mathjs 10.0.0 → 10.6.4

package/CONTRIBUTING.md

@@ -1,23 +1,27 @@
 ## Contributing
 
-Contributions to the math.js library are very welcome! We can't do this alone.
-You can contribute in different ways: spread the word, report bugs, come up with
-ideas and suggestions, and contribute to the code.
+Contributions to the math.js library are very welcome! We can't do this alone. You can contribute in different ways: spread the word, report bugs, come up with ideas and suggestions, and contribute to the code.
 
-There are a few preferences regarding code contributions:
+### What can I do?
 
-- The code of math.js follows the JavaScript Standard Style as described on https://standardjs.com/.
+Search through the [issues](https://github.com/josdejong/mathjs/issues) looking
+  for something that looks interesting to you to pick up. Some issues are marked
+  ["help wanted"](https://github.com/josdejong/mathjs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22),
+  these are typically issues which should be relatively easy to pick up.
+
+### There are a few preferences regarding code contributions:
+
+- The code of math.js follows the JavaScript Standard Style as described on https://standardjs.com/, powered by `eslint`. Run `npm run lint` to test, and `npm run format` to automatically adjust your code to the code style.
 - Make sure you properly unit test your changes.
 - Before creating a pull request, run the unit tests to make sure they all pass.
 - Only commit changes done in the source files under `src`, not to the generated builds
   which are located in the folders `dist` and `lib`.
 - Send pull requests to the `develop` branch, not the `master` branch.
 
-What can I do?
+### FAQ
 
-- Search through the [issues](https://github.com/josdejong/mathjs/issues) looking
-  for something that looks interesting to you to pick up. Some issues are marked
-  ["help wanted"](https://github.com/josdejong/mathjs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22),
-  these are typically issues which should be relatively easy to pick up.
+- How to implement a new function? Answer: See the section [Implementing a new function](README.md#implementing-a-new-function) in the README.md.
+- Where to find more documentation? Answer: best starting point is the project's [README.md](https://github.com/josdejong/mathjs#readme) file. 
+- I'm not sure how/where to start, what now? Answer: feel free to ask when in doubt, just [open an issue](https://github.com/josdejong/mathjs/issues) and discuss your thoughts and questions.
 
 Thanks!

package/HISTORY.md

@@ -1,5 +1,214 @@
 # History
 
+# 2022-06-28, version 10.6.4
+
+- Improve TypeScript definitions of the `factory` function, thanks @mattvague.
+
+
+# 2022-06-24, version 10.6.3
+
+- Revert the TypeScript definition fixes for `factory` applied in `v10.6.2`, 
+  they give some complications.
+
+
+# 2022-06-24, version 10.6.2
+
+- Improve TypeScript definitions of `ParenthesisNode`. Thanks @mattvague.
+- Change the TypeScript definition of `MathNodeCommon['type']` into a less 
+  strict string, so it is possible to extend with new Node classes. 
+  Thanks @mattvague.
+- Improve TypeScript definitions of the `factory` function, thanks @mattvague.
+
+
+# 2022-05-31, version 10.6.1
+
+- Improve the  TypeScript types For `OperatorNode`: you can now define generic 
+  types like `OperatorNode<'+', 'add'>`. Thanks @mattvague.
+
+
+# 2022-05-24, version 10.6.0
+
+- Implementation of fourier transform functions `fft` and `ifft` (#2540).
+  Thanks @HanchaiN.
+- Fix TypeScript types not being listed in the exported fields (#2569).
+  Thanks @mattvague. 
+- Large improvements in TypeScript definitions for chained expressions (#2537).
+  Thanks @mattvague.
+- Fix #2571: improve TypeScript definition of functions `clone` and `cloneDeep` 
+  (#2572). Thanks @mattvague.
+- Fix the first argument of `derivative` holding the expression not correctly
+  being converted when using `.toTex()` (#2564). Thanks @mattvague.
+
+
+# 2022-05-11, version 10.5.3
+
+- Fix #2337: npm package containing examples and docs to solve security 
+  vulnerabilities being reported on the examples and their dependencies.
+- Fix core, construction, and some other functions missing in docs.
+- Drop official support for Node.js 12 which has reached its end of life.
+
+
+# 2022-05-09, version 10.5.2
+
+- Fix #2553: `@types/mocha` defined in `dependencies` instead of 
+  `devDependencies`, causing problems in projects that use a different version
+  of this dependency. Thanks @Kolahzary.
+- Fix #2550: remove `examples/node_modules` folder from the npm package.
+- Fix #2528: improve contribution guidelines (#2548).
+- Document `SymbolNode.onUndefinedSymbol` and 
+  `FunctionNode.onUndefinedFunction`.
+
+
+# 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). 
+  Thanks @HanchaiN.
+- Optimize function `det` for integers by switching to the Bareiss algorithm: 
+  no more round-off errors for integer input (#2516). Thanks @HanchaiN.
+- Implement #2463: allow negative integer powers of invertible square matrices
+  (#2517). Thanks @HanchaiN.
+- Implement the `lgamma` function (defined as log(gamma(z))) for number and
+  Complex types. Supersedes #320. (#2417). Thanks @yifanwww.
+- Fix #2523: update to the latest complex.js to improve `sin(z)` for small
+  `im(z)` (#2525). Thanks @gwhitney.
+- Fix #2526: update TypeScript definition of `ceil` (#2531). Thanks @simlaticak
+- Change mocha reporter to 'dot' to avoid excessively long log files. (#2520)
+
+
+# 2022-04-08, version 10.4.3
+
+- Fix #2508: improve the precision of stirlingS2 (#2509). Thanks @gwhitney.
+- Fix #2514: implement optional argument `base` in the number implementation
+  of function `log` (#2515). Thanks @gwhitney.
+- Improve the documentation on operator `;` (#2512). Thanks @gwhitney.
+
+
+# 2022-03-29, version 10.4.2
+
+- Fix #2499: different behavior for unit conversion "degC" and "K" (#2501).
+  Also disables getting the sign for units with an offset, which is ambiguous. 
+  Thanks @gwhitney.
+- Fix #2503: fix an issue in `log()` for complex numbers in which the imaginary
+  part is much larger in absolute value than the real part, fixed in 
+  `complex.js@2.1.0` (#2505), thanks @gwhitney, @infusion.
+- Fix #2493: unclear error message when an entity that is not a function
+  is being called as a function (#2494). Thanks @gwhitney.
+- Some fixes in the docs on units (#2498). Thanks @dvd101x.
+- Add `forEach` example in embedded docs (#2507). Thanks @dvd101x.
+- Correct approx.deepEqual() to accept an epsilon argument giving the
+  comparison tolerance. It was already being called this way, but was
+  silently ignoring the tolerance. Thanks @yifanwww.
+
+
+# 2022-03-23, version 10.4.1
+
+- Improve TypeScript definitions for function `unit` (#2479). 
+  Thanks @SinanAkkoyun.
+- Add tests for type declarations (#2448). Thanks @samestep.
+- Further improvement to TypeScript definitions of `std` and `variance`
+  (make dimension parameter optional, #2474). Thanks @NattapongSiri.
+- Next step (as per #2431) for full publication of "is" functions like
+  `isMatrix` etc: Provide TypeScript definitions of "is" functions and
+  make them type guards. (#2432). Thanks @ChristopherChudzicki.
+- Fix #2491: Multi line object expressions don't work with comments (#2492).
+  Thanks @gwhitney.
+- Fix #2478: a bug in calculating the eigenvectors when dealing with complex
+  numbers (#2496). Thanks @gwhitney.
+- Update project dependencies and devDependencies.
+
+
+# 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.
+- Fix #2441, #2442: support passing a function as argument to functions created
+  in the expression parser (#2443). Thanks @gwhitney.
+- Fix #2325: improve documentation of subset indices (#2446). Thanks @gwhitney.
+- Fix #2439: fix a bug in `complexEigs` in which real-valued norms were 
+  inadvertently being typed as complex numbers (#2445). Thanks @gwhitney.
+- Fix #2436: improve documentation and error message of function `map` (#2457).
+  Thanks @gwhitney.
+
+
+# 2022-03-01, version 10.2.0
+
+- Implemented context options to control simplifications allowed in `simplify`, 
+  see #2399, #2391. Thanks @gwhitney.
+- Implemented function `leafCount` as a first simple measure of the complexity 
+  of an expression, see #2411, #2389. Thanks @gwhitney.
+- Fix #2413: improve `combinations` to return an integer result without rounding
+  errors for larger values, see #2414. Thanks @gwhitney.
+- Fix #2385: function `rotate` missing in TypeScript definitions. 
+  Thanks @DIVYA-19.
+- Fix #2450: Add BigNumber to parameter type in `math.unit` and add TypeScript
+  types for `Unit.simplify` and `Unit.units` (#2353). Thanks @joshhansen.
+- Fix #2383: detect infinite loops in `simplify` (#2405). Thanks @gwhitney.
+- Fix #1423: collect like factors and cancel like terms in sums (#2388). 
+  Thanks @gwhitney.
+
+
+# 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)
@@ -90,7 +90,7 @@ Math.js works on any ES5 compatible JavaScript engine: node.js, Chrome, Firefox,
 
 First clone the project from github:
 
-    git clone git://github.com/josdejong/mathjs.git
+    git clone git@github.com:josdejong/mathjs.git
     cd mathjs
 
 Install the project dependencies:
@@ -127,6 +127,18 @@ The solution that mathjs uses has two main ingredients:
 
 At the lowest level, mathjs has immutable factory functions which create immutable functions. The core function `math.create(...)` creates a new instance having functions created from all passed factory functions. A mathjs instance is a collection of created functions. It contains a function like `math.import` to allow extending the instance with new functions, which can then be used in the expression parser.
 
+### Implementing a new function
+
+A common case is to implement a new function. This involves the following steps:
+
+- Implement the function in the right category, for example `./src/function/arithmetic/myNewFunction.js`, where you can replace `arithmetic` with the proper category, and `myNewFunction` with the name of the new function. Add the new function to the index files `./src/factoriesAny.js` and possibly `./src/factoriesNumber.js`.
+- Write documentation on the function in the source code comment of `myNewFunction.js`. This documentation is used to auto generate documentation on the website.
+- Write embedded documentation for the new function in `./src/expression/embeddedDocs/function/arithmetic/myNewFunction.js`. Add the new documentation to the index file `./src/expression/embeddedDocs/embeddedDocs.js`.
+- Write unit tests for the function in `./test/unit-tests/function/arithmetic/myNewFunction.test.js`.
+- Write a TypeScript definition for the new function in `./types/index.d.ts`, and write tests for it in `./types/index.ts`. Normally, two definitions need to be added: one for the static function `math.myNewFunction(...)` and one for the chained API `math.chain(...).myNewFunction(...)`.
+- Ensure the code style is ok by running `npm run lint` (run `npm run format` to fix the code style automatically).
+
+
 ### Build scripts
 
 The build script currently generates two types of output:
@@ -155,6 +167,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 +194,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