PassScopeBase

class hugr.passes.scope.PassScopeBase

Bases: ABC

Abstract superclass for concrete implementations of PassScope.

Methods

in_scope	Returns whether the node may be modified by the pass.
preserve_interface	Returns a list of nodes, in the subtree beneath root, for which the pass must preserve the observable semantics (ports, execution behaviour, linking).
recursive	Returns true if the pass should be applied recursively on the descendants of the root regions.
regions	Return every region (every [dataflow] or [CFG] container - but excluding Module) in the Hugr to be optimized by the pass.
root	Returns the root of the subtree to be optimized by the pass, or none if the pass should do nothing.

in_scope(hugr: Hugr, n: Node) → InScope

Returns whether the node may be modified by the pass.

Nodes outside the root subtree are never in scope. Nodes inside the subtree may be InScope.YES or InScope.PRESERVE_INTERFACE.

abstractmethod preserve_interface(hugr: Hugr) → Iterable[Node]

Returns a list of nodes, in the subtree beneath root, for which the pass must preserve the observable semantics (ports, execution behaviour, linking).

We include the Module in this list (if it is root) as these properties must be preserved (this rules out any other changes).

abstractmethod recursive() → bool

Returns true if the pass should be applied recursively on the descendants of the root regions.

regions(hugr: Hugr) → Iterable[Node]

Return every region (every [dataflow] or [CFG] container - but excluding Module) in the Hugr to be optimized by the pass.

This computes all the regions to be optimized at once. In general, it is more efficient to traverse the Hugr incrementally starting from the PassScope.root instead.

abstractmethod root(hugr: Hugr) → Node | None

Returns the root of the subtree to be optimized by the pass, or none if the pass should do nothing.