Skip to content

Rule

oqd_compiler_infrastructure.rule

RuleBase

Bases: PassBase

This class represents a rule applied to an IR.

Source code in oqd-compiler-infrastructure/src/oqd_compiler_infrastructure/rule.py 
30
31
32
33
34
35
36
37
class RuleBase(PassBase):
    """
    This class represents a rule applied to an IR.
    """

    @property
    def children(self):
        return []

RewriteRule

Bases: RuleBase

This class represents a rule used to rewrite a type or IR. The result of the same type or IR.

Acknowledgement

This code was inspired by MLIR, Bloqade-python

Source code in oqd-compiler-infrastructure/src/oqd_compiler_infrastructure/rule.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
class RewriteRule(RuleBase):
    """
    This class represents a rule used to rewrite a type or IR. The result of the same type
    or IR.

    Acknowledgement:
        This code was inspired by [MLIR](https://github.com/llvm/llvm-project/blob/main/mlir/include/mlir/IR/PatternMatch.h#L246), [Bloqade-python](https://github.com/QuEraComputing/bloqade-python/blob/main/src/bloqade/ir/visitor.py#L34)
    """

    def map(self, model):
        for cls in model.__class__.__mro__:
            map_func = getattr(self, "map_{}".format(cls.__name__), None)
            if map_func:
                break

        if not map_func:
            map_func = self.generic_map

        return map_func(model)

    def generic_map(self, model):
        return model

    pass

ConversionRule

Bases: RuleBase

This class represents a rule used to convert between different types and IRs.

Acknowledgement

This code was inspired by MLIR

Source code in oqd-compiler-infrastructure/src/oqd_compiler_infrastructure/rule.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
class ConversionRule(RuleBase):
    """
    This class represents a rule used to convert between different types and IRs.

    Acknowledgement:
        This code was inspired by [MLIR]()
    """

    def __init__(self):
        super().__init__()
        self.operands = None

    def map(self, model):
        operands = self.operands

        for cls in model.__class__.__mro__:
            map_func = getattr(self, "map_{}".format(cls.__name__), None)
            if map_func:
                break

        if not map_func:
            map_func = self.generic_map

        return map_func(model, operands=operands)

    def generic_map(self, model, operands):
        return model

PrettyPrint

Bases: ConversionRule

This class represents a rewrite rule that constructs a string to represent an AST.

Source code in oqd-compiler-infrastructure/src/oqd_compiler_infrastructure/rule.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
class PrettyPrint(ConversionRule):
    """
    This class represents a rewrite rule that constructs a string to represent an AST.
    """

    def __init__(self, *, indent="  "):
        super().__init__()

        self.indent = indent

    def generic_map(self, model, operands):
        return f"{model.__class__.__name__}({model})"

    def map_list(self, model, operands):
        s = f"{model.__class__.__name__}"

        _s = ""
        for n, o in enumerate(operands):
            _s += f"\n{self.indent}- {n}: " + f"\n{self.indent}".join(o.split("\n"))

        s = s + _s

        return s

    def map_tuple(self, model, operands):
        s = f"{model.__class__.__name__}"

        _s = ""
        for n, o in enumerate(operands):
            _s += f"\n{self.indent}- {n}: " + f"\n{self.indent}".join(o.split("\n"))

        s = s + _s

        return s

    def map_dict(self, model, operands):
        s = f"{model.__class__.__name__}"

        _s = ""
        for k, v in operands.items():
            _s += f"\n{self.indent}- {k}: " + f"\n{self.indent}".join(v.split("\n"))

        s = s + _s

        return s

    def map_VisitableBaseModel(self, model, operands):
        s = f"{model.__class__.__name__}"

        _s = ""
        for k, v in operands.items():
            _s += f"\n{self.indent}- {k}: " + f"\n{self.indent}".join(v.split("\n"))

        s = s + _s

        return s