InstructionSet
class qiskit.circuit.InstructionSet(*, resource_requester=None)
Bases: object
Instruction collection, and their contexts.
New collection of instructions.
The context (qargs and cargs that each instruction is attached to) is also stored separately for each instruction.
Parameters
resource_requester (Callable[..., ClassicalRegister |Clbit] | None) –
A callable that takes in the classical resource used in the condition, verifies that it is present in the attached circuit, resolves any indices into concrete Clbit instances, and returns the concrete resource. If this is not given, specifying a condition with an index is forbidden, and all concrete Clbit and ClassicalRegister resources will be assumed to be valid.
The callback resource_requester is called once for each call to c_if(), and assumes that a call implies that the resource will now be used. It may throw an error if the resource is not valid for usage.
Attributes
cargs
Legacy getter for the cargs components of an instruction set. This does not support mutation.
instructions
Legacy getter for the instruction components of an instruction set. This does not support mutation.
qargs
Legacy getter for the qargs components of an instruction set. This does not support mutation.
Methods
add
add(instruction, qargs=None, cargs=None)
Add an instruction and its context (where it is attached).
c_if
c_if(classical, val)
Set a classical equality condition on all the instructions in this set between the ClassicalRegister or Clbit classical and value val.
You should prefer to use the QuantumCircuit.if_test() builder interface, rather than using this method.
This is a setter method, not an additive one. Calling this multiple times will silently override any previously set condition on any of the contained instructions; it does not stack.
The method qiskit.circuit.instructionset.InstructionSet.c_if() is deprecated as of Qiskit 1.3.0. It will be removed in 2.0.0.
Parameters
- classical (Clbit |ClassicalRegister |int) – the classical resource the equality condition should be on. If this is given as an integer, it will be resolved into a
Clbitusing the same conventions as the circuit these instructions are attached to. - val (int) – the value the classical resource should be equal to.
Returns
This same instance of InstructionSet, but now mutated to have the given equality condition.
Raises
CircuitError – if the passed classical resource is invalid, or otherwise not resolvable to a concrete resource that these instructions are permitted to access.
Return type
inverse
inverse(annotated=False)
Invert all instructions.
It is preferable to take the inverse before appending the gate(s) to the circuit.
Parameters
annotated (bool) –