mathjs-min 11.7.2

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

@@ -0,0 +1,193 @@
+import { escape } from '../../utils/string.js';
+import { getSafeProperty } from '../../utils/customs.js';
+import { factory } from '../../utils/factory.js';
+import { toSymbol } from '../../utils/latex.js';
+var name = 'SymbolNode';
+var dependencies = ['math', '?Unit', 'Node'];
+export var createSymbolNode = /* #__PURE__ */factory(name, dependencies, _ref => {
+  var {
+    math,
+    Unit,
+    Node
+  } = _ref;
+  /**
+   * Check whether some name is a valueless unit like "inch".
+   * @param {string} name
+   * @return {boolean}
+   */
+  function isValuelessUnit(name) {
+    return Unit ? Unit.isValuelessUnit(name) : false;
+  }
+  class SymbolNode extends Node {
+    /**
+     * @constructor SymbolNode
+     * @extends {Node}
+     * A symbol node can hold and resolve a symbol
+     * @param {string} name
+     * @extends {Node}
+     */
+    constructor(name) {
+      super();
+      // validate input
+      if (typeof name !== 'string') {
+        throw new TypeError('String expected for parameter "name"');
+      }
+      this.name = name;
+    }
+    get type() {
+      return 'SymbolNode';
+    }
+    get isSymbolNode() {
+      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 name = this.name;
+      if (argNames[name] === true) {
+        // this is a FunctionAssignment argument
+        // (like an x when inside the expression of a function
+        // assignment `f(x) = ...`)
+        return function (scope, args, context) {
+          return args[name];
+        };
+      } else if (name in math) {
+        return function (scope, args, context) {
+          return scope.has(name) ? scope.get(name) : getSafeProperty(math, name);
+        };
+      } else {
+        var isUnit = isValuelessUnit(name);
+        return function (scope, args, context) {
+          return scope.has(name) ? scope.get(name) : isUnit ? new Unit(null, name) : SymbolNode.onUndefinedSymbol(name);
+        };
+      }
+    }
+
+    /**
+     * 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 SymbolNode with children produced by the given callback.
+     * Trivial since a SymbolNode has no children
+     * @param {function(child: Node, path: string, parent: Node) : Node} callback
+     * @returns {SymbolNode} Returns a clone of the node
+     */
+    map(callback) {
+      return this.clone();
+    }
+
+    /**
+     * Throws an error 'Undefined symbol {name}'
+     * @param {string} name
+     */
+    static onUndefinedSymbol(name) {
+      throw new Error('Undefined symbol ' + name);
+    }
+
+    /**
+     * Create a clone of this node, a shallow copy
+     * @return {SymbolNode}
+     */
+    clone() {
+      return new SymbolNode(this.name);
+    }
+
+    /**
+     * Get string representation
+     * @param {Object} options
+     * @return {string} str
+     * @override
+     */
+    _toString(options) {
+      return this.name;
+    }
+
+    /**
+     * Get HTML representation
+     * @param {Object} options
+     * @return {string} str
+     * @override
+     */
+    toHTML(options) {
+      var name = escape(this.name);
+      if (name === 'true' || name === 'false') {
+        return '<span class="math-symbol math-boolean">' + name + '</span>';
+      } else if (name === 'i') {
+        return '<span class="math-symbol math-imaginary-symbol">' + name + '</span>';
+      } else if (name === 'Infinity') {
+        return '<span class="math-symbol math-infinity-symbol">' + name + '</span>';
+      } else if (name === 'NaN') {
+        return '<span class="math-symbol math-nan-symbol">' + name + '</span>';
+      } else if (name === 'null') {
+        return '<span class="math-symbol math-null-symbol">' + name + '</span>';
+      } else if (name === 'undefined') {
+        return '<span class="math-symbol math-undefined-symbol">' + name + '</span>';
+      }
+      return '<span class="math-symbol">' + name + '</span>';
+    }
+
+    /**
+     * Get a JSON representation of the node
+     * @returns {Object}
+     */
+    toJSON() {
+      return {
+        mathjs: 'SymbolNode',
+        name: this.name
+      };
+    }
+
+    /**
+     * Instantiate a SymbolNode from its JSON representation
+     * @param {Object} json  An object structured like
+     *                       `{"mathjs": "SymbolNode", name: "x"}`,
+     *                       where mathjs is optional
+     * @returns {SymbolNode}
+     */
+    static fromJSON(json) {
+      return new SymbolNode(json.name);
+    }
+
+    /**
+     * Get LaTeX representation
+     * @param {Object} options
+     * @return {string} str
+     * @override
+     */
+    _toTex(options) {
+      var isUnit = false;
+      if (typeof math[this.name] === 'undefined' && isValuelessUnit(this.name)) {
+        isUnit = true;
+      }
+      var symbol = toSymbol(this.name, isUnit);
+      if (symbol[0] === '\\') {
+        // no space needed if the symbol starts with '\'
+        return symbol;
+      }
+      // the space prevents symbols from breaking stuff like '\cdot'
+      // if it's written right before the symbol
+      return ' ' + symbol;
+    }
+  }
+  return SymbolNode;
+}, {
+  isClass: true,
+  isNode: true
+});

package/lib/esm/expression/node/utils/access.js

@@ -0,0 +1,40 @@
+import { errorTransform } from '../../transform/utils/errorTransform.js';
+import { getSafeProperty } from '../../../utils/customs.js';
+export function accessFactory(_ref) {
+  var {
+    subset
+  } = _ref;
+  /**
+   * Retrieve part of an object:
+   *
+   * - Retrieve a property from an object
+   * - Retrieve a part of a string
+   * - Retrieve a matrix subset
+   *
+   * @param {Object | Array | Matrix | string} object
+   * @param {Index} index
+   * @return {Object | Array | Matrix | string} Returns the subset
+   */
+  return function access(object, index) {
+    try {
+      if (Array.isArray(object)) {
+        return subset(object, index);
+      } else if (object && typeof object.subset === 'function') {
+        // Matrix
+        return object.subset(index);
+      } else if (typeof object === 'string') {
+        // TODO: move getStringSubset into a separate util file, use that
+        return subset(object, index);
+      } else if (typeof object === 'object') {
+        if (!index.isObjectProperty()) {
+          throw new TypeError('Cannot apply a numeric index as object property');
+        }
+        return getSafeProperty(object, index.getObjectProperty());
+      } else {
+        throw new TypeError('Cannot apply index: unsupported type of object');
+      }
+    } catch (err) {
+      throw errorTransform(err);
+    }
+  };
+}

package/lib/esm/expression/node/utils/assign.js

@@ -0,0 +1,46 @@
+import { errorTransform } from '../../transform/utils/errorTransform.js';
+import { setSafeProperty } from '../../../utils/customs.js';
+export function assignFactory(_ref) {
+  var {
+    subset,
+    matrix
+  } = _ref;
+  /**
+   * Replace part of an object:
+   *
+   * - Assign a property to an object
+   * - Replace a part of a string
+   * - Replace a matrix subset
+   *
+   * @param {Object | Array | Matrix | string} object
+   * @param {Index} index
+   * @param {*} value
+   * @return {Object | Array | Matrix | string} Returns the original object
+   *                                            except in case of a string
+   */
+  // TODO: change assign to return the value instead of the object
+  return function assign(object, index, value) {
+    try {
+      if (Array.isArray(object)) {
+        // we use matrix.subset here instead of the function subset because we must not clone the contents
+        return matrix(object).subset(index, value).valueOf();
+      } else if (object && typeof object.subset === 'function') {
+        // Matrix
+        return object.subset(index, value);
+      } else if (typeof object === 'string') {
+        // TODO: move setStringSubset into a separate util file, use that
+        return subset(object, index, value);
+      } else if (typeof object === 'object') {
+        if (!index.isObjectProperty()) {
+          throw TypeError('Cannot apply a numeric index as object property');
+        }
+        setSafeProperty(object, index.getObjectProperty(), value);
+        return object;
+      } else {
+        throw new TypeError('Cannot apply index: unsupported type of object');
+      }
+    } catch (err) {
+      throw errorTransform(err);
+    }
+  };
+}

package/lib/esm/expression/operators.js

@@ -0,0 +1,381 @@
+// list of identifiers of nodes in order of their precedence
+// also contains information about left/right associativity
+// and which other operator the operator is associative with
+// Example:
+// addition is associative with addition and subtraction, because:
+// (a+b)+c=a+(b+c)
+// (a+b)-c=a+(b-c)
+//
+// postfix operators are left associative, prefix operators
+// are right associative
+//
+// It's also possible to set the following properties:
+// latexParens: if set to false, this node doesn't need to be enclosed
+//              in parentheses when using LaTeX
+// latexLeftParens: if set to false, this !OperatorNode's!
+//                  left argument doesn't need to be enclosed
+//                  in parentheses
+// latexRightParens: the same for the right argument
+import { hasOwnProperty } from '../utils/object.js';
+import { isConstantNode, isParenthesisNode, rule2Node } from '../utils/is.js';
+export var properties = [{
+  // assignment
+  AssignmentNode: {},
+  FunctionAssignmentNode: {}
+}, {
+  // conditional expression
+  ConditionalNode: {
+    latexLeftParens: false,
+    latexRightParens: false,
+    latexParens: false
+    // conditionals don't need parentheses in LaTeX because
+    // they are 2 dimensional
+  }
+}, {
+  // logical or
+  'OperatorNode:or': {
+    op: 'or',
+    associativity: 'left',
+    associativeWith: []
+  }
+}, {
+  // logical xor
+  'OperatorNode:xor': {
+    op: 'xor',
+    associativity: 'left',
+    associativeWith: []
+  }
+}, {
+  // logical and
+  'OperatorNode:and': {
+    op: 'and',
+    associativity: 'left',
+    associativeWith: []
+  }
+}, {
+  // bitwise or
+  'OperatorNode:bitOr': {
+    op: '|',
+    associativity: 'left',
+    associativeWith: []
+  }
+}, {
+  // bitwise xor
+  'OperatorNode:bitXor': {
+    op: '^|',
+    associativity: 'left',
+    associativeWith: []
+  }
+}, {
+  // bitwise and
+  'OperatorNode:bitAnd': {
+    op: '&',
+    associativity: 'left',
+    associativeWith: []
+  }
+}, {
+  // relational operators
+  'OperatorNode:equal': {
+    op: '==',
+    associativity: 'left',
+    associativeWith: []
+  },
+  'OperatorNode:unequal': {
+    op: '!=',
+    associativity: 'left',
+    associativeWith: []
+  },
+  'OperatorNode:smaller': {
+    op: '<',
+    associativity: 'left',
+    associativeWith: []
+  },
+  'OperatorNode:larger': {
+    op: '>',
+    associativity: 'left',
+    associativeWith: []
+  },
+  'OperatorNode:smallerEq': {
+    op: '<=',
+    associativity: 'left',
+    associativeWith: []
+  },
+  'OperatorNode:largerEq': {
+    op: '>=',
+    associativity: 'left',
+    associativeWith: []
+  },
+  RelationalNode: {
+    associativity: 'left',
+    associativeWith: []
+  }
+}, {
+  // bitshift operators
+  'OperatorNode:leftShift': {
+    op: '<<',
+    associativity: 'left',
+    associativeWith: []
+  },
+  'OperatorNode:rightArithShift': {
+    op: '>>',
+    associativity: 'left',
+    associativeWith: []
+  },
+  'OperatorNode:rightLogShift': {
+    op: '>>>',
+    associativity: 'left',
+    associativeWith: []
+  }
+}, {
+  // unit conversion
+  'OperatorNode:to': {
+    op: 'to',
+    associativity: 'left',
+    associativeWith: []
+  }
+}, {
+  // range
+  RangeNode: {}
+}, {
+  // addition, subtraction
+  'OperatorNode:add': {
+    op: '+',
+    associativity: 'left',
+    associativeWith: ['OperatorNode:add', 'OperatorNode:subtract']
+  },
+  'OperatorNode:subtract': {
+    op: '-',
+    associativity: 'left',
+    associativeWith: []
+  }
+}, {
+  // multiply, divide, modulus
+  'OperatorNode:multiply': {
+    op: '*',
+    associativity: 'left',
+    associativeWith: ['OperatorNode:multiply', 'OperatorNode:divide', 'Operator:dotMultiply', 'Operator:dotDivide']
+  },
+  'OperatorNode:divide': {
+    op: '/',
+    associativity: 'left',
+    associativeWith: [],
+    latexLeftParens: false,
+    latexRightParens: false,
+    latexParens: false
+    // fractions don't require parentheses because
+    // they're 2 dimensional, so parens aren't needed
+    // in LaTeX
+  },
+
+  'OperatorNode:dotMultiply': {
+    op: '.*',
+    associativity: 'left',
+    associativeWith: ['OperatorNode:multiply', 'OperatorNode:divide', 'OperatorNode:dotMultiply', 'OperatorNode:doDivide']
+  },
+  'OperatorNode:dotDivide': {
+    op: './',
+    associativity: 'left',
+    associativeWith: []
+  },
+  'OperatorNode:mod': {
+    op: 'mod',
+    associativity: 'left',
+    associativeWith: []
+  }
+}, {
+  // Repeat multiplication for implicit multiplication
+  'OperatorNode:multiply': {
+    associativity: 'left',
+    associativeWith: ['OperatorNode:multiply', 'OperatorNode:divide', 'Operator:dotMultiply', 'Operator:dotDivide']
+  }
+}, {
+  // unary prefix operators
+  'OperatorNode:unaryPlus': {
+    op: '+',
+    associativity: 'right'
+  },
+  'OperatorNode:unaryMinus': {
+    op: '-',
+    associativity: 'right'
+  },
+  'OperatorNode:bitNot': {
+    op: '~',
+    associativity: 'right'
+  },
+  'OperatorNode:not': {
+    op: 'not',
+    associativity: 'right'
+  }
+}, {
+  // exponentiation
+  'OperatorNode:pow': {
+    op: '^',
+    associativity: 'right',
+    associativeWith: [],
+    latexRightParens: false
+    // the exponent doesn't need parentheses in
+    // LaTeX because it's 2 dimensional
+    // (it's on top)
+  },
+
+  'OperatorNode:dotPow': {
+    op: '.^',
+    associativity: 'right',
+    associativeWith: []
+  }
+}, {
+  // factorial
+  'OperatorNode:factorial': {
+    op: '!',
+    associativity: 'left'
+  }
+}, {
+  // matrix transpose
+  'OperatorNode:ctranspose': {
+    op: "'",
+    associativity: 'left'
+  }
+}];
+
+/**
+ * Returns the first non-parenthesis internal node, but only
+ * when the 'parenthesis' option is unset or auto.
+ * @param {Node} _node
+ * @param {string} parenthesis
+ * @return {Node}
+ */
+function unwrapParen(_node, parenthesis) {
+  if (!parenthesis || parenthesis !== 'auto') return _node;
+  var node = _node;
+  while (isParenthesisNode(node)) {
+    node = node.content;
+  }
+  return node;
+}
+
+/**
+ * Get the precedence of a Node.
+ * Higher number for higher precedence, starting with 0.
+ * Returns null if the precedence is undefined.
+ *
+ * @param {Node} _node
+ * @param {string} parenthesis
+ * @param {string} implicit
+ * @param {Node} parent (for determining context for implicit multiplication)
+ * @return {number | null}
+ */
+export function getPrecedence(_node, parenthesis, implicit, parent) {
+  var node = _node;
+  if (parenthesis !== 'keep') {
+    // ParenthesisNodes are only ignored when not in 'keep' mode
+    node = _node.getContent();
+  }
+  var identifier = node.getIdentifier();
+  var precedence = null;
+  for (var i = 0; i < properties.length; i++) {
+    if (identifier in properties[i]) {
+      precedence = i;
+      break;
+    }
+  }
+  // Bump up precedence of implicit multiplication, except when preceded
+  // by a "Rule 2" fraction ( [unaryOp]constant / constant )
+  if (identifier === 'OperatorNode:multiply' && node.implicit && implicit !== 'show') {
+    var leftArg = unwrapParen(node.args[0], parenthesis);
+    if (!(isConstantNode(leftArg) && parent && parent.getIdentifier() === 'OperatorNode:divide' && rule2Node(unwrapParen(parent.args[0], parenthesis))) && !(leftArg.getIdentifier() === 'OperatorNode:divide' && rule2Node(unwrapParen(leftArg.args[0], parenthesis)) && isConstantNode(unwrapParen(leftArg.args[1])))) {
+      precedence += 1;
+    }
+  }
+  return precedence;
+}
+
+/**
+ * Get the associativity of an operator (left or right).
+ * Returns a string containing 'left' or 'right' or null if
+ * the associativity is not defined.
+ *
+ * @param {Node} _node
+ * @param {string} parenthesis
+ * @return {string|null}
+ * @throws {Error}
+ */
+export function getAssociativity(_node, parenthesis) {
+  var node = _node;
+  if (parenthesis !== 'keep') {
+    // ParenthesisNodes are only ignored when not in 'keep' mode
+    node = _node.getContent();
+  }
+  var identifier = node.getIdentifier();
+  var index = getPrecedence(node, parenthesis);
+  if (index === null) {
+    // node isn't in the list
+    return null;
+  }
+  var property = properties[index][identifier];
+  if (hasOwnProperty(property, 'associativity')) {
+    if (property.associativity === 'left') {
+      return 'left';
+    }
+    if (property.associativity === 'right') {
+      return 'right';
+    }
+    // associativity is invalid
+    throw Error('\'' + identifier + '\' has the invalid associativity \'' + property.associativity + '\'.');
+  }
+
+  // associativity is undefined
+  return null;
+}
+
+/**
+ * Check if an operator is associative with another operator.
+ * Returns either true or false or null if not defined.
+ *
+ * @param {Node} nodeA
+ * @param {Node} nodeB
+ * @param {string} parenthesis
+ * @return {boolean | null}
+ */
+export function isAssociativeWith(nodeA, nodeB, parenthesis) {
+  // ParenthesisNodes are only ignored when not in 'keep' mode
+  var a = parenthesis !== 'keep' ? nodeA.getContent() : nodeA;
+  var b = parenthesis !== 'keep' ? nodeA.getContent() : nodeB;
+  var identifierA = a.getIdentifier();
+  var identifierB = b.getIdentifier();
+  var index = getPrecedence(a, parenthesis);
+  if (index === null) {
+    // node isn't in the list
+    return null;
+  }
+  var property = properties[index][identifierA];
+  if (hasOwnProperty(property, 'associativeWith') && property.associativeWith instanceof Array) {
+    for (var i = 0; i < property.associativeWith.length; i++) {
+      if (property.associativeWith[i] === identifierB) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  // associativeWith is not defined
+  return null;
+}
+
+/**
+ * Get the operator associated with a function name.
+ * Returns a string with the operator symbol, or null if the
+ * input is not the name of a function associated with an
+ * operator.
+ *
+ * @param {string} Function name
+ * @return {string | null} Associated operator symbol, if any
+ */
+export function getOperator(fn) {
+  var identifier = 'OperatorNode:' + fn;
+  for (var group of properties) {
+    if (identifier in group) {
+      return group[identifier].op;
+    }
+  }
+  return null;
+}