refactor(resolve): Split implementation into distinct Node types

  This refactor allows custom resolve methods for different node types
  or for newly added node types, as an alternative to josdejong#2775.
  Adds a test that demonstrates the creationg of a (stub) IntervalNode,
  as if you were doing interval arithmetic, say, with a custom resolve
  method for the new type.

Author: gwhitney

src/core/function/typed.js

@@ -152,15 +152,16 @@ export const createTyped = /* #__PURE__ */ factory('typed', dependencies, functi
     { name: 'FunctionNode', test: isFunctionNode },
     { name: 'FunctionAssignmentNode', test: isFunctionAssignmentNode },
     { name: 'IndexNode', test: isIndexNode },
-    { name: 'Node', test: isNode },
     { name: 'ObjectNode', test: isObjectNode },
     { name: 'OperatorNode', test: isOperatorNode },
     { name: 'ParenthesisNode', test: isParenthesisNode },
     { name: 'RangeNode', test: isRangeNode },
     { name: 'RelationalNode', test: isRelationalNode },
     { name: 'SymbolNode', test: isSymbolNode },
+    { name: 'Node', test: isNode },
 
     { name: 'Map', test: isMap },
+    { name: 'Set', test: entity => entity instanceof Set },
     { name: 'Object', test: isObject } // order 'Object' last, it matches on other classes too
   ])
 

src/function/algebra/resolve.js

@@ -1,5 +1,5 @@
 import { createMap } from '../../utils/map.js'
-import { isFunctionNode, isNode, isOperatorNode, isParenthesisNode, isSymbolNode } from '../../utils/is.js'
+import { isNode } from '../../utils/is.js'
 import { factory } from '../../utils/factory.js'
 
 const name = 'resolve'
@@ -46,65 +46,94 @@ export const createResolve = /* #__PURE__ */ factory(name, dependencies, ({
    *     If there is a cyclic dependency among the variables in `scope`,
    *     resolution is impossible and a ReferenceError is thrown.
    */
-  function _resolve (node, scope, within = new Set()) { // note `within`:
-    // `within` is not documented, since it is for internal cycle
-    // detection only
-    if (!scope) {
-      return node
-    }
-    if (isSymbolNode(node)) {
-      if (within.has(node.name)) {
-        const variables = Array.from(within).join(', ')
-        throw new ReferenceError(
-          `recursive loop of variable definitions among {${variables}}`
-        )
+
+  // First we set up core implementations for different node types
+  // Note the 'within' argument that they all take is not documented, as it is
+  // used only for internal cycle detection
+  const resolvers = {
+    SymbolNode: typed.referToSelf(self =>
+      (symbol, scope, within = new Set()) => {
+        // The key case for resolve; most other nodes we just recurse.
+        if (!scope) return symbol
+        if (within.has(symbol.name)) {
+          const variables = Array.from(within).join(', ')
+          throw new ReferenceError(
+            `recursive loop of variable definitions among {${variables}}`
+          )
+        }
+        const value = scope.get(symbol.name)
+        if (isNode(value)) {
+          const nextWithin = new Set(within)
+          nextWithin.add(symbol.name)
+          return self(value, scope, nextWithin)
+        }
+        if (typeof value === 'number') {
+          return parse(String(value)) // ?? is this just to get the currently
+          // defined behavior for number literals, i.e. maybe numbers are
+          // currently being coerced to BigNumber?
+        }
+        if (value !== undefined) {
+          return new ConstantNode(value)
+        }
+        return symbol
+      }
+    ),
+    OperatorNode: typed.referToSelf(self =>
+      (operator, scope, within = new Set()) => {
+        const args = operator.args.map(arg => self(arg, scope, within))
+        // Has its own implementation because we don't recurse on the op also
+        return new OperatorNode(
+          operator.op, operator.fn, args, operator.implicit)
       }
-      const value = scope.get(node.name)
-      if (isNode(value)) {
-        const nextWithin = new Set(within)
-        nextWithin.add(node.name)
-        return _resolve(value, scope, nextWithin)
-      } else if (typeof value === 'number') {
-        return parse(String(value))
-      } else if (value !== undefined) {
-        return new ConstantNode(value)
-      } else {
-        return node
+    ),
+    FunctionNode: typed.referToSelf(self =>
+      (func, scope, within = new Set()) => {
+        const args = func.args.map(arg => self(arg, scope, within))
+        // The only reason this has a separate implementation of its own
+        // is that we don't resolve the func.name itself. But is that
+        // really right? If the tree being resolved was the parse of
+        // 'f(x,y)' and 'f' is defined in the scope, is it clear that we
+        // don't want to replace the function symbol, too? Anyhow, leaving
+        // the implementation as it was before the refactoring.
+        return new FunctionNode(func.name, args)
       }
-    } else if (isOperatorNode(node)) {
-      const args = node.args.map(function (arg) {
-        return _resolve(arg, scope, within)
-      })
-      return new OperatorNode(node.op, node.fn, args, node.implicit)
-    } else if (isParenthesisNode(node)) {
-      return new ParenthesisNode(_resolve(node.content, scope, within))
-    } else if (isFunctionNode(node)) {
-      const args = node.args.map(function (arg) {
-        return _resolve(arg, scope, within)
-      })
-      return new FunctionNode(node.name, args)
-    }
+    ),
+    Node: typed.referToSelf(self =>
+      (node, scope, within = new Set()) => {
+        // The generic case: just recurse
+        return node.map(child => self(child, scope, within))
+      }
+    )
+  }
 
-    // Otherwise just recursively resolve any children (might also work
-    // for some of the above special cases)
-    return node.map(child => _resolve(child, scope, within))
+  // Now expand with all the possible argument types:
+  const nodeTypes = Object.keys(resolvers)
+  const scopeType = ', Map | null | undefined'
+  const objType = ', Object'
+  const withinType = ', Set'
+  for (const nodeType of nodeTypes) {
+    resolvers[nodeType + scopeType] = resolvers[nodeType]
+    resolvers[nodeType + scopeType + withinType] = resolvers[nodeType]
+    resolvers[nodeType + objType] = typed.referToSelf(self =>
+      (node, objScope) => self(node, createMap(objScope))
+    )
+    // Don't need to do nodeType + objType + withinType since we only get
+    // an obj instead of a Map scope in the outermost call, which has no
+    // "within" argument.
   }
 
-  return typed('resolve', {
-    Node: _resolve,
-    'Node, Map | null | undefined': _resolve,
-    'Node, Object': (n, scope) => _resolve(n, createMap(scope)),
-    // For arrays and matrices, we map `self` rather than `_resolve`
-    // because resolve is fairly expensive anyway, and this way
-    // we get nice error messages if one entry in the array has wrong type.
+  // Now add the array and matrix types:
+  Object.assign(resolvers, {
     'Array | Matrix': typed.referToSelf(self => A => A.map(n => self(n))),
     'Array | Matrix, null | undefined': typed.referToSelf(
       self => A => A.map(n => self(n))),
+    'Array | Matrix, Map': typed.referToSelf(
+      self => (A, scope) => A.map(n => self(n, scope))),
     'Array, Object': typed.referTo(
       'Array,Map', selfAM => (A, scope) => selfAM(A, createMap(scope))),
     'Matrix, Object': typed.referTo(
-      'Matrix,Map', selfMM => (A, scope) => selfMM(A, createMap(scope))),
-    'Array | Matrix, Map': typed.referToSelf(
-      self => (A, scope) => A.map(n => self(n, scope)))
+      'Matrix,Map', selfMM => (A, scope) => selfMM(A, createMap(scope)))
   })
+
+  return typed('resolve', resolvers)
 })

test/unit-tests/function/algebra/resolve.test.js

@@ -102,4 +102,55 @@ describe('resolve', function () {
       }),
       /ReferenceError.*\{x, y, z\}/)
   })
+
+  it('should allow resolving custom nodes in custom ways', function () {
+    const mymath = math.create()
+    const Node = mymath.Node
+    class IntervalNode extends Node {
+      // a node that represents any value in a closed interval
+      constructor (left, right) {
+        super()
+        this.left = left
+        this.right = right
+      }
+
+      static name = 'IntervalNode'
+      get type () { return 'IntervalNode' }
+      get isIntervalNode () { return true }
+      clone () {
+        return new IntervalNode(this.left, this.right)
+      }
+
+      _toString (options) {
+        return `[|${this.left}, ${this.right}|]`
+      }
+
+      midpoint () {
+        return (this.left + this.right) / 2
+      }
+    }
+
+    mymath.typed.addTypes(
+      [{
+        name: 'IntervalNode',
+        test: entity => entity && entity.isIntervalNode
+      }],
+      'RangeNode') // Insert just before RangeNode in type order
+
+    // IntervalNodes resolve to their midpoint:
+    const intervalResolver = node => new mymath.ConstantNode(node.midpoint())
+    const resolveInterval = mymath.typed({
+      IntervalNode: intervalResolver,
+      'IntervalNode, Object|Map|null|undefined': intervalResolver,
+      'IntervalNode, Map|null|undefined, Set': intervalResolver
+    })
+    // Merge with standard resolve:
+    mymath.import({ resolve: resolveInterval })
+
+    // And finally test:
+    const innerNode = new IntervalNode(1, 3)
+    const outerNode = new mymath.OperatorNode(
+      '+', 'add', [innerNode, new mymath.ConstantNode(4)])
+    assert.strictEqual(mymath.resolve(outerNode).toString(), '2 + 4')
+  })
 })