Instruction
class Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)
Bases: object
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
unitis ‘dt’ - unit (str) – time unit of duration
- label (str or None) – An optional label for identifying the instruction.
Raises
CircuitError – when the register is not in the correct format.
Methods
add_decomposition
Instruction.add_decomposition(decomposition)
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
assemble
Instruction.assemble()
Assemble a QasmQobjInstruction
broadcast_arguments
Instruction.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
Instruction.c_if(classical, val)
Add classical condition on register or cbit classical and value val.
copy
Instruction.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
inverse
Instruction.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
Raises
CircuitError – if the instruction is not composite and an inverse has not been implemented for it.
is_parameterized
Instruction.is_parameterized()
Return True .IFF. instruction is parameterized else False
mirror
Instruction.mirror()
DEPRECATED: use instruction.reverse_ops().
Returns
a new instruction with sub-instructions
reversed.
Return type
qasm
Instruction.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
Instruction.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
Raises
CircuitError – If n < 1.
reverse_ops
Instruction.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
soft_compare
Instruction.soft_compare(other)
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.
Parameters
other (instruction) – other instruction.
Returns
are self and other equal up to parameter expressions.
Return type
bool
validate_parameter
Instruction.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
Return type
str
params
return instruction params.
unit
Get the time unit of duration.