Merge branch 'develop' into jagged-arrays

Author: dvd101x

AUTHORS

@@ -282,5 +282,7 @@ Richard Taylor <richard.taylor@claconnect.com>
 NilsDietrich <61544566+NilsDietrich@users.noreply.github.com>
 anslem chibuike <144047596+AnslemHack@users.noreply.github.com>
 Ayomide Bamigbade <iamtryve@gmail.com>
+Dheemanth07 <dheemanth1007@gmail.com>
+Anadian <willanad@yandex.com>
 
 # Generated by tools/update-authors.js

HISTORY.md

@@ -2,6 +2,9 @@
 
 # unreleased changes since 15.1.0
 
+- Fix: #3631 Handle bigints in `compareNatural` (#3632). Thanks @Dheemanth07.
+- Docs: Correct several arithmetic and relational documentation examples
+  and add History (#3630). Thanks @Anadian.
 - Fix: #3578 interpret empty true-expr of conditional as error (#3581).
   Thanks @gwhitney.
 - Fix: #3597 added nullish type definitions (#3601). Thanks @Ayo1984.

README.md

@@ -191,11 +191,11 @@ To see the coverage results, open the generated report in your browser:
 
 ### Continuous integration testing
 
-Continuous integration tests are run on [Github Actions](https://github.com/josdejong/mathjs/actions) and [LambdaTest](https://www.lambdatest.com) every time a commit is pushed to github. Github Actions runs the tests for different versions of node.js, and LambdaTest runs the tests on all major browsers.
+Continuous integration tests are run on [GitHub Actions](https://github.com/josdejong/mathjs/actions) and [TestMu AI](https://www.testmu.ai) (formerly LambdaTest) every time a commit is pushed to GitHub. GitHub Actions runs the tests for different versions of node.js, and TestMu AI runs the tests on all major browsers.
 
-[![LambdaTest](https://raw.github.com/josdejong/mathjs/master/misc/lambdatest.svg)](https://www.lambdatest.com)
+[![TestMu AI](https://raw.github.com/josdejong/mathjs/develop/misc/testmu-ai.svg)](https://www.testmu.ai)
 
-Thanks, GitHub Actions and LambdaTest for the generous free hosting of this open source project!
+Thanks, GitHub Actions and TestMu AI for the generous free hosting of this open source project!
 
 ## License
 

misc/lambdatest.svg

@@ -43,14 +43,21 @@ export const createAdd = /* #__PURE__ */ factory(
      *
      *    const c = math.unit('5 cm')
      *    const d = math.unit('2.1 mm')
-     *    math.add(c, d)               // returns Unit 52.1 mm
+     *    math.add(c, d)               // returns Unit 5.21 cm
      *
      *    math.add("2.3", "4")         // returns number 6.3
      *
      * See also:
      *
      *    subtract, sum
      *
+     * History:
+     *
+     *     v13     Handle bigint arguments
+     *     v11.6   Support matrix broadcasting
+     *     v3.8    Allow more than two arguments
+     *     v0.0.2  Created
+     *
      * @param  {number | BigNumber | bigint | Fraction | Complex | Unit | Array | Matrix} x First value to add
      * @param  {number | BigNumber | bigint | Fraction | Complex | Unit | Array | Matrix} y Second value to add
      * @return {number | BigNumber | bigint | Fraction | Complex | Unit | Array | Matrix} Sum of `x` and `y`

misc/testmu-ai.svg

@@ -36,17 +36,18 @@ export const createCbrt = /* #__PURE__ */ factory(name, dependencies, ({ config,
    *    math.map([27, 64, 125], x => math.cbrt(x))       // returns [3, 4, 5]
    *
    *    const x = math.complex('8i')
-   *    math.cbrt(x)                   // returns Complex 1.7320508075689 + i
-   *    math.cbrt(x, true)             // returns Matrix [
-   *                                    //    1.7320508075689 + i
-   *                                    //   -1.7320508075689 + i
-   *                                    //   -2i
-   *                                    // ]
+   *    math.cbrt(x)                   // returns 1.7320508075689 + i ...
+   *    math.cbrt(x, true)
+   *    // Complex Matrix ["1.7320508075689+i", "-1.7320508075689+i", "-2i"]
    *
    * See also:
    *
    *    square, sqrt, cube
    *
+   * History:
+   *
+   *    v2.3  Created
+   *
    * @param {number | BigNumber | Complex | Unit} x
    *            Value for which to calculate the cubic root.
    * @param {boolean} [allRoots]  Optional, false by default. Only applicable

src/function/arithmetic/add.js

@@ -86,13 +86,13 @@ export const createCeil = /* #__PURE__ */ factory(name, dependencies, ({ typed,
    *    math.ceil(-4.782, 2)         // returns number -4.78
    *
    *    const c = math.complex(3.24, -2.71)
-   *    math.ceil(c)                 // returns Complex 4 - 2i
+   *    math.ceil(c)                 // returns Complex 4 - 2i ...
    *    math.ceil(c, 1)              // returns Complex 3.3 - 2.7i
    *
    *    const unit = math.unit('3.241 cm')
    *    const cm = math.unit('cm')
    *    const mm = math.unit('mm')
-   *    math.ceil(unit, 1, cm)      // returns Unit 3.3 cm
+   *    math.ceil(unit, 1, cm)      // returns Unit 3.3 cm ...
    *    math.ceil(unit, 1, mm)      // returns Unit 32.5 mm
    *
    *    math.ceil([3.2, 3.8, -4.7])  // returns Array [4, 4, -4]
@@ -102,6 +102,14 @@ export const createCeil = /* #__PURE__ */ factory(name, dependencies, ({ typed,
    *
    *    floor, fix, round
    *
+   * History:
+   *
+   *     v14    Handle Units
+   *     v7.4   Allow second "precision" argument
+   *     v5.7   Support tolerance for round-off errors
+   *     v2     Handle Fractions
+   *     v0.1   Created
+   *
    * @param  {number | BigNumber | Fraction | Complex | Unit | Array | Matrix} x  Value to be rounded
    * @param  {number | BigNumber | Array} [n=0]                            Number of decimals
    * @param  {Unit} [valuelessUnit]                                        A valueless unit

src/function/arithmetic/cbrt.js

@@ -22,16 +22,18 @@ export const createExp = /* #__PURE__ */ factory(name, dependencies, ({ typed })
    *    math.log(math.exp(2))        // returns number 2
    *
    *    math.map([1, 2, 3], math.exp)
-   *    // returns Array [
-   *    //   2.718281828459045,
-   *    //   7.3890560989306495,
-   *    //   20.085536923187668
-   *    // ]
+   *    // returns [2.718281828459045, 7.3890560989306495, 20.085536923187668]
    *
    * See also:
    *
    *    expm1, expm, log, pow
    *
+   * History:
+   *
+   *    v11     Don't apply elementwise, avoid confusion with matrix exponential
+   *    v0.20   Handle BigNumbers
+   *    v0.0.2  Created
+   *
    * @param {number | BigNumber | Complex} x  A number to exponentiate
    * @return {number | BigNumber | Complex} Exponential of `x`
    */

src/function/arithmetic/ceil.js

@@ -25,16 +25,17 @@ export const createExpm1 = /* #__PURE__ */ factory(name, dependencies, ({ typed,
    *    math.log(math.expm1(2) + 1)        // returns number 2
    *
    *    math.map([1, 2, 3], math.expm1)
-   *    // returns Array [
-   *    //   1.718281828459045,
-   *    //   6.3890560989306495,
-   *    //   19.085536923187668
-   *    // ]
+   *    // returns [1.718281828459045, 6.3890560989306495, 19.085536923187668]
    *
    * See also:
    *
    *    exp, expm, log, pow
    *
+   * History:
+   *
+   *    v11    Don't apply elementwise, avoids confusion with matrix exponential
+   *    v4.2   Created
+   *
    * @param {number | BigNumber | Complex} x  The number to exponentiate
    * @return {number | BigNumber | Complex} Exponential of `x`, minus one
    */