fix: #3631 support bigint in compareNatural (#3632)

Co-authored-by: Glen Whitney <glen@studioinfinity.org>

Author: Dheemanth07

AUTHORS

@@ -282,6 +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,7 +2,8 @@
 
 # unreleased changes since 15.1.0
 
-- Doc: Correct several arithmetic and relational documentation examples
+- 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.

src/function/relational/compareNatural.js

@@ -76,6 +76,7 @@ export const createCompareNatural = /* #__PURE__ */ factory(name, dependencies,
    *
    * History:
    *
+   *     v15.2   Handle bigints
    *     v3.14   Created
    *
    *
@@ -92,8 +93,8 @@ export const createCompareNatural = /* #__PURE__ */ factory(name, dependencies,
     let c
 
     // numeric types
-    if ((typeX === 'number' || typeX === 'BigNumber' || typeX === 'Fraction') &&
-        (typeY === 'number' || typeY === 'BigNumber' || typeY === 'Fraction')) {
+    if ((typeX === 'number' || typeX === 'BigNumber' || typeX === 'Fraction' || typeX === 'bigint') &&
+        (typeY === 'number' || typeY === 'BigNumber' || typeY === 'Fraction' || typeY === 'bigint')) {
       c = compare(x, y)
       if (c.toString() !== '0') {
         // c can be number, BigNumber, or Fraction

test/unit-tests/function/relational/compareNatural.test.js

@@ -64,6 +64,12 @@ describe('compareNatural', function () {
     assert.strictEqual(compareNatural(math.add(math.fraction(0.1), math.fraction(0.2)), math.fraction(0.3)).valueOf(), 0) // this would fail with numbers
   })
 
+  it('should compare bigints', function () {
+    assert.strictEqual(compareNatural(3n, 10n), -1)
+    assert.strictEqual(compareNatural(10n, 3n), 1)
+    assert.strictEqual(compareNatural(3n, 3n), 0)
+  })
+
   it('should compare two measures of the same unit', function () {
     assert.strictEqual(compareNatural(unit('100cm'), unit('10inch')), 1)
     assert.strictEqual(compareNatural(unit('99cm'), unit('1m')), -1)
@@ -117,6 +123,12 @@ describe('compareNatural', function () {
     assert.strictEqual(compareNatural(bignumber(2), 2), -1)
     assert.strictEqual(compareNatural(2, bignumber(2)), 1)
 
+    // numbers and bigints
+    assert.strictEqual(compareNatural(2n, 3), -1)
+    assert.strictEqual(compareNatural(3, 2n), 1)
+    assert.strictEqual(compareNatural(2n, 2), -1)
+    assert.strictEqual(compareNatural(2, 2n), 1)
+
     // array, DenseMatrix, SparseMatrix
     assert.strictEqual(compareNatural([2], matrix([2])), -1)
     assert.strictEqual(compareNatural(matrix([2]), [2]), 1)