FunctionAssignmentNode.js 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  1. import _defineProperty from "@babel/runtime/helpers/defineProperty";
  2. import { isNode } from '../../utils/is.js';
  3. import { keywords } from '../keywords.js';
  4. import { escape } from '../../utils/string.js';
  5. import { forEach, join } from '../../utils/array.js';
  6. import { toSymbol } from '../../utils/latex.js';
  7. import { getPrecedence } from '../operators.js';
  8. import { factory } from '../../utils/factory.js';
  9. var name = 'FunctionAssignmentNode';
  10. var dependencies = ['typed', 'Node'];
  11. export var createFunctionAssignmentNode = /* #__PURE__ */factory(name, dependencies, _ref => {
  12. var {
  13. typed,
  14. Node
  15. } = _ref;
  16. /**
  17. * Is parenthesis needed?
  18. * @param {Node} node
  19. * @param {Object} parenthesis
  20. * @param {string} implicit
  21. * @private
  22. */
  23. function needParenthesis(node, parenthesis, implicit) {
  24. var precedence = getPrecedence(node, parenthesis, implicit);
  25. var exprPrecedence = getPrecedence(node.expr, parenthesis, implicit);
  26. return parenthesis === 'all' || exprPrecedence !== null && exprPrecedence <= precedence;
  27. }
  28. class FunctionAssignmentNode extends Node {
  29. /**
  30. * @constructor FunctionAssignmentNode
  31. * @extends {Node}
  32. * Function assignment
  33. *
  34. * @param {string} name Function name
  35. * @param {string[] | Array.<{name: string, type: string}>} params
  36. * Array with function parameter names, or an
  37. * array with objects containing the name
  38. * and type of the parameter
  39. * @param {Node} expr The function expression
  40. */
  41. constructor(name, params, expr) {
  42. super();
  43. // validate input
  44. if (typeof name !== 'string') {
  45. throw new TypeError('String expected for parameter "name"');
  46. }
  47. if (!Array.isArray(params)) {
  48. throw new TypeError('Array containing strings or objects expected for parameter "params"');
  49. }
  50. if (!isNode(expr)) {
  51. throw new TypeError('Node expected for parameter "expr"');
  52. }
  53. if (keywords.has(name)) {
  54. throw new Error('Illegal function name, "' + name + '" is a reserved keyword');
  55. }
  56. var paramNames = new Set();
  57. for (var param of params) {
  58. var _name = typeof param === 'string' ? param : param.name;
  59. if (paramNames.has(_name)) {
  60. throw new Error("Duplicate parameter name \"".concat(_name, "\""));
  61. } else {
  62. paramNames.add(_name);
  63. }
  64. }
  65. this.name = name;
  66. this.params = params.map(function (param) {
  67. return param && param.name || param;
  68. });
  69. this.types = params.map(function (param) {
  70. return param && param.type || 'any';
  71. });
  72. this.expr = expr;
  73. }
  74. get type() {
  75. return name;
  76. }
  77. get isFunctionAssignmentNode() {
  78. return true;
  79. }
  80. /**
  81. * Compile a node into a JavaScript function.
  82. * This basically pre-calculates as much as possible and only leaves open
  83. * calculations which depend on a dynamic scope with variables.
  84. * @param {Object} math Math.js namespace with functions and constants.
  85. * @param {Object} argNames An object with argument names as key and `true`
  86. * as value. Used in the SymbolNode to optimize
  87. * for arguments from user assigned functions
  88. * (see FunctionAssignmentNode) or special symbols
  89. * like `end` (see IndexNode).
  90. * @return {function} Returns a function which can be called like:
  91. * evalNode(scope: Object, args: Object, context: *)
  92. */
  93. _compile(math, argNames) {
  94. var childArgNames = Object.create(argNames);
  95. forEach(this.params, function (param) {
  96. childArgNames[param] = true;
  97. });
  98. // compile the function expression with the child args
  99. var evalExpr = this.expr._compile(math, childArgNames);
  100. var name = this.name;
  101. var params = this.params;
  102. var signature = join(this.types, ',');
  103. var syntax = name + '(' + join(this.params, ', ') + ')';
  104. return function evalFunctionAssignmentNode(scope, args, context) {
  105. var signatures = {};
  106. signatures[signature] = function () {
  107. var childArgs = Object.create(args);
  108. for (var i = 0; i < params.length; i++) {
  109. childArgs[params[i]] = arguments[i];
  110. }
  111. return evalExpr(scope, childArgs, context);
  112. };
  113. var fn = typed(name, signatures);
  114. fn.syntax = syntax;
  115. scope.set(name, fn);
  116. return fn;
  117. };
  118. }
  119. /**
  120. * Execute a callback for each of the child nodes of this node
  121. * @param {function(child: Node, path: string, parent: Node)} callback
  122. */
  123. forEach(callback) {
  124. callback(this.expr, 'expr', this);
  125. }
  126. /**
  127. * Create a new FunctionAssignmentNode whose children are the results of
  128. * calling the provided callback function for each child of the original
  129. * node.
  130. * @param {function(child: Node, path: string, parent: Node): Node} callback
  131. * @returns {FunctionAssignmentNode} Returns a transformed copy of the node
  132. */
  133. map(callback) {
  134. var expr = this._ifNode(callback(this.expr, 'expr', this));
  135. return new FunctionAssignmentNode(this.name, this.params.slice(0), expr);
  136. }
  137. /**
  138. * Create a clone of this node, a shallow copy
  139. * @return {FunctionAssignmentNode}
  140. */
  141. clone() {
  142. return new FunctionAssignmentNode(this.name, this.params.slice(0), this.expr);
  143. }
  144. /**
  145. * get string representation
  146. * @param {Object} options
  147. * @return {string} str
  148. */
  149. _toString(options) {
  150. var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
  151. var expr = this.expr.toString(options);
  152. if (needParenthesis(this, parenthesis, options && options.implicit)) {
  153. expr = '(' + expr + ')';
  154. }
  155. return this.name + '(' + this.params.join(', ') + ') = ' + expr;
  156. }
  157. /**
  158. * Get a JSON representation of the node
  159. * @returns {Object}
  160. */
  161. toJSON() {
  162. var types = this.types;
  163. return {
  164. mathjs: name,
  165. name: this.name,
  166. params: this.params.map(function (param, index) {
  167. return {
  168. name: param,
  169. type: types[index]
  170. };
  171. }),
  172. expr: this.expr
  173. };
  174. }
  175. /**
  176. * Instantiate an FunctionAssignmentNode from its JSON representation
  177. * @param {Object} json
  178. * An object structured like
  179. * ```
  180. * {"mathjs": "FunctionAssignmentNode",
  181. * name: ..., params: ..., expr: ...}
  182. * ```
  183. * where mathjs is optional
  184. * @returns {FunctionAssignmentNode}
  185. */
  186. static fromJSON(json) {
  187. return new FunctionAssignmentNode(json.name, json.params, json.expr);
  188. }
  189. /**
  190. * get HTML representation
  191. * @param {Object} options
  192. * @return {string} str
  193. */
  194. toHTML(options) {
  195. var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
  196. var params = [];
  197. for (var i = 0; i < this.params.length; i++) {
  198. params.push('<span class="math-symbol math-parameter">' + escape(this.params[i]) + '</span>');
  199. }
  200. var expr = this.expr.toHTML(options);
  201. if (needParenthesis(this, parenthesis, options && options.implicit)) {
  202. expr = '<span class="math-parenthesis math-round-parenthesis">(</span>' + expr + '<span class="math-parenthesis math-round-parenthesis">)</span>';
  203. }
  204. 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;
  205. }
  206. /**
  207. * get LaTeX representation
  208. * @param {Object} options
  209. * @return {string} str
  210. */
  211. _toTex(options) {
  212. var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
  213. var expr = this.expr.toTex(options);
  214. if (needParenthesis(this, parenthesis, options && options.implicit)) {
  215. expr = "\\left(".concat(expr, "\\right)");
  216. }
  217. return '\\mathrm{' + this.name + '}\\left(' + this.params.map(toSymbol).join(',') + '\\right):=' + expr;
  218. }
  219. }
  220. _defineProperty(FunctionAssignmentNode, "name", name);
  221. return FunctionAssignmentNode;
  222. }, {
  223. isClass: true,
  224. isNode: true
  225. });