mathjs 10.0.2 → 10.2.0

package/lib/esm/expression/embeddedDocs/embeddedDocs.js

@@ -1,4 +1,5 @@
 import { bignumberDocs } from './construction/bignumber.js';
+import { printDocs } from './function/utils/print.js';
 import { typeOfDocs } from './function/utils/typeOf.js';
 import { isZeroDocs } from './function/utils/isZero.js';
 import { isPrimeDocs } from './function/utils/isPrime.js';
@@ -135,6 +136,7 @@ import { bitOrDocs } from './function/bitwise/bitOr.js';
 import { bitNotDocs } from './function/bitwise/bitNot.js';
 import { bitAndDocs } from './function/bitwise/bitAnd.js';
 import { xgcdDocs } from './function/arithmetic/xgcd.js';
+import { invmodDocs } from './function/arithmetic/invmod.js';
 import { unaryPlusDocs } from './function/arithmetic/unaryPlus.js';
 import { unaryMinusDocs } from './function/arithmetic/unaryMinus.js';
 import { squareDocs } from './function/arithmetic/square.js';
@@ -173,8 +175,11 @@ import { qrDocs } from './function/algebra/qr.js';
 import { usolveDocs } from './function/algebra/usolve.js';
 import { usolveAllDocs } from './function/algebra/usolveAll.js';
 import { sluDocs } from './function/algebra/slu.js';
+import { leafCountDocs } from './function/algebra/leafCount.js';
 import { rationalizeDocs } from './function/algebra/rationalize.js';
 import { simplifyDocs } from './function/algebra/simplify.js';
+import { simplifyCoreDocs } from './function/algebra/simplifyCore.js';
+import { resolveDocs } from './function/algebra/resolve.js';
 import { lupDocs } from './function/algebra/lup.js';
 import { lsolveDocs } from './function/algebra/lsolve.js';
 import { lsolveAllDocs } from './function/algebra/lsolveAll.js';
@@ -464,7 +469,10 @@ export var embeddedDocs = {
   lsolveAll: lsolveAllDocs,
   lup: lupDocs,
   lusolve: lusolveDocs,
+  leafCount: leafCountDocs,
   simplify: simplifyDocs,
+  resolve: resolveDocs,
+  simplifyCore: simplifyCoreDocs,
   rationalize: rationalizeDocs,
   slu: sluDocs,
   usolve: usolveDocs,
@@ -507,6 +515,7 @@ export var embeddedDocs = {
   unaryMinus: unaryMinusDocs,
   unaryPlus: unaryPlusDocs,
   xgcd: xgcdDocs,
+  invmod: invmodDocs,
   // functions - bitwise
   bitAnd: bitAndDocs,
   bitNot: bitNotDocs,
@@ -668,7 +677,7 @@ export var embeddedDocs = {
   isPositive: isPositiveDocs,
   isPrime: isPrimeDocs,
   isZero: isZeroDocs,
-  // print: printDocs // TODO: add documentation for print as soon as the parser supports objects.
+  print: printDocs,
   typeOf: typeOfDocs,
   numeric: numericDocs
 };

package/lib/esm/expression/embeddedDocs/function/algebra/leafCount.js

@@ -0,0 +1,8 @@
+export var leafCountDocs = {
+  name: 'leafCount',
+  category: 'Algebra',
+  syntax: ['leafCount(expr)'],
+  description: 'Computes the number of leaves in the parse tree of the given expression',
+  examples: ['leafCount("e^(i*pi)-1")', 'leafCount(parse("{a: 22/7, b: 10^(1/2)}"))'],
+  seealso: ['simplify']
+};

package/lib/esm/expression/embeddedDocs/function/algebra/resolve.js

@@ -0,0 +1,9 @@
+export var resolveDocs = {
+  name: 'resolve',
+  category: 'Algebra',
+  syntax: ['resolve(node, scope)'],
+  description: 'Recursively substitute variables in an expression tree.',
+  examples: ['resolve(parse("1 + x"), { x: 7 })', 'resolve(parse("size(text)"), { text: "Hello World" })', 'resolve(parse("x + y"), { x: parse("3z") })', 'resolve(parse("3x"), { x: parse("y+z"), z: parse("w^y") })'],
+  seealso: ['simplify', 'evaluate'],
+  mayThrow: ['ReferenceError']
+};

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

@@ -4,5 +4,5 @@ export var simplifyDocs = {
   syntax: ['simplify(expr)', 'simplify(expr, rules)'],
   description: 'Simplify an expression tree.',
   examples: ['simplify("3 + 2 / 4")', 'simplify("2x + x")', 'f = parse("x * (x + 2 + x)")', 'simplified = simplify(f)', 'simplified.evaluate({x: 2})'],
-  seealso: ['derivative', 'parse', 'evaluate']
+  seealso: ['simplifyCore', 'derivative', 'evaluate', 'parse', 'rationalize', 'resolve']
 };

package/lib/esm/expression/embeddedDocs/function/algebra/simplifyCore.js

@@ -0,0 +1,8 @@
+export var simplifyCoreDocs = {
+  name: 'simplifyCore',
+  category: 'Algebra',
+  syntax: ['simplifyCore(node)'],
+  description: 'Perform simple one-pass simplifications on an expression tree.',
+  examples: ['simplifyCore(parse("0*x"))', 'simplifyCore(parse("(x+0)*2"))'],
+  seealso: ['simplify', 'evaluate']
+};

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

@@ -0,0 +1,8 @@
+export var invmodDocs = {
+  name: 'invmod',
+  category: 'Arithmetic',
+  syntax: ['invmod(a, b)'],
+  description: 'Calculate the (modular) multiplicative inverse of a modulo b. Solution to the equation ax ≣ 1 (mod b)',
+  examples: ['invmod(8, 12)=NaN', 'invmod(7, 13)=2', 'math.invmod(15151, 15122)=10429'],
+  seealso: ['gcd', 'xgcd']
+};

package/lib/esm/expression/embeddedDocs/function/matrix/forEach.js

@@ -3,6 +3,6 @@ export var forEachDocs = {
   category: 'Matrix',
   syntax: ['forEach(x, callback)'],
   description: 'Iterates over all elements of a matrix/array, and executes the given callback function.',
-  examples: ['forEach([1, 2, 3], function(val) { console.log(val) })'],
+  examples: [],
   seealso: ['map', 'sort', 'filter']
 };

package/lib/esm/factoriesAny.js

@@ -53,6 +53,7 @@ export { createSqrt } from './function/arithmetic/sqrt.js';
 export { createSquare } from './function/arithmetic/square.js';
 export { createSubtract } from './function/arithmetic/subtract.js';
 export { createXgcd } from './function/arithmetic/xgcd.js';
+export { createInvmod } from './function/arithmetic/invmod.js';
 export { createDotMultiply } from './function/arithmetic/dotMultiply.js';
 export { createBitAnd } from './function/bitwise/bitAnd.js';
 export { createBitNot } from './function/bitwise/bitNot.js';
@@ -240,7 +241,10 @@ export { createStirlingS2 } from './function/combinatorics/stirlingS2.js';
 export { createBellNumbers } from './function/combinatorics/bellNumbers.js';
 export { createCatalan } from './function/combinatorics/catalan.js';
 export { createComposition } from './function/combinatorics/composition.js';
+export { createLeafCount } from './function/algebra/leafCount.js';
 export { createSimplify } from './function/algebra/simplify.js';
+export { createSimplifyCore } from './function/algebra/simplifyCore.js';
+export { createResolve } from './function/algebra/resolve.js';
 export { createDerivative } from './function/algebra/derivative.js';
 export { createRationalize } from './function/algebra/rationalize.js';
 export { createReviver } from './json/reviver.js';

package/lib/esm/factoriesNumber.js

@@ -13,7 +13,9 @@ export { createChainClass } from './type/chain/Chain.js';
 export { createHelp } from './expression/function/help.js';
 export { createChain } from './type/chain/function/chain.js'; // algebra
 
+export { createResolve } from './function/algebra/resolve.js';
 export { createSimplify } from './function/algebra/simplify.js';
+export { createSimplifyCore } from './function/algebra/simplifyCore.js';
 export { createDerivative } from './function/algebra/derivative.js';
 export { createRationalize } from './function/algebra/rationalize.js'; // arithmetic
 

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

@@ -0,0 +1,59 @@
+import { factory } from '../../utils/factory.js';
+var name = 'leafCount';
+var dependencies = ['parse', 'typed'];
+export var createLeafCount = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    parse,
+    typed
+  } = _ref;
+
+  // This does the real work, but we don't have to recurse through
+  // a typed call if we separate it out
+  function countLeaves(node) {
+    var count = 0;
+    node.forEach(n => {
+      count += countLeaves(n);
+    });
+    return count || 1;
+  }
+  /**
+   * Gives the number of "leaf nodes" in the parse tree of the given expression
+   * A leaf node is one that has no subexpressions, essentially either a
+   * symbol or a constant. Note that `5!` has just one leaf, the '5'; the
+   * unary factorial operator does not add a leaf. On the other hand,
+   * function symbols do add leaves, so `sin(x)/cos(x)` has four leaves.
+   *
+   * The `simplify()` function should generally not increase the `leafCount()`
+   * of an expression, although currently there is no guarantee that it never
+   * does so. In many cases, `simplify()` reduces the leaf count.
+   *
+   * Syntax:
+   *
+   *     leafCount(expr)
+   *
+   * Examples:
+   *
+   *     math.leafCount('x') // 1
+   *     math.leafCount(math.parse('a*d-b*c')) // 4
+   *     math.leafCount('[a,b;c,d][0,1]') // 6
+   *
+   * See also:
+   *
+   *     simplify
+   *
+   * @param {Node|string} expr    The expression to count the leaves of
+   *
+   * @return {number}  The number of leaves of `expr`
+   *
+   */
+
+
+  return typed(name, {
+    string: function string(expr) {
+      return this(parse(expr));
+    },
+    Node: function Node(expr) {
+      return countLeaves(expr);
+    }
+  });
+});

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

@@ -1,9 +1,8 @@
 import { isInteger } from '../../utils/number.js';
 import { factory } from '../../utils/factory.js';
 import { createSimplifyConstant } from './simplify/simplifyConstant.js';
-import { createSimplifyCore } from './simplify/simplifyCore.js';
 var name = 'rationalize';
-var dependencies = ['config', 'typed', 'equal', 'isZero', 'add', 'subtract', 'multiply', 'divide', 'pow', 'parse', 'simplify', '?bignumber', '?fraction', 'mathWithTransform', 'ConstantNode', 'OperatorNode', 'FunctionNode', 'SymbolNode', 'ParenthesisNode'];
+var dependencies = ['config', 'typed', 'equal', 'isZero', 'add', 'subtract', 'multiply', 'divide', 'pow', 'parse', 'simplifyCore', 'simplify', '?bignumber', '?fraction', 'mathWithTransform', 'matrix', 'AccessorNode', 'ArrayNode', 'ConstantNode', 'FunctionNode', 'IndexNode', 'ObjectNode', 'OperatorNode', 'SymbolNode', 'ParenthesisNode'];
 export var createRationalize = /* #__PURE__ */factory(name, dependencies, _ref => {
   var {
     config,
@@ -16,13 +15,19 @@ export var createRationalize = /* #__PURE__ */factory(name, dependencies, _ref =
     divide,
     pow,
     parse,
+    simplifyCore,
     simplify,
     fraction,
     bignumber,
     mathWithTransform,
+    matrix,
+    AccessorNode,
+    ArrayNode,
     ConstantNode,
-    OperatorNode,
     FunctionNode,
+    IndexNode,
+    ObjectNode,
+    OperatorNode,
     SymbolNode,
     ParenthesisNode
   } = _ref;
@@ -30,25 +35,17 @@ export var createRationalize = /* #__PURE__ */factory(name, dependencies, _ref =
     typed,
     config,
     mathWithTransform,
+    matrix,
     fraction,
     bignumber,
+    AccessorNode,
+    ArrayNode,
     ConstantNode,
-    OperatorNode,
     FunctionNode,
-    SymbolNode
-  });
-  var simplifyCore = createSimplifyCore({
-    equal,
-    isZero,
-    add,
-    subtract,
-    multiply,
-    divide,
-    pow,
-    ConstantNode,
+    IndexNode,
+    ObjectNode,
     OperatorNode,
-    FunctionNode,
-    ParenthesisNode
+    SymbolNode
   });
   /**
    * Transform a rationalizable expression in a rational fraction.
@@ -93,13 +90,13 @@ export var createRationalize = /* #__PURE__ */factory(name, dependencies, _ref =
    * @param  {Object|boolean}      optional scope of expression or true for already evaluated rational expression at input
    * @param  {Boolean}  detailed   optional True if return an object, false if return expression node (default)
    *
-   * @return {Object | Node}    The rational polynomial of `expr` or na object
-   *            {Object}
-   *              {Expression Node} expression: node simplified expression
-   *              {Expression Node} numerator: simplified numerator of expression
-   *              {Expression Node | boolean} denominator: simplified denominator or false (if there is no denominator)
-   *              {Array}           variables:  variable names
-   *              {Array}           coefficients: coefficients of numerator sorted by increased exponent
+   * @return {Object | Node}    The rational polynomial of `expr` or an object
+   *            `{expression, numerator, denominator, variables, coefficients}`, where
+   *              `expression` is a `Node` with the node simplified expression,
+   *              `numerator` is a `Node` with the simplified numerator of expression,
+   *              `denominator` is a `Node` or `boolean` with the simplified denominator or `false` (if there is no denominator),
+   *              `variables` is an array with variable names,
+   *              and `coefficients` is an array with coefficients of numerator sorted by increased exponent
    *           {Expression Node}  node simplified expression
    *
    */
@@ -132,6 +129,12 @@ export var createRationalize = /* #__PURE__ */factory(name, dependencies, _ref =
       var polyRet = polynomial(expr, scope, true, setRules.firstRules); // Check if expression is a rationalizable polynomial
 
       var nVars = polyRet.variables.length;
+      var noExactFractions = {
+        exactFractions: false
+      };
+      var withExactFractions = {
+        exactFractions: true
+      };
       expr = polyRet.expression;
 
       if (nVars >= 1) {
@@ -142,18 +145,16 @@ export var createRationalize = /* #__PURE__ */factory(name, dependencies, _ref =
 
         var rules;
         var eDistrDiv = true;
-        var redoInic = false;
-        expr = simplify(expr, setRules.firstRules, {}, {
-          exactFractions: false
-        }); // Apply the initial rules, including succ div rules
+        var redoInic = false; // Apply the initial rules, including succ div rules:
 
+        expr = simplify(expr, setRules.firstRules, {}, noExactFractions);
         var s;
 
         while (true) {
-          // Apply alternately  successive division rules and distr.div.rules
+          // Alternate applying successive division rules and distr.div.rules
+          // until there are no more changes:
           rules = eDistrDiv ? setRules.distrDivRules : setRules.sucDivRules;
-          expr = simplify(expr, rules); // until no more changes
-
+          expr = simplify(expr, rules, {}, withExactFractions);
           eDistrDiv = !eDistrDiv; // Swap between Distr.Div and Succ. Div. Rules
 
           s = expr.toString();
@@ -168,14 +169,11 @@ export var createRationalize = /* #__PURE__ */factory(name, dependencies, _ref =
 
         if (redoInic) {
           // Apply first rules again without succ div rules (if there are changes)
-          expr = simplify(expr, setRules.firstRulesAgain, {}, {
-            exactFractions: false
-          });
-        }
+          expr = simplify(expr, setRules.firstRulesAgain, {}, noExactFractions);
+        } // Apply final rules:
+
 
-        expr = simplify(expr, setRules.finalRules, {}, {
-          exactFractions: false
-        }); // Apply final rules
+        expr = simplify(expr, setRules.finalRules, {}, noExactFractions);
       } // NVars >= 1
 
 

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

@@ -0,0 +1,95 @@
+import { createMap, isMap } from '../../utils/map.js';
+import { isFunctionNode, isNode, isOperatorNode, isParenthesisNode, isSymbolNode } from '../../utils/is.js';
+import { factory } from '../../utils/factory.js';
+var name = 'resolve';
+var dependencies = ['parse', 'ConstantNode', 'FunctionNode', 'OperatorNode', 'ParenthesisNode'];
+export var createResolve = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    parse,
+    ConstantNode,
+    FunctionNode,
+    OperatorNode,
+    ParenthesisNode
+  } = _ref;
+
+  /**
+   * resolve(expr, scope) replaces variable nodes with their scoped values
+   *
+   * Syntax:
+   *
+   *     resolve(expr, scope)
+   *
+   * Examples:
+   *
+   *     math.resolve('x + y', {x:1, y:2})           // Node {1 + 2}
+   *     math.resolve(math.parse('x+y'), {x:1, y:2}) // Node {1 + 2}
+   *     math.simplify('x+y', {x:2, y:'x+x'}).toString()      // "6"
+   *
+   * See also:
+   *
+   *     simplify, evaluate
+   *
+   * @param {Node} node
+   *     The expression tree to be simplified
+   * @param {Object} scope
+   *     Scope specifying variables to be resolved
+   * @return {Node} Returns `node` with variables recursively substituted.
+   * @throws {ReferenceError}
+   *     If there is a cyclic dependency among the variables in `scope`,
+   *     resolution is impossible and a ReferenceError is thrown.
+   */
+  function resolve(node, scope) {
+    var within = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : new Set();
+
+    // note `within`:
+    // `within` is not documented, since it is for internal cycle
+    // detection only
+    if (!scope) {
+      return node;
+    }
+
+    if (!isMap(scope)) {
+      scope = createMap(scope);
+    }
+
+    if (isSymbolNode(node)) {
+      if (within.has(node.name)) {
+        var variables = Array.from(within).join(', ');
+        throw new ReferenceError("recursive loop of variable definitions among {".concat(variables, "}"));
+      }
+
+      var value = scope.get(node.name);
+
+      if (isNode(value)) {
+        var nextWithin = new Set(within);
+        nextWithin.add(node.name);
+        return resolve(value, scope, nextWithin);
+      } else if (typeof value === 'number') {
+        return parse(String(value));
+      } else if (value !== undefined) {
+        return new ConstantNode(value);
+      } else {
+        return node;
+      }
+    } else if (isOperatorNode(node)) {
+      var args = node.args.map(function (arg) {
+        return resolve(arg, scope, within);
+      });
+      return new OperatorNode(node.op, node.fn, args, node.implicit);
+    } else if (isParenthesisNode(node)) {
+      return new ParenthesisNode(resolve(node.content, scope, within));
+    } else if (isFunctionNode(node)) {
+      var _args = node.args.map(function (arg) {
+        return resolve(arg, scope, within);
+      });
+
+      return new FunctionNode(node.name, _args);
+    } // Otherwise just recursively resolve any children (might also work
+    // for some of the above special cases)
+
+
+    return node.map(child => resolve(child, scope, within));
+  }
+
+  return resolve;
+});