---
title: ControlFlowOp (v1.0)
description: API reference for qiskit.circuit.ControlFlowOp in qiskit v1.0
source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit/1.0/qiskit.circuit.ControlFlowOp
---

# ControlFlowOp

*class* `qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/control_flow.py#L26-L45)

Bases: [`Instruction`](/docs/api/qiskit/1.0/qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC)

Abstract class to encapsulate all control flow operations.

Create a new instruction.

**Parameters**

- **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – instruction name
- **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – instruction’s qubit width
- **num\_clbits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – instruction’s clbit width
- **params** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*|*[*float*](https://docs.python.org/3/library/functions.html#float)*|*[*complex*](https://docs.python.org/3/library/functions.html#complex)*|*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*|ndarray|*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*|*[*ParameterExpression*](/docs/api/qiskit/1.0/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]*) – list of parameters
- **duration** ([*int*](https://docs.python.org/3/library/functions.html#int)  *or*[*float*](https://docs.python.org/3/library/functions.html#float)) – instruction’s duration. it must be integer if `unit` is ‘dt’
- **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – time unit of duration
- **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *or None*) – An optional label for identifying the instruction.

**Raises**

- [**CircuitError**](/docs/api/qiskit/1.0/circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – when the register is not in the correct format.
- [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError) – when the optional label is provided, but it is not a string.

## Attributes

### base\_class

Get the base class of this instruction. This is guaranteed to be in the inheritance tree of `self`.

The “base class” of an instruction is the lowest class in its inheritance tree that the object should be considered entirely compatible with for \_all\_ circuit applications. This typically means that the subclass is defined purely to offer some sort of programmer convenience over the base class, and the base class is the “true” class for a behavioural perspective. In particular, you should *not* override [`base_class`](#qiskit.circuit.ControlFlowOp.base_class "qiskit.circuit.ControlFlowOp.base_class") if you are defining a custom version of an instruction that will be implemented differently by hardware, such as an alternative measurement strategy, or a version of a parametrised gate with a particular set of parameters for the purposes of distinguishing it in a [`Target`](/docs/api/qiskit/1.0/qiskit.transpiler.Target "qiskit.transpiler.Target") from the full parametrised gate.

This is often exactly equivalent to `type(obj)`, except in the case of singleton instances of standard-library instructions. These singleton instances are special subclasses of their base class, and this property will return that base. For example:

```python
>>> isinstance(XGate(), XGate)
True
>>> type(XGate()) is XGate
False
>>> XGate().base_class is XGate
True
```

In general, you should not rely on the precise class of an instruction; within a given circuit, it is expected that [`Instruction.name`](/docs/api/qiskit/1.0/qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") should be a more suitable discriminator in most situations.

### blocks

Tuple of QuantumCircuits which may be executed as part of the execution of this ControlFlowOp. May be parameterized by a loop parameter to be resolved at run time.

### condition

The classical condition on the instruction.

### 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

### mutable

Is this instance is a mutable unique instance or not.

If this attribute is `False` the gate instance is a shared singleton and is not mutable.

### 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

`add_decomposition(decomposition)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332)

Add a decomposition of the instruction to the SessionEquivalenceLibrary.

### assemble

`assemble()`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374)

Assemble a QasmQobjInstruction

### broadcast\_arguments

`broadcast_arguments(qargs, cargs)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L535-L564)

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**](/docs/api/qiskit/1.0/circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If the input is not valid. For example, the number of arguments does not match the gate expectation.

### c\_if

`c_if(classical, val)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L479-L497)

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

> **Note**
>
> 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

`copy(name=None)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514)

Copy of the instruction.

**Parameters**

**name** ([*str*](https://docs.python.org/3/library/stdtypes.html#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**

[qiskit.circuit.Instruction](/docs/api/qiskit/1.0/qiskit.circuit.Instruction "qiskit.circuit.Instruction")

### inverse

`inverse(annotated=False)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477)

Invert this instruction.

If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.

If annotated is True, the inverse instruction is implemented as [`AnnotatedOperation`](/docs/api/qiskit/1.0/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"), and corresponds to the given instruction annotated with the “inverse modifier”.

Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) In particular, they can choose how to handle the argument `annotated` which may include ignoring it and always returning a concrete gate class if the inverse is defined as a standard gate.

**Parameters**

**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](/docs/api/qiskit/1.0/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation").

**Returns**

The inverse operation.

**Raises**

[**CircuitError**](/docs/api/qiskit/1.0/circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if the instruction is not composite and an inverse has not been implemented for it.

### is\_parameterized

`is_parameterized()`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297)

Return True .IFF. instruction is parameterized else False

### repeat

`repeat(n)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608)

Creates an instruction with gate repeated n amount of times.

**Parameters**

**n** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of times to repeat the instruction

**Returns**

Containing the definition.

**Return type**

[qiskit.circuit.Instruction](/docs/api/qiskit/1.0/qiskit.circuit.Instruction "qiskit.circuit.Instruction")

**Raises**

[**CircuitError**](/docs/api/qiskit/1.0/circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If n \< 1.

### replace\_blocks

*abstract* `replace_blocks(blocks)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/control_flow.py#L37-L45)

Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction.

**Returns**

New ControlFlowOp with replaced blocks.

**Return type**

[ControlFlowOp](#qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp")

### reverse\_ops

`reverse_ops()`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420)

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**

[qiskit.circuit.Instruction](/docs/api/qiskit/1.0/qiskit.circuit.Instruction "qiskit.circuit.Instruction")

### soft\_compare

`soft_compare(other)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269)

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](https://docs.python.org/3/library/functions.html#bool)

### to\_mutable

`to_mutable()`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159)

Return a mutable copy of this gate.

This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.

### validate\_parameter

`validate_parameter(parameter)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L289-L291)

Instruction parameters has no validation or normalization.