mathjs 10.6.2 → 11.0.0

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

@@ -1,3 +1,4 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { isAccessorNode, isIndexNode, isNode, isSymbolNode } from '../../utils/is.js';
 import { getSafeProperty, setSafeProperty } from '../../utils/customs.js';
 import { factory } from '../../utils/factory.js';
@@ -20,305 +21,316 @@ export var createAssignmentNode = /* #__PURE__ */factory(name, dependencies, _re
     subset,
     matrix
   });
-  /**
-   * @constructor AssignmentNode
-   * @extends {Node}
-   *
-   * Define a symbol, like `a=3.2`, update a property like `a.b=3.2`, or
-   * replace a subset of a matrix like `A[2,2]=42`.
-   *
-   * Syntax:
-   *
-   *     new AssignmentNode(symbol, value)
-   *     new AssignmentNode(object, index, value)
-   *
-   * Usage:
-   *
-   *    new AssignmentNode(new SymbolNode('a'), new ConstantNode(2))                       // a=2
-   *    new AssignmentNode(new SymbolNode('a'), new IndexNode('b'), new ConstantNode(2))   // a.b=2
-   *    new AssignmentNode(new SymbolNode('a'), new IndexNode(1, 2), new ConstantNode(3))  // a[1,2]=3
-   *
-   * @param {SymbolNode | AccessorNode} object  Object on which to assign a value
-   * @param {IndexNode} [index=null]            Index, property name or matrix
-   *                                            index. Optional. If not provided
-   *                                            and `object` is a SymbolNode,
-   *                                            the property is assigned to the
-   *                                            global scope.
-   * @param {Node} value                        The value to be assigned
+  /*
+   * Is parenthesis needed?
+   * @param {node} node
+   * @param {string} [parenthesis='keep']
+   * @param {string} implicit
+   * @private
    */
 
-  function AssignmentNode(object, index, value) {
-    if (!(this instanceof AssignmentNode)) {
-      throw new SyntaxError('Constructor must be called with the new operator');
-    }
-
-    this.object = object;
-    this.index = value ? index : null;
-    this.value = value || index; // validate input
-
-    if (!isSymbolNode(object) && !isAccessorNode(object)) {
-      throw new TypeError('SymbolNode or AccessorNode expected as "object"');
-    }
-
-    if (isSymbolNode(object) && object.name === 'end') {
-      throw new Error('Cannot assign to symbol "end"');
-    }
-
-    if (this.index && !isIndexNode(this.index)) {
-      // index is optional
-      throw new TypeError('IndexNode expected as "index"');
+  function needParenthesis(node, parenthesis, implicit) {
+    if (!parenthesis) {
+      parenthesis = 'keep';
     }
 
-    if (!isNode(this.value)) {
-      throw new TypeError('Node expected as "value"');
-    } // readonly property name
+    var precedence = getPrecedence(node, parenthesis, implicit);
+    var exprPrecedence = getPrecedence(node.value, parenthesis, implicit);
+    return parenthesis === 'all' || exprPrecedence !== null && exprPrecedence <= precedence;
+  }
 
+  class AssignmentNode extends Node {
+    /**
+     * @constructor AssignmentNode
+     * @extends {Node}
+     *
+     * Define a symbol, like `a=3.2`, update a property like `a.b=3.2`, or
+     * replace a subset of a matrix like `A[2,2]=42`.
+     *
+     * Syntax:
+     *
+     *     new AssignmentNode(symbol, value)
+     *     new AssignmentNode(object, index, value)
+     *
+     * Usage:
+     *
+     *    new AssignmentNode(new SymbolNode('a'), new ConstantNode(2))  // a=2
+     *    new AssignmentNode(new SymbolNode('a'),
+     *                       new IndexNode('b'),
+     *                       new ConstantNode(2))   // a.b=2
+     *    new AssignmentNode(new SymbolNode('a'),
+     *                       new IndexNode(1, 2),
+     *                       new ConstantNode(3))  // a[1,2]=3
+     *
+     * @param {SymbolNode | AccessorNode} object
+     *     Object on which to assign a value
+     * @param {IndexNode} [index=null]
+     *     Index, property name or matrix index. Optional. If not provided
+     *     and `object` is a SymbolNode, the property is assigned to the
+     *     global scope.
+     * @param {Node} value
+     *     The value to be assigned
+     */
+    constructor(object, index, value) {
+      super();
+      this.object = object;
+      this.index = value ? index : null;
+      this.value = value || index; // validate input
+
+      if (!isSymbolNode(object) && !isAccessorNode(object)) {
+        throw new TypeError('SymbolNode or AccessorNode expected as "object"');
+      }
 
-    Object.defineProperty(this, 'name', {
-      get: function () {
-        if (this.index) {
-          return this.index.isObjectProperty() ? this.index.getObjectProperty() : '';
-        } else {
-          return this.object.name || '';
-        }
-      }.bind(this),
-      set: function set() {
-        throw new Error('Cannot assign a new name, name is read-only');
+      if (isSymbolNode(object) && object.name === 'end') {
+        throw new Error('Cannot assign to symbol "end"');
       }
-    });
-  }
 
-  AssignmentNode.prototype = new Node();
-  AssignmentNode.prototype.type = 'AssignmentNode';
-  AssignmentNode.prototype.isAssignmentNode = 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: *)
-   */
+      if (this.index && !isIndexNode(this.index)) {
+        // index is optional
+        throw new TypeError('IndexNode expected as "index"');
+      }
 
-  AssignmentNode.prototype._compile = function (math, argNames) {
-    var evalObject = this.object._compile(math, argNames);
+      if (!isNode(this.value)) {
+        throw new TypeError('Node expected as "value"');
+      }
+    } // class name for typing purposes:
 
-    var evalIndex = this.index ? this.index._compile(math, argNames) : null;
 
-    var evalValue = this.value._compile(math, argNames);
+    // readonly property name
+    get name() {
+      if (this.index) {
+        return this.index.isObjectProperty() ? this.index.getObjectProperty() : '';
+      } else {
+        return this.object.name || '';
+      }
+    }
 
-    var name = this.object.name;
+    get type() {
+      return name;
+    }
 
-    if (!this.index) {
-      // apply a variable to the scope, for example `a=2`
-      if (!isSymbolNode(this.object)) {
-        throw new TypeError('SymbolNode expected as object');
-      }
+    get isAssignmentNode() {
+      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 evalObject = this.object._compile(math, argNames);
+
+      var evalIndex = this.index ? this.index._compile(math, argNames) : null;
+
+      var evalValue = this.value._compile(math, argNames);
+
+      var name = this.object.name;
+
+      if (!this.index) {
+        // apply a variable to the scope, for example `a=2`
+        if (!isSymbolNode(this.object)) {
+          throw new TypeError('SymbolNode expected as object');
+        }
 
-      return function evalAssignmentNode(scope, args, context) {
-        var value = evalValue(scope, args, context);
-        scope.set(name, value);
-        return value;
-      };
-    } else if (this.index.isObjectProperty()) {
-      // apply an object property for example `a.b=2`
-      var prop = this.index.getObjectProperty();
-      return function evalAssignmentNode(scope, args, context) {
-        var object = evalObject(scope, args, context);
-        var value = evalValue(scope, args, context);
-        setSafeProperty(object, prop, value);
-        return value;
-      };
-    } else if (isSymbolNode(this.object)) {
-      // update a matrix subset, for example `a[2]=3`
-      return function evalAssignmentNode(scope, args, context) {
-        var childObject = evalObject(scope, args, context);
-        var value = evalValue(scope, args, context);
-        var index = evalIndex(scope, args, childObject); // Important:  we pass childObject instead of context
-
-        scope.set(name, assign(childObject, index, value));
-        return value;
-      };
-    } else {
-      // isAccessorNode(node.object) === true
-      // update a matrix subset, for example `a.b[2]=3`
-      // we will not use the compile function of the AccessorNode, but compile it
-      // ourselves here as we need the parent object of the AccessorNode:
-      // wee need to apply the updated object to parent object
-      var evalParentObject = this.object.object._compile(math, argNames);
-
-      if (this.object.index.isObjectProperty()) {
-        var parentProp = this.object.index.getObjectProperty();
         return function evalAssignmentNode(scope, args, context) {
-          var parent = evalParentObject(scope, args, context);
-          var childObject = getSafeProperty(parent, parentProp);
-          var index = evalIndex(scope, args, childObject); // Important: we pass childObject instead of context
-
           var value = evalValue(scope, args, context);
-          setSafeProperty(parent, parentProp, assign(childObject, index, value));
+          scope.set(name, value);
           return value;
         };
-      } else {
-        // if some parameters use the 'end' parameter, we need to calculate the size
-        var evalParentIndex = this.object.index._compile(math, argNames);
-
+      } else if (this.index.isObjectProperty()) {
+        // apply an object property for example `a.b=2`
+        var prop = this.index.getObjectProperty();
         return function evalAssignmentNode(scope, args, context) {
-          var parent = evalParentObject(scope, args, context);
-          var parentIndex = evalParentIndex(scope, args, parent); // Important: we pass parent instead of context
-
-          var childObject = access(parent, parentIndex);
-          var index = evalIndex(scope, args, childObject); // Important:  we pass childObject instead of context
-
+          var object = evalObject(scope, args, context);
           var value = evalValue(scope, args, context);
-          assign(parent, parentIndex, assign(childObject, index, value));
+          setSafeProperty(object, prop, value);
           return value;
         };
-      }
-    }
-  };
-  /**
-   * Execute a callback for each of the child nodes of this node
-   * @param {function(child: Node, path: string, parent: Node)} callback
-   */
+      } else if (isSymbolNode(this.object)) {
+        // update a matrix subset, for example `a[2]=3`
+        return function evalAssignmentNode(scope, args, context) {
+          var childObject = evalObject(scope, args, context);
+          var value = evalValue(scope, args, context); // Important:  we pass childObject instead of context:
 
+          var index = evalIndex(scope, args, childObject);
+          scope.set(name, assign(childObject, index, value));
+          return value;
+        };
+      } else {
+        // isAccessorNode(node.object) === true
+        // update a matrix subset, for example `a.b[2]=3`
+        // we will not use the compile function of the AccessorNode, but
+        // compile it ourselves here as we need the parent object of the
+        // AccessorNode:
+        // wee need to apply the updated object to parent object
+        var evalParentObject = this.object.object._compile(math, argNames);
+
+        if (this.object.index.isObjectProperty()) {
+          var parentProp = this.object.index.getObjectProperty();
+          return function evalAssignmentNode(scope, args, context) {
+            var parent = evalParentObject(scope, args, context);
+            var childObject = getSafeProperty(parent, parentProp); // Important: we pass childObject instead of context:
+
+            var index = evalIndex(scope, args, childObject);
+            var value = evalValue(scope, args, context);
+            setSafeProperty(parent, parentProp, assign(childObject, index, value));
+            return value;
+          };
+        } else {
+          // if some parameters use the 'end' parameter, we need to calculate
+          // the size
+          var evalParentIndex = this.object.index._compile(math, argNames);
 
-  AssignmentNode.prototype.forEach = function (callback) {
-    callback(this.object, 'object', this);
+          return function evalAssignmentNode(scope, args, context) {
+            var parent = evalParentObject(scope, args, context); // Important: we pass parent instead of context:
 
-    if (this.index) {
-      callback(this.index, 'index', this);
-    }
+            var parentIndex = evalParentIndex(scope, args, parent);
+            var childObject = access(parent, parentIndex); // Important:  we pass childObject instead of context
 
-    callback(this.value, 'value', this);
-  };
-  /**
-   * Create a new AssignmentNode 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 {AssignmentNode} Returns a transformed copy of the node
-   */
+            var index = evalIndex(scope, args, childObject);
+            var value = evalValue(scope, args, context);
+            assign(parent, parentIndex, assign(childObject, index, value));
+            return value;
+          };
+        }
+      }
+    }
+    /**
+     * Execute a callback for each of the child nodes of this node
+     * @param {function(child: Node, path: string, parent: Node)} callback
+     */
 
 
-  AssignmentNode.prototype.map = function (callback) {
-    var object = this._ifNode(callback(this.object, 'object', this));
+    forEach(callback) {
+      callback(this.object, 'object', this);
 
-    var index = this.index ? this._ifNode(callback(this.index, 'index', this)) : null;
+      if (this.index) {
+        callback(this.index, 'index', this);
+      }
 
-    var value = this._ifNode(callback(this.value, 'value', this));
+      callback(this.value, 'value', this);
+    }
+    /**
+     * Create a new AssignmentNode whose children are the results of calling
+     * the provided callback function for each child of the original node.
+     * @param {function(child: Node, path: string, parent: Node): Node} callback
+     * @returns {AssignmentNode} Returns a transformed copy of the node
+     */
 
-    return new AssignmentNode(object, index, value);
-  };
-  /**
-   * Create a clone of this node, a shallow copy
-   * @return {AssignmentNode}
-   */
 
+    map(callback) {
+      var object = this._ifNode(callback(this.object, 'object', this));
 
-  AssignmentNode.prototype.clone = function () {
-    return new AssignmentNode(this.object, this.index, this.value);
-  };
-  /*
-   * Is parenthesis needed?
-   * @param {node} node
-   * @param {string} [parenthesis='keep']
-   * @private
-   */
+      var index = this.index ? this._ifNode(callback(this.index, 'index', this)) : null;
 
+      var value = this._ifNode(callback(this.value, 'value', this));
 
-  function needParenthesis(node, parenthesis) {
-    if (!parenthesis) {
-      parenthesis = 'keep';
+      return new AssignmentNode(object, index, value);
     }
+    /**
+     * Create a clone of this node, a shallow copy
+     * @return {AssignmentNode}
+     */
 
-    var precedence = getPrecedence(node, parenthesis);
-    var exprPrecedence = getPrecedence(node.value, parenthesis);
-    return parenthesis === 'all' || exprPrecedence !== null && exprPrecedence <= precedence;
-  }
-  /**
-   * Get string representation
-   * @param {Object} options
-   * @return {string}
-   */
-
-
-  AssignmentNode.prototype._toString = function (options) {
-    var object = this.object.toString(options);
-    var index = this.index ? this.index.toString(options) : '';
-    var value = this.value.toString(options);
 
-    if (needParenthesis(this, options && options.parenthesis)) {
-      value = '(' + value + ')';
+    clone() {
+      return new AssignmentNode(this.object, this.index, this.value);
     }
+    /**
+     * Get string representation
+     * @param {Object} options
+     * @return {string}
+     */
 
-    return object + index + ' = ' + value;
-  };
-  /**
-   * Get a JSON representation of the node
-   * @returns {Object}
-   */
 
+    _toString(options) {
+      var object = this.object.toString(options);
+      var index = this.index ? this.index.toString(options) : '';
+      var value = this.value.toString(options);
 
-  AssignmentNode.prototype.toJSON = function () {
-    return {
-      mathjs: 'AssignmentNode',
-      object: this.object,
-      index: this.index,
-      value: this.value
-    };
-  };
-  /**
-   * Instantiate an AssignmentNode from its JSON representation
-   * @param {Object} json  An object structured like
-   *                       `{"mathjs": "AssignmentNode", object: ..., index: ..., value: ...}`,
-   *                       where mathjs is optional
-   * @returns {AssignmentNode}
-   */
+      if (needParenthesis(this, options && options.parenthesis, options && options.implicit)) {
+        value = '(' + value + ')';
+      }
 
+      return object + index + ' = ' + value;
+    }
+    /**
+     * Get a JSON representation of the node
+     * @returns {Object}
+     */
+
+
+    toJSON() {
+      return {
+        mathjs: name,
+        object: this.object,
+        index: this.index,
+        value: this.value
+      };
+    }
+    /**
+     * Instantiate an AssignmentNode from its JSON representation
+     * @param {Object} json
+     *     An object structured like
+     *     `{"mathjs": "AssignmentNode", object: ..., index: ..., value: ...}`,
+     *     where mathjs is optional
+     * @returns {AssignmentNode}
+     */
+
+
+    static fromJSON(json) {
+      return new AssignmentNode(json.object, json.index, json.value);
+    }
+    /**
+     * Get HTML representation
+     * @param {Object} options
+     * @return {string}
+     */
 
-  AssignmentNode.fromJSON = function (json) {
-    return new AssignmentNode(json.object, json.index, json.value);
-  };
-  /**
-   * Get HTML representation
-   * @param {Object} options
-   * @return {string}
-   */
 
+    toHTML(options) {
+      var object = this.object.toHTML(options);
+      var index = this.index ? this.index.toHTML(options) : '';
+      var value = this.value.toHTML(options);
 
-  AssignmentNode.prototype.toHTML = function (options) {
-    var object = this.object.toHTML(options);
-    var index = this.index ? this.index.toHTML(options) : '';
-    var value = this.value.toHTML(options);
+      if (needParenthesis(this, options && options.parenthesis, options && options.implicit)) {
+        value = '<span class="math-paranthesis math-round-parenthesis">(</span>' + value + '<span class="math-paranthesis math-round-parenthesis">)</span>';
+      }
 
-    if (needParenthesis(this, options && options.parenthesis)) {
-      value = '<span class="math-paranthesis math-round-parenthesis">(</span>' + value + '<span class="math-paranthesis math-round-parenthesis">)</span>';
+      return object + index + '<span class="math-operator math-assignment-operator ' + 'math-variable-assignment-operator math-binary-operator">=</span>' + value;
     }
+    /**
+     * Get LaTeX representation
+     * @param {Object} options
+     * @return {string}
+     */
 
-    return object + index + '<span class="math-operator math-assignment-operator math-variable-assignment-operator math-binary-operator">=</span>' + value;
-  };
-  /**
-   * Get LaTeX representation
-   * @param {Object} options
-   * @return {string}
-   */
 
+    _toTex(options) {
+      var object = this.object.toTex(options);
+      var index = this.index ? this.index.toTex(options) : '';
+      var value = this.value.toTex(options);
 
-  AssignmentNode.prototype._toTex = function (options) {
-    var object = this.object.toTex(options);
-    var index = this.index ? this.index.toTex(options) : '';
-    var value = this.value.toTex(options);
+      if (needParenthesis(this, options && options.parenthesis, options && options.implicit)) {
+        value = "\\left(".concat(value, "\\right)");
+      }
 
-    if (needParenthesis(this, options && options.parenthesis)) {
-      value = "\\left(".concat(value, "\\right)");
+      return object + index + ':=' + value;
     }
 
-    return object + index + ':=' + value;
-  };
+  }
+
+  _defineProperty(AssignmentNode, "name", name);
 
   return AssignmentNode;
 }, {