mathjs 10.6.2 → 11.0.0

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

@@ -1,3 +1,4 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { isNode, isSymbolNode } from '../../utils/is.js';
 import { factory } from '../../utils/factory.js';
 import { getPrecedence } from '../operators.js';
@@ -8,278 +9,286 @@ export var createRangeNode = /* #__PURE__ */factory(name, dependencies, _ref =>
     Node
   } = _ref;
 
-  /**
-   * @constructor RangeNode
-   * @extends {Node}
-   * create a range
-   * @param {Node} start  included lower-bound
-   * @param {Node} end    included upper-bound
-   * @param {Node} [step] optional step
-   */
-  function RangeNode(start, end, step) {
-    if (!(this instanceof RangeNode)) {
-      throw new SyntaxError('Constructor must be called with the new operator');
-    } // validate inputs
-
-
-    if (!isNode(start)) throw new TypeError('Node expected');
-    if (!isNode(end)) throw new TypeError('Node expected');
-    if (step && !isNode(step)) throw new TypeError('Node expected');
-    if (arguments.length > 3) throw new Error('Too many arguments');
-    this.start = start; // included lower-bound
-
-    this.end = end; // included upper-bound
-
-    this.step = step || null; // optional step
-  }
-
-  RangeNode.prototype = new Node();
-  RangeNode.prototype.type = 'RangeNode';
-  RangeNode.prototype.isRangeNode = true;
-  /**
-   * Check whether the RangeNode needs the `end` symbol to be defined.
-   * This end is the size of the Matrix in current dimension.
-   * @return {boolean}
-   */
-
-  RangeNode.prototype.needsEnd = function () {
-    // find all `end` symbols in this RangeNode
-    var endSymbols = this.filter(function (node) {
-      return isSymbolNode(node) && node.name === 'end';
-    });
-    return endSymbols.length > 0;
-  };
-  /**
-   * 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: *)
-   */
-
-
-  RangeNode.prototype._compile = function (math, argNames) {
-    var range = math.range;
-
-    var evalStart = this.start._compile(math, argNames);
-
-    var evalEnd = this.end._compile(math, argNames);
-
-    if (this.step) {
-      var evalStep = this.step._compile(math, argNames);
-
-      return function evalRangeNode(scope, args, context) {
-        return range(evalStart(scope, args, context), evalEnd(scope, args, context), evalStep(scope, args, context));
-      };
-    } else {
-      return function evalRangeNode(scope, args, context) {
-        return range(evalStart(scope, args, context), evalEnd(scope, args, context));
-      };
-    }
-  };
-  /**
-   * Execute a callback for each of the child nodes of this node
-   * @param {function(child: Node, path: string, parent: Node)} callback
-   */
-
-
-  RangeNode.prototype.forEach = function (callback) {
-    callback(this.start, 'start', this);
-    callback(this.end, 'end', this);
-
-    if (this.step) {
-      callback(this.step, 'step', this);
-    }
-  };
-  /**
-   * Create a new RangeNode 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 {RangeNode} Returns a transformed copy of the node
-   */
-
-
-  RangeNode.prototype.map = function (callback) {
-    return new RangeNode(this._ifNode(callback(this.start, 'start', this)), this._ifNode(callback(this.end, 'end', this)), this.step && this._ifNode(callback(this.step, 'step', this)));
-  };
-  /**
-   * Create a clone of this node, a shallow copy
-   * @return {RangeNode}
-   */
-
-
-  RangeNode.prototype.clone = function () {
-    return new RangeNode(this.start, this.end, this.step && this.step);
-  };
   /**
    * Calculate the necessary parentheses
    * @param {Node} node
    * @param {string} parenthesis
+   * @param {string} implicit
    * @return {Object} parentheses
    * @private
    */
-
-
-  function calculateNecessaryParentheses(node, parenthesis) {
-    var precedence = getPrecedence(node, parenthesis);
+  function calculateNecessaryParentheses(node, parenthesis, implicit) {
+    var precedence = getPrecedence(node, parenthesis, implicit);
     var parens = {};
-    var startPrecedence = getPrecedence(node.start, parenthesis);
+    var startPrecedence = getPrecedence(node.start, parenthesis, implicit);
     parens.start = startPrecedence !== null && startPrecedence <= precedence || parenthesis === 'all';
 
     if (node.step) {
-      var stepPrecedence = getPrecedence(node.step, parenthesis);
+      var stepPrecedence = getPrecedence(node.step, parenthesis, implicit);
       parens.step = stepPrecedence !== null && stepPrecedence <= precedence || parenthesis === 'all';
     }
 
-    var endPrecedence = getPrecedence(node.end, parenthesis);
+    var endPrecedence = getPrecedence(node.end, parenthesis, implicit);
     parens.end = endPrecedence !== null && endPrecedence <= precedence || parenthesis === 'all';
     return parens;
   }
-  /**
-   * Get string representation
-   * @param {Object} options
-   * @return {string} str
-   */
-
 
-  RangeNode.prototype._toString = function (options) {
-    var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
-    var parens = calculateNecessaryParentheses(this, parenthesis); // format string as start:step:stop
+  class RangeNode extends Node {
+    /**
+     * @constructor RangeNode
+     * @extends {Node}
+     * create a range
+     * @param {Node} start  included lower-bound
+     * @param {Node} end    included upper-bound
+     * @param {Node} [step] optional step
+     */
+    constructor(start, end, step) {
+      super(); // validate inputs
+
+      if (!isNode(start)) throw new TypeError('Node expected');
+      if (!isNode(end)) throw new TypeError('Node expected');
+      if (step && !isNode(step)) throw new TypeError('Node expected');
+      if (arguments.length > 3) throw new Error('Too many arguments');
+      this.start = start; // included lower-bound
+
+      this.end = end; // included upper-bound
+
+      this.step = step || null; // optional step
+    }
 
-    var str;
-    var start = this.start.toString(options);
+    get type() {
+      return name;
+    }
 
-    if (parens.start) {
-      start = '(' + start + ')';
+    get isRangeNode() {
+      return true;
+    }
+    /**
+     * Check whether the RangeNode needs the `end` symbol to be defined.
+     * This end is the size of the Matrix in current dimension.
+     * @return {boolean}
+     */
+
+
+    needsEnd() {
+      // find all `end` symbols in this RangeNode
+      var endSymbols = this.filter(function (node) {
+        return isSymbolNode(node) && node.name === 'end';
+      });
+      return endSymbols.length > 0;
     }
+    /**
+     * 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 range = math.range;
+
+      var evalStart = this.start._compile(math, argNames);
+
+      var evalEnd = this.end._compile(math, argNames);
+
+      if (this.step) {
+        var evalStep = this.step._compile(math, argNames);
+
+        return function evalRangeNode(scope, args, context) {
+          return range(evalStart(scope, args, context), evalEnd(scope, args, context), evalStep(scope, args, context));
+        };
+      } else {
+        return function evalRangeNode(scope, args, context) {
+          return range(evalStart(scope, args, context), evalEnd(scope, args, context));
+        };
+      }
+    }
+    /**
+     * Execute a callback for each of the child nodes of this node
+     * @param {function(child: Node, path: string, parent: Node)} callback
+     */
 
-    str = start;
 
-    if (this.step) {
-      var step = this.step.toString(options);
+    forEach(callback) {
+      callback(this.start, 'start', this);
+      callback(this.end, 'end', this);
 
-      if (parens.step) {
-        step = '(' + step + ')';
+      if (this.step) {
+        callback(this.step, 'step', this);
       }
+    }
+    /**
+     * Create a new RangeNode 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 {RangeNode} Returns a transformed copy of the node
+     */
 
-      str += ':' + step;
+
+    map(callback) {
+      return new RangeNode(this._ifNode(callback(this.start, 'start', this)), this._ifNode(callback(this.end, 'end', this)), this.step && this._ifNode(callback(this.step, 'step', this)));
     }
+    /**
+     * Create a clone of this node, a shallow copy
+     * @return {RangeNode}
+     */
 
-    var end = this.end.toString(options);
 
-    if (parens.end) {
-      end = '(' + end + ')';
+    clone() {
+      return new RangeNode(this.start, this.end, this.step && this.step);
     }
+    /**
+     * Get string representation
+     * @param {Object} options
+     * @return {string} str
+     */
 
-    str += ':' + end;
-    return str;
-  };
-  /**
-   * Get a JSON representation of the node
-   * @returns {Object}
-   */
 
+    _toString(options) {
+      var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
+      var parens = calculateNecessaryParentheses(this, parenthesis, options && options.implicit); // format string as start:step:stop
 
-  RangeNode.prototype.toJSON = function () {
-    return {
-      mathjs: 'RangeNode',
-      start: this.start,
-      end: this.end,
-      step: this.step
-    };
-  };
-  /**
-   * Instantiate an RangeNode from its JSON representation
-   * @param {Object} json  An object structured like
-   *                       `{"mathjs": "RangeNode", "start": ..., "end": ..., "step": ...}`,
-   *                       where mathjs is optional
-   * @returns {RangeNode}
-   */
+      var str;
+      var start = this.start.toString(options);
 
+      if (parens.start) {
+        start = '(' + start + ')';
+      }
 
-  RangeNode.fromJSON = function (json) {
-    return new RangeNode(json.start, json.end, json.step);
-  };
-  /**
-   * Get HTML representation
-   * @param {Object} options
-   * @return {string} str
-   */
+      str = start;
+
+      if (this.step) {
+        var step = this.step.toString(options);
 
+        if (parens.step) {
+          step = '(' + step + ')';
+        }
 
-  RangeNode.prototype.toHTML = function (options) {
-    var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
-    var parens = calculateNecessaryParentheses(this, parenthesis); // format string as start:step:stop
+        str += ':' + step;
+      }
 
-    var str;
-    var start = this.start.toHTML(options);
+      var end = this.end.toString(options);
+
+      if (parens.end) {
+        end = '(' + end + ')';
+      }
 
-    if (parens.start) {
-      start = '<span class="math-parenthesis math-round-parenthesis">(</span>' + start + '<span class="math-parenthesis math-round-parenthesis">)</span>';
+      str += ':' + end;
+      return str;
     }
+    /**
+     * Get a JSON representation of the node
+     * @returns {Object}
+     */
+
+
+    toJSON() {
+      return {
+        mathjs: name,
+        start: this.start,
+        end: this.end,
+        step: this.step
+      };
+    }
+    /**
+     * Instantiate an RangeNode from its JSON representation
+     * @param {Object} json
+     *     An object structured like
+     *     `{"mathjs": "RangeNode", "start": ..., "end": ..., "step": ...}`,
+     *     where mathjs is optional
+     * @returns {RangeNode}
+     */
+
+
+    static fromJSON(json) {
+      return new RangeNode(json.start, json.end, json.step);
+    }
+    /**
+     * Get HTML representation
+     * @param {Object} options
+     * @return {string} str
+     */
 
-    str = start;
 
-    if (this.step) {
-      var step = this.step.toHTML(options);
+    toHTML(options) {
+      var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
+      var parens = calculateNecessaryParentheses(this, parenthesis, options && options.implicit); // format string as start:step:stop
 
-      if (parens.step) {
-        step = '<span class="math-parenthesis math-round-parenthesis">(</span>' + step + '<span class="math-parenthesis math-round-parenthesis">)</span>';
+      var str;
+      var start = this.start.toHTML(options);
+
+      if (parens.start) {
+        start = '<span class="math-parenthesis math-round-parenthesis">(</span>' + start + '<span class="math-parenthesis math-round-parenthesis">)</span>';
       }
 
-      str += '<span class="math-operator math-range-operator">:</span>' + step;
-    }
+      str = start;
 
-    var end = this.end.toHTML(options);
+      if (this.step) {
+        var step = this.step.toHTML(options);
 
-    if (parens.end) {
-      end = '<span class="math-parenthesis math-round-parenthesis">(</span>' + end + '<span class="math-parenthesis math-round-parenthesis">)</span>';
-    }
+        if (parens.step) {
+          step = '<span class="math-parenthesis math-round-parenthesis">(</span>' + step + '<span class="math-parenthesis math-round-parenthesis">)</span>';
+        }
 
-    str += '<span class="math-operator math-range-operator">:</span>' + end;
-    return str;
-  };
-  /**
-   * Get LaTeX representation
-   * @params {Object} options
-   * @return {string} str
-   */
+        str += '<span class="math-operator math-range-operator">:</span>' + step;
+      }
 
+      var end = this.end.toHTML(options);
 
-  RangeNode.prototype._toTex = function (options) {
-    var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
-    var parens = calculateNecessaryParentheses(this, parenthesis);
-    var str = this.start.toTex(options);
+      if (parens.end) {
+        end = '<span class="math-parenthesis math-round-parenthesis">(</span>' + end + '<span class="math-parenthesis math-round-parenthesis">)</span>';
+      }
 
-    if (parens.start) {
-      str = "\\left(".concat(str, "\\right)");
+      str += '<span class="math-operator math-range-operator">:</span>' + end;
+      return str;
     }
+    /**
+     * Get LaTeX representation
+     * @params {Object} options
+     * @return {string} str
+     */
 
-    if (this.step) {
-      var step = this.step.toTex(options);
 
-      if (parens.step) {
-        step = "\\left(".concat(step, "\\right)");
+    _toTex(options) {
+      var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
+      var parens = calculateNecessaryParentheses(this, parenthesis, options && options.implicit);
+      var str = this.start.toTex(options);
+
+      if (parens.start) {
+        str = "\\left(".concat(str, "\\right)");
       }
 
-      str += ':' + step;
-    }
+      if (this.step) {
+        var step = this.step.toTex(options);
+
+        if (parens.step) {
+          step = "\\left(".concat(step, "\\right)");
+        }
+
+        str += ':' + step;
+      }
 
-    var end = this.end.toTex(options);
+      var end = this.end.toTex(options);
 
-    if (parens.end) {
-      end = "\\left(".concat(end, "\\right)");
+      if (parens.end) {
+        end = "\\left(".concat(end, "\\right)");
+      }
+
+      str += ':' + end;
+      return str;
     }
 
-    str += ':' + end;
-    return str;
-  };
+  }
+
+  _defineProperty(RangeNode, "name", name);
 
   return RangeNode;
 }, {