qiskit.circuit.Instruction¶
-
class
Instruction
(name, num_qubits, num_clbits, params, duration=None, unit='dt')[ソース]¶ Generic quantum instruction.
Create a new instruction.
- パラメータ
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
- 例外
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.
- パラメータ
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
- 例外
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.
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.
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
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
Return definition in terms of other basic gates.
Get the duration.
return instruction params.
Get the time unit of duration.
-
add_decomposition
(decomposition)[ソース]¶ Add a decomposition of the instruction to the SessionEquivalenceLibrary.
-
broadcast_arguments
(qargs, cargs)[ソース]¶ Validation of the arguments.
- パラメータ
qargs (List) – List of quantum bit arguments.
cargs (List) – List of classical bit arguments.
- 列挙
Tuple(List, List) – A tuple with single arguments.
- 例外
CircuitError – If the input is not valid. For example, the number of arguments does not match the gate expectation.
-
copy
(name=None)[ソース]¶ Copy of the instruction.
- パラメータ
name (str) – name to be given to the copied circuit, if None then the name stays the same.
- 戻り値
- a copy of the current instruction, with the name
updated if it was provided
- 戻り値の型
-
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.)
- 戻り値
a fresh instruction for the inverse
- 戻り値の型
- 例外
CircuitError – if the instruction is not composite and an inverse has not been implemented for it.
-
mirror
()[ソース]¶ DEPRECATED: use instruction.reverse_ops().
- 戻り値
- a new instruction with sub-instructions
reversed.
- 戻り値の型
-
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.
- パラメータ
n (int) – Number of times to repeat the instruction
- 戻り値
Containing the definition.
- 戻り値の型
- 例外
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.
- 戻り値
- a new instruction with
sub-instructions reversed.
- 戻り値の型
-
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.
- パラメータ
other (instruction) – other instruction.
- 戻り値
are self and other equal up to parameter expressions.
- 戻り値の型
bool
-
property
unit
¶ Get the time unit of duration.