qamomile.circuit.serialization

Persist one unbound qkernel and reconstruct it without Python source.

The protobuf format preserves the highest target-neutral static semantics: the qkernel interface, hierarchical IR body, shared callable definitions, and all value-identity relationships needed by later compiler passes. Random process-local UUID and logical-ID spellings are replaced by canonical graph-local identities. Invocation bindings, runtime values, prepared compiler modules, backend artifacts, resource estimates, and Python evaluation performed during tracing are outside the format.

After :func:deserialize, pass the returned :class:SerializedQKernel to an ordinary Qamomile transpiler with fresh bindings and parameters.

Registered compile-time object arguments are stored only as typed binding slots. Their concrete values are deliberately absent from the payload and must be supplied through bindings after deserialization.

Overview¶

Constants¶

• QAMOMILE_VERSION: str = version('qamomile')

Functions¶

deserialize [source]¶

def deserialize(payload: bytes) -> SerializedQKernel

Deserialize protobuf bytes into a static qkernel-like object.

Parameters:

Returns:

SerializedQKernel — Reconstructed qkernel accepted by transpilers.

Raises:

• TypeError — If payload is not bytes-like.

• ValueError — If parsing, version validation, or reconstruction fails.

serialize [source]¶

def serialize(kernel: QKernelLike) -> bytes

Serialize one unbound qkernel to canonical protobuf bytes.

Independently traced equivalent qkernels produce identical bytes because process-local value identities are normalized before protobuf encoding.

Parameters:

Returns:

bytes — Deterministic protobuf encoding.

Raises:

• TypeError — If the qkernel contains an unsupported type or payload.

• ValueError — If the qkernel is bound, lowered, or malformed.

Classes¶

SerializedQKernel [source]¶

class SerializedQKernel

A qkernel whose Python-independent semantic IR was deserialized.

The object implements the compiler-facing qkernel protocol. Its body is a static, unbound hierarchical block, so :meth:build specializes existing IR values instead of executing the original Python function again.

Constructor¶

def __init__(
    self,
    name: str,
    signature: inspect.Signature,
    input_types: dict[str, Any],
    output_types: list[Any],
    _block: Block,
    _callable_definition: CallableDef,
) -> None

Attributes¶

• block: Block Return the cached unbound hierarchical body.

• effects: KernelEffect Return cached semantic effects of the preserved body.

• input_types: dict[str, Any]

• name: str

• output_types: list[Any]

• signature: inspect.Signature

Methods¶

build¶

def build(self, parameters: list[str] | None = None, **kwargs: Any = {}) -> Block

Specialize the preserved IR for bindings and runtime parameters.

This method mirrors the public qkernel argument contract while avoiding Python re-tracing. Compile-time values replace the corresponding formal IR values; runtime parameters remain symbolic.

Parameters:

Returns:

Block — Specialized traced-stage body accepted by the normal Qamomile compiler pipeline.

Raises:

• TypeError — If a requested parameter or binding type is unsupported.

• ValueError — If arguments are unknown, missing, or present in both parameters and kwargs.

qamomile.circuit.serialization.canonical¶

Canonicalize process-local identities in serialized qkernel graphs.

Overview¶

Functions¶

canonicalize_graph [source]¶

def canonicalize_graph(envelope: dict[str, Any]) -> dict[str, Any]

Replace random value identities with deterministic graph-local IDs.

Value-table order is the semantic encoder’s deterministic first-visit order. The rewrite preserves every equality and reference relationship while making independently traced instances of the same qkernel byte-identical.

Parameters:

Returns:

dict[str, Any] — dict[str, Any]: A deep-copied envelope with canonical UUID and logical-ID strings.

Raises:

• ValueError — If the value table or an identity-bearing field is malformed.

qamomile.circuit.serialization.decode¶

Decode one static qkernel from the semantic protobuf graph model.

Overview¶

Constants¶

• QAMOMILE_VERSION: str = version('qamomile')

• ValueLike: TypeAlias = 'Value | ArrayValue | TupleValue | DictValue'

Functions¶

build_param_slots [source]¶

def build_param_slots(
    signature: inspect.Signature,
    input_types: dict[str, Any],
    *,
    parameters: list[str] | None = None,
    kwargs: dict[str, Any] | None = None,
    qubit_sizes: dict[str, int] | None = None,
    bind_defaults: bool,
) -> tuple[ParamSlot, ...]

Build a ParamSlot tuple for the classical arguments of a kernel.

Mirrors the argument-classification logic in qkernel_build.create_traced_block so the resulting slot list reflects the same decisions that drive symbolic-vs-bound input creation. Classical scalar / array arguments are always included; a Dict argument is included only when it is a runtime parameter (its slot carries a DictType). Pure-quantum arguments, Tuple arguments, and compile-time-bound Dict arguments are excluded and live in Block.input_values instead.

Parameters:

Returns:

tuple[ParamSlot, ...] — tuple[ParamSlot, ...]: One slot per classical argument, in the order they appear in signature.parameters.

Raises:

• TypeError — If a non-static classical annotation cannot be represented by an IR parameter type.

from_dict [source]¶

def from_dict(envelope: dict[str, Any]) -> SerializedQKernel

Reconstruct a static qkernel from an internal graph envelope.

Parameters:

Returns:

SerializedQKernel — QKernel-like object accepted by normal transpilers.

Raises:

• ValueError — If the version, graph, interface, or references are malformed.

get_static_binding_by_type_key [source]¶

def get_static_binding_by_type_key(type_key: str) -> StaticBindingSpec

Return the adapter registered under a stable serialization key.

Parameters:

Returns:

StaticBindingSpec — Matching registered adapter.

Raises:

• KeyError — If the installed Qamomile distribution does not know the key.

handle_type_map [source]¶

def handle_type_map(handle_type: type[Handle] | type) -> ValueType

Map Handle type to ValueType.

validate_qkernel_ir [source]¶

def validate_qkernel_ir(block: Block) -> None

Validate every operation and nested region reachable from a qkernel.

Parameters:

Raises:

• ValueError — If an operation violates its arity, type, SSA, callable, or region contract.

validate_static_binding_slot [source]¶

def validate_static_binding_slot(spec: StaticBindingSpec, slot: StaticBindingSlot) -> None

Validate a serialized IR slot against its installed adapter.

Parameters:

Raises:

• ValueError — If the type key, projected field names, or field types do not exactly match the registered adapter.

Classes¶

ArrayValue [source]¶

class ArrayValue(Value[T])

An array of typed IR values.

When slice_of is set, this array is a strided view over another array. Element accesses on a sliced ArrayValue resolve to physical slots on the root parent via the affine map parent_index = slice_start + slice_step * view_local_index, applied recursively along slice_of chains. The emit-time resolver walks this chain to produce the final qubit index; passes that substitute or clone values must treat slice_of / slice_start / slice_step as Value references that need to track through the same mapping as parent_array.

Constructor¶

def __init__(
    self,
    type: T,
    name: str,
    version: int = 0,
    metadata: ValueMetadata = ValueMetadata(),
    uuid: str = (lambda: str(uuid.uuid4()))(),
    logical_id: str = (lambda: str(uuid.uuid4()))(),
    parent_array: ArrayValue | None = None,
    element_indices: tuple[Value, ...] = (),
    shape: tuple[Value, ...] = tuple(),
    slice_of: 'ArrayValue | None' = None,
    slice_start: 'Value | None' = None,
    slice_step: 'Value | None' = None,
) -> None

Attributes¶

• logical_id: str

• metadata: ValueMetadata

• name: str

• shape: tuple[Value, ...]

• slice_of: ‘ArrayValue | None’

• slice_start: ‘Value | None’

• slice_step: ‘Value | None’

• type: T

• uuid: str

Methods¶

is_slice¶

def is_slice(self) -> bool

Return True if this array is a strided view of another array.

Returns:

bool — True iff slice_of is non-None.

next_version¶

def next_version(self) -> ArrayValue[T]

SerializedQKernel [source]¶

class SerializedQKernel

A qkernel whose Python-independent semantic IR was deserialized.

The object implements the compiler-facing qkernel protocol. Its body is a static, unbound hierarchical block, so :meth:build specializes existing IR values instead of executing the original Python function again.

Constructor¶

def __init__(
    self,
    name: str,
    signature: inspect.Signature,
    input_types: dict[str, Any],
    output_types: list[Any],
    _block: Block,
    _callable_definition: CallableDef,
) -> None

Attributes¶

• block: Block Return the cached unbound hierarchical body.

• effects: KernelEffect Return cached semantic effects of the preserved body.

• input_types: dict[str, Any]

• name: str

• output_types: list[Any]

• signature: inspect.Signature

Methods¶

build¶

def build(self, parameters: list[str] | None = None, **kwargs: Any = {}) -> Block

Specialize the preserved IR for bindings and runtime parameters.

This method mirrors the public qkernel argument contract while avoiding Python re-tracing. Compile-time values replace the corresponding formal IR values; runtime parameters remain symbolic.

Parameters:

Returns:

Block — Specialized traced-stage body accepted by the normal Qamomile compiler pipeline.

Raises:

• TypeError — If a requested parameter or binding type is unsupported.

• ValueError — If arguments are unknown, missing, or present in both parameters and kwargs.

qamomile.circuit.serialization.encode¶

Encode one unbound qkernel into the semantic protobuf graph model.

Overview¶

Constants¶

• QAMOMILE_VERSION: str = version('qamomile')

Functions¶

canonicalize_graph [source]¶

def canonicalize_graph(envelope: dict[str, Any]) -> dict[str, Any]

Replace random value identities with deterministic graph-local IDs.

Value-table order is the semantic encoder’s deterministic first-visit order. The rewrite preserves every equality and reference relationship while making independently traced instances of the same qkernel byte-identical.

Parameters:

Returns:

dict[str, Any] — dict[str, Any]: A deep-copied envelope with canonical UUID and logical-ID strings.

Raises:

• ValueError — If the value table or an identity-bearing field is malformed.

get_static_binding_by_annotation [source]¶

def get_static_binding_by_annotation(annotation: Any) -> StaticBindingSpec | None

Return the adapter registered for a qkernel annotation.

Parameters:

Returns:

StaticBindingSpec | None — StaticBindingSpec | None: Registered adapter, or None for an StaticBindingSpec | None — ordinary qkernel argument.

handle_type_map [source]¶

def handle_type_map(handle_type: type[Handle] | type) -> ValueType

Map Handle type to ValueType.

is_array_type [source]¶

def is_array_type(t: Any) -> bool

Check if type is a Vector, Matrix, or Tensor subclass.

is_dict_type [source]¶

def is_dict_type(t: Any) -> bool

Check if type is a Dict handle type.

is_tuple_type [source]¶

def is_tuple_type(t: Any) -> bool

Check if type is a Tuple handle type.

qkernel_callable_attrs [source]¶

def qkernel_callable_attrs(kernel: Any) -> dict[str, Any]

Return compiler attrs for a qkernel invocation.

Composite metadata lives directly on QKernel. This helper is the single translation point from that frontend state into serializer-safe IR attributes, so direct, controlled, and inverse calls share one identity.

Parameters:

Returns:

dict[str, Any] — dict[str, Any]: Serializer-friendly callable attributes.

qkernel_callable_ref [source]¶

def qkernel_callable_ref(kernel: Any) -> CallableRef

Return the compiler-facing callable reference for a qkernel.

Parameters:

Returns:

CallableRef — Stable reference used by InvokeOperation call sites.

to_dict [source]¶

def to_dict(kernel: QKernelLike) -> dict[str, Any]

Encode an unbound qkernel into an internal graph envelope.

Parameters:

Returns:

dict[str, Any] — dict[str, Any]: Internal graph record consumed by the protobuf bridge.

Raises:

• TypeError — If kernel is not qkernel-like or contains an unsupported frontend type or process-local emitter.

• ValueError — If the body is specialized, non-hierarchical, or its interface disagrees with the signature.

validate_qkernel_ir [source]¶

def validate_qkernel_ir(block: Block) -> None

Validate every operation and nested region reachable from a qkernel.

Parameters:

Raises:

• ValueError — If an operation violates its arity, type, SSA, callable, or region contract.

validate_static_binding_slot [source]¶

def validate_static_binding_slot(spec: StaticBindingSpec, slot: StaticBindingSlot) -> None

Validate a serialized IR slot against its installed adapter.

Parameters:

Raises:

• ValueError — If the type key, projected field names, or field types do not exactly match the registered adapter.

Classes¶

BlockKind [source]¶

class BlockKind(Enum)

Classification of block structure for pipeline stages.

Attributes¶

• AFFINE

• ANALYZED

• HIERARCHICAL

• TRACED

CallPolicy [source]¶

class CallPolicy(enum.Enum)

Describe the default lowering policy for a callable call.

Attributes¶

• INLINE

• NATIVE_FIRST

• PRESERVE_BOX

CallableDef [source]¶

class CallableDef

Describe a compiler-facing callable definition.

Parameters:

Constructor¶

def __init__(
    self,
    ref: CallableRef,
    signature: Signature | None = None,
    body: Block | None = None,
    body_ref: CallableBodyRef | None = None,
    implementations: list[CallableImplementation] = list(),
    opaque_cost: Any | None = None,
    default_policy: CallPolicy = CallPolicy.INLINE,
    attrs: dict[str, Any] = dict(),
) -> None

Attributes¶

• attrs: dict[str, Any]

• body: Block | None

• body_ref: CallableBodyRef | None

• default_policy: CallPolicy

• implementations: list[CallableImplementation]

• opaque_cost: Any | None

• ref: CallableRef

• signature: Signature | None

Methods¶

effects_for¶

def effects_for(self, transform: CallTransform = CallTransform.DIRECT) -> 'KernelEffect'

Return cached semantic effects for one call transform.

Parameters:

Returns:

'KernelEffect' — Union of relevant implementation-body effects.

implementation_for¶

def implementation_for(
    self,
    *,
    transform: CallTransform = CallTransform.DIRECT,
    backend: str | None = None,
    strategy: str | None = None,
) -> CallableImplementation | None

Return the best matching implementation candidate.

Parameters:

Returns:

CallableImplementation | None — CallableImplementation | None: Matching implementation, if any.

measurement_result_indices_for¶

def measurement_result_indices_for(self, transform: CallTransform = CallTransform.DIRECT) -> frozenset[int]

Return measured result positions for one call transform.

Parameters:

Returns:

frozenset[int] — frozenset[int]: Result indices carrying measurement provenance.

ParamKind [source]¶

class ParamKind(enum.Enum)

Lifecycle classification for a classical kernel argument.

Values:

RUNTIME_PARAMETER: The argument is intended to be bound at execution time by the backend (or, more generally, by the outer caller in a hybrid loop). It survives the compilation pipeline as a symbolic parameter. COMPILE_TIME_BOUND: The argument was provided as a binding (or via a Python default) and is folded into the IR by resolve_parameter_shapes / partial_eval. No symbolic counterpart remains in the emitted circuit.

Attributes¶

• COMPILE_TIME_BOUND

• RUNTIME_PARAMETER

QKernelLike [source]¶

class QKernelLike(Protocol)

Describe the frontend surface required by compiler entrypoints.

This protocol is intentionally structural. It lets decorator-created composites reuse the qkernel inspection and build interface without making them inherit from QKernel or exposing the compiler-facing callable descriptor model as a frontend concept.

Attributes¶

• block: Block Return the cached hierarchical body block.

• effects: KernelEffect Return cached semantic effects of the qkernel body.

• input_types: dict[str, Any] Return frontend input annotations by parameter name.

• name: str Return the user-facing callable name.

• output_types: list[Any] Return frontend output annotations.

• signature: inspect.Signature Return the Python call signature.

Methods¶

build¶

def build(self, parameters: list[str] | None = None, **kwargs: Any = {}) -> Block

Build a traced body block.

Parameters:

Returns:

Block — Traced hierarchical body block.

ValueBase [source]¶

class ValueBase

Nominal base for every typed IR value.

Runtime compiler passes inspect values in their innermost loops. A nominal base keeps those checks constant-time; a runtime-checkable protocol would repeatedly scan the protocol members on Python versions that do not cache structural checks.

Attributes¶

• logical_id: str

• metadata: ValueMetadata

• name: str

• type: ValueType Return the static IR type carried by this value.

• uuid: str

Methods¶

get_const¶

def get_const(self) -> int | float | bool | None

Return the scalar constant carried by this value.

Returns:

int | float | bool | None — int | float | bool | None: Constant value, or None when the value is not constant.

is_constant¶

def is_constant(self) -> bool

Return whether this value carries a scalar constant.

Returns:

bool — Whether scalar constant metadata is present.

is_parameter¶

def is_parameter(self) -> bool

Return whether this value represents a runtime parameter.

Returns:

bool — Whether parameter metadata is present.

next_version¶

def next_version(self) -> ValueBase

Create the next SSA version of this value.

Returns:

ValueBase — A value with a fresh version UUID and preserved logical identity.

parameter_name¶

def parameter_name(self) -> str | None

Return the public parameter name carried by this value.

Returns:

str | None — str | None: Parameter name, or None for a non-parameter value.

qamomile.circuit.serialization.graph_protobuf¶

Convert semantic IR graph records to the qkernel protobuf schema.

Overview¶

Constants¶

• QAMOMILE_VERSION: str = version('qamomile')

Functions¶

graph_dict_from_qkernel [source]¶

def graph_dict_from_qkernel(message: pb.QKernel) -> dict[str, Any]

Convert a qkernel protobuf into the internal semantic graph record.

Parameters:

Returns:

dict[str, Any] — dict[str, Any]: Graph record accepted by the semantic decoders.

Raises:

• ValueError — If the version, interface, or a typed protobuf field is missing or inconsistent.

qkernel_from_graph_dict [source]¶

def qkernel_from_graph_dict(envelope: dict[str, Any]) -> pb.QKernel

Convert the internal static-qkernel graph record into protobuf.

This bridge keeps graph construction separate from the canonical wire schema. The resulting bytes contain only protobuf fields, never JSON or a pickled Python dictionary.

Parameters:

Returns:

pb.QKernel — pb.QKernel: Canonical qkernel protobuf graph.

Raises:

• ValueError — If the graph envelope or qkernel interface is malformed.

• TypeError — If a nested payload is outside the closed protobuf union.

qamomile.circuit.serialization.graph_protobuf.pb¶

Generated protocol buffer code.

Overview¶

Constants¶

• ARRAY_VALUE: ValueKind

• BIN_OPERATION: OperationType

• BIT_TYPE: ValueTypeKind

• BLOCK_TYPE: ValueTypeKind

• CAST_OPERATION: OperationType

• CINIT_OPERATION: OperationType

• COMP_OPERATION: OperationType

• CONCRETE_CONTROLLED_OPERATION: OperationType

• COND_OPERATION: OperationType

• DECODE_QFIXED_OPERATION: OperationType

• DESCRIPTOR: _descriptor.FileDescriptor

• DICT_GET_ITEM_OPERATION: OperationType

• DICT_TYPE: ValueTypeKind

• DICT_VALUE: ValueKind

• EXPVAL_OPERATION: OperationType

• FLOAT_TYPE: ValueTypeKind

• FOR_ITEMS_OPERATION: OperationType

• FOR_OPERATION: OperationType

• FRONTEND_ANNOTATION_KIND_UNSPECIFIED: FrontendAnnotationKind

• GATE_OPERATION: OperationType

• GLOBAL_PHASE_OPERATION: OperationType

• IF_OPERATION: OperationType

• INVERSE_BLOCK_OPERATION: OperationType

• INVOKE_OPERATION: OperationType

• KEYWORD_ONLY: ParameterKind

• MEASURE_OPERATION: OperationType

• MEASURE_QFIXED_OPERATION: OperationType

• MEASURE_VECTOR_OPERATION: OperationType

• NOT_OPERATION: OperationType

• OBSERVABLE_TYPE: ValueTypeKind

• OPERATION_TYPE_UNSPECIFIED: OperationType

• PARAMETER_KIND_UNSPECIFIED: ParameterKind

• PAULI_EVOLVE_OPERATION: OperationType

• POSITIONAL_ONLY: ParameterKind

• POSITIONAL_OR_KEYWORD: ParameterKind

• PROJECT_OPERATION: OperationType

• PYTHON_BOOL: FrontendAnnotationKind

• PYTHON_FLOAT: FrontendAnnotationKind

• PYTHON_INT: FrontendAnnotationKind

• PYTHON_TUPLE: FrontendAnnotationKind

• QAMOMILE_BIT: FrontendAnnotationKind

• QAMOMILE_DICT: FrontendAnnotationKind

• QAMOMILE_FLOAT: FrontendAnnotationKind

• QAMOMILE_MATRIX: FrontendAnnotationKind

• QAMOMILE_OBSERVABLE: FrontendAnnotationKind

• QAMOMILE_QFIXED: FrontendAnnotationKind

• QAMOMILE_QUBIT: FrontendAnnotationKind

• QAMOMILE_TENSOR: FrontendAnnotationKind

• QAMOMILE_TUPLE: FrontendAnnotationKind

• QAMOMILE_UINT: FrontendAnnotationKind

• QAMOMILE_VECTOR: FrontendAnnotationKind

• QFIXED_TYPE: ValueTypeKind

• QINIT_OPERATION: OperationType

• QUBIT_TYPE: ValueTypeKind

• QUINT_TYPE: ValueTypeKind

• RELEASE_SLICE_VIEW_OPERATION: OperationType

• RESET_OPERATION: OperationType

• RETURN_OPERATION: OperationType

• RETURN_QUANTUM_ARRAY_ELEMENT_OPERATION: OperationType

• RUNTIME_CLASSICAL_OPERATION: OperationType

• SELECT_OPERATION: OperationType

• SLICE_ARRAY_OPERATION: OperationType

• STORE_ARRAY_ELEMENT_OPERATION: OperationType

• SYMBOLIC_CONTROLLED_OPERATION: OperationType

• TUPLE_TYPE: ValueTypeKind

• TUPLE_VALUE: ValueKind

• UINT_TYPE: ValueTypeKind

• UNARY_MATH_OPERATION: OperationType

• VALUE: ValueKind

• VALUE_KIND_UNSPECIFIED: ValueKind

• VALUE_TYPE_KIND_UNSPECIFIED: ValueTypeKind

• VAR_KEYWORD: ParameterKind

• VAR_POSITIONAL: ParameterKind

• WHILE_OPERATION: OperationType

Classes¶

ArrayRuntimeMetadata [source]¶

class ArrayRuntimeMetadata(_message.Message)

Constructor¶

def __init__(
    self,
    const_array: _Optional[_Union[Payload, _Mapping]] = ...,
    element_uuids: _Optional[_Iterable[str]] = ...,
    element_logical_ids: _Optional[_Iterable[str]] = ...,
    element_parent_uuids: _Optional[_Iterable[_Union[OptionalString, _Mapping]]] = ...,
    element_parent_indices: _Optional[_Iterable[_Union[OptionalInteger, _Mapping]]] = ...,
) -> None

Attributes¶

• CONST_ARRAY_FIELD_NUMBER: int

• ELEMENT_LOGICAL_IDS_FIELD_NUMBER: int

• ELEMENT_PARENT_INDICES_FIELD_NUMBER: int

• ELEMENT_PARENT_UUIDS_FIELD_NUMBER: int

• ELEMENT_UUIDS_FIELD_NUMBER: int

• const_array: Payload

• element_logical_ids: _containers.RepeatedScalarFieldContainer[str]

• element_parent_indices: _containers.RepeatedCompositeFieldContainer[OptionalInteger]

• element_parent_uuids: _containers.RepeatedCompositeFieldContainer[OptionalString]

• element_uuids: _containers.RepeatedScalarFieldContainer[str]

BigInteger [source]¶

class BigInteger(_message.Message)

Constructor¶

def __init__(self, negative: bool = ..., magnitude: _Optional[bytes] = ...) -> None

Attributes¶

• MAGNITUDE_FIELD_NUMBER: int

• NEGATIVE_FIELD_NUMBER: int

• magnitude: bytes

• negative: bool

Block [source]¶

class Block(_message.Message)

Constructor¶

def __init__(
    self,
    kind: _Optional[str] = ...,
    name: _Optional[str] = ...,
    label_args: _Optional[_Iterable[_Union[Payload, _Mapping]]] = ...,
    input_value_refs: _Optional[_Iterable[str]] = ...,
    output_value_refs: _Optional[_Iterable[str]] = ...,
    output_names: _Optional[_Iterable[str]] = ...,
    parameters: _Optional[_Iterable[_Union[NamedReference, _Mapping]]] = ...,
    static_bindings: _Optional[_Iterable[_Union[StaticBindingSlot, _Mapping]]] = ...,
    operations: _Optional[_Iterable[_Union[Operation, _Mapping]]] = ...,
) -> None

Attributes¶

• INPUT_VALUE_REFS_FIELD_NUMBER: int

• KIND_FIELD_NUMBER: int

• LABEL_ARGS_FIELD_NUMBER: int

• NAME_FIELD_NUMBER: int

• OPERATIONS_FIELD_NUMBER: int

• OUTPUT_NAMES_FIELD_NUMBER: int

• OUTPUT_VALUE_REFS_FIELD_NUMBER: int

• PARAMETERS_FIELD_NUMBER: int

• STATIC_BINDINGS_FIELD_NUMBER: int

• input_value_refs: _containers.RepeatedScalarFieldContainer[str]

• kind: str

• label_args: _containers.RepeatedCompositeFieldContainer[Payload]

• name: str

• operations: _containers.RepeatedCompositeFieldContainer[Operation]

• output_names: _containers.RepeatedScalarFieldContainer[str]

• output_value_refs: _containers.RepeatedScalarFieldContainer[str]

• parameters: _containers.RepeatedCompositeFieldContainer[NamedReference]

• static_bindings: _containers.RepeatedCompositeFieldContainer[StaticBindingSlot]

BranchRebind [source]¶

class BranchRebind(_message.Message)

Constructor¶

def __init__(
    self,
    var_name: _Optional[str] = ...,
    before_ref: _Optional[str] = ...,
    rebound_in_true: bool = ...,
    rebound_in_false: bool = ...,
) -> None

Attributes¶

• BEFORE_REF_FIELD_NUMBER: int

• REBOUND_IN_FALSE_FIELD_NUMBER: int

• REBOUND_IN_TRUE_FIELD_NUMBER: int

• VAR_NAME_FIELD_NUMBER: int

• before_ref: str

• rebound_in_false: bool

• rebound_in_true: bool

• var_name: str

CallableBodyRef [source]¶

class CallableBodyRef(_message.Message)

Constructor¶

def __init__(
    self,
    ref: _Optional[_Union[CallableRef, _Mapping]] = ...,
    kind: _Optional[str] = ...,
    attrs: _Optional[_Union[Payload, _Mapping]] = ...,
) -> None

Attributes¶

• ATTRS_FIELD_NUMBER: int

• KIND_FIELD_NUMBER: int

• REF_FIELD_NUMBER: int

• attrs: Payload

• kind: str

• ref: CallableRef

CallableDefinition [source]¶

class CallableDefinition(_message.Message)

Constructor¶

def __init__(
    self,
    ref: _Optional[_Union[CallableRef, _Mapping]] = ...,
    signature: _Optional[_Union[Signature, _Mapping]] = ...,
    body: _Optional[_Union[Block, _Mapping]] = ...,
    body_ref: _Optional[_Union[CallableBodyRef, _Mapping]] = ...,
    implementations: _Optional[_Iterable[_Union[CallableImplementation, _Mapping]]] = ...,
    default_policy: _Optional[str] = ...,
    attrs: _Optional[_Union[Payload, _Mapping]] = ...,
) -> None

Attributes¶

• ATTRS_FIELD_NUMBER: int

• BODY_FIELD_NUMBER: int

• BODY_REF_FIELD_NUMBER: int

• DEFAULT_POLICY_FIELD_NUMBER: int

• IMPLEMENTATIONS_FIELD_NUMBER: int

• REF_FIELD_NUMBER: int

• SIGNATURE_FIELD_NUMBER: int

• attrs: Payload

• body: Block

• body_ref: CallableBodyRef

• default_policy: str

• implementations: _containers.RepeatedCompositeFieldContainer[CallableImplementation]

• ref: CallableRef

• signature: Signature

CallableEntry [source]¶

class CallableEntry(_message.Message)

Constructor¶

def __init__(
    self,
    id: _Optional[str] = ...,
    definition: _Optional[_Union[CallableDefinition, _Mapping]] = ...,
) -> None

Attributes¶

• DEFINITION_FIELD_NUMBER: int

• ID_FIELD_NUMBER: int

• definition: CallableDefinition

• id: str

CallableImplementation [source]¶

class CallableImplementation(_message.Message)

Constructor¶

def __init__(
    self,
    transform: _Optional[str] = ...,
    backend: _Optional[str] = ...,
    strategy: _Optional[str] = ...,
    body: _Optional[_Union[Block, _Mapping]] = ...,
    body_ref: _Optional[_Union[CallableBodyRef, _Mapping]] = ...,
    attrs: _Optional[_Union[Payload, _Mapping]] = ...,
) -> None

Attributes¶

• ATTRS_FIELD_NUMBER: int

• BACKEND_FIELD_NUMBER: int

• BODY_FIELD_NUMBER: int

• BODY_REF_FIELD_NUMBER: int

• STRATEGY_FIELD_NUMBER: int

• TRANSFORM_FIELD_NUMBER: int

• attrs: Payload

• backend: str

• body: Block

• body_ref: CallableBodyRef

• strategy: str

• transform: str

CallableRef [source]¶

class CallableRef(_message.Message)

Constructor¶

def __init__(
    self,
    namespace: _Optional[str] = ...,
    name: _Optional[str] = ...,
    version: _Optional[str] = ...,
) -> None

Attributes¶

• NAMESPACE_FIELD_NUMBER: int

• NAME_FIELD_NUMBER: int

• VERSION_FIELD_NUMBER: int

• name: str

• namespace: str

• version: str

CastMetadata [source]¶

class CastMetadata(_message.Message)

Constructor¶

def __init__(
    self,
    source_uuid: _Optional[str] = ...,
    qubit_uuids: _Optional[_Iterable[str]] = ...,
    source_logical_id: _Optional[str] = ...,
    qubit_logical_ids: _Optional[_Iterable[str]] = ...,
) -> None

Attributes¶

• QUBIT_LOGICAL_IDS_FIELD_NUMBER: int

• QUBIT_UUIDS_FIELD_NUMBER: int

• SOURCE_LOGICAL_ID_FIELD_NUMBER: int

• SOURCE_UUID_FIELD_NUMBER: int

• qubit_logical_ids: _containers.RepeatedScalarFieldContainer[str]

• qubit_uuids: _containers.RepeatedScalarFieldContainer[str]

• source_logical_id: str

• source_uuid: str

Complex64 [source]¶

class Complex64(_message.Message)

Constructor¶

def __init__(self, real_bits: _Optional[int] = ..., imag_bits: _Optional[int] = ...) -> None

Attributes¶

• IMAG_BITS_FIELD_NUMBER: int

• REAL_BITS_FIELD_NUMBER: int

• imag_bits: int

• real_bits: int

DictRuntimeMetadata [source]¶

class DictRuntimeMetadata(_message.Message)

Constructor¶

def __init__(
    self,
    bound_data: _Optional[_Iterable[_Union[PayloadEntry, _Mapping]]] = ...,
) -> None

Attributes¶

• BOUND_DATA_FIELD_NUMBER: int

• bound_data: _containers.RepeatedCompositeFieldContainer[PayloadEntry]

Float64 [source]¶

class Float64(_message.Message)

Constructor¶

def __init__(self, bits: _Optional[int] = ...) -> None

Attributes¶

• BITS_FIELD_NUMBER: int

• bits: int

FrontendAnnotation [source]¶

class FrontendAnnotation(_message.Message)

Constructor¶

def __init__(
    self,
    kind: _Optional[_Union[FrontendAnnotationKind, str]] = ...,
    arguments: _Optional[_Iterable[_Union[FrontendAnnotation, _Mapping]]] = ...,
) -> None

Attributes¶

• ARGUMENTS_FIELD_NUMBER: int

• KIND_FIELD_NUMBER: int

• arguments: _containers.RepeatedCompositeFieldContainer[FrontendAnnotation]

• kind: FrontendAnnotationKind

FrontendAnnotationKind [source]¶

class FrontendAnnotationKind(int)

Attributes¶

• FRONTEND_ANNOTATION_KIND_UNSPECIFIED: FrontendAnnotationKind

• PYTHON_BOOL: FrontendAnnotationKind

• PYTHON_FLOAT: FrontendAnnotationKind

• PYTHON_INT: FrontendAnnotationKind

• PYTHON_TUPLE: FrontendAnnotationKind

• QAMOMILE_BIT: FrontendAnnotationKind

• QAMOMILE_DICT: FrontendAnnotationKind

• QAMOMILE_FLOAT: FrontendAnnotationKind

• QAMOMILE_MATRIX: FrontendAnnotationKind

• QAMOMILE_OBSERVABLE: FrontendAnnotationKind

• QAMOMILE_QFIXED: FrontendAnnotationKind

• QAMOMILE_QUBIT: FrontendAnnotationKind

• QAMOMILE_TENSOR: FrontendAnnotationKind

• QAMOMILE_TUPLE: FrontendAnnotationKind

• QAMOMILE_UINT: FrontendAnnotationKind

• QAMOMILE_VECTOR: FrontendAnnotationKind

Hamiltonian [source]¶

class Hamiltonian(_message.Message)

Constructor¶

def __init__(
    self,
    terms: _Optional[_Iterable[_Union[HamiltonianTerm, _Mapping]]] = ...,
    constant: _Optional[_Union[Number, _Mapping]] = ...,
    num_qubits: _Optional[int] = ...,
) -> None

Attributes¶

• CONSTANT_FIELD_NUMBER: int

• NUM_QUBITS_FIELD_NUMBER: int

• TERMS_FIELD_NUMBER: int

• constant: Number

• num_qubits: int

• terms: _containers.RepeatedCompositeFieldContainer[HamiltonianTerm]

HamiltonianTerm [source]¶

class HamiltonianTerm(_message.Message)

Constructor¶

def __init__(
    self,
    operators: _Optional[_Iterable[_Union[PauliOperator, _Mapping]]] = ...,
    coefficient: _Optional[_Union[Number, _Mapping]] = ...,
) -> None

Attributes¶

• COEFFICIENT_FIELD_NUMBER: int

• OPERATORS_FIELD_NUMBER: int

• coefficient: Number

• operators: _containers.RepeatedCompositeFieldContainer[PauliOperator]

IntegerOrReference [source]¶

class IntegerOrReference(_message.Message)

Constructor¶

def __init__(
    self,
    integer: _Optional[_Union[BigInteger, _Mapping]] = ...,
    value_ref: _Optional[str] = ...,
) -> None

Attributes¶

• INTEGER_FIELD_NUMBER: int

• VALUE_REF_FIELD_NUMBER: int

• integer: BigInteger

• value_ref: str

KernelParameter [source]¶

class KernelParameter(_message.Message)

Constructor¶

def __init__(
    self,
    name: _Optional[str] = ...,
    type: _Optional[_Union[KernelType, _Mapping]] = ...,
    kind: _Optional[_Union[ParameterKind, str]] = ...,
    has_default: bool = ...,
    default: _Optional[_Union[Payload, _Mapping]] = ...,
    differentiable: bool = ...,
    static_binding_type: _Optional[str] = ...,
) -> None

Attributes¶

• DEFAULT_FIELD_NUMBER: int

• DIFFERENTIABLE_FIELD_NUMBER: int

• HAS_DEFAULT_FIELD_NUMBER: int

• KIND_FIELD_NUMBER: int

• NAME_FIELD_NUMBER: int

• STATIC_BINDING_TYPE_FIELD_NUMBER: int

• TYPE_FIELD_NUMBER: int

• default: Payload

• differentiable: bool

• has_default: bool

• kind: ParameterKind

• name: str

• static_binding_type: str

• type: KernelType

KernelType [source]¶

class KernelType(_message.Message)

Constructor¶

def __init__(
    self,
    value_type: _Optional[_Union[ValueType, _Mapping]] = ...,
    ndim: _Optional[int] = ...,
    annotation: _Optional[_Union[FrontendAnnotation, _Mapping]] = ...,
) -> None

Attributes¶

• ANNOTATION_FIELD_NUMBER: int

• NDIM_FIELD_NUMBER: int

• VALUE_TYPE_FIELD_NUMBER: int

• annotation: FrontendAnnotation

• ndim: int

• value_type: ValueType

LoopCarriedRebind [source]¶

class LoopCarriedRebind(_message.Message)

Constructor¶

def __init__(
    self,
    var_name: _Optional[str] = ...,
    before_ref: _Optional[str] = ...,
    after_ref: _Optional[str] = ...,
    before_synthesized: bool = ...,
) -> None

Attributes¶

• AFTER_REF_FIELD_NUMBER: int

• BEFORE_REF_FIELD_NUMBER: int

• BEFORE_SYNTHESIZED_FIELD_NUMBER: int

• VAR_NAME_FIELD_NUMBER: int

• after_ref: str

• before_ref: str

• before_synthesized: bool

• var_name: str

NamedReference [source]¶

class NamedReference(_message.Message)

Constructor¶

def __init__(self, name: _Optional[str] = ..., value_ref: _Optional[str] = ...) -> None

Attributes¶

• NAME_FIELD_NUMBER: int

• VALUE_REF_FIELD_NUMBER: int

• name: str

• value_ref: str

NullValue [source]¶

class NullValue(_message.Message)

Constructor¶

def __init__(self) -> None

Number [source]¶

class Number(_message.Message)

Constructor¶

def __init__(
    self,
    integer: _Optional[_Union[BigInteger, _Mapping]] = ...,
    floating: _Optional[_Union[Float64, _Mapping]] = ...,
    complex: _Optional[_Union[Complex64, _Mapping]] = ...,
) -> None

Attributes¶

• COMPLEX_FIELD_NUMBER: int

• FLOATING_FIELD_NUMBER: int

• INTEGER_FIELD_NUMBER: int

• complex: Complex64

• floating: Float64

• integer: BigInteger

NumpyValue [source]¶

class NumpyValue(_message.Message)

Constructor¶

def __init__(
    self,
    dtype: _Optional[str] = ...,
    shape: _Optional[_Iterable[int]] = ...,
    data: _Optional[bytes] = ...,
) -> None

Attributes¶

• DATA_FIELD_NUMBER: int

• DTYPE_FIELD_NUMBER: int

• SHAPE_FIELD_NUMBER: int

• data: bytes

• dtype: str

• shape: _containers.RepeatedScalarFieldContainer[int]

Operation [source]¶

class Operation(_message.Message)

Constructor¶

def __init__(
    self,
    operation_type: _Optional[_Union[OperationType, str]] = ...,
    operand_refs: _Optional[_Iterable[str]] = ...,
    result_refs: _Optional[_Iterable[str]] = ...,
    gate_type: _Optional[str] = ...,
    axis: _Optional[str] = ...,
    num_bits: _Optional[int] = ...,
    int_bits: _Optional[int] = ...,
    key_arity: _Optional[int] = ...,
    source_type: _Optional[_Union[ValueType, _Mapping]] = ...,
    target_type: _Optional[_Union[ValueType, _Mapping]] = ...,
    qubit_mapping: _Optional[_Iterable[str]] = ...,
    expression_kind: _Optional[str] = ...,
    loop_var: _Optional[str] = ...,
    loop_var_value_ref: _Optional[str] = ...,
    key_vars: _Optional[_Iterable[str]] = ...,
    value_var: _Optional[str] = ...,
    key_is_vector: bool = ...,
    key_var_value_refs: _Optional[_Iterable[str]] = ...,
    has_key_var_value_refs: bool = ...,
    value_var_value_ref: _Optional[str] = ...,
    max_iterations: _Optional[int] = ...,
    loop_carried_rebinds: _Optional[_Iterable[_Union[LoopCarriedRebind, _Mapping]]] = ...,
    region_args: _Optional[_Iterable[_Union[RegionArg, _Mapping]]] = ...,
    body: _Optional[_Iterable[_Union[Operation, _Mapping]]] = ...,
    true_body: _Optional[_Iterable[_Union[Operation, _Mapping]]] = ...,
    false_body: _Optional[_Iterable[_Union[Operation, _Mapping]]] = ...,
    true_yield_refs: _Optional[_Iterable[str]] = ...,
    false_yield_refs: _Optional[_Iterable[str]] = ...,
    branch_rebinds: _Optional[_Iterable[_Union[BranchRebind, _Mapping]]] = ...,
    capture_refs: _Optional[_Iterable[str]] = ...,
    true_capture_refs: _Optional[_Iterable[str]] = ...,
    false_capture_refs: _Optional[_Iterable[str]] = ...,
    num_controls: _Optional[int] = ...,
    num_controls_ref: _Optional[str] = ...,
    power: _Optional[_Union[IntegerOrReference, _Mapping]] = ...,
    control_index_refs: _Optional[_Iterable[str]] = ...,
    has_control_index_refs: bool = ...,
    num_control_args: _Optional[int] = ...,
    unitary_block: _Optional[_Union[Block, _Mapping]] = ...,
    callable_ref: _Optional[_Union[CallableRef, _Mapping]] = ...,
    callable_attrs: _Optional[_Union[Payload, _Mapping]] = ...,
    control_value: _Optional[_Union[BigInteger, _Mapping]] = ...,
    target: _Optional[_Union[CallableRef, _Mapping]] = ...,
    transform: _Optional[str] = ...,
    attrs: _Optional[_Union[Payload, _Mapping]] = ...,
    definition_ref: _Optional[str] = ...,
    num_control_qubits: _Optional[int] = ...,
    num_target_qubits: _Optional[int] = ...,
    custom_name: _Optional[str] = ...,
    source_block: _Optional[_Union[Block, _Mapping]] = ...,
    implementation_block: _Optional[_Union[Block, _Mapping]] = ...,
    num_index_qubits: _Optional[int] = ...,
    case_blocks: _Optional[_Iterable[_Union[Block, _Mapping]]] = ...,
    num_index_qubits_ref: _Optional[str] = ...,
    num_index_args: _Optional[int] = ...,
) -> None

Attributes¶

• ATTRS_FIELD_NUMBER: int

• AXIS_FIELD_NUMBER: int

• BODY_FIELD_NUMBER: int

• BRANCH_REBINDS_FIELD_NUMBER: int

• CALLABLE_ATTRS_FIELD_NUMBER: int

• CALLABLE_REF_FIELD_NUMBER: int

• CAPTURE_REFS_FIELD_NUMBER: int

• CASE_BLOCKS_FIELD_NUMBER: int

• CONTROL_INDEX_REFS_FIELD_NUMBER: int

• CONTROL_VALUE_FIELD_NUMBER: int

• CUSTOM_NAME_FIELD_NUMBER: int

• DEFINITION_REF_FIELD_NUMBER: int

• EXPRESSION_KIND_FIELD_NUMBER: int

• FALSE_BODY_FIELD_NUMBER: int

• FALSE_CAPTURE_REFS_FIELD_NUMBER: int

• FALSE_YIELD_REFS_FIELD_NUMBER: int

• GATE_TYPE_FIELD_NUMBER: int

• HAS_CONTROL_INDEX_REFS_FIELD_NUMBER: int

• HAS_KEY_VAR_VALUE_REFS_FIELD_NUMBER: int

• IMPLEMENTATION_BLOCK_FIELD_NUMBER: int

• INT_BITS_FIELD_NUMBER: int

• KEY_ARITY_FIELD_NUMBER: int

• KEY_IS_VECTOR_FIELD_NUMBER: int

• KEY_VARS_FIELD_NUMBER: int

• KEY_VAR_VALUE_REFS_FIELD_NUMBER: int

• LOOP_CARRIED_REBINDS_FIELD_NUMBER: int

• LOOP_VAR_FIELD_NUMBER: int

• LOOP_VAR_VALUE_REF_FIELD_NUMBER: int

• MAX_ITERATIONS_FIELD_NUMBER: int

• NUM_BITS_FIELD_NUMBER: int

• NUM_CONTROLS_FIELD_NUMBER: int

• NUM_CONTROLS_REF_FIELD_NUMBER: int

• NUM_CONTROL_ARGS_FIELD_NUMBER: int

• NUM_CONTROL_QUBITS_FIELD_NUMBER: int

• NUM_INDEX_ARGS_FIELD_NUMBER: int

• NUM_INDEX_QUBITS_FIELD_NUMBER: int

• NUM_INDEX_QUBITS_REF_FIELD_NUMBER: int

• NUM_TARGET_QUBITS_FIELD_NUMBER: int

• OPERAND_REFS_FIELD_NUMBER: int

• OPERATION_TYPE_FIELD_NUMBER: int

• POWER_FIELD_NUMBER: int

• QUBIT_MAPPING_FIELD_NUMBER: int

• REGION_ARGS_FIELD_NUMBER: int

• RESULT_REFS_FIELD_NUMBER: int

• SOURCE_BLOCK_FIELD_NUMBER: int

• SOURCE_TYPE_FIELD_NUMBER: int

• TARGET_FIELD_NUMBER: int

• TARGET_TYPE_FIELD_NUMBER: int

• TRANSFORM_FIELD_NUMBER: int

• TRUE_BODY_FIELD_NUMBER: int

• TRUE_CAPTURE_REFS_FIELD_NUMBER: int

• TRUE_YIELD_REFS_FIELD_NUMBER: int

• UNITARY_BLOCK_FIELD_NUMBER: int

• VALUE_VAR_FIELD_NUMBER: int

• VALUE_VAR_VALUE_REF_FIELD_NUMBER: int

• attrs: Payload

• axis: str

• body: _containers.RepeatedCompositeFieldContainer[Operation]

• branch_rebinds: _containers.RepeatedCompositeFieldContainer[BranchRebind]

• callable_attrs: Payload

• callable_ref: CallableRef

• capture_refs: _containers.RepeatedScalarFieldContainer[str]

• case_blocks: _containers.RepeatedCompositeFieldContainer[Block]

• control_index_refs: _containers.RepeatedScalarFieldContainer[str]

• control_value: BigInteger

• custom_name: str

• definition_ref: str

• expression_kind: str

• false_body: _containers.RepeatedCompositeFieldContainer[Operation]

• false_capture_refs: _containers.RepeatedScalarFieldContainer[str]

• false_yield_refs: _containers.RepeatedScalarFieldContainer[str]

• gate_type: str

• has_control_index_refs: bool

• has_key_var_value_refs: bool

• implementation_block: Block

• int_bits: int

• key_arity: int

• key_is_vector: bool

• key_var_value_refs: _containers.RepeatedScalarFieldContainer[str]

• key_vars: _containers.RepeatedScalarFieldContainer[str]

• loop_carried_rebinds: _containers.RepeatedCompositeFieldContainer[LoopCarriedRebind]

• loop_var: str

• loop_var_value_ref: str

• max_iterations: int

• num_bits: int

• num_control_args: int

• num_control_qubits: int

• num_controls: int

• num_controls_ref: str

• num_index_args: int

• num_index_qubits: int

• num_index_qubits_ref: str

• num_target_qubits: int

• operand_refs: _containers.RepeatedScalarFieldContainer[str]

• operation_type: OperationType

• power: IntegerOrReference

• qubit_mapping: _containers.RepeatedScalarFieldContainer[str]

• region_args: _containers.RepeatedCompositeFieldContainer[RegionArg]

• result_refs: _containers.RepeatedScalarFieldContainer[str]

• source_block: Block

• source_type: ValueType

• target: CallableRef

• target_type: ValueType

• transform: str

• true_body: _containers.RepeatedCompositeFieldContainer[Operation]

• true_capture_refs: _containers.RepeatedScalarFieldContainer[str]

• true_yield_refs: _containers.RepeatedScalarFieldContainer[str]

• unitary_block: Block

• value_var: str

• value_var_value_ref: str

OperationType [source]¶

class OperationType(int)

Attributes¶

• BIN_OPERATION: OperationType

• CAST_OPERATION: OperationType

• CINIT_OPERATION: OperationType

• COMP_OPERATION: OperationType

• CONCRETE_CONTROLLED_OPERATION: OperationType

• COND_OPERATION: OperationType

• DECODE_QFIXED_OPERATION: OperationType

• DICT_GET_ITEM_OPERATION: OperationType

• EXPVAL_OPERATION: OperationType

• FOR_ITEMS_OPERATION: OperationType

• FOR_OPERATION: OperationType

• GATE_OPERATION: OperationType

• GLOBAL_PHASE_OPERATION: OperationType

• IF_OPERATION: OperationType

• INVERSE_BLOCK_OPERATION: OperationType

• INVOKE_OPERATION: OperationType

• MEASURE_OPERATION: OperationType

• MEASURE_QFIXED_OPERATION: OperationType

• MEASURE_VECTOR_OPERATION: OperationType

• NOT_OPERATION: OperationType

• OPERATION_TYPE_UNSPECIFIED: OperationType

• PAULI_EVOLVE_OPERATION: OperationType

• PROJECT_OPERATION: OperationType

• QINIT_OPERATION: OperationType

• RELEASE_SLICE_VIEW_OPERATION: OperationType

• RESET_OPERATION: OperationType

• RETURN_OPERATION: OperationType

• RETURN_QUANTUM_ARRAY_ELEMENT_OPERATION: OperationType

• RUNTIME_CLASSICAL_OPERATION: OperationType

• SELECT_OPERATION: OperationType

• SLICE_ARRAY_OPERATION: OperationType

• STORE_ARRAY_ELEMENT_OPERATION: OperationType

• SYMBOLIC_CONTROLLED_OPERATION: OperationType

• UNARY_MATH_OPERATION: OperationType

• WHILE_OPERATION: OperationType

OptionalInteger [source]¶

class OptionalInteger(_message.Message)

Constructor¶

def __init__(self, value: _Optional[int] = ...) -> None

Attributes¶

• VALUE_FIELD_NUMBER: int

• value: int

OptionalString [source]¶

class OptionalString(_message.Message)

Constructor¶

def __init__(self, value: _Optional[str] = ...) -> None

Attributes¶

• VALUE_FIELD_NUMBER: int

• value: str

ParamHint [source]¶

class ParamHint(_message.Message)

Constructor¶

def __init__(
    self,
    present: bool = ...,
    name: _Optional[str] = ...,
    type: _Optional[_Union[ValueType, _Mapping]] = ...,
) -> None

Attributes¶

• NAME_FIELD_NUMBER: int

• PRESENT_FIELD_NUMBER: int

• TYPE_FIELD_NUMBER: int

• name: str

• present: bool

• type: ValueType

ParameterKind [source]¶

class ParameterKind(int)

Attributes¶

• KEYWORD_ONLY: ParameterKind

• PARAMETER_KIND_UNSPECIFIED: ParameterKind

• POSITIONAL_ONLY: ParameterKind

• POSITIONAL_OR_KEYWORD: ParameterKind

• VAR_KEYWORD: ParameterKind

• VAR_POSITIONAL: ParameterKind

PauliOperator [source]¶

class PauliOperator(_message.Message)

Constructor¶

def __init__(self, pauli: _Optional[str] = ..., index: _Optional[int] = ...) -> None

Attributes¶

• INDEX_FIELD_NUMBER: int

• PAULI_FIELD_NUMBER: int

• index: int

• pauli: str

Payload [source]¶

class Payload(_message.Message)

Constructor¶

def __init__(
    self,
    null_value: _Optional[_Union[NullValue, _Mapping]] = ...,
    bool_value: bool = ...,
    integer_value: _Optional[_Union[BigInteger, _Mapping]] = ...,
    float_value: _Optional[_Union[Float64, _Mapping]] = ...,
    string_value: _Optional[str] = ...,
    bytes_value: _Optional[bytes] = ...,
    list_value: _Optional[_Union[PayloadList, _Mapping]] = ...,
    tuple_value: _Optional[_Union[PayloadList, _Mapping]] = ...,
    set_value: _Optional[_Union[PayloadList, _Mapping]] = ...,
    frozenset_value: _Optional[_Union[PayloadList, _Mapping]] = ...,
    map_value: _Optional[_Union[PayloadMap, _Mapping]] = ...,
    complex_value: _Optional[_Union[Complex64, _Mapping]] = ...,
    numpy_array: _Optional[_Union[NumpyValue, _Mapping]] = ...,
    numpy_scalar: _Optional[_Union[NumpyValue, _Mapping]] = ...,
    hamiltonian: _Optional[_Union[Hamiltonian, _Mapping]] = ...,
) -> None

Attributes¶

• BOOL_VALUE_FIELD_NUMBER: int

• BYTES_VALUE_FIELD_NUMBER: int

• COMPLEX_VALUE_FIELD_NUMBER: int

• FLOAT_VALUE_FIELD_NUMBER: int

• FROZENSET_VALUE_FIELD_NUMBER: int

• HAMILTONIAN_FIELD_NUMBER: int

• INTEGER_VALUE_FIELD_NUMBER: int

• LIST_VALUE_FIELD_NUMBER: int

• MAP_VALUE_FIELD_NUMBER: int

• NULL_VALUE_FIELD_NUMBER: int

• NUMPY_ARRAY_FIELD_NUMBER: int

• NUMPY_SCALAR_FIELD_NUMBER: int

• SET_VALUE_FIELD_NUMBER: int

• STRING_VALUE_FIELD_NUMBER: int

• TUPLE_VALUE_FIELD_NUMBER: int

• bool_value: bool

• bytes_value: bytes

• complex_value: Complex64

• float_value: Float64

• frozenset_value: PayloadList

• hamiltonian: Hamiltonian

• integer_value: BigInteger

• list_value: PayloadList

• map_value: PayloadMap

• null_value: NullValue

• numpy_array: NumpyValue

• numpy_scalar: NumpyValue

• set_value: PayloadList

• string_value: str

• tuple_value: PayloadList

PayloadEntry [source]¶

class PayloadEntry(_message.Message)

Constructor¶

def __init__(
    self,
    key: _Optional[_Union[Payload, _Mapping]] = ...,
    value: _Optional[_Union[Payload, _Mapping]] = ...,
) -> None

Attributes¶

• KEY_FIELD_NUMBER: int

• VALUE_FIELD_NUMBER: int

• key: Payload

• value: Payload

PayloadList [source]¶

class PayloadList(_message.Message)

Constructor¶

def __init__(self, items: _Optional[_Iterable[_Union[Payload, _Mapping]]] = ...) -> None

Attributes¶

• ITEMS_FIELD_NUMBER: int

• items: _containers.RepeatedCompositeFieldContainer[Payload]

PayloadMap [source]¶

class PayloadMap(_message.Message)

Constructor¶

def __init__(
    self,
    entries: _Optional[_Iterable[_Union[PayloadEntry, _Mapping]]] = ...,
) -> None

Attributes¶

• ENTRIES_FIELD_NUMBER: int

• entries: _containers.RepeatedCompositeFieldContainer[PayloadEntry]

QFixedMetadata [source]¶

class QFixedMetadata(_message.Message)

Constructor¶

def __init__(
    self,
    qubit_uuids: _Optional[_Iterable[str]] = ...,
    num_bits: _Optional[int] = ...,
    int_bits: _Optional[int] = ...,
) -> None

Attributes¶

• INT_BITS_FIELD_NUMBER: int

• NUM_BITS_FIELD_NUMBER: int

• QUBIT_UUIDS_FIELD_NUMBER: int

• int_bits: int

• num_bits: int

• qubit_uuids: _containers.RepeatedScalarFieldContainer[str]

QKernel [source]¶

class QKernel(_message.Message)

Constructor¶

def __init__(
    self,
    qamomile_version: _Optional[str] = ...,
    name: _Optional[str] = ...,
    parameters: _Optional[_Iterable[_Union[KernelParameter, _Mapping]]] = ...,
    results: _Optional[_Iterable[_Union[KernelType, _Mapping]]] = ...,
    body: _Optional[_Union[Block, _Mapping]] = ...,
    value_table: _Optional[_Iterable[_Union[ValueNode, _Mapping]]] = ...,
    callable_table: _Optional[_Iterable[_Union[CallableEntry, _Mapping]]] = ...,
    callable_definition: _Optional[_Union[CallableDefinition, _Mapping]] = ...,
    return_annotation: _Optional[_Union[FrontendAnnotation, _Mapping]] = ...,
) -> None

Attributes¶

• BODY_FIELD_NUMBER: int

• CALLABLE_DEFINITION_FIELD_NUMBER: int

• CALLABLE_TABLE_FIELD_NUMBER: int

• NAME_FIELD_NUMBER: int

• PARAMETERS_FIELD_NUMBER: int

• QAMOMILE_VERSION_FIELD_NUMBER: int

• RESULTS_FIELD_NUMBER: int

• RETURN_ANNOTATION_FIELD_NUMBER: int

• VALUE_TABLE_FIELD_NUMBER: int

• body: Block

• callable_definition: CallableDefinition

• callable_table: _containers.RepeatedCompositeFieldContainer[CallableEntry]

• name: str

• parameters: _containers.RepeatedCompositeFieldContainer[KernelParameter]

• qamomile_version: str

• results: _containers.RepeatedCompositeFieldContainer[KernelType]

• return_annotation: FrontendAnnotation

• value_table: _containers.RepeatedCompositeFieldContainer[ValueNode]

ReferencePair [source]¶

class ReferencePair(_message.Message)

Constructor¶

def __init__(self, key_ref: _Optional[str] = ..., value_ref: _Optional[str] = ...) -> None

Attributes¶

• KEY_REF_FIELD_NUMBER: int

• VALUE_REF_FIELD_NUMBER: int

• key_ref: str

• value_ref: str

RegionArg [source]¶

class RegionArg(_message.Message)

Constructor¶

def __init__(
    self,
    var_name: _Optional[str] = ...,
    init_ref: _Optional[str] = ...,
    block_arg_ref: _Optional[str] = ...,
    yielded_ref: _Optional[str] = ...,
    result_ref: _Optional[str] = ...,
) -> None

Attributes¶

• BLOCK_ARG_REF_FIELD_NUMBER: int

• INIT_REF_FIELD_NUMBER: int

• RESULT_REF_FIELD_NUMBER: int

• VAR_NAME_FIELD_NUMBER: int

• YIELDED_REF_FIELD_NUMBER: int

• block_arg_ref: str

• init_ref: str

• result_ref: str

• var_name: str

• yielded_ref: str

RegisterWidth [source]¶

class RegisterWidth(_message.Message)

Constructor¶

def __init__(self, concrete: _Optional[int] = ..., value_ref: _Optional[str] = ...) -> None

Attributes¶

• CONCRETE_FIELD_NUMBER: int

• VALUE_REF_FIELD_NUMBER: int

• concrete: int

• value_ref: str

ScalarMetadata [source]¶

class ScalarMetadata(_message.Message)

Constructor¶

def __init__(
    self,
    const_value: _Optional[_Union[Payload, _Mapping]] = ...,
    parameter_name: _Optional[str] = ...,
) -> None

Attributes¶

• CONST_VALUE_FIELD_NUMBER: int

• PARAMETER_NAME_FIELD_NUMBER: int

• const_value: Payload

• parameter_name: str

Signature [source]¶

class Signature(_message.Message)

Constructor¶

def __init__(
    self,
    operands: _Optional[_Iterable[_Union[ParamHint, _Mapping]]] = ...,
    results: _Optional[_Iterable[_Union[ParamHint, _Mapping]]] = ...,
) -> None

Attributes¶

• OPERANDS_FIELD_NUMBER: int

• RESULTS_FIELD_NUMBER: int

• operands: _containers.RepeatedCompositeFieldContainer[ParamHint]

• results: _containers.RepeatedCompositeFieldContainer[ParamHint]

StaticBindingField [source]¶

class StaticBindingField(_message.Message)

Constructor¶

def __init__(self, name: _Optional[str] = ..., value_ref: _Optional[str] = ...) -> None

Attributes¶

• NAME_FIELD_NUMBER: int

• VALUE_REF_FIELD_NUMBER: int

• name: str

• value_ref: str

StaticBindingSlot [source]¶

class StaticBindingSlot(_message.Message)

Constructor¶

def __init__(
    self,
    name: _Optional[str] = ...,
    type_key: _Optional[str] = ...,
    fields: _Optional[_Iterable[_Union[StaticBindingField, _Mapping]]] = ...,
) -> None

Attributes¶

• FIELDS_FIELD_NUMBER: int

• NAME_FIELD_NUMBER: int

• TYPE_KEY_FIELD_NUMBER: int

• fields: _containers.RepeatedCompositeFieldContainer[StaticBindingField]

• name: str

• type_key: str

ValueKind [source]¶

class ValueKind(int)

Attributes¶

• ARRAY_VALUE: ValueKind

• DICT_VALUE: ValueKind

• TUPLE_VALUE: ValueKind

• VALUE: ValueKind

• VALUE_KIND_UNSPECIFIED: ValueKind

ValueMetadata [source]¶

class ValueMetadata(_message.Message)

Constructor¶

def __init__(
    self,
    scalar: _Optional[_Union[ScalarMetadata, _Mapping]] = ...,
    cast: _Optional[_Union[CastMetadata, _Mapping]] = ...,
    qfixed: _Optional[_Union[QFixedMetadata, _Mapping]] = ...,
    array_runtime: _Optional[_Union[ArrayRuntimeMetadata, _Mapping]] = ...,
    dict_runtime: _Optional[_Union[DictRuntimeMetadata, _Mapping]] = ...,
) -> None

Attributes¶

• ARRAY_RUNTIME_FIELD_NUMBER: int

• CAST_FIELD_NUMBER: int

• DICT_RUNTIME_FIELD_NUMBER: int

• QFIXED_FIELD_NUMBER: int

• SCALAR_FIELD_NUMBER: int

• array_runtime: ArrayRuntimeMetadata

• cast: CastMetadata

• dict_runtime: DictRuntimeMetadata

• qfixed: QFixedMetadata

• scalar: ScalarMetadata

ValueNode [source]¶

class ValueNode(_message.Message)

Constructor¶

def __init__(
    self,
    value_kind: _Optional[_Union[ValueKind, str]] = ...,
    uuid: _Optional[str] = ...,
    logical_id: _Optional[str] = ...,
    name: _Optional[str] = ...,
    version: _Optional[int] = ...,
    value_type: _Optional[_Union[ValueType, _Mapping]] = ...,
    metadata: _Optional[_Union[ValueMetadata, _Mapping]] = ...,
    parent_array_ref: _Optional[str] = ...,
    element_index_refs: _Optional[_Iterable[str]] = ...,
    shape_refs: _Optional[_Iterable[str]] = ...,
    slice_of_ref: _Optional[str] = ...,
    slice_start_ref: _Optional[str] = ...,
    slice_step_ref: _Optional[str] = ...,
    element_refs: _Optional[_Iterable[str]] = ...,
    entry_refs: _Optional[_Iterable[_Union[ReferencePair, _Mapping]]] = ...,
) -> None

Attributes¶

• ELEMENT_INDEX_REFS_FIELD_NUMBER: int

• ELEMENT_REFS_FIELD_NUMBER: int

• ENTRY_REFS_FIELD_NUMBER: int

• LOGICAL_ID_FIELD_NUMBER: int

• METADATA_FIELD_NUMBER: int

• NAME_FIELD_NUMBER: int

• PARENT_ARRAY_REF_FIELD_NUMBER: int

• SHAPE_REFS_FIELD_NUMBER: int

• SLICE_OF_REF_FIELD_NUMBER: int

• SLICE_START_REF_FIELD_NUMBER: int

• SLICE_STEP_REF_FIELD_NUMBER: int

• UUID_FIELD_NUMBER: int

• VALUE_KIND_FIELD_NUMBER: int

• VALUE_TYPE_FIELD_NUMBER: int

• VERSION_FIELD_NUMBER: int

• element_index_refs: _containers.RepeatedScalarFieldContainer[str]

• element_refs: _containers.RepeatedScalarFieldContainer[str]

• entry_refs: _containers.RepeatedCompositeFieldContainer[ReferencePair]

• logical_id: str

• metadata: ValueMetadata

• name: str

• parent_array_ref: str

• shape_refs: _containers.RepeatedScalarFieldContainer[str]

• slice_of_ref: str

• slice_start_ref: str

• slice_step_ref: str

• uuid: str

• value_kind: ValueKind

• value_type: ValueType

• version: int

ValueType [source]¶

class ValueType(_message.Message)

Constructor¶

def __init__(
    self,
    kind: _Optional[_Union[ValueTypeKind, str]] = ...,
    element_types: _Optional[_Iterable[_Union[ValueType, _Mapping]]] = ...,
    key_type: _Optional[_Union[ValueType, _Mapping]] = ...,
    value_type: _Optional[_Union[ValueType, _Mapping]] = ...,
    integer_bits: _Optional[_Union[RegisterWidth, _Mapping]] = ...,
    fractional_bits: _Optional[_Union[RegisterWidth, _Mapping]] = ...,
    width: _Optional[_Union[RegisterWidth, _Mapping]] = ...,
) -> None

Attributes¶

• ELEMENT_TYPES_FIELD_NUMBER: int

• FRACTIONAL_BITS_FIELD_NUMBER: int

• INTEGER_BITS_FIELD_NUMBER: int

• KEY_TYPE_FIELD_NUMBER: int

• KIND_FIELD_NUMBER: int

• VALUE_TYPE_FIELD_NUMBER: int

• WIDTH_FIELD_NUMBER: int

• element_types: _containers.RepeatedCompositeFieldContainer[ValueType]

• fractional_bits: RegisterWidth

• integer_bits: RegisterWidth

• key_type: ValueType

• kind: ValueTypeKind

• value_type: ValueType

• width: RegisterWidth

ValueTypeKind [source]¶

class ValueTypeKind(int)

Attributes¶

• BIT_TYPE: ValueTypeKind

• BLOCK_TYPE: ValueTypeKind

• DICT_TYPE: ValueTypeKind

• FLOAT_TYPE: ValueTypeKind

• OBSERVABLE_TYPE: ValueTypeKind

• QFIXED_TYPE: ValueTypeKind

• QUBIT_TYPE: ValueTypeKind

• QUINT_TYPE: ValueTypeKind

• TUPLE_TYPE: ValueTypeKind

• UINT_TYPE: ValueTypeKind

• VALUE_TYPE_KIND_UNSPECIFIED: ValueTypeKind

qamomile.circuit.serialization.kernel¶

Static qkernel implementation reconstructed from serialized IR.

Overview¶

Constants¶

• ValueLike: TypeAlias = 'Value | ArrayValue | TupleValue | DictValue'

Functions¶

auto_detect_parameters [source]¶

def auto_detect_parameters(
    signature: inspect.Signature,
    input_types: dict[str, type],
    kwargs: dict[str, Any],
) -> list[str]

Detect unbound classical arguments that should be runtime parameters.

Parameters:

Returns:

list[str] — list[str]: Parameter names that should remain symbolic.

build_param_slots [source]¶

def build_param_slots(
    signature: inspect.Signature,
    input_types: dict[str, Any],
    *,
    parameters: list[str] | None = None,
    kwargs: dict[str, Any] | None = None,
    qubit_sizes: dict[str, int] | None = None,
    bind_defaults: bool,
) -> tuple[ParamSlot, ...]

Build a ParamSlot tuple for the classical arguments of a kernel.

Mirrors the argument-classification logic in qkernel_build.create_traced_block so the resulting slot list reflects the same decisions that drive symbolic-vs-bound input creation. Classical scalar / array arguments are always included; a Dict argument is included only when it is a runtime parameter (its slot carries a DictType). Pure-quantum arguments, Tuple arguments, and compile-time-bound Dict arguments are excluded and live in Block.input_values instead.

Parameters:

Returns:

tuple[ParamSlot, ...] — tuple[ParamSlot, ...]: One slot per classical argument, in the order they appear in signature.parameters.

Raises:

• TypeError — If a non-static classical annotation cannot be represented by an IR parameter type.

build_specialized_block [source]¶

def build_specialized_block(
    kernel: Any,
    *,
    parameters: list[str],
    bindings: dict[str, Any],
    qubit_sizes: dict[str, int],
) -> Block

Trace a specialized sub-block for a call site.

Parameters:

Returns:

Block — Specialized hierarchical block ready to be invoked from the Block — caller’s trace.

create_bound_input [source]¶

def create_bound_input(param_type: Any, name: str, value: Any) -> Handle

Create a frontend handle for a compile-time-bound value.

Parameters:

Returns:

Handle — Frontend handle carrying constant or runtime metadata.

Raises:

• TypeError — If param_type cannot be bound from value.

get_array_element_type [source]¶

def get_array_element_type(param_type: Any) -> type | None

Extract the element type from an array type annotation.

Parameters:

Returns:

type | None — type | None: Element type when present, otherwise None.

get_static_binding_by_annotation [source]¶

def get_static_binding_by_annotation(annotation: Any) -> StaticBindingSpec | None

Return the adapter registered for a qkernel annotation.

Parameters:

Returns:

StaticBindingSpec | None — StaticBindingSpec | None: Registered adapter, or None for an StaticBindingSpec | None — ordinary qkernel argument.

get_static_binding_by_type_key [source]¶

def get_static_binding_by_type_key(type_key: str) -> StaticBindingSpec

Return the adapter registered under a stable serialization key.

Parameters:

Returns:

StaticBindingSpec — Matching registered adapter.

Raises:

• KeyError — If the installed Qamomile distribution does not know the key.

is_array_type [source]¶

def is_array_type(t: Any) -> bool

Check if type is a Vector, Matrix, or Tensor subclass.

materialize_static_field [source]¶

def materialize_static_field(spec: StaticBindingSpec, binding: Any, field_name: str) -> int | float

Extract and validate one registered scalar field.

Parameters:

Returns:

int | float — int | float: Scalar value suitable for IR constant metadata.

Raises:

• KeyError — If field_name is not registered.

• TypeError — If the extracted value does not match its handle type.

• ValueError — If a UInt field is negative.

materialize_static_member [source]¶

def materialize_static_member(
    spec: StaticBindingSpec,
    binding: Any,
    member_name: str,
) -> tuple[Any, StaticBindingMemberSpec]

Extract one registered qkernel-like member.

Parameters:

Returns:

Any — tuple[Any, StaticBindingMemberSpec]: Concrete member and its adapter StaticBindingMemberSpec — contract.

Raises:

• KeyError — If member_name is not registered.

• TypeError — If the getter does not return a qkernel-like object.

qkernel_callable_def [source]¶

def qkernel_callable_def(kernel: Any, block: Block) -> CallableDef

Build the inline-by-default callable definition for a qkernel block.

Parameters:

Returns:

CallableDef — Compiler-facing definition for the qkernel.

validate_bindings_parameters_disjoint [source]¶

def validate_bindings_parameters_disjoint(bindings: dict[str, Any] | None, parameters: list[str] | None) -> None

Enforce the project rule that bindings and parameters are disjoint.

A kernel argument name must be resolved exactly one way: compile-time bound (in bindings, baked into the emitted circuit) or runtime symbolic (in parameters, surviving as a backend parameter). Listing the same name in both is ambiguous and historically caused silent miscompilation — the binding won the resolution race and the runtime parameter was silently dropped from the emitted circuit (see #354). This is the single shared checker so the rule is enforced identically at every entry point (QKernel.build / Transpiler.to_block / Transpiler.emit / Transpiler.transpile), not only in the top-level transpile wrapper.

Parameters:

Returns:

None — None

Raises:

• ValueError — If any name appears in both bindings and parameters.

Example:

>>> validate_bindings_parameters_disjoint({"theta": 0.5}, ["phi"])
>>> validate_bindings_parameters_disjoint({"theta": 0.5}, ["theta"])
Traceback (most recent call last):
    ...
ValueError: Parameter name(s) ['theta'] appear in both ...

validate_kwargs [source]¶

def validate_kwargs(
    signature: inspect.Signature,
    input_types: dict[str, type],
    parameters: list[str],
    kwargs: dict[str, Any],
) -> None

Validate compile-time bindings for QKernel.build.

Parameters:

Raises:

• ValueError — If an unknown argument is supplied, or if a required non-parameter classical argument is missing.

• TypeError — If a static binding has a default value or a supplied object does not match its registered annotation.

validate_parameters [source]¶

def validate_parameters(input_types: dict[str, type], parameters: list[str]) -> None

Validate the explicit runtime parameter list.

Parameters:

Raises:

• ValueError — If a requested name is not a qkernel parameter.

• TypeError — If a requested parameter type cannot stay symbolic.

validate_static_binding [source]¶

def validate_static_binding(annotation: Any, name: str, value: Any) -> Any

Validate one concrete compile-time object binding.

Parameters:

Returns:

Any — The validated binding value.

Raises:

• TypeError — If the annotation is not registered or the value has the wrong concrete type.

validate_static_binding_slot [source]¶

def validate_static_binding_slot(spec: StaticBindingSpec, slot: StaticBindingSlot) -> None

Validate a serialized IR slot against its installed adapter.

Parameters:

Raises:

• ValueError — If the type key, projected field names, or field types do not exactly match the registered adapter.

Classes¶

ArrayValue [source]¶

class ArrayValue(Value[T])

An array of typed IR values.

When slice_of is set, this array is a strided view over another array. Element accesses on a sliced ArrayValue resolve to physical slots on the root parent via the affine map parent_index = slice_start + slice_step * view_local_index, applied recursively along slice_of chains. The emit-time resolver walks this chain to produce the final qubit index; passes that substitute or clone values must treat slice_of / slice_start / slice_step as Value references that need to track through the same mapping as parent_array.

Constructor¶

def __init__(
    self,
    type: T,
    name: str,
    version: int = 0,
    metadata: ValueMetadata = ValueMetadata(),
    uuid: str = (lambda: str(uuid.uuid4()))(),
    logical_id: str = (lambda: str(uuid.uuid4()))(),
    parent_array: ArrayValue | None = None,
    element_indices: tuple[Value, ...] = (),
    shape: tuple[Value, ...] = tuple(),
    slice_of: 'ArrayValue | None' = None,
    slice_start: 'Value | None' = None,
    slice_step: 'Value | None' = None,
) -> None

Attributes¶

• logical_id: str

• metadata: ValueMetadata

• name: str

• shape: tuple[Value, ...]

• slice_of: ‘ArrayValue | None’

• slice_start: ‘Value | None’

• slice_step: ‘Value | None’

• type: T

• uuid: str

Methods¶

is_slice¶

def is_slice(self) -> bool

Return True if this array is a strided view of another array.

Returns:

bool — True iff slice_of is non-None.

next_version¶

def next_version(self) -> ArrayValue[T]

Block [source]¶

class Block

Unified block representation for all pipeline stages.

Replaces the older traced and callable IR wrappers with a single structure. The kind field indicates which pipeline stage this block is at.

Constructor¶

def __init__(
    self,
    name: str = '',
    label_args: list[str] = list(),
    input_values: list[ValueLike] = list(),
    output_values: list[ValueLike] = list(),
    output_names: list[str] = list(),
    operations: list['Operation'] = list(),
    kind: BlockKind = BlockKind.HIERARCHICAL,
    parameters: dict[str, Value] = dict(),
    param_slots: tuple[ParamSlot, ...] = tuple(),
    static_bindings: tuple[StaticBindingSlot, ...] = tuple(),
) -> None

Attributes¶

• effects: ‘KernelEffect’ Return lazily cached semantic effects for this block.

• input_values: list[ValueLike]

• kind: BlockKind

• label_args: list[str]

• measurement_result_indices: frozenset[int] Return public output positions derived from measurement.

• name: str

• operations: list[‘Operation’]

• output_names: list[str]

• output_values: list[ValueLike]

• param_slots: tuple[ParamSlot, ...]

• parameters: dict[str, Value]

• static_bindings: tuple[StaticBindingSlot, ...]

Methods¶

call¶

def call(self, **kwargs: ValueLike = {}) -> 'InvokeOperation'

Create an inline callable invocation against this block.

Parameters:

Returns:

'InvokeOperation' — Inline-policy invocation whose callable definition points at this block.

Raises:

• KeyError — If a required label in self.label_args is missing from kwargs.

is_affine¶

def is_affine(self) -> bool

Return whether this block has passed affine validation.

Returns:

bool — True for AFFINE and ANALYZED blocks.

unbound_parameters¶

def unbound_parameters(self) -> list[str]

Return list of unbound parameter names.

BlockKind [source]¶

class BlockKind(Enum)

Classification of block structure for pipeline stages.

Attributes¶

• AFFINE

• ANALYZED

• HIERARCHICAL

• TRACED

CInitOperation [source]¶

class CInitOperation(Operation)

Initialize the classical values (const, arguments etc)

Constructor¶

def __init__(self, operands: list[Value] = list(), results: list[Value] = list()) -> None

Attributes¶

• operation_kind: OperationKind

• signature: Signature

CallPolicy [source]¶

class CallPolicy(enum.Enum)

Describe the default lowering policy for a callable call.

Attributes¶

• INLINE

• NATIVE_FIRST

• PRESERVE_BOX

CallTransform [source]¶

class CallTransform(enum.Enum)

Describe the requested transform of a callable implementation.

Attributes¶

• CONTROLLED

• DIRECT

• INVERSE

CallableDef [source]¶

class CallableDef

Describe a compiler-facing callable definition.

Parameters:

Constructor¶

def __init__(
    self,
    ref: CallableRef,
    signature: Signature | None = None,
    body: Block | None = None,
    body_ref: CallableBodyRef | None = None,
    implementations: list[CallableImplementation] = list(),
    opaque_cost: Any | None = None,
    default_policy: CallPolicy = CallPolicy.INLINE,
    attrs: dict[str, Any] = dict(),
) -> None

Attributes¶

• attrs: dict[str, Any]

• body: Block | None

• body_ref: CallableBodyRef | None

• default_policy: CallPolicy

• implementations: list[CallableImplementation]

• opaque_cost: Any | None

• ref: CallableRef

• signature: Signature | None

Methods¶

effects_for¶

def effects_for(self, transform: CallTransform = CallTransform.DIRECT) -> 'KernelEffect'

Return cached semantic effects for one call transform.

Parameters:

Returns:

'KernelEffect' — Union of relevant implementation-body effects.

implementation_for¶

def implementation_for(
    self,
    *,
    transform: CallTransform = CallTransform.DIRECT,
    backend: str | None = None,
    strategy: str | None = None,
) -> CallableImplementation | None

Return the best matching implementation candidate.

Parameters:

Returns:

CallableImplementation | None — CallableImplementation | None: Matching implementation, if any.

measurement_result_indices_for¶

def measurement_result_indices_for(self, transform: CallTransform = CallTransform.DIRECT) -> frozenset[int]

Return measured result positions for one call transform.

Parameters:

Returns:

frozenset[int] — frozenset[int]: Result indices carrying measurement provenance.

CallableImplementation [source]¶

class CallableImplementation

Describe one implementation candidate for a callable.

Parameters:

Constructor¶

def __init__(
    self,
    transform: CallTransform = CallTransform.DIRECT,
    backend: str | None = None,
    strategy: str | None = None,
    body: Block | None = None,
    body_ref: CallableBodyRef | None = None,
    emitter: Any = None,
    attrs: dict[str, Any] = dict(),
) -> None

Attributes¶

• attrs: dict[str, Any]

• backend: str | None

• body: Block | None

• body_ref: CallableBodyRef | None

• emitter: Any

• strategy: str | None

• transform: CallTransform

CallableRef [source]¶

class CallableRef

Identify a callable independently of its Python object.

Parameters:

Constructor¶

def __init__(self, namespace: str, name: str, version: str = '1') -> None

Attributes¶

• name: str

• namespace: str

• version: str

CompositeGateType [source]¶

class CompositeGateType(enum.Enum)

Classify standard boxed quantum callables.

Attributes¶

• CUSTOM

• IQFT

• QFT

• QPE

ControlledUOperation [source]¶

class ControlledUOperation(Operation)

Base class for controlled-U operations.

Two concrete subclasses handle distinct operand layouts:

• ConcreteControlledU: Fixed num_controls: int, individual qubit operands.

• SymbolicControlledU: Symbolic num_controls: Value, vector-based control operands; optional control_indices selects a subset of the control vector to act as controls (the rest pass through).

All isinstance(op, ControlledUOperation) checks match every subclass.

Constructor¶

def __init__(
    self,
    operands: list[Value] = list(),
    results: list[Value] = list(),
    power: int | Value = 1,
    block: Block | None = None,
    num_controls: int | Value = 1,
    callable_ref: CallableRef | None = None,
    callable_attrs: dict[str, Any] = dict(),
) -> None

Attributes¶

• block: Block | None

• callable_attrs: dict[str, Any]

• callable_ref: CallableRef | None

• control_operands: list[Value] Get the control qubit values.

• is_symbolic_num_controls: bool Whether num_controls is symbolic (Value) rather than concrete.

• num_controls: int | Value

• operation_kind: OperationKind

• param_operands: list[Value] Get the controlled operation’s classical/object arguments.

• power: int | Value

• signature: Signature

• target_operands: list[Value] Get the target qubit values (arguments to U).