mathjs 11.2.0 → 11.3.0

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

@@ -13,7 +13,6 @@ export var createFunctionAssignmentNode = /* #__PURE__ */factory(name, dependenc
     typed,
     Node
   } = _ref;
-
   /**
    * Is parenthesis needed?
    * @param {Node} node
@@ -26,7 +25,6 @@ export var createFunctionAssignmentNode = /* #__PURE__ */factory(name, dependenc
     var exprPrecedence = getPrecedence(node.expr, parenthesis, implicit);
     return parenthesis === 'all' || exprPrecedence !== null && exprPrecedence <= precedence;
   }
-
   class FunctionAssignmentNode extends Node {
     /**
      * @constructor FunctionAssignmentNode
@@ -41,24 +39,20 @@ export var createFunctionAssignmentNode = /* #__PURE__ */factory(name, dependenc
      * @param {Node} expr             The function expression
      */
     constructor(name, params, expr) {
-      super(); // validate input
-
+      super();
+      // validate input
       if (typeof name !== 'string') {
         throw new TypeError('String expected for parameter "name"');
       }
-
       if (!Array.isArray(params)) {
         throw new TypeError('Array containing strings or objects expected for parameter "params"');
       }
-
       if (!isNode(expr)) {
         throw new TypeError('Node expected for parameter "expr"');
       }
-
       if (keywords.has(name)) {
         throw new Error('Illegal function name, "' + name + '" is a reserved keyword');
       }
-
       this.name = name;
       this.params = params.map(function (param) {
         return param && param.name || param;
@@ -68,14 +62,13 @@ export var createFunctionAssignmentNode = /* #__PURE__ */factory(name, dependenc
       });
       this.expr = expr;
     }
-
     get type() {
       return name;
     }
-
     get isFunctionAssignmentNode() {
       return true;
     }
+
     /**
      * Compile a node into a JavaScript function.
      * This basically pre-calculates as much as possible and only leaves open
@@ -89,48 +82,42 @@ export var createFunctionAssignmentNode = /* #__PURE__ */factory(name, dependenc
      * @return {function} Returns a function which can be called like:
      *                        evalNode(scope: Object, args: Object, context: *)
      */
-
-
     _compile(math, argNames) {
       var childArgNames = Object.create(argNames);
       forEach(this.params, function (param) {
         childArgNames[param] = true;
-      }); // compile the function expression with the child args
+      });
 
+      // compile the function expression with the child args
       var evalExpr = this.expr._compile(math, childArgNames);
-
       var name = this.name;
       var params = this.params;
       var signature = join(this.types, ',');
       var syntax = name + '(' + join(this.params, ', ') + ')';
       return function evalFunctionAssignmentNode(scope, args, context) {
         var signatures = {};
-
         signatures[signature] = function () {
           var childArgs = Object.create(args);
-
           for (var i = 0; i < params.length; i++) {
             childArgs[params[i]] = arguments[i];
           }
-
           return evalExpr(scope, childArgs, context);
         };
-
         var fn = typed(name, signatures);
         fn.syntax = syntax;
         scope.set(name, fn);
         return fn;
       };
     }
+
     /**
      * 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.expr, 'expr', this);
     }
+
     /**
      * Create a new FunctionAssignmentNode whose children are the results of
      * calling the provided callback function for each child of the original
@@ -138,45 +125,37 @@ export var createFunctionAssignmentNode = /* #__PURE__ */factory(name, dependenc
      * @param {function(child: Node, path: string, parent: Node): Node} callback
      * @returns {FunctionAssignmentNode} Returns a transformed copy of the node
      */
-
-
     map(callback) {
       var expr = this._ifNode(callback(this.expr, 'expr', this));
-
       return new FunctionAssignmentNode(this.name, this.params.slice(0), expr);
     }
+
     /**
      * Create a clone of this node, a shallow copy
      * @return {FunctionAssignmentNode}
      */
-
-
     clone() {
       return new FunctionAssignmentNode(this.name, this.params.slice(0), this.expr);
     }
+
     /**
      * get string representation
      * @param {Object} options
      * @return {string} str
      */
-
-
     _toString(options) {
       var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
       var expr = this.expr.toString(options);
-
       if (needParenthesis(this, parenthesis, options && options.implicit)) {
         expr = '(' + expr + ')';
       }
-
       return this.name + '(' + this.params.join(', ') + ') = ' + expr;
     }
+
     /**
      * Get a JSON representation of the node
      * @returns {Object}
      */
-
-
     toJSON() {
       var types = this.types;
       return {
@@ -191,6 +170,7 @@ export var createFunctionAssignmentNode = /* #__PURE__ */factory(name, dependenc
         expr: this.expr
       };
     }
+
     /**
      * Instantiate an FunctionAssignmentNode from its JSON representation
      * @param {Object} json
@@ -202,56 +182,43 @@ export var createFunctionAssignmentNode = /* #__PURE__ */factory(name, dependenc
      *     where mathjs is optional
      * @returns {FunctionAssignmentNode}
      */
-
-
     static fromJSON(json) {
       return new FunctionAssignmentNode(json.name, json.params, json.expr);
     }
+
     /**
      * get HTML representation
      * @param {Object} options
      * @return {string} str
      */
-
-
     toHTML(options) {
       var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
       var params = [];
-
       for (var i = 0; i < this.params.length; i++) {
         params.push('<span class="math-symbol math-parameter">' + escape(this.params[i]) + '</span>');
       }
-
       var expr = this.expr.toHTML(options);
-
       if (needParenthesis(this, parenthesis, options && options.implicit)) {
         expr = '<span class="math-parenthesis math-round-parenthesis">(</span>' + expr + '<span class="math-parenthesis math-round-parenthesis">)</span>';
       }
-
       return '<span class="math-function">' + escape(this.name) + '</span>' + '<span class="math-parenthesis math-round-parenthesis">(</span>' + params.join('<span class="math-separator">,</span>') + '<span class="math-parenthesis math-round-parenthesis">)</span>' + '<span class="math-operator math-assignment-operator ' + 'math-variable-assignment-operator math-binary-operator">=</span>' + expr;
     }
+
     /**
      * get LaTeX representation
      * @param {Object} options
      * @return {string} str
      */
-
-
     _toTex(options) {
       var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
       var expr = this.expr.toTex(options);
-
       if (needParenthesis(this, parenthesis, options && options.implicit)) {
         expr = "\\left(".concat(expr, "\\right)");
       }
-
       return '\\mathrm{' + this.name + '}\\left(' + this.params.map(toSymbol).join(',') + '\\right):=' + expr;
     }
-
   }
-
   _defineProperty(FunctionAssignmentNode, "name", name);
-
   return FunctionAssignmentNode;
 }, {
   isClass: true,

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

@@ -14,11 +14,11 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
     Node,
     SymbolNode
   } = _ref;
-
   /* format to fixed length */
   var strin = entity => format(entity, {
     truncate: 78
   });
+
   /*
    * Expand a LaTeX template
    *
@@ -27,23 +27,19 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
    * @param {Object} options
    * @private
    **/
-
-
   function expandTemplate(template, node, options) {
-    var latex = ''; // Match everything of the form ${identifier} or ${identifier[2]} or $$
-    // while submatching identifier and 2 (in the second case)
+    var latex = '';
 
+    // Match everything of the form ${identifier} or ${identifier[2]} or $$
+    // while submatching identifier and 2 (in the second case)
     var regex = /\$(?:\{([a-z_][a-z_0-9]*)(?:\[([0-9]+)\])?\}|\$)/gi;
     var inputPos = 0; // position in the input string
-
     var match;
-
     while ((match = regex.exec(template)) !== null) {
       // go through all matches
       // add everything in front of the match to the LaTeX string
       latex += template.substring(inputPos, match.index);
       inputPos = match.index;
-
       if (match[0] === '$$') {
         // escaped dollar sign
         latex += '$';
@@ -52,18 +48,15 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
         // template parameter
         inputPos += match[0].length;
         var property = node[match[1]];
-
         if (!property) {
           throw new ReferenceError('Template: Property ' + match[1] + ' does not exist.');
         }
-
         if (match[2] === undefined) {
           // no square brackets
           switch (typeof property) {
             case 'string':
               latex += property;
               break;
-
             case 'object':
               if (isNode(property)) {
                 latex += property.toTex(options);
@@ -73,15 +66,12 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
                   if (isNode(arg)) {
                     return arg.toTex(options);
                   }
-
                   throw new TypeError('Template: ' + match[1] + '[' + index + '] is not a Node.');
                 }).join(',');
               } else {
                 throw new TypeError('Template: ' + match[1] + ' has to be a Node, String or array of Nodes');
               }
-
               break;
-
             default:
               throw new TypeError('Template: ' + match[1] + ' has to be a Node, String or array of Nodes');
           }
@@ -95,12 +85,10 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
         }
       }
     }
-
     latex += template.slice(inputPos); // append rest of the template
 
     return latex;
   }
-
   class FunctionNode extends Node {
     /**
      * @constructor FunctionNode
@@ -113,34 +101,30 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
      */
     constructor(fn, args) {
       super();
-
       if (typeof fn === 'string') {
         fn = new SymbolNode(fn);
-      } // validate input
-
+      }
 
+      // validate input
       if (!isNode(fn)) throw new TypeError('Node expected as parameter "fn"');
-
       if (!Array.isArray(args) || !args.every(isNode)) {
         throw new TypeError('Array containing Nodes expected for parameter "args"');
       }
-
       this.fn = fn;
       this.args = args || [];
-    } // readonly property name
-
+    }
 
+    // readonly property name
     get name() {
       return this.fn.name || '';
     }
-
     get type() {
       return name;
     }
-
     get isFunctionNode() {
       return true;
     }
+
     /**
      * Compile a node into a JavaScript function.
      * This basically pre-calculates as much as possible and only leaves open
@@ -154,24 +138,18 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
      * @return {function} Returns a function which can be called like:
      *                        evalNode(scope: Object, args: Object, context: *)
      */
-
-
     _compile(math, argNames) {
       // compile arguments
       var evalArgs = this.args.map(arg => arg._compile(math, argNames));
-
       if (isSymbolNode(this.fn)) {
         var _name = this.fn.name;
-
         if (!argNames[_name]) {
           // we can statically determine whether the function
           // has the rawArgs property
           var fn = _name in math ? getSafeProperty(math, _name) : undefined;
           var isRaw = typeof fn === 'function' && fn.rawArgs === true;
-
           var resolveFn = scope => {
             var value;
-
             if (scope.has(_name)) {
               value = scope.get(_name);
             } else if (_name in math) {
@@ -179,14 +157,11 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
             } else {
               return FunctionNode.onUndefinedFunction(_name);
             }
-
             if (typeof value === 'function') {
               return value;
             }
-
             throw new TypeError("'".concat(_name, "' is not a function; its value is:\n  ").concat(strin(value)));
           };
-
           if (isRaw) {
             // pass unevaluated parameters (nodes) to the function
             // "raw" evaluation
@@ -203,14 +178,12 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
                   var fn = resolveFn(scope);
                   return fn();
                 };
-
               case 1:
                 return function evalFunctionNode(scope, args, context) {
                   var fn = resolveFn(scope);
                   var evalArg0 = evalArgs[0];
                   return fn(evalArg0(scope, args, context));
                 };
-
               case 2:
                 return function evalFunctionNode(scope, args, context) {
                   var fn = resolveFn(scope);
@@ -218,7 +191,6 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
                   var evalArg1 = evalArgs[1];
                   return fn(evalArg0(scope, args, context), evalArg1(scope, args, context));
                 };
-
               default:
                 return function evalFunctionNode(scope, args, context) {
                   var fn = resolveFn(scope);
@@ -232,11 +204,9 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
           var _rawArgs = this.args;
           return function evalFunctionNode(scope, args, context) {
             var fn = args[_name];
-
             if (typeof fn !== 'function') {
               throw new TypeError("Argument '".concat(_name, "' was not a function; received: ").concat(strin(fn)));
             }
-
             if (fn.rawArgs) {
               // "Raw" evaluation
               return fn(_rawArgs, math, createSubScope(scope, args), scope);
@@ -249,15 +219,14 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
       } else if (isAccessorNode(this.fn) && isIndexNode(this.fn.index) && this.fn.index.isObjectProperty()) {
         // execute the function with the right context:
         // the object of the AccessorNode
-        var evalObject = this.fn.object._compile(math, argNames);
 
+        var evalObject = this.fn.object._compile(math, argNames);
         var prop = this.fn.index.getObjectProperty();
         var _rawArgs2 = this.args;
         return function evalFunctionNode(scope, args, context) {
           var object = evalObject(scope, args, context);
           validateSafeMethod(object, prop);
           var isRaw = object[prop] && object[prop].rawArgs;
-
           if (isRaw) {
             // "Raw" evaluation
             return object[prop](_rawArgs2, math, createSubScope(scope, args), scope);
@@ -272,17 +241,13 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
         // we have to dynamically determine whether the function has the
         // rawArgs property
         var fnExpr = this.fn.toString();
-
         var evalFn = this.fn._compile(math, argNames);
-
         var _rawArgs3 = this.args;
         return function evalFunctionNode(scope, args, context) {
           var fn = evalFn(scope, args, context);
-
           if (typeof fn !== 'function') {
             throw new TypeError("Expression '".concat(fnExpr, "' did not evaluate to a function; value is:") + "\n  ".concat(strin(fn)));
           }
-
           if (fn.rawArgs) {
             // "Raw" evaluation
             return fn(_rawArgs3, math, createSubScope(scope, args), scope);
@@ -294,53 +259,46 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
         };
       }
     }
+
     /**
      * 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.fn, 'fn', this);
-
       for (var i = 0; i < this.args.length; i++) {
         callback(this.args[i], 'args[' + i + ']', this);
       }
     }
+
     /**
      * Create a new FunctionNode 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 {FunctionNode} Returns a transformed copy of the node
      */
-
-
     map(callback) {
       var fn = this._ifNode(callback(this.fn, 'fn', this));
-
       var args = [];
-
       for (var i = 0; i < this.args.length; i++) {
         args[i] = this._ifNode(callback(this.args[i], 'args[' + i + ']', this));
       }
-
       return new FunctionNode(fn, args);
     }
+
     /**
      * Create a clone of this node, a shallow copy
      * @return {FunctionNode}
      */
-
-
     clone() {
       return new FunctionNode(this.fn, this.args.slice(0));
     }
+
     /**
      * Throws an error 'Undefined function {name}'
      * @param {string} name
      */
 
-
     /**
      * Get string representation. (wrapper function)
      * This overrides parts of Node's toString function.
@@ -356,40 +314,37 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
     toString(options) {
       var customString;
       var name = this.fn.toString(options);
-
       if (options && typeof options.handler === 'object' && hasOwnProperty(options.handler, name)) {
         // callback is a map of callback functions
         customString = options.handler[name](this, options);
       }
-
       if (typeof customString !== 'undefined') {
         return customString;
-      } // fall back to Node's toString
-
+      }
 
+      // fall back to Node's toString
       return super.toString(options);
     }
+
     /**
      * Get string representation
      * @param {Object} options
      * @return {string} str
      */
-
-
     _toString(options) {
       var args = this.args.map(function (arg) {
         return arg.toString(options);
       });
-      var fn = isFunctionAssignmentNode(this.fn) ? '(' + this.fn.toString(options) + ')' : this.fn.toString(options); // format the arguments like "add(2, 4.2)"
+      var fn = isFunctionAssignmentNode(this.fn) ? '(' + this.fn.toString(options) + ')' : this.fn.toString(options);
 
+      // format the arguments like "add(2, 4.2)"
       return fn + '(' + args.join(', ') + ')';
     }
+
     /**
      * Get a JSON representation of the node
      * @returns {Object}
      */
-
-
     toJSON() {
       return {
         mathjs: name,
@@ -397,6 +352,7 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
         args: this.args
       };
     }
+
     /**
      * Instantiate an AssignmentNode from its JSON representation
      * @param {Object} json  An object structured like
@@ -405,7 +361,6 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
      * @returns {FunctionNode}
      */
 
-
     /**
      * Get HTML representation
      * @param {Object} options
@@ -414,10 +369,12 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
     toHTML(options) {
       var args = this.args.map(function (arg) {
         return arg.toHTML(options);
-      }); // format the arguments like "add(2, 4.2)"
+      });
 
+      // format the arguments like "add(2, 4.2)"
       return '<span class="math-function">' + escape(this.fn) + '</span><span class="math-paranthesis math-round-parenthesis">(</span>' + args.join('<span class="math-separator">,</span>') + '<span class="math-paranthesis math-round-parenthesis">)</span>';
     }
+
     /**
      * Get LaTeX representation. (wrapper function)
      * This overrides parts of Node's toTex function.
@@ -429,60 +386,50 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
      * @param {Object} options
      * @return {string}
      */
-
-
     toTex(options) {
       var customTex;
-
       if (options && typeof options.handler === 'object' && hasOwnProperty(options.handler, this.name)) {
         // callback is a map of callback functions
         customTex = options.handler[this.name](this, options);
       }
-
       if (typeof customTex !== 'undefined') {
         return customTex;
-      } // fall back to Node's toTex
-
+      }
 
+      // fall back to Node's toTex
       return super.toTex(options);
     }
+
     /**
      * Get LaTeX representation
      * @param {Object} options
      * @return {string} str
      */
-
-
     _toTex(options) {
       var args = this.args.map(function (arg) {
         // get LaTeX of the arguments
         return arg.toTex(options);
       });
       var latexConverter;
-
       if (latexFunctions[this.name]) {
         latexConverter = latexFunctions[this.name];
-      } // toTex property on the function itself
-
+      }
 
+      // toTex property on the function itself
       if (math[this.name] && (typeof math[this.name].toTex === 'function' || typeof math[this.name].toTex === 'object' || typeof math[this.name].toTex === 'string')) {
         // .toTex is a callback function
         latexConverter = math[this.name].toTex;
       }
-
       var customToTex;
-
       switch (typeof latexConverter) {
         case 'function':
           // a callback function
           customToTex = latexConverter(this, options);
           break;
-
         case 'string':
           // a template string
           customToTex = expandTemplate(latexConverter, this, options);
           break;
-
         case 'object':
           // an object with different "converters" for different
           // numbers of arguments
@@ -490,42 +437,32 @@ export var createFunctionNode = /* #__PURE__ */factory(name, dependencies, _ref
             case 'function':
               customToTex = latexConverter[args.length](this, options);
               break;
-
             case 'string':
               customToTex = expandTemplate(latexConverter[args.length], this, options);
               break;
           }
-
       }
-
       if (typeof customToTex !== 'undefined') {
         return customToTex;
       }
-
       return expandTemplate(defaultTemplate, this, options);
     }
+
     /**
      * Get identifier.
      * @return {string}
      */
-
-
     getIdentifier() {
       return this.type + ':' + this.name;
     }
-
   }
-
   _defineProperty(FunctionNode, "name", name);
-
   _defineProperty(FunctionNode, "onUndefinedFunction", function (name) {
     throw new Error('Undefined function ' + name);
   });
-
   _defineProperty(FunctionNode, "fromJSON", function (json) {
     return new FunctionNode(json.fn, json.args);
   });
-
   return FunctionNode;
 }, {
   isClass: true,