250 lines
8.6 KiB
JavaScript
250 lines
8.6 KiB
JavaScript
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';
|
|
var name = 'RangeNode';
|
|
var dependencies = ['Node'];
|
|
export var createRangeNode = /* #__PURE__ */factory(name, dependencies, _ref => {
|
|
var {
|
|
Node
|
|
} = _ref;
|
|
/**
|
|
* Calculate the necessary parentheses
|
|
* @param {Node} node
|
|
* @param {string} parenthesis
|
|
* @param {string} implicit
|
|
* @return {Object} parentheses
|
|
* @private
|
|
*/
|
|
function calculateNecessaryParentheses(node, parenthesis, implicit) {
|
|
var precedence = getPrecedence(node, parenthesis, implicit);
|
|
var parens = {};
|
|
var startPrecedence = getPrecedence(node.start, parenthesis, implicit);
|
|
parens.start = startPrecedence !== null && startPrecedence <= precedence || parenthesis === 'all';
|
|
if (node.step) {
|
|
var stepPrecedence = getPrecedence(node.step, parenthesis, implicit);
|
|
parens.step = stepPrecedence !== null && stepPrecedence <= precedence || parenthesis === 'all';
|
|
}
|
|
var endPrecedence = getPrecedence(node.end, parenthesis, implicit);
|
|
parens.end = endPrecedence !== null && endPrecedence <= precedence || parenthesis === 'all';
|
|
return parens;
|
|
}
|
|
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
|
|
}
|
|
get type() {
|
|
return name;
|
|
}
|
|
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
|
|
*/
|
|
forEach(callback) {
|
|
callback(this.start, 'start', this);
|
|
callback(this.end, 'end', this);
|
|
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
|
|
*/
|
|
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}
|
|
*/
|
|
clone() {
|
|
return new RangeNode(this.start, this.end, this.step && this.step);
|
|
}
|
|
|
|
/**
|
|
* Get string representation
|
|
* @param {Object} options
|
|
* @return {string} str
|
|
*/
|
|
_toString(options) {
|
|
var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
|
|
var parens = calculateNecessaryParentheses(this, parenthesis, options && options.implicit);
|
|
|
|
// format string as start:step:stop
|
|
var str;
|
|
var start = this.start.toString(options);
|
|
if (parens.start) {
|
|
start = '(' + start + ')';
|
|
}
|
|
str = start;
|
|
if (this.step) {
|
|
var step = this.step.toString(options);
|
|
if (parens.step) {
|
|
step = '(' + step + ')';
|
|
}
|
|
str += ':' + step;
|
|
}
|
|
var end = this.end.toString(options);
|
|
if (parens.end) {
|
|
end = '(' + end + ')';
|
|
}
|
|
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
|
|
*/
|
|
_toHTML(options) {
|
|
var parenthesis = options && options.parenthesis ? options.parenthesis : 'keep';
|
|
var parens = calculateNecessaryParentheses(this, parenthesis, options && options.implicit);
|
|
|
|
// format string as start:step:stop
|
|
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 = start;
|
|
if (this.step) {
|
|
var step = this.step.toHTML(options);
|
|
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>' + step;
|
|
}
|
|
var end = this.end.toHTML(options);
|
|
if (parens.end) {
|
|
end = '<span class="math-parenthesis math-round-parenthesis">(</span>' + end + '<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
|
|
*/
|
|
_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)");
|
|
}
|
|
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);
|
|
if (parens.end) {
|
|
end = "\\left(".concat(end, "\\right)");
|
|
}
|
|
str += ':' + end;
|
|
return str;
|
|
}
|
|
}
|
|
_defineProperty(RangeNode, "name", name);
|
|
return RangeNode;
|
|
}, {
|
|
isClass: true,
|
|
isNode: true
|
|
}); |