QasmQobjInstruction

class qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)

GitHub

Bases: object

A class representing a single instruction in an QasmQobj Experiment.

Instantiate a new QasmQobjInstruction object.

Deprecated since version 1.2

The class qiskit.qobj.qasm_qobj.QasmQobjInstruction is deprecated as of qiskit 1.2. It will be removed in the 2.0 release. The Qobj class and related functionality are part of the deprecated BackendV1 workflow, and no longer necessary for BackendV2. If a user workflow requires Qobj it likely relies on deprecated functionality and should be updated to use BackendV2.

Parameters

name (str) – The name of the instruction
params (list) – The list of parameters for the gate
qubits (list) – A list of int representing the qubits the instruction operates on
register (list) – If a measure instruction this is a list of int containing the list of register slots in which to store the measurement results (must be the same length as qubits). If a bfunc instruction this is a single int of the register slot in which to store the result.
memory (list) – If a measure instruction this is a list of int containing the list of memory slots to store the measurement results in (must be the same length as qubits). If a bfunc instruction this is a single int of the memory slot to store the boolean function result in.
condition (tuple) – A tuple of the form (int, int) where the first int is the control register and the second int is the control value if the gate has a condition.
conditional (int) – The register index of the condition
label (str) – An optional label assigned to the instruction
mask (int) – For a bfunc instruction the hex value which is applied as an AND to the register bits.
relation (str) – Relational operator for comparing the masked register to the val kwarg. Can be either == (equals) or != (not equals).
val (int) – Value to which to compare the masked register. In other words, the output of the function is (register AND mask)
snapshot_type (str) – For snapshot instructions the type of snapshot to use