mathjs 10.0.2 → 10.1.0

package/lib/esm/function/algebra/simplify/simplifyConstant.js

@@ -1,20 +1,25 @@
 // TODO this could be improved by simplifying seperated constants under associative and commutative operators
-import { isFraction, isNode, isOperatorNode } from '../../../utils/is.js';
+import { isFraction, isMatrix, isNode, isArrayNode, isConstantNode, isIndexNode, isObjectNode, isOperatorNode } from '../../../utils/is.js';
 import { factory } from '../../../utils/factory.js';
 import { createUtil } from './util.js';
 import { noBignumber, noFraction } from '../../../utils/noop.js';
 var name = 'simplifyConstant';
-var dependencies = ['typed', 'config', 'mathWithTransform', '?fraction', '?bignumber', 'ConstantNode', 'OperatorNode', 'FunctionNode', 'SymbolNode'];
+var dependencies = ['typed', 'config', 'mathWithTransform', 'matrix', '?fraction', '?bignumber', 'AccessorNode', 'ArrayNode', 'ConstantNode', 'FunctionNode', 'IndexNode', 'ObjectNode', 'OperatorNode', 'SymbolNode'];
 export var createSimplifyConstant = /* #__PURE__ */factory(name, dependencies, _ref => {
   var {
     typed,
     config,
     mathWithTransform,
+    matrix,
     fraction,
     bignumber,
+    AccessorNode,
+    ArrayNode,
     ConstantNode,
-    OperatorNode,
     FunctionNode,
+    IndexNode,
+    ObjectNode,
+    OperatorNode,
     SymbolNode
   } = _ref;
   var {
@@ -29,22 +34,31 @@ export var createSimplifyConstant = /* #__PURE__ */factory(name, dependencies, _
   });
 
   function simplifyConstant(expr, options) {
-    var res = foldFraction(expr, options);
-    return isNode(res) ? res : _toNode(res);
+    return _ensureNode(foldFraction(expr, options));
+  }
+
+  function _removeFractions(thing) {
+    if (isFraction(thing)) {
+      return thing.valueOf();
+    }
+
+    if (thing instanceof Array) {
+      return thing.map(_removeFractions);
+    }
+
+    if (isMatrix(thing)) {
+      return matrix(_removeFractions(thing.valueOf()));
+    }
+
+    return thing;
   }
 
   function _eval(fnname, args, options) {
     try {
-      return _toNumber(mathWithTransform[fnname].apply(null, args), options);
+      return mathWithTransform[fnname].apply(null, args);
     } catch (ignore) {
       // sometimes the implicit type conversion causes the evaluation to fail, so we'll try again after removing Fractions
-      args = args.map(function (x) {
-        if (isFraction(x)) {
-          return x.valueOf();
-        }
-
-        return x;
-      });
+      args = args.map(_removeFractions);
       return _toNumber(mathWithTransform[fnname].apply(null, args), options);
     }
   }
@@ -67,8 +81,22 @@ export var createSimplifyConstant = /* #__PURE__ */factory(name, dependencies, _
     },
     Complex: function Complex(s) {
       throw new Error('Cannot convert Complex number to Node');
+    },
+    string: function string(s) {
+      return new ConstantNode(s);
+    },
+    Matrix: function Matrix(m) {
+      return new ArrayNode(m.valueOf().map(e => _toNode(e)));
+    }
+  });
+
+  function _ensureNode(thing) {
+    if (isNode(thing)) {
+      return thing;
     }
-  }); // convert a number to a fraction only if it can be expressed exactly,
+
+    return _toNode(thing);
+  } // convert a number to a fraction only if it can be expressed exactly,
   // and when both numerator and denominator are small enough
 
 
@@ -125,6 +153,12 @@ export var createSimplifyConstant = /* #__PURE__ */factory(name, dependencies, _
       }
 
       return _exactFraction(s.re, options);
+    },
+    'Matrix, Object': function MatrixObject(s, options) {
+      return matrix(_exactFraction(s.valueOf()));
+    },
+    'Array, Object': function ArrayObject(s, options) {
+      return s.map(_exactFraction);
     }
   });
 
@@ -148,6 +182,103 @@ export var createSimplifyConstant = /* #__PURE__ */factory(name, dependencies, _
 
     return new OperatorNode('/', 'divide', [n, new ConstantNode(f.d)]);
   }
+  /* Handles constant indexing of ArrayNodes, matrices, and ObjectNodes */
+
+
+  function _foldAccessor(obj, index, options) {
+    if (!isIndexNode(index)) {
+      // don't know what to do with that...
+      return new AccessorNode(_ensureNode(obj), _ensureNode(index));
+    }
+
+    if (isArrayNode(obj) || isMatrix(obj)) {
+      var remainingDims = Array.from(index.dimensions);
+      /* We will resolve constant indices one at a time, looking
+       * just in the first or second dimensions because (a) arrays
+       * of more than two dimensions are likely rare, and (b) pulling
+       * out the third or higher dimension would be pretty intricate.
+       * The price is that we miss simplifying [..3d array][x,y,1]
+       */
+
+      while (remainingDims.length > 0) {
+        if (isConstantNode(remainingDims[0]) && typeof remainingDims[0].value !== 'string') {
+          var first = _toNumber(remainingDims.shift().value, options);
+
+          if (isArrayNode(obj)) {
+            obj = obj.items[first - 1];
+          } else {
+            // matrix
+            obj = obj.valueOf()[first - 1];
+
+            if (obj instanceof Array) {
+              obj = matrix(obj);
+            }
+          }
+        } else if (remainingDims.length > 1 && isConstantNode(remainingDims[1]) && typeof remainingDims[1].value !== 'string') {
+          var second = _toNumber(remainingDims[1].value, options);
+
+          var tryItems = [];
+          var fromItems = isArrayNode(obj) ? obj.items : obj.valueOf();
+
+          for (var item of fromItems) {
+            if (isArrayNode(item)) {
+              tryItems.push(item.items[second - 1]);
+            } else if (isMatrix(obj)) {
+              tryItems.push(item[second - 1]);
+            } else {
+              break;
+            }
+          }
+
+          if (tryItems.length === fromItems.length) {
+            if (isArrayNode(obj)) {
+              obj = new ArrayNode(tryItems);
+            } else {
+              // matrix
+              obj = matrix(tryItems);
+            }
+
+            remainingDims.splice(1, 1);
+          } else {
+            // extracting slice along 2nd dimension failed, give up
+            break;
+          }
+        } else {
+          // neither 1st or 2nd dimension is constant, give up
+          break;
+        }
+      }
+
+      if (remainingDims.length === index.dimensions.length) {
+        /* No successful constant indexing */
+        return new AccessorNode(_ensureNode(obj), index);
+      }
+
+      if (remainingDims.length > 0) {
+        /* Indexed some but not all dimensions */
+        index = new IndexNode(remainingDims);
+        return new AccessorNode(_ensureNode(obj), index);
+      }
+      /* All dimensions were constant, access completely resolved */
+
+
+      return obj;
+    }
+
+    if (isObjectNode(obj) && index.dimensions.length === 1 && isConstantNode(index.dimensions[0])) {
+      var key = index.dimensions[0].value;
+
+      if (key in obj.properties) {
+        return obj.properties[key];
+      }
+
+      return new ConstantNode(); // undefined
+    }
+    /* Don't know how to index this sort of obj, at least not with this index */
+
+
+    return new AccessorNode(_ensureNode(obj), index);
+  }
   /*
    * Create a binary tree from a list of Fractions and Nodes.
    * Tries to fold Fractions by evaluating them until the first Node in the list is hit, so
@@ -186,8 +317,15 @@ export var createSimplifyConstant = /* #__PURE__ */factory(name, dependencies, _
         return node;
 
       case 'ConstantNode':
-        if (typeof node.value === 'number' || !isNaN(node.value)) {
-          return _toNumber(node.value, options);
+        switch (typeof node.value) {
+          case 'number':
+            return _toNumber(node.value, options);
+
+          case 'string':
+            return node.value;
+
+          default:
+            if (!isNaN(node.value)) return _toNumber(node.value, options);
         }
 
         return node;
@@ -207,14 +345,24 @@ export var createSimplifyConstant = /* #__PURE__ */factory(name, dependencies, _
             if (!args.some(isNode)) {
               try {
                 return _eval(node.name, args, options);
-              } catch (ignoreandcontine) {}
+              } catch (ignoreandcontinue) {}
+            } // Size of a matrix does not depend on entries
+
+
+            if (node.name === 'size' && args.length === 1 && isArrayNode(args[0])) {
+              var sz = [];
+              var section = args[0];
+
+              while (isArrayNode(section)) {
+                sz.push(section.items.length);
+                section = section.items[0];
+              }
+
+              return matrix(sz);
             } // Convert all args to nodes and construct a symbolic function call
 
 
-            args = args.map(function (arg) {
-              return isNode(arg) ? arg : _toNode(arg);
-            });
-            return new FunctionNode(node.name, args);
+            return new FunctionNode(node.name, args.map(_ensureNode));
           } else {// treat as operator
           }
         }
@@ -281,10 +429,36 @@ export var createSimplifyConstant = /* #__PURE__ */factory(name, dependencies, _
         return foldFraction(node.content, options);
 
       case 'AccessorNode':
-      /* falls through */
+        return _foldAccessor(foldFraction(node.object, options), foldFraction(node.index, options), options);
 
       case 'ArrayNode':
-      /* falls through */
+        {
+          var foldItems = node.items.map(item => foldFraction(item, options));
+
+          if (foldItems.some(isNode)) {
+            return new ArrayNode(foldItems.map(_ensureNode));
+          }
+          /* All literals -- return a Matrix so we can operate on it */
+
+
+          return matrix(foldItems);
+        }
+
+      case 'IndexNode':
+        {
+          return new IndexNode(node.dimensions.map(n => simplifyConstant(n, options)));
+        }
+
+      case 'ObjectNode':
+        {
+          var foldProps = {};
+
+          for (var prop in node.properties) {
+            foldProps[prop] = simplifyConstant(node.properties[prop], options);
+          }
+
+          return new ObjectNode(foldProps);
+        }
 
       case 'AssignmentNode':
       /* falls through */
@@ -295,12 +469,6 @@ export var createSimplifyConstant = /* #__PURE__ */factory(name, dependencies, _
       case 'FunctionAssignmentNode':
       /* falls through */
 
-      case 'IndexNode':
-      /* falls through */
-
-      case 'ObjectNode':
-      /* falls through */
-
       case 'RangeNode':
       /* falls through */
 

package/lib/esm/function/algebra/simplify/simplifyCore.js

@@ -1,7 +1,7 @@
-import { isConstantNode, isFunctionNode, isOperatorNode, isParenthesisNode, isSymbolNode } from '../../../utils/is.js';
+import { isAccessorNode, isArrayNode, isConstantNode, isFunctionNode, isIndexNode, isObjectNode, isOperatorNode, isParenthesisNode, isSymbolNode } from '../../../utils/is.js';
 import { factory } from '../../../utils/factory.js';
 var name = 'simplifyCore';
-var dependencies = ['equal', 'isZero', 'add', 'subtract', 'multiply', 'divide', 'pow', 'ConstantNode', 'OperatorNode', 'FunctionNode', 'ParenthesisNode'];
+var dependencies = ['equal', 'isZero', 'add', 'subtract', 'multiply', 'divide', 'pow', 'AccessorNode', 'ArrayNode', 'ConstantNode', 'FunctionNode', 'IndexNode', 'ObjectNode', 'OperatorNode', 'ParenthesisNode'];
 export var createSimplifyCore = /* #__PURE__ */factory(name, dependencies, _ref => {
   var {
     equal,
@@ -11,13 +11,23 @@ export var createSimplifyCore = /* #__PURE__ */factory(name, dependencies, _ref
     multiply,
     divide,
     pow,
+    AccessorNode,
+    ArrayNode,
     ConstantNode,
-    OperatorNode,
     FunctionNode,
+    IndexNode,
+    ObjectNode,
+    OperatorNode,
     ParenthesisNode
   } = _ref;
   var node0 = new ConstantNode(0);
   var node1 = new ConstantNode(1);
+
+  function mapSimplifyCore(nodeArray) {
+    return nodeArray.map(simplifyCore).map(function (arg) {
+      return isParenthesisNode(arg) ? arg.content : arg;
+    });
+  }
   /**
    * simplifyCore() performs single pass simplification suitable for
    * applications requiring ultimate performance. In contrast, simplify()
@@ -42,6 +52,7 @@ export var createSimplifyCore = /* #__PURE__ */factory(name, dependencies, _ref
    *     The expression to be simplified
    */
 
+
   function simplifyCore(node) {
     if (isOperatorNode(node) && node.isUnary()) {
       var a0 = simplifyCore(node.args[0]);
@@ -177,10 +188,27 @@ export var createSimplifyCore = /* #__PURE__ */factory(name, dependencies, _ref
 
       return new ParenthesisNode(c);
     } else if (isFunctionNode(node)) {
-      var args = node.args.map(simplifyCore).map(function (arg) {
-        return isParenthesisNode(arg) ? arg.content : arg;
-      });
-      return new FunctionNode(simplifyCore(node.fn), args);
+      return new FunctionNode(simplifyCore(node.fn), mapSimplifyCore(node.args));
+    } else if (isArrayNode(node)) {
+      return new ArrayNode(mapSimplifyCore(node.items));
+    } else if (isAccessorNode(node)) {
+      var obj = mapSimplifyCore(node.object);
+
+      if (isParenthesisNode(obj)) {
+        obj = obj.content;
+      }
+
+      return new AccessorNode(obj, simplifyCore(node.index));
+    } else if (isIndexNode(node)) {
+      return new IndexNode(mapSimplifyCore(node.dimensions));
+    } else if (isObjectNode(node)) {
+      var newProps = {};
+
+      for (var prop in node.properties) {
+        newProps[prop] = simplifyCore(node.properties[prop]);
+      }
+
+      return new ObjectNode(newProps);
     } else {// cannot simplify
     }
 

package/lib/esm/function/algebra/simplify.js

@@ -7,7 +7,7 @@ import { createResolve } from './simplify/resolve.js';
 import { hasOwnProperty } from '../../utils/object.js';
 import { createEmptyMap, createMap } from '../../utils/map.js';
 var name = 'simplify';
-var dependencies = ['config', 'typed', 'parse', 'add', 'subtract', 'multiply', 'divide', 'pow', 'isZero', 'equal', '?fraction', '?bignumber', 'mathWithTransform', 'ConstantNode', 'FunctionNode', 'OperatorNode', 'ParenthesisNode', 'SymbolNode'];
+var dependencies = ['config', 'typed', 'parse', 'add', 'subtract', 'multiply', 'divide', 'pow', 'isZero', 'equal', '?fraction', '?bignumber', 'mathWithTransform', 'matrix', 'AccessorNode', 'ArrayNode', 'ConstantNode', 'FunctionNode', 'IndexNode', 'ObjectNode', 'OperatorNode', 'ParenthesisNode', 'SymbolNode'];
 export var createSimplify = /* #__PURE__ */factory(name, dependencies, _ref => {
   var {
     config,
@@ -23,8 +23,13 @@ export var createSimplify = /* #__PURE__ */factory(name, dependencies, _ref => {
     fraction,
     bignumber,
     mathWithTransform,
+    matrix,
+    AccessorNode,
+    ArrayNode,
     ConstantNode,
     FunctionNode,
+    IndexNode,
+    ObjectNode,
     OperatorNode,
     ParenthesisNode,
     SymbolNode
@@ -33,11 +38,16 @@ export var createSimplify = /* #__PURE__ */factory(name, dependencies, _ref => {
     typed,
     config,
     mathWithTransform,
+    matrix,
     fraction,
     bignumber,
+    AccessorNode,
+    ArrayNode,
     ConstantNode,
-    OperatorNode,
     FunctionNode,
+    IndexNode,
+    ObjectNode,
+    OperatorNode,
     SymbolNode
   });
   var simplifyCore = createSimplifyCore({
@@ -48,9 +58,13 @@ export var createSimplify = /* #__PURE__ */factory(name, dependencies, _ref => {
     multiply,
     divide,
     pow,
+    AccessorNode,
+    ArrayNode,
     ConstantNode,
-    OperatorNode,
     FunctionNode,
+    IndexNode,
+    ObjectNode,
+    OperatorNode,
     ParenthesisNode
   });
   var resolve = createResolve({
@@ -262,17 +276,19 @@ export var createSimplify = /* #__PURE__ */factory(name, dependencies, _ref => {
     l: 'log(e)',
     r: '1'
   }, // temporary rules
+  // Note initially we tend constants to the right because like-term
+  // collection prefers the left, and we would rather collect nonconstants
   {
     l: 'n-n1',
     r: 'n+-n1'
   }, // temporarily replace 'subtract' so we can further flatten the 'add' operator
   {
     l: '-(c*v)',
-    r: '(-c) * v'
+    r: 'v * (-c)'
   }, // make non-constant terms positive
   {
     l: '-v',
-    r: '(-1) * v'
+    r: 'v * (-1)'
   }, {
     l: 'n/n1^n2',
     r: 'n*n1^-n2'
@@ -280,6 +296,17 @@ export var createSimplify = /* #__PURE__ */factory(name, dependencies, _ref => {
   {
     l: 'n/n1',
     r: 'n*n1^-1'
+  }, // remove parenthesis in the case of negating a quantity
+  {
+    l: 'n1 + (n2 + n3)*(-1)',
+    r: 'n1 + n2*(-1) + n3*(-1)'
+  }, // subsume resulting -1 into constants where possible
+  {
+    l: '(-1) * c',
+    r: '-c'
+  }, {
+    l: '(-1) * (-c)',
+    r: 'c'
   }, // expand nested exponentiation
   {
     l: '(n ^ n1) ^ n2',
@@ -302,20 +329,21 @@ export var createSimplify = /* #__PURE__ */factory(name, dependencies, _ref => {
     l: 'n+-n',
     r: '0'
   }, {
-    l: 'n1*n2 + n2',
-    r: '(n1+1)*n2'
-  }, {
-    l: 'n1*n3 + n2*n3',
-    r: '(n1+n2)*n3'
-  }, // remove parenthesis in the case of negating a quantitiy
+    l: 'v*n + v',
+    r: 'v*(n+1)'
+  }, // NOTE: leftmost position is special:
   {
-    l: 'n1 + -1 * (n2 + n3)',
-    r: 'n1 + -1 * n2 + -1 * n3'
+    l: 'n3*n1 + n3*n2',
+    r: 'n3*(n1+n2)'
+  }, // All sub-monomials tried there.
+  {
+    l: 'n*c + c',
+    r: '(n+1)*c'
   }, simplifyConstant, {
     l: '(-n)*n1',
     r: '-(n*n1)'
   }, // make factors positive (and undo 'make non-constant terms positive')
-  // ordering of constants
+  // final ordering of constants
   {
     l: 'c+v',
     r: 'v+c',
@@ -419,7 +447,7 @@ export var createSimplify = /* #__PURE__ */factory(name, dependencies, _ref => {
           };
 
           if (rule.context) {
-            newRule.evaluate = rule.context;
+            newRule.context = rule.context;
           }
 
           if (rule.evaluate) {
@@ -463,6 +491,14 @@ export var createSimplify = /* #__PURE__ */factory(name, dependencies, _ref => {
   function _getExpandPlaceholderSymbol() {
     return new SymbolNode('_p' + _lastsym++);
   }
+
+  function mapRule(nodes, rule) {
+    if (nodes) {
+      for (var i = 0; i < nodes.length; ++i) {
+        nodes[i] = applyRule(nodes[i], rule);
+      }
+    }
+  }
   /**
    * Returns a simplfied form of node, or the original node if no simplification was possible.
    *
@@ -476,19 +512,31 @@ export var createSimplify = /* #__PURE__ */factory(name, dependencies, _ref => {
       // console.log('Entering applyRule(' + node.toString() + ')')
       // Do not clone node unless we find a match
       var res = node; // First replace our child nodes with their simplified versions
-      // If a child could not be simplified, the assignments will have
-      // no effect since the node is returned unchanged
+      // If a child could not be simplified, applying the rule to it
+      // will have no effect since the node is returned unchanged
 
       if (res instanceof OperatorNode || res instanceof FunctionNode) {
-        if (res.args) {
-          for (var i = 0; i < res.args.length; i++) {
-            res.args[i] = applyRule(res.args[i], rule);
-          }
-        }
+        mapRule(res.args, rule);
       } else if (res instanceof ParenthesisNode) {
         if (res.content) {
           res.content = applyRule(res.content, rule);
         }
+      } else if (res instanceof ArrayNode) {
+        mapRule(res.items, rule);
+      } else if (res instanceof AccessorNode) {
+        if (res.object) {
+          res.object = applyRule(res.object, rule);
+        }
+
+        if (res.index) {
+          res.index = applyRule(res.index, rule);
+        }
+      } else if (res instanceof IndexNode) {
+        mapRule(res.dimensions, rule);
+      } else if (res instanceof ObjectNode) {
+        for (var prop in res.properties) {
+          res.properties[prop] = applyRule(res.properties[prop], rule);
+        }
       } // Try to match a rule against this node
 
 

package/lib/esm/function/arithmetic/invmod.js

@@ -0,0 +1,57 @@
+import { factory } from '../../utils/factory.js';
+var name = 'invmod';
+var dependencies = ['typed', 'config', 'BigNumber', 'xgcd', 'equal', 'smaller', 'mod', 'add', 'isInteger'];
+export var createInvmod = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    typed,
+    config,
+    BigNumber,
+    xgcd,
+    equal,
+    smaller,
+    mod,
+    add,
+    isInteger
+  } = _ref;
+
+  /**
+   * Calculate the (modular) multiplicative inverse of a modulo b. Solution to the equation `ax ≣ 1 (mod b)`
+   * See https://en.wikipedia.org/wiki/Modular_multiplicative_inverse.
+   *
+   * Syntax:
+   *
+   *    math.invmod(a, b)
+   *
+   * Examples:
+   *
+   *    math.invmod(8, 12)             // returns NaN
+   *    math.invmod(7, 13)             // return 2
+   *    math.invmod(15151, 15122)      // returns 10429
+   *
+   * See also:
+   *
+   *    gcd, xgcd
+   *
+   * @param {number | BigNumber} a  An integer number
+   * @param {number | BigNumber} b  An integer number
+   * @return {number | BigNumber }  Returns an integer number
+   *                              where `invmod(a,b)*a ≣ 1 (mod b)`
+   */
+  return typed(name, {
+    'number, number': invmod,
+    'BigNumber, BigNumber': invmod
+  });
+
+  function invmod(a, b) {
+    if (!isInteger(a) || !isInteger(b)) throw new Error('Parameters in function invmod must be integer numbers');
+    a = mod(a, b);
+    if (equal(b, 0)) throw new Error('Divisor must be non zero');
+    var res = xgcd(a, b);
+    res = res.valueOf();
+    var [gcd, inv] = res;
+    if (!equal(gcd, BigNumber(1))) return NaN;
+    inv = mod(inv, b);
+    if (smaller(inv, BigNumber(0))) inv = add(inv, b);
+    return inv;
+  }
+});

package/lib/esm/header.js

@@ -10,7 +10,7 @@
  * @date    @@date
  *
  * @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

package/lib/esm/version.js

@@ -1,2 +1,2 @@
-export var version = '10.0.2'; // Note: This file is automatically generated when building math.js.
+export var version = '10.1.0'; // Note: This file is automatically generated when building math.js.
 // Changes made in this file will be overwritten.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mathjs",
-  "version": "10.0.2",
+  "version": "10.1.0",
   "description": "Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with different data types like numbers, big numbers, complex numbers, fractions, units, and matrices.",
   "author": "Jos de Jong <wjosdejong@gmail.com> (https://github.com/josdejong)",
   "homepage": "https://mathjs.org",
@@ -131,6 +131,7 @@
     "compile": "gulp --gulpfile gulpfile.cjs compile",
     "watch": "gulp --gulpfile gulpfile.cjs watch",
     "lint": "standard --env=mocha --env=worker",
+    "format": "npm run lint -- --fix",
     "validate:ascii": "gulp --gulpfile gulpfile.cjs validate:ascii",
     "test": "npm run test:src && npm run lint",
     "test:src": "mocha test/unit-tests",