scnc
/
qiskit-documentation
mirror of https://github.com/Qiskit/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qiskit-documentation/docs/api/qiskit/0.43/qiskit.circuit.IfElseOp.mdx

328 lines
10 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: IfElseOp
description: API reference for qiskit.circuit.IfElseOp
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.circuit.IfElseOp
---
# IfElseOp
<Class id="qiskit.circuit.IfElseOp" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.24/qiskit/circuit/controlflow/if_else.py" signature="IfElseOp(condition, true_body, false_body=None, label=None)" modifiers="class">
Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp")
A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise.
**Parameters**
* **condition** (*Tuple\[*[*ClassicalRegister*](qiskit.circuit.ClassicalRegister "qiskit.circuit.classicalregister.ClassicalRegister") *|*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.classicalregister.Clbit")*, int]*) – A condition to be evaluated at circuit runtime which, if true, will trigger the evaluation of `true_body`. Can be specified as either a tuple of a `ClassicalRegister` to be tested for equality with a given `int`, or as a tuple of a `Clbit` to be compared to either a `bool` or an `int`.
* **true\_body** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – A program to be executed if `condition` evaluates to true.
* **false\_body** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") *| None*) – A optional program to be executed if `condition` evaluates to false.
* **label** (*str | None*) – An optional label for identifying the instruction.
If provided, `false_body` must be of the same `num_qubits` and `num_clbits` as `true_body`.
The classical bits used in `condition` must be a subset of those attached to the circuit on which this `IfElseOp` will be appended.
**Circuit symbol:**
```python
┌───────────┐
q_0: ┤0 ├
│ │
q_1: ┤1 ├
│ if_else │
q_2: ┤2 ├
│ │
c_0: ╡0 ╞
└───────────┘
```
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*](qiskit.circuit.ParameterExpression "qiskit.circuit.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.
**Raises**
* **CircuitError** – when the register is not in the correct format.
* **TypeError** – when the optional label is provided, but it is not a string.
## Methods
<span id="qiskit-circuit-ifelseop-add-decomposition" />
### add\_decomposition
<Function id="qiskit.circuit.IfElseOp.add_decomposition" signature="IfElseOp.add_decomposition(decomposition)">
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
</Function>
<span id="qiskit-circuit-ifelseop-assemble" />
### assemble
<Function id="qiskit.circuit.IfElseOp.assemble" signature="IfElseOp.assemble()">
Assemble a QasmQobjInstruction
</Function>
<span id="qiskit-circuit-ifelseop-broadcast-arguments" />
### broadcast\_arguments
<Function id="qiskit.circuit.IfElseOp.broadcast_arguments" signature="IfElseOp.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.
</Function>
<span id="qiskit-circuit-ifelseop-c-if" />
### c\_if
<Function id="qiskit.circuit.IfElseOp.c_if" signature="IfElseOp.c_if(classical, val)">
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
<Admonition title="Note" type="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.
</Admonition>
</Function>
<span id="qiskit-circuit-ifelseop-copy" />
### copy
<Function id="qiskit.circuit.IfElseOp.copy" signature="IfElseOp.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**
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
</Function>
<span id="qiskit-circuit-ifelseop-inverse" />
### inverse
<Function id="qiskit.circuit.IfElseOp.inverse" signature="IfElseOp.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**
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
**Raises**
**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it.
</Function>
<span id="qiskit-circuit-ifelseop-is-parameterized" />
### is\_parameterized
<Function id="qiskit.circuit.IfElseOp.is_parameterized" signature="IfElseOp.is_parameterized()">
Return True .IFF. instruction is parameterized else False
</Function>
<span id="qiskit-circuit-ifelseop-qasm" />
### qasm
<Function id="qiskit.circuit.IfElseOp.qasm" signature="IfElseOp.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];).
</Function>
<span id="qiskit-circuit-ifelseop-repeat" />
### repeat
<Function id="qiskit.circuit.IfElseOp.repeat" signature="IfElseOp.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**
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
**Raises**
**CircuitError** – If n \< 1.
</Function>
<span id="qiskit-circuit-ifelseop-replace-blocks" />
### replace\_blocks
<Function id="qiskit.circuit.IfElseOp.replace_blocks" signature="IfElseOp.replace_blocks(blocks)">
Replace blocks and return new instruction.
**Parameters**
**blocks** (*Iterable\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")*]*) – Iterable of circuits for “if” and “else” condition. If there is no “else” circuit it may be set to None or ommited.
**Returns**
New IfElseOp with replaced blocks.
**Return type**
[*IfElseOp*](qiskit.circuit.IfElseOp "qiskit.circuit.controlflow.if_else.IfElseOp")
</Function>
<span id="qiskit-circuit-ifelseop-reverse-ops" />
### reverse\_ops
<Function id="qiskit.circuit.IfElseOp.reverse_ops" signature="IfElseOp.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.
**Returns**
**a new instruction with**
sub-instructions reversed.
**Return type**
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
</Function>
<span id="qiskit-circuit-ifelseop-soft-compare" />
### soft\_compare
<Function id="qiskit.circuit.IfElseOp.soft_compare" signature="IfElseOp.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.
**Parameters**
**other** (*instruction*) – other instruction.
**Returns**
are self and other equal up to parameter expressions.
**Return type**
bool
</Function>
<span id="qiskit-circuit-ifelseop-validate-parameter" />
### validate\_parameter
<Function id="qiskit.circuit.IfElseOp.validate_parameter" signature="IfElseOp.validate_parameter(parameter)">
Instruction parameters has no validation or normalization.
</Function>
## Attributes
### blocks
<Attribute id="qiskit.circuit.IfElseOp.blocks" />
### condition\_bits
<Attribute id="qiskit.circuit.IfElseOp.condition_bits">
Get Clbits in condition.
</Attribute>
### decompositions
<Attribute id="qiskit.circuit.IfElseOp.decompositions">
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
</Attribute>
### definition
<Attribute id="qiskit.circuit.IfElseOp.definition">
Return definition in terms of other basic gates.
</Attribute>
### duration
<Attribute id="qiskit.circuit.IfElseOp.duration">
Get the duration.
</Attribute>
### label
<Attribute id="qiskit.circuit.IfElseOp.label">
Return instruction label
</Attribute>
### name
<Attribute id="qiskit.circuit.IfElseOp.name">
Return the name.
</Attribute>
### num\_clbits
<Attribute id="qiskit.circuit.IfElseOp.num_clbits">
Return the number of clbits.
</Attribute>
### num\_qubits
<Attribute id="qiskit.circuit.IfElseOp.num_qubits">
Return the number of qubits.
</Attribute>
### params
<Attribute id="qiskit.circuit.IfElseOp.params" />
### unit
<Attribute id="qiskit.circuit.IfElseOp.unit">
Get the time unit of duration.
</Attribute>
</Class>
Reference in New Issue View Git Blame Copy Permalink