qiskit.circuit.Instruction

class Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt')

Generic quantum instruction.

Create a new instruction.

Parameters

• 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

Raises

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

__init__(name, num_qubits, num_clbits, params, duration=None, unit='dt')

Create a new instruction.

Parameters

• 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

Raises

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()	Assemble a QasmQobjInstruction
broadcast_arguments(qargs, cargs)	Validation of the arguments.
c_if(classical, val)	Add classical condition on register classical and value val.
copy([name])	Copy of the instruction.
inverse()	Invert this instruction.
is_parameterized()	Return True .IFF.
mirror()	DEPRECATED: use instruction.reverse_ops().
qasm()	Return a default OpenQASM string for the instruction.
repeat(n)	Creates an instruction with gate repeated n amount of times.
reverse_ops()	For a composite instruction, reverse the order of sub-instructions.
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.
params	return instruction params.
unit	Get the time unit of duration.

add_decomposition(decomposition)

Add a decomposition of the instruction to the SessionEquivalenceLibrary.

assemble()

Assemble a QasmQobjInstruction

broadcast_arguments(qargs, cargs)

Validation of the arguments.

Parameters

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

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

Yields

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

Raises

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

c_if(classical, val)

Add classical condition on register classical and value val.

copy(name=None)

Copy of the instruction.

Parameters

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

Returns

a copy of the current instruction, with the name

updated if it was provided

Return type

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()

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.)

Returns

a fresh instruction for the inverse

Return type

qiskit.circuit.Instruction

Raises

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

is_parameterized()

Return True .IFF. instruction is parameterized else False

mirror()

DEPRECATED: use instruction.reverse_ops().

Returns

a new instruction with sub-instructions

reversed.

Return type

qiskit.circuit.Instruction

property params

return instruction params.

qasm()

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)

Creates an instruction with gate repeated n amount of times.

Parameters

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

Returns

Containing the definition.

Return type

qiskit.circuit.Instruction

Raises

CircuitError – If n < 1.

reverse_ops()

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.

Returns

a new instruction with

sub-instructions reversed.

Return type

qiskit.circuit.Instruction

property unit

Get the time unit of duration.

validate_parameter(parameter)

Instruction parameters has no validation or normalization.