mathjs-min 11.7.2

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

@@ -0,0 +1,185 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { isNode } from '../../utils/is.js';
+import { forEach, map } from '../../utils/array.js';
+import { factory } from '../../utils/factory.js';
+var name = 'BlockNode';
+var dependencies = ['ResultSet', 'Node'];
+export var createBlockNode = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    ResultSet,
+    Node
+  } = _ref;
+  class BlockNode extends Node {
+    /**
+     * @constructor BlockNode
+     * @extends {Node}
+     * Holds a set with blocks
+     * @param {Array.<{node: Node} | {node: Node, visible: boolean}>} blocks
+     *            An array with blocks, where a block is constructed as an
+     *            Object with properties block, which is a Node, and visible,
+     *            which is a boolean. The property visible is optional and
+     *            is true by default
+     */
+    constructor(blocks) {
+      super();
+      // validate input, copy blocks
+      if (!Array.isArray(blocks)) throw new Error('Array expected');
+      this.blocks = blocks.map(function (block) {
+        var node = block && block.node;
+        var visible = block && block.visible !== undefined ? block.visible : true;
+        if (!isNode(node)) throw new TypeError('Property "node" must be a Node');
+        if (typeof visible !== 'boolean') {
+          throw new TypeError('Property "visible" must be a boolean');
+        }
+        return {
+          node,
+          visible
+        };
+      });
+    }
+    get type() {
+      return name;
+    }
+    get isBlockNode() {
+      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 evalBlocks = map(this.blocks, function (block) {
+        return {
+          evaluate: block.node._compile(math, argNames),
+          visible: block.visible
+        };
+      });
+      return function evalBlockNodes(scope, args, context) {
+        var results = [];
+        forEach(evalBlocks, function evalBlockNode(block) {
+          var result = block.evaluate(scope, args, context);
+          if (block.visible) {
+            results.push(result);
+          }
+        });
+        return new ResultSet(results);
+      };
+    }
+
+    /**
+     * Execute a callback for each of the child blocks of this node
+     * @param {function(child: Node, path: string, parent: Node)} callback
+     */
+    forEach(callback) {
+      for (var i = 0; i < this.blocks.length; i++) {
+        callback(this.blocks[i].node, 'blocks[' + i + '].node', this);
+      }
+    }
+
+    /**
+     * Create a new BlockNode 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 {BlockNode} Returns a transformed copy of the node
+     */
+    map(callback) {
+      var blocks = [];
+      for (var i = 0; i < this.blocks.length; i++) {
+        var block = this.blocks[i];
+        var node = this._ifNode(callback(block.node, 'blocks[' + i + '].node', this));
+        blocks[i] = {
+          node,
+          visible: block.visible
+        };
+      }
+      return new BlockNode(blocks);
+    }
+
+    /**
+     * Create a clone of this node, a shallow copy
+     * @return {BlockNode}
+     */
+    clone() {
+      var blocks = this.blocks.map(function (block) {
+        return {
+          node: block.node,
+          visible: block.visible
+        };
+      });
+      return new BlockNode(blocks);
+    }
+
+    /**
+     * Get string representation
+     * @param {Object} options
+     * @return {string} str
+     * @override
+     */
+    _toString(options) {
+      return this.blocks.map(function (param) {
+        return param.node.toString(options) + (param.visible ? '' : ';');
+      }).join('\n');
+    }
+
+    /**
+     * Get a JSON representation of the node
+     * @returns {Object}
+     */
+    toJSON() {
+      return {
+        mathjs: name,
+        blocks: this.blocks
+      };
+    }
+
+    /**
+     * Instantiate an BlockNode from its JSON representation
+     * @param {Object} json
+     *     An object structured like
+     *     `{"mathjs": "BlockNode", blocks: [{node: ..., visible: false}, ...]}`,
+     *     where mathjs is optional
+     * @returns {BlockNode}
+     */
+    static fromJSON(json) {
+      return new BlockNode(json.blocks);
+    }
+
+    /**
+     * Get HTML representation
+     * @param {Object} options
+     * @return {string} str
+     * @override
+     */
+    toHTML(options) {
+      return this.blocks.map(function (param) {
+        return param.node.toHTML(options) + (param.visible ? '' : '<span class="math-separator">;</span>');
+      }).join('<span class="math-separator"><br /></span>');
+    }
+
+    /**
+     * Get LaTeX representation
+     * @param {Object} options
+     * @return {string} str
+     */
+    _toTex(options) {
+      return this.blocks.map(function (param) {
+        return param.node.toTex(options) + (param.visible ? '' : ';');
+      }).join('\\;\\;\n');
+    }
+  }
+  _defineProperty(BlockNode, "name", name);
+  return BlockNode;
+}, {
+  isClass: true,
+  isNode: true
+});

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

@@ -0,0 +1,225 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { isBigNumber, isComplex, isNode, isUnit, typeOf } from '../../utils/is.js';
+import { factory } from '../../utils/factory.js';
+import { getPrecedence } from '../operators.js';
+var name = 'ConditionalNode';
+var dependencies = ['Node'];
+export var createConditionalNode = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    Node
+  } = _ref;
+  /**
+   * Test whether a condition is met
+   * @param {*} condition
+   * @returns {boolean} true if condition is true or non-zero, else false
+   */
+  function testCondition(condition) {
+    if (typeof condition === 'number' || typeof condition === 'boolean' || typeof condition === 'string') {
+      return !!condition;
+    }
+    if (condition) {
+      if (isBigNumber(condition)) {
+        return !condition.isZero();
+      }
+      if (isComplex(condition)) {
+        return !!(condition.re || condition.im);
+      }
+      if (isUnit(condition)) {
+        return !!condition.value;
+      }
+    }
+    if (condition === null || condition === undefined) {
+      return false;
+    }
+    throw new TypeError('Unsupported type of condition "' + typeOf(condition) + '"');
+  }
+  class ConditionalNode extends Node {
+    /**
+     * A lazy evaluating conditional operator: 'condition ? trueExpr : falseExpr'
+     *
+     * @param {Node} condition   Condition, must result in a boolean
+     * @param {Node} trueExpr    Expression evaluated when condition is true
+     * @param {Node} falseExpr   Expression evaluated when condition is true
+     *
+     * @constructor ConditionalNode
+     * @extends {Node}
+     */
+    constructor(condition, trueExpr, falseExpr) {
+      super();
+      if (!isNode(condition)) {
+        throw new TypeError('Parameter condition must be a Node');
+      }
+      if (!isNode(trueExpr)) {
+        throw new TypeError('Parameter trueExpr must be a Node');
+      }
+      if (!isNode(falseExpr)) {
+        throw new TypeError('Parameter falseExpr must be a Node');
+      }
+      this.condition = condition;
+      this.trueExpr = trueExpr;
+      this.falseExpr = falseExpr;
+    }
+    get type() {
+      return name;
+    }
+    get isConditionalNode() {
+      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 evalCondition = this.condition._compile(math, argNames);
+      var evalTrueExpr = this.trueExpr._compile(math, argNames);
+      var evalFalseExpr = this.falseExpr._compile(math, argNames);
+      return function evalConditionalNode(scope, args, context) {
+        return testCondition(evalCondition(scope, args, context)) ? evalTrueExpr(scope, args, context) : evalFalseExpr(scope, args, context);
+      };
+    }
+
+    /**
+     * Execute a callback for each of the child nodes of this node
+     * @param {function(child: Node, path: string, parent: Node)} callback
+     */
+    forEach(callback) {
+      callback(this.condition, 'condition', this);
+      callback(this.trueExpr, 'trueExpr', this);
+      callback(this.falseExpr, 'falseExpr', this);
+    }
+
+    /**
+     * Create a new ConditionalNode 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 {ConditionalNode} Returns a transformed copy of the node
+     */
+    map(callback) {
+      return new ConditionalNode(this._ifNode(callback(this.condition, 'condition', this)), this._ifNode(callback(this.trueExpr, 'trueExpr', this)), this._ifNode(callback(this.falseExpr, 'falseExpr', this)));
+    }
+
+    /**
+     * Create a clone of this node, a shallow copy
+     * @return {ConditionalNode}
+     */
+    clone() {
+      return new ConditionalNode(this.condition, this.trueExpr, this.falseExpr);
+    }
+
+    /**
+     * Get string representation
+     * @param {Object} options
+     * @return {string} str
+     */
+    _toString(options) {
+      var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
+      var precedence = getPrecedence(this, parenthesis, options && options.implicit);
+
+      // Enclose Arguments in parentheses if they are an OperatorNode
+      // or have lower or equal precedence
+      // NOTE: enclosing all OperatorNodes in parentheses is a decision
+      // purely based on aesthetics and readability
+      var condition = this.condition.toString(options);
+      var conditionPrecedence = getPrecedence(this.condition, parenthesis, options && options.implicit);
+      if (parenthesis === 'all' || this.condition.type === 'OperatorNode' || conditionPrecedence !== null && conditionPrecedence <= precedence) {
+        condition = '(' + condition + ')';
+      }
+      var trueExpr = this.trueExpr.toString(options);
+      var truePrecedence = getPrecedence(this.trueExpr, parenthesis, options && options.implicit);
+      if (parenthesis === 'all' || this.trueExpr.type === 'OperatorNode' || truePrecedence !== null && truePrecedence <= precedence) {
+        trueExpr = '(' + trueExpr + ')';
+      }
+      var falseExpr = this.falseExpr.toString(options);
+      var falsePrecedence = getPrecedence(this.falseExpr, parenthesis, options && options.implicit);
+      if (parenthesis === 'all' || this.falseExpr.type === 'OperatorNode' || falsePrecedence !== null && falsePrecedence <= precedence) {
+        falseExpr = '(' + falseExpr + ')';
+      }
+      return condition + ' ? ' + trueExpr + ' : ' + falseExpr;
+    }
+
+    /**
+     * Get a JSON representation of the node
+     * @returns {Object}
+     */
+    toJSON() {
+      return {
+        mathjs: name,
+        condition: this.condition,
+        trueExpr: this.trueExpr,
+        falseExpr: this.falseExpr
+      };
+    }
+
+    /**
+     * Instantiate an ConditionalNode from its JSON representation
+     * @param {Object} json
+     *     An object structured like
+     *     ```
+     *     {"mathjs": "ConditionalNode",
+     *      "condition": ...,
+     *      "trueExpr": ...,
+     *      "falseExpr": ...}
+     *     ```
+     *     where mathjs is optional
+     * @returns {ConditionalNode}
+     */
+    static fromJSON(json) {
+      return new ConditionalNode(json.condition, json.trueExpr, json.falseExpr);
+    }
+
+    /**
+     * Get HTML representation
+     * @param {Object} options
+     * @return {string} str
+     */
+    toHTML(options) {
+      var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
+      var precedence = getPrecedence(this, parenthesis, options && options.implicit);
+
+      // Enclose Arguments in parentheses if they are an OperatorNode
+      // or have lower or equal precedence
+      // NOTE: enclosing all OperatorNodes in parentheses is a decision
+      // purely based on aesthetics and readability
+      var condition = this.condition.toHTML(options);
+      var conditionPrecedence = getPrecedence(this.condition, parenthesis, options && options.implicit);
+      if (parenthesis === 'all' || this.condition.type === 'OperatorNode' || conditionPrecedence !== null && conditionPrecedence <= precedence) {
+        condition = '<span class="math-parenthesis math-round-parenthesis">(</span>' + condition + '<span class="math-parenthesis math-round-parenthesis">)</span>';
+      }
+      var trueExpr = this.trueExpr.toHTML(options);
+      var truePrecedence = getPrecedence(this.trueExpr, parenthesis, options && options.implicit);
+      if (parenthesis === 'all' || this.trueExpr.type === 'OperatorNode' || truePrecedence !== null && truePrecedence <= precedence) {
+        trueExpr = '<span class="math-parenthesis math-round-parenthesis">(</span>' + trueExpr + '<span class="math-parenthesis math-round-parenthesis">)</span>';
+      }
+      var falseExpr = this.falseExpr.toHTML(options);
+      var falsePrecedence = getPrecedence(this.falseExpr, parenthesis, options && options.implicit);
+      if (parenthesis === 'all' || this.falseExpr.type === 'OperatorNode' || falsePrecedence !== null && falsePrecedence <= precedence) {
+        falseExpr = '<span class="math-parenthesis math-round-parenthesis">(</span>' + falseExpr + '<span class="math-parenthesis math-round-parenthesis">)</span>';
+      }
+      return condition + '<span class="math-operator math-conditional-operator">?</span>' + trueExpr + '<span class="math-operator math-conditional-operator">:</span>' + falseExpr;
+    }
+
+    /**
+     * Get LaTeX representation
+     * @param {Object} options
+     * @return {string} str
+     */
+    _toTex(options) {
+      return '\\begin{cases} {' + this.trueExpr.toTex(options) + '}, &\\quad{\\text{if }\\;' + this.condition.toTex(options) + '}\\\\{' + this.falseExpr.toTex(options) + '}, &\\quad{\\text{otherwise}}\\end{cases}';
+    }
+  }
+  _defineProperty(ConditionalNode, "name", name);
+  return ConditionalNode;
+}, {
+  isClass: true,
+  isNode: true
+});

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

@@ -0,0 +1,172 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { format } from '../../utils/string.js';
+import { typeOf } from '../../utils/is.js';
+import { escapeLatex } from '../../utils/latex.js';
+import { factory } from '../../utils/factory.js';
+var name = 'ConstantNode';
+var dependencies = ['Node'];
+export var createConstantNode = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    Node
+  } = _ref;
+  class ConstantNode extends Node {
+    /**
+     * A ConstantNode holds a constant value like a number or string.
+     *
+     * Usage:
+     *
+     *     new ConstantNode(2.3)
+     *     new ConstantNode('hello')
+     *
+     * @param {*} value    Value can be any type (number, BigNumber, string, ...)
+     * @constructor ConstantNode
+     * @extends {Node}
+     */
+    constructor(value) {
+      super();
+      this.value = value;
+    }
+    get type() {
+      return name;
+    }
+    get isConstantNode() {
+      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 value = this.value;
+      return function evalConstantNode() {
+        return value;
+      };
+    }
+
+    /**
+     * Execute a callback for each of the child nodes of this node
+     * @param {function(child: Node, path: string, parent: Node)} callback
+     */
+    forEach(callback) {
+      // nothing to do, we don't have any children
+    }
+
+    /**
+     * Create a new ConstantNode with children produced by the given callback.
+     * Trivial because there are no children.
+     * @param {function(child: Node, path: string, parent: Node) : Node} callback
+     * @returns {ConstantNode} Returns a clone of the node
+     */
+    map(callback) {
+      return this.clone();
+    }
+
+    /**
+     * Create a clone of this node, a shallow copy
+     * @return {ConstantNode}
+     */
+    clone() {
+      return new ConstantNode(this.value);
+    }
+
+    /**
+     * Get string representation
+     * @param {Object} options
+     * @return {string} str
+     */
+    _toString(options) {
+      return format(this.value, options);
+    }
+
+    /**
+     * Get HTML representation
+     * @param {Object} options
+     * @return {string} str
+     */
+    toHTML(options) {
+      var value = this._toString(options);
+      switch (typeOf(this.value)) {
+        case 'number':
+        case 'BigNumber':
+        case 'Fraction':
+          return '<span class="math-number">' + value + '</span>';
+        case 'string':
+          return '<span class="math-string">' + value + '</span>';
+        case 'boolean':
+          return '<span class="math-boolean">' + value + '</span>';
+        case 'null':
+          return '<span class="math-null-symbol">' + value + '</span>';
+        case 'undefined':
+          return '<span class="math-undefined">' + value + '</span>';
+        default:
+          return '<span class="math-symbol">' + value + '</span>';
+      }
+    }
+
+    /**
+     * Get a JSON representation of the node
+     * @returns {Object}
+     */
+    toJSON() {
+      return {
+        mathjs: name,
+        value: this.value
+      };
+    }
+
+    /**
+     * Instantiate a ConstantNode from its JSON representation
+     * @param {Object} json  An object structured like
+     *                       `{"mathjs": "SymbolNode", value: 2.3}`,
+     *                       where mathjs is optional
+     * @returns {ConstantNode}
+     */
+    static fromJSON(json) {
+      return new ConstantNode(json.value);
+    }
+
+    /**
+     * Get LaTeX representation
+     * @param {Object} options
+     * @return {string} str
+     */
+    _toTex(options) {
+      var value = this._toString(options);
+      switch (typeOf(this.value)) {
+        case 'string':
+          return '\\mathtt{' + escapeLatex(value) + '}';
+        case 'number':
+        case 'BigNumber':
+          {
+            if (!isFinite(this.value)) {
+              return this.value.valueOf() < 0 ? '-\\infty' : '\\infty';
+            }
+            var index = value.toLowerCase().indexOf('e');
+            if (index !== -1) {
+              return value.substring(0, index) + '\\cdot10^{' + value.substring(index + 1) + '}';
+            }
+          }
+          return value;
+        case 'Fraction':
+          return this.value.toLatex();
+        default:
+          return value;
+      }
+    }
+  }
+  _defineProperty(ConstantNode, "name", name);
+  return ConstantNode;
+}, {
+  isClass: true,
+  isNode: true
+});