BreakLoopOp#

class qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)[Quellcode]#

Bases: Instruction

A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop.

Circuit symbol:

     ┌──────────────┐
q_0: ┤0             ├
     │              │
q_1: ┤1             ├
     │  break_loop  │
q_2: ┤2             ├
     │              │
c_0: ╡0             ╞
     └──────────────┘

Create a new instruction.

Parameter:

  • 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

  • label (str or None) – An optional label for identifying the instruction.

Verursacht:

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

  • TypeError – when the optional label is provided, but it is not a string.

Attributes

condition_bits#

Get Clbits in condition.

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

name#

Return the name.

num_clbits#

Return the number of clbits.

num_qubits#

Return the number of qubits.

params#

return instruction params.

unit#

Get the time unit of duration.

Methods

add_decomposition(decomposition)#

Add a decomposition of the instruction to the SessionEquivalenceLibrary.

assemble()#

Assemble a QasmQobjInstruction

broadcast_arguments(qargs, cargs)#

Validation of the arguments.

Parameter:

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

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

Yields:

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

Verursacht:

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

c_if(classical, val)#

Set a classical equality condition on this instruction between the register or cbit classical and value val.

Bemerkung

This is a setter method, not an additive one. Calling this multiple times will silently override any previously set condition; it does not stack.

copy(name=None)#

Copy of the instruction.

Parameter:

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

Rückgabe:

a copy of the current instruction, with the name updated if it was provided

Rückgabetyp:

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

Rückgabe:

a fresh instruction for the inverse

Rückgabetyp:

qiskit.circuit.Instruction

Verursacht:

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

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

Veraltet ab Version 0.25.0: The method qiskit.circuit.instruction.Instruction.qasm() is deprecated as of qiskit-terra 0.25.0. It will be removed no earlier than 3 months after the release date. Correct exporting to OpenQASM 2 is the responsibility of a larger exporter; it cannot safely be done on an object-by-object basis without context. No replacement will be provided, because the premise is wrong.

repeat(n)#

Creates an instruction with gate repeated n amount of times.

Parameter:

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

Rückgabe:

Containing the definition.

Rückgabetyp:

qiskit.circuit.Instruction

Verursacht:

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.

Rückgabe:

a new instruction with

sub-instructions reversed.

Rückgabetyp:

qiskit.circuit.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.

Parameter:

other (instruction) – other instruction.

Rückgabe:

are self and other equal up to parameter expressions.

Rückgabetyp:

bool

validate_parameter(parameter)#

Instruction parameters has no validation or normalization.