Skip to content

Lattice

Lattice for constant analysis.

Bottom dataclass 

Bottom()

Bases: Result

Bottom element of the lattice.

is_subseteq 

is_subseteq(other: Result) -> bool

Subseteq operation.

Source code in src/kirin/analysis/const/lattice.py 
65
66
def is_subseteq(self, other: Result) -> bool:
    return True

PartialConst dataclass 

PartialConst()

Bases: Result

Base class for partial constant values.

PartialLambda dataclass 

PartialLambda(
    code: ir.Statement,
    captured: tuple[Result, ...],
    argnames: list[str] | None = None,
)

Bases: PartialConst

Partial lambda constant value.

This represents a closure with captured variables.

Source code in src/kirin/analysis/const/lattice.py 
194
195
196
197
198
199
200
201
202
203
204
205
206
def __init__(
    self,
    code: ir.Statement,
    captured: tuple[Result, ...],
    argnames: list[str] | None = None,
):
    trait = code.get_present_trait(ir.CallableStmtInterface)
    region = trait.get_callable_region(code)
    self.argnames = argnames or [
        arg.name or f"arg_{idx}" for idx, arg in enumerate(region.blocks[0].args)
    ]
    self.code = code
    self.captured = captured

join 

join(other: Result) -> Result

Join operation.

Source code in src/kirin/analysis/const/lattice.py 
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
def join(self, other: Result) -> Result:
    if other is other.bottom():
        return self

    if not isinstance(other, PartialLambda):
        return Unknown().join(other)  # widen self

    if self.code is not other.code:
        return Unknown()  # lambda stmt is pure

    if len(self.captured) != len(other.captured):
        return self.bottom()  # err

    return PartialLambda(
        self.code,
        tuple(x.join(y) for x, y in zip(self.captured, other.captured)),
        self.argnames,
    )

meet 

meet(other: Result) -> Result

Meet operation.

Source code in src/kirin/analysis/const/lattice.py 
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
def meet(self, other: Result) -> Result:
    if not isinstance(other, PartialLambda):
        return Unknown().meet(other)

    if self.code is not other.code:
        return self.bottom()

    if len(self.captured) != len(other.captured):
        return Unknown()

    return PartialLambda(
        self.code,
        tuple(x.meet(y) for x, y in zip(self.captured, other.captured)),
        self.argnames,
    )

PartialTuple dataclass 

PartialTuple(data: tuple[Result, ...])

Bases: PartialConst

Partial tuple constant value.

join 

join(other: Result) -> Result

Join operation.

Source code in src/kirin/analysis/const/lattice.py 
129
130
131
132
133
134
135
136
137
138
139
140
def join(self, other: Result) -> Result:
    if other.is_subseteq(self):
        return self
    elif self.is_subseteq(other):
        return other
    elif isinstance(other, PartialTuple):
        return PartialTuple(tuple(x.join(y) for x, y in zip(self.data, other.data)))
    elif isinstance(other, Value) and isinstance(other.data, tuple):
        return PartialTuple(
            tuple(x.join(Value(y)) for x, y in zip(self.data, other.data))
        )
    return Unknown()

meet 

meet(other: Result) -> Result

Meet operation.

Source code in src/kirin/analysis/const/lattice.py 
142
143
144
145
146
147
148
149
150
151
152
153
def meet(self, other: Result) -> Result:
    if self.is_subseteq(other):
        return self
    elif other.is_subseteq(self):
        return other
    elif isinstance(other, PartialTuple):
        return PartialTuple(tuple(x.meet(y) for x, y in zip(self.data, other.data)))
    elif isinstance(other, Value) and isinstance(other.data, tuple):
        return PartialTuple(
            tuple(x.meet(Value(y)) for x, y in zip(self.data, other.data))
        )
    return self.bottom()

PartialTupleMeta

Bases: LatticeAttributeMeta

Metaclass for PartialTuple.

This metaclass canonicalizes PartialTuple instances with all Value elements into a single Value instance.

Result dataclass 

Result()

Bases: Attribute, IsSubsetEqMixin['Result'], SimpleJoinMixin['Result'], SimpleMeetMixin['Result'], BoundedLattice['Result'], _ElemVisitor

Base class for constant analysis results.

Unknown dataclass 

Unknown()

Bases: Result

Unknown constant value. This is the top element of the lattice.

is_subseteq 

is_subseteq(other: Result) -> bool

Subseteq operation.

Source code in src/kirin/analysis/const/lattice.py 
48
49
def is_subseteq(self, other: Result) -> bool:
    return isinstance(other, Unknown)

Value dataclass 

Value(data: Any)

Bases: Result

Constant value. Wraps any hashable Python value.