Skip to content

Commit 1174e8e

Browse files
committed
Add rudimentary docs for BoxOp
1 parent 2364ee6 commit 1174e8e

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

qiskit/circuit/__init__.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,8 @@
272272
* :class:`ForLoopOp`, to loop over a fixed range of values
273273
* :class:`IfElseOp`, to conditionally enter one of two subcircuits
274274
* :class:`SwitchCaseOp`, to conditionally enter one of many subcircuits
275-
* :class:`WhileLoopOp`, to repeat a subcircuit until a condition is falsified.
275+
* :class:`WhileLoopOp`, to repeat a subcircuit until a condition is falsified
276+
* :class:`BoxOp`, to group a series of instructions for later processing
276277
277278
:ref:`Circuits can include classical expressions that are evaluated in real time
278279
<circuit-repr-real-time-classical>`, while the QPU is executing a single shot of the circuit. These
@@ -708,7 +709,7 @@
708709
.. autofunction:: get_control_flow_name_mapping
709710
710711
These control-flow operations (:class:`IfElseOp`, :class:`WhileLoopOp`,
711-
:class:`SwitchCaseOp` and :class:`ForLoopOp`) all have specific state that defines the branching
712+
:class:`SwitchCaseOp`, :class:`ForLoopOp` and :class:`BoxOp`) all have specific state that defines the branching
712713
conditions and strategies, but contain all the different subcircuit blocks that might be entered in
713714
their :attr:`~ControlFlowOp.blocks` property.
714715
@@ -719,6 +720,7 @@
719720
WhileLoopOp
720721
SwitchCaseOp
721722
ForLoopOp
723+
BoxOp
722724
723725
The :class:`.SwitchCaseOp` also understands a special value:
724726
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
upgrade_circuits:
2+
fixes:
33
- |
44
Converting a quantum circuit to a gate with :func:`.converters.circuit_to_instruction`
55
now properly fails when given circuit contains control flow instructions.

0 commit comments

Comments
 (0)