mathjs 11.12.0 → 12.0.0

package/HISTORY.md

@@ -1,9 +1,46 @@
 # History
 
-# 2023-10-25, 11.12.0
+
+# 2023-10-26, 12.0.0
+
+Breaking changes:
+
+- Fix #2879, #2927, #3014: change the confusing interface of `eigs`.
+  Before, functions `eigs` returned an object:
+  ```
+  { values: MathCollection; vectors: MathCollection }
+  ```
+  where `vectors` was a 2d matrix of which the columns contained the vectors.
+  This is changed to `eigs` returning an object:
+  ```
+  { 
+    values: MathCollection
+    eigenvectors: Array<{
+      value: number | BigNumber
+      vector: MathCollection
+    }>
+  }
+  ```
+  Where `eigenvectors` is an array containing an object with the corresponding
+  eigenvalue and vector.
+- Refactored the TypeScript type definitions to make them work with a `NodeNext`
+  module resolution (#3079, #2919). 
+  - Type `MathJsStatic` is renamed to `MathJsInstance`.
+  - Type `FactoryDependencies` is deprecated, use `MathJsFactory` instead, and 
+    import dependency maps directly from the library.
+- Change the assignment operator of .toTex output from `:=` to `=` (see #2980, 
+  #3032).
+- Drop official support for Node.js 14 and 16.
+
+Fixes:
+
+- Find eigenvectors of defective matrices (#3037). Thanks @gwhitney.
+
+
+# 2023-10-26, 11.12.0
 
 - Implemented function `subtractScalar` (#3081, #2643), thanks @vrushaket.
-- Fix #3073: function format not escaping control characters and double 
+- Fix #3073: function format not escaping control characters and double
   quotes (#3082).
 - Fix: function `clone` not throwing an error when passing an unsupported
   type like a function.

package/README.md

@@ -135,7 +135,7 @@ A common case is to implement a new function. This involves the following steps:
 - 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(...)`.
+- Write the necessary TypeScript definitions for the new function in `./types/index.d.ts`, and write tests for it in `./test/typescript-tests/testTypes.ts`. This is described in [./types/EXPLANATION.md](./types/EXPLANATION.md).
 - Ensure the code style is ok by running `npm run lint` (run `npm run format` to fix the code style automatically).