Skip to main contentIBM Quantum Documentation

QasmQobjInstruction

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(opens in a new tab)

Bases: object(opens in a new tab)

A class representing a single instruction in an QasmQobj Experiment.

Instantiate a new QasmQobjInstruction object.

Parameters

  • name (str(opens in a new tab)) – The name of the instruction
  • params (list(opens in a new tab)) – The list of parameters for the gate
  • qubits (list(opens in a new tab)) – A list of int representing the qubits the instruction operates on
  • register (list(opens in a new tab)) – 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(opens in a new tab)) – 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(opens in a new tab)) – 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(opens in a new tab)) – The register index of the condition
  • label (str(opens in a new tab)) – An optional label assigned to the instruction
  • mask (int(opens in a new tab)) – For a bfunc instruction the hex value which is applied as an AND to the register bits.
  • relation (str(opens in a new tab)) – Relational operator for comparing the masked register to the val kwarg. Can be either == (equals) or != (not equals).
  • val (int(opens in a new tab)) – Value to which to compare the masked register. In other words, the output of the function is (register AND mask)
  • snapshot_type (str(opens in a new tab)) – For snapshot instructions the type of snapshot to use

Methods

from_dict

classmethod from_dict(data)

Create a new QasmQobjInstruction object from a dictionary.

Parameters

data (dict(opens in a new tab)) – A dictionary for the experiment config

Returns

The object from the input dictionary.

Return type

QasmQobjInstruction

to_dict

to_dict()

Return a dictionary format representation of the Instruction.

Returns

The dictionary form of the QasmQobjInstruction.

Return type

dict(opens in a new tab)

Was this page helpful?