Instruction
Instruction(name, num_qubits, num_clbits, params)
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
Raises
CircuitError – when the register is not in the correct format.
Attributes
decompositions
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
definition
Return definition in terms of other basic gates.
params
return instruction params.
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 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()
For a composite instruction, reverse the order of sub-gates.
This is done by recursively mirroring all sub-instructions. It does not invert any gate.
Returns
a fresh gate with sub-gates 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.