DFG

class hugr.ops.DFG(inputs: list[Type], _outputs: list[Type] | None = None)

Bases: DfParentOp, DataflowOp

Simple dataflow graph operation. Outer signature matches inner signature.

Methods

inner_signature	Inner signature of the child dataflow graph.
name	Name of the operation.
outer_signature	The external signature of this operation.
port_kind	Get the kind of the given port.
port_type	Get the type of the given dataflow port from the signature of the operation.
used_extensions	Get the extensions used by this operation, optionally resolving unresolved types and operations.

Attributes

num_out	The number of output ports for this operation.
outputs	Output types of the operation.
signature	Signature of the operation.
inputs	Inputs types of the operation.

inner_signature() → FunctionType

Inner signature of the child dataflow graph.

inputs: list[Type]

Inputs types of the operation.

name() → str

Name of the operation.

property num_out: int

The number of output ports for this operation.

Example

>>> op = Const(val.TRUE)
>>> op.num_out
1

outer_signature() → FunctionType

The external signature of this operation. Defines the valid external connectivity of the node the operation belongs to.

Raises:

IncompleteOp – If the operation’s inputs and outputs have not been set.

property outputs: list[Type]

Output types of the operation.

Raises:

IncompleteOp – If the outputs have not been set.

port_kind(port: InPort | OutPort) → ValueKind | ConstKind | FunctionKind | CFKind | OrderKind

Get the kind of the given port.

Example

>>> op = Const(val.TRUE)
>>> op.port_kind(OutPort(Node(0), 0))
ConstKind(Bool)

port_type(port: InPort | OutPort) → Type

Get the type of the given dataflow port from the signature of the operation.

Example

>>> op = Input([tys.Bool])
>>> op.port_type(OutPort(Node(0), 0))
Bool

property signature: FunctionType

Signature of the operation.

Raises:

IncompleteOp – If the outputs have not been set.

used_extensions(resolve_from: ExtensionRegistry | None = None) → ExtensionResolutionResult

Get the extensions used by this operation, optionally resolving unresolved types and operations.

Parameters:

resolve_from – Optional extension registry to resolve against. If None, opaque types and Custom ops will not be resolved.

Returns:

The result containing used and unresolved extensions.