mathjs 10.6.2 → 11.0.0

package/lib/esm/expression/node/SymbolNode.js

@@ -19,186 +19,195 @@ export var createSymbolNode = /* #__PURE__ */factory(name, dependencies, _ref =>
   function isValuelessUnit(name) {
     return Unit ? Unit.isValuelessUnit(name) : false;
   }
-  /**
-   * @constructor SymbolNode
-   * @extends {Node}
-   * A symbol node can hold and resolve a symbol
-   * @param {string} name
-   * @extends {Node}
-   */
-
-
-  function SymbolNode(name) {
-    if (!(this instanceof SymbolNode)) {
-      throw new SyntaxError('Constructor must be called with the new operator');
-    } // validate input
 
+  class SymbolNode extends Node {
+    /**
+     * @constructor SymbolNode
+     * @extends {Node}
+     * A symbol node can hold and resolve a symbol
+     * @param {string} name
+     * @extends {Node}
+     */
+    constructor(name) {
+      super(); // validate input
+
+      if (typeof name !== 'string') {
+        throw new TypeError('String expected for parameter "name"');
+      }
+
+      this.name = name;
+    }
 
-    if (typeof name !== 'string') throw new TypeError('String expected for parameter "name"');
-    this.name = name;
-  }
+    get type() {
+      return 'SymbolNode';
+    }
 
-  SymbolNode.prototype = new Node();
-  SymbolNode.prototype.type = 'SymbolNode';
-  SymbolNode.prototype.isSymbolNode = true;
-  /**
-   * Compile a node into a JavaScript function.
-   * This basically pre-calculates as much as possible and only leaves open
-   * calculations which depend on a dynamic scope with variables.
-   * @param {Object} math     Math.js namespace with functions and constants.
-   * @param {Object} argNames An object with argument names as key and `true`
-   *                          as value. Used in the SymbolNode to optimize
-   *                          for arguments from user assigned functions
-   *                          (see FunctionAssignmentNode) or special symbols
-   *                          like `end` (see IndexNode).
-   * @return {function} Returns a function which can be called like:
-   *                        evalNode(scope: Object, args: Object, context: *)
-   */
+    get isSymbolNode() {
+      return true;
+    }
+    /**
+     * Compile a node into a JavaScript function.
+     * This basically pre-calculates as much as possible and only leaves open
+     * calculations which depend on a dynamic scope with variables.
+     * @param {Object} math     Math.js namespace with functions and constants.
+     * @param {Object} argNames An object with argument names as key and `true`
+     *                          as value. Used in the SymbolNode to optimize
+     *                          for arguments from user assigned functions
+     *                          (see FunctionAssignmentNode) or special symbols
+     *                          like `end` (see IndexNode).
+     * @return {function} Returns a function which can be called like:
+     *                        evalNode(scope: Object, args: Object, context: *)
+     */
+
+
+    _compile(math, argNames) {
+      var name = this.name;
+
+      if (argNames[name] === true) {
+        // this is a FunctionAssignment argument
+        // (like an x when inside the expression of a function
+        // assignment `f(x) = ...`)
+        return function (scope, args, context) {
+          return args[name];
+        };
+      } else if (name in math) {
+        return function (scope, args, context) {
+          return scope.has(name) ? scope.get(name) : getSafeProperty(math, name);
+        };
+      } else {
+        var isUnit = isValuelessUnit(name);
+        return function (scope, args, context) {
+          return scope.has(name) ? scope.get(name) : isUnit ? new Unit(null, name) : SymbolNode.onUndefinedSymbol(name);
+        };
+      }
+    }
+    /**
+     * Execute a callback for each of the child nodes of this node
+     * @param {function(child: Node, path: string, parent: Node)} callback
+     */
 
-  SymbolNode.prototype._compile = function (math, argNames) {
-    var name = this.name;
 
-    if (argNames[name] === true) {
-      // this is a FunctionAssignment argument
-      // (like an x when inside the expression of a function assignment `f(x) = ...`)
-      return function (scope, args, context) {
-        return args[name];
-      };
-    } else if (name in math) {
-      return function (scope, args, context) {
-        return scope.has(name) ? scope.get(name) : getSafeProperty(math, name);
-      };
-    } else {
-      var isUnit = isValuelessUnit(name);
-      return function (scope, args, context) {
-        return scope.has(name) ? scope.get(name) : isUnit ? new Unit(null, name) : SymbolNode.onUndefinedSymbol(name);
-      };
+    forEach(callback) {// nothing to do, we don't have any children
     }
-  };
-  /**
-   * Execute a callback for each of the child nodes of this node
-   * @param {function(child: Node, path: string, parent: Node)} callback
-   */
+    /**
+     * Create a new SymbolNode with children produced by the given callback.
+     * Trivial since a SymbolNode has no children
+     * @param {function(child: Node, path: string, parent: Node) : Node} callback
+     * @returns {SymbolNode} Returns a clone of the node
+     */
 
 
-  SymbolNode.prototype.forEach = function (callback) {// nothing to do, we don't have childs
-  };
-  /**
-   * Create a new SymbolNode having it's childs be the results of calling
-   * the provided callback function for each of the childs of the original node.
-   * @param {function(child: Node, path: string, parent: Node) : Node} callback
-   * @returns {SymbolNode} Returns a clone of the node
-   */
+    map(callback) {
+      return this.clone();
+    }
+    /**
+     * Throws an error 'Undefined symbol {name}'
+     * @param {string} name
+     */
 
 
-  SymbolNode.prototype.map = function (callback) {
-    return this.clone();
-  };
-  /**
-   * Throws an error 'Undefined symbol {name}'
-   * @param {string} name
-   */
+    static onUndefinedSymbol(name) {
+      throw new Error('Undefined symbol ' + name);
+    }
+    /**
+     * Create a clone of this node, a shallow copy
+     * @return {SymbolNode}
+     */
 
 
-  SymbolNode.onUndefinedSymbol = function (name) {
-    throw new Error('Undefined symbol ' + name);
-  };
-  /**
-   * Create a clone of this node, a shallow copy
-   * @return {SymbolNode}
-   */
+    clone() {
+      return new SymbolNode(this.name);
+    }
+    /**
+     * Get string representation
+     * @param {Object} options
+     * @return {string} str
+     * @override
+     */
 
 
-  SymbolNode.prototype.clone = function () {
-    return new SymbolNode(this.name);
-  };
-  /**
-   * Get string representation
-   * @param {Object} options
-   * @return {string} str
-   * @override
-   */
+    _toString(options) {
+      return this.name;
+    }
+    /**
+     * Get HTML representation
+     * @param {Object} options
+     * @return {string} str
+     * @override
+     */
+
+
+    toHTML(options) {
+      var name = escape(this.name);
+
+      if (name === 'true' || name === 'false') {
+        return '<span class="math-symbol math-boolean">' + name + '</span>';
+      } else if (name === 'i') {
+        return '<span class="math-symbol math-imaginary-symbol">' + name + '</span>';
+      } else if (name === 'Infinity') {
+        return '<span class="math-symbol math-infinity-symbol">' + name + '</span>';
+      } else if (name === 'NaN') {
+        return '<span class="math-symbol math-nan-symbol">' + name + '</span>';
+      } else if (name === 'null') {
+        return '<span class="math-symbol math-null-symbol">' + name + '</span>';
+      } else if (name === 'undefined') {
+        return '<span class="math-symbol math-undefined-symbol">' + name + '</span>';
+      }
+
+      return '<span class="math-symbol">' + name + '</span>';
+    }
+    /**
+     * Get a JSON representation of the node
+     * @returns {Object}
+     */
 
 
-  SymbolNode.prototype._toString = function (options) {
-    return this.name;
-  };
-  /**
-   * Get HTML representation
-   * @param {Object} options
-   * @return {string} str
-   * @override
-   */
+    toJSON() {
+      return {
+        mathjs: 'SymbolNode',
+        name: this.name
+      };
+    }
+    /**
+     * Instantiate a SymbolNode from its JSON representation
+     * @param {Object} json  An object structured like
+     *                       `{"mathjs": "SymbolNode", name: "x"}`,
+     *                       where mathjs is optional
+     * @returns {SymbolNode}
+     */
 
 
-  SymbolNode.prototype.toHTML = function (options) {
-    var name = escape(this.name);
-
-    if (name === 'true' || name === 'false') {
-      return '<span class="math-symbol math-boolean">' + name + '</span>';
-    } else if (name === 'i') {
-      return '<span class="math-symbol math-imaginary-symbol">' + name + '</span>';
-    } else if (name === 'Infinity') {
-      return '<span class="math-symbol math-infinity-symbol">' + name + '</span>';
-    } else if (name === 'NaN') {
-      return '<span class="math-symbol math-nan-symbol">' + name + '</span>';
-    } else if (name === 'null') {
-      return '<span class="math-symbol math-null-symbol">' + name + '</span>';
-    } else if (name === 'undefined') {
-      return '<span class="math-symbol math-undefined-symbol">' + name + '</span>';
+    static fromJSON(json) {
+      return new SymbolNode(json.name);
     }
+    /**
+     * Get LaTeX representation
+     * @param {Object} options
+     * @return {string} str
+     * @override
+     */
 
-    return '<span class="math-symbol">' + name + '</span>';
-  };
-  /**
-   * Get a JSON representation of the node
-   * @returns {Object}
-   */
 
+    _toTex(options) {
+      var isUnit = false;
 
-  SymbolNode.prototype.toJSON = function () {
-    return {
-      mathjs: 'SymbolNode',
-      name: this.name
-    };
-  };
-  /**
-   * Instantiate a SymbolNode from its JSON representation
-   * @param {Object} json  An object structured like
-   *                       `{"mathjs": "SymbolNode", name: "x"}`,
-   *                       where mathjs is optional
-   * @returns {SymbolNode}
-   */
+      if (typeof math[this.name] === 'undefined' && isValuelessUnit(this.name)) {
+        isUnit = true;
+      }
 
+      var symbol = toSymbol(this.name, isUnit);
 
-  SymbolNode.fromJSON = function (json) {
-    return new SymbolNode(json.name);
-  };
-  /**
-   * Get LaTeX representation
-   * @param {Object} options
-   * @return {string} str
-   * @override
-   */
+      if (symbol[0] === '\\') {
+        // no space needed if the symbol starts with '\'
+        return symbol;
+      } // the space prevents symbols from breaking stuff like '\cdot'
+      // if it's written right before the symbol
 
 
-  SymbolNode.prototype._toTex = function (options) {
-    var isUnit = false;
-
-    if (typeof math[this.name] === 'undefined' && isValuelessUnit(this.name)) {
-      isUnit = true;
+      return ' ' + symbol;
     }
 
-    var symbol = toSymbol(this.name, isUnit);
-
-    if (symbol[0] === '\\') {
-      // no space needed if the symbol starts with '\'
-      return symbol;
-    } // the space prevents symbols from breaking stuff like '\cdot' if it's written right before the symbol
-
-
-    return ' ' + symbol;
-  };
+  }
 
   return SymbolNode;
 }, {

package/lib/esm/expression/operators.js

@@ -17,6 +17,7 @@
 //                  in parentheses
 // latexRightParens: the same for the right argument
 import { hasOwnProperty } from '../utils/object.js';
+import { isConstantNode, isParenthesisNode, rule2Node } from '../utils/is.js';
 export var properties = [{
   // assignment
   AssignmentNode: {},
@@ -33,62 +34,74 @@ export var properties = [{
 }, {
   // logical or
   'OperatorNode:or': {
+    op: 'or',
     associativity: 'left',
     associativeWith: []
   }
 }, {
   // logical xor
   'OperatorNode:xor': {
+    op: 'xor',
     associativity: 'left',
     associativeWith: []
   }
 }, {
   // logical and
   'OperatorNode:and': {
+    op: 'and',
     associativity: 'left',
     associativeWith: []
   }
 }, {
   // bitwise or
   'OperatorNode:bitOr': {
+    op: '|',
     associativity: 'left',
     associativeWith: []
   }
 }, {
   // bitwise xor
   'OperatorNode:bitXor': {
+    op: '^|',
     associativity: 'left',
     associativeWith: []
   }
 }, {
   // bitwise and
   'OperatorNode:bitAnd': {
+    op: '&',
     associativity: 'left',
     associativeWith: []
   }
 }, {
   // relational operators
   'OperatorNode:equal': {
+    op: '==',
     associativity: 'left',
     associativeWith: []
   },
   'OperatorNode:unequal': {
+    op: '!=',
     associativity: 'left',
     associativeWith: []
   },
   'OperatorNode:smaller': {
+    op: '<',
     associativity: 'left',
     associativeWith: []
   },
   'OperatorNode:larger': {
+    op: '>',
     associativity: 'left',
     associativeWith: []
   },
   'OperatorNode:smallerEq': {
+    op: '<=',
     associativity: 'left',
     associativeWith: []
   },
   'OperatorNode:largerEq': {
+    op: '>=',
     associativity: 'left',
     associativeWith: []
   },
@@ -99,20 +112,24 @@ export var properties = [{
 }, {
   // bitshift operators
   'OperatorNode:leftShift': {
+    op: '<<',
     associativity: 'left',
     associativeWith: []
   },
   'OperatorNode:rightArithShift': {
+    op: '>>',
     associativity: 'left',
     associativeWith: []
   },
   'OperatorNode:rightLogShift': {
+    op: '>>>',
     associativity: 'left',
     associativeWith: []
   }
 }, {
   // unit conversion
   'OperatorNode:to': {
+    op: 'to',
     associativity: 'left',
     associativeWith: []
   }
@@ -122,20 +139,24 @@ export var properties = [{
 }, {
   // addition, subtraction
   'OperatorNode:add': {
+    op: '+',
     associativity: 'left',
     associativeWith: ['OperatorNode:add', 'OperatorNode:subtract']
   },
   'OperatorNode:subtract': {
+    op: '-',
     associativity: 'left',
     associativeWith: []
   }
 }, {
   // multiply, divide, modulus
   'OperatorNode:multiply': {
+    op: '*',
     associativity: 'left',
     associativeWith: ['OperatorNode:multiply', 'OperatorNode:divide', 'Operator:dotMultiply', 'Operator:dotDivide']
   },
   'OperatorNode:divide': {
+    op: '/',
     associativity: 'left',
     associativeWith: [],
     latexLeftParens: false,
@@ -146,34 +167,48 @@ export var properties = [{
 
   },
   'OperatorNode:dotMultiply': {
+    op: '.*',
     associativity: 'left',
     associativeWith: ['OperatorNode:multiply', 'OperatorNode:divide', 'OperatorNode:dotMultiply', 'OperatorNode:doDivide']
   },
   'OperatorNode:dotDivide': {
+    op: './',
     associativity: 'left',
     associativeWith: []
   },
   'OperatorNode:mod': {
+    op: 'mod',
     associativity: 'left',
     associativeWith: []
   }
+}, {
+  // Repeat multiplication for implicit multiplication
+  'OperatorNode:multiply': {
+    associativity: 'left',
+    associativeWith: ['OperatorNode:multiply', 'OperatorNode:divide', 'Operator:dotMultiply', 'Operator:dotDivide']
+  }
 }, {
   // unary prefix operators
   'OperatorNode:unaryPlus': {
+    op: '+',
     associativity: 'right'
   },
   'OperatorNode:unaryMinus': {
+    op: '-',
     associativity: 'right'
   },
   'OperatorNode:bitNot': {
+    op: '~',
     associativity: 'right'
   },
   'OperatorNode:not': {
+    op: 'not',
     associativity: 'right'
   }
 }, {
   // exponentiation
   'OperatorNode:pow': {
+    op: '^',
     associativity: 'right',
     associativeWith: [],
     latexRightParens: false // the exponent doesn't need parentheses in
@@ -182,20 +217,41 @@ export var properties = [{
 
   },
   'OperatorNode:dotPow': {
+    op: '.^',
     associativity: 'right',
     associativeWith: []
   }
 }, {
   // factorial
   'OperatorNode:factorial': {
+    op: '!',
     associativity: 'left'
   }
 }, {
   // matrix transpose
-  'OperatorNode:transpose': {
+  'OperatorNode:ctranspose': {
+    op: "'",
     associativity: 'left'
   }
 }];
+/**
+ * Returns the first non-parenthesis internal node, but only
+ * when the 'parenthesis' option is unset or auto.
+ * @param {Node} _node
+ * @param {string} parenthesis
+ * @return {Node}
+ */
+
+function unwrapParen(_node, parenthesis) {
+  if (!parenthesis || parenthesis !== 'auto') return _node;
+  var node = _node;
+
+  while (isParenthesisNode(node)) {
+    node = node.content;
+  }
+
+  return node;
+}
 /**
  * Get the precedence of a Node.
  * Higher number for higher precedence, starting with 0.
@@ -203,10 +259,13 @@ export var properties = [{
  *
  * @param {Node} _node
  * @param {string} parenthesis
+ * @param {string} implicit
+ * @param {Node} parent (for determining context for implicit multiplication)
  * @return {number | null}
  */
 
-export function getPrecedence(_node, parenthesis) {
+
+export function getPrecedence(_node, parenthesis, implicit, parent) {
   var node = _node;
 
   if (parenthesis !== 'keep') {
@@ -215,14 +274,26 @@ export function getPrecedence(_node, parenthesis) {
   }
 
   var identifier = node.getIdentifier();
+  var precedence = null;
 
   for (var i = 0; i < properties.length; i++) {
     if (identifier in properties[i]) {
-      return i;
+      precedence = i;
+      break;
+    }
+  } // Bump up precedence of implicit multiplication, except when preceded
+  // by a "Rule 2" fraction ( [unaryOp]constant / constant )
+
+
+  if (identifier === 'OperatorNode:multiply' && node.implicit && implicit !== 'show') {
+    var leftArg = unwrapParen(node.args[0], parenthesis);
+
+    if (!(isConstantNode(leftArg) && parent && parent.getIdentifier() === 'OperatorNode:divide' && rule2Node(unwrapParen(parent.args[0], parenthesis))) && !(leftArg.getIdentifier() === 'OperatorNode:divide' && rule2Node(unwrapParen(leftArg.args[0], parenthesis)) && isConstantNode(unwrapParen(leftArg.args[1])))) {
+      precedence += 1;
     }
   }
 
-  return null;
+  return precedence;
 }
 /**
  * Get the associativity of an operator (left or right).
@@ -305,5 +376,26 @@ export function isAssociativeWith(nodeA, nodeB, parenthesis) {
   } // associativeWith is not defined
 
 
+  return null;
+}
+/**
+ * Get the operator associated with a function name.
+ * Returns a string with the operator symbol, or null if the
+ * input is not the name of a function associated with an
+ * operator.
+ *
+ * @param {string} Function name
+ * @return {string | null} Associated operator symbol, if any
+ */
+
+export function getOperator(fn) {
+  var identifier = 'OperatorNode:' + fn;
+
+  for (var group of properties) {
+    if (identifier in group) {
+      return group[identifier].op;
+    }
+  }
+
   return null;
 }