Merge pull request #2621 from enwask/lazy-visitors

compiler: Lazy IET visitors + Search

Author: mloubout

devito/ir/iet/visitors.py

@@ -5,8 +5,9 @@
 """
 
 from collections import OrderedDict
-from collections.abc import Iterable
+from collections.abc import Callable, Generator, Iterable, Iterator, Sequence
 from itertools import chain, groupby
+from typing import Any, Generic, TypeVar
 import ctypes
 
 import cgen as c
@@ -58,6 +59,55 @@ def always_rebuild(self, o, *args, **kwargs):
         return o._rebuild(*new_ops, **okwargs)
 
 
+# Type variables for LazyVisitor
+YieldType = TypeVar('YieldType', covariant=True)
+FlagType = TypeVar('FlagType', covariant=True)
+ResultType = TypeVar('ResultType', covariant=True)
+
+# Describes the return type of a LazyVisitor visit method which yields objects of
+# type YieldType and returns a FlagType (or NoneType)
+LazyVisit = Generator[YieldType, None, FlagType]
+
+
+class LazyVisitor(GenericVisitor, Generic[YieldType, ResultType, FlagType]):
+
+    """
+    A generic visitor that lazily yields results instead of flattening results
+    from children at every step. Intermediate visit methods may return a flag
+    of type FlagType in addition to yielding results; by default, the last flag
+    returned by a child is the one propagated.
+
+    Subclass-defined visit methods should be generators.
+    """
+
+    def lookup_method(self, instance) \
+            -> Callable[..., LazyVisit[YieldType, FlagType]]:
+        return super().lookup_method(instance)
+
+    def _visit(self, o, *args, **kwargs) -> LazyVisit[YieldType, FlagType]:
+        meth = self.lookup_method(o)
+        flag = yield from meth(o, *args, **kwargs)
+        return flag
+
+    def _post_visit(self, ret: LazyVisit[YieldType, FlagType]) -> ResultType:
+        return list(ret)
+
+    def visit_object(self, o: object, **kwargs) -> LazyVisit[YieldType, FlagType]:
+        yield from ()
+
+    def visit_Node(self, o: Node, **kwargs) -> LazyVisit[YieldType, FlagType]:
+        flag = yield from self._visit(o.children, **kwargs)
+        return flag
+
+    def visit_tuple(self, o: Sequence[Any], **kwargs) -> LazyVisit[YieldType, FlagType]:
+        flag: FlagType = None
+        for i in o:
+            flag = yield from self._visit(i, **kwargs)
+        return flag
+
+    visit_list = visit_tuple
+
+
 class PrintAST(Visitor):
 
     _depth = 0
@@ -992,16 +1042,7 @@ def visit_Node(self, o, ret=None, parents=None, in_parent=False):
         return ret
 
 
-class FindSymbols(Visitor):
-
-    class Retval(list):
-        def __init__(self, *retvals):
-            elements = filter_ordered(flatten(retvals), key=id)
-            super().__init__(elements)
-
-    @classmethod
-    def default_retval(cls):
-        return cls.Retval()
+class FindSymbols(LazyVisitor[Any, list[Any], None]):
 
     """
     Find symbols in an Iteration/Expression tree.
@@ -1020,32 +1061,32 @@ def default_retval(cls):
         - `defines-aliases`: Collect all defined objects and their aliases
     """
 
+    @staticmethod
     def _defines_aliases(n):
-        retval = []
         for i in n.defines:
             f = i.function
             if f.is_ArrayBasic:
-                retval.extend([f, f.indexed])
+                yield from (f, f.indexed)
             else:
-                retval.append(i)
-        return tuple(retval)
+                yield i
 
-    rules = {
+    RulesDict = dict[str, Callable[[Node], Iterator[Any]]]
+    rules: RulesDict = {
         'symbolics': lambda n: n.functions,
-        'basics': lambda n: [i for i in n.expr_symbols if isinstance(i, Basic)],
-        'symbols': lambda n: [i for i in n.expr_symbols
-                              if isinstance(i, AbstractSymbol)],
-        'dimensions': lambda n: [i for i in n.expr_symbols if isinstance(i, Dimension)],
-        'indexeds': lambda n: [i for i in n.expr_symbols if i.is_Indexed],
-        'indexedbases': lambda n: [i for i in n.expr_symbols
-                                   if isinstance(i, IndexedBase)],
+        'basics': lambda n: (i for i in n.expr_symbols if isinstance(i, Basic)),
+        'symbols': lambda n: (i for i in n.expr_symbols
+                              if isinstance(i, AbstractSymbol)),
+        'dimensions': lambda n: (i for i in n.expr_symbols if isinstance(i, Dimension)),
+        'indexeds': lambda n: (i for i in n.expr_symbols if i.is_Indexed),
+        'indexedbases': lambda n: (i for i in n.expr_symbols
+                                   if isinstance(i, IndexedBase)),
         'writes': lambda n: as_tuple(n.writes),
         'defines': lambda n: as_tuple(n.defines),
-        'globals': lambda n: [f.base for f in n.functions if f._mem_global],
+        'globals': lambda n: (f.base for f in n.functions if f._mem_global),
         'defines-aliases': _defines_aliases
     }
 
-    def __init__(self, mode='symbolics'):
+    def __init__(self, mode: str = 'symbolics') -> None:
         super().__init__()
 
         modes = mode.split('|')
@@ -1055,33 +1096,27 @@ def __init__(self, mode='symbolics'):
             self.rule = lambda n: chain(*[self.rules[mode](n) for mode in modes])
 
     def _post_visit(self, ret):
-        return sorted(ret, key=lambda i: str(i))
+        return sorted(filter_ordered(ret, key=id), key=str)
 
-    def visit_tuple(self, o):
-        return self.Retval(*[self._visit(i) for i in o])
-
-    visit_list = visit_tuple
+    def visit_Node(self, o: Node) -> Iterator[Any]:
+        yield from self._visit(o.children)
+        yield from self.rule(o)
 
-    def visit_Node(self, o):
-        return self.Retval(self._visit(o.children), self.rule(o))
-
-    def visit_ThreadedProdder(self, o):
+    def visit_ThreadedProdder(self, o) -> Iterator[Any]:
         # TODO: this handle required because ThreadedProdder suffers from the
         # long-standing issue affecting all Node subclasses which rely on
         # multiple inheritance
-        return self.Retval(self._visit(o.then_body), self.rule(o))
-
-    def visit_Operator(self, o):
-        ret = self._visit(o.body)
-        ret.extend(flatten(self._visit(v) for v in o._func_table.values()))
-        return self.Retval(ret, self.rule(o))
+        yield from self._visit(o.then_body)
+        yield from self.rule(o)
 
+    def visit_Operator(self, o) -> Iterator[Any]:
+        yield from self._visit(o.body)
+        yield from self.rule(o)
+        for i in o._func_table.values():
+            yield from self._visit(i)
 
-class FindNodes(Visitor):
 
-    @classmethod
-    def default_retval(cls):
-        return []
+class FindNodes(LazyVisitor[Node, list[Node], None]):
 
     """
     Find all instances of given type.
@@ -1097,126 +1132,103 @@ def default_retval(cls):
                      appears.
     """
 
-    rules = {
+    RulesDict = dict[str, Callable[[type, Node], bool]]
+    rules: RulesDict = {
         'type': lambda match, o: isinstance(o, match),
         'scope': lambda match, o: match in flatten(o.children)
     }
 
-    def __init__(self, match, mode='type'):
+    def __init__(self, match: type, mode: str = 'type') -> None:
         super().__init__()
         self.match = match
         self.rule = self.rules[mode]
 
-    def visit_object(self, o, ret=None):
-        return ret
-
-    def visit_tuple(self, o, ret=None):
-        for i in o:
-            ret = self._visit(i, ret=ret)
-        return ret
-
-    visit_list = visit_tuple
-
-    def visit_Node(self, o, ret=None):
-        if ret is None:
-            ret = self.default_retval()
+    def visit_Node(self, o: Node, **kwargs) -> Iterator[Node]:
         if self.rule(self.match, o):
-            ret.append(o)
+            yield o
         for i in o.children:
-            ret = self._visit(i, ret=ret)
-        return ret
+            yield from self._visit(i, **kwargs)
 
 
-class FindWithin(FindNodes):
-
-    @classmethod
-    def default_retval(cls):
-        return [], False
+class FindWithin(FindNodes, LazyVisitor[Node, list[Node], bool]):
 
     """
     Like FindNodes, but given an additional parameter `within=(start, stop)`,
     it starts collecting matching nodes only after `start` is found, and stops
     collecting matching nodes after `stop` is found.
     """
 
-    def __init__(self, match, start, stop=None):
+    def __init__(self, match: type, start: Node, stop: Node | None = None) -> None:
         super().__init__(match)
         self.start = start
         self.stop = stop
 
-    def visit(self, o, ret=None):
-        found, _ = self._visit(o, ret=ret)
-        return found
+    def visit_object(self, o: object, flag: bool = False) -> LazyVisit[Node, bool]:
+        yield from ()
+        return flag
 
-    def visit_Node(self, o, ret=None):
-        if ret is None:
-            ret = self.default_retval()
-        found, flag = ret
+    def visit_tuple(self, o: Sequence[Any], flag: bool = False) -> LazyVisit[Node, bool]:
+        for el in o:
+            # Yield results from visiting this element, and update the flag
+            flag = yield from self._visit(el, flag=flag)
 
-        if o is self.start:
-            flag = True
+        return flag
+
+    visit_list = visit_tuple
+
+    def visit_Node(self, o: Node, flag: bool = False) -> LazyVisit[Node, bool]:
+        flag = flag or (o is self.start)
 
         if flag and self.rule(self.match, o):
-            found.append(o)
-        for i in o.children:
-            found, newflag = self._visit(i, ret=(found, flag))
-            if flag and not newflag:
-                return found, newflag
-            flag = newflag
+            yield o
 
-        if o is self.stop:
-            flag = False
+        for child in o.children:
+            # Yield results from this child and retrieve its flag
+            nflag = yield from self._visit(child, flag=flag)
 
-        return found, flag
+            # If we started collecting outside of here and the child found a stop,
+            # don't visit the rest of the children
+            if flag and not nflag:
+                return False
+            flag = nflag
 
+        # Update the flag if we found a stop
+        flag &= (o is not self.stop)
 
-class FindApplications(Visitor):
+        return flag
+
+
+ApplicationType = TypeVar('ApplicationType')
+
+
+class FindApplications(LazyVisitor[ApplicationType, set[ApplicationType], None]):
 
     """
     Find all SymPy applied functions (aka, `Application`s). The user may refine
     the search by supplying a different target class.
     """
 
-    def __init__(self, cls=Application):
+    def __init__(self, cls: type[ApplicationType] = Application):
         super().__init__()
         self.match = lambda i: isinstance(i, cls) and not isinstance(i, Basic)
 
-    @classmethod
-    def default_retval(cls):
-        return set()
-
-    def visit_object(self, o, **kwargs):
-        return self.default_retval()
-
-    def visit_tuple(self, o, ret=None):
-        ret = ret or self.default_retval()
-        for i in o:
-            ret.update(self._visit(i, ret=ret))
-        return ret
-
-    def visit_Node(self, o, ret=None):
-        ret = ret or self.default_retval()
-        for i in o.children:
-            ret.update(self._visit(i, ret=ret))
-        return ret
+    def _post_visit(self, ret):
+        return set(ret)
 
-    def visit_Expression(self, o, **kwargs):
-        return o.expr.find(self.match)
+    def visit_Expression(self, o: Expression, **kwargs) -> Iterator[ApplicationType]:
+        yield from o.expr.find(self.match)
 
-    def visit_Iteration(self, o, **kwargs):
-        ret = self._visit(o.children) or self.default_retval()
-        ret.update(o.symbolic_min.find(self.match))
-        ret.update(o.symbolic_max.find(self.match))
-        return ret
+    def visit_Iteration(self, o: Iteration, **kwargs) -> Iterator[ApplicationType]:
+        yield from self._visit(o.children)
+        yield from o.symbolic_min.find(self.match)
+        yield from o.symbolic_max.find(self.match)
 
-    def visit_Call(self, o, **kwargs):
-        ret = self.default_retval()
+    def visit_Call(self, o: Call, **kwargs) -> Iterator[ApplicationType]:
         for i in o.arguments:
             try:
-                ret.update(i.find(self.match))
+                yield from i.find(self.match)
             except (AttributeError, TypeError):
-                ret.update(self._visit(i, ret=ret))
-        return ret
+                yield from self._visit(i)
 
 
 class IsPerfectIteration(Visitor):