123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219 |
- import _defineProperty from "@babel/runtime/helpers/defineProperty";
- import { map } from '../../utils/array.js';
- import { getSafeProperty } from '../../utils/customs.js';
- import { factory } from '../../utils/factory.js';
- import { isArray, isConstantNode, isMatrix, isNode, isString, typeOf } from '../../utils/is.js';
- import { escape } from '../../utils/string.js';
- var name = 'IndexNode';
- var dependencies = ['Node', 'size'];
- export var createIndexNode = /* #__PURE__ */factory(name, dependencies, _ref => {
- var {
- Node,
- size
- } = _ref;
- class IndexNode extends Node {
- /**
- * @constructor IndexNode
- * @extends Node
- *
- * Describes a subset of a matrix or an object property.
- * Cannot be used on its own, needs to be used within an AccessorNode or
- * AssignmentNode.
- *
- * @param {Node[]} dimensions
- * @param {boolean} [dotNotation=false]
- * Optional property describing whether this index was written using dot
- * notation like `a.b`, or using bracket notation like `a["b"]`
- * (which is the default). This property is used for string conversion.
- */
- constructor(dimensions, dotNotation) {
- super();
- this.dimensions = dimensions;
- this.dotNotation = dotNotation || false;
- // validate input
- if (!Array.isArray(dimensions) || !dimensions.every(isNode)) {
- throw new TypeError('Array containing Nodes expected for parameter "dimensions"');
- }
- if (this.dotNotation && !this.isObjectProperty()) {
- throw new Error('dotNotation only applicable for object properties');
- }
- }
- get type() {
- return name;
- }
- get isIndexNode() {
- 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) {
- // TODO: implement support for bignumber (currently bignumbers are silently
- // reduced to numbers when changing the value to zero-based)
- // TODO: Optimization: when the range values are ConstantNodes,
- // we can beforehand resolve the zero-based value
- // optimization for a simple object property
- var evalDimensions = map(this.dimensions, function (dimension, i) {
- var needsEnd = dimension.filter(node => node.isSymbolNode && node.name === 'end').length > 0;
- if (needsEnd) {
- // SymbolNode 'end' is used inside the index,
- // like in `A[end]` or `A[end - 2]`
- var childArgNames = Object.create(argNames);
- childArgNames.end = true;
- var _evalDimension = dimension._compile(math, childArgNames);
- return function evalDimension(scope, args, context) {
- if (!isMatrix(context) && !isArray(context) && !isString(context)) {
- throw new TypeError('Cannot resolve "end": ' + 'context must be a Matrix, Array, or string but is ' + typeOf(context));
- }
- var s = size(context).valueOf();
- var childArgs = Object.create(args);
- childArgs.end = s[i];
- return _evalDimension(scope, childArgs, context);
- };
- } else {
- // SymbolNode `end` not used
- return dimension._compile(math, argNames);
- }
- });
- var index = getSafeProperty(math, 'index');
- return function evalIndexNode(scope, args, context) {
- var dimensions = map(evalDimensions, function (evalDimension) {
- return evalDimension(scope, args, context);
- });
- return index(...dimensions);
- };
- }
- /**
- * Execute a callback for each of the child nodes of this node
- * @param {function(child: Node, path: string, parent: Node)} callback
- */
- forEach(callback) {
- for (var i = 0; i < this.dimensions.length; i++) {
- callback(this.dimensions[i], 'dimensions[' + i + ']', this);
- }
- }
- /**
- * Create a new IndexNode 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 {IndexNode} Returns a transformed copy of the node
- */
- map(callback) {
- var dimensions = [];
- for (var i = 0; i < this.dimensions.length; i++) {
- dimensions[i] = this._ifNode(callback(this.dimensions[i], 'dimensions[' + i + ']', this));
- }
- return new IndexNode(dimensions, this.dotNotation);
- }
- /**
- * Create a clone of this node, a shallow copy
- * @return {IndexNode}
- */
- clone() {
- return new IndexNode(this.dimensions.slice(0), this.dotNotation);
- }
- /**
- * Test whether this IndexNode contains a single property name
- * @return {boolean}
- */
- isObjectProperty() {
- return this.dimensions.length === 1 && isConstantNode(this.dimensions[0]) && typeof this.dimensions[0].value === 'string';
- }
- /**
- * Returns the property name if IndexNode contains a property.
- * If not, returns null.
- * @return {string | null}
- */
- getObjectProperty() {
- return this.isObjectProperty() ? this.dimensions[0].value : null;
- }
- /**
- * Get string representation
- * @param {Object} options
- * @return {string} str
- */
- _toString(options) {
- // format the parameters like "[1, 0:5]"
- return this.dotNotation ? '.' + this.getObjectProperty() : '[' + this.dimensions.join(', ') + ']';
- }
- /**
- * Get a JSON representation of the node
- * @returns {Object}
- */
- toJSON() {
- return {
- mathjs: name,
- dimensions: this.dimensions,
- dotNotation: this.dotNotation
- };
- }
- /**
- * Instantiate an IndexNode from its JSON representation
- * @param {Object} json
- * An object structured like
- * `{"mathjs": "IndexNode", dimensions: [...], dotNotation: false}`,
- * where mathjs is optional
- * @returns {IndexNode}
- */
- static fromJSON(json) {
- return new IndexNode(json.dimensions, json.dotNotation);
- }
- /**
- * Get HTML representation
- * @param {Object} options
- * @return {string} str
- */
- toHTML(options) {
- // format the parameters like "[1, 0:5]"
- var dimensions = [];
- for (var i = 0; i < this.dimensions.length; i++) {
- dimensions[i] = this.dimensions[i].toHTML();
- }
- if (this.dotNotation) {
- return '<span class="math-operator math-accessor-operator">.</span>' + '<span class="math-symbol math-property">' + escape(this.getObjectProperty()) + '</span>';
- } else {
- return '<span class="math-parenthesis math-square-parenthesis">[</span>' + dimensions.join('<span class="math-separator">,</span>') + '<span class="math-parenthesis math-square-parenthesis">]</span>';
- }
- }
- /**
- * Get LaTeX representation
- * @param {Object} options
- * @return {string} str
- */
- _toTex(options) {
- var dimensions = this.dimensions.map(function (range) {
- return range.toTex(options);
- });
- return this.dotNotation ? '.' + this.getObjectProperty() + '' : '_{' + dimensions.join(',') + '}';
- }
- }
- _defineProperty(IndexNode, "name", name);
- return IndexNode;
- }, {
- isClass: true,
- isNode: true
- });
|