mathjs 10.6.2 → 11.0.0

package/types/index.ts

@@ -29,6 +29,7 @@ import {
   OperatorNodeOp,
   SymbolNode,
   ParenthesisNode,
+  SimplifyRule,
 } from 'mathjs'
 import * as assert from 'assert'
 import { expectTypeOf } from 'expect-type'
@@ -88,6 +89,22 @@ Basic usage examples
 
   math.variance(math.variance(m2by3, 'uncorrected'))
 
+  // count and sum check
+  math.count([10, 10, 10])
+  math.count([
+    [1, 2, 3],
+    [4, 5, 6],
+  ])
+  math.count('mathjs')
+
+  math.sum(1, 2, 3, 4)
+  math.sum([1, 2, 3, 4])
+  math.sum([
+    [1, 2],
+    [3, 4],
+    [5, 6],
+  ])
+
   // expressions
   math.evaluate('1.2 * (2 + 4.5)')
 
@@ -134,6 +151,23 @@ Bignumbers examples
   }
 }
 
+/*
+  Arithmetic function examples
+*/
+{
+  const math = create(all, {})
+
+  const _e: number = math.exp(1)
+  const _bige: BigNumber = math.exp(math.bignumber(1))
+  const _compe: Complex = math.exp(math.complex(1, 0))
+  // TODO: Typescript type declarations are not understanding typed-function's
+  // automatic conversions, so the following do not work:
+
+  // const _compeagain: Complex = math.exp(math.fraction(1, 1))
+  // const _eagain: number = math.exp('1')
+  // const _eanother: number = math.exp(true)
+}
+
 /*
 Chaining examples
 */
@@ -524,21 +558,23 @@ Chaining examples
   expectTypeOf(math.chain(math.complex(1, 2)).cbrt()).toMatchTypeOf<
     MathJsChain<Complex>
   >()
-  expectTypeOf(math.chain([1, 2]).cbrt()).toMatchTypeOf<
-    MathJsChain<MathArray>
-  >()
-  expectTypeOf(
-    math
-      .chain(
-        math.matrix([
-          [1, 2],
-          [3, 4],
-        ])
-      )
-      .cbrt()
-  ).toMatchTypeOf<MathJsChain<Matrix>>()
+  // @ts-expect-error ... verify cbrt does not run on arrays.
+  assert.throws(() => math.chain([1, 2]).cbrt(), TypeError)
+  assert.throws(
+    () =>
+      // @ts-expect-error ... verify cbrt does not run on matrices.
+      math
+        .chain(
+          math.matrix([
+            [1, 2],
+            [3, 4],
+          ])
+        )
+        .cbrt(),
+    TypeError
+  )
 
-  // cbrt
+  // ceil
   expectTypeOf(math.chain(1).ceil()).toMatchTypeOf<
     MathJsChain<MathNumericType>
   >()
@@ -581,19 +617,23 @@ Chaining examples
   expectTypeOf(math.chain(math.complex(1, 2)).cube()).toMatchTypeOf<
     MathJsChain<Complex>
   >()
-  expectTypeOf(math.chain([1, 2]).cube()).toMatchTypeOf<
-    MathJsChain<MathArray>
-  >()
-  expectTypeOf(
-    math
-      .chain(
-        math.matrix([
-          [1, 2],
-          [3, 4],
-        ])
-      )
-      .cube()
-  ).toMatchTypeOf<MathJsChain<Matrix>>()
+
+  // @ts-expect-error ... verify cube does not run on arrays.
+  assert.throws(() => math.chain([1, 2]).cube(), TypeError)
+  assert.throws(
+    () =>
+      // @ts-expect-error ... verify cube does not run on matrices.
+      math
+        .chain(
+          math.matrix([
+            [1, 2],
+            [3, 4],
+          ])
+        )
+        .cube(),
+    TypeError
+  )
+
   expectTypeOf(math.chain(math.unit('furlong')).cube()).toMatchTypeOf<
     MathJsChain<Unit>
   >()
@@ -655,33 +695,40 @@ Chaining examples
 
   // exp
   expectTypeOf(math.chain(1).exp()).toMatchTypeOf<MathJsChain<MathType>>()
-  expectTypeOf(math.chain([1, 2]).exp()).toMatchTypeOf<MathJsChain<MathArray>>()
-  expectTypeOf(
-    math
-      .chain(
-        math.matrix([
-          [1, 2],
-          [3, 4],
-        ])
-      )
-      .exp()
-  ).toMatchTypeOf<MathJsChain<Matrix>>()
+  // @ts-expect-error ... verify exp does not run on arrays.
+  assert.throws(() => math.chain([1, 2]).exp(), TypeError)
+  assert.throws(
+    () =>
+      // @ts-expect-error ... verify exp does not run on matrices.
+      math
+        .chain(
+          math.matrix([
+            [1, 2],
+            [3, 4],
+          ])
+        )
+        .exp(),
+    TypeError
+  )
 
   // expm1
   expectTypeOf(math.chain(1).expm1()).toMatchTypeOf<MathJsChain<MathType>>()
-  expectTypeOf(math.chain([1, 2]).expm1()).toMatchTypeOf<
-    MathJsChain<MathArray>
-  >()
-  expectTypeOf(
-    math
-      .chain(
-        math.matrix([
-          [1, 2],
-          [3, 4],
-        ])
-      )
-      .expm1()
-  ).toMatchTypeOf<MathJsChain<Matrix>>()
+
+  // @ts-expect-error ... verify expm1 does not run on arrays
+  assert.throws(() => math.chain([1, 2]).expm1(), TypeError)
+  assert.throws(
+    () =>
+      // @ts-expect-error ... verify expm1 does not run on arrays
+      math
+        .chain(
+          math.matrix([
+            [1, 2],
+            [3, 4],
+          ])
+        )
+        .expm1(),
+    TypeError
+  )
 
   // gcd
   expectTypeOf(math.chain([1, 2]).gcd(3)).toMatchTypeOf<MathJsChain<number>>()
@@ -765,6 +812,11 @@ Chaining examples
       .log10()
   ).toMatchTypeOf<MathJsChain<Matrix>>()
 
+  expectTypeOf(math.chain([1, 2]).count()).toMatchTypeOf<MathJsChain<number>>()
+  expectTypeOf(math.chain('mathjs').count()).toMatchTypeOf<
+    MathJsChain<number>
+  >()
+  expectTypeOf(math.chain([1, 2]).sum()).toMatchTypeOf<MathJsChain<number>>()
   // TODO complete the rest of these...
 }
 
@@ -775,13 +827,89 @@ Simplify examples
   const math = create(all)
 
   math.simplify('2 * 1 * x ^ (2 - 1)')
+  math.simplifyConstant('2 * 1 * x ^ (2 - 1)')
+  math.simplifyCore('2 * 1 * x ^ (2 - 1)')
   math.simplify('2 * 3 * x', { x: 4 })
 
+  expectTypeOf(math.simplify.rules).toMatchTypeOf<Array<SimplifyRule>>()
+
   const f = math.parse('2 * 1 * x ^ (2 - 1)')
   math.simplify(f)
 
   math.simplify('0.4 * x', {}, { exactFractions: true })
+  math.simplifyConstant('0.4 * x', { exactFractions: true })
   math.simplify('0.4 * x', {}, { exactFractions: false })
+  math.simplify('0.4 * x', {}, { fractionsLimit: 2 })
+  math.simplify('0.4 * x', {}, { consoleDebug: false })
+
+  math.simplify(
+    '0.4 * x',
+    {},
+    {
+      context: {
+        xor: {
+          trivial: true,
+          total: true,
+          commutative: true,
+          associative: true,
+        },
+      },
+    }
+  )
+
+  math.simplify('0.4 * x', [])
+  math.simplify('0.4 * x', [
+    'n * n -> 2n',
+    {
+      s: 'n * n -> 2n',
+      repeat: true,
+      assuming: {
+        multiply: {
+          trivial: true,
+          total: true,
+          commutative: true,
+          associative: true,
+        },
+      },
+      imposeContext: {
+        multiply: {
+          trivial: true,
+          total: true,
+          commutative: true,
+          associative: true,
+        },
+      },
+    },
+    {
+      l: 'n * n',
+      r: '2n',
+      repeat: true,
+      assuming: {
+        multiply: {
+          trivial: true,
+          total: true,
+          commutative: true,
+          associative: true,
+        },
+      },
+      imposeContext: {
+        multiply: {
+          trivial: true,
+          total: true,
+          commutative: true,
+          associative: true,
+        },
+      },
+    },
+    (node: MathNode) => node,
+  ])
+  math.simplifyCore('0.4 * x + 0', { exactFractions: false })
+
+  math
+    .chain('0.4 * x + 0')
+    .parse()
+    .simplifyCore({ exactFractions: false })
+    .simplifyConstant()
 }
 
 /*
@@ -816,8 +944,13 @@ Complex numbers examples
 
   // create a complex number from polar coordinates
   {
-    const p: math.PolarCoordinates = { r: math.sqrt(2), phi: math.pi / 4 }
-    const _c: math.Complex = math.complex(p)
+    const p: math.PolarCoordinates = {
+      r: math.sqrt(2) as number, // must be real but a sqrt could be Complex
+      phi: math.pi / 4,
+    }
+    const c: math.Complex = math.complex(p)
+    assert.strictEqual(c.im, 1)
+    assert.ok(Math.abs(c.re - 1) < 1e-12)
   }
 
   // get polar coordinates of a complex number
@@ -988,6 +1121,11 @@ Matrices examples
   const b: math.Matrix = math.matrix(math.ones([2, 3]))
   b.size()
 
+  // @ts-expect-error ... ones() in a chain cannot take more dimensions
+  assert.throws(() => math.chain(3).ones(2, 'dense').done(), /Error:.*ones/)
+  // @ts-expect-error ... and neither can zeros()
+  assert.throws(() => math.chain(3).zeros(2, 'sparse').done(), /Error:.*zeros/)
+
   // the Array data of a Matrix can be retrieved using valueOf()
   const _array = a.valueOf()
 
@@ -995,7 +1133,7 @@ Matrices examples
   const _clone: math.Matrix = a.clone()
 
   // perform operations with matrices
-  math.sqrt(a)
+  math.map(a, math.sqrt)
   math.factorial(a)
 
   // create and manipulate matrices. Arrays and Matrices can be used mixed.
@@ -1143,6 +1281,69 @@ Matrices examples
   }
 }
 
+/*
+Math types examples: Type results after multiplying  'MathTypes' with matrices
+ */
+{
+  const math = create(all, {})
+
+  const abc: MathArray = [1, 2, 3, 4]
+  const bcd: MathArray = [
+    [1, 2, 3, 4],
+    [2, 3, 4, 5],
+    [4, 5, 6, 7],
+    [5, 6, 7, 8],
+  ]
+
+  const Mbcd = math.matrix(bcd)
+  const Mabc = math.matrix(abc)
+
+  // Number
+  const _r1 = math.multiply(1, 2)
+
+  // Unit
+  const a = math.unit(45, 'cm') // 450 mm
+  const b = math.unit(45, 'cm') // 450 mm
+  const _r2 = math.multiply(a, b)
+
+  // 1D JS Array
+  const r3 = math.multiply(abc, bcd)
+  r3[1] // By default least promised valid syntax
+
+  // 2D JS Array
+  const r12 = math.multiply(bcd, bcd)
+  // Example to sort ambiguity between multidimensional & singledimensional arrays
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const multiDimensional = (x: any): x is any[][] => x.length && x[0].length
+  if (multiDimensional(r12)) {
+    r12[1][1]
+  }
+  r12[1] // Valid syntax
+
+  // Matrix: matrix * vector
+  const r7 = math.multiply(Mabc, bcd)
+  r7.toArray() // Matrix-es have toArray function
+
+  // Matrix
+  const _r8 = math.multiply(Mabc, 4)
+
+  // Matrix
+  const _r11 = math.multiply(4, Mabc)
+
+  // Matrix of units
+  const _r9 = math.multiply(Mabc, a)
+  const _r10 = math.multiply(a, Mabc)
+
+  // Matrix
+  const _r6 = math.multiply(abc, Mbcd)
+
+  // 2D JS Array
+  const _r5 = math.multiply(bcd, abc)
+
+  // Number
+  const _r4 = math.multiply(abc, math.transpose(abc))
+}
+
 /*
 Sparse matrices examples
 */
@@ -1218,6 +1419,7 @@ Units examples
   // use Unit as definition
   math.createUnit('c', { definition: b })
   math.createUnit('c', { definition: b }, { override: true })
+  math.createUnit('customUnit', math.unit(0.5, 'm'))
 
   // units can be added, subtracted, and multiplied or divided by numbers and by other units
   math.add(a, b)
@@ -2020,11 +2222,16 @@ Resolve examples
 {
   const math = create(all, {})
 
+  expectTypeOf(math.resolve('x + y')).toMatchTypeOf<MathNode>()
   expectTypeOf(math.resolve(math.parse('x + y'))).toMatchTypeOf<MathNode>()
   expectTypeOf(
     math.resolve(math.parse('x + y'), { x: 0 })
   ).toMatchTypeOf<MathNode>()
-  expectTypeOf(math.resolve([math.parse('x + y')], { x: 0 })).toMatchTypeOf<
-    MathNode[]
-  >()
+  expectTypeOf(math.resolve('x + y', { x: 0 })).toMatchTypeOf<MathNode>()
+  expectTypeOf(
+    math.resolve([math.parse('x + y'), 'x*x'], { x: 0 })
+  ).toMatchTypeOf<MathNode[]>()
+  expectTypeOf(
+    math.resolve(math.matrix(['x', 'y']))
+  ).toMatchTypeOf<math.Matrix>()
 }

package/lib/cjs/utils/polyfills.js

@@ -1,14 +0,0 @@
-"use strict";
-
-// TODO: remove these polyfills as soon as we have a build process that transpiles the code to ES5
-// Polyfill for IE 11 (Number.isFinite is used in `complex.js`)
-// source: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isFinite
-Number.isFinite = Number.isFinite || function (value) {
-  return typeof value === 'number' && isFinite(value);
-}; // Polyfill for IE 11
-// source: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isNaN
-
-
-Number.isNaN = Number.isNaN || function (value) {
-  return value !== value; // eslint-disable-line no-self-compare
-};

package/lib/esm/utils/polyfills.js

@@ -1,12 +0,0 @@
-// TODO: remove these polyfills as soon as we have a build process that transpiles the code to ES5
-// Polyfill for IE 11 (Number.isFinite is used in `complex.js`)
-// source: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isFinite
-Number.isFinite = Number.isFinite || function (value) {
-  return typeof value === 'number' && isFinite(value);
-}; // Polyfill for IE 11
-// source: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isNaN
-
-
-Number.isNaN = Number.isNaN || function (value) {
-  return value !== value; // eslint-disable-line no-self-compare
-};