# qiskit.circuit.Instruction¶

class Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)[Quellcode]

Generic quantum instruction.

Create a new instruction.

Parameter
• name (str) – instruction name

• num_qubits (int) – instruction’s qubit width

• num_clbits (int) – instruction’s clbit width

• params (list[int|float|complex|str|ndarray|list|ParameterExpression]) – list of parameters

• duration (int or float) – instruction’s duration. it must be integer if unit is ‚dt‘

• unit (str) – time unit of duration

• label (str or None) – An optional label for identifying the instruction.

Verursacht

CircuitError – when the register is not in the correct format.

__init__(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)[Quellcode]

Create a new instruction.

Parameter
• name (str) – instruction name

• num_qubits (int) – instruction’s qubit width

• num_clbits (int) – instruction’s clbit width

• params (list[int|float|complex|str|ndarray|list|ParameterExpression]) – list of parameters

• duration (int or float) – instruction’s duration. it must be integer if unit is ‚dt‘

• unit (str) – time unit of duration

• label (str or None) – An optional label for identifying the instruction.

Verursacht

CircuitError – when the register is not in the correct format.

Methods

 __init__(name, num_qubits, num_clbits, params) Create a new instruction. add_decomposition(decomposition) Add a decomposition of the instruction to the SessionEquivalenceLibrary. Assemble a QasmQobjInstruction broadcast_arguments(qargs, cargs) Validation of the arguments. c_if(classical, val) Add classical condition on register or cbit classical and value val. copy([name]) Copy of the instruction. Invert this instruction. Return True .IFF. DEPRECATED: use instruction.reverse_ops(). Return a default OpenQASM string for the instruction. Creates an instruction with gate repeated n amount of times. For a composite instruction, reverse the order of sub-instructions. soft_compare(other) Soft comparison between gates. validate_parameter(parameter) Instruction parameters has no validation or normalization.

Attributes

 decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. definition Return definition in terms of other basic gates. duration Get the duration. label Return instruction label params return instruction params. unit Get the time unit of duration.
add_decomposition(decomposition)[Quellcode]

Add a decomposition of the instruction to the SessionEquivalenceLibrary.

assemble()[Quellcode]

Assemble a QasmQobjInstruction

broadcast_arguments(qargs, cargs)[Quellcode]

Validation of the arguments.

Parameter
• qargs (List) – List of quantum bit arguments.

• cargs (List) – List of classical bit arguments.

Yields

Tuple(List, List) – A tuple with single arguments.

Verursacht

CircuitError – If the input is not valid. For example, the number of arguments does not match the gate expectation.

c_if(classical, val)[Quellcode]

Add classical condition on register or cbit classical and value val.

copy(name=None)[Quellcode]

Copy of the instruction.

Parameter

name (str) – name to be given to the copied circuit, if None then the name stays the same.

Rückgabe

a copy of the current instruction, with the name

updated if it was provided

Rückgabetyp

qiskit.circuit.Instruction

property decompositions

Get the decompositions of the instruction from the SessionEquivalenceLibrary.

property definition

Return definition in terms of other basic gates.

property duration

Get the duration.

inverse()[Quellcode]

Invert this instruction.

If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted.

Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.)

Rückgabe

a fresh instruction for the inverse

Rückgabetyp

qiskit.circuit.Instruction

Verursacht

CircuitError – if the instruction is not composite and an inverse has not been implemented for it.

is_parameterized()[Quellcode]

Return True .IFF. instruction is parameterized else False

property label

Return instruction label

Rückgabetyp

str

mirror()[Quellcode]

DEPRECATED: use instruction.reverse_ops().

Rückgabe

a new instruction with sub-instructions

reversed.

Rückgabetyp

qiskit.circuit.Instruction

property params

return instruction params.

qasm()[Quellcode]

Return a default OpenQASM string for the instruction.

Derived instructions may override this to print in a different format (e.g. measure q[0] -> c[0];).

repeat(n)[Quellcode]

Creates an instruction with gate repeated n amount of times.

Parameter

n (int) – Number of times to repeat the instruction

Rückgabe

Containing the definition.

Rückgabetyp

qiskit.circuit.Instruction

Verursacht

CircuitError – If n < 1.

reverse_ops()[Quellcode]

For a composite instruction, reverse the order of sub-instructions.

This is done by recursively reversing all sub-instructions. It does not invert any gate.

Rückgabe

a new instruction with

sub-instructions reversed.

Rückgabetyp

qiskit.circuit.Instruction

soft_compare(other)[Quellcode]

Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.

Parameter

other (instruction) – other instruction.

Rückgabe

are self and other equal up to parameter expressions.

Rückgabetyp

bool

property unit

Get the time unit of duration.

validate_parameter(parameter)[Quellcode]

Instruction parameters has no validation or normalization.