kirin.ir.nodes.base.IRNode

← Module overview

classIRNode¶source

kirin.ir.nodes.base.IRNode

Bases: Generic[ParentType], ABC, Printable

Base class for all IR nodes. All IR nodes are hashable and can be compared for equality. The hash of an IR node is the same as the id of the object.

class IRNode

Public import paths

• from kirin.ir import IRNode
• from kirin.ir.nodes import IRNode
• from kirin.rewrite.abc import IRNode
• from kirin.ir.exception import IRNode
• from kirin.rewrite.walk import IRNode
• from kirin.rewrite.chain import IRNode
• from kirin.rewrite.fixpoint import IRNode
• from kirin.ir.nodes.stmt import IRNode
• from kirin.ir.nodes.view import IRNode
• from kirin.ir.nodes.block import IRNode
• from kirin.ir.nodes.region import IRNode
• from kirin.rewrite.aggressive.fold import IRNode
• from kirin.dialects.vmath.rewrites.desugar import IRNode

!!! note “Pretty Printing” This object is pretty printable via .print() method.

Attributes

Name	Type	Default	Description
source	SourceInfo | None	field(default=None, init=False, repr=False)
IS_REGION	bool	False
IS_BLOCK	bool	False
IS_STATEMENT	bool	False

methodassert_parent¶source

kirin.ir.nodes.base.IRNode.assert_parent

def assert_parent(type_: type[IRNode], parent) -> None

Parameters

Name	Type	Description
type_	type[IRNode]
parent	—

source

propertyparent_node¶source

kirin.ir.nodes.base.IRNode.parent_node

parent_node: ParentType | None

Parent node of the current node.

source

methodis_ancestor¶source

kirin.ir.nodes.base.IRNode.is_ancestor

def is_ancestor(op: IRNode) -> bool

Check if the given node is an ancestor of the current node.

Parameters

Name	Type	Description
op	IRNode

Returns

bool

source

methodget_root¶source

kirin.ir.nodes.base.IRNode.get_root

def get_root() -> IRNode

Get the root node of the current node.

Returns

IRNode

source

methodattach¶source

kirin.ir.nodes.base.IRNode.attach

def attach(parent: ParentType) -> None

Attach the current node to the parent node.

Parameters

Name	Type	Description
parent	ParentType

source

methoddetach¶source

kirin.ir.nodes.base.IRNode.detach

def detach() -> None

Detach the current node from the parent node.

source

methoddrop_all_references¶source

kirin.ir.nodes.base.IRNode.drop_all_references

def drop_all_references() -> None

Drop all references to other nodes.

source

methoddelete¶source

kirin.ir.nodes.base.IRNode.delete

def delete(safe: bool = True) -> None

Delete the current node.

Parameters

Name	Type	Default	Description
safe	bool	True	If True, check if the node has any references before deleting.

source

methodis_structurally_equal¶source

kirin.ir.nodes.base.IRNode.is_structurally_equal

Signature

def is_structurally_equal(other: 'IRNode', context: dict[IRNode | SSAValue, IRNode | SSAValue] | None = None) -> bool

Check if the current node is structurally equal to the other node.

!!! note This method is for tweaking the behavior of structural equality. To check if two nodes are structurally equal, use the is_structurally_equal method.

Parameters

Name	Type	Default	Description
other	'IRNode'	required	The other node to compare.
context	dict[IRNode | SSAValue, IRNode | SSAValue] | None	None	The context to store the visited nodes.

Returns

boolTrue if the nodes are structurally equal, False otherwise.

source

methodwalk¶source

kirin.ir.nodes.base.IRNode.walk

Signature

def walk(*, reverse: bool = False, region_first: bool = False) -> Iterator[Statement]

Parameters

Name	Type	Default	Description
reverse	bool	False
region_first	bool	False

Returns

Iterator[Statement]

source

methodprint_impl¶source

kirin.ir.nodes.base.IRNode.print_impl

def print_impl(printer: Printer) -> None

Parameters

Name	Type	Description
printer	Printer

source

methodverify¶source

kirin.ir.nodes.base.IRNode.verify

def verify() -> None

run mandatory validation checks. This is not same as verify_type, which may be optional.

source

methodverify_type¶source

kirin.ir.nodes.base.IRNode.verify_type

def verify_type() -> None

verify the type of the node.

source