Update API dev docs (#2224)

An action recently synced the latest dev docs. This PR updates all dev APIs that changed. > [!NOTE] > This pull request was created by a GitHub action. --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Eric Arellano <[email protected]>
Qiskit · Nov 1, 2024 · f998723 · f998723
1 parent 882cd0a
commit f998723
Show file tree

Hide file tree

Showing 306 changed files with 4,300 additions and 1,286 deletions.
diff --git a/docs/api/qiskit/dev/_toc.json b/docs/api/qiskit/dev/_toc.json
@@ -137,6 +137,14 @@
               "title": "AND",
               "url": "/api/qiskit/dev/qiskit.circuit.library.AND"
             },
+            {
+              "title": "AndGate",
+              "url": "/api/qiskit/dev/qiskit.circuit.library.AndGate"
+            },
+            {
+              "title": "BitwiseXorGate",
+              "url": "/api/qiskit/dev/qiskit.circuit.library.BitwiseXorGate"
+            },
             {
               "title": "C3SXGate",
               "url": "/api/qiskit/dev/qiskit.circuit.library.C3SXGate"
@@ -325,6 +333,10 @@
               "title": "InnerProduct",
               "url": "/api/qiskit/dev/qiskit.circuit.library.InnerProduct"
             },
+            {
+              "title": "InnerProductGate",
+              "url": "/api/qiskit/dev/qiskit.circuit.library.InnerProductGate"
+            },
             {
               "title": "IntegerComparator",
               "url": "/api/qiskit/dev/qiskit.circuit.library.IntegerComparator"
@@ -397,6 +409,10 @@
               "title": "OR",
               "url": "/api/qiskit/dev/qiskit.circuit.library.OR"
             },
+            {
+              "title": "OrGate",
+              "url": "/api/qiskit/dev/qiskit.circuit.library.OrGate"
+            },
             {
               "title": "PauliEvolutionGate",
               "url": "/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate"
@@ -712,6 +728,10 @@
           "title": "ScalarOp",
           "url": "/api/qiskit/dev/qiskit.quantum_info.ScalarOp"
         },
+        {
+          "title": "SparseObservable",
+          "url": "/api/qiskit/dev/qiskit.quantum_info.SparseObservable"
+        },
         {
           "title": "SparsePauliOp",
           "url": "/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp"
@@ -1345,6 +1365,10 @@
               "title": "RemoveFinalReset",
               "url": "/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalReset"
             },
+            {
+              "title": "RemoveIdentityEquivalent",
+              "url": "/api/qiskit/dev/qiskit.transpiler.passes.RemoveIdentityEquivalent"
+            },
             {
               "title": "RemoveResetInZeroState",
               "url": "/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState"

diff --git a/docs/api/qiskit/dev/assembler.mdx b/docs/api/qiskit/dev/assembler.mdx
@@ -65,9 +65,13 @@ python_api_name: qiskit.assembler
 
 ### assemble\_schedules
 
-<Function id="qiskit.assembler.assemble_schedules" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/assembler/assemble_schedules.py#L27-L103" signature="qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)">
+<Function id="qiskit.assembler.assemble_schedules" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/assembler/assemble_schedules.py#L28-L105" signature="qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)">
   Assembles a list of schedules into a qobj that can be run on the backend.
 
+  <Admonition title="Deprecated since version 1.3" type="danger">
+    The function `qiskit.assembler.assemble_schedules.assemble_schedules()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.assembler.assemble_schedules.assemble_schedules()` will have no alternative in Qiskit.
+  </Admonition>
+
   **Parameters**
 
   *   **schedules** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*ScheduleBlock*](qiskit.pulse.ScheduleBlock "qiskit.pulse.schedule.ScheduleBlock")  *|*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule")  *|*[*Instruction*](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction")  *|*[*Tuple*](https://docs.python.org/3/library/typing.html#typing.Tuple "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule")  *|*[*Instruction*](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction")*]]*) – Schedules to assemble.

diff --git a/docs/api/qiskit/dev/circuit.mdx b/docs/api/qiskit/dev/circuit.mdx
@@ -485,7 +485,7 @@ Hardware can be instructed to apply a real-time idle period on a given qubit. A
 
 #### Delay
 
-<Class id="qiskit.circuit.Delay" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/delay.py#L24-L121" signature="qiskit.circuit.Delay(duration, unit='dt')" modifiers="class">
+<Class id="qiskit.circuit.Delay" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/delay.py#L25-L123" signature="qiskit.circuit.Delay(duration, unit='dt')" modifiers="class">
   Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")
 
   Do nothing and just delay/wait/idle for a specified duration.
@@ -511,7 +511,7 @@ it is forbidden for the optimizer to cancel out the two $X$ instructions.
 
 #### Barrier
 
-<Class id="qiskit.circuit.Barrier" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/barrier.py#L25-L48" signature="qiskit.circuit.Barrier(num_qubits, label=None)" modifiers="class">
+<Class id="qiskit.circuit.Barrier" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/barrier.py#L26-L50" signature="qiskit.circuit.Barrier(num_qubits, label=None)" modifiers="class">
   Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")
 
   A directive for circuit compilation to separate pieces of a circuit so that any optimizations or re-writes are constrained to only act between barriers.
@@ -537,7 +537,7 @@ qc.store(creg[0], parity)
 
 #### Store
 
-<Class id="qiskit.circuit.Store" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/store.py#L55-L95" signature="qiskit.circuit.Store(lvalue, rvalue)" modifiers="class">
+<Class id="qiskit.circuit.Store" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/store.py#L56-L97" signature="qiskit.circuit.Store(lvalue, rvalue)" modifiers="class">
   Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")
 
   A manual storage of some classical value to a classical memory location.
@@ -549,6 +549,14 @@ qc.store(creg[0], parity)
   *   **lvalue** ([*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – the memory location being stored into.
   *   **rvalue** ([*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – the expression result being stored.
 
+  ##### c\_if
+
+  <Function id="qiskit.circuit.Store.c_if" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/store.py#L92-L97" signature="c_if(classical, val)">
+    <Admonition title="Deprecated since version 1.3.0" type="danger">
+      The method `qiskit.circuit.store.Store.c_if()` is deprecated as of qiskit 1.3.0. It will be removed in 2.0.0.
+    </Admonition>
+  </Function>
+
   ##### lvalue
 
   <Attribute id="qiskit.circuit.Store.lvalue">
@@ -682,7 +690,7 @@ Consult [the control-flow construction documentation](qiskit.circuit.QuantumCirc
 
 If two operations in a circuit commute, we can swap the order in which they are applied. This can allow for optimizations and simplifications, for example, if it allows to merge or cancel gates:
 
-```python
+```text
      ┌─────────┐     ┌─────────┐               ┌─────────┐
 q_0: ┤ Rz(0.5) ├──■──┤ Rz(1.2) ├──■──     q_0: ┤ Rz(1.7) ├
      └─────────┘┌─┴─┐└──┬───┬──┘┌─┴─┐  =       └──┬───┬──┘
@@ -714,7 +722,7 @@ Subclasses of [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruc
 
 #### \_define
 
-<Function id="qiskit.circuit.Instruction._define" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/instruction.py#L290-L297" signature="Instruction._define()">
+<Function id="qiskit.circuit.Instruction._define" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/instruction.py#L291-L298" signature="Instruction._define()">
   Populate the cached `_definition` field of this [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction").
 
   Subclasses should implement this method to provide lazy construction of their public [`definition`](qiskit.circuit.Instruction#definition "qiskit.circuit.Instruction.definition") attribute. A subclass can use its [`params`](qiskit.circuit.Instruction#params "qiskit.circuit.Instruction.params") at the time of the call. The method should populate `_definition` with a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") and not return a value.