diff --git a/docs/api/qiskit-c/2.1/qk-complex-64.mdx b/docs/api/qiskit-c/2.1/qk-complex-64.mdx index a564130e6e4..de08a0648d4 100644 --- a/docs/api/qiskit-c/2.1/qk-complex-64.mdx +++ b/docs/api/qiskit-c/2.1/qk-complex-64.mdx @@ -32,9 +32,11 @@ Explicitly, Qiskit assumes the compiler-native complex number type in C to be `_ ## Functions -**static CMPLX\_DOUBLE qk\_complex64\_to\_native(QkComplex64 \*value)** +### qk\_complex64\_to\_native -Convert a `QkComplex64` to a compiler-native complex number representation. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details. + + Convert a `QkComplex64` to a compiler-native complex number representation. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details. + ### Example @@ -57,9 +59,11 @@ Behavior is undefined if `value` is not a valid, non-null pointer to a `QkComple A native representation of the complex number. -**static QkComplex64 qk\_complex64\_from\_native(CMPLX\_DOUBLE \*value)** +#### qk\_complex64\_from\_native -Convert a compiler-native complex number to a `QkComplex64`. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details. + + Convert a compiler-native complex number to a `QkComplex64`. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details. + diff --git a/docs/api/qiskit-c/_package.json b/docs/api/qiskit-c/_package.json index d622d2544fa..1581f0b1138 100644 --- a/docs/api/qiskit-c/_package.json +++ b/docs/api/qiskit-c/_package.json @@ -1,4 +1,4 @@ { "name": "qiskit-c", - "version": "2.2.1" + "version": "2.2.3" } diff --git a/docs/api/qiskit-c/qk-bit-term.mdx b/docs/api/qiskit-c/qk-bit-term.mdx index eac3ea6aece..7d5fe161955 100644 --- a/docs/api/qiskit-c/qk-bit-term.mdx +++ b/docs/api/qiskit-c/qk-bit-term.mdx @@ -111,7 +111,7 @@ The numeric structure of these is that they are all four-bit values of which the **Parameters** - **bit\_term** – The bit term. + * **bit\_term** – The bit term. **Returns** diff --git a/docs/api/qiskit-c/qk-circuit.mdx b/docs/api/qiskit-c/qk-circuit.mdx index 80b7e0fe0bf..b80b79d7c73 100644 --- a/docs/api/qiskit-c/qk-circuit.mdx +++ b/docs/api/qiskit-c/qk-circuit.mdx @@ -274,7 +274,7 @@ The circuit C API currently only supports creating circuits that contain operati **Parameters** - **circuit** – A pointer to the circuit to copy. + * **circuit** – A pointer to the circuit to copy. **Returns** @@ -305,7 +305,7 @@ The circuit C API currently only supports creating circuits that contain operati **Parameters** - **circuit** – A pointer to the circuit. + * **circuit** – A pointer to the circuit. **Returns** @@ -336,7 +336,7 @@ The circuit C API currently only supports creating circuits that contain operati **Parameters** - **circuit** – A pointer to the circuit. + * **circuit** – A pointer to the circuit. **Returns** @@ -367,7 +367,7 @@ The circuit C API currently only supports creating circuits that contain operati **Parameters** - **circuit** – A pointer to the circuit to free. + * **circuit** – A pointer to the circuit to free. ### qk\_circuit\_gate @@ -422,7 +422,7 @@ The circuit C API currently only supports creating circuits that contain operati **Parameters** - **gate** – The `QkGate` to get the number of qubits for. + * **gate** – The `QkGate` to get the number of qubits for. **Returns** @@ -444,7 +444,7 @@ The circuit C API currently only supports creating circuits that contain operati **Parameters** - **gate** – The `QkGate` to get the number of qubits for. + * **gate** – The `QkGate` to get the number of qubits for. **Returns** @@ -625,7 +625,7 @@ The circuit C API currently only supports creating circuits that contain operati **Parameters** - **circuit** – A pointer to the circuit to get the counts for. + * **circuit** – A pointer to the circuit to get the counts for. **Returns** @@ -658,7 +658,7 @@ The circuit C API currently only supports creating circuits that contain operati **Parameters** - **circuit** – A pointer to the circuit to get the total number of instructions for. + * **circuit** – A pointer to the circuit to get the total number of instructions for. **Returns** @@ -734,7 +734,7 @@ The circuit C API currently only supports creating circuits that contain operati **Parameters** - **inst** – A pointer to the instruction to free. + * **inst** – A pointer to the instruction to free. ### qk\_opcounts\_clear @@ -752,7 +752,7 @@ The circuit C API currently only supports creating circuits that contain operati **Parameters** - **op\_counts** – The returned op count list from `qk_circuit_count_ops`. + * **op\_counts** – The returned op count list from `qk_circuit_count_ops`. ### qk\_circuit\_to\_python @@ -774,7 +774,7 @@ The circuit C API currently only supports creating circuits that contain operati **Parameters** - **circuit** – The C-space `QkCircuit` pointer. + * **circuit** – The C-space `QkCircuit` pointer. **Returns** diff --git a/docs/api/qiskit-c/qk-classical-register.mdx b/docs/api/qiskit-c/qk-classical-register.mdx index 605d992afb0..e8047d80600 100644 --- a/docs/api/qiskit-c/qk-classical-register.mdx +++ b/docs/api/qiskit-c/qk-classical-register.mdx @@ -60,7 +60,7 @@ While circuits track registers, the registers themselves impart almost no behavi **Parameters** - **reg** – A pointer to the register to free. + * **reg** – A pointer to the register to free. ### qk\_classical\_register\_new diff --git a/docs/api/qiskit-c/qk-complex-64.mdx b/docs/api/qiskit-c/qk-complex-64.mdx index 045741ffd9e..e0f0f430858 100644 --- a/docs/api/qiskit-c/qk-complex-64.mdx +++ b/docs/api/qiskit-c/qk-complex-64.mdx @@ -32,9 +32,11 @@ Explicitly, Qiskit assumes the compiler-native complex number type in C to be `_ ## Functions -**static CMPLX\_DOUBLE qk\_complex64\_to\_native(QkComplex64 \*value)** +### qk\_complex64\_to\_native -Convert a `QkComplex64` to a compiler-native complex number representation. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details. + + Convert a `QkComplex64` to a compiler-native complex number representation. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details. + ### Example @@ -57,9 +59,11 @@ Behavior is undefined if `value` is not a valid, non-null pointer to a `QkComple A native representation of the complex number. -**static QkComplex64 qk\_complex64\_from\_native(CMPLX\_DOUBLE \*value)** +#### qk\_complex64\_from\_native -Convert a compiler-native complex number to a `QkComplex64`. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details. + + Convert a compiler-native complex number to a `QkComplex64`. Note that `CMPLX_DOUBLE` is a placeholder for the compiler-native complex number type, see the top of the page for more details. + diff --git a/docs/api/qiskit-c/qk-obs-term.mdx b/docs/api/qiskit-c/qk-obs-term.mdx index 2ab1cfd55f5..a75958d6223 100644 --- a/docs/api/qiskit-c/qk-obs-term.mdx +++ b/docs/api/qiskit-c/qk-obs-term.mdx @@ -92,7 +92,7 @@ This is a group of functions for interacting with an opaque (Rust-space) SparseT **Parameters** - **term** – A pointer to the term. + * **term** – A pointer to the term. **Returns** diff --git a/docs/api/qiskit-c/qk-obs.mdx b/docs/api/qiskit-c/qk-obs.mdx index 7521874a064..6894eec33c2 100644 --- a/docs/api/qiskit-c/qk-obs.mdx +++ b/docs/api/qiskit-c/qk-obs.mdx @@ -154,7 +154,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **num\_qubits** – The number of qubits the observable is defined on. + * **num\_qubits** – The number of qubits the observable is defined on. **Returns** @@ -176,7 +176,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **num\_qubits** – The number of qubits the observable is defined on. + * **num\_qubits** – The number of qubits the observable is defined on. **Returns** @@ -259,7 +259,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **obs** – A pointer to the observable to free. + * **obs** – A pointer to the observable to free. ### qk\_obs\_add\_term @@ -369,7 +369,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **obs** – A pointer to the observable. + * **obs** – A pointer to the observable. **Returns** @@ -400,7 +400,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **obs** – A pointer to the observable. + * **obs** – A pointer to the observable. **Returns** @@ -431,7 +431,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **obs** – A pointer to the observable. + * **obs** – A pointer to the observable. **Returns** @@ -469,7 +469,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **obs** – A pointer to the observable. + * **obs** – A pointer to the observable. **Returns** @@ -521,7 +521,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **obs** – A pointer to the observable. + * **obs** – A pointer to the observable. **Returns** @@ -567,7 +567,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **obs** – A pointer to the observable. + * **obs** – A pointer to the observable. **Returns** @@ -615,7 +615,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **obs** – A pointer to the observable. + * **obs** – A pointer to the observable. **Returns** @@ -889,7 +889,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **obs** – A pointer to the observable. + * **obs** – A pointer to the observable. **Returns** @@ -960,7 +960,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **obs** – A pointer to the `QkObs` to get the string for. + * **obs** – A pointer to the `QkObs` to get the string for. **Returns** @@ -982,7 +982,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **string** – A pointer to the returned string representation from `qk_obs_str` or `qk_obsterm_str`. + * **string** – A pointer to the returned string representation from `qk_obs_str` or `qk_obsterm_str`. ### qk\_obs\_to\_python @@ -1002,7 +1002,7 @@ for (size_t i = 0; i < num_terms; i++) { **Parameters** - **obs** – The C-space `QkObs` pointer. + * **obs** – The C-space `QkObs` pointer. **Returns** diff --git a/docs/api/qiskit-c/qk-quantum-register.mdx b/docs/api/qiskit-c/qk-quantum-register.mdx index 88b149365a0..5419929d5dc 100644 --- a/docs/api/qiskit-c/qk-quantum-register.mdx +++ b/docs/api/qiskit-c/qk-quantum-register.mdx @@ -91,6 +91,6 @@ While circuits track registers, the registers themselves impart almost no behavi **Parameters** - **reg** – A pointer to the register to free. + * **reg** – A pointer to the register to free. diff --git a/docs/api/qiskit-c/qk-target-entry.mdx b/docs/api/qiskit-c/qk-target-entry.mdx index 8720a1126ed..749d3906535 100644 --- a/docs/api/qiskit-c/qk-target-entry.mdx +++ b/docs/api/qiskit-c/qk-target-entry.mdx @@ -48,7 +48,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003); **Parameters** - **operation** – The `QkGate` whose properties this target entry defines. If the `QkGate` takes parameters (which can be checked with `qk_gate_num_params`) it will be added as a an instruction on the target which accepts any parameter value. If the gate only accepts a fixed parameter value you can use `qk_target_entry_new_fixed` instead. + * **operation** – The `QkGate` whose properties this target entry defines. If the `QkGate` takes parameters (which can be checked with `qk_gate_num_params`) it will be added as a an instruction on the target which accepts any parameter value. If the gate only accepts a fixed parameter value you can use `qk_target_entry_new_fixed` instead. **Returns** @@ -172,7 +172,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003); **Parameters** - **entry** – The pointer to the mapping object. + * **entry** – The pointer to the mapping object. **Returns** @@ -207,7 +207,7 @@ qk_target_entry_add_property(entry, NULL, 0, NAN, 0.003); **Parameters** - **entry** – The pointer to the mapping object to be freed. + * **entry** – The pointer to the mapping object to be freed. ### qk\_target\_entry\_add\_property diff --git a/docs/api/qiskit-c/qk-target.mdx b/docs/api/qiskit-c/qk-target.mdx index 8d5a3a74daf..f703e8b6ffd 100644 --- a/docs/api/qiskit-c/qk-target.mdx +++ b/docs/api/qiskit-c/qk-target.mdx @@ -58,7 +58,7 @@ The Target C API currently only supports additions of `QkGate` instances with ei **Parameters** - **num\_qubits** – The number of qubits the `QkTarget` will explicitly support. + * **num\_qubits** – The number of qubits the `QkTarget` will explicitly support. **Returns** @@ -89,7 +89,7 @@ The Target C API currently only supports additions of `QkGate` instances with ei **Parameters** - **target** – A pointer to the `QkTarget`. + * **target** – A pointer to the `QkTarget`. **Returns** @@ -121,7 +121,7 @@ The Target C API currently only supports additions of `QkGate` instances with ei **Parameters** - **target** – A pointer to the `QkTarget`. + * **target** – A pointer to the `QkTarget`. **Returns** @@ -153,7 +153,7 @@ The Target C API currently only supports additions of `QkGate` instances with ei **Parameters** - **target** – A pointer to the `QkTarget`. + * **target** – A pointer to the `QkTarget`. **Returns** @@ -185,7 +185,7 @@ The Target C API currently only supports additions of `QkGate` instances with ei **Parameters** - **target** – A pointer to the `QkTarget`. + * **target** – A pointer to the `QkTarget`. **Returns** @@ -217,7 +217,7 @@ The Target C API currently only supports additions of `QkGate` instances with ei **Parameters** - **target** – A pointer to the `QkTarget`. + * **target** – A pointer to the `QkTarget`. **Returns** @@ -249,7 +249,7 @@ The Target C API currently only supports additions of `QkGate` instances with ei **Parameters** - **target** – A pointer to the `QkTarget`. + * **target** – A pointer to the `QkTarget`. **Returns** @@ -449,7 +449,7 @@ The Target C API currently only supports additions of `QkGate` instances with ei **Parameters** - **target** – A pointer to the `QkTarget` to copy. + * **target** – A pointer to the `QkTarget` to copy. **Returns** @@ -480,7 +480,7 @@ The Target C API currently only supports additions of `QkGate` instances with ei **Parameters** - **target** – A pointer to the `QkTarget` to free. + * **target** – A pointer to the `QkTarget` to free. ### qk\_target\_add\_instruction @@ -591,7 +591,7 @@ The Target C API currently only supports additions of `QkGate` instances with ei **Parameters** - **target** – A pointer to the `QkTarget`. + * **target** – A pointer to the `QkTarget`. **Returns** diff --git a/docs/api/qiskit-c/qk-transpile-layout.mdx b/docs/api/qiskit-c/qk-transpile-layout.mdx index cc3030e993b..017b59a1798 100644 --- a/docs/api/qiskit-c/qk-transpile-layout.mdx +++ b/docs/api/qiskit-c/qk-transpile-layout.mdx @@ -89,7 +89,7 @@ The transpiler will also allocate ancilla qubits to the circuit if the target ha **Parameters** - **layout** – A pointer to the `QkTranspileLayout`. + * **layout** – A pointer to the `QkTranspileLayout`. **Returns** @@ -111,7 +111,7 @@ The transpiler will also allocate ancilla qubits to the circuit if the target ha **Parameters** - **layout** – A pointer to the `QkTranspileLayout`. + * **layout** – A pointer to the `QkTranspileLayout`. **Returns** @@ -224,6 +224,6 @@ The transpiler will also allocate ancilla qubits to the circuit if the target ha **Parameters** - **layout** – a pointer to the layout to free + * **layout** – a pointer to the layout to free diff --git a/docs/api/qiskit-c/qk-transpiler-passes.mdx b/docs/api/qiskit-c/qk-transpiler-passes.mdx index bf617650507..062dc97a23f 100644 --- a/docs/api/qiskit-c/qk-transpiler-passes.mdx +++ b/docs/api/qiskit-c/qk-transpiler-passes.mdx @@ -161,7 +161,7 @@ The Qiskit C API provides functions that execute transpiler passes in a standalo **Parameters** - **circuit** – A pointer to the circuit to run ElidePermutations on. If there are changes made the object pointed to is changed in place. In case of gates being elided the original circuit’s allocations are freed by this function. + * **circuit** – A pointer to the circuit to run ElidePermutations on. If there are changes made the object pointed to is changed in place. In case of gates being elided the original circuit’s allocations are freed by this function. **Returns** @@ -305,7 +305,7 @@ The Qiskit C API provides functions that execute transpiler passes in a standalo **Parameters** - **circuit** – A pointer to the circuit to run InverseCancellation on. If the pass is able to remove any gates, the original circuit will be replaced by the circuit produced by this pass. + * **circuit** – A pointer to the circuit to run InverseCancellation on. If the pass is able to remove any gates, the original circuit will be replaced by the circuit produced by this pass. ### qk\_transpiler\_standalone\_optimize\_1q\_sequences @@ -398,7 +398,7 @@ The Qiskit C API provides functions that execute transpiler passes in a standalo **Parameters** - **circuit** – A pointer to the circuit to run this pass on + * **circuit** – A pointer to the circuit to run this pass on ### qk\_transpiler\_pass\_standalone\_remove\_identity\_equivalent diff --git a/docs/api/qiskit-c/qk-transpiler.mdx b/docs/api/qiskit-c/qk-transpiler.mdx index 78eb43ba329..85b45741971 100644 --- a/docs/api/qiskit-c/qk-transpiler.mdx +++ b/docs/api/qiskit-c/qk-transpiler.mdx @@ -8,7 +8,7 @@ python_api_name: QkTranspiler # QkTranspiler -The [`qk_transpile()`](#_cppv412qk_transpilepk9qkcircuitpk8qktargetpk18qktranspileoptionsp17qktranspileresultppc "qk_transpile") function lets C access the Qiskit tranpsiler ([`qiskit.transpiler`](/docs/api/qiskit/transpiler#module-qiskit.transpiler "qiskit.transpiler")). The basic functionality is using the same underlying code as the Python-space version, but the transpiler as exposed to C has more limitations than what is exposed to Python. The transpiler assumes a circuit built constructed using solely the C API and is intended to work solely in the case of a standalone C API. It will potentially not work correctly when in a mixed Python/C use case. If you’re mixing C and Python you should call the [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager#qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") or [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") functions for those circuits. +The `qk_transpile()` function lets C access the Qiskit tranpsiler ([`qiskit.transpiler`](/docs/api/qiskit/transpiler#module-qiskit.transpiler "qiskit.transpiler")). The basic functionality is using the same underlying code as the Python-space version, but the transpiler as exposed to C has more limitations than what is exposed to Python. The transpiler assumes a circuit built constructed using solely the C API and is intended to work solely in the case of a standalone C API. It will potentially not work correctly when in a mixed Python/C use case. If you’re mixing C and Python you should call the [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager#qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") or [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") functions for those circuits. ## Data Types diff --git a/docs/api/qiskit-c/qk-vf-2-layout-result.mdx b/docs/api/qiskit-c/qk-vf-2-layout-result.mdx index 68dfa5c2654..a8e6af81492 100644 --- a/docs/api/qiskit-c/qk-vf-2-layout-result.mdx +++ b/docs/api/qiskit-c/qk-vf-2-layout-result.mdx @@ -12,7 +12,7 @@ python_api_name: QkVF2LayoutResult typedef struct QkVF2LayoutResult QkVF2LayoutResult ``` -When running the [`qk_transpiler_pass_standalone_vf2_layout()`](qk-transpiler-passes#_cppv440qk_transpiler_pass_standalone_vf2_layoutpk9qkcircuitpk8qktargetb7int64_td7int64_t "qk_transpiler_pass_standalone_vf2_layout") function it returns its analysis result as a `QkVF2LayoutResult` object. This object contains the outcome of the transpiler pass, whether the pass was able to find a layout or not, and what the layout selected by the pass was. +When running the `qk_transpiler_pass_standalone_vf2_layout()` function it returns its analysis result as a `QkVF2LayoutResult` object. This object contains the outcome of the transpiler pass, whether the pass was able to find a layout or not, and what the layout selected by the pass was. ## Functions @@ -31,7 +31,7 @@ When running the [`qk_transpiler_pass_standalone_vf2_layout()`](qk-transpiler-pa **Parameters** - **layout** – a pointer to the layout + * **layout** – a pointer to the layout **Returns** @@ -53,7 +53,7 @@ When running the [`qk_transpiler_pass_standalone_vf2_layout()`](qk-transpiler-pa **Parameters** - **layout** – a pointer to the layout + * **layout** – a pointer to the layout **Returns** @@ -106,6 +106,6 @@ When running the [`qk_transpiler_pass_standalone_vf2_layout()`](qk-transpiler-pa **Parameters** - **layout** – a pointer to the layout to free + * **layout** – a pointer to the layout to free diff --git a/docs/api/qiskit/_package.json b/docs/api/qiskit/_package.json index e9de6eafbf6..1c0c297cef6 100644 --- a/docs/api/qiskit/_package.json +++ b/docs/api/qiskit/_package.json @@ -1,4 +1,4 @@ { "name": "qiskit", - "version": "2.2.1" + "version": "2.2.3" } diff --git a/docs/api/qiskit/circuit.mdx b/docs/api/qiskit/circuit.mdx index 51506424dba..e362083df5f 100644 --- a/docs/api/qiskit/circuit.mdx +++ b/docs/api/qiskit/circuit.mdx @@ -256,7 +256,7 @@ Qubits and classical bits are represented by a shared base [`Bit`](#qiskit.circu #### Bit - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Implement a generic bit. @@ -296,7 +296,7 @@ A collection bits of the same type can be encapsulated in a register of the matc #### Register - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Implement a generic register. @@ -391,7 +391,7 @@ Subclassing [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), Qiskit has a sp | -------------------------------------------------------------------------------------------------------------------- | ------------------------ | | [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate")(name, num\_qubits, params\[, ...]) | Controlled unitary gate. | -Each of [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction"), [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") and [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") has a corresponding singleton type, built using the machinery described in [`qiskit.circuit.singleton`](circuit_singleton#module-qiskit.circuit.singleton "qiskit.circuit.singleton"). The module-level documentation contains full details, along with descriptions of [`SingletonInstruction`](circuit_singleton#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") and [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate"). From a user’s perspective, little changes based on whether the base class is a singleton or not; the intention always remains that you should call [`to_mutable()`](qiskit.circuit.Instruction#to_mutable "qiskit.circuit.Instruction.to_mutable") first if you need to get a safe-to-mutate owned copy of an instruction (you cannot assume that an arbitrary instruction is mutable), and while direct [`type`](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)") inspection is discouraged, if you do need it, the reliable way to find the “base” type of a potentially singleton instruction is to use [`base_class`](qiskit.circuit.Instruction#base_class "qiskit.circuit.Instruction.base_class"). +Each of [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction"), [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") and [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") has a corresponding singleton type, built using the machinery described in [`qiskit.circuit.singleton`](circuit_singleton#module-qiskit.circuit.singleton "qiskit.circuit.singleton"). The module-level documentation contains full details, along with descriptions of [`SingletonInstruction`](circuit_singleton#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") and [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate"). From a user’s perspective, little changes based on whether the base class is a singleton or not; the intention always remains that you should call [`to_mutable()`](qiskit.circuit.Instruction#to_mutable "qiskit.circuit.Instruction.to_mutable") first if you need to get a safe-to-mutate owned copy of an instruction (you cannot assume that an arbitrary instruction is mutable), and while direct [`type`](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)") inspection is discouraged, if you do need it, the reliable way to find the “base” type of a potentially singleton instruction is to use [`base_class`](qiskit.circuit.Instruction#base_class "qiskit.circuit.Instruction.base_class"). [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") uses the same mechanisms as [subclassing gates](#circuit-custom-gates) to define a fixed, lazy synthesis for itself. This is naturally not hardware-aware, and harder to hook into the synthesis routines of the compiler, but works better as a concrete [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") that could potentially be run natively on hardware. For cases where synthesis and abstract optimization is more important, Qiskit offers a composable class called [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"), which tracks “gate modifiers” (of which [`ControlModifier`](#qiskit.circuit.ControlModifier "qiskit.circuit.ControlModifier") is one) to apply to the inner [`base_op`](qiskit.circuit.AnnotatedOperation#base_op "qiskit.circuit.AnnotatedOperation.base_op"). @@ -418,8 +418,8 @@ The available modifiers for [`AnnotatedOperation`](qiskit.circuit.AnnotatedOpera **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – #### PowerModifier @@ -431,7 +431,7 @@ The available modifiers for [`AnnotatedOperation`](qiskit.circuit.AnnotatedOpera **Parameters** - **power** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + **power** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – For information on how to create custom gates and instructions, including how to build one-off objects, and re-usable parametric gates via subclassing, see [Creating custom instructions](#circuit-custom-gates) below. The Qiskit circuit library in [`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library") contains many predefined gates and circuits for you to use. @@ -513,8 +513,8 @@ it is forbidden for the optimizer to cancel out the two $X$ instructions. **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits for the barrier. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the optional label of this barrier. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits for the barrier. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the optional label of this barrier. The [`Store`](#qiskit.circuit.Store "qiskit.circuit.Store") instruction is particularly special, in that it allows writing the result of a [real-time classical computation expression](#circuit-repr-real-time-classical) (an [`expr.Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) in a local classical variable (a [`expr.Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")). It takes *neither* [`Qubit`](#qiskit.circuit.Qubit "qiskit.circuit.Qubit") nor [`Clbit`](#qiskit.circuit.Clbit "qiskit.circuit.Clbit") operands, but has an explicit [`lvalue`](#qiskit.circuit.Store.lvalue "qiskit.circuit.Store.lvalue") and [`rvalue`](#qiskit.circuit.Store.rvalue "qiskit.circuit.Store.rvalue"). @@ -611,7 +611,7 @@ Within [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumC | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | | [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp")(\*args, \*\*kwargs) | Abstract class to encapsulate all control flow operations. | -For convenience, there is a [`frozenset`](https://docs.python.org/3/library/stdtypes.html#frozenset "(in Python v3.13)") instance containing the [`Instruction.name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") attributes of each of the control-flow operations. +For convenience, there is a [`frozenset`](https://docs.python.org/3/library/stdtypes.html#frozenset "(in Python v3.14)") instance containing the [`Instruction.name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") attributes of each of the control-flow operations. #### qiskit.circuit.CONTROL\_FLOW\_OP\_NAMES @@ -814,7 +814,7 @@ Subclasses of [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") will also like Return a Numpy array representing the gate. This can use the gate’s [`params`](qiskit.circuit.Instruction#params "qiskit.circuit.Instruction.params") field, and may assume that these are numeric values (assuming the subclass expects that) and not [compile-time parameters](#circuit-compile-time-parameters). - For greatest efficiency, the returned array should default to a dtype of [`complex`](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)"). + For greatest efficiency, the returned array should default to a dtype of [`complex`](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)"). If your custom subclass has natural representations of its controlled or inverse forms, you may also wish to override the [`inverse()`](qiskit.circuit.Instruction#inverse "qiskit.circuit.Instruction.inverse") and [`control()`](qiskit.circuit.Gate#control "qiskit.circuit.Gate.control") methods. @@ -951,9 +951,9 @@ Pauli twirling is a quantum error suppression technique that uses randomization **Parameters** * **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The circuit to twirl - * **twirling\_gate** (*None |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – The gate to twirl, defaults to None which means twirl all default gates: [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"), [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"), and [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). If supplied it can either be a single gate or a list of gates either as either a gate object or its string name. Currently only the names “cx”, “cz”, “ecr”, and “iswap” are supported. If a gate object is provided outside the default gates it must have a matrix defined from its `to_matrix` method for the gate to potentially be twirled. If a valid twirling configuration can’t be computed that particular gate will be silently ignored and not twirled. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – An integer seed for the random number generator used internally by this function. If specified this must be between 0 and 18,446,744,073,709,551,615. - * **num\_twirls** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of twirling circuits to build. This defaults to `None` and will return a single circuit. If it is an integer a list of circuits with num\_twirls circuits will be returned. + * **twirling\_gate** (*None |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – The gate to twirl, defaults to None which means twirl all default gates: [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"), [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"), and [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). If supplied it can either be a single gate or a list of gates either as either a gate object or its string name. Currently only the names “cx”, “cz”, “ecr”, and “iswap” are supported. If a gate object is provided outside the default gates it must have a matrix defined from its `to_matrix` method for the gate to potentially be twirled. If a valid twirling configuration can’t be computed that particular gate will be silently ignored and not twirled. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – An integer seed for the random number generator used internally by this function. If specified this must be between 0 and 18,446,744,073,709,551,615. + * **num\_twirls** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of twirling circuits to build. This defaults to `None` and will return a single circuit. If it is an integer a list of circuits with num\_twirls circuits will be returned. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target") *| None*) – If specified an [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") instance to use for running single qubit decomposition as part of the Pauli twirling to optimize and map the pauli gates added to the circuit to the specified target. **Returns** @@ -962,7 +962,7 @@ Pauli twirling is a quantum error suppression technique that uses randomization **Return type** - [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") | [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")] + [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") | [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")] ## Exceptions diff --git a/docs/api/qiskit/circuit_annotation.mdx b/docs/api/qiskit/circuit_annotation.mdx index a3a0797f32b..2717778913f 100644 --- a/docs/api/qiskit/circuit_annotation.mdx +++ b/docs/api/qiskit/circuit_annotation.mdx @@ -26,7 +26,7 @@ The main user-facing class is the base class [`qiskit.circuit.Annotation`](qiski The [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") class is intended to be subclassed. Subclasses must set their [`namespace`](qiskit.circuit.Annotation#namespace "qiskit.circuit.Annotation.namespace") field. This can be specific to an instance, or static for an entire subclass. The namespace is used as part of the dispatch mechanism, as described in [Namespacing](#circuit-annotation-namespacing). -Circuit equality checks also compare annotations on objects in an order-dependent manner. You will likely want to implement the [`__eq__()`](https://docs.python.org/3/reference/datamodel.html#object.__eq__ "(in Python v3.13)") magic method on any subclasses. +Circuit equality checks also compare annotations on objects in an order-dependent manner. You will likely want to implement the [`__eq__()`](https://docs.python.org/3/reference/datamodel.html#object.__eq__ "(in Python v3.14)") magic method on any subclasses. If you intend your annotation to be able to be serialized via [QPY](qpy#qiskit-qpy) or :ref:\` OpenQASM 3 \\`, you must provide separate implementations of the serialization and deserialization methods as discussed in [Serialization and deserialization](#circuit-annotation-serialization). @@ -56,11 +56,11 @@ A stand-alone function allows iterating through namespaces and parent namespaces **Parameters** - **namespace** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + **namespace** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – **Return type** - [*Iterator*](https://docs.python.org/3/library/typing.html#typing.Iterator "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")] + [*Iterator*](https://docs.python.org/3/library/typing.html#typing.Iterator "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")] @@ -76,7 +76,7 @@ For all of these reasons, serialization and deserialization of annotations is ha #### QPYSerializer - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") The interface for serializers and deserializers of [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects to QPY. @@ -151,7 +151,7 @@ For all of these reasons, serialization and deserialization of annotations is ha #### OpenQASM3Serializer - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") The interface for serializers and deserializers of [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects to OpenQASM 3. @@ -166,7 +166,7 @@ For all of these reasons, serialization and deserialization of annotations is ha A principal goal of the annotation framework is to allow custom analyses and commands to be stored on circuits in an instruction-local manner, either by the user on entry to the compiler, or for one compiler pass to store information for later consumption. -For example, we can write a simple transpiler pass that collects runs of single-qubit operations, and puts each run into a [`BoxOp`](qiskit.circuit.BoxOp "qiskit.circuit.BoxOp"), the calculates the total unitary action and attaches it as a custom annotation, so the same analysis does not need to be repeated later, even if the internals of each block are optimized. +For example, we can write a simple transpiler pass that collects runs of single-qubit operations, and puts each run into a [`BoxOp`](qiskit.circuit.BoxOp "qiskit.circuit.BoxOp"), then calculates the total unitary action and attaches it as a custom annotation, so the same analysis does not need to be repeated later, even if the internals of each block are optimized. ```python from qiskit.circuit import annotation, QuantumCircuit, BoxOp diff --git a/docs/api/qiskit/circuit_classical.mdx b/docs/api/qiskit/circuit_classical.mdx index e11d15e77e8..ee66868517c 100644 --- a/docs/api/qiskit/circuit_classical.mdx +++ b/docs/api/qiskit/circuit_classical.mdx @@ -47,7 +47,7 @@ The expression system is based on tree representation. All nodes in the tree are #### Expr - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Root base class of all nodes in the expression tree. The base case should never be instantiated directly. @@ -76,7 +76,7 @@ The base for dynamic variables is the [`Var`](#qiskit.circuit.classical.expr.Var ##### name - The name of the variable. This is required to exist if the backing [`var`](#qiskit.circuit.classical.expr.Var.var "qiskit.circuit.classical.expr.Var.var") attribute is a [`UUID`](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.13)"), i.e. if it is a new-style variable, and must be `None` if it is an old-style variable.””” + The name of the variable. This is required to exist if the backing [`var`](#qiskit.circuit.classical.expr.Var.var "qiskit.circuit.classical.expr.Var.var") attribute is a [`UUID`](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.14)"), i.e. if it is a new-style variable, and must be `None` if it is an old-style variable.””” ##### new @@ -88,7 +88,7 @@ The base for dynamic variables is the [`Var`](#qiskit.circuit.classical.expr.Var ##### var - A reference to the backing data storage of the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") instance. When lifting old-style [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") or [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") instances into a [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var"), this is exactly the [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") or [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister"). If the variable is a new-style classical variable (one that owns its own storage separate to the old [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")/[`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") model), this field will be a [`UUID`](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.13)") to uniquely identify it.””” + A reference to the backing data storage of the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") instance. When lifting old-style [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") or [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") instances into a [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var"), this is exactly the [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") or [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister"). If the variable is a new-style classical variable (one that owns its own storage separate to the old [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")/[`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") model), this field will be a [`UUID`](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.14)") to uniquely identify it.””” @@ -128,7 +128,7 @@ Stretch variables for use in duration expressions are represented by the [`Stret ##### var - A [`UUID`](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.13)") to uniquely identify this stretch. + A [`UUID`](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.14)") to uniquely identify this stretch. @@ -150,7 +150,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.14)") Enumeration of the opcodes for unary operations. @@ -177,7 +177,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.14)") Enumeration of the opcodes for binary operations. @@ -262,7 +262,7 @@ The functions and methods described in this section are a more user-friendly way **Parameters** - * **value** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **value** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type") *| None*) – **Return type** @@ -292,7 +292,7 @@ You can manually specify casts in cases where the cast is allowed in explicit fo **Parameters** - * **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – **Return type** @@ -320,7 +320,7 @@ There are helper constructor functions for each of the unary operations. **Parameters** - **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -345,7 +345,7 @@ There are helper constructor functions for each of the unary operations. **Parameters** - **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -372,8 +372,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -398,8 +398,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -424,8 +424,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -450,8 +450,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -476,8 +476,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -502,8 +502,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -528,8 +528,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -554,8 +554,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -580,8 +580,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -606,8 +606,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -632,8 +632,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -667,8 +667,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type") *| None*) – **Return type** @@ -696,8 +696,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type") *| None*) – **Return type** @@ -731,8 +731,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -765,8 +765,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -801,8 +801,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -846,8 +846,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -876,8 +876,8 @@ You can index into unsigned integers and bit-likes using another unsigned intege **Parameters** - * **target** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – - * **index** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **target** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – + * **index** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – **Return type** @@ -893,7 +893,7 @@ Qiskit’s legacy method for specifying equality conditions for use in condition **Parameters** - **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*qiskit.circuit.Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*qiskit.circuit.ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*qiskit.circuit.Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*qiskit.circuit.ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – **Return type** @@ -907,7 +907,7 @@ A typical consumer of the expression tree wants to recursively walk through the #### ExprVisitor - Bases: [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.13)")\[`_T_co`] + Bases: [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.14)")\[`_T_co`] Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organized such that non-existent methods will never be called. @@ -1045,7 +1045,7 @@ For the convenience of simple visitors that only need to inspect the variables i **Return type** - [*Iterator*](https://docs.python.org/3/library/typing.html#typing.Iterator "(in Python v3.13)")\[[*Var*](#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")] + [*Iterator*](https://docs.python.org/3/library/typing.html#typing.Iterator "(in Python v3.14)")\[[*Var*](#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")] To iterator over all variables including stretch variables, the iterator method [`iter_identifiers()`](#qiskit.circuit.classical.expr.iter_identifiers "qiskit.circuit.classical.expr.iter_identifiers") is provided. @@ -1083,7 +1083,7 @@ To iterator over all variables including stretch variables, the iterator method **Return type** - [*Iterator*](https://docs.python.org/3/library/typing.html#typing.Iterator "(in Python v3.13)")\[[*Var*](#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var") | [*Stretch*](#qiskit.circuit.classical.expr.Stretch "qiskit._accelerate.circuit.classical.expr.Stretch")] + [*Iterator*](https://docs.python.org/3/library/typing.html#typing.Iterator "(in Python v3.14)")\[[*Var*](#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var") | [*Stretch*](#qiskit.circuit.classical.expr.Stretch "qiskit._accelerate.circuit.classical.expr.Stretch")] Two expressions can be compared for direct structural equality by using the built-in Python `==` operator. In general, though, one might want to compare two expressions slightly more semantically, allowing that the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes inside them are bound to different memory-location descriptions between two different circuits. In this case, one can use [`structurally_equivalent()`](#qiskit.circuit.classical.expr.structurally_equivalent "qiskit.circuit.classical.expr.structurally_equivalent") with two suitable “key” functions to do the comparison. @@ -1101,12 +1101,12 @@ Two expressions can be compared for direct structural equality by using the buil * **left** ([*expr.Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – one of the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") nodes. * **right** ([*expr.Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – the other [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") node. - * **left\_var\_key** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*],* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*] | None*) – a callable whose output should be used when comparing [`Var.var`](#qiskit.circuit.classical.expr.Var.var "qiskit.circuit.classical.expr.Var.var") attributes. If this argument is `None` or its output is `None` for a given variable in `left`, the variable will be used verbatim. - * **right\_var\_key** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*],* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*] | None*) – same as `left_var_key`, but used on the variables in `right` instead. + * **left\_var\_key** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)")*\[\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")*],* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")*] | None*) – a callable whose output should be used when comparing [`Var.var`](#qiskit.circuit.classical.expr.Var.var "qiskit.circuit.classical.expr.Var.var") attributes. If this argument is `None` or its output is `None` for a given variable in `left`, the variable will be used verbatim. + * **right\_var\_key** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)")*\[\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")*],* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")*] | None*) – same as `left_var_key`, but used on the variables in `right` instead. **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") **Examples** @@ -1182,7 +1182,7 @@ Some expressions have associated memory locations, and others may be purely temp **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") @@ -1204,7 +1204,7 @@ All types inherit from an abstract base class: #### Type - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Root base class of all nodes in the type tree. The base case should never be instantiated directly. @@ -1296,7 +1296,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. #### Ordering - Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.14)") Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. @@ -1333,11 +1333,11 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – - * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") #### is\_supertype @@ -1368,11 +1368,11 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – - * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") #### greater @@ -1386,7 +1386,7 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis **Raises** - [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – if there is no ordering relation between the two types. + [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – if there is no ordering relation between the two types. **Parameters** @@ -1410,7 +1410,7 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis ### Casting between types -It is common to need to cast values of one type to another type. The casting rules for this are embedded into the [`types`](https://docs.python.org/3/library/types.html#module-types "(in Python v3.13)") module. You can query the casting kinds using [`cast_kind()`](#qiskit.circuit.classical.types.cast_kind "qiskit.circuit.classical.types.cast_kind"): +It is common to need to cast values of one type to another type. The casting rules for this are embedded into the [`types`](https://docs.python.org/3/library/types.html#module-types "(in Python v3.14)") module. You can query the casting kinds using [`cast_kind()`](#qiskit.circuit.classical.types.cast_kind "qiskit.circuit.classical.types.cast_kind"): #### cast\_kind @@ -1448,7 +1448,7 @@ Note that casts between [`Float`](#qiskit.circuit.classical.types.Float "qiskit. #### CastKind - Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.14)") A return value indicating the type of cast that can occur from one type to another. diff --git a/docs/api/qiskit/circuit_random.mdx b/docs/api/qiskit/circuit_random.mdx index e1a40dbb09f..51f83b7324f 100644 --- a/docs/api/qiskit/circuit_random.mdx +++ b/docs/api/qiskit/circuit_random.mdx @@ -40,14 +40,14 @@ These circuits can be used for benchmarking existing quantum hardware and estima **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of quantum wires - * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – layers of operations (i.e. critical path length) - * **max\_operands** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – maximum qubit operands of each gate (between 1 and 4) - * **measure** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, measure all qubits at the end - * **conditional** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, insert middle measurements and conditionals - * **reset** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, insert middle resets - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – sets random seed (optional) - * **num\_operand\_distribution** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – a distribution of gates that specifies the ratio of 1-qubit, 2-qubit, 3-qubit, …, n-qubit gates in the random circuit. Expect a deviation from the specified ratios that depends on the size of the requested random circuit. (optional) + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of quantum wires + * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – layers of operations (i.e. critical path length) + * **max\_operands** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – maximum qubit operands of each gate (between 1 and 4) + * **measure** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, measure all qubits at the end + * **conditional** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, insert middle measurements and conditionals + * **reset** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, insert middle resets + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – sets random seed (optional) + * **num\_operand\_distribution** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – a distribution of gates that specifies the ratio of 1-qubit, 2-qubit, 3-qubit, …, n-qubit gates in the random circuit. Expect a deviation from the specified ratios that depends on the size of the requested random circuit. (optional) **Returns** @@ -97,16 +97,16 @@ These circuits can be used for benchmarking existing quantum hardware and estima **Parameters** - * **interaction\_graph** (*PyGraph | PyDiGraph | List\[Tuple\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]]*) – Interaction Graph - * **min\_2q\_gate\_per\_edge** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Minimum number of times every qubit-pair must be used in the random circuit. (optional, default:1) - * **max\_operands** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – maximum qubit operands of each gate(should be 1 or 2) (optional, default:2) - * **measure** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, measure all qubits at the end. (optional, default: False) - * **conditional** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, insert middle measurements and conditionals. (optional, default: False) - * **reset** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, insert middle resets. (optional, default: False) - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – sets random seed. (If None, a random seed is chosen) (optional) - * **insert\_1q\_oper** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Insert 1Q operations to the circuit. (optional, default: True) - * **prob\_conditional** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Probability less than 1.0, this is used to control the occurrence of conditionals in the circuit. (optional, default: 0.1) - * **prob\_reset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Probability less than 1.0, this is used to control the occurrence of reset in the circuit. (optional, default: 0.1) + * **interaction\_graph** (*PyGraph | PyDiGraph | List\[Tuple\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]]*) – Interaction Graph + * **min\_2q\_gate\_per\_edge** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Minimum number of times every qubit-pair must be used in the random circuit. (optional, default:1) + * **max\_operands** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – maximum qubit operands of each gate(should be 1 or 2) (optional, default:2) + * **measure** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, measure all qubits at the end. (optional, default: False) + * **conditional** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, insert middle measurements and conditionals. (optional, default: False) + * **reset** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, insert middle resets. (optional, default: False) + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – sets random seed. (If None, a random seed is chosen) (optional) + * **insert\_1q\_oper** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Insert 1Q operations to the circuit. (optional, default: True) + * **prob\_conditional** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Probability less than 1.0, this is used to control the occurrence of conditionals in the circuit. (optional, default: 0.1) + * **prob\_reset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Probability less than 1.0, this is used to control the occurrence of reset in the circuit. (optional, default: 0.1) **Returns** @@ -122,7 +122,7 @@ These circuits can be used for benchmarking existing quantum hardware and estima * [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – When max\_operands is set to 1, but no 1Q operations are allowed by setting insert\_1q\_oper to false. * [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – When the interaction graph has no edges, so only 1Q gates are possible in the circuit, but insert\_1q\_oper is set to False. * [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – When an invalid interaction graph object is passed. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – Given max\_operands=2, when any edge have probability None but not all, or any of the probabilities are negative. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – Given max\_operands=2, when any edge have probability None but not all, or any of the probabilities are negative. ### Generating arbitrary circuits with clifford gates @@ -145,10 +145,10 @@ These circuits can be used for benchmarking existing quantum hardware and estima **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of quantum wires. - * **num\_gates** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of gates in the circuit. - * **gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – optional list of Clifford gate names to randomly sample from. If `"all"` (default), use all Clifford gates in the standard library. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| np.random.Generator*) – sets random seed/generator (optional). + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of quantum wires. + * **num\_gates** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of gates in the circuit. + * **gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – optional list of Clifford gate names to randomly sample from. If `"all"` (default), use all Clifford gates in the standard library. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| np.random.Generator*) – sets random seed/generator (optional). **Returns** diff --git a/docs/api/qiskit/circuit_singleton.mdx b/docs/api/qiskit/circuit_singleton.mdx index 02ff9df0fb5..0f19791fdb0 100644 --- a/docs/api/qiskit/circuit_singleton.mdx +++ b/docs/api/qiskit/circuit_singleton.mdx @@ -20,7 +20,7 @@ The machinery in this module is for defining subclasses of [`Instruction`](qiski * There is a regular class called `XGate`, which derives from [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). * Doing something like `XGate(label="my_gate")` produces an object whose type is exactly `XGate`, and all the mutability works completely as expected; all the methods resolve to exactly those defined by [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"), [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), or parents. -* Doing `XGate()` produces a singleton object whose type is a synthetic `_SingletonXGate` class, which derives [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") but overrides [`__setattr__()`](https://docs.python.org/3/reference/datamodel.html#object.__setattr__ "(in Python v3.13)") to make itself immutable. The object itself has precisely the same instance attributes as `XGate()` would have if there was no singleton handling. This object will return itself under [`copy()`](https://docs.python.org/3/library/copy.html#copy.copy "(in Python v3.13)"), [`deepcopy()`](https://docs.python.org/3/library/copy.html#copy.deepcopy "(in Python v3.13)") and roundtrip through [`pickle`](https://docs.python.org/3/library/pickle.html#module-pickle "(in Python v3.13)"). +* Doing `XGate()` produces a singleton object whose type is a synthetic `_SingletonXGate` class, which derives [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") but overrides [`__setattr__()`](https://docs.python.org/3/reference/datamodel.html#object.__setattr__ "(in Python v3.14)") to make itself immutable. The object itself has precisely the same instance attributes as `XGate()` would have if there was no singleton handling. This object will return itself under [`copy()`](https://docs.python.org/3/library/copy.html#copy.copy "(in Python v3.14)"), [`deepcopy()`](https://docs.python.org/3/library/copy.html#copy.deepcopy "(in Python v3.14)") and roundtrip through [`pickle`](https://docs.python.org/3/library/pickle.html#module-pickle "(in Python v3.14)"). The same can be true for, for example, [`Measure`](circuit#qiskit.circuit.Measure "qiskit.circuit.Measure"), except that it’s a subclass of [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") only, and not [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). @@ -74,7 +74,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") semantics as well. The same caveats around setting attributes in that class apply here as well. -When inheriting from one of these classes, the produced class will have an eagerly created singleton instance that will be returned whenever the class is constructed with arguments that have been defined to be singletons. Typically this will be the defaults. These instances are immutable; attempts to modify their properties will raise [`TypeError`](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)"). +When inheriting from one of these classes, the produced class will have an eagerly created singleton instance that will be returned whenever the class is constructed with arguments that have been defined to be singletons. Typically this will be the defaults. These instances are immutable; attempts to modify their properties will raise [`TypeError`](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)"). *All* subclasses of [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") have a [`mutable`](qiskit.circuit.Instruction#mutable "qiskit.circuit.Instruction.mutable") property. For most instructions this is `True`, while for the singleton instances it is `False`. One can use the [`to_mutable()`](qiskit.circuit.Instruction#to_mutable "qiskit.circuit.Instruction.to_mutable") method to get a version of the instruction that is owned and safe to mutate. @@ -84,11 +84,11 @@ The singleton instances are not exact instances of their base class; they are sp type(XGate()) is not XGate ``` -You should not rely on [`type`](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)") having an exact value; use [`isinstance()`](https://docs.python.org/3/library/functions.html#isinstance "(in Python v3.13)") instead for type checking. If you need to reliably retrieve the base class from an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction"), see the [`Instruction.base_class`](qiskit.circuit.Instruction#base_class "qiskit.circuit.Instruction.base_class") attribute; singleton instances set this correctly. For most cases in using Qiskit, [`Instruction.name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") is a more suitable determiner of what an instruction “means” in a circuit. +You should not rely on [`type`](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)") having an exact value; use [`isinstance()`](https://docs.python.org/3/library/functions.html#isinstance "(in Python v3.14)") instead for type checking. If you need to reliably retrieve the base class from an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction"), see the [`Instruction.base_class`](qiskit.circuit.Instruction#base_class "qiskit.circuit.Instruction.base_class") attribute; singleton instances set this correctly. For most cases in using Qiskit, [`Instruction.name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") is a more suitable determiner of what an instruction “means” in a circuit. ### Deriving new singletons -The simplest example of deriving a new singleton instruction is simply to inherit from the correct base and supply an [`__init__()`](https://docs.python.org/3/reference/datamodel.html#object.__init__ "(in Python v3.13)") method that has immutable defaults for any arguments. For example: +The simplest example of deriving a new singleton instruction is simply to inherit from the correct base and supply an [`__init__()`](https://docs.python.org/3/reference/datamodel.html#object.__init__ "(in Python v3.14)") method that has immutable defaults for any arguments. For example: ```python from qiskit.circuit.singleton import SingletonInstruction @@ -183,7 +183,7 @@ The case of the class being instantiated with zero arguments is handled speciall This section is primarily developer documentation for the code; none of the machinery described here is public, and it is not safe to inherit from any of it directly. -There are several moving parts to tackle here. The behavior of having `XGate()` return some singleton object that is an (inexact) instance of [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") but *without* calling `__init__` requires us to override [`type.__call__`](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)"). This means that [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") must have a metaclass that defines `__call__` to return the singleton instance. +There are several moving parts to tackle here. The behavior of having `XGate()` return some singleton object that is an (inexact) instance of [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") but *without* calling `__init__` requires us to override [`type.__call__`](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)"). This means that [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") must have a metaclass that defines `__call__` to return the singleton instance. Next, we need to ensure that there *is* a singleton instance for `XGate()` to return. This can be done dynamically on each call (i.e. check if the instance exists and create it if not), but since we also want that instance to be very special, it’s easier to hook in and create it during the definition of the `XGate` type object. This also has the advantage that we do not need to make the singleton object pickleable; we only need to specify where to retrieve it from during the unpickle, because the creation of the base type object will recreate the singleton. @@ -204,9 +204,9 @@ We could do this entirely within the metaclass machinery, but that would require class XGate(Gate, metaclass=_SingletonMeta, overrides=_SingletonGateOverrides): ... ``` -which is super inconvenient (or we’d have to have `_SingletonMeta` do a bunch of fragile introspection). Instead, we use the [`abc.ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)")/[`abc.ABCMeta`](https://docs.python.org/3/library/abc.html#abc.ABCMeta "(in Python v3.13)") pattern of defining a concrete middle class ([`SingletonGate`](#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") in the [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") case) that sets the metaclass, selects the overrides to be applied, and has an [`__init_subclass__()`](https://docs.python.org/3/reference/datamodel.html#object.__init_subclass__ "(in Python v3.13)") that applies the singleton-subclass-creation steps above. The overrides are in separate classes so that *mutable* [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") instances do not have them in their own method-resolution orders; doing this is easier to implement, but requires all the setters and checkers to dance around at runtime trying to validate whether mutating the instance is allowed. +which is super inconvenient (or we’d have to have `_SingletonMeta` do a bunch of fragile introspection). Instead, we use the [`abc.ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)")/[`abc.ABCMeta`](https://docs.python.org/3/library/abc.html#abc.ABCMeta "(in Python v3.14)") pattern of defining a concrete middle class ([`SingletonGate`](#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") in the [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") case) that sets the metaclass, selects the overrides to be applied, and has an [`__init_subclass__()`](https://docs.python.org/3/reference/datamodel.html#object.__init_subclass__ "(in Python v3.14)") that applies the singleton-subclass-creation steps above. The overrides are in separate classes so that *mutable* [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") instances do not have them in their own method-resolution orders; doing this is easier to implement, but requires all the setters and checkers to dance around at runtime trying to validate whether mutating the instance is allowed. -Finally, to actually build all this machinery up, the base is `_SingletonMeta`, which is a metaclass compatible with any metaclass of [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction"). This defines the [`__call__()`](https://docs.python.org/3/reference/datamodel.html#object.__call__ "(in Python v3.13)") machinery that overrides [`type.__call__`](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)") to return the singleton instances. The other component of it is its [`__new__()`](https://docs.python.org/3/reference/datamodel.html#object.__new__ "(in Python v3.13)"), which is called (non-trivially) during the creation of [`SingletonGate`](#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") and [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") with its `overrides` keyword argument set to define the `__init_subclass__` of those classes with the above properties. We use the metaclass to add this method dynamically, because the [`__init_subclass__()`](https://docs.python.org/3/reference/datamodel.html#object.__init_subclass__ "(in Python v3.13)") machinery wants to be abstract, closing over the `overrides` and the base class, but still able to call [`super`](https://docs.python.org/3/library/functions.html#super "(in Python v3.13)"). It’s more convenient to do this dynamically, closing over the desired class variable and using the two-argument form of [`super`](https://docs.python.org/3/library/functions.html#super "(in Python v3.13)"), since the zero-argument form does magic introspection based on where its containing function was defined. +Finally, to actually build all this machinery up, the base is `_SingletonMeta`, which is a metaclass compatible with any metaclass of [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction"). This defines the [`__call__()`](https://docs.python.org/3/reference/datamodel.html#object.__call__ "(in Python v3.14)") machinery that overrides [`type.__call__`](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)") to return the singleton instances. The other component of it is its [`__new__()`](https://docs.python.org/3/reference/datamodel.html#object.__new__ "(in Python v3.14)"), which is called (non-trivially) during the creation of [`SingletonGate`](#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") and [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") with its `overrides` keyword argument set to define the `__init_subclass__` of those classes with the above properties. We use the metaclass to add this method dynamically, because the [`__init_subclass__()`](https://docs.python.org/3/reference/datamodel.html#object.__init_subclass__ "(in Python v3.14)") machinery wants to be abstract, closing over the `overrides` and the base class, but still able to call [`super`](https://docs.python.org/3/library/functions.html#super "(in Python v3.14)"). It’s more convenient to do this dynamically, closing over the desired class variable and using the two-argument form of [`super`](https://docs.python.org/3/library/functions.html#super "(in Python v3.14)"), since the zero-argument form does magic introspection based on where its containing function was defined. Handling multiple singletons requires storing the initialization arguments in some form, to allow the [`to_mutable()`](qiskit.circuit.Instruction#to_mutable "qiskit.circuit.Instruction.to_mutable") method and pickling to be defined. We do this as a lookup dictionary on the singleton *type object*. This is logically an instance attribute, but because we need to dynamically switch in the dynamic \_Singleton type onto an instance of the base type, that gets rather complex; either we have to require that the base already has an instance dictionary, or we risk breaking the `__slots__` layout during the switch. Since the singletons have lifetimes that last until garbage collection of their base class’s type object, we can fake out this instance dictionary using a type-object dictionary that maps instance pointers to the data we want to store. An alternative would be to build a new type object for each individual singleton that closes over (or stores) the initializer arguments, but type objects are quite heavy and the principle is largely same anyway. diff --git a/docs/api/qiskit/compiler.mdx b/docs/api/qiskit/compiler.mdx index f23a9adf6b1..f7585112db2 100644 --- a/docs/api/qiskit/compiler.mdx +++ b/docs/api/qiskit/compiler.mdx @@ -39,9 +39,9 @@ python_api_name: qiskit.compiler * **backend** ([*Backend*](qiskit.providers.Backend "qiskit.providers.backend.Backend") *| None*) – If set, the transpiler will compile the input circuit to this target device. If any other option is explicitly set (e.g., `coupling_map`), it will override the backend’s. - * **basis\_gates** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – List of basis gate names to unroll to (e.g: `['u1', 'u2', 'u3', 'cx']`). If `None`, do not unroll. + * **basis\_gates** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] | None*) – List of basis gate names to unroll to (e.g: `['u1', 'u2', 'u3', 'cx']`). If `None`, do not unroll. - * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.coupling.CouplingMap") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | None*) – + * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.coupling.CouplingMap") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]] | None*) – Directed coupling map (perhaps custom) to target in mapping. If the coupling map is symmetric, both directions need to be specified. @@ -50,7 +50,7 @@ python_api_name: qiskit.compiler 1. `CouplingMap` instance 2. List, must be given as an adjacency matrix, where each entry specifies all directed two-qubit interactions supported by backend, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]` - * **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.layout.Layout") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)") *| None*) – + * **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.layout.Layout") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.14)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)") *| None*) – Initial position of virtual qubits on physical qubits. If this layout makes the circuit compatible with the coupling\_map constraints, it will be used. The final layout is not guaranteed to be the same, as the transpiler may permute qubits through swaps or other means. Multiple formats are supported: @@ -86,21 +86,21 @@ python_api_name: qiskit.compiler [qr[0], None, None, qr[1], None, qr[2]] ``` - * **layout\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Name of layout selection pass (‘trivial’, ‘dense’, ‘sabre’). This can also be the external plugin name to use for the `layout` stage. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"layout"` for the `stage_name` argument. + * **layout\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Name of layout selection pass (‘trivial’, ‘dense’, ‘sabre’). This can also be the external plugin name to use for the `layout` stage. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"layout"` for the `stage_name` argument. - * **routing\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Name of routing pass (‘basic’, ‘lookahead’, ‘stochastic’, ‘sabre’, ‘none’). Note This can also be the external plugin name to use for the `routing` stage. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"routing"` for the `stage_name` argument. + * **routing\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Name of routing pass (‘basic’, ‘lookahead’, ‘stochastic’, ‘sabre’, ‘none’). Note This can also be the external plugin name to use for the `routing` stage. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"routing"` for the `stage_name` argument. - * **translation\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Name of translation pass (`"default"`, `"translator"` or `"synthesis"`). This can also be the external plugin name to use for the `translation` stage. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"translation"` for the `stage_name` argument. + * **translation\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Name of translation pass (`"default"`, `"translator"` or `"synthesis"`). This can also be the external plugin name to use for the `translation` stage. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"translation"` for the `stage_name` argument. - * **scheduling\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Name of scheduling pass. \* `'as_soon_as_possible'`: Schedule instructions greedily, as early as possible on a qubit resource. (alias: `'asap'`) \* `'as_late_as_possible'`: Schedule instructions late, i.e. keeping qubits in the ground state when possible. (alias: `'alap'`) If `None`, no scheduling will be done. This can also be the external plugin name to use for the `scheduling` stage. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"scheduling"` for the `stage_name` argument. + * **scheduling\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Name of scheduling pass. \* `'as_soon_as_possible'`: Schedule instructions greedily, as early as possible on a qubit resource. (alias: `'asap'`) \* `'as_late_as_possible'`: Schedule instructions late, i.e. keeping qubits in the ground state when possible. (alias: `'alap'`) If `None`, no scheduling will be done. This can also be the external plugin name to use for the `scheduling` stage. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"scheduling"` for the `stage_name` argument. - * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – Backend sample time (resolution) in seconds. If `None` (default), `backend.dt` is used. + * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – Backend sample time (resolution) in seconds. If `None` (default), `backend.dt` is used. - * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation) + * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation) - * **seed\_transpiler** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – Sets random seed for the stochastic parts of the transpiler + * **seed\_transpiler** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – Sets random seed for the stochastic parts of the transpiler - * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer transpilation time. @@ -111,7 +111,7 @@ python_api_name: qiskit.compiler If `None`, level 2 will be chosen as default. - * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[BasePass,* [*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*,* [*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.compilation_status.PropertySet")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*] | None*) – + * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)")*\[\[BasePass,* [*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*,* [*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.compilation_status.PropertySet")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")*] | None*) – A callback function that will be called after each pass execution. The function will be called with 5 keyword arguments, | `pass_`: the pass being run. | `dag`: the dag output of the pass. | `time`: the time to execute the pass. | `property_set`: the property set. | `count`: the index for the pass execution. The exact arguments passed expose the internals of the pass manager, and are subject to change as the pass manager internals change. If you intend to reuse a callback function over multiple releases, be sure to check that the arguments being passed are the same. To use the callback feature, define a function that will take in kwargs dict and access the variables. For example: @@ -126,25 +126,25 @@ python_api_name: qiskit.compiler transpile(circ, callback=callback_func) ``` - * **output\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – A list with strings to identify the output circuits. The length of the list should be exactly the length of the `circuits` parameter. + * **output\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] | None*) – A list with strings to identify the output circuits. The length of the list should be exactly the length of the `circuits` parameter. - * **unitary\_synthesis\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the unitary synthesis method to use. By default `'default'` is used. You can see a list of installed plugins with [`unitary_synthesis_plugin_names()`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names"). + * **unitary\_synthesis\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the unitary synthesis method to use. By default `'default'` is used. You can see a list of installed plugins with [`unitary_synthesis_plugin_names()`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names"). - * **unitary\_synthesis\_plugin\_config** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – An optional configuration dictionary that will be passed directly to the unitary synthesis plugin. By default this setting will have no effect as the default unitary synthesis method does not take custom configuration. This should only be necessary when a unitary synthesis plugin is specified with the `unitary_synthesis_method` argument. As this is custom for each unitary synthesis plugin refer to the plugin documentation for how to use this option. + * **unitary\_synthesis\_plugin\_config** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *| None*) – An optional configuration dictionary that will be passed directly to the unitary synthesis plugin. By default this setting will have no effect as the default unitary synthesis method does not take custom configuration. This should only be necessary when a unitary synthesis plugin is specified with the `unitary_synthesis_method` argument. As this is custom for each unitary synthesis plugin refer to the plugin documentation for how to use this option. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.target.Target") *| None*) – A backend transpiler target. Normally this is specified as part of the `backend` argument, but if you have manually constructed a [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object you can specify it manually here. This will override the target from `backend`. * **hls\_config** ([*HLSConfig*](qiskit.transpiler.passes.HLSConfig "qiskit.transpiler.passes.synthesis.high_level_synthesis.HLSConfig") *| None*) – An optional configuration class `HLSConfig` that will be passed directly to `HighLevelSynthesis` transformation pass. This configuration class allows to specify for various high-level objects the lists of synthesis algorithms and their parameters. - * **init\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The plugin name to use for the `init` stage. By default an external plugin is not used. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"init"` for the stage name argument. + * **init\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The plugin name to use for the `init` stage. By default an external plugin is not used. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"init"` for the stage name argument. - * **optimization\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The plugin name to use for the `optimization` stage. By default an external plugin is not used. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"optimization"` for the `stage_name` argument. + * **optimization\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The plugin name to use for the `optimization` stage. By default an external plugin is not used. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"optimization"` for the `stage_name` argument. - * **ignore\_backend\_supplied\_default\_methods** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to `True` any default methods specified by a backend will be ignored. Some backends specify alternative default methods to support custom compilation target-specific passes/plugins which support backend-specific compilation techniques. If you’d prefer that these defaults were not used this option is used to disable those backend-specific defaults. + * **ignore\_backend\_supplied\_default\_methods** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to `True` any default methods specified by a backend will be ignored. Some backends specify alternative default methods to support custom compilation target-specific passes/plugins which support backend-specific compilation techniques. If you’d prefer that these defaults were not used this option is used to disable those backend-specific defaults. - * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The maximum number of parallel processes to launch for this call to transpile if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. + * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The maximum number of parallel processes to launch for this call to transpile if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. - * **qubits\_initially\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Indicates whether the input circuit is zero-initialized. + * **qubits\_initially\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Indicates whether the input circuit is zero-initialized. **Returns** diff --git a/docs/api/qiskit/converters.mdx b/docs/api/qiskit/converters.mdx index 58ab2549049..e45b955c242 100644 --- a/docs/api/qiskit/converters.mdx +++ b/docs/api/qiskit/converters.mdx @@ -30,9 +30,9 @@ python_api_name: qiskit.converters **Parameters** * **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuit. - * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the instruction. If None, existing circuit parameters will also parameterize the instruction. + * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the instruction. If None, existing circuit parameters will also parameterize the instruction. * **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – Optional equivalence library where the converted instruction will be registered. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Optional instruction label. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Optional instruction label. **Raises** @@ -73,9 +73,9 @@ python_api_name: qiskit.converters **Parameters** * **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuit. - * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the gate. If None, existing circuit parameters will also parameterize the Gate. + * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the gate. If None, existing circuit parameters will also parameterize the Gate. * **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – Optional equivalence library where the converted gate will be registered. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Optional gate label. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Optional gate label. **Raises** @@ -102,7 +102,7 @@ python_api_name: qiskit.converters **Parameters** * **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuit. - * **copy\_operations** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Deep copy the operation objects in the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") for the output [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"). This should only be set to `False` if the input [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") will not be used anymore as the operations in the output [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") will be shared instances and modifications to operations in the [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") will be reflected in the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") (and vice versa). + * **copy\_operations** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Deep copy the operation objects in the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") for the output [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"). This should only be set to `False` if the input [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") will not be used anymore as the operations in the output [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") will be shared instances and modifications to operations in the [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") will be reflected in the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") (and vice versa). * **qubit\_order** (*Iterable\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*] or None*) – the order that the qubits should be indexed in the output DAG. Defaults to the same order as in the circuit. * **clbit\_order** (*Iterable\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*] or None*) – the order that the clbits should be indexed in the output DAG. Defaults to the same order as in the circuit. @@ -116,7 +116,7 @@ python_api_name: qiskit.converters **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if the `qubit_order` or `clbit_order` parameters do not match the bits in the circuit. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if the `qubit_order` or `clbit_order` parameters do not match the bits in the circuit. **Example** @@ -144,7 +144,7 @@ python_api_name: qiskit.converters **Parameters** * **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the input dag. - * **copy\_operations** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Deep copy the operation objects in the [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") for the output [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). This should only be set to `False` if the input [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") will not be used anymore as the operations in the output [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") will be shared instances and modifications to operations in the [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") will be reflected in the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") (and vice versa). + * **copy\_operations** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Deep copy the operation objects in the [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") for the output [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). This should only be set to `False` if the input [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") will not be used anymore as the operations in the output [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") will be shared instances and modifications to operations in the [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") will be reflected in the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") (and vice versa). **Returns** @@ -208,7 +208,7 @@ python_api_name: qiskit.converters **Parameters** * **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuit. - * **create\_preds\_and\_succs** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – whether to construct lists of predecessors and successors for every node. + * **create\_preds\_and\_succs** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – whether to construct lists of predecessors and successors for every node. **Returns** @@ -231,7 +231,7 @@ python_api_name: qiskit.converters **Parameters** * **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the input dag. - * **create\_preds\_and\_succs** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – whether to construct lists of predecessors and successors for every node. + * **create\_preds\_and\_succs** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – whether to construct lists of predecessors and successors for every node. **Returns** diff --git a/docs/api/qiskit/dev/_toc.json b/docs/api/qiskit/dev/_toc.json index fffb246c089..5db5c233b2d 100644 --- a/docs/api/qiskit/dev/_toc.json +++ b/docs/api/qiskit/dev/_toc.json @@ -2134,10 +2134,6 @@ { "title": "v2", "children": [ - { - "title": "v2.3", - "url": "/docs/api/qiskit/release-notes/2.3" - }, { "title": "v2.2", "url": "/docs/api/qiskit/release-notes/2.2" diff --git a/docs/api/qiskit/exceptions.mdx b/docs/api/qiskit/exceptions.mdx index 7d448c749da..fb251c124f5 100644 --- a/docs/api/qiskit/exceptions.mdx +++ b/docs/api/qiskit/exceptions.mdx @@ -23,7 +23,7 @@ All Qiskit-related exceptions raised by Qiskit are subclasses of the base: ### QiskitError - Bases: [`Exception`](https://docs.python.org/3/library/exceptions.html#Exception "(in Python v3.13)") + Bases: [`Exception`](https://docs.python.org/3/library/exceptions.html#Exception "(in Python v3.14)") Base class for errors raised by Qiskit. @@ -41,7 +41,7 @@ Qiskit has several optional features that depend on other packages that are not ### MissingOptionalLibraryError - Bases: [`QiskitError`](#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError"), [`ImportError`](https://docs.python.org/3/library/exceptions.html#ImportError "(in Python v3.13)") + Bases: [`QiskitError`](#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError"), [`ImportError`](https://docs.python.org/3/library/exceptions.html#ImportError "(in Python v3.14)") Raised when an optional library is missing. @@ -49,10 +49,10 @@ Qiskit has several optional features that depend on other packages that are not **Parameters** - * **libname** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – - * **pip\_install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – - * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **libname** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – + * **pip\_install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – **Return type** @@ -83,12 +83,12 @@ Two more uncommon errors relate to failures in reading user-configuration files, ## Warnings -Some particular features of Qiskit may raise custom warnings. In general, Qiskit will use built-in Python warnings (such as [`DeprecationWarning`](https://docs.python.org/3/library/exceptions.html#DeprecationWarning "(in Python v3.13)")) when appropriate, but warnings related to Qiskit-specific functionality will be subtypes of [`QiskitWarning`](#qiskit.exceptions.QiskitWarning "qiskit.exceptions.QiskitWarning"). +Some particular features of Qiskit may raise custom warnings. In general, Qiskit will use built-in Python warnings (such as [`DeprecationWarning`](https://docs.python.org/3/library/exceptions.html#DeprecationWarning "(in Python v3.14)")) when appropriate, but warnings related to Qiskit-specific functionality will be subtypes of [`QiskitWarning`](#qiskit.exceptions.QiskitWarning "qiskit.exceptions.QiskitWarning"). ### QiskitWarning - Bases: [`UserWarning`](https://docs.python.org/3/library/exceptions.html#UserWarning "(in Python v3.13)") + Bases: [`UserWarning`](https://docs.python.org/3/library/exceptions.html#UserWarning "(in Python v3.14)") Common subclass of warnings for Qiskit-specific warnings being raised. @@ -119,7 +119,7 @@ When experimental features are being used, Qiskit will raise [`ExperimentalWarni ### Filtering warnings -Python has built-in mechanisms to filter warnings, described in the documentation of the [`warnings`](https://docs.python.org/3/library/warnings.html#module-warnings "(in Python v3.13)") module. You can use these subclasses in your warning filters from within Python to silence warnings you are not interested in. For example, if you are knowingly using experimental features and are comfortable that they make break in later versions, you can silence [`ExperimentalWarning`](#qiskit.exceptions.ExperimentalWarning "qiskit.exceptions.ExperimentalWarning") like this: +Python has built-in mechanisms to filter warnings, described in the documentation of the [`warnings`](https://docs.python.org/3/library/warnings.html#module-warnings "(in Python v3.14)") module. You can use these subclasses in your warning filters from within Python to silence warnings you are not interested in. For example, if you are knowingly using experimental features and are comfortable that they make break in later versions, you can silence [`ExperimentalWarning`](#qiskit.exceptions.ExperimentalWarning "qiskit.exceptions.ExperimentalWarning") like this: ```python import warnings diff --git a/docs/api/qiskit/qasm2.mdx b/docs/api/qiskit/qasm2.mdx index 005887cd9c7..edcf6d1bd81 100644 --- a/docs/api/qiskit/qasm2.mdx +++ b/docs/api/qiskit/qasm2.mdx @@ -35,12 +35,12 @@ This module contains two public functions, both of which create a [`QuantumCircu **Parameters** - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*PathLike*](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.13)")) – The OpenQASM 2 program in a string. - * **include\_path** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*PathLike*](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.13)")*]*) – order of directories to search when evaluating `include` statements. - * **include\_input\_directory** ([*Literal*](https://docs.python.org/3/library/typing.html#typing.Literal "(in Python v3.13)")*\['append', 'prepend'] | None*) – Whether to add the directory of the input file to the `include_path`, and if so, whether to *append* it to search last, or *prepend* it to search first. Pass `None` to suppress adding this directory entirely. - * **custom\_instructions** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*CustomInstruction*](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.parse.CustomInstruction")*]*) – any custom constructors that should be used for specific gates or opaque instructions during circuit construction. See [Specifying custom instructions](#qasm2-custom-instructions) for more. - * **custom\_classical** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*CustomClassical*](#qiskit.qasm2.CustomClassical "qiskit.qasm2.CustomClassical")*]*) – any custom classical functions that should be used during the parsing of classical expressions. See [Specifying custom classical functions](#qasm2-custom-classical) for more. - * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – whether to run in [strict mode](#qasm2-strict-mode). + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*PathLike*](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.14)")) – The OpenQASM 2 program in a string. + * **include\_path** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*PathLike*](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.14)")*]*) – order of directories to search when evaluating `include` statements. + * **include\_input\_directory** ([*Literal*](https://docs.python.org/3/library/typing.html#typing.Literal "(in Python v3.14)")*\['append', 'prepend'] | None*) – Whether to add the directory of the input file to the `include_path`, and if so, whether to *append* it to search last, or *prepend* it to search first. Pass `None` to suppress adding this directory entirely. + * **custom\_instructions** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*CustomInstruction*](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.parse.CustomInstruction")*]*) – any custom constructors that should be used for specific gates or opaque instructions during circuit construction. See [Specifying custom instructions](#qasm2-custom-instructions) for more. + * **custom\_classical** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*CustomClassical*](#qiskit.qasm2.CustomClassical "qiskit.qasm2.CustomClassical")*]*) – any custom classical functions that should be used during the parsing of classical expressions. See [Specifying custom classical functions](#qasm2-custom-classical) for more. + * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – whether to run in [strict mode](#qasm2-strict-mode). **Returns** @@ -58,11 +58,11 @@ This module contains two public functions, both of which create a [`QuantumCircu **Parameters** - * **string** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The OpenQASM 2 program in a string. - * **include\_path** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*PathLike*](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.13)")*]*) – order of directories to search when evaluating `include` statements. - * **custom\_instructions** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*CustomInstruction*](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.parse.CustomInstruction")*]*) – any custom constructors that should be used for specific gates or opaque instructions during circuit construction. See [Specifying custom instructions](#qasm2-custom-instructions) for more. - * **custom\_classical** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*CustomClassical*](#qiskit.qasm2.CustomClassical "qiskit.qasm2.CustomClassical")*]*) – any custom classical functions that should be used during the parsing of classical expressions. See [Specifying custom classical functions](#qasm2-custom-classical) for more. - * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – whether to run in [strict mode](#qasm2-strict-mode). + * **string** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The OpenQASM 2 program in a string. + * **include\_path** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*PathLike*](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.14)")*]*) – order of directories to search when evaluating `include` statements. + * **custom\_instructions** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*CustomInstruction*](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.parse.CustomInstruction")*]*) – any custom constructors that should be used for specific gates or opaque instructions during circuit construction. See [Specifying custom instructions](#qasm2-custom-instructions) for more. + * **custom\_classical** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*CustomClassical*](#qiskit.qasm2.CustomClassical "qiskit.qasm2.CustomClassical")*]*) – any custom classical functions that should be used during the parsing of classical expressions. See [Specifying custom classical functions](#qasm2-custom-classical) for more. + * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – whether to run in [strict mode](#qasm2-strict-mode). **Returns** @@ -84,7 +84,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i #### CustomInstruction - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Information about a custom instruction that should be defined during the parse. @@ -123,11 +123,11 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i **Parameters** - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – - * **num\_params** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **constructor** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[...],* [*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")*]*) – - * **builtin** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – + * **num\_params** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **constructor** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)")*\[\[...],* [*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")*]*) – + * **builtin** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – This can be particularly useful when trying to resolve ambiguities in the global-phase conventions of an OpenQASM 2 program. See [OpenQASM 2 Phase Conventions](#qasm2-phase-conventions) for more details. @@ -141,7 +141,7 @@ Similar to the quantum extensions above, you can also extend the processing done #### CustomClassical - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Information about a custom classical function that should be defined in mathematical expressions. @@ -168,7 +168,7 @@ Similar to other serialization modules in Python, this module offers two public **Parameters** * **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") to be exported. - * **filename\_or\_stream** ([*os.PathLike*](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.13)") *|*[*io.TextIOBase*](https://docs.python.org/3/library/io.html#io.TextIOBase "(in Python v3.13)")) – either a path-like object (likely a [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") or [`pathlib.Path`](https://docs.python.org/3/library/pathlib.html#pathlib.Path "(in Python v3.13)")), or an already opened text-mode stream. + * **filename\_or\_stream** ([*os.PathLike*](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.14)") *|*[*io.TextIOBase*](https://docs.python.org/3/library/io.html#io.TextIOBase "(in Python v3.14)")) – either a path-like object (likely a [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") or [`pathlib.Path`](https://docs.python.org/3/library/pathlib.html#pathlib.Path "(in Python v3.14)")), or an already opened text-mode stream. **Raises** @@ -194,7 +194,7 @@ Similar to other serialization modules in Python, this module offers two public **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ## Errors @@ -271,7 +271,7 @@ Write out the same [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circ qiskit.qasm2.dump(qc, "myfile.qasm") ``` -Similarly, one can use general [`os.PathLike`](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.13)") instances as the filename: +Similarly, one can use general [`os.PathLike`](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.14)") instances as the filename: ```python import pathlib diff --git a/docs/api/qiskit/qasm3.mdx b/docs/api/qiskit/qasm3.mdx index f3e7333f720..2ef5ed5a065 100644 --- a/docs/api/qiskit/qasm3.mdx +++ b/docs/api/qiskit/qasm3.mdx @@ -54,7 +54,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") Both of these exporter functions are single-use wrappers around the main [`Exporter`](#qiskit.qasm3.Exporter "qiskit.qasm3.Exporter") class. For more complex exporting needs, including dumping multiple circuits in a single session, it may be more convenient or faster to use the complete interface. @@ -62,13 +62,13 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") QASM3 exporter main class. **Parameters** - * **includes** (*Sequence\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **includes** (*Sequence\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – the filenames that should be emitted as includes. @@ -76,11 +76,11 @@ Both of these exporter functions are single-use wrappers around the main [`Expor At present, only the standard-library file `stdgates.inc` is properly understood by the exporter, in the sense that it knows the gates it defines. You can specify other includes, but you will need to pass the names of the gates they define in the `basis_gates` argument to avoid the exporter outputting a separate `gate` definition. - * **basis\_gates** (*Sequence\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – the basic defined gate set of the backend. + * **basis\_gates** (*Sequence\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – the basic defined gate set of the backend. - * **disable\_constants** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if `True`, always emit floating-point constants for numeric parameter values. If `False` (the default), then values close to multiples of OpenQASM 3 constants (`pi`, `euler`, and `tau`) will be emitted in terms of those constants instead, potentially improving accuracy in the output. + * **disable\_constants** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if `True`, always emit floating-point constants for numeric parameter values. If `False` (the default), then values close to multiples of OpenQASM 3 constants (`pi`, `euler`, and `tau`) will be emitted in terms of those constants instead, potentially improving accuracy in the output. - * **alias\_classical\_registers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **alias\_classical\_registers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, then bits may be contained in more than one register. If so, the registers will be emitted using “alias” definitions, which might not be well supported by consumers of OpenQASM 3. @@ -90,19 +90,19 @@ Both of these exporter functions are single-use wrappers around the main [`Expor A value for `allow_aliasing` overrides any value given here, and supersedes this parameter. - * **allow\_aliasing** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **allow\_aliasing** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, then bits may be contained in more than one register. If so, the registers will be emitted using “alias” definitions, which might not be well supported by consumers of OpenQASM 3. Defaults to `False` or the value of `alias_classical_registers`. - * **indent** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the indentation string to use for each level within an indented block. Can be set to the empty string to disable indentation. + * **indent** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the indentation string to use for each level within an indented block. Can be set to the empty string to disable indentation. * **experimental** ([*ExperimentalFeatures*](#qiskit.qasm3.ExperimentalFeatures "qiskit.qasm3.ExperimentalFeatures")) – any experimental features to enable during the export. See [`ExperimentalFeatures`](#qiskit.qasm3.ExperimentalFeatures "qiskit.qasm3.ExperimentalFeatures") for more details. - * **annotation\_handlers** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*OpenQASM3Serializer*](circuit_annotation#qiskit.circuit.annotation.OpenQASM3Serializer "qiskit.circuit.annotation.OpenQASM3Serializer")*] | None*) – a mapping of namespaces to annotation serializers. When an [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") object is encountered, the most specific namespace in this mapping that matches the annotation’s [`namespace`](qiskit.circuit.Annotation#namespace "qiskit.circuit.Annotation.namespace") attribute will be used to serialize it. + * **annotation\_handlers** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*OpenQASM3Serializer*](circuit_annotation#qiskit.circuit.annotation.OpenQASM3Serializer "qiskit.circuit.annotation.OpenQASM3Serializer")*] | None*) – a mapping of namespaces to annotation serializers. When an [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") object is encountered, the most specific namespace in this mapping that matches the annotation’s [`namespace`](qiskit.circuit.Annotation#namespace "qiskit.circuit.Annotation.namespace") attribute will be used to serialize it. - * **implicit\_defcals** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, DefcalInstruction] | None*) – mapping of [`Instruction.name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name")s to an associated `DefcalInstruction` object. All instructions with the key name in the input circuit should be output as if there is a `defcal` statement corresponding to the given `DefcalInstruction` defined. The key name and the `DefcalInstruction.name` do not need to match. The `defcal` name cannot collide with an OpenQASM 3 keyword. + * **implicit\_defcals** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, DefcalInstruction] | None*) – mapping of [`Instruction.name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name")s to an associated `DefcalInstruction` object. All instructions with the key name in the input circuit should be output as if there is a `defcal` statement corresponding to the given `DefcalInstruction` defined. The key name and the `DefcalInstruction.name` do not need to match. The `defcal` name cannot collide with an OpenQASM 3 keyword. #### dump @@ -136,7 +136,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t #### ExperimentalFeatures - Bases: [`Flag`](https://docs.python.org/3/library/enum.html#enum.Flag "(in Python v3.13)") + Bases: [`Flag`](https://docs.python.org/3/library/enum.html#enum.Flag "(in Python v3.14)") Flags for experimental features that the OpenQASM 3 exporter supports. @@ -236,9 +236,9 @@ Currently only two high-level functions are offered, as Qiskit support for impor **Parameters** - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the filename to load the program from. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – keyword argument which provides number of physical/virtual qubits. - * **annotation\_handlers** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*annotation.OpenQASM3Serializer*](circuit_annotation#qiskit.circuit.annotation.OpenQASM3Serializer "qiskit.circuit.annotation.OpenQASM3Serializer")*] | None*) – a mapping whose keys are (parent) namespaces and values are serializers that can handle children of those namesapces. Requires `qiskit_qasm3_import>=0.6.0`. + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the filename to load the program from. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – keyword argument which provides number of physical/virtual qubits. + * **annotation\_handlers** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*annotation.OpenQASM3Serializer*](circuit_annotation#qiskit.circuit.annotation.OpenQASM3Serializer "qiskit.circuit.annotation.OpenQASM3Serializer")*] | None*) – a mapping whose keys are (parent) namespaces and values are serializers that can handle children of those namesapces. Requires `qiskit_qasm3_import>=0.6.0`. **Returns** @@ -284,9 +284,9 @@ Currently only two high-level functions are offered, as Qiskit support for impor **Parameters** - * **program** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the OpenQASM 3 program. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – provides number of physical/virtual qubits. - * **annotation\_handlers** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*annotation.OpenQASM3Serializer*](circuit_annotation#qiskit.circuit.annotation.OpenQASM3Serializer "qiskit.circuit.annotation.OpenQASM3Serializer")*] | None*) – a mapping whose keys are (parent) namespaces and values are serializers that can handle children of those namesapces. Requires `qiskit_qasm3_import>=0.6.0`. + * **program** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the OpenQASM 3 program. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – provides number of physical/virtual qubits. + * **annotation\_handlers** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*annotation.OpenQASM3Serializer*](circuit_annotation#qiskit.circuit.annotation.OpenQASM3Serializer "qiskit.circuit.annotation.OpenQASM3Serializer")*] | None*) – a mapping whose keys are (parent) namespaces and values are serializers that can handle children of those namesapces. Requires `qiskit_qasm3_import>=0.6.0`. **Returns** @@ -299,7 +299,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor **Raises** * [**QASM3ImporterError**](#qiskit.qasm3.QASM3ImporterError "qiskit.qasm3.QASM3ImporterError") – if the OpenQASM 3 file is invalid, or cannot be represented by a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if number of qubits in qasm3\_ckt is more than num\_qubits. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if number of qubits in qasm3\_ckt is more than num\_qubits. The `annotation_handlers` argument. This requires `qiskit_qasm3_import>=0.6.0`. @@ -388,9 +388,9 @@ You can use the experimental interface immediately, with similar functions to th **Parameters** - * **pathlike\_or\_filelike** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*os.PathLike*](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.13)") *|*[*io.TextIOBase*](https://docs.python.org/3/library/io.html#io.TextIOBase "(in Python v3.13)")) – the program source. This can either be given as a filepath, or an open text stream object. If the stream is already opened it is consumed in Python space, whereas filenames are opened and consumed in Rust space; there might be slightly different performance characteristics, depending on your system and how the streams are buffered by default. + * **pathlike\_or\_filelike** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*os.PathLike*](https://docs.python.org/3/library/os.html#os.PathLike "(in Python v3.14)") *|*[*io.TextIOBase*](https://docs.python.org/3/library/io.html#io.TextIOBase "(in Python v3.14)")) – the program source. This can either be given as a filepath, or an open text stream object. If the stream is already opened it is consumed in Python space, whereas filenames are opened and consumed in Rust space; there might be slightly different performance characteristics, depending on your system and how the streams are buffered by default. * **custom\_gates** (*Iterable\[*[*CustomGate*](#qiskit.qasm3.CustomGate "qiskit.qasm3.CustomGate")*]*) – Python constructors to use for particular named gates. If not supplied, Qiskit will use its own standard-library constructors for gates defined in the OpenQASM 3.0 standard-library file `stdgates.inc`. - * **include\_path** (*Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – the path to search when resolving `include` statements. If not given, Qiskit will arrange for this to point to a location containing `stdgates.inc` only. Paths are tried in the sequence order. + * **include\_path** (*Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – the path to search when resolving `include` statements. If not given, Qiskit will arrange for this to point to a location containing `stdgates.inc` only. Paths are tried in the sequence order. **Returns** @@ -416,9 +416,9 @@ You can use the experimental interface immediately, with similar functions to th **Parameters** - * **source** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the program source in a Python string. + * **source** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the program source in a Python string. * **custom\_gates** (*Iterable\[*[*CustomGate*](#qiskit.qasm3.CustomGate "qiskit.qasm3.CustomGate")*]*) – Python constructors to use for particular named gates. If not supplied, Qiskit will use its own standard-library constructors for gates defined in the OpenQASM 3.0 standard-library file `stdgates.inc`. - * **include\_path** (*Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – the path to search when resolving `include` statements. If not given, Qiskit will arrange for this to point to a location containing `stdgates.inc` only. Paths are tried in the sequence order. + * **include\_path** (*Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – the path to search when resolving `include` statements. If not given, Qiskit will arrange for this to point to a location containing `stdgates.inc` only. Paths are tried in the sequence order. **Returns** @@ -447,7 +447,7 @@ These two functions allow for specifying include paths as an iterable of paths, #### CustomGate - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Information received from Python space about how to construct a Python-space object to represent a given gate that might be declared. diff --git a/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.mdx b/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.mdx index 9970ce48910..8b839541507 100644 --- a/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.mdx +++ b/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.mdx @@ -86,10 +86,10 @@ python_api_name: qiskit.circuit.AnnotatedOperation **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – ignored (used for consistency with other control methods) - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ignored (used for consistency with other control methods) + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – ignored (used for consistency with other control methods) + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ignored (used for consistency with other control methods) **Returns** @@ -119,7 +119,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ignored (used for consistency with other inverse methods) + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ignored (used for consistency with other inverse methods) **Returns** @@ -135,8 +135,8 @@ python_api_name: qiskit.circuit.AnnotatedOperation **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ignored (used for consistency with other power methods) + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ignored (used for consistency with other power methods) **Returns** @@ -156,11 +156,11 @@ python_api_name: qiskit.circuit.AnnotatedOperation **Parameters** - **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – **Return type** - [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") | [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") | [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.circuit.Annotation.mdx b/docs/api/qiskit/qiskit.circuit.Annotation.mdx index 1a3d7e802e1..fb560f18eac 100644 --- a/docs/api/qiskit/qiskit.circuit.Annotation.mdx +++ b/docs/api/qiskit/qiskit.circuit.Annotation.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.circuit.Annotation # Annotation - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") An arbitrary annotation for instructions. diff --git a/docs/api/qiskit/qiskit.circuit.BoxOp.mdx b/docs/api/qiskit/qiskit.circuit.BoxOp.mdx index 013364724f2..d8c2a3edcc3 100644 --- a/docs/api/qiskit/qiskit.circuit.BoxOp.mdx +++ b/docs/api/qiskit/qiskit.circuit.BoxOp.mdx @@ -23,11 +23,11 @@ python_api_name: qiskit.circuit.BoxOp **Parameters** - * **body** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the circuit to use as the body of the box. This should explicit close over any [`expr.Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") variables that must be incident from the outer circuit. The expected number of qubit and clbits for the resulting instruction are inferred from the number in the circuit, even if they are idle. + * **body** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the circuit to use as the body of the box. This should explicitly close over any [`expr.Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") variables that must be incident from the outer circuit. The required number of qubit and clbits for the resulting instruction are inferred from the number in the circuit, even if they are idle. * **duration** (*None*) – an optional duration for the box as a whole. - * **unit** ([*Literal*](https://docs.python.org/3/library/typing.html#typing.Literal "(in Python v3.13)")*\['dt', 's', 'ms', 'us', 'ns', 'ps', 'expr'] | None*) – the unit of the `duration`. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – an optional string label for the instruction. - * **annotations** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*Annotation*](qiskit.circuit.Annotation "qiskit.circuit.Annotation")*]*) – any [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation")s to apply to the box. In cases where order is important, annotations are to be interpreted in the same order they appear in the iterable. + * **unit** ([*Literal*](https://docs.python.org/3/library/typing.html#typing.Literal "(in Python v3.14)")*\['dt', 's', 'ms', 'us', 'ns', 'ps', 'expr'] | None*) – the unit of the `duration`. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – an optional string label for the instruction. + * **annotations** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*Annotation*](qiskit.circuit.Annotation "qiskit.circuit.Annotation")*]*) – any [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation")s to apply to the box. In cases where order is important, annotations are to be interpreted in the same order they appear in the iterable. ## Attributes @@ -61,7 +61,7 @@ python_api_name: qiskit.circuit.BoxOp The `body` [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") of the operation. - This is the same as object returned as the sole entry in [`params()`](#qiskit.circuit.BoxOp.params "qiskit.circuit.BoxOp.params") and [`blocks()`](#qiskit.circuit.BoxOp.blocks "qiskit.circuit.BoxOp.blocks"). + This is the same object returned as the sole entry in [`params()`](#qiskit.circuit.BoxOp.params "qiskit.circuit.BoxOp.params") and [`blocks()`](#qiskit.circuit.BoxOp.blocks "qiskit.circuit.BoxOp.blocks"). ### decompositions @@ -146,7 +146,7 @@ python_api_name: qiskit.circuit.BoxOp **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -170,7 +170,7 @@ python_api_name: qiskit.circuit.BoxOp **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -194,7 +194,7 @@ python_api_name: qiskit.circuit.BoxOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] ### iter\_captured\_vars @@ -204,7 +204,7 @@ python_api_name: qiskit.circuit.BoxOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] ### repeat @@ -214,7 +214,7 @@ python_api_name: qiskit.circuit.BoxOp **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -293,7 +293,7 @@ python_api_name: qiskit.circuit.BoxOp **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_mutable @@ -307,7 +307,7 @@ python_api_name: qiskit.circuit.BoxOp ### validate\_parameter - Instruction parameters has no validation or normalization. + Instruction parameter has no validation or normalization. diff --git a/docs/api/qiskit/qiskit.circuit.BreakLoopOp.mdx b/docs/api/qiskit/qiskit.circuit.BreakLoopOp.mdx index f23ba883ded..b256f3d47ac 100644 --- a/docs/api/qiskit/qiskit.circuit.BreakLoopOp.mdx +++ b/docs/api/qiskit/qiskit.circuit.BreakLoopOp.mdx @@ -15,9 +15,9 @@ python_api_name: qiskit.circuit.BreakLoopOp **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits this affects. - * **num\_clbits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits this affects. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – an optional string label for the instruction. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits this affects. + * **num\_clbits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits this affects. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – an optional string label for the instruction. ## Attributes @@ -126,7 +126,7 @@ python_api_name: qiskit.circuit.BreakLoopOp **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -150,7 +150,7 @@ python_api_name: qiskit.circuit.BreakLoopOp **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.BreakLoopOp **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -222,7 +222,7 @@ python_api_name: qiskit.circuit.BreakLoopOp **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_mutable @@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.BreakLoopOp ### validate\_parameter - Instruction parameters has no validation or normalization. + Instruction parameter has no validation or normalization. diff --git a/docs/api/qiskit/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/qiskit.circuit.CircuitInstruction.mdx index 7f3d027f68f..26a253e8e0f 100644 --- a/docs/api/qiskit/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/qiskit.circuit.CircuitInstruction.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.circuit.CircuitInstruction # CircuitInstruction - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the [`operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") and various operands. diff --git a/docs/api/qiskit/qiskit.circuit.CommutationChecker.mdx b/docs/api/qiskit/qiskit.circuit.CommutationChecker.mdx index f430144a2e8..0c31d610c70 100644 --- a/docs/api/qiskit/qiskit.circuit.CommutationChecker.mdx +++ b/docs/api/qiskit/qiskit.circuit.CommutationChecker.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.circuit.CommutationChecker # CommutationChecker - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Check commutations of two operations. @@ -33,9 +33,9 @@ $$ **Parameters** - * **standard\_gate\_commutations** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – - * **cache\_max\_entries** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **gates** (*Optional\[Set\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]]*) – + * **standard\_gate\_commutations** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – + * **cache\_max\_entries** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **gates** (*Optional\[Set\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]]*) – ### check\_commutation\_entries @@ -45,9 +45,9 @@ $$ **Parameters** * **first\_op** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.operation.Operation")) – first operation. - * **first\_qargs** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")) – first operation’s qubits. + * **first\_qargs** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")) – first operation’s qubits. * **second\_op** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.operation.Operation")) – second operation. - * **second\_qargs** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")) – second operation’s qubits. + * **second\_qargs** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")) – second operation’s qubits. **Returns** @@ -55,7 +55,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### clear\_cached\_commutations @@ -72,13 +72,13 @@ $$ **Parameters** * **op1** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – first operation. - * **qargs1** (*Sequence\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – first operation’s qubits. - * **cargs1** (*Sequence\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – first operation’s clbits. + * **qargs1** (*Sequence\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – first operation’s qubits. + * **cargs1** (*Sequence\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – first operation’s clbits. * **op2** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – second operation. - * **qargs2** (*Sequence\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – second operation’s qubits. - * **cargs2** (*Sequence\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – second operation’s clbits. - * **max\_num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the maximum number of qubits to consider, the check may be skipped if the number of qubits for either operation exceeds this amount. - * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – If the average gate fidelity in between the two operations is above this number (up to `1e-12`) they are assumed to commute. + * **qargs2** (*Sequence\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – second operation’s qubits. + * **cargs2** (*Sequence\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – second operation’s clbits. + * **max\_num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the maximum number of qubits to consider, the check may be skipped if the number of qubits for either operation exceeds this amount. + * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – If the average gate fidelity in between the two operations is above this number (up to `1e-12`) they are assumed to commute. **Returns** @@ -86,7 +86,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### commute\_nodes @@ -96,12 +96,12 @@ $$ **Parameters** - * **max\_num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **max\_num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### num\_cached\_entries diff --git a/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.mdx b/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.mdx index c3dd2d80567..ac73502968e 100644 --- a/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.mdx +++ b/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.mdx @@ -15,9 +15,9 @@ python_api_name: qiskit.circuit.ContinueLoopOp **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits this affects. - * **num\_clbits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits this affects. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – an optional string label for the instruction. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits this affects. + * **num\_clbits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits this affects. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – an optional string label for the instruction. ## Attributes @@ -126,7 +126,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -150,7 +150,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -174,7 +174,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -222,7 +222,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_mutable @@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp ### validate\_parameter - Instruction parameters has no validation or normalization. + Instruction parameter has no validation or normalization. diff --git a/docs/api/qiskit/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/qiskit.circuit.ControlFlowOp.mdx index acb8584ff3b..9f294539339 100644 --- a/docs/api/qiskit/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/qiskit.circuit.ControlFlowOp.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.circuit.ControlFlowOp # ControlFlowOp - Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Abstract class to encapsulate all control flow operations. @@ -21,16 +21,16 @@ python_api_name: qiskit.circuit.ControlFlowOp **Parameters** - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – instruction name - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – instruction’s qubit width - * **num\_clbits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – instruction’s clbit width - * **params** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*|*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")*|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*|ndarray|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]*) – list of parameters - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *or None*) – An optional label for identifying the instruction. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – instruction name + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – instruction’s qubit width + * **num\_clbits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – instruction’s clbit width + * **params** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*|*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")*|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*|ndarray|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]*) – list of parameters + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *or None*) – An optional label for identifying the instruction. **Raises** * [**CircuitError**](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 "(in Python v3.13)") – when the optional label is provided, but it is not a string. + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – when the optional label is provided, but it is not a string. ## Attributes @@ -145,7 +145,7 @@ python_api_name: qiskit.circuit.ControlFlowOp **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -169,7 +169,7 @@ python_api_name: qiskit.circuit.ControlFlowOp **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -193,7 +193,7 @@ python_api_name: qiskit.circuit.ControlFlowOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] ### iter\_captured\_vars @@ -203,7 +203,7 @@ python_api_name: qiskit.circuit.ControlFlowOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] ### repeat @@ -213,7 +213,7 @@ python_api_name: qiskit.circuit.ControlFlowOp **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.ControlFlowOp **Parameters** - **blocks** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – the new subcircuit blocks to use. + **blocks** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – the new subcircuit blocks to use. **Returns** @@ -296,7 +296,7 @@ python_api_name: qiskit.circuit.ControlFlowOp **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_mutable @@ -310,7 +310,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### validate\_parameter - Instruction parameters has no validation or normalization. + Instruction parameter has no validation or normalization. diff --git a/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx index 342467d1537..26905601454 100644 --- a/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx @@ -17,13 +17,13 @@ python_api_name: qiskit.circuit.ControlledGate **Parameters** - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the gate. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits the gate acts on. - * **params** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of parameters for the gate. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional label for the gate. - * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – Number of control qubits. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the gate. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits the gate acts on. + * **params** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of parameters for the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional label for the gate. + * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – Number of control qubits. * **definition** (*Optional\['QuantumCircuit']*) – A list of gate rules for implementing this gate. The elements of the list are tuples of ([`Gate()`](qiskit.circuit.Gate "qiskit.circuit.Gate"), \[qubit\_list], \[clbit\_list]). - * **ctrl\_state** (*Optional\[Union\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]]*) – The control state in decimal or as a bitstring (e.g. ‘111’). If specified as a bitstring the length must equal num\_ctrl\_qubits, MSB on left. If None, use 2\*\*num\_ctrl\_qubits-1. + * **ctrl\_state** (*Optional\[Union\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]]*) – The control state in decimal or as a bitstring (e.g. ‘111’). If specified as a bitstring the length must equal num\_ctrl\_qubits, MSB on left. If None, use 2\*\*num\_ctrl\_qubits-1. * **base\_gate** (*Optional\[*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – Gate object to be controlled. **Raises** @@ -148,7 +148,7 @@ python_api_name: qiskit.circuit.ControlledGate **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -168,7 +168,7 @@ python_api_name: qiskit.circuit.ControlledGate **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -220,8 +220,8 @@ python_api_name: qiskit.circuit.ControlledGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -233,7 +233,7 @@ python_api_name: qiskit.circuit.ControlledGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -245,10 +245,10 @@ python_api_name: qiskit.circuit.ControlledGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -266,7 +266,7 @@ python_api_name: qiskit.circuit.ControlledGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -284,7 +284,7 @@ python_api_name: qiskit.circuit.ControlledGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – **Return type** @@ -306,8 +306,8 @@ python_api_name: qiskit.circuit.ControlledGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -325,7 +325,7 @@ python_api_name: qiskit.circuit.ControlledGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -373,7 +373,7 @@ python_api_name: qiskit.circuit.ControlledGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.mdx b/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.mdx index 020f0b31d00..5b34fa76bc9 100644 --- a/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.mdx +++ b/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.mdx @@ -53,7 +53,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary **Parameters** - **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – An optional path to write the output image to if specified this method will return None. + **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – An optional path to write the output image to if specified this method will return None. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.ForLoopOp.mdx b/docs/api/qiskit/qiskit.circuit.ForLoopOp.mdx index f6b4548329a..c61dfc952d2 100644 --- a/docs/api/qiskit/qiskit.circuit.ForLoopOp.mdx +++ b/docs/api/qiskit/qiskit.circuit.ForLoopOp.mdx @@ -15,10 +15,10 @@ python_api_name: qiskit.circuit.ForLoopOp **Parameters** - * **indexset** (*Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – A collection of integers to loop over. + * **indexset** (*Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – A collection of integers to loop over. * **loop\_parameter** (*Union\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*, None]*) – The placeholder parameterizing `body` to which the values from `indexset` will be assigned. * **body** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The loop body to be repeatedly executed. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional label for identifying the instruction. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional label for identifying the instruction. ## Attributes @@ -129,7 +129,7 @@ python_api_name: qiskit.circuit.ForLoopOp **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -153,7 +153,7 @@ python_api_name: qiskit.circuit.ForLoopOp **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -177,7 +177,7 @@ python_api_name: qiskit.circuit.ForLoopOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] ### iter\_captured\_vars @@ -187,7 +187,7 @@ python_api_name: qiskit.circuit.ForLoopOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] ### repeat @@ -197,7 +197,7 @@ python_api_name: qiskit.circuit.ForLoopOp **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -276,7 +276,7 @@ python_api_name: qiskit.circuit.ForLoopOp **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_mutable @@ -290,7 +290,7 @@ python_api_name: qiskit.circuit.ForLoopOp ### validate\_parameter - Instruction parameters has no validation or normalization. + Instruction parameter has no validation or normalization. diff --git a/docs/api/qiskit/qiskit.circuit.Gate.mdx b/docs/api/qiskit/qiskit.circuit.Gate.mdx index e0ec7f9b9a5..b76b72947cc 100644 --- a/docs/api/qiskit/qiskit.circuit.Gate.mdx +++ b/docs/api/qiskit/qiskit.circuit.Gate.mdx @@ -15,10 +15,10 @@ python_api_name: qiskit.circuit.Gate **Parameters** - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the gate. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits the gate acts on. - * **params** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of parameters. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the gate. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits the gate acts on. + * **params** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of parameters. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate. ## Attributes @@ -138,8 +138,8 @@ python_api_name: qiskit.circuit.Gate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -151,7 +151,7 @@ python_api_name: qiskit.circuit.Gate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -163,10 +163,10 @@ python_api_name: qiskit.circuit.Gate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -184,7 +184,7 @@ python_api_name: qiskit.circuit.Gate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -208,7 +208,7 @@ python_api_name: qiskit.circuit.Gate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -234,8 +234,8 @@ python_api_name: qiskit.circuit.Gate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -253,7 +253,7 @@ python_api_name: qiskit.circuit.Gate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -301,7 +301,7 @@ python_api_name: qiskit.circuit.Gate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.IfElseOp.mdx b/docs/api/qiskit/qiskit.circuit.IfElseOp.mdx index 7b264547696..7491b3aa52c 100644 --- a/docs/api/qiskit/qiskit.circuit.IfElseOp.mdx +++ b/docs/api/qiskit/qiskit.circuit.IfElseOp.mdx @@ -19,10 +19,10 @@ python_api_name: qiskit.circuit.IfElseOp **Parameters** - * **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] |* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – A condition to be evaluated in real time during circuit execution 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`. + * **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] |* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – A condition to be evaluated in real time during circuit execution 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")) – A program to be executed if `condition` evaluates to true. * **false\_body** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A optional program to be executed if `condition` evaluates to false. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for identifying the instruction. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for identifying the instruction. ## Attributes @@ -139,7 +139,7 @@ python_api_name: qiskit.circuit.IfElseOp **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -163,7 +163,7 @@ python_api_name: qiskit.circuit.IfElseOp **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -187,7 +187,7 @@ python_api_name: qiskit.circuit.IfElseOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] ### iter\_captured\_vars @@ -197,7 +197,7 @@ python_api_name: qiskit.circuit.IfElseOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] ### repeat @@ -207,7 +207,7 @@ python_api_name: qiskit.circuit.IfElseOp **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -273,7 +273,7 @@ python_api_name: qiskit.circuit.IfElseOp **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_mutable @@ -287,7 +287,7 @@ python_api_name: qiskit.circuit.IfElseOp ### validate\_parameter - Instruction parameters has no validation or normalization. + Instruction parameter has no validation or normalization. diff --git a/docs/api/qiskit/qiskit.circuit.Instruction.mdx b/docs/api/qiskit/qiskit.circuit.Instruction.mdx index 75936d7fd82..166544542ea 100644 --- a/docs/api/qiskit/qiskit.circuit.Instruction.mdx +++ b/docs/api/qiskit/qiskit.circuit.Instruction.mdx @@ -19,16 +19,16 @@ python_api_name: qiskit.circuit.Instruction **Parameters** - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – instruction name - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – instruction’s qubit width - * **num\_clbits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – instruction’s clbit width - * **params** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*|*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")*|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*|ndarray|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]*) – list of parameters - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *or None*) – An optional label for identifying the instruction. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – instruction name + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – instruction’s qubit width + * **num\_clbits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – instruction’s clbit width + * **params** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*|*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")*|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*|ndarray|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]*) – list of parameters + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *or None*) – An optional label for identifying the instruction. **Raises** * [**CircuitError**](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 "(in Python v3.13)") – when the optional label is provided, but it is not a string. + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – when the optional label is provided, but it is not a string. ## Attributes @@ -137,7 +137,7 @@ python_api_name: qiskit.circuit.Instruction **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -161,7 +161,7 @@ python_api_name: qiskit.circuit.Instruction **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -185,7 +185,7 @@ python_api_name: qiskit.circuit.Instruction **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -233,7 +233,7 @@ python_api_name: qiskit.circuit.Instruction **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_mutable @@ -247,7 +247,7 @@ python_api_name: qiskit.circuit.Instruction ### validate\_parameter - Instruction parameters has no validation or normalization. + Instruction parameter has no validation or normalization. diff --git a/docs/api/qiskit/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/qiskit.circuit.InstructionSet.mdx index c310b9402a8..8b777f1f922 100644 --- a/docs/api/qiskit/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/qiskit.circuit.InstructionSet.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.circuit.InstructionSet # InstructionSet - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Instruction collection, and their contexts. @@ -66,7 +66,7 @@ python_api_name: qiskit.circuit.InstructionSet **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – diff --git a/docs/api/qiskit/qiskit.circuit.Operation.mdx b/docs/api/qiskit/qiskit.circuit.Operation.mdx index 654483b93b7..4b37c3d3416 100644 --- a/docs/api/qiskit/qiskit.circuit.Operation.mdx +++ b/docs/api/qiskit/qiskit.circuit.Operation.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.circuit.Operation # Operation - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Quantum operation interface. diff --git a/docs/api/qiskit/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/qiskit.circuit.Parameter.mdx index 7027d3e2f1f..69369436a92 100644 --- a/docs/api/qiskit/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/qiskit.circuit.Parameter.mdx @@ -63,7 +63,7 @@ python_api_name: qiskit.circuit.Parameter ### uuid - Returns the [`UUID`](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.13)") of the [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). + Returns the [`UUID`](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.14)") of the [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). In advanced use cases, this property can be passed to the [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter") constructor to produce an instance that compares equal to another instance. @@ -125,7 +125,7 @@ python_api_name: qiskit.circuit.Parameter * If parameter\_values contains parameters outside those in self. - If a non-numeric value is passed in `parameter_values`. - * [**ZeroDivisionError**](https://docs.python.org/3/library/exceptions.html#ZeroDivisionError "(in Python v3.13)") – + * [**ZeroDivisionError**](https://docs.python.org/3/library/exceptions.html#ZeroDivisionError "(in Python v3.14)") – * If binding the provided values requires division by zero. diff --git a/docs/api/qiskit/qiskit.circuit.ParameterExpression.mdx b/docs/api/qiskit/qiskit.circuit.ParameterExpression.mdx index 238b8966bf8..ec796a50c69 100644 --- a/docs/api/qiskit/qiskit.circuit.ParameterExpression.mdx +++ b/docs/api/qiskit/qiskit.circuit.ParameterExpression.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.circuit.ParameterExpression # ParameterExpression - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A parameter expression. @@ -84,7 +84,7 @@ python_api_name: qiskit.circuit.ParameterExpression * If parameter\_values contains parameters outside those in self. - If a non-numeric value is passed in `parameter_values`. - * [**ZeroDivisionError**](https://docs.python.org/3/library/exceptions.html#ZeroDivisionError "(in Python v3.13)") – + * [**ZeroDivisionError**](https://docs.python.org/3/library/exceptions.html#ZeroDivisionError "(in Python v3.14)") – * If binding the provided values requires division by zero. diff --git a/docs/api/qiskit/qiskit.circuit.ParameterVector.mdx b/docs/api/qiskit/qiskit.circuit.ParameterVector.mdx index aeec00f0a07..d509ee99288 100644 --- a/docs/api/qiskit/qiskit.circuit.ParameterVector.mdx +++ b/docs/api/qiskit/qiskit.circuit.ParameterVector.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.circuit.ParameterVector # ParameterVector - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A container of many related [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects. @@ -17,7 +17,7 @@ python_api_name: qiskit.circuit.ParameterVector The elements of a vector are sorted by the name of the vector, then the numeric value of their index. - This class fulfill the [`collections.abc.Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)") interface. + This class fulfill the [`collections.abc.Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)") interface. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.ParameterVectorElement.mdx b/docs/api/qiskit/qiskit.circuit.ParameterVectorElement.mdx index 4f6dd670ee1..6b9020c7599 100644 --- a/docs/api/qiskit/qiskit.circuit.ParameterVectorElement.mdx +++ b/docs/api/qiskit/qiskit.circuit.ParameterVectorElement.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.circuit.ParameterVectorElement ### uuid - Returns the [`UUID`](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.13)") of the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). + Returns the [`UUID`](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.14)") of the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). In advanced use cases, this property can be passed to the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") constructor to produce an instance that compares equal to another instance. @@ -112,7 +112,7 @@ python_api_name: qiskit.circuit.ParameterVectorElement * If parameter\_values contains parameters outside those in self. - If a non-numeric value is passed in `parameter_values`. - * [**ZeroDivisionError**](https://docs.python.org/3/library/exceptions.html#ZeroDivisionError "(in Python v3.13)") – + * [**ZeroDivisionError**](https://docs.python.org/3/library/exceptions.html#ZeroDivisionError "(in Python v3.14)") – * If binding the provided values requires division by zero. diff --git a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx index 34d862c8870..c919631a29a 100644 --- a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx @@ -13,7 +13,7 @@ python_api_name: qiskit.circuit.QuantumCircuit # [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") class - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Core Qiskit representation of a quantum circuit. @@ -192,7 +192,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ``` - [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") exposes data attributes tracking its internal quantum and classical bits and registers. These appear as Python [`list`](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")s, but you should treat them as immutable; changing them will *at best* have no effect, and more likely will simply corrupt the internal data of the [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). + [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") exposes data attributes tracking its internal quantum and classical bits and registers. These appear as Python [`list`](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")s, but you should treat them as immutable; changing them will *at best* have no effect, and more likely will simply corrupt the internal data of the [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). ### qregs @@ -246,7 +246,7 @@ python_api_name: qiskit.circuit.QuantumCircuit ``` - The [compile-time parameters](circuit#circuit-compile-time-parameters) present in instructions on the circuit are available in [`parameters`](#qiskit.circuit.QuantumCircuit.parameters "qiskit.circuit.QuantumCircuit.parameters"). This has a canonical order (mostly lexical, except in the case of [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector")), which matches the order that parameters will be assigned when using the list forms of [`assign_parameters()`](#qiskit.circuit.QuantumCircuit.assign_parameters "qiskit.circuit.QuantumCircuit.assign_parameters"), but also supports [`set`](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)")-like constant-time membership testing. + The [compile-time parameters](circuit#circuit-compile-time-parameters) present in instructions on the circuit are available in [`parameters`](#qiskit.circuit.QuantumCircuit.parameters "qiskit.circuit.QuantumCircuit.parameters"). This has a canonical order (mostly lexical, except in the case of [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector")), which matches the order that parameters will be assigned when using the list forms of [`assign_parameters()`](#qiskit.circuit.QuantumCircuit.assign_parameters "qiskit.circuit.QuantumCircuit.assign_parameters"), but also supports [`set`](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.14)")-like constant-time membership testing. ### parameters @@ -451,7 +451,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** - [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – When circuit is not scheduled. + [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – When circuit is not scheduled. Finally, [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") exposes several simple properties as dynamic read-only numeric attributes. @@ -598,7 +598,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – + * **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – The registers to be included in the circuit. @@ -619,11 +619,11 @@ python_api_name: qiskit.circuit.QuantumCircuit * If a list of python lists containing [`Bit`](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit") objects, a collection of [`Bit`](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit") s to be added to the circuit. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the name of the quantum circuit. If not set, an automatically generated string will be assigned. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the name of the quantum circuit. If not set, an automatically generated string will be assigned. * **global\_phase** (*ParameterValueType*) – The global phase of the circuit in radians. - * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – Arbitrary key value metadata to associate with the circuit. This gets stored as free-form data in a dict in the [`metadata`](#qiskit.circuit.QuantumCircuit.metadata "qiskit.circuit.QuantumCircuit.metadata") attribute. It will not be directly used in the circuit. + * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *| None*) – Arbitrary key value metadata to associate with the circuit. This gets stored as free-form data in a dict in the [`metadata`](#qiskit.circuit.QuantumCircuit.metadata "qiskit.circuit.QuantumCircuit.metadata") attribute. It will not be directly used in the circuit. * **inputs** (*Iterable\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*]*) – any variables to declare as `input` runtime variables for this circuit. These should already be existing [`expr.Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes that you build from somewhere else; if you need to create the inputs as well, use [`QuantumCircuit.add_input()`](#qiskit.circuit.QuantumCircuit.add_input "qiskit.circuit.QuantumCircuit.add_input"). The variables given in this argument will be passed directly to [`add_input()`](#qiskit.circuit.QuantumCircuit.add_input "qiskit.circuit.QuantumCircuit.add_input"). A circuit cannot have both `inputs` and `captures`. @@ -650,7 +650,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit. If None, then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit. If None, then the name stays the same. **Returns** @@ -681,7 +681,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Name for the copied circuit. If None, then the name stays the same. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Name for the copied circuit. If None, then the name stays the same. * **vars\_mode** (*Literal\['alike', 'captures', 'drop']*) – @@ -717,12 +717,12 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **instructions** (*Iterable\[*[*CircuitInstruction*](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*, Iterable\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*, Iterable\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*], Iterable\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]]]*) – The instructions to add to the circuit. + * **instructions** (*Iterable\[*[*CircuitInstruction*](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*, Iterable\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*, Iterable\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*], Iterable\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]]]*) – The instructions to add to the circuit. * **qubits** (*Iterable\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – Any qubits to add to the circuit. This argument can be used, for example, to enforce a particular ordering of qubits. * **clbits** (*Iterable\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – Any classical bits to add to the circuit. This argument can be used, for example, to enforce a particular ordering of classical bits. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The name of the circuit. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The name of the circuit. * **global\_phase** (*ParameterValueType*) – The global phase of the circuit in radians. - * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – Arbitrary key value metadata to associate with the circuit. + * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *| None*) – Arbitrary key value metadata to associate with the circuit. **Returns** @@ -742,7 +742,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **path** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Path to the file for an OpenQASM 2 program + **path** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Path to the file for an OpenQASM 2 program **Returns** @@ -764,7 +764,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qasm\_str** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A string containing an OpenQASM 2.0 program. + **qasm\_str** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – A string containing an OpenQASM 2.0 program. **Returns** @@ -810,7 +810,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **bits** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – + **bits** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – **Return type** @@ -830,7 +830,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – + **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – **Return type** @@ -848,9 +848,9 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **name\_or\_var** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")) – either a string of the variable name, or an existing instance of [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") to re-use. Variables cannot shadow names that are already in use within the circuit. + * **name\_or\_var** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")) – either a string of the variable name, or an existing instance of [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") to re-use. Variables cannot shadow names that are already in use within the circuit. - * **initial** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **initial** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – the value to initialize this variable with. If the first argument was given as a string name, the type of the resulting variable is inferred from the initial expression; to control this more manually, either use [`Var.new()`](circuit_classical#qiskit.circuit.classical.expr.Var.new "qiskit.circuit.classical.expr.Var.new") to manually construct a new variable with the desired type, or use [`expr.cast()`](circuit_classical#qiskit.circuit.classical.expr.cast "qiskit.circuit.classical.expr.cast") to cast the initializer to the desired type. @@ -935,7 +935,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **name\_or\_stretch** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*expr.Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")) – either a string of the stretch name, or an existing instance of [`Stretch`](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch") to re-use. Stretches cannot shadow names that are already in use within the circuit. + **name\_or\_stretch** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*expr.Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")) – either a string of the stretch name, or an existing instance of [`Stretch`](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch") to re-use. Stretches cannot shadow names that are already in use within the circuit. **Returns** @@ -1027,7 +1027,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - namedtuple([int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)"), List\[Tuple([Register](circuit#qiskit.circuit.Register "qiskit.circuit.Register"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)"))]) + namedtuple([int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)"), List\[Tuple([Register](circuit#qiskit.circuit.Register "qiskit.circuit.Register"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)"))]) **Raises** @@ -1080,7 +1080,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### Working with compile-time parameters @@ -1122,7 +1122,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** * [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If parameters is a dict and contains parameters not present in the circuit. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If parameters is a list/array and the length mismatches the number of free parameters in the circuit. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If parameters is a list/array and the length mismatches the number of free parameters in the circuit. **Returns** @@ -1178,7 +1178,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **name\_or\_param** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) – the parameter, or name of a parameter to check. If this is a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") node, the parameter must be exactly the given one for this function to return `True`. + **name\_or\_param** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) – the parameter, or name of a parameter to check. If this is a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") node, the parameter must be exactly the given one for this function to return `True`. **Returns** @@ -1186,7 +1186,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") **[`QuantumCircuit.get_parameter()`](#qiskit.circuit.QuantumCircuit.get_parameter "qiskit.circuit.QuantumCircuit.get_parameter")** @@ -1207,7 +1207,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **name** – the name of the parameter to retrieve. - * **default** – if given, this value will be returned if the parameter is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") is raised instead. + * **default** – if given, this value will be returned if the parameter is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") is raised instead. **Returns** @@ -1215,7 +1215,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** - [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") – if no default is given, but the parameter does not exist in the circuit. + [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") – if no default is given, but the parameter does not exist in the circuit. **Examples** @@ -1279,7 +1279,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **name** – the name of the variable to retrieve. - * **default** – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") is raised instead. + * **default** – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") is raised instead. **Returns** @@ -1287,7 +1287,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** - [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") – if no default is given, but the variable does not exist. + [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") – if no default is given, but the variable does not exist. **Examples** @@ -1329,7 +1329,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **name** – the name of the stretch to retrieve. - * **default** – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") is raised instead. + * **default** – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") is raised instead. **Returns** @@ -1337,7 +1337,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** - [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") – if no default is given, but the variable does not exist. + [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") – if no default is given, but the variable does not exist. **Examples** @@ -1375,7 +1375,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **name** – the name of the identifier to retrieve. - * **default** – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") is raised instead. + * **default** – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") is raised instead. **Returns** @@ -1383,7 +1383,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** - [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") – if no default is given, but the identifier does not exist. + [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") – if no default is given, but the identifier does not exist. **[`get_var()`](#qiskit.circuit.QuantumCircuit.get_var "qiskit.circuit.QuantumCircuit.get_var")** @@ -1407,7 +1407,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **name\_or\_var** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")) – the variable, or name of a variable to check. If this is a [`expr.Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node, the variable must be exactly the given one for this function to return `True`. + **name\_or\_var** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")) – the variable, or name of a variable to check. If this is a [`expr.Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node, the variable must be exactly the given one for this function to return `True`. **Returns** @@ -1415,7 +1415,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") **[`QuantumCircuit.get_var()`](#qiskit.circuit.QuantumCircuit.get_var "qiskit.circuit.QuantumCircuit.get_var")** @@ -1435,7 +1435,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **name\_or\_stretch** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*expr.Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")) – the stretch, or name of a stretch to check. If this is a [`expr.Stretch`](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch") node, the stretch must be exactly the given one for this function to return `True`. + **name\_or\_stretch** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*expr.Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")) – the stretch, or name of a stretch to check. If this is a [`expr.Stretch`](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch") node, the stretch must be exactly the given one for this function to return `True`. **Returns** @@ -1443,7 +1443,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") **[`QuantumCircuit.get_stretch()`](#qiskit.circuit.QuantumCircuit.get_stretch "qiskit.circuit.QuantumCircuit.get_stretch")** @@ -1459,7 +1459,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **name\_or\_ident** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") *|*[*expr.Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")) – the instance, or name of the identifier to check. If this is a [`expr.Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") or [`expr.Stretch`](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch") node, the matched instance must be exactly the given one for this function to return `True`. + **name\_or\_ident** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") *|*[*expr.Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")) – the instance, or name of the identifier to check. If this is a [`expr.Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") or [`expr.Stretch`](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch") node, the matched instance must be exactly the given one for this function to return `True`. **Returns** @@ -1467,7 +1467,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") **[`QuantumCircuit.get_identifier()`](#qiskit.circuit.QuantumCircuit.get_identifier "qiskit.circuit.QuantumCircuit.get_identifier")** @@ -1499,7 +1499,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[*Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[*Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")] #### iter\_stretches @@ -1511,7 +1511,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[*Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit._accelerate.circuit.classical.expr.Stretch")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[*Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit._accelerate.circuit.classical.expr.Stretch")] #### iter\_input\_vars @@ -1521,7 +1521,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[*Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[*Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")] #### iter\_captured\_vars @@ -1531,7 +1531,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[*Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[*Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")] #### iter\_captured\_stretches @@ -1541,7 +1541,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[*Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit._accelerate.circuit.classical.expr.Stretch")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[*Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit._accelerate.circuit.classical.expr.Stretch")] #### iter\_declared\_vars @@ -1551,7 +1551,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[*Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[*Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")] #### iter\_declared\_stretches @@ -1561,7 +1561,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[*Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit._accelerate.circuit.classical.expr.Stretch")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[*Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit._accelerate.circuit.classical.expr.Stretch")] @@ -1611,7 +1611,7 @@ python_api_name: qiskit.circuit.QuantumCircuit * **instruction** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation") *|*[*CircuitInstruction*](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")) – [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instance to append, or a [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") with all its context. * **qargs** (*Sequence\[QubitSpecifier] | None*) – specifiers of the [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")s to attach instruction to. * **cargs** (*Sequence\[ClbitSpecifier] | None*) – specifiers of the [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")s to attach instruction to. - * **copy** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if `True` (the default), then the incoming `instruction` is copied before adding it to the circuit if it contains symbolic parameters, so it can be safely mutated without affecting other circuits the same instruction might be in. If you are sure this instruction will not be in other circuits, you can set this `False` for a small speedup. + * **copy** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if `True` (the default), then the incoming `instruction` is copied before adding it to the circuit if it contains symbolic parameters, so it can be safely mutated without affecting other circuits the same instruction might be in. If you are sure this instruction will not be in other circuits, you can set this `False` for a small speedup. **Returns** @@ -1688,15 +1688,15 @@ python_api_name: qiskit.circuit.QuantumCircuit * **other** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *or*[*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – (sub)circuit or instruction to compose onto self. If not a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), this can be anything that [`append`](#qiskit.circuit.QuantumCircuit.append "qiskit.circuit.QuantumCircuit.append") will accept. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – qubits of self to compose onto. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – qubits of self to compose onto. - * **clbits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – clbits of self to compose onto. + * **clbits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – clbits of self to compose onto. - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, front composition will be performed. This is not possible within control-flow builder context managers. + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, front composition will be performed. This is not possible within control-flow builder context managers. - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, modify the object. Otherwise, return composed circuit. + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, modify the object. Otherwise, return composed circuit. - * **copy** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` (the default), then the input is treated as shared, and any contained instructions will be copied, if they might need to be mutated in the future. You can set this to `False` if the input should be considered owned by the base circuit, in order to avoid unnecessary copies; in this case, it is not valid to use `other` afterward, and some instructions may have been mutated in place. + * **copy** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` (the default), then the input is treated as shared, and any contained instructions will be copied, if they might need to be mutated in the future. You can set this to `False` if the input should be considered owned by the base circuit, in order to avoid unnecessary copies; in this case, it is not valid to use `other` afterward, and some instructions may have been mutated in place. * **var\_remap** (*Mapping*) – @@ -1704,13 +1704,13 @@ python_api_name: qiskit.circuit.QuantumCircuit Both keys and values can be given as strings or direct identifier instances. If a key is a string, it matches any [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") or [`Stretch`](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch") with the same name. If a value is a string, whenever a new key matches it, a new [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") or [`Stretch`](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch") is created with the correct type. If a value is a [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var"), its `type` must exactly match that of the variable it is replacing. - * **inline\_captures** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **inline\_captures** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if `True`, then all “captured” identifier nodes in the `other` [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") are assumed to refer to identifiers already declared in `self` (as any input/capture/local type), and the uses in `other` will apply to the existing identifiers. If you want to build up a layer for an existing circuit to use with [`compose()`](#qiskit.circuit.QuantumCircuit.compose "qiskit.circuit.QuantumCircuit.compose"), you might find the `vars_mode="captures"` argument to [`copy_empty_like()`](#qiskit.circuit.QuantumCircuit.copy_empty_like "qiskit.circuit.QuantumCircuit.copy_empty_like") useful. Any remapping in `vars_remap` occurs before evaluating this variable inlining. If this is `False` (the default), then all identifiers in `other` will be required to be distinct from those in `self`, and new declarations will be made for them. - * **wrap** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, wraps the other circuit into a gate (or instruction, depending on whether it contains only unitary instructions) before composing it onto self. Rather than using this option, it is almost always better to manually control this yourself by using [`to_instruction()`](#qiskit.circuit.QuantumCircuit.to_instruction "qiskit.circuit.QuantumCircuit.to_instruction") or [`to_gate()`](#qiskit.circuit.QuantumCircuit.to_gate "qiskit.circuit.QuantumCircuit.to_gate"), and then call [`append()`](#qiskit.circuit.QuantumCircuit.append "qiskit.circuit.QuantumCircuit.append"). + * **wrap** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, wraps the other circuit into a gate (or instruction, depending on whether it contains only unitary instructions) before composing it onto self. Rather than using this option, it is almost always better to manually control this yourself by using [`to_instruction()`](#qiskit.circuit.QuantumCircuit.to_instruction "qiskit.circuit.QuantumCircuit.to_instruction") or [`to_gate()`](#qiskit.circuit.QuantumCircuit.to_gate "qiskit.circuit.QuantumCircuit.to_gate"), and then call [`append()`](#qiskit.circuit.QuantumCircuit.append "qiskit.circuit.QuantumCircuit.append"). **Returns** @@ -1770,7 +1770,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **other** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The other circuit to tensor this circuit with. - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, modify the object. Otherwise return composed circuit. + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, modify the object. Otherwise return composed circuit. **Return type** @@ -1801,7 +1801,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **other** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – As some rules of thumb: @@ -1909,7 +1909,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **qargs** (*QubitSpecifier*) – Specification for one or more qubit arguments. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The string label of the barrier. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The string label of the barrier. **Returns** @@ -1932,7 +1932,7 @@ python_api_name: qiskit.circuit.QuantumCircuit * **control\_qubit1** (*QubitSpecifier*) – The qubit(s) used as the first control. * **control\_qubit2** (*QubitSpecifier*) – The qubit(s) used as the second control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -1955,8 +1955,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **control\_qubit1** (*QubitSpecifier*) – The qubit(s) used as the first control. * **control\_qubit2** (*QubitSpecifier*) – The qubit(s) used as the second control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘10’). Defaults to controlling on the ‘11’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘10’). Defaults to controlling on the ‘11’ state. **Returns** @@ -1978,8 +1978,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2002,8 +2002,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **theta** (*ParameterValueType*) – The angle of the rotation. * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2026,8 +2026,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **theta** (*ParameterValueType*) – The angle of the rotation. * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2050,8 +2050,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **theta** (*ParameterValueType*) – The angle of the rotation. * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2074,8 +2074,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **theta** (*ParameterValueType*) – The angle of the rotation. * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2097,8 +2097,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2120,8 +2120,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2144,8 +2144,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control. * **target\_qubit1** (*QubitSpecifier*) – The qubit(s) targeted by the gate. * **target\_qubit2** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. `'1'`). Defaults to controlling on the `'1'` state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. `'1'`). Defaults to controlling on the `'1'` state. **Returns** @@ -2167,8 +2167,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2194,8 +2194,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **gamma** (*ParameterValueType*) – The global phase applied of the U gate, if applied. * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2217,8 +2217,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the control. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2240,8 +2240,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the controls. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2263,8 +2263,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **control\_qubit** (*QubitSpecifier*) – The qubit(s) used as the controls. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2284,8 +2284,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. - * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. + * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -2305,7 +2305,7 @@ python_api_name: qiskit.circuit.QuantumCircuit * **duration** (*Object*) – duration of the delay. If this is an [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr"), it must be a constant expression of type [`Duration`](circuit_classical#qiskit.circuit.classical.types.Duration "qiskit.circuit.classical.types.Duration"). * **qarg** (*Object*) – qubit argument to apply this delay. - * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – unit of the duration, unless `duration` is an [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") in which case it must not be specified. Supported units: `'s'`, `'ms'`, `'us'`, `'ns'`, `'ps'`, and `'dt'`. Default is `'dt'`, i.e. integer time unit depending on the target backend. + * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – unit of the duration, unless `duration` is an [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") in which case it must not be specified. Supported units: `'s'`, `'ms'`, `'us'`, `'ns'`, `'ps'`, and `'dt'`. Default is `'dt'`, i.e. integer time unit depending on the target backend. **Returns** @@ -2329,8 +2329,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubits to apply the gate to. - * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubits to apply the gate to. + * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubits to apply the gate to. + * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubits to apply the gate to. **Returns** @@ -2350,7 +2350,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -2370,7 +2370,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -2390,7 +2390,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **params** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *| Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")*] |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **params** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *| Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")*] |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The state to initialize to, can be either of the following. @@ -2400,7 +2400,7 @@ python_api_name: qiskit.circuit.QuantumCircuit * **qubits** (*Sequence\[QubitSpecifier] | None*) – Qubits to initialize. If `None` the initialization is applied to all qubits in the circuit. - * **normalize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to normalize an input array to a unit vector. + * **normalize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to normalize an input array to a unit vector. **Returns** @@ -2479,8 +2479,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubits to apply the gate to. - * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubits to apply the gate to. + * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubits to apply the gate to. + * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubits to apply the gate to. **Returns** @@ -2503,7 +2503,7 @@ python_api_name: qiskit.circuit.QuantumCircuit * **lam** (*ParameterValueType*) – The angle of the rotation. * **control\_qubits** (*Sequence\[QubitSpecifier]*) – The qubits used as the controls. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2521,10 +2521,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The angle of the rotation. - * **q\_controls** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – The qubits used as the controls. - * **q\_target** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit targeted by the gate. - * **use\_basis\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – use p, u, cx basis gates. + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The angle of the rotation. + * **q\_controls** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – The qubits used as the controls. + * **q\_target** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit targeted by the gate. + * **use\_basis\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – use p, u, cx basis gates. #### mcry @@ -2538,8 +2538,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **q\_controls** (*Sequence\[QubitSpecifier]*) – The qubits used as the controls. * **q\_target** (*QubitSpecifier*) – The qubit targeted by the gate. * **q\_ancillae** (*QubitSpecifier | Sequence\[QubitSpecifier] | None*) – The list of ancillary qubits. - * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The implementation mode to use. - * **use\_basis\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – use p, u, cx basis gates + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The implementation mode to use. + * **use\_basis\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – use p, u, cx basis gates #### mcrz @@ -2549,10 +2549,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **lam** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The angle of the rotation. - * **q\_controls** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – The qubits used as the controls. - * **q\_target** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit targeted by the gate. - * **use\_basis\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – use p, u, cx basis gates. + * **lam** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The angle of the rotation. + * **q\_controls** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – The qubits used as the controls. + * **q\_target** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit targeted by the gate. + * **use\_basis\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – use p, u, cx basis gates. #### mcx @@ -2578,8 +2578,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **control\_qubits** (*Sequence\[QubitSpecifier]*) – The qubits used as the controls. * **target\_qubit** (*QubitSpecifier*) – The qubit(s) targeted by the gate. * **ancilla\_qubits** (*QubitSpecifier | Sequence\[QubitSpecifier] | None*) – The qubits used as the ancillae, if the mode requires them. - * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The choice of mode, explained further above. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The choice of mode, explained further above. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The control state in decimal, or as a bitstring (e.g. ‘1’). Defaults to controlling on the ‘1’ state. **Returns** @@ -2587,8 +2587,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if the given mode is not known, or if too few ancilla qubits are passed. - * [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – if no ancilla qubits are passed, but some are needed. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if the given mode is not known, or if too few ancilla qubits are passed. + * [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – if no ancilla qubits are passed, but some are needed. **Return type** @@ -2604,8 +2604,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – qubit(s) to measure. - * **cbit** ([*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – classical bit(s) to place the measurement result(s) in. + * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – qubit(s) to measure. + * **cbit** ([*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – classical bit(s) to place the measurement result(s) in. **Returns** @@ -2680,8 +2680,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The angle of the rotation. - * **qubits** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – The qubits to apply the gate to. + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The angle of the rotation. + * **qubits** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – The qubits to apply the gate to. **Returns** @@ -2701,8 +2701,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – THe angle of the rotation. - * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – THe angle of the rotation. + * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -2720,8 +2720,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **pauli\_string** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A string representing the Pauli operator to apply, e.g. ‘XX’. - * **qubits** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – The qubits to apply this gate to. + * **pauli\_string** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – A string representing the Pauli operator to apply, e.g. ‘XX’. + * **qubits** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – The qubits to apply this gate to. **Returns** @@ -2741,7 +2741,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *| Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")*] |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *| Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")*] |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The state to initialize to, can be either of the following. @@ -2751,9 +2751,9 @@ python_api_name: qiskit.circuit.QuantumCircuit * **qubits** (*Sequence\[QubitSpecifier] | None*) – Qubits to initialize. If `None` the initialization is applied to all qubits in the circuit. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate - * **normalize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to normalize an input array to a unit vector. + * **normalize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to normalize an input array to a unit vector. **Returns** @@ -2836,9 +2836,9 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The angle of the rotation. - * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The angle of the axis of rotation in the x-y plane. - * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The angle of the rotation. + * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The angle of the axis of rotation in the x-y plane. + * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -2858,10 +2858,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **control\_qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) used as the first control. - * **control\_qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) used as the second control. - * **control\_qubit3** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) used as the third control. - * **target\_qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) targeted by the gate. + * **control\_qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) used as the first control. + * **control\_qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) used as the second control. + * **control\_qubit3** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) used as the third control. + * **target\_qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) targeted by the gate. **Returns** @@ -2881,9 +2881,9 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **control\_qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) used as the first control. - * **control\_qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) used as the second control. - * **target\_qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) targeted by the gate. + * **control\_qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) used as the first control. + * **control\_qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) used as the second control. + * **target\_qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) targeted by the gate. **Returns** @@ -2901,7 +2901,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – qubit(s) to reset. + **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – qubit(s) to reset. **Returns** @@ -2923,10 +2923,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **vx** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – x-component of the rotation axis. - * **vy** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – y-component of the rotation axis. - * **vz** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – z-component of the rotation axis. - * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + * **vx** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – x-component of the rotation axis. + * **vy** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – y-component of the rotation axis. + * **vz** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – z-component of the rotation axis. + * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -2948,7 +2948,7 @@ python_api_name: qiskit.circuit.QuantumCircuit * **theta** (*ParameterValueType*) – The rotation angle of the gate. * **qubit** (*QubitSpecifier*) – The qubit(s) to apply the gate to. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. **Returns** @@ -2968,9 +2968,9 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The angle of the rotation. - * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. - * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The angle of the rotation. + * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. + * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -2992,7 +2992,7 @@ python_api_name: qiskit.circuit.QuantumCircuit * **theta** (*ParameterValueType*) – The rotation angle of the gate. * **qubit** (*QubitSpecifier*) – The qubit(s) to apply the gate to. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. **Returns** @@ -3012,9 +3012,9 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The rotation angle of the gate. - * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. - * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The rotation angle of the gate. + * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. + * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3034,8 +3034,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The rotation angle of the gate. - * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The rotation angle of the gate. + * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3055,9 +3055,9 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The rotation angle of the gate. - * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. - * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The rotation angle of the gate. + * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. + * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3077,9 +3077,9 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The rotation angle of the gate. - * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. - * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The rotation angle of the gate. + * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. + * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3099,7 +3099,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3119,7 +3119,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3139,8 +3139,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **lvalue** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – a valid specifier for a memory location in the circuit. This will typically be a [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node, but you can also write to [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") or [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") memory locations if your hardware supports it. The memory location must already be present in the circuit. - * **rvalue** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – a real-time classical expression whose result should be written into the given memory location. + * **lvalue** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – a valid specifier for a memory location in the circuit. This will typically be a [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node, but you can also write to [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") or [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") memory locations if your hardware supports it. The memory location must already be present in the circuit. + * **rvalue** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – a real-time classical expression whose result should be written into the given memory location. **Return type** @@ -3166,8 +3166,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubits to apply the gate to. - * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubits to apply the gate to. + * **qubit1** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubits to apply the gate to. + * **qubit2** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubits to apply the gate to. **Returns** @@ -3187,7 +3187,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3207,7 +3207,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3227,7 +3227,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3247,7 +3247,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3267,10 +3267,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The $\theta$ rotation angle of the gate. - * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The $\phi$ rotation angle of the gate. - * **lam** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The $\lambda$ rotation angle of the gate. - * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The $\theta$ rotation angle of the gate. + * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The $\phi$ rotation angle of the gate. + * **lam** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The $\lambda$ rotation angle of the gate. + * **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3290,7 +3290,7 @@ python_api_name: qiskit.circuit.QuantumCircuit * **obj** (*np.ndarray |* [*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| BaseOperator*) – Unitary operator. * **qubits** (*Sequence\[QubitSpecifier]*) – The circuit qubits to apply the transformation to. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Unitary name for backend \[Default: None]. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Unitary name for backend \[Default: None]. **Returns** @@ -3325,7 +3325,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **qubit** (*QubitSpecifier*) – The qubit(s) to apply the gate to. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the gate in the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the gate in the circuit. **Returns** @@ -3345,7 +3345,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3365,7 +3365,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit(s) to apply the gate to. + **qubit** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit(s) to apply the gate to. **Returns** @@ -3460,13 +3460,13 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **body\_or\_annotations** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*Annotation*](qiskit.circuit.Annotation "qiskit.circuit.Annotation")*]*) – the first positional argument is unnamed. If a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") is passed positionally, it is immediately used as the body of the box, and `qubits` and `clbits` must also be specified. If not given, or if given an iterable of [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects, the context-manager form of this method is triggered. + * **body\_or\_annotations** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*Annotation*](qiskit.circuit.Annotation "qiskit.circuit.Annotation")*]*) – the first positional argument is unnamed. If a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") is passed positionally, it is immediately used as the body of the box, and `qubits` and `clbits` must also be specified. If not given, or if given an iterable of [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects, the context-manager form of this method is triggered. * **qubits** (*Sequence\[QubitSpecifier] | None*) – the qubits to apply the [`BoxOp`](qiskit.circuit.BoxOp "qiskit.circuit.BoxOp") to, in the explicit form. * **clbits** (*Sequence\[ClbitSpecifier] | None*) – the qubits to apply the [`BoxOp`](qiskit.circuit.BoxOp "qiskit.circuit.BoxOp") to, in the explicit form. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – an optional string label for the instruction. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – an optional string label for the instruction. * **duration** (*None*) – an optional explicit duration for the [`BoxOp`](qiskit.circuit.BoxOp "qiskit.circuit.BoxOp"). Scheduling passes are constrained to schedule the contained scope to match a given duration, including delay insertion if required. * **unit** (*Literal\['dt', 's', 'ms', 'us', 'ns', 'ps', 'expr'] | None*) – the unit of the `duration`. - * **annotations** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*Annotation*](qiskit.circuit.Annotation "qiskit.circuit.Annotation")*]*) – any [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects the box should have. When this method is used in context-manager form, this argument can instead be passed as the only positional argument. + * **annotations** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*Annotation*](qiskit.circuit.Annotation "qiskit.circuit.Annotation")*]*) – any [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects the box should have. When this method is used in context-manager form, this argument can instead be passed as the only positional argument. #### break\_loop @@ -3536,7 +3536,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **indexset** (*Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – A collection of integers to loop over. Always necessary. + * **indexset** (*Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – A collection of integers to loop over. Always necessary. * **loop\_parameter** (*Optional\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*]*) – @@ -3550,7 +3550,7 @@ python_api_name: qiskit.circuit.QuantumCircuit * **clbits** (*Optional\[Sequence\[ClbitSpecifier]]*) – The circuit clbits over which the loop body should be run. Omit this to use the context-manager mode. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – The string label of the instruction in the circuit. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – The string label of the instruction in the circuit. **Returns** @@ -3589,12 +3589,12 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]*) – A condition to be evaluated in real time at circuit execution, 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`. + * **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*]*) – A condition to be evaluated in real time at circuit execution, 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")) – The circuit body to be run if `condition` is true. * **false\_body** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The circuit to be run if `condition` is false. * **qubits** (*Sequence\[QubitSpecifier]*) – The circuit qubits over which the if/else should be run. * **clbits** (*Sequence\[ClbitSpecifier]*) – The circuit clbits over which the if/else should be run. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The string label of the instruction in the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The string label of the instruction in the circuit. **Raises** @@ -3639,11 +3639,11 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **condition** (*Tuple\[Union\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*],* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – A condition to be evaluated in real time during circuit execution, 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`. + * **condition** (*Tuple\[Union\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*],* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – A condition to be evaluated in real time during circuit execution, 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** (*Optional\[*[*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – The circuit body to be run if `condition` is true. * **qubits** (*Optional\[Sequence\[QubitSpecifier]]*) – The circuit qubits over which the if/else should be run. * **clbits** (*Optional\[Sequence\[ClbitSpecifier]]*) – The circuit clbits over which the if/else should be run. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – The string label of the instruction in the circuit. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – The string label of the instruction in the circuit. **Returns** @@ -3692,10 +3692,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **target** (*Union\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – The classical value to switch one. This must be integer-like. - * **cases** (*Iterable\[Tuple\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*,* [*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]]*) – A sequence of case specifiers. Each tuple defines one case body (the second item). The first item of the tuple can be either a single integer value, the special value [`CASE_DEFAULT`](circuit#qiskit.circuit.CASE_DEFAULT "qiskit.circuit.CASE_DEFAULT"), or a tuple of several integer values. Each of the integer values will be tried in turn; control will then pass to the body corresponding to the first match. [`CASE_DEFAULT`](circuit#qiskit.circuit.CASE_DEFAULT "qiskit.circuit.CASE_DEFAULT") matches all possible values. Omit in context-manager form. + * **cases** (*Iterable\[Tuple\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")*,* [*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]]*) – A sequence of case specifiers. Each tuple defines one case body (the second item). The first item of the tuple can be either a single integer value, the special value [`CASE_DEFAULT`](circuit#qiskit.circuit.CASE_DEFAULT "qiskit.circuit.CASE_DEFAULT"), or a tuple of several integer values. Each of the integer values will be tried in turn; control will then pass to the body corresponding to the first match. [`CASE_DEFAULT`](circuit#qiskit.circuit.CASE_DEFAULT "qiskit.circuit.CASE_DEFAULT") matches all possible values. Omit in context-manager form. * **qubits** (*Sequence\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – The circuit qubits over which all case bodies execute. Omit in context-manager form. * **clbits** (*Sequence\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – The circuit clbits over which all case bodies execute. Omit in context-manager form. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – The string label of the instruction in the circuit. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – The string label of the instruction in the circuit. **Returns** @@ -3732,11 +3732,11 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **condition** (*Tuple\[Union\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*],* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – An equality condition to be checked prior to executing `body`. The left-hand side of the condition must be a [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or a [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit"), and the right-hand side must be an integer or boolean. + * **condition** (*Tuple\[Union\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*],* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – An equality condition to be checked prior to executing `body`. The left-hand side of the condition must be a [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or a [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit"), and the right-hand side must be an integer or boolean. * **body** (*Optional\[*[*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – The loop body to be repeatedly executed. Omit this to use the context-manager mode. * **qubits** (*Optional\[Sequence\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]]*) – The circuit qubits over which the loop body should be run. Omit this to use the context-manager mode. * **clbits** (*Optional\[Sequence\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]]*) – The circuit clbits over which the loop body should be run. Omit this to use the context-manager mode. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – The string label of the instruction in the circuit. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – The string label of the instruction in the circuit. **Returns** @@ -3776,7 +3776,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **\*qargs** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.13)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – variadic list of valid qubit specifiers. Anything that can be passed as a qubit or collection of qubits is valid for each argument here. + **\*qargs** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*slice*](https://docs.python.org/3/library/functions.html#slice "(in Python v3.14)") *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – variadic list of valid qubit specifiers. Anything that can be passed as a qubit or collection of qubits is valid for each argument here. **Raises** @@ -3790,7 +3790,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### Converting circuits to single objects @@ -3810,8 +3810,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*, ParameterValueType] | None*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the instruction. If None, existing circuit parameters will also parameterize the instruction. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Optional gate label. + * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*, ParameterValueType] | None*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the instruction. If None, existing circuit parameters will also parameterize the instruction. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Optional gate label. **Returns** @@ -3837,8 +3837,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*, ParameterValueType] | None*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the gate. If `None`, existing circuit parameters will also parameterize the gate. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Optional gate label. + * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*, ParameterValueType] | None*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the gate. If `None`, existing circuit parameters will also parameterize the gate. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Optional gate label. **Returns** @@ -3862,7 +3862,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – All measurements inplace or return new circuit. + **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – All measurements inplace or return new circuit. **Returns** @@ -3884,8 +3884,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – All measurements inplace or return new circuit. - * **add\_bits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to add new bits to store the results. + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – All measurements inplace or return new circuit. + * **add\_bits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to add new bits to store the results. **Returns** @@ -3953,7 +3953,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – All measurements removed inplace or return new circuit. + **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – All measurements removed inplace or return new circuit. **Returns** @@ -4052,7 +4052,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **filter\_function** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*CircuitInstruction*](qiskit.circuit.CircuitInstruction "qiskit._accelerate.circuit.CircuitInstruction")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]*) – A function to decide which instructions count to increase depth. Should take as a single positional input a [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction"). Instructions for which the function returns `False` are ignored in the computation of the circuit depth. By default, filters out “directives”, such as [`Barrier`](circuit#qiskit.circuit.Barrier "qiskit.circuit.Barrier"). + **filter\_function** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)")*\[\[*[*CircuitInstruction*](qiskit.circuit.CircuitInstruction "qiskit._accelerate.circuit.CircuitInstruction")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*]*) – A function to decide which instructions count to increase depth. Should take as a single positional input a [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction"). Instructions for which the function returns `False` are ignored in the computation of the circuit depth. By default, filters out “directives”, such as [`Barrier`](circuit#qiskit.circuit.Barrier "qiskit.circuit.Barrier"). **Returns** @@ -4060,7 +4060,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") **Examples** @@ -4090,7 +4090,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of instruction to. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of instruction to. **Returns** @@ -4098,7 +4098,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")([tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")([tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) #### num\_connected\_components @@ -4108,7 +4108,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **unitary\_only** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Compute only unitary part of graph. + **unitary\_only** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Compute only unitary part of graph. **Returns** @@ -4116,7 +4116,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") #### num\_nonlocal\_gates @@ -4128,7 +4128,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") #### num\_tensor\_factors @@ -4142,7 +4142,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") #### num\_unitary\_factors @@ -4152,7 +4152,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") #### size @@ -4170,7 +4170,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") #### width @@ -4184,7 +4184,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### Accessing scheduling information @@ -4201,7 +4201,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") instance that contains durations for the instructions if the target is missing duration data for any of the instructions in the circuit an [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") will be raised. This should be the same target object used as the target for transpilation. - * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The unit to return the duration in. This defaults to “s” for seconds but this can be a supported SI prefix for seconds returns. For example setting this to “n” will return in unit of nanoseconds. Supported values of this type are “f”, “p”, “n”, “u”, “µ”, “m”, “k”, “M”, “G”, “T”, and “P”. Additionally, a value of “dt” is also accepted to output an integer in units of “dt”. For this to function “dt” must be specified in the `target`. + * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The unit to return the duration in. This defaults to “s” for seconds but this can be a supported SI prefix for seconds returns. For example setting this to “n” will return in unit of nanoseconds. Supported values of this type are “f”, “p”, “n”, “u”, “µ”, “m”, “k”, “M”, “G”, “T”, and “P”. Additionally, a value of “dt” is also accepted to output an integer in units of “dt”. For this to function “dt” must be specified in the `target`. **Returns** @@ -4213,7 +4213,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") | [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") | [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") #### qubit\_duration @@ -4223,7 +4223,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **\*qubits** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Qubits within `self` to include. + **\*qubits** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Qubits within `self` to include. **Returns** @@ -4231,7 +4231,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") #### qubit\_start\_time @@ -4256,7 +4256,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") #### qubit\_stop\_time @@ -4281,7 +4281,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") @@ -4309,8 +4309,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – if given, expand the circuit with ancillas up to this size. The ancillas will always be the highest qubit indices of the circuit. If not given (the default), the circuit stays the same width. This option cannot be set if the circuit already as a [`layout`](#qiskit.circuit.QuantumCircuit.layout "qiskit.circuit.QuantumCircuit.layout"). - * **apply\_layout** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if true (the default), set the [`layout`](#qiskit.circuit.QuantumCircuit.layout "qiskit.circuit.QuantumCircuit.layout") attribute of the circuit appropriately so that the circuit appears to have been laid out with the “trivial” layout, including ancilla expansion, for a backend of width `num_qubits`. This has no effect if the circuit already had a [`layout`](#qiskit.circuit.QuantumCircuit.layout "qiskit.circuit.QuantumCircuit.layout"). + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – if given, expand the circuit with ancillas up to this size. The ancillas will always be the highest qubit indices of the circuit. If not given (the default), the circuit stays the same width. This option cannot be set if the circuit already as a [`layout`](#qiskit.circuit.QuantumCircuit.layout "qiskit.circuit.QuantumCircuit.layout"). + * **apply\_layout** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if true (the default), set the [`layout`](#qiskit.circuit.QuantumCircuit.layout "qiskit.circuit.QuantumCircuit.layout") attribute of the circuit appropriately so that the circuit appears to have been laid out with the “trivial” layout, including ancilla expansion, for a backend of width `num_qubits`. This has no effect if the circuit already had a [`layout`](#qiskit.circuit.QuantumCircuit.layout "qiskit.circuit.QuantumCircuit.layout"). **Returns** @@ -4318,12 +4318,12 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if `num_qubits` is too small for the circuit. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if `num_qubits` is too small for the circuit. * [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if `num_qubits` is set to attempt to expand the circuit, but the circuit already has a layout set. **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ## Instruction-like methods @@ -4337,10 +4337,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – An optional label to give the controlled operation for visualization. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The control state in decimal or as a bitstring (e.g. ‘111’). If None, use `2**num_ctrl_qubits - 1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the controlled gate should be implemented as an annotated gate. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – An optional label to give the controlled operation for visualization. + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The control state in decimal or as a bitstring (e.g. ‘111’). If None, use `2**num_ctrl_qubits - 1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the controlled gate should be implemented as an annotated gate. **Returns** @@ -4364,7 +4364,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the inverse gate can be implemented as an annotated gate. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the inverse gate can be implemented as an annotated gate. **Returns** @@ -4410,9 +4410,9 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **power** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The power to raise this circuit to. - * **matrix\_power** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the inner power gate can be implemented as a unitary gate. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the inner power gate can be implemented as an annotated operation. + * **power** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The power to raise this circuit to. + * **matrix\_power** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the inner power gate can be implemented as a unitary gate. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the inner power gate can be implemented as an annotated operation. **Raises** @@ -4434,8 +4434,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – How often this circuit should be repeated. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to include barriers between circuit repetitions. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – How often this circuit should be repeated. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to include barriers between circuit repetitions. **Returns** @@ -4513,13 +4513,13 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **output** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Select the output method to use for drawing the circuit. Valid choices are `text`, `mpl`, `latex`, `latex_source`. By default, the `text` drawer is used unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative backend set as the default. For example, `circuit_drawer = latex`. If the output kwarg is set, that backend will always be used over the default in the user config file. + * **output** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Select the output method to use for drawing the circuit. Valid choices are `text`, `mpl`, `latex`, `latex_source`. By default, the `text` drawer is used unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative backend set as the default. For example, `circuit_drawer = latex`. If the output kwarg is set, that backend will always be used over the default in the user config file. - * **scale** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – Scale of image to draw (shrink if `< 1.0`). Only used by the `mpl`, `latex` and `latex_source` outputs. Defaults to `1.0`. + * **scale** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – Scale of image to draw (shrink if `< 1.0`). Only used by the `mpl`, `latex` and `latex_source` outputs. Defaults to `1.0`. - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – File path to save image to. Defaults to `None` (result not saved in a file). + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – File path to save image to. Defaults to `None` (result not saved in a file). - * **style** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **style** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Style name, file name of style JSON file, or a dictionary specifying the style. @@ -4528,37 +4528,37 @@ python_api_name: qiskit.circuit.QuantumCircuit * If a dictionary, every entry overrides the default configuration. If the `"name"` key is given, the default configuration is given by that style. For example, `{"name": "textbook", "subfontsize": 5}` loads the `"texbook"` style and sets the subfontsize (e.g. the gate angles) to `5`. * If `None` the default style `"iqp"` is used or, if given, the default style specified in `~/.qiskit/settings.conf`. - * **interactive** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – When set to `True`, show the circuit in a new window (for `mpl` this depends on the matplotlib backend being used supporting this). Note when used with either the text or the `latex_source` output type this has no effect and will be silently ignored. Defaults to `False`. + * **interactive** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – When set to `True`, show the circuit in a new window (for `mpl` this depends on the matplotlib backend being used supporting this). Note when used with either the text or the `latex_source` output type this has no effect and will be silently ignored. Defaults to `False`. - * **reverse\_bits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – When set to `True`, reverse the bit order inside registers for the output visualization. Defaults to `False` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_reverse_bits = True`. + * **reverse\_bits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – When set to `True`, reverse the bit order inside registers for the output visualization. Defaults to `False` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_reverse_bits = True`. - * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Enable/disable drawing barriers in the output circuit. Defaults to `True`. + * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Enable/disable drawing barriers in the output circuit. Defaults to `True`. - * **justify** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Options are `"left"`, `"right"` or `"none"` (str). If anything else is supplied, left justified will be used instead. It refers to where gates should be placed in the output circuit if there is an option. `none` results in each gate being placed in its own column. Defaults to `left`. + * **justify** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Options are `"left"`, `"right"` or `"none"` (str). If anything else is supplied, left justified will be used instead. It refers to where gates should be placed in the output circuit if there is an option. `none` results in each gate being placed in its own column. Defaults to `left`. - * **vertical\_compression** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – `high`, `medium` or `low`. It merges the lines generated by the text output so the drawing will take less vertical room. Default is `medium`. Only used by the `text` output, will be silently ignored otherwise. + * **vertical\_compression** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – `high`, `medium` or `low`. It merges the lines generated by the text output so the drawing will take less vertical room. Default is `medium`. Only used by the `text` output, will be silently ignored otherwise. - * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Include (or not) idle wires (wires with no circuit elements) in output visualization. The string `"auto"` is also possible, in which case idle wires are show except that the circuit has a layout attached. Default is `"auto"` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_idle_wires = False`. + * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Include (or not) idle wires (wires with no circuit elements) in output visualization. The string `"auto"` is also possible, in which case idle wires are show except that the circuit has a layout attached. Default is `"auto"` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_idle_wires = False`. - * **with\_layout** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Include layout information, with labels on the physical layout. Default is `True`. + * **with\_layout** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Include layout information, with labels on the physical layout. Default is `True`. - * **fold** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – Sets pagination. It can be disabled using -1. In `text`, sets the length of the lines. This is useful when the drawing does not fit in the console. If None (default), it will try to guess the console width using `shutil.get_terminal_size()`. However, if running in jupyter, the default line length is set to 80 characters. In `mpl`, it is the number of (visual) layers before folding. Default is 25. + * **fold** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – Sets pagination. It can be disabled using -1. In `text`, sets the length of the lines. This is useful when the drawing does not fit in the console. If None (default), it will try to guess the console width using `shutil.get_terminal_size()`. However, if running in jupyter, the default line length is set to 80 characters. In `mpl`, it is the number of (visual) layers before folding. Default is 25. * **ax** (*Any | None*) – Only used by the mpl backend. An optional `matplotlib.axes.Axes` object to be used for the visualization output. If none is specified, a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. - * **initial\_state** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Adds $|0\rangle$ in the beginning of the qubit wires and $0$ to classical wires. Default is `False`. + * **initial\_state** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Adds $|0\rangle$ in the beginning of the qubit wires and $0$ to classical wires. Default is `False`. - * **cregbundle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – If set to `True`, bundle classical registers. Default is `True`, except for when `output` is set to `"text"`. + * **cregbundle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – If set to `True`, bundle classical registers. Default is `True`, except for when `output` is set to `"text"`. - * **wire\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – A list of integers used to reorder the display of the bits. The list must have an entry for every bit with the bits in the range 0 to (`num_qubits` + `num_clbits`). + * **wire\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – A list of integers used to reorder the display of the bits. The list must have an entry for every bit with the bits in the range 0 to (`num_qubits` + `num_clbits`). - * **expr\_len** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of characters to display if an [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") is used for the condition in a [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp"). If this number is exceeded, the string will be truncated at that number and ‘…’ added to the end. + * **expr\_len** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of characters to display if an [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") is used for the condition in a [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp"). If this number is exceeded, the string will be truncated at that number and ‘…’ added to the end. - * **measure\_arrows** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – If True, draw an arrow from each measure box down the the classical bit or register where the measure value is placed. If False, do not draw arrow, but instead place the name of the bit or register in the measure box. Default is `True` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_measure_arrows = False`. + * **measure\_arrows** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – If True, draw an arrow from each measure box down the the classical bit or register where the measure value is placed. If False, do not draw arrow, but instead place the name of the bit or register in the measure box. Default is `True` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_measure_arrows = False`. **Returns** - `TextDrawing` or `matplotlib.figure` or `PIL.Image` or [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"): + `TextDrawing` or `matplotlib.figure` or `PIL.Image` or [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"): * **`TextDrawing` (if `output='text'`)** @@ -4579,7 +4579,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** * [**VisualizationError**](visualization#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – when an invalid output method is selected - * [**ImportError**](https://docs.python.org/3/library/exceptions.html#ImportError "(in Python v3.13)") – when the output methods requires non-installed libraries. + * [**ImportError**](https://docs.python.org/3/library/exceptions.html#ImportError "(in Python v3.14)") – when the output methods requires non-installed libraries. **Example** @@ -4603,8 +4603,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **gates\_to\_decompose** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*] | Sequence\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]] | None*) – Optional subset of gates to decompose. Can be a gate type, such as `HGate`, or a gate name, such as “h”, or a gate label, such as “My H Gate”, or a list of any combination of these. If a gate name is entered, it will decompose all gates with that name, whether the gates have labels or not. Defaults to all gates in the circuit. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Optional number of times the circuit should be decomposed. For instance, `reps=2` equals calling `circuit.decompose().decompose()`. + * **gates\_to\_decompose** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*] | Sequence\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]] | None*) – Optional subset of gates to decompose. Can be a gate type, such as `HGate`, or a gate name, such as “h”, or a gate label, such as “My H Gate”, or a list of any combination of these. If a gate name is entered, it will decompose all gates with that name, whether the gates have labels or not. Defaults to all gates in the circuit. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Optional number of times the circuit should be decomposed. For instance, `reps=2` equals calling `circuit.decompose().decompose()`. **Returns** @@ -4669,10 +4669,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – * **global\_phase** (*ParameterValueType*) – - * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – + * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *| None*) – * **inputs** (*Iterable\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*]*) – * **captures** (*Iterable\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") *|*[*expr.Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")*]*) – * **declarations** (*Mapping\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*,* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")*] | Iterable\[Tuple\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*,* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")*]]*) – diff --git a/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.mdx b/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.mdx index bc6e5c9b18d..37e2cc47a98 100644 --- a/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.mdx +++ b/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp * **target** ([*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") *|*[*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – the real-time value to switch on. * **cases** (*Iterable\[Tuple\[Any,* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]]*) – an ordered iterable of the corresponding value of the `target` and the circuit block that should be executed if this is matched. There is no fall-through between blocks, and the order matters. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – ## Attributes @@ -160,7 +160,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -184,7 +184,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -208,7 +208,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] ### iter\_captured\_vars @@ -218,7 +218,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] ### repeat @@ -228,7 +228,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -311,7 +311,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_mutable @@ -325,7 +325,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp ### validate\_parameter - Instruction parameters has no validation or normalization. + Instruction parameter has no validation or normalization. diff --git a/docs/api/qiskit/qiskit.circuit.WhileLoopOp.mdx b/docs/api/qiskit/qiskit.circuit.WhileLoopOp.mdx index 5b3903e4aa2..3ddaa22b32b 100644 --- a/docs/api/qiskit/qiskit.circuit.WhileLoopOp.mdx +++ b/docs/api/qiskit/qiskit.circuit.WhileLoopOp.mdx @@ -17,9 +17,9 @@ python_api_name: qiskit.circuit.WhileLoopOp **Parameters** - * **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] |* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – A condition to be checked prior to executing `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`. + * **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] |* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – A condition to be checked prior to executing `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`. * **body** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The loop body to be repeatedly executed. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for identifying the instruction. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for identifying the instruction. ## Attributes @@ -136,7 +136,7 @@ python_api_name: qiskit.circuit.WhileLoopOp **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.circuit.WhileLoopOp **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -184,7 +184,7 @@ python_api_name: qiskit.circuit.WhileLoopOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Stretch](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")] ### iter\_captured\_vars @@ -194,7 +194,7 @@ python_api_name: qiskit.circuit.WhileLoopOp **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[expr.Var](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")] ### repeat @@ -204,7 +204,7 @@ python_api_name: qiskit.circuit.WhileLoopOp **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -283,7 +283,7 @@ python_api_name: qiskit.circuit.WhileLoopOp **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_mutable @@ -297,7 +297,7 @@ python_api_name: qiskit.circuit.WhileLoopOp ### validate\_parameter - Instruction parameters has no validation or normalization. + Instruction parameter has no validation or normalization. diff --git a/docs/api/qiskit/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/qiskit.circuit.library.AND.mdx index 1850fdc888b..2c94058872b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.AND.mdx @@ -29,9 +29,9 @@ python_api_name: qiskit.circuit.library.AND **Parameters** - * **num\_variable\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The qubits of which the AND is computed. The result will be written into an additional result qubit. - * **flags** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – A list of +1/0/-1 marking negations or omissions of qubits. - * **mcx\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The mode to be used to implement the multi-controlled X gate. + * **num\_variable\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The qubits of which the AND is computed. The result will be written into an additional result qubit. + * **flags** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – A list of +1/0/-1 marking negations or omissions of qubits. + * **mcx\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The mode to be used to implement the multi-controlled X gate. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.AndGate.mdx b/docs/api/qiskit/qiskit.circuit.library.AndGate.mdx index ca57b7c6e24..10bfc594bed 100644 --- a/docs/api/qiskit/qiskit.circuit.library.AndGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.AndGate.mdx @@ -25,8 +25,8 @@ python_api_name: qiskit.circuit.library.AndGate **Parameters** - * **num\_variable\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The qubits of which the AND is computed. The result will be written into an additional result qubit. - * **flags** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – A list of +1/0/-1 marking negations or omissions of qubits. + * **num\_variable\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The qubits of which the AND is computed. The result will be written into an additional result qubit. + * **flags** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – A list of +1/0/-1 marking negations or omissions of qubits. ## Attributes @@ -146,8 +146,8 @@ python_api_name: qiskit.circuit.library.AndGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -159,7 +159,7 @@ python_api_name: qiskit.circuit.library.AndGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -171,10 +171,10 @@ python_api_name: qiskit.circuit.library.AndGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -192,7 +192,7 @@ python_api_name: qiskit.circuit.library.AndGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -210,7 +210,7 @@ python_api_name: qiskit.circuit.library.AndGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -236,8 +236,8 @@ python_api_name: qiskit.circuit.library.AndGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -255,7 +255,7 @@ python_api_name: qiskit.circuit.library.AndGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -303,7 +303,7 @@ python_api_name: qiskit.circuit.library.AndGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.BitFlipOracleGate.mdx b/docs/api/qiskit/qiskit.circuit.library.BitFlipOracleGate.mdx index 0aae9a95f96..af6a4327c64 100644 --- a/docs/api/qiskit/qiskit.circuit.library.BitFlipOracleGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.BitFlipOracleGate.mdx @@ -27,9 +27,9 @@ $$ **Parameters** - * **expression** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| BooleanExpression*) – A Python-like boolean expression string or a BooleanExpression object. - * **var\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – A list with the order in which variables will be created. (default: by appearance) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – A label for the gate to display in visualizations. Per default, the label is set to display the textual represntation of the boolean expression (truncated if needed) + * **expression** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| BooleanExpression*) – A Python-like boolean expression string or a BooleanExpression object. + * **var\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] | None*) – A list with the order in which variables will be created. (default: by appearance) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – A label for the gate to display in visualizations. Per default, the label is set to display the textual represntation of the boolean expression (truncated if needed) ## Attributes @@ -149,8 +149,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -162,7 +162,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -174,10 +174,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -195,7 +195,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -231,7 +231,7 @@ $$ **Parameters** - **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A file in DIMACS format. + **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – A file in DIMACS format. **Returns** @@ -255,7 +255,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -281,8 +281,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -300,7 +300,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -348,7 +348,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.BitwiseXorGate.mdx b/docs/api/qiskit/qiskit.circuit.library.BitwiseXorGate.mdx index bb41a84e2fe..afaf3eab51d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.BitwiseXorGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.BitwiseXorGate.mdx @@ -23,8 +23,8 @@ python_api_name: qiskit.circuit.library.BitwiseXorGate **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the width of circuit. - * **amount** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the xor amount in decimal form. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the width of circuit. + * **amount** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the xor amount in decimal form. **Raises** @@ -148,8 +148,8 @@ python_api_name: qiskit.circuit.library.BitwiseXorGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -161,7 +161,7 @@ python_api_name: qiskit.circuit.library.BitwiseXorGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -173,10 +173,10 @@ python_api_name: qiskit.circuit.library.BitwiseXorGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -194,7 +194,7 @@ python_api_name: qiskit.circuit.library.BitwiseXorGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -212,7 +212,7 @@ python_api_name: qiskit.circuit.library.BitwiseXorGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -238,8 +238,8 @@ python_api_name: qiskit.circuit.library.BitwiseXorGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -257,7 +257,7 @@ python_api_name: qiskit.circuit.library.BitwiseXorGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -305,7 +305,7 @@ python_api_name: qiskit.circuit.library.BitwiseXorGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.C3SXGate.mdx index f57fc07221b..257854c80d6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.C3SXGate.mdx @@ -108,7 +108,7 @@ python_api_name: qiskit.circuit.library.C3SXGate **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -128,7 +128,7 @@ python_api_name: qiskit.circuit.library.C3SXGate **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -180,8 +180,8 @@ python_api_name: qiskit.circuit.library.C3SXGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -193,7 +193,7 @@ python_api_name: qiskit.circuit.library.C3SXGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -205,10 +205,10 @@ python_api_name: qiskit.circuit.library.C3SXGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -226,7 +226,7 @@ python_api_name: qiskit.circuit.library.C3SXGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -244,7 +244,7 @@ python_api_name: qiskit.circuit.library.C3SXGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – **Return type** @@ -266,8 +266,8 @@ python_api_name: qiskit.circuit.library.C3SXGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -285,7 +285,7 @@ python_api_name: qiskit.circuit.library.C3SXGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -333,7 +333,7 @@ python_api_name: qiskit.circuit.library.C3SXGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.C3XGate.mdx b/docs/api/qiskit/qiskit.circuit.library.C3XGate.mdx index f5ca5f2afd2..683d4671a08 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C3XGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.C3XGate.mdx @@ -99,7 +99,7 @@ python_api_name: qiskit.circuit.library.C3XGate **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -119,7 +119,7 @@ python_api_name: qiskit.circuit.library.C3XGate **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -171,8 +171,8 @@ python_api_name: qiskit.circuit.library.C3XGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -184,7 +184,7 @@ python_api_name: qiskit.circuit.library.C3XGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -194,10 +194,10 @@ python_api_name: qiskit.circuit.library.C3XGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled C3X gate is a multi-controlled X-gate. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled C3X gate is a multi-controlled X-gate. **Returns** @@ -215,7 +215,7 @@ python_api_name: qiskit.circuit.library.C3XGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -233,7 +233,7 @@ python_api_name: qiskit.circuit.library.C3XGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -259,8 +259,8 @@ python_api_name: qiskit.circuit.library.C3XGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -278,7 +278,7 @@ python_api_name: qiskit.circuit.library.C3XGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -326,7 +326,7 @@ python_api_name: qiskit.circuit.library.C3XGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.C4XGate.mdx b/docs/api/qiskit/qiskit.circuit.library.C4XGate.mdx index 7c32f78827b..a53ff560dd2 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C4XGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.C4XGate.mdx @@ -104,7 +104,7 @@ python_api_name: qiskit.circuit.library.C4XGate **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -124,7 +124,7 @@ python_api_name: qiskit.circuit.library.C4XGate **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -176,8 +176,8 @@ python_api_name: qiskit.circuit.library.C4XGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -189,7 +189,7 @@ python_api_name: qiskit.circuit.library.C4XGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -199,10 +199,10 @@ python_api_name: qiskit.circuit.library.C4XGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled C4X gate is a multi-controlled X-gate. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled C4X gate is a multi-controlled X-gate. **Returns** @@ -220,7 +220,7 @@ python_api_name: qiskit.circuit.library.C4XGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.C4XGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -264,8 +264,8 @@ python_api_name: qiskit.circuit.library.C4XGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -283,7 +283,7 @@ python_api_name: qiskit.circuit.library.C4XGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -331,7 +331,7 @@ python_api_name: qiskit.circuit.library.C4XGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CCXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CCXGate.mdx index 6d964210031..6b939cbda08 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CCXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CCXGate.mdx @@ -155,7 +155,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -175,7 +175,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -227,8 +227,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -240,7 +240,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -250,10 +250,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled CCX gate is a multi-controlled X-gate. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled CCX gate is a multi-controlled X-gate. **Returns** @@ -271,7 +271,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -289,7 +289,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -315,8 +315,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -334,7 +334,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -382,7 +382,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CCZGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CCZGate.mdx index e7f54ea0131..c90b8d87ff6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CCZGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CCZGate.mdx @@ -130,7 +130,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -150,7 +150,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -202,8 +202,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -215,7 +215,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -227,10 +227,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -248,7 +248,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -266,7 +266,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -292,8 +292,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -311,7 +311,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -359,7 +359,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index 084a6e3be80..afb182a1e2f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -85,13 +85,13 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. - * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The kind of adder, can be `'full'` for a full adder, `'half'` for a half adder, or `'fixed'` for a fixed-sized adder. A full adder includes both carry-in and carry-out, a half only carry-out, and a fixed-sized adder neither carry-in nor carry-out. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit object. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. + * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The kind of adder, can be `'full'` for a full adder, `'half'` for a half adder, or `'fixed'` for a fixed-sized adder. A full adder includes both carry-in and carry-out, a half only carry-out, and a fixed-sized adder neither carry-in nor carry-out. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit object. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_state_qubits` is lower than 1. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_state_qubits` is lower than 1. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CHGate.mdx index d79f6778def..64ce84b7763 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CHGate.mdx @@ -145,7 +145,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -165,7 +165,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -217,8 +217,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -230,7 +230,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -242,10 +242,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -263,7 +263,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -281,7 +281,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### is\_parameterized @@ -299,8 +299,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -318,7 +318,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -366,7 +366,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.mdx index 200cd266298..148a00f3852 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.mdx @@ -49,8 +49,8 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – ### base\_class @@ -132,7 +132,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -152,7 +152,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -204,8 +204,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -217,7 +217,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -227,10 +227,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. **Returns** @@ -248,7 +248,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -266,7 +266,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### is\_parameterized @@ -284,8 +284,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -303,7 +303,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -351,7 +351,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CRXGate.mdx index eefc602574d..65af0ebf94a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CRXGate.mdx @@ -70,8 +70,8 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – - * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – ### base\_class @@ -153,7 +153,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -173,7 +173,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -225,8 +225,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -238,7 +238,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -250,10 +250,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -271,7 +271,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -289,7 +289,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CRXGate`](#qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate") with an inverted parameter value. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CRXGate`](#qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate") with an inverted parameter value. **Returns** @@ -315,8 +315,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -334,7 +334,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -382,7 +382,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CRYGate.mdx index be21257fd66..fbf9677ec1c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CRYGate.mdx @@ -70,8 +70,8 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – - * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – ### base\_class @@ -153,7 +153,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -173,7 +173,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -225,8 +225,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -238,7 +238,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -250,10 +250,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -271,7 +271,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -289,7 +289,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CRYGate`](#qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate") with an inverted parameter value. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CRYGate`](#qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate") with an inverted parameter value. **Returns** @@ -317,8 +317,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -336,7 +336,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -384,7 +384,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CRZGate.mdx index 9301510620f..22ca21f03c1 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CRZGate.mdx @@ -72,8 +72,8 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – - * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – ### base\_class @@ -155,7 +155,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -175,7 +175,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -227,8 +227,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -240,7 +240,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -252,10 +252,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -273,7 +273,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -291,7 +291,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – **when set to `True`, this is typically used to return an** @@ -317,8 +317,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -336,7 +336,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -384,7 +384,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CSGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CSGate.mdx index ad837cc3ef7..ba997058f60 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CSGate.mdx @@ -121,7 +121,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -141,7 +141,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -193,8 +193,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -206,7 +206,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -218,10 +218,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -239,7 +239,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -257,7 +257,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate"). **Returns** @@ -283,8 +283,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -302,7 +302,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -350,7 +350,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CSXGate.mdx index c41047f1142..dfcf8a3a10c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CSXGate.mdx @@ -143,7 +143,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -163,7 +163,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -215,8 +215,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -228,7 +228,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -240,10 +240,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -261,7 +261,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -279,7 +279,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – **Return type** @@ -301,8 +301,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -320,7 +320,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -368,7 +368,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CSdgGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CSdgGate.mdx index 25b0b9c62de..2dc256d81e3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSdgGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CSdgGate.mdx @@ -121,7 +121,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -141,7 +141,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -193,8 +193,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -206,7 +206,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -218,10 +218,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -239,7 +239,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -257,7 +257,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate"). **Returns** @@ -283,8 +283,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -302,7 +302,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -350,7 +350,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CSwapGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CSwapGate.mdx index 0fb191565d6..0e2805231fe 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSwapGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CSwapGate.mdx @@ -164,7 +164,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -184,7 +184,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -236,8 +236,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -249,7 +249,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -261,10 +261,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -282,7 +282,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -300,7 +300,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -326,8 +326,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -345,7 +345,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -393,7 +393,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/qiskit.circuit.library.CU1Gate.mdx index 8023e80b888..eadf5d7fd3d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CU1Gate.mdx @@ -60,8 +60,8 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – ### base\_class @@ -143,7 +143,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -163,7 +163,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -215,8 +215,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -228,7 +228,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -238,10 +238,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the controlled gate should be implemented as an annotated gate. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the controlled gate should be implemented as an annotated gate. **Returns** @@ -259,7 +259,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -277,7 +277,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CU1Gate`](#qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate") with inverse parameter values. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CU1Gate`](#qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate") with inverse parameter values. **Returns** @@ -303,8 +303,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -322,7 +322,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -370,7 +370,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/qiskit.circuit.library.CU3Gate.mdx index ef65229afd9..cce0043c132 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CU3Gate.mdx @@ -88,8 +88,8 @@ $$ * **theta** (*ParameterValueType*) – * **phi** (*ParameterValueType*) – * **lam** (*ParameterValueType*) – - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – - * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – ### base\_class @@ -171,7 +171,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -191,7 +191,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -243,8 +243,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -256,7 +256,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -268,10 +268,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -289,7 +289,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -309,7 +309,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CU3Gate`](#qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate") with inverse parameter values. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CU3Gate`](#qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate") with inverse parameter values. **Returns** @@ -335,8 +335,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -354,7 +354,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -402,7 +402,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CUGate.mdx index a6da2c3fd64..9deed483987 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CUGate.mdx @@ -79,8 +79,8 @@ $$ * **phi** (*ParameterValueType*) – * **lam** (*ParameterValueType*) – * **gamma** (*ParameterValueType*) – - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – - * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – ### base\_class @@ -162,7 +162,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -220,8 +220,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -233,7 +233,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -245,10 +245,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -266,7 +266,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -286,7 +286,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CUGate`](#qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate") with inverse parameter values. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`CUGate`](#qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate") with inverse parameter values. **Returns** @@ -312,8 +312,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -331,7 +331,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -379,7 +379,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CXGate.mdx index 30513a88a82..8da0e5284ca 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CXGate.mdx @@ -151,7 +151,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -171,7 +171,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -223,8 +223,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -236,7 +236,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -246,10 +246,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled CX gate is a multi-controlled X-gate. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled CX gate is a multi-controlled X-gate. **Returns** @@ -267,7 +267,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -285,7 +285,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -311,8 +311,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -330,7 +330,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -378,7 +378,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CYGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CYGate.mdx index 06a585f39b1..8067686694c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CYGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CYGate.mdx @@ -143,7 +143,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -163,7 +163,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -215,8 +215,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -228,7 +228,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -240,10 +240,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -261,7 +261,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -279,7 +279,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -305,8 +305,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -324,7 +324,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -372,7 +372,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.CZGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CZGate.mdx index a1cf9a772ea..893b551ede5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CZGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CZGate.mdx @@ -124,7 +124,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -144,7 +144,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -196,8 +196,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -209,7 +209,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -221,10 +221,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -242,7 +242,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -260,7 +260,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -286,8 +286,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -305,7 +305,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -353,7 +353,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.DCXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.DCXGate.mdx index 4d8c2c9bc09..2cacfb455d3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.DCXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.DCXGate.mdx @@ -159,8 +159,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -172,7 +172,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -184,10 +184,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -205,7 +205,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -229,7 +229,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -255,8 +255,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -274,7 +274,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -322,7 +322,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/qiskit.circuit.library.Diagonal.mdx index 650f83a6037..108021c28f7 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.Diagonal.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.circuit.library.Diagonal **Parameters** - **diag** (*Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")*]*) – List of the $2^k$ diagonal entries (for a diagonal gate on $k$ qubits). + **diag** (*Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")*]*) – List of the $2^k$ diagonal entries (for a diagonal gate on $k$ qubits). **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.mdx b/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.mdx index 7f3c7122c61..f6b330bcdbb 100644 --- a/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.mdx @@ -41,7 +41,7 @@ $$ **Parameters** - **diag** (*Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")*]*) – list of the $2^k$ diagonal entries (for a diagonal gate on $k$ qubits). + **diag** (*Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")*]*) – list of the $2^k$ diagonal entries (for a diagonal gate on $k$ qubits). ## Attributes @@ -161,8 +161,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -174,7 +174,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -186,10 +186,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -207,7 +207,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -225,7 +225,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### is\_parameterized @@ -243,8 +243,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -262,7 +262,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -310,7 +310,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.mdx index 6dbdc3d6dda..ee1638f13fd 100644 --- a/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.mdx @@ -52,13 +52,13 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. - * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The kind of adder, can be `'half'` for a half adder or `'fixed'` for a fixed-sized adder. A half adder contains a carry-out to represent the most-significant bit, but the fixed-sized adder doesn’t and hence performs addition modulo `2 ** num_state_qubits`. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit object. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. + * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The kind of adder, can be `'half'` for a half adder or `'fixed'` for a fixed-sized adder. A half adder contains a carry-out to represent the most-significant bit, but the fixed-sized adder doesn’t and hence performs addition modulo `2 ** num_state_qubits`. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit object. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_state_qubits` is lower than 1. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_state_qubits` is lower than 1. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.ECRGate.mdx b/docs/api/qiskit/qiskit.circuit.library.ECRGate.mdx index 2c301239364..5909bebe8ed 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ECRGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ECRGate.mdx @@ -184,8 +184,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -197,7 +197,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -209,10 +209,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -230,7 +230,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -248,7 +248,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -274,8 +274,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -293,7 +293,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -341,7 +341,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.mdx index 373c0642ef9..8ca4caa1d6d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.mdx @@ -72,17 +72,17 @@ python_api_name: qiskit.circuit.library.EfficientSU2 **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits of the EfficientSU2 circuit. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. - * **su2\_gates** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The SU(2) single qubit gates to apply in single qubit gate layers. If only one gate is provided, the same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. - * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’, ‘reverse\_linear’, ‘pairwise’, ‘circular’, or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. Defaults to ‘reverse\_linear’ entanglement. Note that ‘reverse\_linear’ entanglement provides the same unitary as ‘full’ with fewer entangling gates. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits of the EfficientSU2 circuit. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. + * **su2\_gates** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The SU(2) single qubit gates to apply in single qubit gate layers. If only one gate is provided, the same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’, ‘reverse\_linear’, ‘pairwise’, ‘circular’, or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. Defaults to ‘reverse\_linear’ entanglement. Note that ‘reverse\_linear’ entanglement provides the same unitary as ‘full’ with fewer entangling gates. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A QuantumCircuit object to prepend to the circuit. - * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. - * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If False, a rotation layer is added at the end of the ansatz. If True, no rotation layer is added. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. - * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. + * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If False, a rotation layer is added at the end of the ansatz. If True, no rotation layer is added. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. + * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index b9e5939a303..1ea2da079fb 100644 --- a/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -15,14 +15,14 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz **Parameters** - * **operators** (*BaseOperator |* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| None*) – The operators to evolve. If a circuit is passed, we assume it implements an already evolved operator and thus the circuit is not evolved again. Can be a single operator (circuit) or a list of operators (and circuits). - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of times to repeat the evolved operators. + * **operators** (*BaseOperator |* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *| None*) – The operators to evolve. If a circuit is passed, we assume it implements an already evolved operator and thus the circuit is not evolved again. Can be a single operator (circuit) or a list of operators (and circuits). + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of times to repeat the evolved operators. * **evolution** (*EvolutionBase |* [*EvolutionSynthesis*](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.EvolutionSynthesis") *| None*) – A specification of which evolution synthesis to use for the [`PauliEvolutionGate`](qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate"). Defaults to first order Trotterization. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to insert barriers in between each evolution. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – Set the names of the circuit parameters. If a string, the same prefix will be used for each parameters. Can also be a list to specify a prefix per operator. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to insert barriers in between each evolution. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| Sequence\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – Set the names of the circuit parameters. If a string, the same prefix will be used for each parameters. Can also be a list to specify a prefix per operator. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object to prepend to the circuit. - * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. ## Attributes @@ -61,7 +61,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") ### preferred\_init\_points diff --git a/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.mdx index 148b8e34c9d..633e9cd4829 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.mdx @@ -23,10 +23,10 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits representing the value to invert. - * **scaling** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Scaling factor $s$ of the reciprocal function, i.e. to compute $s / x$. - * **neg\_vals** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether $x$ might represent negative values. In this case the first qubit is the sign, with $|1\rangle$ for negative and $|0\rangle$ for positive. For the negative case it is assumed that the remaining string represents $1 - x$. This is because $e^{-2 \pi i x} = e^{2 \pi i (1 - x)}$ for $x \in [0,1)$. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the object. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits representing the value to invert. + * **scaling** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Scaling factor $s$ of the reciprocal function, i.e. to compute $s / x$. + * **neg\_vals** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether $x$ might represent negative values. In this case the first qubit is the sign, with $|1\rangle$ for negative and $|0\rangle$ for positive. For the negative case it is assumed that the remaining string represents $1 - x$. This is because $e^{-2 \pi i x} = e^{2 \pi i (1 - x)}$ for $x \in [0,1)$. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the object. It is assumed that the binary string $x$ represents a number \< 1. diff --git a/docs/api/qiskit/qiskit.circuit.library.ExactReciprocalGate.mdx b/docs/api/qiskit/qiskit.circuit.library.ExactReciprocalGate.mdx index de9ec7fcb3c..e8616e32d2a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ExactReciprocalGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ExactReciprocalGate.mdx @@ -25,10 +25,10 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits representing the value to invert. - * **scaling** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Scaling factor $s$ of the reciprocal function, i.e. to compute $s / x$. - * **neg\_vals** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether $x$ might represent negative values. In this case the first qubit is the sign, with $|1\rangle$ for negative and $|0\rangle$ for positive. For the negative case it is assumed that the remaining string represents $1 - x$. This is because $e^{-2 \pi i x} = e^{2 \pi i (1 - x)}$ for $x \in [0,1)$. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The label of the object. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits representing the value to invert. + * **scaling** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Scaling factor $s$ of the reciprocal function, i.e. to compute $s / x$. + * **neg\_vals** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether $x$ might represent negative values. In this case the first qubit is the sign, with $|1\rangle$ for negative and $|0\rangle$ for positive. For the negative case it is assumed that the remaining string represents $1 - x$. This is because $e^{-2 \pi i x} = e^{2 \pi i (1 - x)}$ for $x \in [0,1)$. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The label of the object. It is assumed that the binary string $x$ represents a number \< 1. @@ -152,8 +152,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -165,7 +165,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -177,10 +177,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -198,7 +198,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -222,7 +222,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -248,8 +248,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -267,7 +267,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -315,7 +315,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.mdx index 438cbd3fa4d..eaff1a24658 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.mdx @@ -86,21 +86,21 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits of the ExcitationPreserving circuit. - * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Choose the entangler mode, can be ‘iswap’ or ‘fsim’. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. - * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits of the ExcitationPreserving circuit. + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Choose the entangler mode, can be ‘iswap’ or ‘fsim’. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A QuantumCircuit object to prepend to the circuit. - * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. - * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, a rotation layer is added at the end of the ansatz. If False, no rotation layer is added. Defaults to True. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. - * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. + * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, a rotation layer is added at the end of the ansatz. If False, no rotation layer is added. Defaults to True. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. + * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the selected mode is not supported. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the selected mode is not supported. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/qiskit.circuit.library.FourierChecking.mdx index 1aec0234843..f290d19d955 100644 --- a/docs/api/qiskit/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.FourierChecking.mdx @@ -35,8 +35,8 @@ python_api_name: qiskit.circuit.library.FourierChecking **Parameters** - * **f** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – truth table for f, length 2\*\*n list of \{1,-1}. - * **g** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – truth table for g, length 2\*\*n list of \{1,-1}. + * **f** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – truth table for f, length 2\*\*n list of \{1,-1}. + * **g** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – truth table for g, length 2\*\*n list of \{1,-1}. **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.FullAdderGate.mdx b/docs/api/qiskit/qiskit.circuit.library.FullAdderGate.mdx index c23a34644e5..e48dbc78107 100644 --- a/docs/api/qiskit/qiskit.circuit.library.FullAdderGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.FullAdderGate.mdx @@ -34,9 +34,9 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the registers. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in each of the registers. * **name** – The name of the circuit. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – ## Attributes @@ -166,8 +166,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -179,7 +179,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -191,10 +191,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -212,7 +212,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -236,7 +236,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -262,8 +262,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -281,7 +281,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -329,7 +329,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.mdx index 1efcb9577df..e71c139047b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -9,15 +9,15 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations # FunctionalPauliRotations - Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Base class for functional Pauli rotations. **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits representing the state $|x\rangle$. - * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The kind of Pauli rotation to use. Must be ‘X’, ‘Y’ or ‘Z’. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit object. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits representing the state $|x\rangle$. + * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The kind of Pauli rotation to use. Must be ‘X’, ‘Y’ or ‘Z’. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit object. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/qiskit.circuit.library.GMS.mdx index 3f0f7265b71..1dfaf37e407 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.GMS.mdx @@ -50,8 +50,8 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – width of gate. - * **theta** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]] | np.ndarray*) – a num\_qubits x num\_qubits symmetric matrix of interaction angles for each qubit pair. The upper triangle is considered. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – width of gate. + * **theta** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]] | np.ndarray*) – a num\_qubits x num\_qubits symmetric matrix of interaction angles for each qubit pair. The upper triangle is considered. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/qiskit.circuit.library.GR.mdx index 7eadc99551a..0bb7ce12bea 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.GR.mdx @@ -39,9 +39,9 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubits. - * **theta** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – rotation angle about axis determined by phi - * **phi** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – angle of rotation axis in xy-plane + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubits. + * **theta** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – rotation angle about axis determined by phi + * **phi** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – angle of rotation axis in xy-plane ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/qiskit.circuit.library.GRX.mdx index 18dd9d3a5ad..eea42e19a92 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.GRX.mdx @@ -41,8 +41,8 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubits. - * **theta** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – rotation angle about x-axis + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubits. + * **theta** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – rotation angle about x-axis ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/qiskit.circuit.library.GRY.mdx index 7e19098aeda..91be8b8961b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.GRY.mdx @@ -41,8 +41,8 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubits. - * **theta** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – rotation angle about y-axis + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubits. + * **theta** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – rotation angle about y-axis ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/qiskit.circuit.library.GRZ.mdx index 01a1c0d064f..e025b7d189f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.GRZ.mdx @@ -41,8 +41,8 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubits. - * **phi** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – rotation angle about z-axis + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubits. + * **phi** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – rotation angle about z-axis ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.mdx b/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.mdx index 73b1cb5ba80..f2533def6a3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.mdx @@ -28,8 +28,8 @@ $$ **Parameters** - * **phase** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The value of phase it takes. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate. + * **phase** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The value of phase it takes. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate. ## Attributes @@ -149,8 +149,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -162,7 +162,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -174,10 +174,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -195,7 +195,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -215,7 +215,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse is always another [`GlobalPhaseGate`](#qiskit.circuit.library.GlobalPhaseGate "qiskit.circuit.library.GlobalPhaseGate") with an inverted parameter value. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse is always another [`GlobalPhaseGate`](#qiskit.circuit.library.GlobalPhaseGate "qiskit.circuit.library.GlobalPhaseGate") with an inverted parameter value. **Returns** @@ -241,8 +241,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -260,7 +260,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -308,7 +308,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/qiskit.circuit.library.GraphState.mdx index 3bc32a62e5e..c52ab221d59 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.GraphState.mdx @@ -45,7 +45,7 @@ $$ **Parameters** - **adjacency\_matrix** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| np.ndarray*) – input graph as n-by-n list of 0-1 lists + **adjacency\_matrix** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *| np.ndarray*) – input graph as n-by-n list of 0-1 lists **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.GraphStateGate.mdx b/docs/api/qiskit/qiskit.circuit.library.GraphStateGate.mdx index 4abd35574c4..0fde19963c3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GraphStateGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.GraphStateGate.mdx @@ -46,7 +46,7 @@ $$ **Parameters** - **adjacency\_matrix** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| np.ndarray*) – input graph as n-by-n list of 0-1 lists + **adjacency\_matrix** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *| np.ndarray*) – input graph as n-by-n list of 0-1 lists **Raises** @@ -178,8 +178,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -191,7 +191,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -203,10 +203,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -224,7 +224,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -248,7 +248,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -274,8 +274,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -293,7 +293,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -341,7 +341,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/qiskit.circuit.library.GroverOperator.mdx index cf38452d955..8a3eef68c24 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.GroverOperator.mdx @@ -157,10 +157,10 @@ $$ * **oracle** (*Union\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")*]*) – The phase oracle implementing a reflection about the bad state. Note that this is not a bitflip oracle, see the docstring for more information. * **state\_preparation** (*Optional\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – The operator preparing the good and bad state. For Grover’s algorithm, this is a n-qubit Hadamard gate and for amplitude amplification or estimation the operator $\mathcal{A}$. * **zero\_reflection** (*Optional\[Union\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")*,* [*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")*]]*) – The reflection about the zero state, $\mathcal{S}_0$. - * **reflection\_qubits** (*Optional\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – Qubits on which the zero reflection acts on. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether barriers should be inserted between the reflections and A. - * **mcx\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The mode to use for building the default zero reflection. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. + * **reflection\_qubits** (*Optional\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – Qubits on which the zero reflection acts on. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether barriers should be inserted between the reflections and A. + * **mcx\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The mode to use for building the default zero reflection. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.HGate.mdx b/docs/api/qiskit/qiskit.circuit.library.HGate.mdx index f914d2f09f4..c07f56bc102 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.HGate.mdx @@ -157,8 +157,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -170,7 +170,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -182,10 +182,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. **Returns** @@ -203,7 +203,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -221,7 +221,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -247,8 +247,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -266,7 +266,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -314,7 +314,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index 64b79a2bf38..04f58196dd5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -56,14 +56,14 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. - * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of result qubits to limit the output to. If number of result qubits is $n$, multiplication modulo $2^n$ is performed to limit the output to the specified number of qubits. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. + * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of result qubits to limit the output to. If number of result qubits is $n$, multiplication modulo $2^n$ is performed to limit the output to the specified number of qubits. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. * **adder** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") *| None*) – Half adder circuit to be used for performing multiplication. The CDKMRippleCarryAdder is used as default if no adder is provided. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit object. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit object. **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – If `num_result_qubits` is not default and a custom adder is provided. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – If `num_result_qubits` is not default and a custom adder is provided. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate.mdx b/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate.mdx index 0811fb8ce98..4b41f3f18c3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate.mdx @@ -33,9 +33,9 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the registers. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in each of the registers. * **name** – The name of the circuit. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – ## Attributes @@ -165,8 +165,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -178,7 +178,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -190,10 +190,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -211,7 +211,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -235,7 +235,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -261,8 +261,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -280,7 +280,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -328,7 +328,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.mdx b/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.mdx index 7eb087a9618..3bb149e8aff 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.mdx @@ -18,12 +18,12 @@ python_api_name: qiskit.circuit.library.HamiltonianGate **Parameters** * **data** (*np.ndarray |* [*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| BaseOperator*) – A hermitian operator. - * **time** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – Time evolution parameter. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Unitary name for backend \[Default: `None`]. + * **time** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – Time evolution parameter. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Unitary name for backend \[Default: `None`]. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if input data is not an N-qubit unitary operator. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if input data is not an N-qubit unitary operator. ## Attributes @@ -149,8 +149,8 @@ python_api_name: qiskit.circuit.library.HamiltonianGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -162,7 +162,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### conjugate @@ -180,10 +180,10 @@ python_api_name: qiskit.circuit.library.HamiltonianGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -201,7 +201,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -219,7 +219,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### is\_parameterized @@ -237,8 +237,8 @@ python_api_name: qiskit.circuit.library.HamiltonianGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -256,7 +256,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -304,7 +304,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.mdx index f620538efea..de2fa311497 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -49,7 +49,7 @@ $$ **Parameters** - **adjacency\_matrix** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| np.ndarray*) – a symmetric n-by-n list of 0-1 lists. n will be the number of qubits. + **adjacency\_matrix** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *| np.ndarray*) – a symmetric n-by-n list of 0-1 lists. n will be the number of qubits. **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.IGate.mdx b/docs/api/qiskit/qiskit.circuit.library.IGate.mdx index cc0dcd6c6f3..3acbd334d94 100644 --- a/docs/api/qiskit/qiskit.circuit.library.IGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.IGate.mdx @@ -156,8 +156,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -169,7 +169,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -181,10 +181,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -202,7 +202,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -220,7 +220,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -248,8 +248,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -267,7 +267,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -315,7 +315,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/qiskit.circuit.library.IQP.mdx index 950a881345d..8e5f1b24380 100644 --- a/docs/api/qiskit/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.IQP.mdx @@ -37,7 +37,7 @@ python_api_name: qiskit.circuit.library.IQP **Parameters** - **interactions** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| np.ndarray*) – input n-by-n symmetric matrix. + **interactions** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *| np.ndarray*) – input n-by-n symmetric matrix. **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.Initialize.mdx b/docs/api/qiskit/qiskit.circuit.library.Initialize.mdx index dddd7efe0ea..a173103ba42 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Initialize.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.Initialize.mdx @@ -23,7 +23,7 @@ python_api_name: qiskit.circuit.library.Initialize **Parameters** - * **params** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *| Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")*] |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **params** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *| Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")*] |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The state to initialize to, can be either of the following. @@ -31,9 +31,9 @@ python_api_name: qiskit.circuit.library.Initialize * Labels of basis states of the Pauli eigenstates Z, X, Y. See [`Statevector.from_label()`](qiskit.quantum_info.Statevector#from_label "qiskit.quantum_info.Statevector.from_label"). Notice the order of the labels is reversed with respect to the qubit index to be applied to. Example label ‘01’ initializes the qubit zero to $|1\rangle$ and the qubit one to $|0\rangle$. * An integer that is used as a bitmap indicating which qubits to initialize to $|1\rangle$. Example: setting params to 5 would initialize qubit 0 and qubit 2 to $|1\rangle$ and qubit 1 to $|0\rangle$. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – This parameter is only used if params is an int. Indicates the total number of qubits in the initialize call. Example: initialize covers 5 qubits and params is 3. This allows qubits 0 and 1 to be initialized to $|1\rangle$ and the remaining 3 qubits to be initialized to $|0\rangle$. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – This parameter is only used if params is an int. Indicates the total number of qubits in the initialize call. Example: initialize covers 5 qubits and params is 3. This allows qubits 0 and 1 to be initialized to $|1\rangle$ and the remaining 3 qubits to be initialized to $|0\rangle$. - * **normalize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to normalize an input array to a unit vector. + * **normalize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to normalize an input array to a unit vector. ## Attributes @@ -142,7 +142,7 @@ python_api_name: qiskit.circuit.library.Initialize **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -180,7 +180,7 @@ python_api_name: qiskit.circuit.library.Initialize **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -204,7 +204,7 @@ python_api_name: qiskit.circuit.library.Initialize **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.Initialize **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_mutable @@ -266,7 +266,7 @@ python_api_name: qiskit.circuit.library.Initialize ### validate\_parameter - Instruction parameters has no validation or normalization. + Instruction parameter has no validation or normalization. diff --git a/docs/api/qiskit/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/qiskit.circuit.library.InnerProduct.mdx index 60e729cd43f..08b3e88f17d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.InnerProduct.mdx @@ -50,7 +50,7 @@ $$ **Parameters** - **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – width of top and bottom registers (half total circuit width) + **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – width of top and bottom registers (half total circuit width) ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.InnerProductGate.mdx b/docs/api/qiskit/qiskit.circuit.library.InnerProductGate.mdx index 4324b925935..2f1ab66bd82 100644 --- a/docs/api/qiskit/qiskit.circuit.library.InnerProductGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.InnerProductGate.mdx @@ -46,7 +46,7 @@ $$ **Parameters** - **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – width of top and bottom registers (half total number of qubits). + **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – width of top and bottom registers (half total number of qubits). ## Attributes @@ -166,8 +166,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -179,7 +179,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -191,10 +191,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -212,7 +212,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -236,7 +236,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -262,8 +262,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -281,7 +281,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -329,7 +329,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.mdx index 1e7b6f4cc2e..a68c1bfb10b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.mdx @@ -23,10 +23,10 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – Number of state qubits. If this is set it will determine the number of qubits required for the circuit. - * **value** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The fixed value to compare with. - * **geq** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, evaluate a `>=` condition, else `<`. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the circuit. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – Number of state qubits. If this is set it will determine the number of qubits required for the circuit. + * **value** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The fixed value to compare with. + * **geq** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, evaluate a `>=` condition, else `<`. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Name of the circuit. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.IntegerComparatorGate.mdx b/docs/api/qiskit/qiskit.circuit.library.IntegerComparatorGate.mdx index eb6ce37012b..ad83bd2bb91 100644 --- a/docs/api/qiskit/qiskit.circuit.library.IntegerComparatorGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.IntegerComparatorGate.mdx @@ -21,10 +21,10 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in the registers. - * **value** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The value $L$ to compre to. - * **geq** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` compute $i \geq L$, otherwise compute $i < L$. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in the registers. + * **value** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The value $L$ to compre to. + * **geq** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` compute $i \geq L$, otherwise compute $i < L$. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate. ## Attributes @@ -144,8 +144,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -157,7 +157,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -169,10 +169,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -190,7 +190,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -214,7 +214,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -240,8 +240,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -259,7 +259,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -307,7 +307,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.Isometry.mdx b/docs/api/qiskit/qiskit.circuit.library.Isometry.mdx index 03a32f8cc48..e6773429c8d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Isometry.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.Isometry.mdx @@ -24,9 +24,9 @@ python_api_name: qiskit.circuit.library.Isometry **Parameters** * **isometry** (*np.ndarray*) – An isometry from $m$ to :math\`n\` qubits, i.e., a complex `np.ndarray` of dimension $2^n \times 2^m$ with orthonormal columns (given in the computational basis specified by the order of the ancillas and the input qubits, where the ancillas are considered to be more significant than the input qubits). - * **num\_ancillas\_zero** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of additional ancillas that start in the state $|0\rangle$ (the $n-m$ ancillas required for providing the output of the isometry are not accounted for here). - * **num\_ancillas\_dirty** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of additional ancillas that start in an arbitrary state. - * **epsilon** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Error tolerance of calculations. + * **num\_ancillas\_zero** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of additional ancillas that start in the state $|0\rangle$ (the $n-m$ ancillas required for providing the output of the isometry are not accounted for here). + * **num\_ancillas\_dirty** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of additional ancillas that start in an arbitrary state. + * **epsilon** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Error tolerance of calculations. ## Attributes @@ -135,7 +135,7 @@ python_api_name: qiskit.circuit.library.Isometry **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -165,7 +165,7 @@ python_api_name: qiskit.circuit.library.Isometry **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -189,7 +189,7 @@ python_api_name: qiskit.circuit.library.Isometry **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -237,7 +237,7 @@ python_api_name: qiskit.circuit.library.Isometry **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_mutable diff --git a/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 353e35a3aa7..00d83cbd597 100644 --- a/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -56,14 +56,14 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits used to encode the variable $x$. - * **slope** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – The slope of the linear function. Can be a list of slopes if it is a piecewise linear function. - * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – The offset of the linear function. Can be a list of offsets if it is a piecewise linear function. - * **domain** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – The domain of the function as tuple $(x_\min{}, x_\max{})$. - * **image** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – The image of the function as tuple $(f_\min{}, f_\max{})$. - * **rescaling\_factor** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The rescaling factor to adjust the accuracy in the Taylor approximation. - * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – The breakpoints if the function is piecewise linear. If None, the function is not piecewise. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the circuit. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits used to encode the variable $x$. + * **slope** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – The slope of the linear function. Can be a list of slopes if it is a piecewise linear function. + * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – The offset of the linear function. Can be a list of offsets if it is a piecewise linear function. + * **domain** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – The domain of the function as tuple $(x_\min{}, x_\max{})$. + * **image** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – The image of the function as tuple $(f_\min{}, f_\max{})$. + * **rescaling\_factor** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The rescaling factor to adjust the accuracy in the Taylor approximation. + * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | None*) – The breakpoints if the function is piecewise linear. If None, the function is not piecewise. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Name of the circuit. ## Attributes @@ -95,7 +95,7 @@ $$ **Parameters** - **scaled\_value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – A function value from the Taylor expansion of $\hat{f}(x)$. + **scaled\_value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – A function value from the Taylor expansion of $\hat{f}(x)$. **Returns** @@ -103,7 +103,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunctionGate.mdx b/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunctionGate.mdx index 519d08ab57f..4a61fac0867 100644 --- a/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunctionGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunctionGate.mdx @@ -52,14 +52,14 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits used to encode the variable $x$. - * **slope** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – The slope of the linear function. Can be a list of slopes if it is a piecewise linear function. - * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – The offset of the linear function. Can be a list of offsets if it is a piecewise linear function. - * **domain** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – The domain of the function as tuple $(x_\min{}, x_\max{})$. - * **image** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – The image of the function as tuple $(f_\min{}, f_\max{})$. - * **rescaling\_factor** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The rescaling factor to adjust the accuracy in the Taylor approximation. - * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – The breakpoints if the function is piecewise linear. If None, the function is not piecewise. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A label for the gate. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits used to encode the variable $x$. + * **slope** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – The slope of the linear function. Can be a list of slopes if it is a piecewise linear function. + * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – The offset of the linear function. Can be a list of offsets if it is a piecewise linear function. + * **domain** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – The domain of the function as tuple $(x_\min{}, x_\max{})$. + * **image** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – The image of the function as tuple $(f_\min{}, f_\max{})$. + * **rescaling\_factor** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The rescaling factor to adjust the accuracy in the Taylor approximation. + * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | None*) – The breakpoints if the function is piecewise linear. If None, the function is not piecewise. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – A label for the gate. ## Attributes @@ -179,8 +179,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -192,7 +192,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -204,10 +204,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -225,7 +225,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -249,7 +249,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -273,7 +273,7 @@ $$ **Parameters** - **scaled\_value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – A function value from the Taylor expansion of $\hat{f}(x)$. + **scaled\_value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – A function value from the Taylor expansion of $\hat{f}(x)$. **Returns** @@ -281,7 +281,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") ### power @@ -293,8 +293,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -312,7 +312,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -360,7 +360,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.LinearFunction.mdx b/docs/api/qiskit/qiskit.circuit.library.LinearFunction.mdx index 91fb60da560..87525252106 100644 --- a/docs/api/qiskit/qiskit.circuit.library.LinearFunction.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.LinearFunction.mdx @@ -47,8 +47,8 @@ $$ **Parameters** - * **linear** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]] | np.ndarray\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*] |* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*LinearFunction*](#qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction") *|*[*PermutationGate*](qiskit.circuit.library.PermutationGate "qiskit.circuit.library.PermutationGate") *|*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – data from which a linear function can be constructed. It can be either a nxn matrix (describing the linear transformation), a permutation (which is a special case of a linear function), another linear function, a clifford (when it corresponds to a linear function), or a quantum circuit composed of linear gates (CX and SWAP) and other objects described above, including nested subcircuits. - * **validate\_input** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, performs more expensive input validation checks, such as checking that a given n x n matrix is invertible. + * **linear** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*]] | np.ndarray\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*] |* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*LinearFunction*](#qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction") *|*[*PermutationGate*](qiskit.circuit.library.PermutationGate "qiskit.circuit.library.PermutationGate") *|*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – data from which a linear function can be constructed. It can be either a nxn matrix (describing the linear transformation), a permutation (which is a special case of a linear function), another linear function, a clifford (when it corresponds to a linear function), or a quantum circuit composed of linear gates (CX and SWAP) and other objects described above, including nested subcircuits. + * **validate\_input** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, performs more expensive input validation checks, such as checking that a given n x n matrix is invertible. **Raises** @@ -184,8 +184,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -197,7 +197,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -209,10 +209,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -230,7 +230,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -248,8 +248,8 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubits of the extended function. - * **positions** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – describes the positions of original qubits in the extended function’s qubits. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubits of the extended function. + * **positions** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – describes the positions of original qubits in the extended function’s qubits. **Returns** @@ -279,7 +279,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -303,7 +303,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### mat\_str @@ -327,8 +327,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -346,7 +346,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -394,7 +394,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### synthesize diff --git a/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.mdx index b3dc164a7d2..9baf89ddb9f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.mdx @@ -36,11 +36,11 @@ $$ **Parameters** - * **num\_state\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The number of qubits representing the state $|x\rangle$. - * **slope** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The slope of the controlled rotation. - * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The offset of the controlled rotation. - * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The type of Pauli rotation (‘X’, ‘Y’, ‘Z’). - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit object. + * **num\_state\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The number of qubits representing the state $|x\rangle$. + * **slope** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The slope of the controlled rotation. + * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The offset of the controlled rotation. + * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The type of Pauli rotation (‘X’, ‘Y’, ‘Z’). + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit object. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotationsGate.mdx b/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotationsGate.mdx index 5b9bf9bce84..a582fc47549 100644 --- a/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotationsGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotationsGate.mdx @@ -36,11 +36,11 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits representing the state $|x\rangle$. - * **slope** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The slope of the controlled rotation. - * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The offset of the controlled rotation. - * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The type of Pauli rotation (‘X’, ‘Y’, ‘Z’). - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The label of the gate. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits representing the state $|x\rangle$. + * **slope** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The slope of the controlled rotation. + * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The offset of the controlled rotation. + * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The type of Pauli rotation (‘X’, ‘Y’, ‘Z’). + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The label of the gate. ## Attributes @@ -160,8 +160,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -173,7 +173,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -185,10 +185,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -206,7 +206,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -230,7 +230,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -256,8 +256,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -275,7 +275,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -323,7 +323,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/qiskit.circuit.library.MCMT.mdx index af2840ee319..be5b73db18d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCMT.mdx @@ -39,13 +39,13 @@ python_api_name: qiskit.circuit.library.MCMT **Parameters** * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*],* [*circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]*) – The gate to be applied controlled on the control qubits and applied to the target qubits. Can be either a Gate or a circuit method. If it is a callable, it will be casted to a Gate. - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. - * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of target qubits. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. + * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of target qubits. **Raises** - * [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If the gate cannot be casted to a controlled gate. - * [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If the number of controls or targets is 0. + * [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – If the gate cannot be casted to a controlled gate. + * [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – If the number of controls or targets is 0. ## Attributes @@ -89,7 +89,7 @@ python_api_name: qiskit.circuit.library.MCMT **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – diff --git a/docs/api/qiskit/qiskit.circuit.library.MCMTGate.mdx b/docs/api/qiskit/qiskit.circuit.library.MCMTGate.mdx index d483c53a13e..fbc8cae1112 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCMTGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCMTGate.mdx @@ -33,10 +33,10 @@ python_api_name: qiskit.circuit.library.MCMTGate **Parameters** * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – The base gate to apply on multiple target qubits, controlled by other qubits. This must be a single-qubit gate or a controlled single-qubit gate. - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. - * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of target qubits. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The control state of the control qubits. Defaults to all closed controls. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The gate label. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. + * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of target qubits. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The control state of the control qubits. Defaults to all closed controls. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The gate label. ## Attributes @@ -120,7 +120,7 @@ python_api_name: qiskit.circuit.library.MCMTGate **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -140,7 +140,7 @@ python_api_name: qiskit.circuit.library.MCMTGate **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -192,8 +192,8 @@ python_api_name: qiskit.circuit.library.MCMTGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -205,7 +205,7 @@ python_api_name: qiskit.circuit.library.MCMTGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -221,7 +221,7 @@ python_api_name: qiskit.circuit.library.MCMTGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -239,7 +239,7 @@ python_api_name: qiskit.circuit.library.MCMTGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### is\_parameterized @@ -257,8 +257,8 @@ python_api_name: qiskit.circuit.library.MCMTGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -276,7 +276,7 @@ python_api_name: qiskit.circuit.library.MCMTGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -324,7 +324,7 @@ python_api_name: qiskit.circuit.library.MCMTGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.mdx index 981120d402b..e195110b692 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.mdx @@ -63,8 +63,8 @@ python_api_name: qiskit.circuit.library.MCMTVChain **Parameters** * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*],* [*circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]*) – - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – ### num\_ancilla\_qubits @@ -100,7 +100,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – diff --git a/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.mdx index f207a4d22c2..9a7b9c970b8 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate # MCPhaseGate - + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") Multi-controlled-Phase gate. @@ -41,9 +41,9 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Parameters** * **lam** (*ParameterValueType*) – - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – ### base\_class @@ -125,7 +125,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -145,7 +145,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -197,8 +197,8 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -210,7 +210,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -220,10 +220,10 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. **Returns** @@ -241,7 +241,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -254,12 +254,12 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ### inverse - + Return inverted MCPhase gate ($MCPhase(\lambda)^{\dagger} = MCPhase(-\lambda)$) **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### is\_parameterized @@ -277,8 +277,8 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -296,7 +296,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -344,7 +344,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx index ef2829cc3c7..d726edf6366 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx @@ -21,9 +21,9 @@ python_api_name: qiskit.circuit.library.MCXGate **Parameters** - * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – - * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – ### base\_class @@ -111,7 +111,7 @@ python_api_name: qiskit.circuit.library.MCXGate **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### num\_qubits @@ -131,7 +131,7 @@ python_api_name: qiskit.circuit.library.MCXGate **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -183,8 +183,8 @@ python_api_name: qiskit.circuit.library.MCXGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -196,7 +196,7 @@ python_api_name: qiskit.circuit.library.MCXGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -206,10 +206,10 @@ python_api_name: qiskit.circuit.library.MCXGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled multi-controlled X gate is another multi-controlled X-gate. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled multi-controlled X gate is another multi-controlled X-gate. **Returns** @@ -227,7 +227,7 @@ python_api_name: qiskit.circuit.library.MCXGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -251,12 +251,12 @@ python_api_name: qiskit.circuit.library.MCXGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### inverse @@ -266,7 +266,7 @@ python_api_name: qiskit.circuit.library.MCXGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -292,8 +292,8 @@ python_api_name: qiskit.circuit.library.MCXGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -311,7 +311,7 @@ python_api_name: qiskit.circuit.library.MCXGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -359,7 +359,7 @@ python_api_name: qiskit.circuit.library.MCXGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx index 4d354bff729..0bbedbc748d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx @@ -21,9 +21,9 @@ python_api_name: qiskit.circuit.library.MCXGrayCode **Parameters** - * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – - * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – ### inverse @@ -32,7 +32,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx index 193e16b863b..dd581781826 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx @@ -28,9 +28,9 @@ python_api_name: qiskit.circuit.library.MCXRecursive **Parameters** - * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – - * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – ### get\_num\_ancilla\_qubits @@ -39,8 +39,8 @@ python_api_name: qiskit.circuit.library.MCXRecursive **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – ### inverse @@ -50,7 +50,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx index 1fa6d5bca7c..0562ff2c528 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx @@ -15,12 +15,12 @@ python_api_name: qiskit.circuit.library.MCXVChain **Parameters** - * **dirty\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, the method applies an optimized multicontrolled-X gate up to a relative phase using dirty ancillary qubits with the properties of lemmas 7 and 8 from arXiv:1501.06911, with at most 8\*k - 6 CNOT gates. For k within the range \{1, …, ceil(n/2)}. And for n representing the total number of qubits. - * **relative\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, the method applies the optimized multicontrolled-X gate up to a relative phase, in a way that, by lemma 7 of arXiv:1501.06911, the relative phases of the `action part` cancel out with the phases of the `reset part`. - * **action\_only** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, the method applies only the action part of lemma 8 from arXiv:1501.06911. - * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – - * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + * **dirty\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, the method applies an optimized multicontrolled-X gate up to a relative phase using dirty ancillary qubits with the properties of lemmas 7 and 8 from arXiv:1501.06911, with at most 8\*k - 6 CNOT gates. For k within the range \{1, …, ceil(n/2)}. And for n representing the total number of qubits. + * **relative\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, the method applies the optimized multicontrolled-X gate up to a relative phase, in a way that, by lemma 7 of arXiv:1501.06911, the relative phases of the `action part` cancel out with the phases of the `reset part`. + * **action\_only** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, the method applies only the action part of lemma 8 from arXiv:1501.06911. + * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – ## Methods @@ -31,8 +31,8 @@ python_api_name: qiskit.circuit.library.MCXVChain **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – ### inverse @@ -42,7 +42,7 @@ python_api_name: qiskit.circuit.library.MCXVChain **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.library.MSGate.mdx b/docs/api/qiskit/qiskit.circuit.library.MSGate.mdx index 5c0e8532b9d..c6e71b5f014 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MSGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MSGate.mdx @@ -43,9 +43,9 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits the MS gate acts on. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits the MS gate acts on. * **theta** (*ParameterValueType | Sequence\[Sequence\[ParameterValueType]]*) – The XX rotation angles. If a single value, the same angle is used on all interactions. Alternatively an upper-triangular, square matrix with width `num_qubits` can be provided with interaction angles for each qubit pair. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – A gate label. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – A gate label. ## Attributes @@ -165,8 +165,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -178,7 +178,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -190,10 +190,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -211,7 +211,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -235,7 +235,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -261,8 +261,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -280,7 +280,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -328,7 +328,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate.mdx b/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate.mdx index 22a4bfa2174..b993c86dbc9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate.mdx @@ -33,9 +33,9 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the registers. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in each of the registers. * **name** – The name of the circuit. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – ## Attributes @@ -165,8 +165,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -178,7 +178,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -190,10 +190,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -211,7 +211,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -235,7 +235,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -261,8 +261,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -280,7 +280,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -328,7 +328,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.MultiplierGate.mdx b/docs/api/qiskit/qiskit.circuit.library.MultiplierGate.mdx index b29c4cc0568..43fb25d3af1 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MultiplierGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MultiplierGate.mdx @@ -35,16 +35,16 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the input registers. - * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of result qubits to limit the output to. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in each of the input registers. + * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of result qubits to limit the output to. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. * **name** – The name of the circuit. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_state_qubits` is smaller than 1. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_result_qubits` is smaller than `num_state_qubits`. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_result_qubits` is larger than `2 * num_state_qubits`. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_state_qubits` is smaller than 1. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_result_qubits` is smaller than `num_state_qubits`. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_result_qubits` is larger than `2 * num_state_qubits`. ## Attributes @@ -184,8 +184,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -197,7 +197,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -209,10 +209,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -230,7 +230,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -254,7 +254,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -280,8 +280,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -299,7 +299,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -347,7 +347,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/qiskit.circuit.library.NLocal.mdx index d849adf360e..a48502786f5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.NLocal.mdx @@ -49,24 +49,24 @@ python_api_name: qiskit.circuit.library.NLocal **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits of the circuit. - * **rotation\_blocks** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] |* [*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*] | None*) – The blocks used in the rotation layers. If multiple are passed, these will be applied one after another (like new sub-layers). - * **entanglement\_blocks** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] |* [*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*] | None*) – The blocks used in the entanglement layers. If multiple are passed, these will be applied one after another. To use different entanglements for the sub-layers, see [`get_entangler_map()`](#qiskit.circuit.library.NLocal.get_entangler_map "qiskit.circuit.library.NLocal.get_entangler_map"). - * **entanglement** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | None*) – The indices specifying on which qubits the input blocks act. If `None`, the entanglement blocks are applied at the top of the circuit. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often the rotation blocks and entanglement blocks are repeated. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used if default parameters are generated. - * **overwrite\_block\_parameters** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*]]*) – If the parameters in the added blocks should be overwritten. If `False`, the parameters in the blocks are not changed. - * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether a final rotation layer is added to the circuit. - * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits of the circuit. + * **rotation\_blocks** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] |* [*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*] | None*) – The blocks used in the rotation layers. If multiple are passed, these will be applied one after another (like new sub-layers). + * **entanglement\_blocks** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] |* [*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*] | None*) – The blocks used in the entanglement layers. If multiple are passed, these will be applied one after another. To use different entanglements for the sub-layers, see [`get_entangler_map()`](#qiskit.circuit.library.NLocal.get_entangler_map "qiskit.circuit.library.NLocal.get_entangler_map"). + * **entanglement** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]] | None*) – The indices specifying on which qubits the input blocks act. If `None`, the entanglement blocks are applied at the top of the circuit. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Specifies how often the rotation blocks and entanglement blocks are repeated. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The prefix used if default parameters are generated. + * **overwrite\_block\_parameters** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*]]*) – If the parameters in the added blocks should be overwritten. If `False`, the parameters in the blocks are not changed. + * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether a final rotation layer is added to the circuit. + * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object which can be used to describe an initial state prepended to the NLocal circuit. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The name of the circuit. - * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The name of the circuit. + * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `reps` parameter is less than or equal to 0. - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If `reps` parameter is not an int value. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `reps` parameter is less than or equal to 0. + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If `reps` parameter is not an int value. ## Attributes @@ -247,8 +247,8 @@ python_api_name: qiskit.circuit.library.NLocal **Parameters** * **other** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – The layer to compose, can be another NLocal, an Instruction or Gate, or a QuantumCircuit. - * **entanglement** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | None*) – The entanglement or qubit indices. - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, `other` is appended to the front, else to the back. + * **entanglement** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]] | None*) – The entanglement or qubit indices. + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, `other` is appended to the front, else to the back. **Returns** @@ -256,7 +256,7 @@ python_api_name: qiskit.circuit.library.NLocal **Raises** - [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If other is not compatible, i.e. is no Instruction and does not have a to\_instruction method. + [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If other is not compatible, i.e. is no Instruction and does not have a to\_instruction method. **Return type** @@ -276,12 +276,12 @@ python_api_name: qiskit.circuit.library.NLocal **Raises** - [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If the parameters are given as list and do not match the number of parameters. + [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – If the parameters are given as list and do not match the number of parameters. **Parameters** - * **parameters** (*Mapping\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | Sequence\[*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **parameters** (*Mapping\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | Sequence\[*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – **Return type** @@ -312,9 +312,9 @@ python_api_name: qiskit.circuit.library.NLocal **Parameters** - * **rep\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The current repetition we are in. - * **block\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The block number within the entanglement layers. - * **num\_block\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in the block. + * **rep\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The current repetition we are in. + * **block\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The block number within the entanglement layers. + * **num\_block\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in the block. **Returns** @@ -322,11 +322,11 @@ python_api_name: qiskit.circuit.library.NLocal **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the value of `entanglement` could not be cast to a corresponding entangler map. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the value of `entanglement` could not be cast to a corresponding entangler map. **Return type** - [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")]] + [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")\[[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")]] ### get\_unentangled\_qubits @@ -340,7 +340,7 @@ python_api_name: qiskit.circuit.library.NLocal **Return type** - [set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] + [set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")] ### print\_settings @@ -354,7 +354,7 @@ python_api_name: qiskit.circuit.library.NLocal **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/qiskit.circuit.library.OR.mdx index f765a0ed0e2..e141c8b654b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.OR.mdx @@ -29,9 +29,9 @@ python_api_name: qiskit.circuit.library.OR **Parameters** - * **num\_variable\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The qubits of which the OR is computed. The result will be written into an additional result qubit. - * **flags** (*Optional\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – A list of +1/0/-1 marking negations or omissions of qubits. - * **mcx\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The mode to be used to implement the multi-controlled X gate. + * **num\_variable\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The qubits of which the OR is computed. The result will be written into an additional result qubit. + * **flags** (*Optional\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – A list of +1/0/-1 marking negations or omissions of qubits. + * **mcx\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The mode to be used to implement the multi-controlled X gate. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.OrGate.mdx b/docs/api/qiskit/qiskit.circuit.library.OrGate.mdx index ff6999e277a..e37b01f90ea 100644 --- a/docs/api/qiskit/qiskit.circuit.library.OrGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.OrGate.mdx @@ -25,8 +25,8 @@ python_api_name: qiskit.circuit.library.OrGate **Parameters** - * **num\_variable\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The qubits of which the OR is computed. The result will be written into an additional result qubit. - * **flags** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – A list of +1/0/-1 marking negations or omissions of qubits. + * **num\_variable\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The qubits of which the OR is computed. The result will be written into an additional result qubit. + * **flags** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – A list of +1/0/-1 marking negations or omissions of qubits. ## Attributes @@ -146,8 +146,8 @@ python_api_name: qiskit.circuit.library.OrGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -159,7 +159,7 @@ python_api_name: qiskit.circuit.library.OrGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -171,10 +171,10 @@ python_api_name: qiskit.circuit.library.OrGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -192,7 +192,7 @@ python_api_name: qiskit.circuit.library.OrGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -210,7 +210,7 @@ python_api_name: qiskit.circuit.library.OrGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -236,8 +236,8 @@ python_api_name: qiskit.circuit.library.OrGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -255,7 +255,7 @@ python_api_name: qiskit.circuit.library.OrGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -303,7 +303,7 @@ python_api_name: qiskit.circuit.library.OrGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.mdx index 1c4f3a41cfe..75956955243 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -68,9 +68,9 @@ $$ **Parameters** - * **operator** ([*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *|*[*SparseObservable*](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *|*[*SparseObservable*](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")*]*) – The operator to evolve. Can also be provided as list of non-commuting operators where the elements are sums of commuting operators. For example: `[XY + YX, ZZ + ZI + IZ, YY]`. + * **operator** ([*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *|*[*SparseObservable*](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *|*[*SparseObservable*](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")*]*) – The operator to evolve. Can also be provided as list of non-commuting operators where the elements are sums of commuting operators. For example: `[XY + YX, ZZ + ZI + IZ, YY]`. * **time** (*ParameterValueType*) – The evolution time. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – A label for the gate to display in visualizations. Per default, the label is set to `exp(-it )` where `` is the sum of the Paulis. Note that the label does not include any coefficients of the Paulis. See the class docstring for an example. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – A label for the gate to display in visualizations. Per default, the label is set to `exp(-it )` where `` is the sum of the Paulis. Note that the label does not include any coefficients of the Paulis. See the class docstring for an example. * **synthesis** ([*EvolutionSynthesis*](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.EvolutionSynthesis") *| None*) – A synthesis strategy. If None, the default synthesis is the Lie-Trotter product formula with a single repetition. ## Attributes @@ -201,8 +201,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -214,7 +214,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -226,10 +226,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of controls to add to gate (default: `1`). - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The control state in decimal or as a bitstring (e.g. `"111"`). If `None`, use `2**num_ctrl_qubits - 1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Not applicable to this class. Usually, when this is `True` we return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, we can efficiently represent controlled Pauli evolutions as [`PauliEvolutionGate`](#qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate"), which is used here. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of controls to add to gate (default: `1`). + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The control state in decimal or as a bitstring (e.g. `"111"`). If `None`, use `2**num_ctrl_qubits - 1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – Not applicable to this class. Usually, when this is `True` we return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, we can efficiently represent controlled Pauli evolutions as [`PauliEvolutionGate`](#qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate"), which is used here. **Returns** @@ -247,7 +247,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -265,7 +265,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### is\_parameterized @@ -283,8 +283,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The power to raise the gate to. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Not applicable to this class. Usually, when this is `True` we return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a power modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, we can efficiently represent powers of Pauli evolutions as [`PauliEvolutionGate`](#qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate"), which is used here. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The power to raise the gate to. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Not applicable to this class. Usually, when this is `True` we return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a power modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, we can efficiently represent powers of Pauli evolutions as [`PauliEvolutionGate`](#qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate"), which is used here. **Returns** @@ -302,7 +302,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -350,7 +350,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix @@ -364,7 +364,7 @@ $$ **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the `time` parameters is not numeric. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the `time` parameters is not numeric. **Return type** @@ -386,11 +386,11 @@ $$ **Parameters** - **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – **Return type** - [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") | [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") | [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.mdx index 1c2b29d753a..768c3063285 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.mdx @@ -102,15 +102,15 @@ $$ **Parameters** - * **feature\_dimension** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – Number of qubits in the circuit. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of repeated circuits. - * **entanglement** (*Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Dict\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, List\[Tuple\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]], Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*], Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Dict\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, List\[Tuple\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]]]]*) – Specifies the entanglement structure. Can be a string (`'full'`, `'linear'`, `'reverse_linear'`, `'circular'` or `'sca'`) or can be a dictionary where the keys represent the number of qubits and the values are list of integer-pairs specifying the indices of qubits that are entangled with one another, for example: `{1: [(0,), (2,)], 2: [(0,1), (2,0)]}` or can be a `Callable[[int], Union[str | Dict[...]]]` to return an entanglement specific for a repetition - * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The Pauli rotation factor, multiplicative to the pauli rotations - * **paulis** (*Optional\[List\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]]*) – A list of strings for to-be-used paulis. If None are provided, `['Z', 'ZZ']` will be used. - * **data\_map\_func** (*Optional\[Callable\[\[np.ndarray],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]]*) – A mapping function for data x which can be supplied to override the default mapping from `self_product()`. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used if default parameters are generated. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between the evolution instructions and Hadamard layers. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **feature\_dimension** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – Number of qubits in the circuit. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of repeated circuits. + * **entanglement** (*Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Dict\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*, List\[Tuple\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]], Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*], Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Dict\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*, List\[Tuple\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]]]]]*) – Specifies the entanglement structure. Can be a string (`'full'`, `'linear'`, `'reverse_linear'`, `'circular'` or `'sca'`) or can be a dictionary where the keys represent the number of qubits and the values are list of integer-pairs specifying the indices of qubits that are entangled with one another, for example: `{1: [(0,), (2,)], 2: [(0,1), (2,0)]}` or can be a `Callable[[int], Union[str | Dict[...]]]` to return an entanglement specific for a repetition + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The Pauli rotation factor, multiplicative to the pauli rotations + * **paulis** (*Optional\[List\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]]*) – A list of strings for to-be-used paulis. If None are provided, `['Z', 'ZZ']` will be used. + * **data\_map\_func** (*Optional\[Callable\[\[np.ndarray],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]]*) – A mapping function for data x which can be supplied to override the default mapping from `self_product()`. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The prefix used if default parameters are generated. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, barriers are inserted in between the evolution instructions and Hadamard layers. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – ## Attributes @@ -205,9 +205,9 @@ $$ **Parameters** - * **rep\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The current repetition we are in. - * **block\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The block number within the entanglement layers. - * **num\_block\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in the block. + * **rep\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The current repetition we are in. + * **block\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The block number within the entanglement layers. + * **num\_block\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in the block. **Returns** @@ -215,11 +215,11 @@ $$ **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the value of `entanglement` could not be cast to a corresponding entangler map. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the value of `entanglement` could not be cast to a corresponding entangler map. **Return type** - [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")]] + [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")\[[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")]] ### pauli\_block diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PauliGate.mdx index d7336dcba57..fad474ac285 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PauliGate.mdx @@ -144,8 +144,8 @@ python_api_name: qiskit.circuit.library.PauliGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -157,7 +157,7 @@ python_api_name: qiskit.circuit.library.PauliGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -169,10 +169,10 @@ python_api_name: qiskit.circuit.library.PauliGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -190,7 +190,7 @@ python_api_name: qiskit.circuit.library.PauliGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -208,7 +208,7 @@ python_api_name: qiskit.circuit.library.PauliGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### is\_parameterized @@ -226,8 +226,8 @@ python_api_name: qiskit.circuit.library.PauliGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -245,7 +245,7 @@ python_api_name: qiskit.circuit.library.PauliGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -293,7 +293,7 @@ python_api_name: qiskit.circuit.library.PauliGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.mdx index 9cd76ad1302..75dd7ba46b9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.mdx @@ -61,11 +61,11 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits of the Pauli Two-Design circuit. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often a block consisting of a rotation layer and entanglement layer is repeated. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The seed for randomly choosing the axes of the Pauli rotations. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits of the Pauli Two-Design circuit. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Specifies how often a block consisting of a rotation layer and entanglement layer is repeated. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The seed for randomly choosing the axes of the Pauli rotations. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/qiskit.circuit.library.Permutation.mdx index 968740e87e2..bff4a605bd6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.Permutation.mdx @@ -19,9 +19,9 @@ python_api_name: qiskit.circuit.library.Permutation **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – circuit width. - * **pattern** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | np.ndarray | None*) – permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation, that is `pattern[k] = m` when the permutation maps qubit `m` to position `k`. As an example, the pattern `[2, 4, 3, 0, 1]` means that qubit `2` goes to position `0`, qubit `4` goes to the position `1`, etc. The pattern can also be `None`, in which case a random permutation over `num_qubits` is created. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – random seed in case a random permutation is requested. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – circuit width. + * **pattern** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | np.ndarray | None*) – permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation, that is `pattern[k] = m` when the permutation maps qubit `m` to position `k`. As an example, the pattern `[2, 4, 3, 0, 1]` means that qubit `2` goes to position `0`, qubit `4` goes to the position `1`, etc. The pattern can also be `None`, in which case a random permutation over `num_qubits` is created. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – random seed in case a random permutation is requested. **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PermutationGate.mdx index 2bfe34dc7f9..95e3d77db8d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PermutationGate.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.circuit.library.PermutationGate **Parameters** - **pattern** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation, that is `pattern[k] = m` when the permutation maps qubit `m` to position `k`. As an example, the pattern `[2, 4, 3, 0, 1]` means that qubit `2` goes to position `0`, qubit `4` goes to the position `1`, etc. + **pattern** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation, that is `pattern[k] = m` when the permutation maps qubit `m` to position `k`. As an example, the pattern `[2, 4, 3, 0, 1]` means that qubit `2` goes to position `0`, qubit `4` goes to the position `1`, etc. **Raises** @@ -155,8 +155,8 @@ python_api_name: qiskit.circuit.library.PermutationGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -168,7 +168,7 @@ python_api_name: qiskit.circuit.library.PermutationGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -180,10 +180,10 @@ python_api_name: qiskit.circuit.library.PermutationGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -201,7 +201,7 @@ python_api_name: qiskit.circuit.library.PermutationGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -219,7 +219,7 @@ python_api_name: qiskit.circuit.library.PermutationGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – **Return type** @@ -241,8 +241,8 @@ python_api_name: qiskit.circuit.library.PermutationGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -260,7 +260,7 @@ python_api_name: qiskit.circuit.library.PermutationGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -308,7 +308,7 @@ python_api_name: qiskit.circuit.library.PermutationGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.mdx index d0b4a029eb6..f6ead7c10ef 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.mdx @@ -35,10 +35,10 @@ $$ **Parameters** - * **num\_evaluation\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of evaluation qubits. + * **num\_evaluation\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of evaluation qubits. * **unitary** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The unitary operation $U$ which will be repeated and controlled. * **iqft** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A inverse Quantum Fourier Transform, per default the inverse of [`QFT`](qiskit.circuit.library.QFT "qiskit.circuit.library.QFT") is used. Note that the QFT should not include the usual swaps! - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. The inverse QFT should not include a swap of the qubit order. diff --git a/docs/api/qiskit/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PhaseGate.mdx index a1cef842b75..97925adc9e4 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PhaseGate.mdx @@ -62,7 +62,7 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – The rotation angle. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate. ## Attributes @@ -182,8 +182,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -195,7 +195,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -205,10 +205,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. **Returns** @@ -226,7 +226,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -244,7 +244,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always another `PGate` with an inverse parameter value. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always another `PGate` with an inverse parameter value. **Returns** @@ -270,8 +270,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -289,7 +289,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -337,7 +337,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.mdx index 160de10b8c5..1dfe4a7f501 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.mdx @@ -31,8 +31,8 @@ $$ **Parameters** - * **expression** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| BooleanExpression*) – A Python-like boolean expression string or a BooleanExpression object. - * **var\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – A list with the order in which variables will be created. (default: by appearance) + * **expression** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| BooleanExpression*) – A Python-like boolean expression string or a BooleanExpression object. + * **var\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] | None*) – A list with the order in which variables will be created. (default: by appearance) ## Attributes @@ -64,7 +64,7 @@ $$ **Parameters** - **bitstring** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The bitstring for which to evaluate. The input bitstring is expected to be in little-endian order. + **bitstring** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The bitstring for which to evaluate. The input bitstring is expected to be in little-endian order. **Returns** @@ -72,7 +72,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### from\_dimacs\_file @@ -100,7 +100,7 @@ $$ **Parameters** - **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A file in DIMACS format. + **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – A file in DIMACS format. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.library.PhaseOracleGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PhaseOracleGate.mdx index 75d2eceb6eb..045307ae6d2 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PhaseOracleGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PhaseOracleGate.mdx @@ -27,9 +27,9 @@ $$ **Parameters** - * **expression** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| BooleanExpression*) – A Python-like boolean expression string or a BooleanExpression object. - * **var\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – A list with the order in which variables will be created. (default: by appearance) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – A label for the gate to display in visualizations. Per default, the label is set to display the textual represntation of the boolean expression (truncated if needed) + * **expression** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| BooleanExpression*) – A Python-like boolean expression string or a BooleanExpression object. + * **var\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] | None*) – A list with the order in which variables will be created. (default: by appearance) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – A label for the gate to display in visualizations. Per default, the label is set to display the textual represntation of the boolean expression (truncated if needed) ## Attributes @@ -149,8 +149,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -162,7 +162,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -174,10 +174,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -195,7 +195,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -231,7 +231,7 @@ $$ **Parameters** - **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A file in DIMACS format. + **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – A file in DIMACS format. **Returns** @@ -255,7 +255,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -281,8 +281,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -300,7 +300,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -348,7 +348,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.mdx index bf30ab5dc0f..ae2adedae1c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -42,11 +42,11 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev **Parameters** - * **f\_x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – the function to be approximated. Constant functions should be specified as f\_x = constant. - * **degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – the degree of the polynomials. Defaults to `1`. - * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – the breakpoints to define the piecewise-linear function. Defaults to the full interval. - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – number of qubits representing the state. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit object. + * **f\_x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – the function to be approximated. Constant functions should be specified as f\_x = constant. + * **degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – the degree of the polynomials. Defaults to `1`. + * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – the breakpoints to define the piecewise-linear function. Defaults to the full interval. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – number of qubits representing the state. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit object. ## Attributes @@ -101,7 +101,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev **Raises** - [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If the input function is not in the correct format. + [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If the input function is not in the correct format. ### name diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshevGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshevGate.mdx index 01eb2e04ded..f51b6d56a6c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshevGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshevGate.mdx @@ -43,11 +43,11 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshevGate **Parameters** - * **f\_x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – the function to be approximated. Constant functions should be specified as f\_x = constant. - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubits representing the state. - * **degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – the degree of the polynomials. Defaults to `1`. - * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – the breakpoints to define the piecewise-linear function. Defaults to the full interval. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – A label for the gate. + * **f\_x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – the function to be approximated. Constant functions should be specified as f\_x = constant. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubits representing the state. + * **degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – the degree of the polynomials. Defaults to `1`. + * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – the breakpoints to define the piecewise-linear function. Defaults to the full interval. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – A label for the gate. ## Attributes @@ -167,8 +167,8 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshevGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -180,7 +180,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshevGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -192,10 +192,10 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshevGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -213,7 +213,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshevGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -237,7 +237,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshevGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -263,8 +263,8 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshevGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -282,7 +282,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshevGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -330,7 +330,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshevGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 4c6052f3c49..9a55b296a01 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -26,12 +26,12 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits representing the state. - * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – The breakpoints to define the piecewise-linear function. Defaults to `[0]`. - * **slopes** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | np.ndarray | None*) – The slopes for different segments of the piecewise-linear function. Defaults to `[1]`. - * **offsets** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | np.ndarray | None*) – The offsets for different segments of the piecewise-linear function. Defaults to `[0]`. - * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The type of Pauli rotation (`'X'`, `'Y'`, `'Z'`). - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits representing the state. + * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – The breakpoints to define the piecewise-linear function. Defaults to `[0]`. + * **slopes** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | np.ndarray | None*) – The slopes for different segments of the piecewise-linear function. Defaults to `[1]`. + * **offsets** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | np.ndarray | None*) – The offsets for different segments of the piecewise-linear function. Defaults to `[0]`. + * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The type of Pauli rotation (`'X'`, `'Y'`, `'Z'`). + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. ## Attributes @@ -117,7 +117,7 @@ $$ **Parameters** - **x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Value to be evaluated at. + **x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Value to be evaluated at. **Returns** @@ -125,7 +125,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotationsGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotationsGate.mdx index 3efae6de96d..edd4da793f3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotationsGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotationsGate.mdx @@ -28,12 +28,12 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits representing the state. - * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – The breakpoints to define the piecewise-linear function. Defaults to `[0]`. - * **slopes** (*Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – The slopes for different segments of the piecewise-linear function. Defaults to `[1]`. - * **offsets** (*Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – The offsets for different segments of the piecewise-linear function. Defaults to `[0]`. - * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The type of Pauli rotation (`'X'`, `'Y'`, `'Z'`). - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The label of the gate. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits representing the state. + * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – The breakpoints to define the piecewise-linear function. Defaults to `[0]`. + * **slopes** (*Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | None*) – The slopes for different segments of the piecewise-linear function. Defaults to `[1]`. + * **offsets** (*Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | None*) – The offsets for different segments of the piecewise-linear function. Defaults to `[0]`. + * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The type of Pauli rotation (`'X'`, `'Y'`, `'Z'`). + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The label of the gate. ## Attributes @@ -153,8 +153,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -166,7 +166,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -178,10 +178,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -199,7 +199,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -223,7 +223,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -249,8 +249,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -268,7 +268,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -316,7 +316,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 1a3b6c767ae..c700c85596d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -71,11 +71,11 @@ $$ **Parameters** - * **num\_state\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The number of qubits representing the state. - * **breakpoints** (*Optional\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – The breakpoints to define the piecewise-linear function. Defaults to `[0]`. - * **coeffs** (*Optional\[List\[List\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]]]*) – The coefficients of the polynomials for different segments of the piecewise-linear function. `coeffs[j][i]` is the coefficient of the i-th power of x for the j-th polynomial. Defaults to linear: `[[1]]`. - * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The type of Pauli rotation (`'X'`, `'Y'`, `'Z'`). - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. + * **num\_state\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The number of qubits representing the state. + * **breakpoints** (*Optional\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – The breakpoints to define the piecewise-linear function. Defaults to `[0]`. + * **coeffs** (*Optional\[List\[List\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]]]*) – The coefficients of the polynomials for different segments of the piecewise-linear function. `coeffs[j][i]` is the coefficient of the i-th power of x for the j-th polynomial. Defaults to linear: `[[1]]`. + * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The type of Pauli rotation (`'X'`, `'Y'`, `'Z'`). + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. ## Attributes @@ -149,7 +149,7 @@ $$ **Parameters** - **x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Value to be evaluated at. + **x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Value to be evaluated at. **Returns** @@ -157,7 +157,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotationsGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotationsGate.mdx index edad62109e4..33c4f0cc4b5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotationsGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotationsGate.mdx @@ -69,11 +69,11 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits representing the state. - * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – The breakpoints to define the piecewise-linear function. Defaults to `[0]`. - * **coeffs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]] | None*) – The coefficients of the polynomials for different segments of the piecewise-linear function. `coeffs[j][i]` is the coefficient of the i-th power of x for the j-th polynomial. Defaults to linear: `[[1]]`. - * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The type of Pauli rotation (`'X'`, `'Y'`, `'Z'`). - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits representing the state. + * **breakpoints** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – The breakpoints to define the piecewise-linear function. Defaults to `[0]`. + * **coeffs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]] | None*) – The coefficients of the polynomials for different segments of the piecewise-linear function. `coeffs[j][i]` is the coefficient of the i-th power of x for the j-th polynomial. Defaults to linear: `[[1]]`. + * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The type of Pauli rotation (`'X'`, `'Y'`, `'Z'`). + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate. ## Attributes @@ -193,8 +193,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -206,7 +206,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -218,10 +218,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -239,7 +239,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -257,7 +257,7 @@ $$ **Parameters** - **x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Value to be evaluated at. + **x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Value to be evaluated at. **Returns** @@ -265,7 +265,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") ### inverse @@ -281,7 +281,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -307,8 +307,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -326,7 +326,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -374,7 +374,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.mdx index 17dceab97b7..63e07cfb8a0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -36,10 +36,10 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits representing the state. - * **coeffs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – The coefficients of the polynomial. `coeffs[i]` is the coefficient of the i-th power of x. Defaults to linear: \[0, 1]. - * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The type of Pauli rotation (‘X’, ‘Y’, ‘Z’). - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits representing the state. + * **coeffs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | None*) – The coefficients of the polynomial. `coeffs[i]` is the coefficient of the i-th power of x. Defaults to linear: \[0, 1]. + * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The type of Pauli rotation (‘X’, ‘Y’, ‘Z’). + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotationsGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotationsGate.mdx index 3e9a2acea67..037eeced51c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotationsGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotationsGate.mdx @@ -38,10 +38,10 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits representing the state. - * **coeffs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – The coefficients of the polynomial. `coeffs[i]` is the coefficient of the i-th power of x. Defaults to linear: \[0, 1]. - * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The type of Pauli rotation (‘X’, ‘Y’, ‘Z’). - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – A label for the gate. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits representing the state. + * **coeffs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | None*) – The coefficients of the polynomial. `coeffs[i]` is the coefficient of the i-th power of x. Defaults to linear: \[0, 1]. + * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The type of Pauli rotation (‘X’, ‘Y’, ‘Z’). + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – A label for the gate. ## Attributes @@ -161,8 +161,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -174,7 +174,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -186,10 +186,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -207,7 +207,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -231,7 +231,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -257,8 +257,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -276,7 +276,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -324,7 +324,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.mdx index 1641972b865..3894ff4ca3e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.mdx @@ -20,11 +20,11 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz **Parameters** * **cost\_operator** (*BaseOperator or OperatorBase, optional*) – The operator representing the cost of the optimization problem, denoted as $U(C, \gamma)$ in the original paper. Must be set either in the constructor or via property setter. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The integer parameter p, which determines the depth of the circuit, as specified in the original paper, default is 1. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The integer parameter p, which determines the depth of the circuit, as specified in the original paper, default is 1. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*, optional*) – An optional initial state to use. If None is passed then a set of Hadamard gates is applied as an initial state to all qubits. * **mixer\_operator** (*BaseOperator or OperatorBase or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*, optional*) – An optional custom mixer to use instead of the global X-rotations, denoted as $U(B, \beta)$ in the original paper. Can be an operator or an optionally parameterized quantum circuit. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A name of the circuit, default ‘qaoa’ - * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – A name of the circuit, default ‘qaoa’ + * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/qiskit.circuit.library.QFT.mdx index 7eb09335e9a..def073bf459 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.QFT.mdx @@ -41,12 +41,12 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits on which the QFT acts. - * **approximation\_degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The degree of approximation (0 for no approximation). - * **do\_swaps** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to include the final swaps in the QFT. - * **inverse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, the inverse Fourier transform is constructed. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted as visualization improvement. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The name of the circuit. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits on which the QFT acts. + * **approximation\_degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The degree of approximation (0 for no approximation). + * **do\_swaps** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to include the final swaps in the QFT. + * **inverse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, the inverse Fourier transform is constructed. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, barriers are inserted as visualization improvement. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The name of the circuit. ## Attributes @@ -118,7 +118,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the inverse gate can be implemented as an annotated gate. The value of this argument is ignored as the inverse of a QFT is an IQFT which is just another instance of [`QFT`](#qiskit.circuit.library.QFT "qiskit.circuit.library.QFT"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the inverse gate can be implemented as an annotated gate. The value of this argument is ignored as the inverse of a QFT is an IQFT which is just another instance of [`QFT`](#qiskit.circuit.library.QFT "qiskit.circuit.library.QFT"). **Returns** @@ -140,7 +140,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.circuit.library.QFTGate.mdx b/docs/api/qiskit/qiskit.circuit.library.QFTGate.mdx index 4b23c7e6f8e..20799ba6022 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QFTGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.QFTGate.mdx @@ -21,7 +21,7 @@ $$ **Parameters** - **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits on which the QFT acts. + **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits on which the QFT acts. ## Attributes @@ -141,8 +141,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -154,7 +154,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -166,10 +166,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -187,7 +187,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -211,7 +211,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -237,8 +237,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -256,7 +256,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -304,7 +304,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.mdx index d356a5acd68..3795d19a5f0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.mdx @@ -43,16 +43,16 @@ $$ **Parameters** - * **num\_result\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The number of qubits to encode the result. Called $m$ in the class documentation. - * **quadratic** (*Optional\[Union\[np.ndarray, List\[List\[Union\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]]]]]*) – A matrix containing the quadratic coefficients, $A$. - * **linear** (*Optional\[Union\[np.ndarray, List\[Union\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]]]]*) – An array containing the linear coefficients, $b$. - * **offset** (*Optional\[Union\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]]*) – A constant offset, $c$. - * **little\_endian** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Encode the result in little endianness. + * **num\_result\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The number of qubits to encode the result. Called $m$ in the class documentation. + * **quadratic** (*Optional\[Union\[np.ndarray, List\[List\[Union\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]]]]]*) – A matrix containing the quadratic coefficients, $A$. + * **linear** (*Optional\[Union\[np.ndarray, List\[Union\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]]]]*) – An array containing the linear coefficients, $b$. + * **offset** (*Optional\[Union\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]]*) – A constant offset, $c$. + * **little\_endian** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Encode the result in little endianness. **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `linear` and `quadratic` have mismatching sizes. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_result_qubits` is unspecified but cannot be determined because some values of the quadratic form are parameterized. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `linear` and `quadratic` have mismatching sizes. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_result_qubits` is unspecified but cannot be determined because some values of the quadratic form are parameterized. ## Attributes @@ -84,9 +84,9 @@ $$ **Parameters** - * **quadratic** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]]*) – A matrix containing the quadratic coefficients. - * **linear** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – An array containing the linear coefficients. - * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – A constant offset. + * **quadratic** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]]*) – A matrix containing the quadratic coefficients. + * **linear** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – An array containing the linear coefficients. + * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – A constant offset. **Returns** @@ -94,7 +94,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.circuit.library.QuadraticFormGate.mdx b/docs/api/qiskit/qiskit.circuit.library.QuadraticFormGate.mdx index f72445f9221..e96c83ebdc3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QuadraticFormGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.QuadraticFormGate.mdx @@ -42,11 +42,11 @@ $$ * **name** – The name of the gate. * **num\_qubits** – The number of qubits the gate acts on. * **params** – A list of parameters. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – An optional label for the gate. - * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – - * **quadratic** (*Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]] | None*) – - * **linear** (*Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]] | None*) – - * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – An optional label for the gate. + * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – + * **quadratic** (*Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]] | None*) – + * **linear** (*Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]] | None*) – + * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – ## Attributes @@ -166,8 +166,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -179,7 +179,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -191,10 +191,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -212,7 +212,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -236,7 +236,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -262,8 +262,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -281,7 +281,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -303,9 +303,9 @@ $$ **Parameters** - * **quadratic** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]]*) – A matrix containing the quadratic coefficients. - * **linear** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – An array containing the linear coefficients. - * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – A constant offset. + * **quadratic** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]]*) – A matrix containing the quadratic coefficients. + * **linear** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – An array containing the linear coefficients. + * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – A constant offset. **Returns** @@ -313,7 +313,7 @@ $$ **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### reverse\_ops @@ -349,7 +349,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.mdx index 33e7586cee0..43f89ec23c0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.mdx @@ -35,11 +35,11 @@ python_api_name: qiskit.circuit.library.QuantumVolume **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of active qubits in model circuit. - * **depth** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – layers of SU(4) operations in model circuit. - * **seed** (*Optional\[Union\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, np.random.Generator]]*) – Random number generator or generator seed. - * **classical\_permutation** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – use classical permutations at every layer, rather than quantum. - * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `False` (the default), construct a circuit that contains a single instruction, which in turn has the actual volume structure. If `True`, construct the volume structure directly. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of active qubits in model circuit. + * **depth** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – layers of SU(4) operations in model circuit. + * **seed** (*Optional\[Union\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*, np.random.Generator]]*) – Random number generator or generator seed. + * **classical\_permutation** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – use classical permutations at every layer, rather than quantum. + * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `False` (the default), construct a circuit that contains a single instruction, which in turn has the actual volume structure. If `True`, construct the volume structure directly. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.RC3XGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RC3XGate.mdx index c1641cc99c3..b73e4071888 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RC3XGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RC3XGate.mdx @@ -139,8 +139,8 @@ python_api_name: qiskit.circuit.library.RC3XGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -152,7 +152,7 @@ python_api_name: qiskit.circuit.library.RC3XGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -164,10 +164,10 @@ python_api_name: qiskit.circuit.library.RC3XGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -185,7 +185,7 @@ python_api_name: qiskit.circuit.library.RC3XGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -209,7 +209,7 @@ python_api_name: qiskit.circuit.library.RC3XGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -235,8 +235,8 @@ python_api_name: qiskit.circuit.library.RC3XGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -254,7 +254,7 @@ python_api_name: qiskit.circuit.library.RC3XGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -302,7 +302,7 @@ python_api_name: qiskit.circuit.library.RC3XGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RCCXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RCCXGate.mdx index 42fb01a2173..ff71ea9a2b0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RCCXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RCCXGate.mdx @@ -139,8 +139,8 @@ python_api_name: qiskit.circuit.library.RCCXGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -152,7 +152,7 @@ python_api_name: qiskit.circuit.library.RCCXGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -164,10 +164,10 @@ python_api_name: qiskit.circuit.library.RCCXGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -185,7 +185,7 @@ python_api_name: qiskit.circuit.library.RCCXGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -209,7 +209,7 @@ python_api_name: qiskit.circuit.library.RCCXGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -235,8 +235,8 @@ python_api_name: qiskit.circuit.library.RCCXGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -254,7 +254,7 @@ python_api_name: qiskit.circuit.library.RCCXGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -302,7 +302,7 @@ python_api_name: qiskit.circuit.library.RCCXGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.mdx index 8e411f01047..219235bacd9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -40,9 +40,9 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. - * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of result qubits to limit the output to. If number of result qubits is $n$, multiplication modulo $2^n$ is performed to limit the output to the specified number of qubits. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit object. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. + * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of result qubits to limit the output to. If number of result qubits is $n$, multiplication modulo $2^n$ is performed to limit the output to the specified number of qubits. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit object. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RGate.mdx index d730654f10f..685d853e910 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RGate.mdx @@ -37,9 +37,9 @@ $$ **Parameters** - * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The rotation angle $\theta$. - * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The angle specifying the rotation axis, given by $\cos(\phi) x + \sin(\phi)y$. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate. + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The rotation angle $\theta$. + * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The angle specifying the rotation axis, given by $\cos(\phi) x + \sin(\phi)y$. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate. ## Attributes @@ -159,8 +159,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -172,7 +172,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -184,10 +184,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -205,7 +205,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -223,7 +223,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RGate`](#qiskit.circuit.library.RGate "qiskit.circuit.library.RGate") with an inverted parameter value. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RGate`](#qiskit.circuit.library.RGate "qiskit.circuit.library.RGate") with an inverted parameter value. **Returns** @@ -249,8 +249,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -268,7 +268,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -316,7 +316,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RVGate.mdx index df53222dcf7..05c4ef89d29 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RVGate.mdx @@ -42,10 +42,10 @@ $$ **Parameters** - * **v\_x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – x-component - * **v\_y** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – y-component - * **v\_z** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – z-component - * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – basis (see [`OneQubitEulerDecomposer`](qiskit.synthesis.OneQubitEulerDecomposer "qiskit.synthesis.one_qubit.one_qubit_decompose.OneQubitEulerDecomposer")) + * **v\_x** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – x-component + * **v\_y** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – y-component + * **v\_z** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – z-component + * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – basis (see [`OneQubitEulerDecomposer`](qiskit.synthesis.OneQubitEulerDecomposer "qiskit.synthesis.one_qubit.one_qubit_decompose.OneQubitEulerDecomposer")) ## Attributes @@ -165,8 +165,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -178,7 +178,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -190,10 +190,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -211,7 +211,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -229,7 +229,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### is\_parameterized @@ -247,8 +247,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -266,7 +266,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -314,7 +314,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RXGate.mdx index c2fe6a026d2..f994ad4cb6b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RXGate.mdx @@ -38,7 +38,7 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – The rotation angle. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional label for the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional label for the gate. ## Attributes @@ -158,8 +158,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -171,7 +171,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -181,10 +181,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters and more than one control qubit, in which case it cannot yet be synthesized. Otherwise it is set to `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters and more than one control qubit, in which case it cannot yet be synthesized. Otherwise it is set to `False`. **Returns** @@ -202,7 +202,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -222,7 +222,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RXGate`](#qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") with an inverted parameter value. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RXGate`](#qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") with an inverted parameter value. **Returns** @@ -248,8 +248,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](#qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](#qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -267,7 +267,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -315,7 +315,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RXXGate.mdx index 2558d87edec..b837c453175 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RXXGate.mdx @@ -64,7 +64,7 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – The rotation angle. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional label for the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional label for the gate. ## Attributes @@ -184,8 +184,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -197,7 +197,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -207,10 +207,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. **Returns** @@ -228,7 +228,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -246,7 +246,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RXXGate`](#qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate") with an inverted parameter value. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RXXGate`](#qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate") with an inverted parameter value. **Returns** @@ -272,8 +272,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -291,7 +291,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -339,7 +339,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RYGate.mdx index 3c8850ca03f..a012fd07f54 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RYGate.mdx @@ -38,7 +38,7 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – The rotation angle. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional label for the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional label for the gate. ## Attributes @@ -158,8 +158,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -171,7 +171,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -181,10 +181,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters and more than one control qubit, in which case it cannot yet be synthesized. Otherwise it is set to `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters and more than one control qubit, in which case it cannot yet be synthesized. Otherwise it is set to `False`. **Returns** @@ -202,7 +202,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -222,7 +222,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RYGate`](#qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate") with an inverted parameter value. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RYGate`](#qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate") with an inverted parameter value. **Returns** @@ -248,8 +248,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -267,7 +267,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -315,7 +315,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RYYGate.mdx index 0482b3ec797..9a08b62e5ec 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RYYGate.mdx @@ -64,7 +64,7 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – The rotation angle. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional label for the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional label for the gate. ## Attributes @@ -184,8 +184,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -197,7 +197,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -207,10 +207,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. **Returns** @@ -228,7 +228,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -246,7 +246,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RYYGate`](#qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate") with an inverted parameter value. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RYYGate`](#qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate") with an inverted parameter value. **Returns** @@ -272,8 +272,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -291,7 +291,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -339,7 +339,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RZGate.mdx index 9ccf0558e2f..ce1c50348b6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RZGate.mdx @@ -48,7 +48,7 @@ $$ **Parameters** * **theta** – The rotation angle. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional label for the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional label for the gate. * **phi** (*ParameterValueType*) – ## Attributes @@ -169,8 +169,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -182,7 +182,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -192,10 +192,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters and more than one control qubit, in which case it cannot yet be synthesized. Otherwise it is set to `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters and more than one control qubit, in which case it cannot yet be synthesized. Otherwise it is set to `False`. **Returns** @@ -213,7 +213,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -233,7 +233,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RZGate`](#qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate") with an inverted parameter value. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RZGate`](#qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate") with an inverted parameter value. **Returns** @@ -259,8 +259,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -278,7 +278,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -326,7 +326,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RZXGate.mdx index 37cfea134bd..2635a637797 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RZXGate.mdx @@ -104,7 +104,7 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – The rotation angle. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional label for the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional label for the gate. ## Attributes @@ -224,8 +224,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -237,7 +237,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -247,10 +247,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. **Returns** @@ -268,7 +268,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -286,7 +286,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – **when set to `True`, this is typically used to return an** @@ -312,8 +312,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -331,7 +331,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -379,7 +379,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RZZGate.mdx index 8c9e71746fb..68d5fbd9aed 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RZZGate.mdx @@ -76,7 +76,7 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – The rotation angle. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional label for the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional label for the gate. ## Attributes @@ -196,8 +196,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -209,7 +209,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -219,10 +219,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. **Returns** @@ -240,7 +240,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -258,7 +258,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RZZGate`](#qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate") with an inverted parameter value. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`RZZGate`](#qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate") with an inverted parameter value. **Returns** @@ -284,8 +284,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -303,7 +303,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -351,7 +351,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.mdx index 9f18447871d..a548b24ecef 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.mdx @@ -112,16 +112,16 @@ python_api_name: qiskit.circuit.library.RealAmplitudes **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits of the RealAmplitudes circuit. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. - * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ ‘reverse\_linear, ‘circular’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. Default to ‘reverse\_linear’ entanglement. Note that ‘reverse\_linear’ entanglement provides the same unitary as ‘full’ with fewer entangling gates. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits of the RealAmplitudes circuit. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ ‘reverse\_linear, ‘circular’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. Default to ‘reverse\_linear’ entanglement. Note that ‘reverse\_linear’ entanglement provides the same unitary as ‘full’ with fewer entangling gates. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A QuantumCircuit object to prepend to the circuit. - * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. - * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If False, a rotation layer is added at the end of the ansatz. If True, no rotation layer is added. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. - * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. + * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If False, a rotation layer is added at the end of the ansatz. If True, no rotation layer is added. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. + * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/qiskit.circuit.library.SGate.mdx index 1844aeaf851..3e152ed8552 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.SGate.mdx @@ -160,8 +160,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -173,7 +173,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -185,10 +185,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. **Returns** @@ -206,7 +206,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -224,7 +224,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). **Returns** @@ -250,8 +250,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -269,7 +269,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -317,7 +317,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.SXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.SXGate.mdx index d2a94e213ce..37515dd1de5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.SXGate.mdx @@ -166,8 +166,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -179,7 +179,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -191,10 +191,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. **Returns** @@ -212,7 +212,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -230,7 +230,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). **Returns** @@ -256,8 +256,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -275,7 +275,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -323,7 +323,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.SXdgGate.mdx b/docs/api/qiskit/qiskit.circuit.library.SXdgGate.mdx index 306f8eef2fc..0633c7025fc 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SXdgGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.SXdgGate.mdx @@ -154,8 +154,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -167,7 +167,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -179,10 +179,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -200,7 +200,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -218,7 +218,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). **Returns** @@ -244,8 +244,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -263,7 +263,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -311,7 +311,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/qiskit.circuit.library.SdgGate.mdx index 24f05f5a7b5..3133bbb1a8e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.SdgGate.mdx @@ -158,8 +158,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -171,7 +171,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -183,10 +183,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. **Returns** @@ -204,7 +204,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -222,7 +222,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). **Returns** @@ -248,8 +248,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -267,7 +267,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -315,7 +315,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/qiskit.circuit.library.StatePreparation.mdx index fee781c9479..cda98d8d4c5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.StatePreparation.mdx @@ -17,20 +17,20 @@ python_api_name: qiskit.circuit.library.StatePreparation **Parameters** - * **params** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector")) – + * **params** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector")) – * Statevector: Statevector to initialize to. * list: vector of complex amplitudes to initialize to. * string: labels of basis states of the Pauli eigenstates Z, X, Y. See [`Statevector.from_label()`](qiskit.quantum_info.Statevector#from_label "qiskit.quantum_info.Statevector.from_label"). Notice the order of the labels is reversed with respect to the qubit index to be applied to. Example label ‘01’ initializes the qubit zero to $|1\rangle$ and the qubit one to $|0\rangle$. * int: an integer that is used as a bitmap indicating which qubits to initialize to $|1\rangle$. Example: setting params to 5 would initialize qubit 0 and qubit 2 to $|1\rangle$ and qubit 1 to $|0\rangle$. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – This parameter is only used if params is an int. Indicates the total number of qubits in the initialize call. Example: initialize covers 5 qubits and params is 3. This allows qubits 0 and 1 to be initialized to $|1\rangle$ and the remaining 3 qubits to be initialized to $|0\rangle$. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – This parameter is only used if params is an int. Indicates the total number of qubits in the initialize call. Example: initialize covers 5 qubits and params is 3. This allows qubits 0 and 1 to be initialized to $|1\rangle$ and the remaining 3 qubits to be initialized to $|0\rangle$. - * **inverse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, the inverse state is constructed. + * **inverse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, the inverse state is constructed. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate - * **normalize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to normalize an input array to a unit vector. + * **normalize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to normalize an input array to a unit vector. **Raises** @@ -181,10 +181,10 @@ python_api_name: qiskit.circuit.library.StatePreparation **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -202,7 +202,7 @@ python_api_name: qiskit.circuit.library.StatePreparation **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -220,7 +220,7 @@ python_api_name: qiskit.circuit.library.StatePreparation **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### is\_parameterized @@ -238,8 +238,8 @@ python_api_name: qiskit.circuit.library.StatePreparation **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -257,7 +257,7 @@ python_api_name: qiskit.circuit.library.StatePreparation **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -305,7 +305,7 @@ python_api_name: qiskit.circuit.library.StatePreparation **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.SwapGate.mdx b/docs/api/qiskit/qiskit.circuit.library.SwapGate.mdx index f62c8d9afd4..2f53a645242 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SwapGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.SwapGate.mdx @@ -165,8 +165,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -178,7 +178,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -190,10 +190,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. **Returns** @@ -211,7 +211,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -229,7 +229,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -255,8 +255,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -274,7 +274,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -322,7 +322,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.TGate.mdx b/docs/api/qiskit/qiskit.circuit.library.TGate.mdx index 5fc7b1f304e..fcf68d33cd2 100644 --- a/docs/api/qiskit/qiskit.circuit.library.TGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.TGate.mdx @@ -160,8 +160,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -173,7 +173,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -185,10 +185,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -206,7 +206,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -224,7 +224,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). **Returns** @@ -250,8 +250,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -269,7 +269,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -317,7 +317,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.TdgGate.mdx b/docs/api/qiskit/qiskit.circuit.library.TdgGate.mdx index a80c66cacb0..c3004458190 100644 --- a/docs/api/qiskit/qiskit.circuit.library.TdgGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.TdgGate.mdx @@ -158,8 +158,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -171,7 +171,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -183,10 +183,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -204,7 +204,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -222,7 +222,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). **Returns** @@ -248,8 +248,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -267,7 +267,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -315,7 +315,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/qiskit.circuit.library.TwoLocal.mdx index 2b10110ee3d..a7917d333c7 100644 --- a/docs/api/qiskit/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.TwoLocal.mdx @@ -117,18 +117,18 @@ python_api_name: qiskit.circuit.library.TwoLocal **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits of the two-local circuit. - * **rotation\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The gates used in the rotation layer. Can be specified via the name of a gate (e.g. `'ry'`) or the gate type itself (e.g. [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate")). If only one gate is provided, the gate same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. See the Examples section for more detail. - * **entanglement\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The gates used in the entanglement layer. Can be specified in the same format as `rotation_blocks`. - * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – Specifies the entanglement structure. Can be a string (`'full'`, `'linear'`, `'reverse_linear'`, `'circular'` or `'sca'`), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. Default to `'full'` entanglement. Note that if `entanglement_blocks = 'cx'`, then `'full'` entanglement provides the same unitary as `'reverse_linear'` but the latter option has fewer entangling gates. See the Examples section for more detail. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often a block consisting of a rotation layer and entanglement layer is repeated. - * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, the single qubit gates are only applied to qubits that are entangled with another qubit. If `False`, the single qubit gates are applied to each qubit in the ansatz. Defaults to `False`. - * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `False`, a rotation layer is added at the end of the ansatz. If `True`, no rotation layer is added. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The parameterized gates require a parameter to be defined, for which we use instances of [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). The name of each parameter will be this specified prefix plus its index. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits of the two-local circuit. + * **rotation\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The gates used in the rotation layer. Can be specified via the name of a gate (e.g. `'ry'`) or the gate type itself (e.g. [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate")). If only one gate is provided, the gate same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. See the Examples section for more detail. + * **entanglement\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The gates used in the entanglement layer. Can be specified in the same format as `rotation_blocks`. + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – Specifies the entanglement structure. Can be a string (`'full'`, `'linear'`, `'reverse_linear'`, `'circular'` or `'sca'`), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. Default to `'full'` entanglement. Note that if `entanglement_blocks = 'cx'`, then `'full'` entanglement provides the same unitary as `'reverse_linear'` but the latter option has fewer entangling gates. See the Examples section for more detail. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Specifies how often a block consisting of a rotation layer and entanglement layer is repeated. + * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, the single qubit gates are only applied to qubits that are entangled with another qubit. If `False`, the single qubit gates are applied to each qubit in the ansatz. Defaults to `False`. + * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `False`, a rotation layer is added at the end of the ansatz. If `True`, no rotation layer is added. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The parameterized gates require a parameter to be defined, for which we use instances of [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). The name of each parameter will be this specified prefix plus its index. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object to prepend to the circuit. - * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – ## Attributes @@ -160,13 +160,13 @@ python_api_name: qiskit.circuit.library.TwoLocal **Parameters** - * **rep\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **block\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **num\_block\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **rep\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **block\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **num\_block\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – **Return type** - [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")]] + [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")\[[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")]] diff --git a/docs/api/qiskit/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/qiskit.circuit.library.U1Gate.mdx index 339542517d7..57226c51568 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.U1Gate.mdx @@ -75,7 +75,7 @@ $$ **Parameters** * **theta** (*ParameterValueType*) – The rotation angle. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate. ## Attributes @@ -195,8 +195,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -208,7 +208,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -218,10 +218,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the controlled gate should be implemented as an annotated gate. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the controlled gate should be implemented as an annotated gate. **Returns** @@ -239,7 +239,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -257,7 +257,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`U1Gate`](#qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate") with inverse parameter values. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`U1Gate`](#qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate") with inverse parameter values. **Returns** @@ -283,8 +283,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -302,7 +302,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -350,7 +350,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/qiskit.circuit.library.U2Gate.mdx index 2899994aea1..46d563782a1 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.U2Gate.mdx @@ -73,9 +73,9 @@ $$ **Parameters** - * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The rotation angle $\phi$. - * **lam** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The rotation angle $\lambda$. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate. + * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The rotation angle $\phi$. + * **lam** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The rotation angle $\lambda$. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate. ## Attributes @@ -195,8 +195,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -208,7 +208,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -220,10 +220,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -241,7 +241,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -261,7 +261,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`U2Gate`](#qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate") with inverse parameter values. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`U2Gate`](#qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate") with inverse parameter values. **Returns** @@ -287,8 +287,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -306,7 +306,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -354,7 +354,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/qiskit.circuit.library.U3Gate.mdx index 2d78d056a97..0a76451352a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.U3Gate.mdx @@ -71,7 +71,7 @@ $$ * **theta** (*ParameterValueType*) – The angle $\theta corresponding to the :math:`R_Y(\theta)$ rotation. * **phi** (*ParameterValueType*) – The angle $\phi$ corresponding to the $R_Z(\phi)$ rotation. * **lam** (*ParameterValueType*) – The angle $\lambda$ corresponding to the $R_Z(\lambda)$ rotation. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional label for the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional label for the gate. ## Attributes @@ -191,8 +191,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -204,7 +204,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -214,10 +214,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters and more than one control qubit, in which case it cannot yet be synthesized. Otherwise it is set to `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters and more than one control qubit, in which case it cannot yet be synthesized. Otherwise it is set to `False`. **Returns** @@ -235,7 +235,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -255,7 +255,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`U3Gate`](#qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate") with inverse parameter values. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`U3Gate`](#qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate") with inverse parameter values. **Returns** @@ -281,8 +281,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -300,7 +300,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -348,7 +348,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.UCGate.mdx b/docs/api/qiskit/qiskit.circuit.library.UCGate.mdx index be656576a20..a4db8cd8117 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.UCGate.mdx @@ -38,9 +38,9 @@ $$ **Parameters** - * **gate\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[np.ndarray]*) – List of two qubit unitaries $[U_0, ..., U_{2^{k-1}}]$, where each single-qubit unitary $U_i$ is given as a $2 \times 2$ numpy array. - * **up\_to\_diagonal** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Determines if the gate is implemented up to a diagonal. or if it is decomposed completely (default: False). If the `UCGate` $U$ is decomposed up to a diagonal $D$, this means that the circuit implements a unitary $U'$ such that $D U' = U$. - * **mux\_simp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Determines whether the search for repetitions is conducted (default: True). The intention is to perform a possible simplification in the number of controls and operators. + * **gate\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[np.ndarray]*) – List of two qubit unitaries $[U_0, ..., U_{2^{k-1}}]$, where each single-qubit unitary $U_i$ is given as a $2 \times 2$ numpy array. + * **up\_to\_diagonal** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Determines if the gate is implemented up to a diagonal. or if it is decomposed completely (default: False). If the `UCGate` $U$ is decomposed up to a diagonal $D$, this means that the circuit implements a unitary $U'$ such that $D U' = U$. + * **mux\_simp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Determines whether the search for repetitions is conducted (default: True). The intention is to perform a possible simplification in the number of controls and operators. **Raises** @@ -164,8 +164,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -177,7 +177,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -189,10 +189,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -210,7 +210,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -230,7 +230,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – **Return type** @@ -252,8 +252,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -271,7 +271,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -319,7 +319,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.mdx b/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.mdx index e4e5217bcc3..321723c780f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.mdx @@ -17,8 +17,8 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate **Parameters** - * **angle\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – List of rotation angles $[a_0, ..., a_{2^{k-1}}]$. - * **rot\_axis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Rotation axis. Must be either of `"X"`, `"Y"` or `"Z"`. + * **angle\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – List of rotation angles $[a_0, ..., a_{2^{k-1}}]$. + * **rot\_axis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Rotation axis. Must be either of `"X"`, `"Y"` or `"Z"`. ## Attributes @@ -138,8 +138,8 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -151,7 +151,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -163,10 +163,10 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -184,7 +184,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -208,7 +208,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -234,8 +234,8 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -253,7 +253,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -301,7 +301,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.UCRXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.UCRXGate.mdx index 590dc604f18..c73235f9823 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCRXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.UCRXGate.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.circuit.library.UCRXGate **Parameters** - **angle\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – List of rotation angles $[a_0, ..., a_{2^{k-1}}]$. + **angle\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – List of rotation angles $[a_0, ..., a_{2^{k-1}}]$. ## Attributes @@ -137,8 +137,8 @@ python_api_name: qiskit.circuit.library.UCRXGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -150,7 +150,7 @@ python_api_name: qiskit.circuit.library.UCRXGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -162,10 +162,10 @@ python_api_name: qiskit.circuit.library.UCRXGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -183,7 +183,7 @@ python_api_name: qiskit.circuit.library.UCRXGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -207,7 +207,7 @@ python_api_name: qiskit.circuit.library.UCRXGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -233,8 +233,8 @@ python_api_name: qiskit.circuit.library.UCRXGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.UCRXGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -300,7 +300,7 @@ python_api_name: qiskit.circuit.library.UCRXGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.UCRYGate.mdx b/docs/api/qiskit/qiskit.circuit.library.UCRYGate.mdx index 806be48ca4a..7b50cde1821 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCRYGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.UCRYGate.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.circuit.library.UCRYGate **Parameters** - **angle\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – List of rotation angles $[a_0, ..., a_{2^{k-1}}]$. + **angle\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – List of rotation angles $[a_0, ..., a_{2^{k-1}}]$. ## Attributes @@ -137,8 +137,8 @@ python_api_name: qiskit.circuit.library.UCRYGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -150,7 +150,7 @@ python_api_name: qiskit.circuit.library.UCRYGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -162,10 +162,10 @@ python_api_name: qiskit.circuit.library.UCRYGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -183,7 +183,7 @@ python_api_name: qiskit.circuit.library.UCRYGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -207,7 +207,7 @@ python_api_name: qiskit.circuit.library.UCRYGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -233,8 +233,8 @@ python_api_name: qiskit.circuit.library.UCRYGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.UCRYGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -300,7 +300,7 @@ python_api_name: qiskit.circuit.library.UCRYGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.UCRZGate.mdx b/docs/api/qiskit/qiskit.circuit.library.UCRZGate.mdx index b87dbc5fd7a..3fb478873c6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCRZGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.UCRZGate.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.circuit.library.UCRZGate **Parameters** - **angle\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – List of rotation angles $[a_0, ..., a_{2^{k-1}}]$. + **angle\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – List of rotation angles $[a_0, ..., a_{2^{k-1}}]$. ## Attributes @@ -137,8 +137,8 @@ python_api_name: qiskit.circuit.library.UCRZGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -150,7 +150,7 @@ python_api_name: qiskit.circuit.library.UCRZGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -162,10 +162,10 @@ python_api_name: qiskit.circuit.library.UCRZGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -183,7 +183,7 @@ python_api_name: qiskit.circuit.library.UCRZGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -207,7 +207,7 @@ python_api_name: qiskit.circuit.library.UCRZGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -233,8 +233,8 @@ python_api_name: qiskit.circuit.library.UCRZGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.UCRZGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -300,7 +300,7 @@ python_api_name: qiskit.circuit.library.UCRZGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/qiskit.circuit.library.UGate.mdx index 6213b08ccc5..63c7e1560d8 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.UGate.mdx @@ -61,7 +61,7 @@ $$ * **theta** (*ParameterValueType*) – The angle $\theta corresponding to the :math:`R_Y(\theta)$ rotation. * **phi** (*ParameterValueType*) – The angle $\phi$ corresponding to the $R_Z(\phi)$ rotation. * **lam** (*ParameterValueType*) – The angle $\lambda$ corresponding to the $R_Z(\lambda)$ rotation. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional label for the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional label for the gate. ## Attributes @@ -181,8 +181,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -194,7 +194,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -204,10 +204,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters and more than one control qubit, in which case it cannot yet be synthesized. Otherwise it is set to `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters and more than one control qubit, in which case it cannot yet be synthesized. Otherwise it is set to `False`. **Returns** @@ -225,7 +225,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -245,7 +245,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`UGate`](#qiskit.circuit.library.UGate "qiskit.circuit.library.UGate") with inverse parameter values. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`UGate`](#qiskit.circuit.library.UGate "qiskit.circuit.library.UGate") with inverse parameter values. **Returns** @@ -271,8 +271,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -290,7 +290,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -338,7 +338,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.mdx b/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.mdx index 29921ce1482..42c048f3f13 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.mdx @@ -34,13 +34,13 @@ python_api_name: qiskit.circuit.library.UnitaryGate **Parameters** * **data** ([*numpy.ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| BaseOperator*) – Unitary operator. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Unitary name for backend \[Default: `None`]. - * **check\_input** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to `False` this asserts the input is known to be unitary and the checking to validate this will be skipped. This should only ever be used if you know the input is unitary, setting this to `False` and passing in a non-unitary matrix will result unexpected behavior and errors. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – If given, the number of qubits in the matrix. If not given, it is inferred. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Unitary name for backend \[Default: `None`]. + * **check\_input** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to `False` this asserts the input is known to be unitary and the checking to validate this will be skipped. This should only ever be used if you know the input is unitary, setting this to `False` and passing in a non-unitary matrix will result unexpected behavior and errors. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – If given, the number of qubits in the matrix. If not given, it is inferred. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If input data is not an N-qubit unitary operator. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If input data is not an N-qubit unitary operator. ## Attributes @@ -166,8 +166,8 @@ python_api_name: qiskit.circuit.library.UnitaryGate **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -179,7 +179,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### conjugate @@ -195,10 +195,10 @@ python_api_name: qiskit.circuit.library.UnitaryGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of controls to add to gate (default is 1). - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Optional gate label. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The control state in decimal or as a bit string (e.g. `"1011"`). If `None`, use `2**num_ctrl_qubits - 1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of controls to add to gate (default is 1). + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Optional gate label. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The control state in decimal or as a bit string (e.g. `"1011"`). If `None`, use `2**num_ctrl_qubits - 1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is handled as `False`. **Returns** @@ -216,7 +216,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -234,7 +234,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### is\_parameterized @@ -252,8 +252,8 @@ python_api_name: qiskit.circuit.library.UnitaryGate **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -271,7 +271,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -319,7 +319,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.mdx b/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.mdx index 1e01b2d2d58..65a38e35a2a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.mdx @@ -54,9 +54,9 @@ $$ * **unitary1** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – Unitary acting on the ket vector. * **unitary2** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – Unitary whose inverse operates on the bra vector. - * **prefix1** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the parameter vector associated to `unitary1`, if it is parameterized. Defaults to `"p1"`. - * **prefix2** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the parameter vector associated to `unitary2`, if it is parameterized. Defaults to `"p2"`. - * **insert\_barrier** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to insert a barrier between the two unitaries. + * **prefix1** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the parameter vector associated to `unitary1`, if it is parameterized. Defaults to `"p1"`. + * **prefix2** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the parameter vector associated to `unitary2`, if it is parameterized. Defaults to `"p2"`. + * **insert\_barrier** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to insert a barrier between the two unitaries. **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.mdx index 8f20cf1db38..e0cb9dd560a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -57,13 +57,13 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The size of the register. - * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The kind of adder, can be `'full'` for a full adder, `'half'` for a half adder, or `'fixed'` for a fixed-sized adder. A full adder includes both carry-in and carry-out, a half only carry-out, and a fixed-sized adder neither carry-in nor carry-out. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The size of the register. + * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The kind of adder, can be `'full'` for a full adder, `'half'` for a half adder, or `'fixed'` for a fixed-sized adder. A full adder includes both carry-in and carry-out, a half only carry-out, and a fixed-sized adder neither carry-in nor carry-out. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_state_qubits` is lower than 1. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_state_qubits` is lower than 1. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.mdx index 0b6ee70f0b8..4c76f8104c6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.mdx @@ -56,9 +56,9 @@ $$ **Parameters** - * **num\_state\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The number of state qubits. - * **weights** (*Optional\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – List of weights, one for each state qubit. If none are provided they default to 1 for every qubit. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. + * **num\_state\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The number of state qubits. + * **weights** (*Optional\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – List of weights, one for each state qubit. If none are provided they default to 1 for every qubit. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.WeightedSumGate.mdx b/docs/api/qiskit/qiskit.circuit.library.WeightedSumGate.mdx index 63d19e58b18..6effdd33f56 100644 --- a/docs/api/qiskit/qiskit.circuit.library.WeightedSumGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.WeightedSumGate.mdx @@ -50,9 +50,9 @@ $$ **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of state qubits. - * **weights** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – List of weights, one for each state qubit. If none are provided they default to 1 for every qubit. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The name of the circuit. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of state qubits. + * **weights** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – List of weights, one for each state qubit. If none are provided they default to 1 for every qubit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The name of the circuit. ## Attributes @@ -172,8 +172,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -185,7 +185,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -197,10 +197,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -218,7 +218,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -242,7 +242,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -268,8 +268,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -287,7 +287,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -335,7 +335,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/qiskit.circuit.library.XGate.mdx index 3306af71dec..fddc1acfc1b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.XGate.mdx @@ -175,8 +175,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -188,7 +188,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -200,10 +200,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled X gate is a multi-controlled X-gate. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g. `'110'`), or `None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with a control modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as a controlled X gate is a multi-controlled X-gate. **Returns** @@ -221,7 +221,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -239,7 +239,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -265,8 +265,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -284,7 +284,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -332,7 +332,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/qiskit.circuit.library.XOR.mdx index ee481d230f6..326cc066ef8 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.XOR.mdx @@ -23,9 +23,9 @@ python_api_name: qiskit.circuit.library.XOR **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the width of circuit. - * **amount** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – the xor amount in decimal form. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – random seed in case a random xor is requested. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the width of circuit. + * **amount** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – the xor amount in decimal form. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – random seed in case a random xor is requested. **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.mdx b/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.mdx index 1fc42e74867..5168e0dfffa 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.mdx @@ -44,7 +44,7 @@ $$ * **theta** (*ParameterValueType*) – The rotation angle. * **beta** (*ParameterValueType*) – The phase angle. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – The label of the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – The label of the gate. ## Attributes @@ -164,8 +164,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -177,7 +177,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -187,10 +187,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. **Returns** @@ -208,7 +208,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -226,7 +226,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`XXMinusYYGate`](#qiskit.circuit.library.XXMinusYYGate "qiskit.circuit.library.XXMinusYYGate") with inverse parameter values. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`XXMinusYYGate`](#qiskit.circuit.library.XXMinusYYGate "qiskit.circuit.library.XXMinusYYGate") with inverse parameter values. **Returns** @@ -252,8 +252,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -271,7 +271,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -319,7 +319,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.mdx b/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.mdx index 2df7e21883d..c16e5022c76 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.mdx @@ -71,7 +71,7 @@ $$ * **theta** (*ParameterValueType*) – The rotation angle. * **beta** (*ParameterValueType*) – The phase angle. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – The label of the gate. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – The label of the gate. ## Attributes @@ -191,8 +191,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -204,7 +204,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -214,10 +214,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate should be implemented as an annotated gate. If `None`, this is set to `True` if the gate contains free parameters, in which case it cannot yet be synthesized. **Returns** @@ -235,7 +235,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -253,7 +253,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`XXPlusYYGate`](#qiskit.circuit.library.XXPlusYYGate "qiskit.circuit.library.XXPlusYYGate") with inverse parameter values. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as the inverse of this gate is always a [`XXPlusYYGate`](#qiskit.circuit.library.XXPlusYYGate "qiskit.circuit.library.XXPlusYYGate") with inverse parameter values. **Returns** @@ -279,8 +279,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -298,7 +298,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -346,7 +346,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.YGate.mdx b/docs/api/qiskit/qiskit.circuit.library.YGate.mdx index 5b034ee7ae2..753bdb84167 100644 --- a/docs/api/qiskit/qiskit.circuit.library.YGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.YGate.mdx @@ -175,8 +175,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -188,7 +188,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -200,10 +200,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the controlled gate should be implemented as an annotated gate. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the controlled gate should be implemented as an annotated gate. **Returns** @@ -221,7 +221,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -239,7 +239,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -265,8 +265,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -284,7 +284,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -332,7 +332,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.mdx index 28bff0f7ead..f8d56af67bb 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.mdx @@ -74,12 +74,12 @@ python_api_name: qiskit.circuit.library.ZFeatureMap **Parameters** - * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of features - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of repeated circuits. Defaults to 2, has a minimum value of 1. - * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – A mapping function for data x which can be supplied to override the default mapping from `self_product()`. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used if default parameters are generated. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between the evolution instructions and hadamard layers. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of features + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of repeated circuits. Defaults to 2, has a minimum value of 1. + * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)")*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | None*) – A mapping function for data x which can be supplied to override the default mapping from `self_product()`. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The prefix used if default parameters are generated. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, barriers are inserted in between the evolution instructions and hadamard layers. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.ZGate.mdx b/docs/api/qiskit/qiskit.circuit.library.ZGate.mdx index 64971ffc848..6c352afeaa0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ZGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ZGate.mdx @@ -175,8 +175,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -188,7 +188,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -200,10 +200,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of control qubits. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – An optional label for the gate \[Default: `None`] - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the controlled gate should be implemented as an annotated gate. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of control qubits. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – An optional label for the gate \[Default: `None`] + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the controlled gate should be implemented as an annotated gate. **Returns** @@ -221,7 +221,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -239,7 +239,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse. **Returns** @@ -265,8 +265,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -284,7 +284,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -332,7 +332,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.mdx index 39b4ef35b48..52d5831eb76 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.mdx @@ -90,17 +90,17 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap **Parameters** - * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of features. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of repeated circuits, has a min. value of 1. - * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*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)")*]]] |* [*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*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)")*]]]]*) – Specifies the entanglement structure. Refer to [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap") for detail. - * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – A mapping function for data x. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used if default parameters are generated. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between the evolution instructions and hadamard layers. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of features. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of repeated circuits, has a min. value of 1. + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*,* [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*Tuple*](https://docs.python.org/3/library/typing.html#typing.Tuple "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]] |* [*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)")*\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*,* [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*Tuple*](https://docs.python.org/3/library/typing.html#typing.Tuple "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]]]*) – Specifies the entanglement structure. Refer to [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap") for detail. + * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)")*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | None*) – A mapping function for data x. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The prefix used if default parameters are generated. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, barriers are inserted in between the evolution instructions and hadamard layers. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the feature dimension is smaller than 2. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the feature dimension is smaller than 2. ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.efficient_su2.mdx b/docs/api/qiskit/qiskit.circuit.library.efficient_su2.mdx index 0436f7c4150..280d1dc6ece 100644 --- a/docs/api/qiskit/qiskit.circuit.library.efficient_su2.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.efficient_su2.mdx @@ -53,15 +53,15 @@ python_api_name: qiskit.circuit.library.efficient_su2 **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits. - * **su2\_gates** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*] | None*) – The $SU(2)$ single qubit gates to apply in single qubit gate layers. If only one gate is provided, the same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. - * **entanglement** (*BlockEntanglement | Iterable\[BlockEntanglement] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*], BlockEntanglement | Iterable\[BlockEntanglement]]*) – The indices specifying on which qubits the input blocks act. See [`n_local()`](qiskit.circuit.library.n_local "qiskit.circuit.library.n_local") for detailed information. - * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether a final rotation layer is added to the circuit. - * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the free parameters. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits. + * **su2\_gates** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*] | None*) – The $SU(2)$ single qubit gates to apply in single qubit gate layers. If only one gate is provided, the same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. + * **entanglement** (*BlockEntanglement | Iterable\[BlockEntanglement] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*], BlockEntanglement | Iterable\[BlockEntanglement]]*) – The indices specifying on which qubits the input blocks act. See [`n_local()`](qiskit.circuit.library.n_local "qiskit.circuit.library.n_local") for detailed information. + * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether a final rotation layer is added to the circuit. + * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the free parameters. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.library.evolved_operator_ansatz.mdx b/docs/api/qiskit/qiskit.circuit.library.evolved_operator_ansatz.mdx index 8cfaee43a2e..da9b85f7e82 100644 --- a/docs/api/qiskit/qiskit.circuit.library.evolved_operator_ansatz.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.evolved_operator_ansatz.mdx @@ -37,13 +37,13 @@ $$ **Parameters** * **operators** (*BaseOperator | Sequence\[BaseOperator]*) – The operators to evolve. Can be a single operator or a sequence thereof. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of times to repeat the evolved operators. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of times to repeat the evolved operators. * **evolution** ([*EvolutionSynthesis*](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.EvolutionSynthesis") *| None*) – A specification of which evolution synthesis to use for the [`PauliEvolutionGate`](qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate"). Defaults to first order Trotterization. Note, that operators of type [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") are evolved using the [`HamiltonianGate`](qiskit.circuit.library.HamiltonianGate "qiskit.circuit.library.HamiltonianGate"), as there are no Hamiltonian terms to expand in Trotterization. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to insert barriers in between each evolution. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – Set the names of the circuit parameters. If a string, the same prefix will be used for each parameters. Can also be a list to specify a prefix per operator. - * **remove\_identities** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, ignore identity operators (note that we do not check [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") inputs). This will also remove parameters associated with identities. - * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – If `True`, a flat circuit is returned instead of nesting it inside multiple layers of gate objects. Setting this to `False` is significantly less performant, especially for parameter binding, but can be desirable for a cleaner visualization. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to insert barriers in between each evolution. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| Sequence\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – Set the names of the circuit parameters. If a string, the same prefix will be used for each parameters. Can also be a list to specify a prefix per operator. + * **remove\_identities** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, ignore identity operators (note that we do not check [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") inputs). This will also remove parameters associated with identities. + * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – If `True`, a flat circuit is returned instead of nesting it inside multiple layers of gate objects. Setting this to `False` is significantly less performant, especially for parameter binding, but can be desirable for a cleaner visualization. **Return type** diff --git a/docs/api/qiskit/qiskit.circuit.library.excitation_preserving.mdx b/docs/api/qiskit/qiskit.circuit.library.excitation_preserving.mdx index 9b582f189c2..68b85cc3878 100644 --- a/docs/api/qiskit/qiskit.circuit.library.excitation_preserving.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.excitation_preserving.mdx @@ -58,15 +58,15 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits. - * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Choose the entangler mode, can be “iswap” or “fsim”. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. - * **entanglement** (*BlockEntanglement | Iterable\[BlockEntanglement] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*], BlockEntanglement | Iterable\[BlockEntanglement]]*) – The indices specifying on which qubits the input blocks act. See [`n_local()`](qiskit.circuit.library.n_local "qiskit.circuit.library.n_local") for detailed information. - * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether a final rotation layer is added to the circuit. - * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the free parameters. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits. + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Choose the entangler mode, can be “iswap” or “fsim”. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. + * **entanglement** (*BlockEntanglement | Iterable\[BlockEntanglement] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*], BlockEntanglement | Iterable\[BlockEntanglement]]*) – The indices specifying on which qubits the input blocks act. See [`n_local()`](qiskit.circuit.library.n_local "qiskit.circuit.library.n_local") for detailed information. + * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether a final rotation layer is added to the circuit. + * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the free parameters. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.library.fourier_checking.mdx b/docs/api/qiskit/qiskit.circuit.library.fourier_checking.mdx index ca0367026f9..a7e6b84fd64 100644 --- a/docs/api/qiskit/qiskit.circuit.library.fourier_checking.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.fourier_checking.mdx @@ -39,8 +39,8 @@ python_api_name: qiskit.circuit.library.fourier_checking **Parameters** - * **f** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – - * **g** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **f** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – + * **g** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – **Return type** diff --git a/docs/api/qiskit/qiskit.circuit.library.grover_operator.mdx b/docs/api/qiskit/qiskit.circuit.library.grover_operator.mdx index bb9a4367236..9d465a79bb2 100644 --- a/docs/api/qiskit/qiskit.circuit.library.grover_operator.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.grover_operator.mdx @@ -151,9 +151,9 @@ $$ * **oracle** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) – The phase oracle implementing a reflection about the bad state. Note that this is not a bitflip oracle, see the docstring for more information. * **state\_preparation** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – The operator preparing the good and bad state. For Grover’s algorithm, this is a n-qubit Hadamard gate and for amplitude amplification or estimation the operator $\mathcal{A}$. * **zero\_reflection** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *|*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *| None*) – The reflection about the zero state, $\mathcal{S}_0$. - * **reflection\_qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – Qubits on which the zero reflection acts on. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether barriers should be inserted between the reflections and A. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. + * **reflection\_qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – Qubits on which the zero reflection acts on. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether barriers should be inserted between the reflections and A. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. References: diff --git a/docs/api/qiskit/qiskit.circuit.library.hamiltonian_variational_ansatz.mdx b/docs/api/qiskit/qiskit.circuit.library.hamiltonian_variational_ansatz.mdx index 5c983297c36..46f2cd45432 100644 --- a/docs/api/qiskit/qiskit.circuit.library.hamiltonian_variational_ansatz.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.hamiltonian_variational_ansatz.mdx @@ -56,10 +56,10 @@ $$ **Parameters** * **hamiltonian** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *| Sequence\[*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")*]*) – The Hamiltonian to evolve. If given as single operator, it will be split into commuting terms. If a sequence of [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"), then it is assumed that each element consists of commuting terms, but the elements do not commute among each other. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of times to repeat the evolved operators. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to insert barriers in between each evolution. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Set the names of the circuit parameters. If a string, the same prefix will be used for each parameters. Can also be a list to specify a prefix per operator. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of times to repeat the evolved operators. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to insert barriers in between each evolution. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Set the names of the circuit parameters. If a string, the same prefix will be used for each parameters. Can also be a list to specify a prefix per operator. **Return type** diff --git a/docs/api/qiskit/qiskit.circuit.library.hidden_linear_function.mdx b/docs/api/qiskit/qiskit.circuit.library.hidden_linear_function.mdx index cf79f4e3650..5e7b09093bc 100644 --- a/docs/api/qiskit/qiskit.circuit.library.hidden_linear_function.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.hidden_linear_function.mdx @@ -46,7 +46,7 @@ $$ **Parameters** - **adjacency\_matrix** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| np.ndarray*) – a symmetric n-by-n list of 0-1 lists. n will be the number of qubits. + **adjacency\_matrix** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *| np.ndarray*) – a symmetric n-by-n list of 0-1 lists. n will be the number of qubits. **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.iSwapGate.mdx b/docs/api/qiskit/qiskit.circuit.library.iSwapGate.mdx index 5c87af88dea..def6235edf9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.iSwapGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.iSwapGate.mdx @@ -188,8 +188,8 @@ $$ **Parameters** - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of quantum bit arguments. - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of classical bit arguments. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of quantum bit arguments. + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of classical bit arguments. **Returns** @@ -201,7 +201,7 @@ $$ **Return type** - [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")]] + [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")]] ### control @@ -213,10 +213,10 @@ $$ **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of controls to add to gate (default: `1`) - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of controls to add to gate (default: `1`) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – optional gate label. Ignored if implemented as an annotated operation. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – the control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – indicates whether the controlled gate is implemented as an annotated gate. If `None`, this is set to `False` if the controlled gate can directly be constructed, and otherwise set to `True`. This allows defering the construction process in case the synthesis of the controlled gate requires more information (e.g. values of unbound parameters). **Returns** @@ -234,7 +234,7 @@ $$ **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name to be given to the copied circuit, if `None` then the name stays the same. + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – name to be given to the copied circuit, if `None` then the name stays the same. **Returns** @@ -258,7 +258,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if set to True the output inverse gate will be returned as [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). **Returns** @@ -284,8 +284,8 @@ $$ **Parameters** - * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the gate to - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. + * **exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the gate to + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – indicates whether the power gate can be implemented as an annotated operation. In the case of several standard gates, such as [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), this argument is ignored when the power of a gate can be expressed in terms of another standard gate. **Returns** @@ -303,7 +303,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of times to repeat the instruction + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of times to repeat the instruction **Returns** @@ -351,7 +351,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.iqp_function.mdx b/docs/api/qiskit/qiskit.circuit.library.iqp_function.mdx index f1c08154945..2233ff8eaae 100644 --- a/docs/api/qiskit/qiskit.circuit.library.iqp_function.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.iqp_function.mdx @@ -31,7 +31,7 @@ python_api_name: qiskit.circuit.library.iqp **Parameters** - **interactions** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – The interactions as symmetric square matrix. If `None`, then the `num_qubits` argument must be set and a random IQP circuit will be generated. + **interactions** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – The interactions as symmetric square matrix. If `None`, then the `num_qubits` argument must be set and a random IQP circuit will be generated. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.library.n_local.mdx b/docs/api/qiskit/qiskit.circuit.library.n_local.mdx index 13d2f6488e0..9f9e167aa9d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.n_local.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.n_local.mdx @@ -137,17 +137,17 @@ python_api_name: qiskit.circuit.library.n_local **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits of the circuit. - * **rotation\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – The blocks used in the rotation layers. If multiple are passed, these will be applied one after another (like new sub-layers). - * **entanglement\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – The blocks used in the entanglement layers. If multiple are passed, these will be applied one after another. - * **entanglement** (*BlockEntanglement | Iterable\[BlockEntanglement] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*], BlockEntanglement | Iterable\[BlockEntanglement]]*) – The indices specifying on which qubits the input blocks act. This is specified by string describing an entanglement strategy (see the additional info) or a list of qubit connections. If a list of entanglement blocks is passed, different entanglement for each block can be specified by passing a list of entanglements. To specify varying entanglement for each repetition, pass a callable that takes as input the layer and returns the entanglement for that layer. Defaults to `"full"`, meaning an all-to-all entanglement structure. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often the rotation blocks and entanglement blocks are repeated. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used if default parameters are generated. - * **overwrite\_block\_parameters** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If the parameters in the added blocks should be overwritten. If `False`, the parameters in the blocks are not changed. - * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether a final rotation layer is added to the circuit. - * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The name of the circuit. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits of the circuit. + * **rotation\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – The blocks used in the rotation layers. If multiple are passed, these will be applied one after another (like new sub-layers). + * **entanglement\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – The blocks used in the entanglement layers. If multiple are passed, these will be applied one after another. + * **entanglement** (*BlockEntanglement | Iterable\[BlockEntanglement] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*], BlockEntanglement | Iterable\[BlockEntanglement]]*) – The indices specifying on which qubits the input blocks act. This is specified by string describing an entanglement strategy (see the additional info) or a list of qubit connections. If a list of entanglement blocks is passed, different entanglement for each block can be specified by passing a list of entanglements. To specify varying entanglement for each repetition, pass a callable that takes as input the layer and returns the entanglement for that layer. Defaults to `"full"`, meaning an all-to-all entanglement structure. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Specifies how often the rotation blocks and entanglement blocks are repeated. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The prefix used if default parameters are generated. + * **overwrite\_block\_parameters** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If the parameters in the added blocks should be overwritten. If `False`, the parameters in the blocks are not changed. + * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether a final rotation layer is added to the circuit. + * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The name of the circuit. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.library.pauli_feature_map.mdx b/docs/api/qiskit/qiskit.circuit.library.pauli_feature_map.mdx index 1105f7f217d..641453b2166 100644 --- a/docs/api/qiskit/qiskit.circuit.library.pauli_feature_map.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.pauli_feature_map.mdx @@ -98,15 +98,15 @@ $$ **Parameters** - * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Mapping\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Mapping\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]]*) – - * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – - * **paulis** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| Mapping\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*, Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| Mapping\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*, Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]]]*) – + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – + * **paulis** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] | None*) – * **data\_map\_func** (*Callable\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*] | None*) – - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – **Return type** diff --git a/docs/api/qiskit/qiskit.circuit.library.pauli_two_design.mdx b/docs/api/qiskit/qiskit.circuit.library.pauli_two_design.mdx index 8659cc45dc4..66bd016cad8 100644 --- a/docs/api/qiskit/qiskit.circuit.library.pauli_two_design.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.pauli_two_design.mdx @@ -43,12 +43,12 @@ python_api_name: qiskit.circuit.library.pauli_two_design **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits of the Pauli Two-Design circuit. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often a block consisting of a rotation layer and entanglement layer is repeated. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The seed for randomly choosing the axes of the Pauli rotations. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used for the rotation parameters. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The circuit name. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits of the Pauli Two-Design circuit. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Specifies how often a block consisting of a rotation layer and entanglement layer is repeated. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The seed for randomly choosing the axes of the Pauli rotations. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The prefix used for the rotation parameters. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The circuit name. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.library.phase_estimation.mdx b/docs/api/qiskit/qiskit.circuit.library.phase_estimation.mdx index 8212b6d078b..dd60381355e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.phase_estimation.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.phase_estimation.mdx @@ -23,9 +23,9 @@ $$ **Parameters** - * **num\_evaluation\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of evaluation qubits. + * **num\_evaluation\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of evaluation qubits. * **unitary** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – The unitary operation $U$ which will be repeated and controlled. This can either be a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). Passing gates can often be more performant, as it allows calling optimized control and power subroutines. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the output circuit. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the output circuit. **Return type** diff --git a/docs/api/qiskit/qiskit.circuit.library.qaoa_ansatz.mdx b/docs/api/qiskit/qiskit.circuit.library.qaoa_ansatz.mdx index f9fc60e4e5f..0bde334bc71 100644 --- a/docs/api/qiskit/qiskit.circuit.library.qaoa_ansatz.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.qaoa_ansatz.mdx @@ -31,12 +31,12 @@ python_api_name: qiskit.circuit.library.qaoa_ansatz **Parameters** * **cost\_operator** (*BaseOperator*) – The operator representing the cost of the optimization problem, denoted as $U(C, \gamma)$ in \[1]. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The integer determining the depth of the circuit, called $p$ in \[1]. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The integer determining the depth of the circuit, called $p$ in \[1]. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – An optional initial state to use, which defaults to a layer of Hadamard gates preparing the $|+\rangle^{\otimes n}$ state. If a custom mixer is chosen, this circuit should be set to prepare its ground state, to appropriately fulfill the annealing conditions. * **mixer\_operator** (*BaseOperator | None*) – An optional custom mixer, which defaults to global Pauli-$X$ rotations. This is denoted as $U(B, \beta)$ in \[1]. If this is set, the `initial_state` might also require modification. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to insert barriers in-between the cost and mixer operators. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. - * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, a flat circuit is returned instead of nesting it inside multiple layers of gate objects. Setting this to `False` is significantly less performant, especially for parameter binding, but can be desirable for a cleaner visualization. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to insert barriers in-between the cost and mixer operators. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. + * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, a flat circuit is returned instead of nesting it inside multiple layers of gate objects. Setting this to `False` is significantly less performant, especially for parameter binding, but can be desirable for a cleaner visualization. **Return type** diff --git a/docs/api/qiskit/qiskit.circuit.library.quantum_volume.mdx b/docs/api/qiskit/qiskit.circuit.library.quantum_volume.mdx index 1eaed789d3d..c6a06a52b11 100644 --- a/docs/api/qiskit/qiskit.circuit.library.quantum_volume.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.quantum_volume.mdx @@ -21,9 +21,9 @@ python_api_name: qiskit.circuit.library.quantum_volume **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number qubits to use for the generated circuit. - * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of layers for the generated circuit. If this is not specified it will default to `num_qubits` layers. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| np.random.Generator | None*) – An optional RNG seed used for generating the random SU(4) matrices used in the output circuit. This can be either an integer or a numpy generator. If an integer is specfied it must be an value between 0 and 2\*\*64 - 1. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number qubits to use for the generated circuit. + * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of layers for the generated circuit. If this is not specified it will default to `num_qubits` layers. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| np.random.Generator | None*) – An optional RNG seed used for generating the random SU(4) matrices used in the output circuit. This can be either an integer or a numpy generator. If an integer is specfied it must be an value between 0 and 2\*\*64 - 1. **Return type** diff --git a/docs/api/qiskit/qiskit.circuit.library.random_bitwise_xor.mdx b/docs/api/qiskit/qiskit.circuit.library.random_bitwise_xor.mdx index 4c677fcc168..2503f43bcfc 100644 --- a/docs/api/qiskit/qiskit.circuit.library.random_bitwise_xor.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.random_bitwise_xor.mdx @@ -15,8 +15,8 @@ python_api_name: qiskit.circuit.library.random_bitwise_xor **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the width of circuit. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – random seed in case a random xor is requested. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the width of circuit. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – random seed in case a random xor is requested. **Return type** diff --git a/docs/api/qiskit/qiskit.circuit.library.random_iqp.mdx b/docs/api/qiskit/qiskit.circuit.library.random_iqp.mdx index bde4df55519..985788cff9c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.random_iqp.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.random_iqp.mdx @@ -28,8 +28,8 @@ python_api_name: qiskit.circuit.library.random_iqp **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in the circuit. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – A seed for the random number generator, in case the interactions matrix is randomly generated. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in the circuit. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – A seed for the random number generator, in case the interactions matrix is randomly generated. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.library.real_amplitudes.mdx b/docs/api/qiskit/qiskit.circuit.library.real_amplitudes.mdx index 67d630d3e28..238ff2aff80 100644 --- a/docs/api/qiskit/qiskit.circuit.library.real_amplitudes.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.real_amplitudes.mdx @@ -63,14 +63,14 @@ python_api_name: qiskit.circuit.library.real_amplitudes **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits of the RealAmplitudes circuit. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. - * **entanglement** (*BlockEntanglement | Iterable\[BlockEntanglement] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*], BlockEntanglement | Iterable\[BlockEntanglement]]*) – The indices specifying on which qubits the input blocks act. See [`n_local()`](qiskit.circuit.library.n_local "qiskit.circuit.library.n_local") for detailed information. - * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether a final rotation layer is added to the circuit. - * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits. - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the free parameters. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the circuit. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits of the RealAmplitudes circuit. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. + * **entanglement** (*BlockEntanglement | Iterable\[BlockEntanglement] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*], BlockEntanglement | Iterable\[BlockEntanglement]]*) – The indices specifying on which qubits the input blocks act. See [`n_local()`](qiskit.circuit.library.n_local "qiskit.circuit.library.n_local") for detailed information. + * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether a final rotation layer is added to the circuit. + * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, the rotation gates act only on qubits that are entangled. If `False`, the rotation gates act on all qubits. + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the free parameters. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the circuit. **Returns** diff --git a/docs/api/qiskit/qiskit.circuit.library.unitary_overlap.mdx b/docs/api/qiskit/qiskit.circuit.library.unitary_overlap.mdx index e26c11533a9..5a759a01dce 100644 --- a/docs/api/qiskit/qiskit.circuit.library.unitary_overlap.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.unitary_overlap.mdx @@ -45,9 +45,9 @@ $$ * **unitary1** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – Unitary acting on the ket vector. * **unitary2** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – Unitary whose inverse operates on the bra vector. - * **prefix1** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the parameter vector associated to `unitary1`, if it is parameterized. Defaults to `"p1"`. - * **prefix2** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the parameter vector associated to `unitary2`, if it is parameterized. Defaults to `"p2"`. - * **insert\_barrier** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to insert a barrier between the two unitaries. + * **prefix1** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the parameter vector associated to `unitary1`, if it is parameterized. Defaults to `"p1"`. + * **prefix2** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the parameter vector associated to `unitary2`, if it is parameterized. Defaults to `"p2"`. + * **insert\_barrier** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to insert a barrier between the two unitaries. **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.z_feature_map.mdx b/docs/api/qiskit/qiskit.circuit.library.z_feature_map.mdx index 0239983f1bc..30d8e814ee9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.z_feature_map.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.z_feature_map.mdx @@ -72,14 +72,14 @@ python_api_name: qiskit.circuit.library.z_feature_map **Parameters** - * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]*) – - * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]]*) – + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – * **data\_map\_func** (*Callable\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*] | None*) – - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – **Return type** diff --git a/docs/api/qiskit/qiskit.circuit.library.zz_feature_map.mdx b/docs/api/qiskit/qiskit.circuit.library.zz_feature_map.mdx index 1c6c13cfd6f..8e08c02dff3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.zz_feature_map.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.zz_feature_map.mdx @@ -66,14 +66,14 @@ python_api_name: qiskit.circuit.library.zz_feature_map **Parameters** - * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]*) – - * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]]*) – + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – * **data\_map\_func** (*Callable\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*] | None*) – - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – **Return type** diff --git a/docs/api/qiskit/qiskit.dagcircuit.BlockCollapser.mdx b/docs/api/qiskit/qiskit.dagcircuit.BlockCollapser.mdx index 043cf42d367..16762c6dad7 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.BlockCollapser.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.BlockCollapser.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.dagcircuit.BlockCollapser # BlockCollapser - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") This class implements various strategies of consolidating blocks of nodes in a DAG (direct acyclic graph). It works both with the [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") and [`DAGDependency`](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency") DAG representations. diff --git a/docs/api/qiskit/qiskit.dagcircuit.BlockCollector.mdx b/docs/api/qiskit/qiskit.dagcircuit.BlockCollector.mdx index 07aaa3df148..d56adc6bb3b 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.BlockCollector.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.BlockCollector.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.dagcircuit.BlockCollector # BlockCollector - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") This class implements various strategies of dividing a DAG (direct acyclic graph) into blocks of nodes that satisfy certain criteria. It works both with the [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") and [`DAGDependency`](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency") representations of a DAG, where DagDependency takes into account commutativity between nodes. @@ -47,11 +47,11 @@ python_api_name: qiskit.dagcircuit.BlockCollector **Parameters** * **filter\_fn** (*Callable*) – - * **max\_block\_width** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **max\_block\_width** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") | [DAGDepNode](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") | [DAGDepNode](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")] diff --git a/docs/api/qiskit/qiskit.dagcircuit.BlockSplitter.mdx b/docs/api/qiskit/qiskit.dagcircuit.BlockSplitter.mdx index 6610253208a..5b8211ea698 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.BlockSplitter.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.BlockSplitter.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.dagcircuit.BlockSplitter # BlockSplitter - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Splits a block of nodes into sub-blocks over disjoint qubits. The implementation is based on the Disjoint Set Union data structure. diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.mdx b/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.mdx index c31d24896ad..02e8ad29c6b 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit # DAGCircuit - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Quantum circuit as a directed acyclic graph. @@ -253,9 +253,9 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Parameters** * **op** ([*qiskit.circuit.Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – the operation associated with the DAG node - * **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – qubits that op will be applied to - * **cargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – cbits that op will be applied to - * **check** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` (default), this function will enforce that the [`DAGCircuit`](#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") data-structure invariants are maintained (all `qargs` are [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")\ s, all are in the DAG, etc). If `False`, the caller *must* uphold these invariants itself, but the cost of several checks will be skipped. This is most useful when building a new DAG from a source of known-good nodes. + * **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – qubits that op will be applied to + * **cargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – cbits that op will be applied to + * **check** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` (default), this function will enforce that the [`DAGCircuit`](#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") data-structure invariants are maintained (all `qargs` are [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")\ s, all are in the DAG, etc). If `False`, the caller *must* uphold these invariants itself, but the cost of several checks will be skipped. This is most useful when building a new DAG from a source of known-good nodes. **Returns** @@ -278,9 +278,9 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Parameters** * **op** ([*qiskit.circuit.Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – the operation associated with the DAG node - * **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – qubits that op will be applied to - * **cargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – cbits that op will be applied to - * **check** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` (default), this function will enforce that the [`DAGCircuit`](#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") data-structure invariants are maintained (all `qargs` are [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")\ s, all are in the DAG, etc). If `False`, the caller *must* uphold these invariants itself, but the cost of several checks will be skipped. This is most useful when building a new DAG from a source of known-good nodes. + * **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – qubits that op will be applied to + * **cargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – cbits that op will be applied to + * **check** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` (default), this function will enforce that the [`DAGCircuit`](#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") data-structure invariants are maintained (all `qargs` are [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")\ s, all are in the DAG, etc). If `False`, the caller *must* uphold these invariants itself, but the cost of several checks will be skipped. This is most useful when building a new DAG from a source of known-good nodes. **Returns** @@ -347,11 +347,11 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Parameters** * **other** ([*DAGCircuit*](#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – circuit to compose with self - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – qubits of self to compose onto. - * **clbits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – clbits of self to compose onto. - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, front composition will be performed (not implemented yet) - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, modify the object. Otherwise return composed circuit. - * **inline\_captures** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, variables marked as “captures” in the `other` DAG will be inlined onto existing uses of those same variables in `self`. If `False`, all variables in `other` are required to be distinct from `self`, and they will be added to `self`. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – qubits of self to compose onto. + * **clbits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – clbits of self to compose onto. + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, front composition will be performed (not implemented yet) + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, modify the object. Otherwise return composed circuit. + * **inline\_captures** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, variables marked as “captures” in the `other` DAG will be inlined onto existing uses of those same variables in `self`. If `False`, all variables in `other` are required to be distinct from `self`, and they will be added to `self`. **Returns** @@ -377,7 +377,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] ### copy\_empty\_like @@ -416,7 +416,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Return type** - Mapping\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] + Mapping\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")] ### count\_ops\_longest\_path @@ -442,7 +442,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") **Raises** @@ -467,9 +467,9 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Parameters** - * **scale** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – scaling factor - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to (format inferred from name) - * **style** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ‘plain’: B\&W graph; ‘color’ (default): color input/output/op nodes + * **scale** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – scaling factor + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – file path to save image to (format inferred from name) + * **style** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – ‘plain’: B\&W graph; ‘color’ (default): color input/output/op nodes **Returns** @@ -489,7 +489,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Parameters** - **nodes** ([*DAGOpNode*](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")*,* [*DAGInNode*](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")*, or* [*DAGOutNode*](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*(*[*DAGOpNode*](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")*,* [*DAGInNode*](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")*, or* [*DAGOutNode*](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")) – Either a list of nodes or a single input node. If none is specified, all edges are returned from the graph. + **nodes** ([*DAGOpNode*](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")*,* [*DAGInNode*](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")*, or* [*DAGOutNode*](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")*|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*(*[*DAGOpNode*](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")*,* [*DAGInNode*](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")*, or* [*DAGOutNode*](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")) – Either a list of nodes or a single input node. If none is specified, all edges are returned from the graph. **Yields** @@ -541,7 +541,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] ### has\_identifier @@ -581,7 +581,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Parameters** - **ignore** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*(*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*)*) – List of node names to ignore. Default: \[] + **ignore** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*(*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*)*) – List of node names to ignore. Default: \[] **Yields** @@ -709,7 +709,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Parameters** - **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Node identifier. + **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Node identifier. **Returns** @@ -738,7 +738,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Parameters** * **wire** ([*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")) – the wire to be looked at. - * **only\_ops** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – True if only the ops nodes are wanted; otherwise, all nodes are returned. + * **only\_ops** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – True if only the ops nodes are wanted; otherwise, all nodes are returned. **Yields** @@ -781,7 +781,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Parameters** * **op** ([*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")) – [`qiskit.circuit.Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") subclass op nodes to return. If None, return all op nodes. - * **include\_directives** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – include barrier, snapshot etc. + * **include\_directives** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – include barrier, snapshot etc. **Returns** @@ -789,7 +789,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] ### op\_predecessors @@ -957,8 +957,8 @@ python_api_name: qiskit.dagcircuit.DAGCircuit * **node\_block** (*List\[*[*DAGNode*](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")*]*) – A list of dag nodes that represents the node block to be replaced * **op** ([*qiskit.circuit.Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The operation to replace the block with - * **wire\_pos\_map** (*Dict\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The dictionary mapping the bits to their positions in the output `qargs` or `cargs`. This is necessary to reconstruct the arg order over multiple gates in the combined single op node. If a [`Bit`](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit") is not in the dictionary, it will not be added to the args; this can be useful when dealing with control-flow operations that have inherent bits in their `condition` or `target` fields. - * **cycle\_check** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – When set to True this method will check that replacing the provided `node_block` with a single node would introduce a cycle (which would invalidate the `DAGCircuit`) and will raise a `DAGCircuitError` if a cycle would be introduced. This checking comes with a run time penalty. If you can guarantee that your input `node_block` is a contiguous block and won’t introduce a cycle when it’s contracted to a single node, this can be set to `False` to improve the runtime performance of this method. + * **wire\_pos\_map** (*Dict\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The dictionary mapping the bits to their positions in the output `qargs` or `cargs`. This is necessary to reconstruct the arg order over multiple gates in the combined single op node. If a [`Bit`](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit") is not in the dictionary, it will not be added to the args; this can be useful when dealing with control-flow operations that have inherent bits in their `condition` or `target` fields. + * **cycle\_check** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – When set to True this method will check that replacing the provided `node_block` with a single node would introduce a cycle (which would invalidate the `DAGCircuit`) and will raise a `DAGCircuitError` if a cycle would be introduced. This checking comes with a run time penalty. If you can guarantee that your input `node_block` is a contiguous block and won’t introduce a cycle when it’s contracted to a single node, this can be set to `False` to improve the runtime performance of this method. **Raises** @@ -994,7 +994,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Parameters** - **remove\_idle\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Flag denoting whether to remove idle qubits from the separated circuits. If `False`, each output circuit will contain the same number of qubits as `self`. + **remove\_idle\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Flag denoting whether to remove idle qubits from the separated circuits. If `False`, each output circuit will contain the same number of qubits as `self`. **Returns** @@ -1032,7 +1032,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") **Raises** @@ -1070,8 +1070,8 @@ python_api_name: qiskit.dagcircuit.DAGCircuit * **node** ([*DAGOpNode*](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")) – Node to be replaced * **op** ([*qiskit.circuit.Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The [`qiskit.circuit.Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") instance to be added to the DAG - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Optional, default False. If True, existing DAG node will be modified to include op. Otherwise, a new DAG node will be used. - * **propagate\_condition** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – DEPRECATED a legacy option that used to control the behavior of handling control flow. It has no effect anymore, left it for backwards compatibility. Will be removed in Qiskit 3.0. + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Optional, default False. If True, existing DAG node will be modified to include op. Otherwise, a new DAG node will be used. + * **propagate\_condition** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – DEPRECATED a legacy option that used to control the behavior of handling control flow. It has no effect anymore, left it for backwards compatibility. Will be removed in Qiskit 3.0. **Returns** @@ -1096,8 +1096,8 @@ python_api_name: qiskit.dagcircuit.DAGCircuit * **node** ([*DAGOpNode*](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")) – node to substitute * **input\_dag** ([*DAGCircuit*](#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – circuit that will substitute the node - * **wires** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*] | Dict\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*,* [*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – gives an order for (qu)bits in the input circuit. If a list, then the bits refer to those in the `input_dag`, and the order gets matched to the node wires by qargs first, then cargs, then conditions. If a dictionary, then a mapping of bits in the `input_dag` to those that the `node` acts on. - * **propagate\_condition** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – DEPRECATED a legacy option that used to control the behavior of handling control flow. It has no effect anymore, left it for backwards compatibility. Will be removed in Qiskit 3.0. + * **wires** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*] | Dict\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*,* [*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – gives an order for (qu)bits in the input circuit. If a list, then the bits refer to those in the `input_dag`, and the order gets matched to the node wires by qargs first, then cargs, then conditions. If a dictionary, then a mapping of bits in the `input_dag` to those that the `node` acts on. + * **propagate\_condition** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – DEPRECATED a legacy option that used to control the behavior of handling control flow. It has no effect anymore, left it for backwards compatibility. Will be removed in Qiskit 3.0. **Returns** @@ -1105,7 +1105,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") **Raises** diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.mdx index d99c9cac580..015c10cd6ad 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode # DAGDepNode - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Object to represent the information at a node in the DAGDependency(). @@ -19,14 +19,14 @@ python_api_name: qiskit.dagcircuit.DAGDepNode **Parameters** - * **successors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – - * **predecessors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – - * **matchedwith** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – - * **successorstovisit** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – - * **isblocked** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – - * **qindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – - * **cindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – - * **nid** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **successors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – + * **predecessors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – + * **matchedwith** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – + * **successorstovisit** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – + * **isblocked** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – + * **qindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – + * **cindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – + * **nid** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – ### type diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.mdx b/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.mdx index 285b313157d..c9b39569804 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency # DAGDependency - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Object to represent a quantum circuit as a Directed Acyclic Graph (DAG) via operation dependencies (i.e. lack of commutation). @@ -67,8 +67,8 @@ python_api_name: qiskit.dagcircuit.DAGDependency **Parameters** * **operation** ([*qiskit.circuit.Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – operation as a quantum gate - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of qubits on which the operation acts - * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – list of classical wires to attach to + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of qubits on which the operation acts + * **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – list of classical wires to attach to ### add\_qreg @@ -102,7 +102,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency **Parameters** - **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – label of considered node. + **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – label of considered node. **Returns** @@ -120,7 +120,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency **Parameters** - **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – label of considered node. + **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – label of considered node. **Returns** @@ -140,9 +140,9 @@ python_api_name: qiskit.dagcircuit.DAGDependency **Parameters** - * **scale** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – scaling factor - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to (format inferred from name) - * **style** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ‘plain’: B\&W graph ‘color’ (default): color input/output/op nodes + * **scale** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – scaling factor + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – file path to save image to (format inferred from name) + * **style** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – ‘plain’: B\&W graph ‘color’ (default): color input/output/op nodes **Returns** @@ -174,8 +174,8 @@ python_api_name: qiskit.dagcircuit.DAGDependency **Parameters** - * **src\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – label of the first node. - * **dest\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – label of the second node. + * **src\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – label of the first node. + * **dest\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – label of the second node. **Returns** @@ -193,7 +193,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency **Parameters** - **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – label of considered node. + **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – label of considered node. **Returns** @@ -209,7 +209,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency **Parameters** - **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – label of considered node. + **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – label of considered node. **Returns** @@ -229,7 +229,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency **Return type** - generator([dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) + generator([dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) ### get\_out\_edges @@ -239,7 +239,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency **Parameters** - **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – label of considered node. + **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – label of considered node. **Returns** @@ -257,7 +257,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency **Parameters** - **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – label of considered node. + **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – label of considered node. **Returns** @@ -281,8 +281,8 @@ python_api_name: qiskit.dagcircuit.DAGDependency * **node\_block** (*List\[*[*DAGDepNode*](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")*]*) – A list of dag nodes that represents the node block to be replaced * **op** ([*qiskit.circuit.Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The operation to replace the block with - * **wire\_pos\_map** (*Dict\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The dictionary mapping the qarg to the position. This is necessary to reconstruct the qarg order over multiple gates in the combined single op node. - * **cycle\_check** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – When set to True this method will check that replacing the provided `node_block` with a single node would introduce a cycle (which would invalidate the `DAGDependency`) and will raise a `DAGDependencyError` if a cycle would be introduced. This checking comes with a run time penalty. If you can guarantee that your input `node_block` is a contiguous block and won’t introduce a cycle when it’s contracted to a single node, this can be set to `False` to improve the runtime performance of this method. + * **wire\_pos\_map** (*Dict\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The dictionary mapping the qarg to the position. This is necessary to reconstruct the qarg order over multiple gates in the combined single op node. + * **cycle\_check** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – When set to True this method will check that replacing the provided `node_block` with a single node would introduce a cycle (which would invalidate the `DAGDependency`) and will raise a `DAGDependencyError` if a cycle would be introduced. This checking comes with a run time penalty. If you can guarantee that your input `node_block` is a contiguous block and won’t introduce a cycle when it’s contracted to a single node, this can be set to `False` to improve the runtime performance of this method. **Raises** @@ -302,7 +302,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency **Parameters** - **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – label of considered node. + **node\_id** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – label of considered node. **Returns** diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGNode.mdx b/docs/api/qiskit/qiskit.dagcircuit.DAGNode.mdx index c940cc61986..88ab8cf51d2 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGNode.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGNode.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.dagcircuit.DAGNode # DAGNode - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Parent class for DAGOpNode, DAGInNode, and DAGOutNode. diff --git a/docs/api/qiskit/qiskit.passmanager.BaseController.mdx b/docs/api/qiskit/qiskit.passmanager.BaseController.mdx index 6d82685c349..bb693f0c7f9 100644 --- a/docs/api/qiskit/qiskit.passmanager.BaseController.mdx +++ b/docs/api/qiskit/qiskit.passmanager.BaseController.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.passmanager.BaseController # BaseController - Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Base class of controller. @@ -19,7 +19,7 @@ python_api_name: qiskit.passmanager.BaseController **Parameters** - **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Any] | None*) – Option for this flow controller. ## Methods @@ -30,9 +30,9 @@ python_api_name: qiskit.passmanager.BaseController **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,7 +40,7 @@ python_api_name: qiskit.passmanager.BaseController **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### iter\_tasks @@ -61,7 +61,7 @@ python_api_name: qiskit.passmanager.BaseController **Return type** - [*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.13)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] + [*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.14)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] diff --git a/docs/api/qiskit/qiskit.passmanager.BasePassManager.mdx b/docs/api/qiskit/qiskit.passmanager.BasePassManager.mdx index 1d351948d6c..2980c346a61 100644 --- a/docs/api/qiskit/qiskit.passmanager.BasePassManager.mdx +++ b/docs/api/qiskit/qiskit.passmanager.BasePassManager.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.passmanager.BasePassManager # BasePassManager - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Pass manager base class. @@ -17,8 +17,8 @@ python_api_name: qiskit.passmanager.BasePassManager **Parameters** - * **tasks** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[Task]*) – A pass set to be added to the pass manager schedule. - * **max\_iteration** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The maximum number of iterations the schedule will be looped if the condition is not met. + * **tasks** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[Task]*) – A pass set to be added to the pass manager schedule. + * **max\_iteration** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The maximum number of iterations the schedule will be looped if the condition is not met. ## Methods @@ -29,11 +29,11 @@ python_api_name: qiskit.passmanager.BasePassManager **Parameters** - **tasks** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[Task]*) – A set of pass manager tasks to be added to schedule. + **tasks** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[Task]*) – A set of pass manager tasks to be added to schedule. **Raises** - [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – When any element of tasks is not a subclass of passmanager Task. + [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – When any element of tasks is not a subclass of passmanager Task. **Return type** @@ -47,7 +47,7 @@ python_api_name: qiskit.passmanager.BasePassManager **Parameters** - **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Pass index to remove, based on the position in `passes()`. + **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Pass index to remove, based on the position in `passes()`. **Raises** @@ -65,12 +65,12 @@ python_api_name: qiskit.passmanager.BasePassManager **Parameters** - * **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Task index to replace, based on the position in `tasks()` - * **tasks** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[Task]*) – A set of pass manager tasks to be added to schedule. + * **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Task index to replace, based on the position in `tasks()` + * **tasks** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[Task]*) – A set of pass manager tasks to be added to schedule. **Raises** - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – When any element of tasks is not a subclass of passmanager Task. + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – When any element of tasks is not a subclass of passmanager Task. * [**PassManagerError**](passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.PassManagerError") – If the index is not found. **Return type** @@ -85,7 +85,7 @@ python_api_name: qiskit.passmanager.BasePassManager **Parameters** - * **in\_programs** (*Any |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[Any]*) – Input programs to transform via all the registered passes. A single input object cannot be a Python builtin list object. A list object is considered as multiple input objects to optimize. + * **in\_programs** (*Any |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[Any]*) – Input programs to transform via all the registered passes. A single input object cannot be a Python builtin list object. A list object is considered as multiple input objects to optimize. * **callback** (*Callable*) – @@ -113,9 +113,9 @@ python_api_name: qiskit.passmanager.BasePassManager ... ``` - * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The maximum number of parallel processes to launch if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. + * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The maximum number of parallel processes to launch if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. - * **property\_set** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*object*](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)")*] | None*) – If given, the initial value to use as the [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") for the pass manager pipeline. This can be used to persist analysis from one run to another, in cases where you know the analysis is safe to share. Beware that some analysis will be specific to the input circuit and the particular [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target"), so you should take a lot of care when using this argument. + * **property\_set** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*object*](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)")*] | None*) – If given, the initial value to use as the [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") for the pass manager pipeline. This can be used to persist analysis from one run to another, in cases where you know the analysis is safe to share. Beware that some analysis will be specific to the input circuit and the particular [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target"), so you should take a lot of care when using this argument. * **kwargs** – Arbitrary arguments passed to the compiler frontend and backend. diff --git a/docs/api/qiskit/qiskit.passmanager.ConditionalController.mdx b/docs/api/qiskit/qiskit.passmanager.ConditionalController.mdx index b729e5c4fbf..6d23b5ed560 100644 --- a/docs/api/qiskit/qiskit.passmanager.ConditionalController.mdx +++ b/docs/api/qiskit/qiskit.passmanager.ConditionalController.mdx @@ -17,9 +17,9 @@ python_api_name: qiskit.passmanager.ConditionalController **Parameters** - * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Any] | None*) – Option for this flow controller. * **tasks** (*Task | Iterable\[Task]*) – - * **condition** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]*) – + * **condition** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*]*) – ## Attributes @@ -38,9 +38,9 @@ python_api_name: qiskit.passmanager.ConditionalController **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -48,7 +48,7 @@ python_api_name: qiskit.passmanager.ConditionalController **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### iter\_tasks @@ -69,7 +69,7 @@ python_api_name: qiskit.passmanager.ConditionalController **Return type** - [*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.13)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] + [*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.14)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] diff --git a/docs/api/qiskit/qiskit.passmanager.DoWhileController.mdx b/docs/api/qiskit/qiskit.passmanager.DoWhileController.mdx index e73942bb6fd..6e16f370f7b 100644 --- a/docs/api/qiskit/qiskit.passmanager.DoWhileController.mdx +++ b/docs/api/qiskit/qiskit.passmanager.DoWhileController.mdx @@ -19,9 +19,9 @@ python_api_name: qiskit.passmanager.DoWhileController **Parameters** - * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Any] | None*) – Option for this flow controller. * **tasks** (*Task | Iterable\[Task]*) – - * **do\_while** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]*) – + * **do\_while** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*]*) – ## Attributes @@ -40,9 +40,9 @@ python_api_name: qiskit.passmanager.DoWhileController **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.passmanager.DoWhileController **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### iter\_tasks @@ -71,7 +71,7 @@ python_api_name: qiskit.passmanager.DoWhileController **Return type** - [*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.13)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] + [*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.14)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] diff --git a/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.mdx b/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.mdx index 3603de32e0b..5db6574b7d4 100644 --- a/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.mdx +++ b/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear **Parameters** - * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Any] | None*) – Option for this flow controller. * **tasks** (*Task | Iterable\[Task]*) – ## Attributes @@ -37,9 +37,9 @@ python_api_name: qiskit.passmanager.FlowControllerLinear **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -47,7 +47,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### iter\_tasks @@ -68,7 +68,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear **Return type** - [*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.13)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] + [*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.14)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] diff --git a/docs/api/qiskit/qiskit.passmanager.GenericPass.mdx b/docs/api/qiskit/qiskit.passmanager.GenericPass.mdx index fdd8f9b619c..2ac5e07e2a1 100644 --- a/docs/api/qiskit/qiskit.passmanager.GenericPass.mdx +++ b/docs/api/qiskit/qiskit.passmanager.GenericPass.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.passmanager.GenericPass # GenericPass - Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Base class of a single pass manager task. @@ -24,9 +24,9 @@ python_api_name: qiskit.passmanager.GenericPass **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -34,7 +34,7 @@ python_api_name: qiskit.passmanager.GenericPass **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -44,7 +44,7 @@ python_api_name: qiskit.passmanager.GenericPass **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run @@ -54,7 +54,7 @@ python_api_name: qiskit.passmanager.GenericPass **Parameters** - **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.passmanager.GenericPass **Return type** - [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)") + [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)") ### update\_status diff --git a/docs/api/qiskit/qiskit.passmanager.PassManagerState.mdx b/docs/api/qiskit/qiskit.passmanager.PassManagerState.mdx index c324d6d6022..8d46fe04457 100644 --- a/docs/api/qiskit/qiskit.passmanager.PassManagerState.mdx +++ b/docs/api/qiskit/qiskit.passmanager.PassManagerState.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.passmanager.PassManagerState # PassManagerState - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A portable container object that pass manager tasks communicate through generator. diff --git a/docs/api/qiskit/qiskit.passmanager.PropertySet.mdx b/docs/api/qiskit/qiskit.passmanager.PropertySet.mdx index fcd07f9cab2..2c713997c38 100644 --- a/docs/api/qiskit/qiskit.passmanager.PropertySet.mdx +++ b/docs/api/qiskit/qiskit.passmanager.PropertySet.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.passmanager.PropertySet # PropertySet - Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") A default dictionary-like object. diff --git a/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.mdx b/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.mdx index d83d8ac4f61..3308d22d33d 100644 --- a/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.mdx +++ b/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.passmanager.WorkflowStatus # WorkflowStatus - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Collection of compilation status of workflow, i.e. pass manager run. @@ -19,8 +19,8 @@ python_api_name: qiskit.passmanager.WorkflowStatus **Parameters** - * **count** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – - * **completed\_passes** ([*set*](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)")) – + * **count** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **completed\_passes** ([*set*](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.14)")) – * **previous\_run** (*RunState*) – ### count diff --git a/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2.mdx b/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2.mdx index b448cd4c609..a925e939252 100644 --- a/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2.mdx +++ b/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2.mdx @@ -38,7 +38,7 @@ $$ **Parameters** * **backend** ([*BackendV2*](qiskit.providers.BackendV2 "qiskit.providers.BackendV2")) – The backend to run the primitive on. - * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – The options to control the default precision (`default_precision`), the operator grouping (`abelian_grouping`), and the random seed for the simulator (`seed_simulator`). + * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *| None*) – The options to control the default precision (`default_precision`), the operator grouping (`abelian_grouping`), and the random seed for the simulator (`seed_simulator`). ## Attributes @@ -64,7 +64,7 @@ $$ **Parameters** * **pubs** (*Iterable\[EstimatorPubLike]*) – An iterable of pub-like objects, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`. - * **precision** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – The target precision for expectation value estimates of each run Estimator Pub that does not specify its own precision. If None the estimator’s default precision value will be used. + * **precision** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – The target precision for expectation value estimates of each run Estimator Pub that does not specify its own precision. If None the estimator’s default precision value will be used. **Returns** diff --git a/docs/api/qiskit/qiskit.primitives.BackendSamplerV2.mdx b/docs/api/qiskit/qiskit.primitives.BackendSamplerV2.mdx index 19213be04f5..d39706ad9b0 100644 --- a/docs/api/qiskit/qiskit.primitives.BackendSamplerV2.mdx +++ b/docs/api/qiskit/qiskit.primitives.BackendSamplerV2.mdx @@ -32,7 +32,7 @@ python_api_name: qiskit.primitives.BackendSamplerV2 **Parameters** * **backend** ([*BackendV2*](qiskit.providers.BackendV2 "qiskit.providers.BackendV2")) – The backend to run the primitive on. - * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – The options to control the default shots (`default_shots`) and the random seed for the simulator (`seed_simulator`). + * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *| None*) – The options to control the default shots (`default_shots`) and the random seed for the simulator (`seed_simulator`). ## Attributes @@ -58,7 +58,7 @@ python_api_name: qiskit.primitives.BackendSamplerV2 **Parameters** * **pubs** (*Iterable\[SamplerPubLike]*) – An iterable of pub-like objects. For example, a list of circuits or tuples `(circuit, parameter_values)`. - * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The total number of shots to sample for each sampler pub that does not specify its own shots. If `None`, the primitive’s default shots value will be used, which can vary by implementation. + * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The total number of shots to sample for each sampler pub that does not specify its own shots. If `None`, the primitive’s default shots value will be used, which can vary by implementation. **Returns** diff --git a/docs/api/qiskit/qiskit.primitives.BaseEstimatorV1.mdx b/docs/api/qiskit/qiskit.primitives.BaseEstimatorV1.mdx index 57814abdbcd..323ae804f83 100644 --- a/docs/api/qiskit/qiskit.primitives.BaseEstimatorV1.mdx +++ b/docs/api/qiskit/qiskit.primitives.BaseEstimatorV1.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV1 # BaseEstimatorV1 - Bases: `BasePrimitiveV1`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.13)")\[`T`] + Bases: `BasePrimitiveV1`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.14)")\[`T`] Base class for `EstimatorV1` implementations. @@ -68,7 +68,7 @@ $$ **Parameters** - **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – Default options. + **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *| None*) – Default options. ## Attributes @@ -110,8 +110,8 @@ $$ **Parameters** * **circuits** (*Sequence\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] |* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – one or more circuit objects. - * **observables** (*Sequence\[BaseOperator |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | BaseOperator |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – one or more observable objects. Several formats are allowed; importantly, `str` should follow the string representation format for [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") objects. - * **parameter\_values** (*Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]] | Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] |* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – concrete parameters to be bound. + * **observables** (*Sequence\[BaseOperator |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] | BaseOperator |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – one or more observable objects. Several formats are allowed; importantly, `str` should follow the string representation format for [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") objects. + * **parameter\_values** (*Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]] | Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] |* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – concrete parameters to be bound. * **run\_options** – runtime options used for circuit execution. **Returns** @@ -120,8 +120,8 @@ $$ **Raises** - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – Invalid argument type given. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – Invalid argument values given. + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – Invalid argument type given. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – Invalid argument values given. **Return type** diff --git a/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2.mdx b/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2.mdx index 8a9ba204173..092fe810468 100644 --- a/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2.mdx +++ b/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV2 # BaseEstimatorV2 - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Base class for `EstimatorV2` implementations. @@ -46,7 +46,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV2 **Parameters** * **pubs** (*Iterable\[EstimatorPubLike]*) – An iterable of pub-like objects, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`. - * **precision** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – The target precision for expectation value estimates of each run Estimator Pub that does not specify its own precision. If None the estimator’s default precision value will be used. + * **precision** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – The target precision for expectation value estimates of each run Estimator Pub that does not specify its own precision. If None the estimator’s default precision value will be used. **Returns** diff --git a/docs/api/qiskit/qiskit.primitives.BasePrimitiveJob.mdx b/docs/api/qiskit/qiskit.primitives.BasePrimitiveJob.mdx index 4a0f2304344..4fb285a732c 100644 --- a/docs/api/qiskit/qiskit.primitives.BasePrimitiveJob.mdx +++ b/docs/api/qiskit/qiskit.primitives.BasePrimitiveJob.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob # BasePrimitiveJob - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)"), [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.13)")\[`ResultT`, `StatusT`] + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)"), [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.14)")\[`ResultT`, `StatusT`] Primitive job abstract base class. @@ -17,7 +17,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob **Parameters** - * **job\_id** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A unique id in the context of the primitive used to run the job. + * **job\_id** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – A unique id in the context of the primitive used to run the job. * **kwargs** – Any key value metadata to associate with this job. ## Methods @@ -35,7 +35,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### done @@ -45,7 +45,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### in\_final\_state @@ -55,7 +55,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### job\_id @@ -65,7 +65,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### result @@ -85,7 +85,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### status diff --git a/docs/api/qiskit/qiskit.primitives.BaseSamplerV1.mdx b/docs/api/qiskit/qiskit.primitives.BaseSamplerV1.mdx index 996df6ddd97..9e12f6f6187 100644 --- a/docs/api/qiskit/qiskit.primitives.BaseSamplerV1.mdx +++ b/docs/api/qiskit/qiskit.primitives.BaseSamplerV1.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.primitives.BaseSamplerV1 # BaseSamplerV1 - Bases: `BasePrimitiveV1`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.13)")\[`T`] + Bases: `BasePrimitiveV1`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.14)")\[`T`] Sampler V1 base class @@ -67,7 +67,7 @@ python_api_name: qiskit.primitives.BaseSamplerV1 **Parameters** - **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – Default options. + **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *| None*) – Default options. ## Attributes @@ -91,7 +91,7 @@ python_api_name: qiskit.primitives.BaseSamplerV1 **Parameters** * **circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| Sequence\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – One of more circuit objects. - * **parameter\_values** (*Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]] | None*) – Parameters to be bound to the circuit. + * **parameter\_values** (*Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]] | None*) – Parameters to be bound to the circuit. * **run\_options** – Backend runtime options used for circuit execution. **Returns** @@ -100,7 +100,7 @@ python_api_name: qiskit.primitives.BaseSamplerV1 **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – Invalid arguments are given. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – Invalid arguments are given. **Return type** diff --git a/docs/api/qiskit/qiskit.primitives.BaseSamplerV2.mdx b/docs/api/qiskit/qiskit.primitives.BaseSamplerV2.mdx index f0756a93b8c..5e91813af56 100644 --- a/docs/api/qiskit/qiskit.primitives.BaseSamplerV2.mdx +++ b/docs/api/qiskit/qiskit.primitives.BaseSamplerV2.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.primitives.BaseSamplerV2 # BaseSamplerV2 - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Base class for `SamplerV2` implementations. @@ -39,7 +39,7 @@ python_api_name: qiskit.primitives.BaseSamplerV2 **Parameters** * **pubs** (*Iterable\[SamplerPubLike]*) – An iterable of pub-like objects. For example, a list of circuits or tuples `(circuit, parameter_values)`. - * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The total number of shots to sample for each sampler pub that does not specify its own shots. If `None`, the primitive’s default shots value will be used, which can vary by implementation. + * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The total number of shots to sample for each sampler pub that does not specify its own shots. If `None`, the primitive’s default shots value will be used, which can vary by implementation. **Returns** diff --git a/docs/api/qiskit/qiskit.primitives.BitArray.mdx b/docs/api/qiskit/qiskit.primitives.BitArray.mdx index 779f5a9f191..170c2921ac0 100644 --- a/docs/api/qiskit/qiskit.primitives.BitArray.mdx +++ b/docs/api/qiskit/qiskit.primitives.BitArray.mdx @@ -18,12 +18,12 @@ python_api_name: qiskit.primitives.BitArray **Parameters** * **array** (*NDArray\[np.uint8]*) – The `uint8` data array. - * **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – How many bit are in each outcome. + * **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – How many bit are in each outcome. **Raises** - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If the input is not a NumPy array with type `numpy.uint8`. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the input array has fewer than two axes, or the size of the last axis is not the smallest number of bytes that can contain `num_bits`. + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If the input is not a NumPy array with type `numpy.uint8`. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the input array has fewer than two axes, or the size of the last axis is not the smallest number of bytes that can contain `num_bits`. ## Attributes @@ -74,7 +74,7 @@ python_api_name: qiskit.primitives.BitArray **Return type** - [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")\[*uint64*]] + [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")\[*uint64*]] ### concatenate @@ -84,8 +84,8 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - * **bit\_arrays** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*BitArray*](#qiskit.primitives.BitArray "qiskit.primitives.containers.bit_array.BitArray")*]*) – The bit arrays must have (1) the same number of bits, (2) the same number of shots, and (3) the same shape, except in the dimension corresponding to axis (the first, by default). - * **axis** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The axis along which the arrays will be joined. Default is 0. + * **bit\_arrays** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*BitArray*](#qiskit.primitives.BitArray "qiskit.primitives.containers.bit_array.BitArray")*]*) – The bit arrays must have (1) the same number of bits, (2) the same number of shots, and (3) the same shape, except in the dimension corresponding to axis (the first, by default). + * **axis** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The axis along which the arrays will be joined. Default is 0. **Returns** @@ -93,10 +93,10 @@ python_api_name: qiskit.primitives.BitArray **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the sequence of bit arrays is empty. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If any bit arrays has a different number of bits. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If any bit arrays has a different number of shots. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If any bit arrays has a different number of dimensions. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the sequence of bit arrays is empty. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If any bit arrays has a different number of bits. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If any bit arrays has a different number of shots. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If any bit arrays has a different number of dimensions. **Return type** @@ -114,7 +114,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - **bit\_arrays** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*BitArray*](#qiskit.primitives.BitArray "qiskit.primitives.containers.bit_array.BitArray")*]*) – Bit arrays that have (1) the same number of shots, and (2) the same shape. + **bit\_arrays** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*BitArray*](#qiskit.primitives.BitArray "qiskit.primitives.containers.bit_array.BitArray")*]*) – Bit arrays that have (1) the same number of shots, and (2) the same shape. **Returns** @@ -122,9 +122,9 @@ python_api_name: qiskit.primitives.BitArray **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the sequence of bit arrays is empty. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If any bit arrays has a different number of shots. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If any bit arrays has a different shape. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the sequence of bit arrays is empty. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If any bit arrays has a different number of shots. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If any bit arrays has a different shape. **Return type** @@ -138,7 +138,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - **bit\_arrays** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*BitArray*](#qiskit.primitives.BitArray "qiskit.primitives.containers.bit_array.BitArray")*]*) – The bit arrays must have (1) the same number of bits, and (2) the same shape. + **bit\_arrays** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*BitArray*](#qiskit.primitives.BitArray "qiskit.primitives.containers.bit_array.BitArray")*]*) – The bit arrays must have (1) the same number of bits, and (2) the same shape. **Returns** @@ -146,9 +146,9 @@ python_api_name: qiskit.primitives.BitArray **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the sequence of bit arrays is empty. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If any bit arrays has a different number of bits. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If any bit arrays has a different shape. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the sequence of bit arrays is empty. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If any bit arrays has a different number of bits. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If any bit arrays has a different shape. **Return type** @@ -166,7 +166,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - **observables** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp") *|*[*SparseObservable*](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") *|*[*Mapping*](https://docs.python.org/3/library/typing.html#typing.Mapping "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | \_SupportsArray\[*[*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*]] | \_NestedSequence\[\_SupportsArray\[*[*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*]]] |* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *|*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)") *|*[*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes "(in Python v3.13)") *| \_NestedSequence\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *|*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes "(in Python v3.13)")*]*) – The observable(s) to take the expectation value of. Must have a shape broadcastable with with this bit array and the same number of qubits as the number of bits of this bit array. The observables must be diagonal (I, Z, 0 or 1) too. + **observables** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp") *|*[*SparseObservable*](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") *|*[*Mapping*](https://docs.python.org/3/library/typing.html#typing.Mapping "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | \_SupportsArray\[*[*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")*]] | \_NestedSequence\[\_SupportsArray\[*[*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")*]]] |* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *|*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)") *|*[*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes "(in Python v3.14)") *| \_NestedSequence\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *|*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes "(in Python v3.14)")*]*) – The observable(s) to take the expectation value of. Must have a shape broadcastable with with this bit array and the same number of qubits as the number of bits of this bit array. The observables must be diagonal (I, Z, 0 or 1) too. **Returns** @@ -174,13 +174,13 @@ python_api_name: qiskit.primitives.BitArray **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the provided observables does not have a shape broadcastable with this bit array. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the provided observables does not have the same number of qubits as the number of bits of this bit array. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the provided observables are not diagonal. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the provided observables does not have a shape broadcastable with this bit array. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the provided observables does not have the same number of qubits as the number of bits of this bit array. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the provided observables are not diagonal. **Return type** - [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")\[*float64*]] + [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")\[*float64*]] ### from\_bool\_array @@ -190,8 +190,8 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - * **array** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*,* [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")*\[bool\_]]*) – The array to convert, with “bitstrings” along the last axis. - * **order** ([*Literal*](https://docs.python.org/3/library/typing.html#typing.Literal "(in Python v3.13)")*\['big', 'little']*) – One of `"big"` or `"little"`, indicating whether `array[..., 0]` correspond to the most significant bits or the least significant bits of each bitstring, respectively. + * **array** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")*,* [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")*\[bool\_]]*) – The array to convert, with “bitstrings” along the last axis. + * **order** ([*Literal*](https://docs.python.org/3/library/typing.html#typing.Literal "(in Python v3.14)")*\['big', 'little']*) – One of `"big"` or `"little"`, indicating whether `array[..., 0]` correspond to the most significant bits or the least significant bits of each bitstring, respectively. **Returns** @@ -211,8 +211,8 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - * **counts** (*Mapping\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | Iterable\[Mapping\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – One or more counts-like mappings with the same number of shots. - * **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The desired number of bits per shot. If unset, the biggest value found sets this value, with a minimum of one bit. + * **counts** (*Mapping\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | Iterable\[Mapping\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – One or more counts-like mappings with the same number of shots. + * **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The desired number of bits per shot. If unset, the biggest value found sets this value, with a minimum of one bit. **Returns** @@ -220,8 +220,8 @@ python_api_name: qiskit.primitives.BitArray **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If different mappings have different numbers of shots. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If no counts dictionaries are supplied. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If different mappings have different numbers of shots. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If no counts dictionaries are supplied. **Return type** @@ -239,8 +239,8 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - * **samples** (*Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – A list of bitstrings, a list of integers, or a list of hexstrings. - * **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The desired number of bits per sample. If unset, the biggest sample provided is used to determine this value, with a minimum of one bit. + * **samples** (*Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] | Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – A list of bitstrings, a list of integers, or a list of hexstrings. + * **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The desired number of bits per sample. If unset, the biggest sample provided is used to determine this value, with a minimum of one bit. **Returns** @@ -248,7 +248,7 @@ python_api_name: qiskit.primitives.BitArray **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If no strings are given. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If no strings are given. **Return type** @@ -262,7 +262,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - **loc** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, ...] | None*) – Which entry of this array to return a dictionary for. If `None`, counts from all positions in this array are unioned together. + **loc** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*, ...] | None*) – Which entry of this array to return a dictionary for. If `None`, counts from all positions in this array are unioned together. **Returns** @@ -270,7 +270,7 @@ python_api_name: qiskit.primitives.BitArray **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")] ### get\_counts @@ -280,7 +280,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - **loc** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, ...] | None*) – Which entry of this array to return a dictionary for. If `None`, counts from all positions in this array are unioned together. + **loc** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*, ...] | None*) – Which entry of this array to return a dictionary for. If `None`, counts from all positions in this array are unioned together. **Returns** @@ -288,7 +288,7 @@ python_api_name: qiskit.primitives.BitArray **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")] ### get\_int\_counts @@ -298,7 +298,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - **loc** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, ...] | None*) – Which entry of this array to return a dictionary for. If `None`, counts from all positions in this array are unioned together. + **loc** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*, ...] | None*) – Which entry of this array to return a dictionary for. If `None`, counts from all positions in this array are unioned together. **Returns** @@ -306,7 +306,7 @@ python_api_name: qiskit.primitives.BitArray **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")] ### postselect @@ -320,8 +320,8 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - * **indices** (*Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] |* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – A list of the indices of the cbits on which to postselect. If this bit array was produced by a sampler, then an index `i` corresponds to the [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") location `creg[i]` (as in [`slice_bits()`](#qiskit.primitives.BitArray.slice_bits "qiskit.primitives.BitArray.slice_bits")). Negative indices are allowed. - * **selection** (*Sequence\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] |* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – A list of binary values (will be cast to `bool`) of length matching `indices`, with `indices[i]` corresponding to `selection[i]`. Shots will be discarded unless all cbits specified by `indices` have the values given by `selection`. + * **indices** (*Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] |* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – A list of the indices of the cbits on which to postselect. If this bit array was produced by a sampler, then an index `i` corresponds to the [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") location `creg[i]` (as in [`slice_bits()`](#qiskit.primitives.BitArray.slice_bits "qiskit.primitives.BitArray.slice_bits")). Negative indices are allowed. + * **selection** (*Sequence\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] |* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – A list of binary values (will be cast to `bool`) of length matching `indices`, with `indices[i]` corresponding to `selection[i]`. Shots will be discarded unless all cbits specified by `indices` have the values given by `selection`. **Returns** @@ -329,9 +329,9 @@ python_api_name: qiskit.primitives.BitArray **Raises** - * [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.13)") – If `max(indices)` is greater than or equal to [`num_bits`](#qiskit.primitives.BitArray.num_bits "qiskit.primitives.BitArray.num_bits"). - * [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.13)") – If `min(indices)` is less than negative [`num_bits`](#qiskit.primitives.BitArray.num_bits "qiskit.primitives.BitArray.num_bits"). - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the lengths of `selection` and `indices` do not match. + * [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.14)") – If `max(indices)` is greater than or equal to [`num_bits`](#qiskit.primitives.BitArray.num_bits "qiskit.primitives.BitArray.num_bits"). + * [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.14)") – If `min(indices)` is less than negative [`num_bits`](#qiskit.primitives.BitArray.num_bits "qiskit.primitives.BitArray.num_bits"). + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the lengths of `selection` and `indices` do not match. **Return type** @@ -347,7 +347,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - **\*shape** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Iterable\[ShapeInput]]*) – The new desired shape. + **\*shape** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| Iterable\[ShapeInput]]*) – The new desired shape. **Returns** @@ -355,7 +355,7 @@ python_api_name: qiskit.primitives.BitArray **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the size corresponding to your new shape is not equal to either [`size`](#qiskit.primitives.BitArray.size "qiskit.primitives.BitArray.size"), or the product of [`size`](#qiskit.primitives.BitArray.size "qiskit.primitives.BitArray.size") and [`num_shots`](#qiskit.primitives.BitArray.num_shots "qiskit.primitives.BitArray.num_shots"). + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the size corresponding to your new shape is not equal to either [`size`](#qiskit.primitives.BitArray.size "qiskit.primitives.BitArray.size"), or the product of [`size`](#qiskit.primitives.BitArray.size "qiskit.primitives.BitArray.size") and [`num_shots`](#qiskit.primitives.BitArray.num_shots "qiskit.primitives.BitArray.num_shots"). **Return type** @@ -375,7 +375,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - **indices** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The bit positions of interest to slice along. + **indices** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The bit positions of interest to slice along. **Returns** @@ -383,7 +383,7 @@ python_api_name: qiskit.primitives.BitArray **Raises** - [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.13)") – If there are any invalid indices of the bit axis. + [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.14)") – If there are any invalid indices of the bit axis. **Return type** @@ -397,7 +397,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - **indices** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The shots positions of interest to slice along. + **indices** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The shots positions of interest to slice along. **Returns** @@ -405,7 +405,7 @@ python_api_name: qiskit.primitives.BitArray **Raises** - [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.13)") – If there are any invalid indices of the shots axis. + [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.14)") – If there are any invalid indices of the shots axis. **Return type** @@ -419,7 +419,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - **order** ([*Literal*](https://docs.python.org/3/library/typing.html#typing.Literal "(in Python v3.13)")*\['big', 'little']*) – One of `"big"` or `"little"`, respectively indicating whether the most significant bit or the least significant bit of each bitstring should be placed at `[..., 0]`. + **order** ([*Literal*](https://docs.python.org/3/library/typing.html#typing.Literal "(in Python v3.14)")*\['big', 'little']*) – One of `"big"` or `"little"`, respectively indicating whether the most significant bit or the least significant bit of each bitstring should be placed at `[..., 0]`. **Returns** @@ -427,11 +427,11 @@ python_api_name: qiskit.primitives.BitArray **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the order is not one of `"big"` or `"little"`. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the order is not one of `"big"` or `"little"`. **Return type** - [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")\[*bool\_*]] + [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype "(in NumPy v2.3)")\[*bool\_*]] ### transpose @@ -453,8 +453,8 @@ python_api_name: qiskit.primitives.BitArray **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `axes` don’t match this bit array. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `axes` includes any indices that are out of bounds. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `axes` don’t match this bit array. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `axes` includes any indices that are out of bounds. diff --git a/docs/api/qiskit/qiskit.primitives.DataBin.mdx b/docs/api/qiskit/qiskit.primitives.DataBin.mdx index 66d526fc316..f2c9534db8e 100644 --- a/docs/api/qiskit/qiskit.primitives.DataBin.mdx +++ b/docs/api/qiskit/qiskit.primitives.DataBin.mdx @@ -38,8 +38,8 @@ python_api_name: qiskit.primitives.DataBin **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If a name overlaps with a method name on this class. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If some value is inconsistent with the provided shape. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If a name overlaps with a method name on this class. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If some value is inconsistent with the provided shape. ## Attributes @@ -64,7 +64,7 @@ python_api_name: qiskit.primitives.DataBin **Return type** - [*ItemsView*](https://docs.python.org/3/library/typing.html#typing.ItemsView "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")] + [*ItemsView*](https://docs.python.org/3/library/typing.html#typing.ItemsView "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")] ### keys @@ -74,7 +74,7 @@ python_api_name: qiskit.primitives.DataBin **Return type** - [*KeysView*](https://docs.python.org/3/library/typing.html#typing.KeysView "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")] + [*KeysView*](https://docs.python.org/3/library/typing.html#typing.KeysView "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")] ### values @@ -84,7 +84,7 @@ python_api_name: qiskit.primitives.DataBin **Return type** - [*ValuesView*](https://docs.python.org/3/library/typing.html#typing.ValuesView "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")] + [*ValuesView*](https://docs.python.org/3/library/typing.html#typing.ValuesView "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")] diff --git a/docs/api/qiskit/qiskit.primitives.EstimatorResult.mdx b/docs/api/qiskit/qiskit.primitives.EstimatorResult.mdx index 058c73e02bf..d58dad9dfd0 100644 --- a/docs/api/qiskit/qiskit.primitives.EstimatorResult.mdx +++ b/docs/api/qiskit/qiskit.primitives.EstimatorResult.mdx @@ -22,7 +22,7 @@ python_api_name: qiskit.primitives.EstimatorResult **Parameters** * **values** (*np.ndarray*) – The array of the expectation values. - * **metadata** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*]*) – List of the metadata. + * **metadata** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*]*) – List of the metadata. ## Attributes diff --git a/docs/api/qiskit/qiskit.primitives.PrimitiveJob.mdx b/docs/api/qiskit/qiskit.primitives.PrimitiveJob.mdx index 7dcc97e5268..1821a13625f 100644 --- a/docs/api/qiskit/qiskit.primitives.PrimitiveJob.mdx +++ b/docs/api/qiskit/qiskit.primitives.PrimitiveJob.mdx @@ -32,7 +32,7 @@ python_api_name: qiskit.primitives.PrimitiveJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### done @@ -42,7 +42,7 @@ python_api_name: qiskit.primitives.PrimitiveJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### in\_final\_state @@ -52,7 +52,7 @@ python_api_name: qiskit.primitives.PrimitiveJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### job\_id @@ -62,7 +62,7 @@ python_api_name: qiskit.primitives.PrimitiveJob **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### result @@ -82,7 +82,7 @@ python_api_name: qiskit.primitives.PrimitiveJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### status diff --git a/docs/api/qiskit/qiskit.primitives.PrimitiveResult.mdx b/docs/api/qiskit/qiskit.primitives.PrimitiveResult.mdx index 17ebc9f40b9..506ca6be986 100644 --- a/docs/api/qiskit/qiskit.primitives.PrimitiveResult.mdx +++ b/docs/api/qiskit/qiskit.primitives.PrimitiveResult.mdx @@ -9,14 +9,14 @@ python_api_name: qiskit.primitives.PrimitiveResult # PrimitiveResult - Bases: [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.13)")\[`T`] + Bases: [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.14)")\[`T`] A container for multiple pub results and global metadata. **Parameters** * **pub\_results** (*Iterable\[T]*) – Pub results. - * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Metadata that is common to all pub results; metadata specific to particular pubs should be placed in their metadata fields. Keys are expected to be strings. + * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Any] | None*) – Metadata that is common to all pub results; metadata specific to particular pubs should be placed in their metadata fields. Keys are expected to be strings. ## Attributes diff --git a/docs/api/qiskit/qiskit.primitives.PubResult.mdx b/docs/api/qiskit/qiskit.primitives.PubResult.mdx index ed2a7dc4a96..0ec2449dc23 100644 --- a/docs/api/qiskit/qiskit.primitives.PubResult.mdx +++ b/docs/api/qiskit/qiskit.primitives.PubResult.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.primitives.PubResult # PubResult - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Result of Primitive Unified Bloc. @@ -18,7 +18,7 @@ python_api_name: qiskit.primitives.PubResult **Parameters** * **data** ([*DataBin*](qiskit.primitives.DataBin "qiskit.primitives.DataBin")) – Result data. - * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Metadata specific to this pub. Keys are expected to be strings. + * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Any] | None*) – Metadata specific to this pub. Keys are expected to be strings. ## Attributes diff --git a/docs/api/qiskit/qiskit.primitives.SamplerPubResult.mdx b/docs/api/qiskit/qiskit.primitives.SamplerPubResult.mdx index 89b57fee5b4..3fc827f088f 100644 --- a/docs/api/qiskit/qiskit.primitives.SamplerPubResult.mdx +++ b/docs/api/qiskit/qiskit.primitives.SamplerPubResult.mdx @@ -18,7 +18,7 @@ python_api_name: qiskit.primitives.SamplerPubResult **Parameters** * **data** ([*DataBin*](qiskit.primitives.DataBin "qiskit.primitives.DataBin")) – Result data. - * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Metadata specific to this pub. Keys are expected to be strings. + * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Any] | None*) – Metadata specific to this pub. Keys are expected to be strings. ## Attributes @@ -45,7 +45,7 @@ python_api_name: qiskit.primitives.SamplerPubResult **Parameters** - **names** (*Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – Which registers to join. Their order is maintained, for example, given `["alpha", "beta"]`, the data from register `alpha` is placed to the left of the data from register `beta`. When `None` is given, this value is set to the ordered list of register names, which will have been preserved from the input circuit order. + **names** (*Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] | None*) – Which registers to join. Their order is maintained, for example, given `["alpha", "beta"]`, the data from register `alpha` is placed to the left of the data from register `beta`. When `None` is given, this value is set to the ordered list of register names, which will have been preserved from the input circuit order. **Returns** @@ -53,9 +53,9 @@ python_api_name: qiskit.primitives.SamplerPubResult **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If specified names are empty. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If specified name does not exist. - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If specified data comes from incompatible types. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If specified names are empty. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If specified name does not exist. + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If specified data comes from incompatible types. **Return type** diff --git a/docs/api/qiskit/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/qiskit.primitives.SamplerResult.mdx index 5a1d07cfeeb..3057624f99b 100644 --- a/docs/api/qiskit/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/qiskit.primitives.SamplerResult.mdx @@ -21,8 +21,8 @@ python_api_name: qiskit.primitives.SamplerResult **Parameters** - * **quasi\_dists** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*QuasiDistribution*](qiskit.result.QuasiDistribution "qiskit.result.QuasiDistribution")*]*) – List of the quasi-probabilities. - * **metadata** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*]*) – List of the metadata. + * **quasi\_dists** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*QuasiDistribution*](qiskit.result.QuasiDistribution "qiskit.result.QuasiDistribution")*]*) – List of the quasi-probabilities. + * **metadata** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*]*) – List of the metadata. ## Attributes diff --git a/docs/api/qiskit/qiskit.primitives.StatevectorEstimator.mdx b/docs/api/qiskit/qiskit.primitives.StatevectorEstimator.mdx index d51cc659295..28f77bbad44 100644 --- a/docs/api/qiskit/qiskit.primitives.StatevectorEstimator.mdx +++ b/docs/api/qiskit/qiskit.primitives.StatevectorEstimator.mdx @@ -84,8 +84,8 @@ python_api_name: qiskit.primitives.StatevectorEstimator **Parameters** - * **default\_precision** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The default precision for the estimator if not specified during run. - * **seed** (*np.random.Generator |* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The seed or Generator object for random number generation. If None, a random seeded default RNG will be used. + * **default\_precision** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The default precision for the estimator if not specified during run. + * **seed** (*np.random.Generator |* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The seed or Generator object for random number generation. If None, a random seeded default RNG will be used. ## Attributes @@ -111,7 +111,7 @@ python_api_name: qiskit.primitives.StatevectorEstimator **Parameters** * **pubs** (*Iterable\[EstimatorPubLike]*) – An iterable of pub-like objects, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`. - * **precision** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – The target precision for expectation value estimates of each run Estimator Pub that does not specify its own precision. If None the estimator’s default precision value will be used. + * **precision** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – The target precision for expectation value estimates of each run Estimator Pub that does not specify its own precision. If None the estimator’s default precision value will be used. **Returns** diff --git a/docs/api/qiskit/qiskit.primitives.StatevectorSampler.mdx b/docs/api/qiskit/qiskit.primitives.StatevectorSampler.mdx index dc1fbe5acfd..8904276d781 100644 --- a/docs/api/qiskit/qiskit.primitives.StatevectorSampler.mdx +++ b/docs/api/qiskit/qiskit.primitives.StatevectorSampler.mdx @@ -87,8 +87,8 @@ python_api_name: qiskit.primitives.StatevectorSampler **Parameters** - * **default\_shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The default shots for the sampler if not specified during run. - * **seed** (*np.random.Generator |* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The seed or Generator object for random number generation. If None, a random seeded default RNG will be used. + * **default\_shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The default shots for the sampler if not specified during run. + * **seed** (*np.random.Generator |* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The seed or Generator object for random number generation. If None, a random seeded default RNG will be used. ## Attributes @@ -114,7 +114,7 @@ python_api_name: qiskit.primitives.StatevectorSampler **Parameters** * **pubs** (*Iterable\[SamplerPubLike]*) – An iterable of pub-like objects. For example, a list of circuits or tuples `(circuit, parameter_values)`. - * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The total number of shots to sample for each sampler pub that does not specify its own shots. If `None`, the primitive’s default shots value will be used, which can vary by implementation. + * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The total number of shots to sample for each sampler pub that does not specify its own shots. If `None`, the primitive’s default shots value will be used, which can vary by implementation. **Returns** diff --git a/docs/api/qiskit/qiskit.providers.Backend.mdx b/docs/api/qiskit/qiskit.providers.Backend.mdx index 6ff1c4f30ad..0e4ea9f75c3 100644 --- a/docs/api/qiskit/qiskit.providers.Backend.mdx +++ b/docs/api/qiskit/qiskit.providers.Backend.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.providers.Backend # Backend - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Base common type for all versioned Backend abstract classes. diff --git a/docs/api/qiskit/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/qiskit.providers.BackendV2.mdx index 602030a5ba6..86992f048c6 100644 --- a/docs/api/qiskit/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/qiskit.providers.BackendV2.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.providers.BackendV2 # BackendV2 - Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Abstract class for Backends @@ -44,15 +44,15 @@ python_api_name: qiskit.providers.BackendV2 **Parameters** * **provider** – An optional backwards reference to the provider object that the backend is from - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – An optional name for the backend - * **description** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – An optional description of the backend - * **online\_date** ([*datetime*](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.13)")) – An optional datetime the backend was brought online - * **backend\_version** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – An optional backend version string. This differs from the [`version`](#qiskit.providers.BackendV2.version "qiskit.providers.BackendV2.version") attribute as [`version`](#qiskit.providers.BackendV2.version "qiskit.providers.BackendV2.version") is for the abstract [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend") abstract interface version of the object while `backend_version` is for versioning the backend itself. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – An optional name for the backend + * **description** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – An optional description of the backend + * **online\_date** ([*datetime*](https://docs.python.org/3/library/datetime.html#datetime.datetime "(in Python v3.14)")) – An optional datetime the backend was brought online + * **backend\_version** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – An optional backend version string. This differs from the [`version`](#qiskit.providers.BackendV2.version "qiskit.providers.BackendV2.version") attribute as [`version`](#qiskit.providers.BackendV2.version "qiskit.providers.BackendV2.version") is for the abstract [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend") abstract interface version of the object while `backend_version` is for versioning the backend itself. * **fields** – kwargs for the values to use to override the default options. **Raises** - [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If a field is specified that’s outside the backend’s options + [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – If a field is specified that’s outside the backend’s options ## Attributes @@ -85,7 +85,7 @@ python_api_name: qiskit.providers.BackendV2 **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the output signal timestep + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – if the backend doesn’t support querying the output signal timestep ### instruction\_durations @@ -121,7 +121,7 @@ python_api_name: qiskit.providers.BackendV2 **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – if the backend doesn’t support querying the measurement mapping ### num\_qubits @@ -213,7 +213,7 @@ python_api_name: qiskit.providers.BackendV2 **Parameters** - **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit to get the [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") object for. This can be a single integer for 1 qubit or a list of qubits and a list of [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") objects will be returned in the same order + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit to get the [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") object for. This can be a single integer for 1 qubit or a list of qubits and a list of [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") objects will be returned in the same order **Returns** @@ -221,11 +221,11 @@ python_api_name: qiskit.providers.BackendV2 **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the qubit properties + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – if the backend doesn’t support querying the qubit properties **Return type** - [*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties") | [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties")] + [*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties") | [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")\[[*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties")] ### run @@ -237,7 +237,7 @@ python_api_name: qiskit.providers.BackendV2 **Parameters** - * **run\_input** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – An individual or a list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects to run on the backend. + * **run\_input** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – An individual or a list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** @@ -262,7 +262,7 @@ python_api_name: qiskit.providers.BackendV2 **Raises** - [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If the field passed in is not part of the options + [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – If the field passed in is not part of the options diff --git a/docs/api/qiskit/qiskit.providers.Job.mdx b/docs/api/qiskit/qiskit.providers.Job.mdx index a01465b278e..dad66b9fc5b 100644 --- a/docs/api/qiskit/qiskit.providers.Job.mdx +++ b/docs/api/qiskit/qiskit.providers.Job.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.providers.Job # Job - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Base common type for all versioned Job abstract classes. diff --git a/docs/api/qiskit/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/qiskit.providers.JobStatus.mdx index 6ec0dd90e54..66103febb42 100644 --- a/docs/api/qiskit/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/qiskit.providers.JobStatus.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.14)") Class for job status enumerated type. diff --git a/docs/api/qiskit/qiskit.providers.JobV1.mdx b/docs/api/qiskit/qiskit.providers.JobV1.mdx index 309fc623692..9910cb1085d 100644 --- a/docs/api/qiskit/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/qiskit.providers.JobV1.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.providers.JobV1 # JobV1 - Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Class to handle jobs @@ -20,7 +20,7 @@ python_api_name: qiskit.providers.JobV1 **Parameters** * **backend** (*Optional\[*[*Backend*](qiskit.providers.Backend "qiskit.providers.Backend")*]*) – the backend used to run the job. - * **job\_id** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a unique id in the context of the backend used to run the job. + * **job\_id** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – a unique id in the context of the backend used to run the job. * **kwargs** – Any key value metadata to associate with this job. ## Attributes @@ -54,7 +54,7 @@ python_api_name: qiskit.providers.JobV1 **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### done @@ -64,7 +64,7 @@ python_api_name: qiskit.providers.JobV1 **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### in\_final\_state @@ -74,7 +74,7 @@ python_api_name: qiskit.providers.JobV1 **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### job\_id @@ -84,7 +84,7 @@ python_api_name: qiskit.providers.JobV1 **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### result @@ -104,7 +104,7 @@ python_api_name: qiskit.providers.JobV1 **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### status @@ -130,11 +130,11 @@ python_api_name: qiskit.providers.JobV1 **Parameters** - * **timeout** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – Seconds to wait for the job. If `None`, wait indefinitely. + * **timeout** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – Seconds to wait for the job. If `None`, wait indefinitely. - * **wait** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Seconds between queries. + * **wait** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Seconds between queries. - * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)") *| None*) – + * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)") *| None*) – Callback function invoked after each query. The following positional arguments are provided to the callback function: diff --git a/docs/api/qiskit/qiskit.providers.Options.mdx b/docs/api/qiskit/qiskit.providers.Options.mdx index ed78062cf1f..c6c38eb1d70 100644 --- a/docs/api/qiskit/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/qiskit.providers.Options.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.providers.Options # Options - Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.13)") + Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.14)") Base options object @@ -88,14 +88,14 @@ python_api_name: qiskit.providers.Options **Parameters** - * **field** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The field name to set the validator on - * **validator\_value** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *or*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)")) – The value to use for the validator depending on the type indicates on how the value for a field is enforced. If a tuple is passed in it must have a length of two and will enforce the min and max value (inclusive) for an integer or float value option. If it’s a list it will list the valid values for a field. If it’s a `type` the validator will just enforce the value is of a certain type. + * **field** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The field name to set the validator on + * **validator\_value** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *or*[*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)")) – The value to use for the validator depending on the type indicates on how the value for a field is enforced. If a tuple is passed in it must have a length of two and will enforce the min and max value (inclusive) for an integer or float value option. If it’s a list it will list the valid values for a field. If it’s a `type` the validator will just enforce the value is of a certain type. **Raises** - * [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") – If field is not present in the options object - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the `validator_value` has an invalid value for a given type - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If `validator_value` is not a valid type + * [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") – If field is not present in the options object + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the `validator_value` has an invalid value for a given type + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If `validator_value` is not a valid type ### update\_options diff --git a/docs/api/qiskit/qiskit.providers.QubitProperties.mdx b/docs/api/qiskit/qiskit.providers.QubitProperties.mdx index 6bbad95955f..56b041f2ef4 100644 --- a/docs/api/qiskit/qiskit.providers.QubitProperties.mdx +++ b/docs/api/qiskit/qiskit.providers.QubitProperties.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.providers.QubitProperties # QubitProperties - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A representation of a `QubitProperties` object. diff --git a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.mdx b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.mdx index d9a5e4c44bb..66978ebebfa 100644 --- a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.mdx +++ b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProvider # BasicProvider - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Provider for test simulators. @@ -28,11 +28,11 @@ python_api_name: qiskit.providers.basic_provider.BasicProvider **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] **Parameters** - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – * **filters** (*Callable | None*) – diff --git a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.mdx b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.mdx index 67f1f560f8a..f9dac206eed 100644 --- a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.mdx +++ b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.mdx @@ -48,7 +48,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### done @@ -58,7 +58,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### in\_final\_state @@ -68,7 +68,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### job\_id @@ -78,7 +78,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### result @@ -102,7 +102,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### status @@ -136,11 +136,11 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob **Parameters** - * **timeout** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – Seconds to wait for the job. If `None`, wait indefinitely. + * **timeout** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – Seconds to wait for the job. If `None`, wait indefinitely. - * **wait** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Seconds between queries. + * **wait** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Seconds between queries. - * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)") *| None*) – + * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)") *| None*) – Callback function invoked after each query. The following positional arguments are provided to the callback function: diff --git a/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.mdx b/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.mdx index 5ef9a4d5726..1d314f4d17c 100644 --- a/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.mdx +++ b/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.mdx @@ -21,7 +21,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Raises** - [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If a field is specified that’s outside the backend’s options. + [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – If a field is specified that’s outside the backend’s options. ## Attributes @@ -58,7 +58,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the output signal timestep + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – if the backend doesn’t support querying the output signal timestep ### instruction\_durations @@ -90,7 +90,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – if the backend doesn’t support querying the measurement mapping ### num\_qubits @@ -176,7 +176,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Parameters** - **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit to get the [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") object for. This can be a single integer for 1 qubit or a list of qubits and a list of [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") objects will be returned in the same order + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit to get the [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") object for. This can be a single integer for 1 qubit or a list of qubits and a list of [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") objects will be returned in the same order **Returns** @@ -184,11 +184,11 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the qubit properties + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – if the backend doesn’t support querying the qubit properties **Return type** - [*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties") | [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties")] + [*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties") | [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")\[[*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties")] ### run @@ -198,7 +198,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Parameters** - * **run\_input** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – the QuantumCircuit (or list of QuantumCircuit objects) to run + * **run\_input** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – the QuantumCircuit (or list of QuantumCircuit objects) to run * **run\_options** (*kwargs*) – additional runtime backend options **Returns** @@ -241,7 +241,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Raises** - [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If the field passed in is not part of the options + [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – If the field passed in is not part of the options diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx b/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx index a47a9d6a7d6..b843e5afa32 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx +++ b/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx @@ -15,11 +15,11 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of qubits that will be used to construct the backend’s target. Note that, while there is no limit in the size of the target that can be constructed, this backend runs on local noisy simulators, and these might present limitations in the number of qubits that can be simulated. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of qubits that will be used to construct the backend’s target. Note that, while there is no limit in the size of the target that can be constructed, this backend runs on local noisy simulators, and these might present limitations in the number of qubits that can be simulated. - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – List of basis gate names to be supported by the target. These must be part of the standard qiskit circuit library. The default set of basis gates is `["id", "rz", "sx", "x", "cx"]` The `"reset"`, `"delay"`, and `"measure"` instructions are always supported by default, even if not specified via `basis_gates`. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] | None*) – List of basis gate names to be supported by the target. These must be part of the standard qiskit circuit library. The default set of basis gates is `["id", "rz", "sx", "x", "cx"]` The `"reset"`, `"delay"`, and `"measure"` instructions are always supported by default, even if not specified via `basis_gates`. - * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] |* [*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") *| None*) – + * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]] |* [*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") *| None*) – Optional coupling map for the backend. Multiple formats are supported: @@ -28,15 +28,15 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 If `coupling_map` is specified, it must match the number of qubits specified in `num_qubits`. If `coupling_map` is not specified, a fully connected coupling map will be generated with `num_qubits` qubits. - * **control\_flow** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Flag to enable control flow directives on the target (defaults to False). + * **control\_flow** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Flag to enable control flow directives on the target (defaults to False). - * **dtm** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – System time resolution of output signals in nanoseconds. None by default. + * **dtm** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – System time resolution of output signals in nanoseconds. None by default. - * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – System time resolution of input signals in nanoseconds. None by default. + * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – System time resolution of input signals in nanoseconds. None by default. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – Optional seed for generation of default values. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – Optional seed for generation of default values. - * **noise\_info** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If true, associates gates and qubits with default noise information. + * **noise\_info** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If true, associates gates and qubits with default noise information. ## Attributes @@ -167,7 +167,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 **Parameters** - **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubit to get the [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") object for. This can be a single integer for 1 qubit or a list of qubits and a list of [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") objects will be returned in the same order + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The qubit to get the [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") object for. This can be a single integer for 1 qubit or a list of qubits and a list of [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") objects will be returned in the same order **Returns** @@ -175,11 +175,11 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the qubit properties + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – if the backend doesn’t support querying the qubit properties **Return type** - [*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties") | [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties")] + [*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties") | [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")\[[*QubitProperties*](qiskit.providers.QubitProperties "qiskit._accelerate.target.QubitProperties")] ### run @@ -193,7 +193,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 **Parameters** - * **run\_input** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – An individual or a list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects to run on the backend. + * **run\_input** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – An individual or a list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects to run on the backend. * **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object, then the expectation is that the value specified will be used instead of what’s set in the options object. **Returns** @@ -223,7 +223,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 **Raises** - [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If the field passed in is not part of the options + [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – If the field passed in is not part of the options diff --git a/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.mdx b/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.mdx index f1abfb16e6a..b122e841037 100644 --- a/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.mdx @@ -62,8 +62,8 @@ python_api_name: qiskit.quantum_info.CNOTDihedral **Parameters** * **data** ([*CNOTDihedral*](#qiskit.quantum_info.CNOTDihedral "qiskit.quantum_info.CNOTDihedral") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – Optional, operator to initialize. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Optional, initialize an empty CNOTDihedral operator. - * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, validates the CNOTDihedral element. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Optional, initialize an empty CNOTDihedral operator. + * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, validates the CNOTDihedral element. **Raises** @@ -118,8 +118,8 @@ python_api_name: qiskit.quantum_info.CNOTDihedral **Parameters** * **other** ([*CNOTDihedral*](#qiskit.quantum_info.CNOTDihedral "qiskit.quantum_info.CNOTDihedral")) – a CNOTDihedral object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). **Returns** @@ -214,7 +214,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of times to compose with self (n>0). + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of times to compose with self (n>0). **Returns** @@ -236,9 +236,9 @@ python_api_name: qiskit.quantum_info.CNOTDihedral **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/qiskit.quantum_info.Chi.mdx index 0e5b11c0dda..d1980be2f0c 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Chi.mdx @@ -32,8 +32,8 @@ $$ **Parameters** * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. - * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. - * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the output subsystem dimensions. **Raises** @@ -103,8 +103,8 @@ $$ **Parameters** * **other** ([*Chi*](#qiskit.quantum_info.Chi "qiskit.quantum_info.Chi")) – a Chi object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. **Returns** @@ -149,7 +149,7 @@ $$ **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). **Returns** @@ -197,12 +197,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_cptp @@ -212,12 +212,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_tp @@ -227,12 +227,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_unitary @@ -242,12 +242,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### output\_dims @@ -263,7 +263,7 @@ $$ **Parameters** - **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power exponent. + **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power exponent. **Returns** @@ -289,9 +289,9 @@ $$ **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/qiskit.quantum_info.Choi.mdx index f4b2779bc39..739b43de939 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Choi.mdx @@ -40,8 +40,8 @@ $$ **Parameters** * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. - * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. - * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the output subsystem dimensions. **Raises** @@ -115,8 +115,8 @@ $$ **Parameters** * **other** ([*Choi*](#qiskit.quantum_info.Choi "qiskit.quantum_info.Choi")) – a Choi object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. **Returns** @@ -161,7 +161,7 @@ $$ **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). **Returns** @@ -209,12 +209,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_cptp @@ -224,12 +224,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_tp @@ -239,12 +239,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_unitary @@ -254,12 +254,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### output\_dims @@ -275,7 +275,7 @@ $$ **Parameters** - **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power exponent. + **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power exponent. **Returns** @@ -301,9 +301,9 @@ $$ **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/qiskit.quantum_info.Clifford.mdx index 22475529c77..53268f24574 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Clifford.mdx @@ -194,8 +194,8 @@ python_api_name: qiskit.quantum_info.Clifford **Parameters** * **other** ([*Clifford*](#qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – a Clifford object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. **Returns** @@ -236,7 +236,7 @@ python_api_name: qiskit.quantum_info.Clifford **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). **Returns** @@ -458,7 +458,7 @@ python_api_name: qiskit.quantum_info.Clifford **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of times to compose with self (n>0). + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of times to compose with self (n>0). **Returns** @@ -480,9 +480,9 @@ python_api_name: qiskit.quantum_info.Clifford **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** @@ -574,7 +574,7 @@ python_api_name: qiskit.quantum_info.Clifford **Parameters** - * **array** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – return a Numpy array if True, otherwise return a list (Default: False). + * **array** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – return a Numpy array if True, otherwise return a list (Default: False). * **mode** (*Literal\["S", "D", "B"]*) – return both stabilizer and destabilizer if “B”, return only stabilizer if “S” and return only destabilizer if “D”. **Returns** @@ -583,7 +583,7 @@ python_api_name: qiskit.quantum_info.Clifford **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") or array + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") or array **Raises** diff --git a/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.mdx index 635fe74046e..6942ff9595f 100644 --- a/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.mdx @@ -17,8 +17,8 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - * **data** (*np.ndarray |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| QuantumState*) – A statevector, quantum instruction or an object with a `to_operator` or `to_matrix` method from which the density matrix can be constructed. If a vector the density matrix is constructed as the projector of that vector. If a quantum instruction, the density matrix is constructed by assuming all qubits are initialized in the zero state. - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| None*) – The subsystem dimension of the state (See additional information). + * **data** (*np.ndarray |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| QuantumState*) – A statevector, quantum instruction or an object with a `to_operator` or `to_matrix` method from which the density matrix can be constructed. If a vector the density matrix is constructed as the projector of that vector. If a quantum instruction, the density matrix is constructed by assuming all qubits are initialized in the zero state. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *| None*) – The subsystem dimension of the state (See additional information). **Raises** @@ -106,16 +106,16 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - * **output** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Select the output method to use for drawing the state. Valid choices are repr, text, latex, latex\_source, qsphere, hinton, or bloch. Default is repr. Default can be changed by adding the line `state_drawer = ` to `~/.qiskit/settings.conf` under `[default]`. + * **output** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Select the output method to use for drawing the state. Valid choices are repr, text, latex, latex\_source, qsphere, hinton, or bloch. Default is repr. Default can be changed by adding the line `state_drawer = ` to `~/.qiskit/settings.conf` under `[default]`. * **drawer\_args** – Arguments to be passed directly to the relevant drawing function or constructor (TextMatrix(), array\_to\_latex(), plot\_state\_qsphere(), plot\_state\_hinton() or plot\_bloch\_multivector()). See the relevant function under qiskit.visualization for that function’s documentation. **Returns** - `matplotlib.Figure` or [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") or `TextMatrix` or `IPython.display.Latex`: Drawing of the Statevector. + `matplotlib.Figure` or [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") or `TextMatrix` or `IPython.display.Latex`: Drawing of the Statevector. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – when an invalid output method is selected. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – when an invalid output method is selected. ### evolve @@ -126,7 +126,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *| QuantumChannel |*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The operator to evolve by. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – a list of QuantumState subsystem positions to apply the operator on. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – a list of QuantumState subsystem positions to apply the operator on. **Returns** @@ -171,7 +171,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** * **oper** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator to evaluate expval. - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to apply the operator on. + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to apply the operator on. **Returns** @@ -179,7 +179,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Return type** - [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)") + [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)") ### from\_instruction @@ -213,8 +213,8 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - * **i** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the basis state element. - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – The subsystem dimensions of the statevector (See additional information). + * **i** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the basis state element. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – The subsystem dimensions of the statevector (See additional information). **Returns** @@ -278,7 +278,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). **Returns** @@ -288,7 +288,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") ### partial\_transpose @@ -298,7 +298,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – The subsystems to be transposed. + **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – The subsystems to be transposed. **Returns** @@ -318,8 +318,8 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). - * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of decimal places to round values. If None no rounding is done (Default: None). + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). + * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of decimal places to round values. If None no rounding is done (Default: None). **Returns** @@ -391,8 +391,8 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). - * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of decimal places to round values. If None no rounding is done (Default: None). + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). + * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of decimal places to round values. If None no rounding is done (Default: None). **Returns** @@ -400,7 +400,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") ### purity @@ -416,7 +416,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – subsystems to reset, if None all subsystems will be reset to their 0-state (Default: None). + **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – subsystems to reset, if None all subsystems will be reset to their 0-state (Default: None). **Returns** @@ -454,8 +454,8 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of samples to generate. - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of samples to generate. + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). **Returns** @@ -479,8 +479,8 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of samples to generate. - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of samples to generate. + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). **Returns** @@ -534,7 +534,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of decimal places to round values. If None no rounding is done (Default: None). + **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of decimal places to round values. If None no rounding is done (Default: None). **Returns** @@ -542,7 +542,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") **Examples** @@ -618,8 +618,8 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Absolute tolerance for checking operation validity. - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Relative tolerance for checking operation validity. + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Absolute tolerance for checking operation validity. + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Relative tolerance for checking operation validity. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/qiskit.quantum_info.Kraus.mdx index 97d5c992fb3..196c10fb75e 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Kraus.mdx @@ -36,8 +36,8 @@ $$ **Parameters** * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. + * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the output subsystem dimensions. **Raises** @@ -107,8 +107,8 @@ $$ **Parameters** * **other** ([*Kraus*](#qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus")) – a Kraus object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. **Returns** @@ -153,7 +153,7 @@ $$ **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). **Returns** @@ -201,12 +201,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_cptp @@ -222,12 +222,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_unitary @@ -237,12 +237,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### output\_dims @@ -258,7 +258,7 @@ $$ **Parameters** - **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power exponent. + **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power exponent. **Returns** @@ -284,9 +284,9 @@ $$ **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/qiskit.quantum_info.Operator.mdx index cd07786f147..4f2e6a72d0c 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Operator.mdx @@ -55,8 +55,8 @@ $$ **Parameters** * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation") *or BaseOperator or matrix*) – data to initialize operator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the output subsystem dimensions. \[Default: None] + * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – the input subsystem dimensions. \[Default: None] + * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – the output subsystem dimensions. \[Default: None] **Raises** @@ -125,8 +125,8 @@ $$ **Parameters** - * **perm** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation. - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – When set to `True` the permutation is applied before the operator, when set to `False` the permutation is applied after the operator. + * **perm** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation. + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – When set to `True` the permutation is applied before the operator, when set to `False` the permutation is applied after the operator. **Returns** @@ -149,8 +149,8 @@ $$ **Parameters** * **other** ([*Operator*](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. **Returns** @@ -191,7 +191,7 @@ $$ **Parameters** * **other** ([*Operator*](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). **Returns** @@ -221,7 +221,7 @@ $$ **Parameters** - * **output** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Select the output method to use for drawing the state. Valid choices are repr, text, latex, latex\_source, Default is repr. + * **output** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Select the output method to use for drawing the state. Valid choices are repr, text, latex, latex\_source, Default is repr. * **drawer\_args** – Arguments to be passed directly to the relevant drawing function or constructor (TextMatrix(), array\_to\_latex()). See the relevant function under qiskit.visualization for that function’s documentation. **Returns** @@ -230,11 +230,11 @@ $$ **Return type** - [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") or `TextMatrix` or `IPython.display.Latex` + [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") or `TextMatrix` or `IPython.display.Latex` **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – when an invalid output method is selected. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – when an invalid output method is selected. * **MissingOptionalLibrary** – If SymPy isn’t installed and `'latex'` or `'latex_source'` is selected for `output`. @@ -246,8 +246,8 @@ $$ **Parameters** * **other** ([*Operator*](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – relative tolerance value for comparison. - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – absolute tolerance value for comparison. + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – relative tolerance value for comparison. + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – absolute tolerance value for comparison. **Returns** @@ -255,7 +255,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### expand @@ -290,7 +290,7 @@ $$ **Parameters** * **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") to create an Operator object from. - * **ignore\_set\_layout** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – When set to `True` if the input `circuit` has a layout set it will be ignored + * **ignore\_set\_layout** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – When set to `True` if the input `circuit` has a layout set it will be ignored * **layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – If specified this kwarg can be used to specify a particular layout to use to permute the qubits in the created [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). If this is specified it will be used instead of a layout contained in the `circuit` input. If specified the virtual bits in the [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") must be present in the `circuit` input. * **final\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – If specified this kwarg can be used to represent the output permutation caused by swap insertions during the routing stage of the transpiler. @@ -367,9 +367,9 @@ $$ **Parameters** - * **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power to raise the matrix to. - * **branch\_cut\_rotation** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The rotation angle to apply to the branch cut in the complex plane. This shifts the branch cut away from the common point of $-1$, but can cause a different root to be selected as the principal root. The rotation is anticlockwise, following the standard convention for complex phase. - * **assume\_unitary** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if `True`, the operator is assumed to be unitary. In this case, for fractional powers we employ a faster implementation based on Schur’s decomposition. + * **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power to raise the matrix to. + * **branch\_cut\_rotation** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The rotation angle to apply to the branch cut in the complex plane. This shifts the branch cut away from the common point of $-1$, but can cause a different root to be selected as the principal root. The rotation is anticlockwise, following the standard convention for complex phase. + * **assume\_unitary** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if `True`, the operator is assumed to be unitary. In this case, for fractional powers we employ a faster implementation based on Schur’s decomposition. **Returns** @@ -395,9 +395,9 @@ $$ **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/qiskit.quantum_info.PTM.mdx index f44d2a1a68a..3e368a114b7 100644 --- a/docs/api/qiskit/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.PTM.mdx @@ -40,8 +40,8 @@ $$ **Parameters** * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. - * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. - * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the output subsystem dimensions. **Raises** @@ -111,8 +111,8 @@ $$ **Parameters** * **other** ([*PTM*](#qiskit.quantum_info.PTM "qiskit.quantum_info.PTM")) – a PTM object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. **Returns** @@ -157,7 +157,7 @@ $$ **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). **Returns** @@ -205,12 +205,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_cptp @@ -220,12 +220,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_tp @@ -235,12 +235,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_unitary @@ -250,12 +250,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### output\_dims @@ -271,7 +271,7 @@ $$ **Parameters** - **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power exponent. + **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power exponent. **Returns** @@ -297,9 +297,9 @@ $$ **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/qiskit.quantum_info.Pauli.mdx index 11e9210aadb..d81a033f307 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Pauli.mdx @@ -105,7 +105,7 @@ $$ **Parameters** - **data** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *or*[*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*ScalarOp*](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – input data for Pauli. If input is a tuple it must be of the form `(z, x)` or `(z, x, phase)` where `z` and `x` are boolean Numpy arrays, and phase is an integer from $\mathbb{Z}_4$. If input is a string, it must be a concatenation of a phase and a Pauli string (e.g. `'XYZ', '-iZIZ'`) where a phase string is a combination of at most three characters from `['+', '-', '']`, `['1', '']`, and `['i', 'j', '']` in this order, e.g. `''`, `'-1j'` while a Pauli string is 1 or more characters of `'I'`, `'X'`, `'Y'`, or `'Z'`, e.g. `'Z'`, `'XIYY'`. + **data** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *or*[*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*ScalarOp*](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – input data for Pauli. If input is a tuple it must be of the form `(z, x)` or `(z, x, phase)` where `z` and `x` are boolean Numpy arrays, and phase is an integer from $\mathbb{Z}_4$. If input is a string, it must be a concatenation of a phase and a Pauli string (e.g. `'XYZ', '-iZIZ'`) where a phase string is a combination of at most three characters from `['+', '-', '']`, `['1', '']`, and `['i', 'j', '']` in this order, e.g. `''`, `'-1j'` while a Pauli string is 1 or more characters of `'I'`, `'X'`, `'Y'`, or `'Z'`, e.g. `'Z'`, `'XIYY'`. **Raises** @@ -183,7 +183,7 @@ $$ **Parameters** * **other** ([*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – another Pauli operator. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – qubits to apply dot product on (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – qubits to apply dot product on (default: None). **Returns** @@ -191,7 +191,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### apply\_layout @@ -201,8 +201,8 @@ $$ **Parameters** - * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – Either a [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), a list of integers or None. If both layout and num\_qubits are none, a copy of the operator is returned. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits to expand the operator to. If not provided then if `layout` is a [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") the number of the transpiler output circuit qubits will be used by default. If `layout` is a list of integers the permutation specified will be applied without any expansion. If layout is None, the operator will be expanded to the given number of qubits. + * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – Either a [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), a list of integers or None. If both layout and num\_qubits are none, a copy of the operator is returned. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits to expand the operator to. If not provided then if `layout` is a [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") the number of the transpiler output circuit qubits will be used by default. If `layout` is a list of integers the permutation specified will be applied without any expansion. If layout is None, the operator will be expanded to the given number of qubits. **Returns** @@ -221,7 +221,7 @@ $$ **Parameters** * **other** ([*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another Pauli operator. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – qubits to apply dot product on (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – qubits to apply dot product on (default: None). **Returns** @@ -229,7 +229,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### compose @@ -240,9 +240,9 @@ $$ **Parameters** * **other** ([*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a Pauli object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, qubits to apply dot product on (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True update in-place (default: False). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, qubits to apply dot product on (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True update in-place (default: False). **Returns** @@ -282,7 +282,7 @@ $$ **Parameters** - **qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – qubits to delete from Pauli. + **qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – qubits to delete from Pauli. **Returns** @@ -305,8 +305,8 @@ $$ **Parameters** * **other** ([*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, qubits to apply dot product on (default: None). - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True update in-place (default: False). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, qubits to apply dot product on (default: None). + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True update in-place (default: False). **Returns** @@ -332,7 +332,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### evolve @@ -349,7 +349,7 @@ $$ **Parameters** * **other** ([*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The Clifford operator to evolve by. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – a list of qubits to apply the Clifford to. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – a list of qubits to apply the Clifford to. * **frame** (*string*) – `'h'` for Heisenberg (default) or `'s'` for Schrödinger framework. **Returns** @@ -398,7 +398,7 @@ $$ **Parameters** - * **qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – qubits index to insert at. + * **qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – qubits index to insert at. * **value** ([*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – value to insert. **Returns** @@ -433,7 +433,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of times to compose with self (n>0). + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of times to compose with self (n>0). **Returns** @@ -455,9 +455,9 @@ $$ **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** @@ -479,7 +479,7 @@ $$ **Parameters** - **val** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of characters. + **val** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of characters. Truncation will be disabled if the truncation value is set to 0. @@ -531,7 +531,7 @@ $$ **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### to\_matrix @@ -541,7 +541,7 @@ $$ **Parameters** - **sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True return sparse CSR matrices, otherwise return dense Numpy arrays (default: False). + **sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True return sparse CSR matrices, otherwise return dense Numpy arrays (default: False). **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.PauliLindbladMap.mdx b/docs/api/qiskit/qiskit.quantum_info.PauliLindbladMap.mdx index c851777dbf8..fc2e61b8f87 100644 --- a/docs/api/qiskit/qiskit.quantum_info.PauliLindbladMap.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.PauliLindbladMap.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.quantum_info.PauliLindbladMap # PauliLindbladMap - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A Pauli Lindblad map stored in a qubit-sparse format. @@ -55,14 +55,14 @@ $$ ### Indexing - [`PauliLindbladMap`](#qiskit.quantum_info.PauliLindbladMap "qiskit.quantum_info.PauliLindbladMap") behaves as [a Python sequence](https://docs.python.org/3/glossary.html#term-sequence) (the standard form, not the expanded [`collections.abc.Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")). The generators of the map can be indexed by integers, and iterated through to yield individual generator terms. + [`PauliLindbladMap`](#qiskit.quantum_info.PauliLindbladMap "qiskit.quantum_info.PauliLindbladMap") behaves as [a Python sequence](https://docs.python.org/3/glossary.html#term-sequence) (the standard form, not the expanded [`collections.abc.Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")). The generators of the map can be indexed by integers, and iterated through to yield individual generator terms. Each generator term appears as an instance a self-contained class. The individual terms are copied out of the base map; mutations to them will not affect the original map from which they are indexed. #### GeneratorTerm - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A single term from a complete [`PauliLindbladMap`](#qiskit.quantum_info.PauliLindbladMap "qiskit.quantum_info.PauliLindbladMap"). @@ -150,7 +150,7 @@ $$ **Parameters** * **data** – The data type of the input. This can be another [`PauliLindbladMap`](#qiskit.quantum_info.PauliLindbladMap "qiskit.quantum_info.PauliLindbladMap"), in which case the input is copied, or it can be a list in a valid format for either [`from_list()`](#qiskit.quantum_info.PauliLindbladMap.from_list "qiskit.quantum_info.PauliLindbladMap.from_list") or [`from_sparse_list()`](#qiskit.quantum_info.PauliLindbladMap.from_sparse_list "qiskit.quantum_info.PauliLindbladMap.from_sparse_list"). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*|None*) – Optional number of qubits for the map. For most data inputs, this can be inferred and need not be passed. It is only necessary for empty lists or the sparse-list format. If given unnecessarily, it must match the data input. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*|None*) – Optional number of qubits for the map. For most data inputs, this can be inferred and need not be passed. It is only necessary for empty lists or the sparse-list format. If given unnecessarily, it must match the data input. In addition to the conversion-based constructors, there are also helper methods that construct special forms of maps. @@ -200,8 +200,8 @@ $$ **Parameters** - * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – The layout to apply. Most uses of this function should pass the [`QuantumCircuit.layout`](qiskit.circuit.QuantumCircuit#layout "qiskit.circuit.QuantumCircuit.layout") field from a circuit that was transpiled for hardware. In addition, you can pass a list of new qubit indices. If given as explicitly `None`, no remapping is applied (but you can still use `num_qubits` to expand the map). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits to expand the map to. If not supplied, the output will be as wide as the given [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), or the same width as the input if the `layout` is given in another form. + * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – The layout to apply. Most uses of this function should pass the [`QuantumCircuit.layout`](qiskit.circuit.QuantumCircuit#layout "qiskit.circuit.QuantumCircuit.layout") field from a circuit that was transpiled for hardware. In addition, you can pass a list of new qubit indices. If given as explicitly `None`, no remapping is applied (but you can still use `num_qubits` to expand the map). + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits to expand the map to. If not supplied, the output will be as wide as the given [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), or the same width as the input if the `layout` is given in another form. **Returns** @@ -261,7 +261,7 @@ $$ **Parameters** - **indices** (*Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The indices for which Paulis must be dropped. + **indices** (*Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The indices for which Paulis must be dropped. **Returns** @@ -285,7 +285,7 @@ $$ **Parameters** - **indices** (*Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The indices of the qubits to trace out. + **indices** (*Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The indices of the qubits to trace out. **Returns** @@ -315,8 +315,8 @@ $$ **Parameters** - * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]]*) – Pairs of labels and their associated rates in the generator sum. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – It is not necessary to specify this if you are sure that `iter` is not an empty sequence, since it can be inferred from the label lengths. If `iter` may be empty, you must specify this argument to disambiguate how many qubits the map acts on. If this is given and `iter` is not empty, the value must match the label lengths. + * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]]*) – Pairs of labels and their associated rates in the generator sum. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – It is not necessary to specify this if you are sure that `iter` is not an empty sequence, since it can be inferred from the label lengths. If `iter` may be empty, you must specify this argument to disambiguate how many qubits the map acts on. If this is given and `iter` is not empty, the value must match the label lengths. **Examples** @@ -371,8 +371,8 @@ $$ **Parameters** - * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]]*) – triples of labels, the qubits each single-qubit term applies to, and the rate of the entire term. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits the map acts on. + * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]]*) – triples of labels, the qubits each single-qubit term applies to, and the rate of the entire term. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits the map acts on. **Examples** @@ -418,7 +418,7 @@ $$ **Parameters** * **obj** (*Iterable\[*[*Term*](qiskit.quantum_info.SparseObservable#term "qiskit.quantum_info.SparseObservable.Term")*]*) – Iterable of individual terms to build the map generator from. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits the map should act on. This is usually inferred from the input, but can be explicitly given to handle the case of an empty iterable. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits the map should act on. This is usually inferred from the input, but can be explicitly given to handle the case of an empty iterable. **Returns** @@ -469,7 +469,7 @@ $$ **Parameters** - **indices** (*Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The indices for which Paulis must be kept. + **indices** (*Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The indices for which Paulis must be kept. **Returns** @@ -493,7 +493,7 @@ $$ **Parameters** - **indices** (*Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The indices for which qubits must be kept. + **indices** (*Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The indices for which qubits must be kept. **Returns** @@ -547,8 +547,8 @@ $$ **Parameters** - * **num\_samples** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of samples to draw. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Random seed. Defaults to `None`. + * **num\_samples** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of samples to draw. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Random seed. Defaults to `None`. **Returns** @@ -560,7 +560,7 @@ $$ **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If any of the rates in the map are negative. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If any of the rates in the map are negative. ### scale\_rates @@ -570,7 +570,7 @@ $$ **Parameters** - **scale\_factor** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the scaling coefficient. + **scale\_factor** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the scaling coefficient. ### signed\_sample @@ -590,8 +590,8 @@ $$ **Parameters** - * **num\_samples** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of samples to draw. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Random seed. + * **num\_samples** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of samples to draw. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Random seed. **Returns** @@ -615,7 +615,7 @@ $$ **Parameters** - **tol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – after summing like terms, any rates whose absolute value is less than the given absolute tolerance will be suppressed from the output. + **tol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – after summing like terms, any rates whose absolute value is less than the given absolute tolerance will be suppressed from the output. **Examples** diff --git a/docs/api/qiskit/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/qiskit.quantum_info.PauliList.mdx index 5c46f5e3cc8..13f197b3b19 100644 --- a/docs/api/qiskit/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.PauliList.mdx @@ -91,7 +91,7 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - **data** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – input data for Paulis. If input is a list each item in the list must be a Pauli object or Pauli str. + **data** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – input data for Paulis. If input is a list each item in the list must be a Pauli object or Pauli str. **Raises** @@ -173,7 +173,7 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** * **other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList operator. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – qubits to apply dot product on (default: `None`). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – qubits to apply dot product on (default: `None`). **Returns** @@ -181,7 +181,7 @@ python_api_name: qiskit.quantum_info.PauliList **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### anticommutes\_with\_all @@ -213,8 +213,8 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Optionally sort by weight if `True` (Default: `False`). - * **phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Optionally sort by phase before weight or order (Default: `False`). + * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Optionally sort by weight if `True` (Default: `False`). + * **phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Optionally sort by phase before weight or order (Default: `False`). **Returns** @@ -233,7 +233,7 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** * **other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList operator. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – qubits to apply dot product on (default: `None`). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – qubits to apply dot product on (default: `None`). **Returns** @@ -241,7 +241,7 @@ python_api_name: qiskit.quantum_info.PauliList **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### commutes\_with\_all @@ -272,9 +272,9 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** * **other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList. - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – qubits to apply dot product on (Default: `None`). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True use dot composition method \[default: `False`]. - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` update in-place (default: `False`). + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – qubits to apply dot product on (Default: `None`). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True use dot composition method \[default: `False`]. + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` update in-place (default: `False`). **Returns** @@ -310,8 +310,8 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - * **ind** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – index(es) to delete. - * **qubit** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if `True` delete qubit columns, otherwise delete Pauli rows (Default: `False`). + * **ind** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – index(es) to delete. + * **qubit** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if `True` delete qubit columns, otherwise delete Pauli rows (Default: `False`). **Returns** @@ -334,8 +334,8 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** * **other** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList. - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – qubits to apply dot product on (Default: `None`). - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True update in-place (default: `False`). + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – qubits to apply dot product on (Default: `None`). + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True update in-place (default: `False`). **Returns** @@ -384,7 +384,7 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** * **other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The Clifford operator to evolve by. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – a list of qubits to apply the Clifford to. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – a list of qubits to apply the Clifford to. * **frame** (*string*) – `'h'` for Heisenberg (default) or `'s'` for Schrödinger framework. **Returns** @@ -449,7 +449,7 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - **qubit\_wise** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **qubit\_wise** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – whether the commutation rule is applied to the whole operator, or on a per-qubit basis. For example: @@ -468,7 +468,7 @@ python_api_name: qiskit.quantum_info.PauliList **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")] ### group\_qubit\_wise\_commuting @@ -482,7 +482,7 @@ python_api_name: qiskit.quantum_info.PauliList **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[PauliList](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")] ### input\_dims @@ -500,9 +500,9 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - * **ind** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – index to insert at. + * **ind** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – index to insert at. * **value** ([*PauliList*](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – values to insert. - * **qubit** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if `True` insert qubit columns, otherwise insert Pauli rows (Default: `False`). + * **qubit** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if `True` insert qubit columns, otherwise insert Pauli rows (Default: `False`). **Returns** @@ -548,7 +548,7 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - **sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – optionally return sparse CSR matrices if `True`, otherwise return Numpy array matrices (Default: `False`) + **sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – optionally return sparse CSR matrices if `True`, otherwise return Numpy array matrices (Default: `False`) **Returns** @@ -568,7 +568,7 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - **qubit\_wise** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – whether the commutation rule is applied to the whole operator, or on a per-qubit basis. + **qubit\_wise** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – whether the commutation rule is applied to the whole operator, or on a per-qubit basis. **Returns** @@ -594,7 +594,7 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of times to compose with self (n>0). + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of times to compose with self (n>0). **Returns** @@ -616,9 +616,9 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** @@ -682,8 +682,8 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – optionally sort by weight if `True` (Default: `False`). - * **phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Optionally sort by phase before weight or order (Default: `False`). + * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – optionally sort by weight if `True` (Default: `False`). + * **phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Optionally sort by phase before weight or order (Default: `False`). **Returns** @@ -732,7 +732,7 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - **array** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – return a Numpy array if `True`, otherwise return a list (Default: `False`). + **array** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – return a Numpy array if `True`, otherwise return a list (Default: `False`). **Returns** @@ -740,7 +740,7 @@ python_api_name: qiskit.quantum_info.PauliList **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") or array + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") or array ### to\_matrix @@ -759,8 +759,8 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - * **sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if `True` return sparse CSR matrices, otherwise return dense Numpy arrays (Default: `False`). - * **array** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – return as rank-3 numpy array if `True`, otherwise return a list of Numpy arrays (Default: `False`). + * **sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if `True` return sparse CSR matrices, otherwise return dense Numpy arrays (Default: `False`). + * **array** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – return as rank-3 numpy array if `True`, otherwise return a list of Numpy arrays (Default: `False`). **Returns** @@ -768,7 +768,7 @@ python_api_name: qiskit.quantum_info.PauliList **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") ### transpose @@ -798,8 +798,8 @@ python_api_name: qiskit.quantum_info.PauliList **Parameters** - * **return\_index** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, also return the indices that result in the unique array. (Default: `False`) - * **return\_counts** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, also return the number of times each unique item appears in the table. + * **return\_index** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, also return the indices that result in the unique array. (Default: `False`) + * **return\_counts** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, also return the number of times each unique item appears in the table. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.PhasedQubitSparsePauli.mdx b/docs/api/qiskit/qiskit.quantum_info.PhasedQubitSparsePauli.mdx index 856cfcc55a5..7b065f87c6d 100644 --- a/docs/api/qiskit/qiskit.quantum_info.PhasedQubitSparsePauli.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.PhasedQubitSparsePauli.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauli # PhasedQubitSparsePauli - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A Pauli operator stored in a qubit-sparse format. @@ -44,7 +44,7 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauli **Parameters** * **data** – The data type of the input. This can be another [`QubitSparsePauli`](qiskit.quantum_info.QubitSparsePauli "qiskit.quantum_info.QubitSparsePauli"), in which case the input is copied, or it can be a valid format for either [`from_label()`](#qiskit.quantum_info.PhasedQubitSparsePauli.from_label "qiskit.quantum_info.PhasedQubitSparsePauli.from_label") or [`from_sparse_label()`](#qiskit.quantum_info.PhasedQubitSparsePauli.from_sparse_label "qiskit.quantum_info.PhasedQubitSparsePauli.from_sparse_label"). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*|None*) – Optional number of qubits for the operator. For most data inputs, this can be inferred and need not be passed. It is only necessary for the sparse-label format. If given unnecessarily, it must match the data input. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*|None*) – Optional number of qubits for the operator. For most data inputs, this can be inferred and need not be passed. It is only necessary for the sparse-label format. If given unnecessarily, it must match the data input. ## Attributes @@ -114,7 +114,7 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauli **Parameters** - **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the dense label. + **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the dense label. **Examples** @@ -184,8 +184,8 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauli **Parameters** - * **sparse\_label** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – labels and the qubits each single-qubit term applies to. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits the operator acts on. + * **sparse\_label** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – labels and the qubits each single-qubit term applies to. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits the operator acts on. **Examples** diff --git a/docs/api/qiskit/qiskit.quantum_info.PhasedQubitSparsePauliList.mdx b/docs/api/qiskit/qiskit.quantum_info.PhasedQubitSparsePauliList.mdx index b3b3665b0fd..4e3a8930694 100644 --- a/docs/api/qiskit/qiskit.quantum_info.PhasedQubitSparsePauliList.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.PhasedQubitSparsePauliList.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauliList # PhasedQubitSparsePauliList - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A list of Pauli operators with phases stored in a qubit-sparse format. @@ -19,7 +19,7 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauliList ### Indexing - [`PhasedQubitSparsePauliList`](#qiskit.quantum_info.PhasedQubitSparsePauliList "qiskit.quantum_info.PhasedQubitSparsePauliList") behaves as [a Python sequence](https://docs.python.org/3/glossary.html#term-sequence) (the standard form, not the expanded [`collections.abc.Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")). The elements of the list can be indexed by integers, as well as iterated through. Whether through indexing or iterating, elements of the list are returned as [`PhasedQubitSparsePauli`](qiskit.quantum_info.PhasedQubitSparsePauli "qiskit.quantum_info.PhasedQubitSparsePauli") instances. + [`PhasedQubitSparsePauliList`](#qiskit.quantum_info.PhasedQubitSparsePauliList "qiskit.quantum_info.PhasedQubitSparsePauliList") behaves as [a Python sequence](https://docs.python.org/3/glossary.html#term-sequence) (the standard form, not the expanded [`collections.abc.Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")). The elements of the list can be indexed by integers, as well as iterated through. Whether through indexing or iterating, elements of the list are returned as [`PhasedQubitSparsePauli`](qiskit.quantum_info.PhasedQubitSparsePauli "qiskit.quantum_info.PhasedQubitSparsePauli") instances. ## Construction @@ -45,7 +45,7 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauliList **Parameters** * **data** – The data type of the input. This can be another [`PhasedQubitSparsePauliList`](#qiskit.quantum_info.PhasedQubitSparsePauliList "qiskit.quantum_info.PhasedQubitSparsePauliList"), in which case the input is copied, or it can be a list in a valid format for either [`from_list()`](#qiskit.quantum_info.PhasedQubitSparsePauliList.from_list "qiskit.quantum_info.PhasedQubitSparsePauliList.from_list") or [`from_sparse_list()`](#qiskit.quantum_info.PhasedQubitSparsePauliList.from_sparse_list "qiskit.quantum_info.PhasedQubitSparsePauliList.from_sparse_list"). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*|None*) – Optional number of qubits for the list. For most data inputs, this can be inferred and need not be passed. It is only necessary for empty lists or the sparse-list format. If given unnecessarily, it must match the data input. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*|None*) – Optional number of qubits for the list. For most data inputs, this can be inferred and need not be passed. It is only necessary for empty lists or the sparse-list format. If given unnecessarily, it must match the data input. In addition to the conversion-based constructors, the method [`empty()`](#qiskit.quantum_info.PhasedQubitSparsePauliList.empty "qiskit.quantum_info.PhasedQubitSparsePauliList.empty") can be used to construct an empty list of phased qubit-sparse Paulis acting on a given number of qubits. @@ -85,8 +85,8 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauliList **Parameters** - * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – The layout to apply. Most uses of this function should pass the [`QuantumCircuit.layout`](qiskit.circuit.QuantumCircuit#layout "qiskit.circuit.QuantumCircuit.layout") field from a circuit that was transpiled for hardware. In addition, you can pass a list of new qubit indices. If given as explicitly `None`, no remapping is applied (but you can still use `num_qubits` to expand the qubits in the list). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits to expand the list elements to. If not supplied, the output will be as wide as the given [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), or the same width as the input if the `layout` is given in another form. + * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – The layout to apply. Most uses of this function should pass the [`QuantumCircuit.layout`](qiskit.circuit.QuantumCircuit#layout "qiskit.circuit.QuantumCircuit.layout") field from a circuit that was transpiled for hardware. In addition, you can pass a list of new qubit indices. If given as explicitly `None`, no remapping is applied (but you can still use `num_qubits` to expand the qubits in the list). + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits to expand the list elements to. If not supplied, the output will be as wide as the given [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), or the same width as the input if the `layout` is given in another form. **Returns** @@ -149,7 +149,7 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauliList **Parameters** - **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the dense label. + **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the dense label. **Examples** @@ -179,8 +179,8 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauliList **Parameters** - * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – List of dense string labels. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – It is not necessary to specify this if you are sure that `iter` is not an empty sequence, since it can be inferred from the label lengths. If `iter` may be empty, you must specify this argument to disambiguate how many qubits the operators act on. If this is given and `iter` is not empty, the value must match the label lengths. + * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – List of dense string labels. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – It is not necessary to specify this if you are sure that `iter` is not an empty sequence, since it can be inferred from the label lengths. If `iter` may be empty, you must specify this argument to disambiguate how many qubits the operators act on. If this is given and `iter` is not empty, the value must match the label lengths. **Examples** @@ -255,7 +255,7 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauliList **Parameters** * **obj** (*Iterable\[*[*PhasedQubitSparsePauli*](qiskit.quantum_info.PhasedQubitSparsePauli "qiskit.quantum_info.PhasedQubitSparsePauli")*]*) – Iterable of individual terms to build the list from. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits the elements of the list should act on. This is usually inferred from the input, but can be explicitly given to handle the case of an empty iterable. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits the elements of the list should act on. This is usually inferred from the input, but can be explicitly given to handle the case of an empty iterable. **Returns** @@ -273,8 +273,8 @@ python_api_name: qiskit.quantum_info.PhasedQubitSparsePauliList **Parameters** - * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]*) – tuples of phase exponents, labels, and the qubits each single-qubit term applies to. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits the operators in the list act on. + * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]]*) – tuples of phase exponents, labels, and the qubits each single-qubit term applies to. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits the operators in the list act on. **Examples** diff --git a/docs/api/qiskit/qiskit.quantum_info.Quaternion.mdx b/docs/api/qiskit/qiskit.quantum_info.Quaternion.mdx index e0769dc1032..a4564ede8dc 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Quaternion.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Quaternion.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.quantum_info.Quaternion # Quaternion - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A class representing a Quaternion. @@ -22,8 +22,8 @@ python_api_name: qiskit.quantum_info.Quaternion **Parameters** - * **angle** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Angle in radians. - * **axis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Axis for rotation + * **angle** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Angle in radians. + * **axis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Axis for rotation **Returns** @@ -35,7 +35,7 @@ python_api_name: qiskit.quantum_info.Quaternion **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – Invalid input axis. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – Invalid input axis. ### from\_euler @@ -46,7 +46,7 @@ python_api_name: qiskit.quantum_info.Quaternion **Parameters** * **angles** (*array\_like*) – Array of Euler angles. - * **order** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Order of Euler rotations. ‘yzy’ is default. + * **order** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Order of Euler rotations. ‘yzy’ is default. **Returns** @@ -70,7 +70,7 @@ python_api_name: qiskit.quantum_info.Quaternion **Parameters** - **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Do an inplace normalization. + **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Do an inplace normalization. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.QubitSparsePauli.mdx b/docs/api/qiskit/qiskit.quantum_info.QubitSparsePauli.mdx index a5cdab531ed..c3f7b84a47f 100644 --- a/docs/api/qiskit/qiskit.quantum_info.QubitSparsePauli.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.QubitSparsePauli.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.quantum_info.QubitSparsePauli # QubitSparsePauli - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A phase-less Pauli operator stored in a qubit-sparse format. @@ -42,7 +42,7 @@ python_api_name: qiskit.quantum_info.QubitSparsePauli ### Pauli - An [`IntEnum`](https://docs.python.org/3/library/enum.html#enum.IntEnum "(in Python v3.13)") that provides named access to the numerical values used to represent each of the single-qubit alphabet terms enumerated in [Alphabet of single-qubit Pauli operators used in QubitSparsePauliList](#qubit-sparse-pauli-alphabet). + An [`IntEnum`](https://docs.python.org/3/library/enum.html#enum.IntEnum "(in Python v3.14)") that provides named access to the numerical values used to represent each of the single-qubit alphabet terms enumerated in [Alphabet of single-qubit Pauli operators used in QubitSparsePauliList](#qubit-sparse-pauli-alphabet). This class is attached to [`QubitSparsePauli`](#qiskit.quantum_info.QubitSparsePauli "qiskit.quantum_info.QubitSparsePauli"). Access it as [`QubitSparsePauli.Pauli`](#qiskit.quantum_info.QubitSparsePauli.Pauli "qiskit.quantum_info.QubitSparsePauli.Pauli"). If this is too much typing, and you are solely dealing with [`QubitSparsePauliList`](qiskit.quantum_info.QubitSparsePauliList "qiskit.quantum_info.QubitSparsePauliList") objects and the [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") name is not ambiguous, you might want to shorten it as: @@ -80,7 +80,7 @@ python_api_name: qiskit.quantum_info.QubitSparsePauli - Each of the array-like attributes behaves like a Python sequence. You can index and slice these with standard [`list`](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")-like semantics. Slicing an attribute returns a Numpy [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)") containing a copy of the relevant data with the natural `dtype` of the field; this lets you easily do mathematics on the results, like bitwise operations on [`paulis`](#qiskit.quantum_info.QubitSparsePauli.paulis "qiskit.quantum_info.QubitSparsePauli.paulis"). + Each of the array-like attributes behaves like a Python sequence. You can index and slice these with standard [`list`](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")-like semantics. Slicing an attribute returns a Numpy [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)") containing a copy of the relevant data with the natural `dtype` of the field; this lets you easily do mathematics on the results, like bitwise operations on [`paulis`](#qiskit.quantum_info.QubitSparsePauli.paulis "qiskit.quantum_info.QubitSparsePauli.paulis"). ## Construction @@ -105,7 +105,7 @@ python_api_name: qiskit.quantum_info.QubitSparsePauli **Parameters** * **data** – The data type of the input. This can be another [`QubitSparsePauli`](#qiskit.quantum_info.QubitSparsePauli "qiskit.quantum_info.QubitSparsePauli"), in which case the input is copied, or it can be a valid format for either [`from_label()`](#qiskit.quantum_info.QubitSparsePauli.from_label "qiskit.quantum_info.QubitSparsePauli.from_label") or [`from_sparse_label()`](#qiskit.quantum_info.QubitSparsePauli.from_sparse_label "qiskit.quantum_info.QubitSparsePauli.from_sparse_label"). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*|None*) – Optional number of qubits for the operator. For most data inputs, this can be inferred and need not be passed. It is only necessary for the sparse-label format. If given unnecessarily, it must match the data input. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*|None*) – Optional number of qubits for the operator. For most data inputs, this can be inferred and need not be passed. It is only necessary for the sparse-label format. If given unnecessarily, it must match the data input. ## Attributes @@ -169,7 +169,7 @@ python_api_name: qiskit.quantum_info.QubitSparsePauli **Parameters** - **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the dense label. + **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the dense label. **Examples** @@ -239,8 +239,8 @@ python_api_name: qiskit.quantum_info.QubitSparsePauli **Parameters** - * **sparse\_label** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – labels and the qubits each single-qubit term applies to. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits the operator acts on. + * **sparse\_label** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – labels and the qubits each single-qubit term applies to. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits the operator acts on. **Examples** diff --git a/docs/api/qiskit/qiskit.quantum_info.QubitSparsePauliList.mdx b/docs/api/qiskit/qiskit.quantum_info.QubitSparsePauliList.mdx index 45a58e905e4..888ad5efaa0 100644 --- a/docs/api/qiskit/qiskit.quantum_info.QubitSparsePauliList.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.QubitSparsePauliList.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.quantum_info.QubitSparsePauliList # QubitSparsePauliList - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A list of phase-less Pauli operators stored in a qubit-sparse format. @@ -19,7 +19,7 @@ python_api_name: qiskit.quantum_info.QubitSparsePauliList ### Indexing - [`QubitSparsePauliList`](#qiskit.quantum_info.QubitSparsePauliList "qiskit.quantum_info.QubitSparsePauliList") behaves as [a Python sequence](https://docs.python.org/3/glossary.html#term-sequence) (the standard form, not the expanded [`collections.abc.Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")). The elements of the list can be indexed by integers, as well as iterated through. Whether through indexing or iterating, elements of the list are returned as [`QubitSparsePauli`](qiskit.quantum_info.QubitSparsePauli "qiskit.quantum_info.QubitSparsePauli") instances. + [`QubitSparsePauliList`](#qiskit.quantum_info.QubitSparsePauliList "qiskit.quantum_info.QubitSparsePauliList") behaves as [a Python sequence](https://docs.python.org/3/glossary.html#term-sequence) (the standard form, not the expanded [`collections.abc.Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")). The elements of the list can be indexed by integers, as well as iterated through. Whether through indexing or iterating, elements of the list are returned as [`QubitSparsePauli`](qiskit.quantum_info.QubitSparsePauli "qiskit.quantum_info.QubitSparsePauli") instances. ## Construction @@ -45,7 +45,7 @@ python_api_name: qiskit.quantum_info.QubitSparsePauliList **Parameters** * **data** – The data type of the input. This can be another [`QubitSparsePauliList`](#qiskit.quantum_info.QubitSparsePauliList "qiskit.quantum_info.QubitSparsePauliList"), in which case the input is copied, or it can be a list in a valid format for either [`from_list()`](#qiskit.quantum_info.QubitSparsePauliList.from_list "qiskit.quantum_info.QubitSparsePauliList.from_list") or [`from_sparse_list()`](#qiskit.quantum_info.QubitSparsePauliList.from_sparse_list "qiskit.quantum_info.QubitSparsePauliList.from_sparse_list"). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*|None*) – Optional number of qubits for the list. For most data inputs, this can be inferred and need not be passed. It is only necessary for empty lists or the sparse-list format. If given unnecessarily, it must match the data input. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*|None*) – Optional number of qubits for the list. For most data inputs, this can be inferred and need not be passed. It is only necessary for empty lists or the sparse-list format. If given unnecessarily, it must match the data input. In addition to the conversion-based constructors, the method [`empty()`](#qiskit.quantum_info.QubitSparsePauliList.empty "qiskit.quantum_info.QubitSparsePauliList.empty") can be used to construct an empty list of qubit-sparse Paulis acting on a given number of qubits. @@ -85,8 +85,8 @@ python_api_name: qiskit.quantum_info.QubitSparsePauliList **Parameters** - * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – The layout to apply. Most uses of this function should pass the [`QuantumCircuit.layout`](qiskit.circuit.QuantumCircuit#layout "qiskit.circuit.QuantumCircuit.layout") field from a circuit that was transpiled for hardware. In addition, you can pass a list of new qubit indices. If given as explicitly `None`, no remapping is applied (but you can still use `num_qubits` to expand the qubits in the list). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits to expand the list elements to. If not supplied, the output will be as wide as the given [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), or the same width as the input if the `layout` is given in another form. + * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – The layout to apply. Most uses of this function should pass the [`QuantumCircuit.layout`](qiskit.circuit.QuantumCircuit#layout "qiskit.circuit.QuantumCircuit.layout") field from a circuit that was transpiled for hardware. In addition, you can pass a list of new qubit indices. If given as explicitly `None`, no remapping is applied (but you can still use `num_qubits` to expand the qubits in the list). + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits to expand the list elements to. If not supplied, the output will be as wide as the given [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), or the same width as the input if the `layout` is given in another form. **Returns** @@ -149,7 +149,7 @@ python_api_name: qiskit.quantum_info.QubitSparsePauliList **Parameters** - **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the dense label. + **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the dense label. **Examples** @@ -179,8 +179,8 @@ python_api_name: qiskit.quantum_info.QubitSparsePauliList **Parameters** - * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – List of dense string labels. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – It is not necessary to specify this if you are sure that `iter` is not an empty sequence, since it can be inferred from the label lengths. If `iter` may be empty, you must specify this argument to disambiguate how many qubits the operators act on. If this is given and `iter` is not empty, the value must match the label lengths. + * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – List of dense string labels. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – It is not necessary to specify this if you are sure that `iter` is not an empty sequence, since it can be inferred from the label lengths. If `iter` may be empty, you must specify this argument to disambiguate how many qubits the operators act on. If this is given and `iter` is not empty, the value must match the label lengths. **Examples** @@ -255,7 +255,7 @@ python_api_name: qiskit.quantum_info.QubitSparsePauliList **Parameters** * **obj** (*Iterable\[*[*QubitSparsePauli*](qiskit.quantum_info.QubitSparsePauli "qiskit.quantum_info.QubitSparsePauli")*]*) – Iterable of individual terms to build the list from. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits the elements of the list should act on. This is usually inferred from the input, but can be explicitly given to handle the case of an empty iterable. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits the elements of the list should act on. This is usually inferred from the input, but can be explicitly given to handle the case of an empty iterable. **Returns** @@ -273,8 +273,8 @@ python_api_name: qiskit.quantum_info.QubitSparsePauliList **Parameters** - * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]*) – tuples of labels and the qubits each single-qubit term applies to. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits the operators in the list act on. + * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]]*) – tuples of labels and the qubits each single-qubit term applies to. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits the operators in the list act on. **Examples** diff --git a/docs/api/qiskit/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/qiskit.quantum_info.ScalarOp.mdx index e728fcb6601..4dc788f0220 100644 --- a/docs/api/qiskit/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.ScalarOp.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.quantum_info.ScalarOp **Parameters** - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – subsystem dimensions. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – subsystem dimensions. * **coeff** (*Number*) – scalar coefficient for the identity operator (Default: 1). **Raises** @@ -80,8 +80,8 @@ python_api_name: qiskit.quantum_info.ScalarOp **Parameters** * **other** ([*ScalarOp*](#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – a ScalarOp object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. **Returns** @@ -122,7 +122,7 @@ python_api_name: qiskit.quantum_info.ScalarOp **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). **Returns** @@ -182,7 +182,7 @@ python_api_name: qiskit.quantum_info.ScalarOp **Parameters** - **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the exponent for the scalar op. + **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the exponent for the scalar op. **Returns** @@ -200,9 +200,9 @@ python_api_name: qiskit.quantum_info.ScalarOp **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.SparseObservable.mdx b/docs/api/qiskit/qiskit.quantum_info.SparseObservable.mdx index 0b9a113f94a..cb392011d2c 100644 --- a/docs/api/qiskit/qiskit.quantum_info.SparseObservable.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.SparseObservable.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.quantum_info.SparseObservable # SparseObservable - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") An observable over Pauli bases that stores its data in a qubit-sparse format. @@ -76,7 +76,7 @@ $$ ### BitTerm - An [`IntEnum`](https://docs.python.org/3/library/enum.html#enum.IntEnum "(in Python v3.13)") that provides named access to the numerical values used to represent each of the single-qubit alphabet terms enumerated in [Alphabet of single-qubit terms used in SparseObservable](#sparse-observable-alphabet). + An [`IntEnum`](https://docs.python.org/3/library/enum.html#enum.IntEnum "(in Python v3.14)") that provides named access to the numerical values used to represent each of the single-qubit alphabet terms enumerated in [Alphabet of single-qubit terms used in SparseObservable](#sparse-observable-alphabet). This class is attached to [`SparseObservable`](#qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable"). Access it as [`SparseObservable.BitTerm`](#qiskit.quantum_info.SparseObservable.BitTerm "qiskit.quantum_info.SparseObservable.BitTerm"). If this is too much typing, and you are solely dealing with :class:¬SparseObservable\` objects and the `BitTerm` name is not ambiguous, you might want to shorten it as: @@ -158,7 +158,7 @@ $$ - Each of the array-like attributes behaves like a Python sequence. You can index and slice these with standard [`list`](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")-like semantics. Slicing an attribute returns a Numpy [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)") containing a copy of the relevant data with the natural `dtype` of the field; this lets you easily do mathematics on the results, like bitwise operations on [`bit_terms`](#qiskit.quantum_info.SparseObservable.bit_terms "qiskit.quantum_info.SparseObservable.bit_terms"). You can assign to indices or slices of each of the attributes, but beware that you must uphold [the data coherence rules](#sparse-observable-arrays) while doing this. For example: + Each of the array-like attributes behaves like a Python sequence. You can index and slice these with standard [`list`](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")-like semantics. Slicing an attribute returns a Numpy [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)") containing a copy of the relevant data with the natural `dtype` of the field; this lets you easily do mathematics on the results, like bitwise operations on [`bit_terms`](#qiskit.quantum_info.SparseObservable.bit_terms "qiskit.quantum_info.SparseObservable.bit_terms"). You can assign to indices or slices of each of the attributes, but beware that you must uphold [the data coherence rules](#sparse-observable-arrays) while doing this. For example: ```python >>> obs = SparseObservable.from_list([("XZY", 1.5j), ("+1r", -0.5)]) @@ -197,14 +197,14 @@ $$ ### Indexing - [`SparseObservable`](#qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") behaves as [a Python sequence](https://docs.python.org/3/glossary.html#term-sequence) (the standard form, not the expanded [`collections.abc.Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")). The observable can be indexed by integers, and iterated through to yield individual terms. + [`SparseObservable`](#qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") behaves as [a Python sequence](https://docs.python.org/3/glossary.html#term-sequence) (the standard form, not the expanded [`collections.abc.Sequence`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.14)")). The observable can be indexed by integers, and iterated through to yield individual terms. Each term appears as an instance a self-contained class. The individual terms are copied out of the base observable; mutations to them will not affect the observable. #### Term - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A single term from a complete [`SparseObservable`](#qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable"). @@ -307,7 +307,7 @@ $$ **Parameters** * **data** – The data type of the input. This can be another [`SparseObservable`](#qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable"), in which case the input is copied, a [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") or [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"), in which case [`from_pauli()`](#qiskit.quantum_info.SparseObservable.from_pauli "qiskit.quantum_info.SparseObservable.from_pauli") or [`from_sparse_pauli_op()`](#qiskit.quantum_info.SparseObservable.from_sparse_pauli_op "qiskit.quantum_info.SparseObservable.from_sparse_pauli_op") are called as appropriate, or it can be a list in a valid format for either [`from_list()`](#qiskit.quantum_info.SparseObservable.from_list "qiskit.quantum_info.SparseObservable.from_list") or [`from_sparse_list()`](#qiskit.quantum_info.SparseObservable.from_sparse_list "qiskit.quantum_info.SparseObservable.from_sparse_list"). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*|None*) – Optional number of qubits for the operator. For most data inputs, this can be inferred and need not be passed. It is only necessary for empty lists or the sparse-list format. If given unnecessarily, it must match the data input. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*|None*) – Optional number of qubits for the operator. For most data inputs, this can be inferred and need not be passed. It is only necessary for empty lists or the sparse-list format. If given unnecessarily, it must match the data input. In addition to the conversion-based constructors, there are also helper methods that construct special forms of observables. @@ -336,7 +336,7 @@ $$ * add two observables using `+` * subtract two observables using `-` - * multiply or divide by an [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)"), [`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") or [`complex`](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)") using `*` and `/` + * multiply or divide by an [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)"), [`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") or [`complex`](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)") using `*` and `/` * negate all the coefficients in an observable with unary `-` Each of the basic binary arithmetic operators has a corresponding specialized in-place method, which mutates the left-hand side in-place. Using these is typically more efficient than the infix operators, especially for building an observable in a loop. @@ -428,8 +428,8 @@ $$ **Parameters** - * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – The layout to apply. Most uses of this function should pass the [`QuantumCircuit.layout`](qiskit.circuit.QuantumCircuit#layout "qiskit.circuit.QuantumCircuit.layout") field from a circuit that was transpiled for hardware. In addition, you can pass a list of new qubit indices. If given as explicitly `None`, no remapping is applied (but you can still use `num_qubits` to expand the observable). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits to expand the observable to. If not supplied, the output will be as wide as the given [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), or the same width as the input if the `layout` is given in another form. + * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – The layout to apply. Most uses of this function should pass the [`QuantumCircuit.layout`](qiskit.circuit.QuantumCircuit#layout "qiskit.circuit.QuantumCircuit.layout") field from a circuit that was transpiled for hardware. In addition, you can pass a list of new qubit indices. If given as explicitly `None`, no remapping is applied (but you can still use `num_qubits` to expand the observable). + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits to expand the observable to. If not supplied, the output will be as wide as the given [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), or the same width as the input if the `layout` is given in another form. **Returns** @@ -594,7 +594,7 @@ $$ **Parameters** - **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the dense label. + **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the dense label. **Examples** @@ -624,8 +624,8 @@ $$ **Parameters** - * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")*]]*) – Pairs of labels and their associated coefficients to sum. The labels are interpreted the same way as in [`from_label()`](#qiskit.quantum_info.SparseObservable.from_label "qiskit.quantum_info.SparseObservable.from_label"). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – It is not necessary to specify this if you are sure that `iter` is not an empty sequence, since it can be inferred from the label lengths. If `iter` may be empty, you must specify this argument to disambiguate how many qubits the observable is for. If this is given and `iter` is not empty, the value must match the label lengths. + * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")*]]*) – Pairs of labels and their associated coefficients to sum. The labels are interpreted the same way as in [`from_label()`](#qiskit.quantum_info.SparseObservable.from_label "qiskit.quantum_info.SparseObservable.from_label"). + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – It is not necessary to specify this if you are sure that `iter` is not an empty sequence, since it can be inferred from the label lengths. If `iter` may be empty, you must specify this argument to disambiguate how many qubits the observable is for. If this is given and `iter` is not empty, the value must match the label lengths. **Examples** @@ -748,8 +748,8 @@ $$ **Parameters** - * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")*]]*) – triples of labels, the qubits each single-qubit term applies to, and the coefficient of the entire term. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits in the operator. + * **iter** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")*]]*) – triples of labels, the qubits each single-qubit term applies to, and the coefficient of the entire term. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits in the operator. **Examples** @@ -822,7 +822,7 @@ $$ **Parameters** * **obj** (*Iterable\[*[*Term*](#qiskit.quantum_info.SparseObservable.Term "qiskit.quantum_info.SparseObservable.Term")*]*) – Iterable of individual terms to build the observable from. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits the observable should act on. This is usually inferred from the input, but can be explicitly given to handle the case of an empty iterable. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits the observable should act on. This is usually inferred from the input, but can be explicitly given to handle the case of an empty iterable. **Returns** @@ -875,7 +875,7 @@ $$ **Parameters** - **tol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – after summing like terms, any coefficients whose absolute value is less than the given absolute tolerance will be suppressed from the output. + **tol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – after summing like terms, any coefficients whose absolute value is less than the given absolute tolerance will be suppressed from the output. **Examples** diff --git a/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.mdx index 53853776db2..1e1d4572f03 100644 --- a/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.mdx @@ -49,7 +49,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp **Parameters** - * **data** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") *or*[*SparsePauliOp*](#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Pauli list of terms. A list of Pauli strings or a Pauli string is also allowed. + * **data** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") *or*[*SparsePauliOp*](#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Pauli list of terms. A list of Pauli strings or a Pauli string is also allowed. * **coeffs** (*np.ndarray*) – @@ -59,9 +59,9 @@ python_api_name: qiskit.quantum_info.SparsePauliOp If `data` is a [`SparsePauliOp`](#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") and `coeffs` is not `None`, the value of the `SparsePauliOp.coeffs` will be ignored, and only the passed keyword argument `coeffs` will be used. - * **ignore\_pauli\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if true, any `phase` component of a given [`PauliList`](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") will be assumed to be zero. This is more efficient in cases where a [`PauliList`](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") has been constructed purely for this object, and it is already known that the phases in the ZX-convention are zero. It only makes sense to pass this option when giving [`PauliList`](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") data. (Default: False) + * **ignore\_pauli\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if true, any `phase` component of a given [`PauliList`](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") will be assumed to be zero. This is more efficient in cases where a [`PauliList`](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") has been constructed purely for this object, and it is already known that the phases in the ZX-convention are zero. It only makes sense to pass this option when giving [`PauliList`](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") data. (Default: False) - * **copy** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – copy the input data if True, otherwise assign it directly, if possible. (Default: True) + * **copy** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – copy the input data if True, otherwise assign it directly, if possible. (Default: True) **Raises** @@ -140,8 +140,8 @@ python_api_name: qiskit.quantum_info.SparsePauliOp **Parameters** - * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *| List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – Either a [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), a list of integers or None. If both layout and num\_qubits are none, a copy of the operator is returned. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits to expand the operator to. If not provided then if `layout` is a [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") the number of the transpiler output circuit qubits will be used by default. If `layout` is a list of integers the permutation specified will be applied without any expansion. If layout is None, the operator will be expanded to the given number of qubits. + * **layout** ([*TranspileLayout*](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") *| List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – Either a [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout"), a list of integers or None. If both layout and num\_qubits are none, a copy of the operator is returned. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits to expand the operator to. If not provided then if `layout` is a [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") the number of the transpiler output circuit qubits will be used by default. If `layout` is a list of integers the permutation specified will be applied without any expansion. If layout is None, the operator will be expanded to the given number of qubits. **Returns** @@ -207,7 +207,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp **Parameters** - * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – optionally sort by weight if True (Default: False). + * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – optionally sort by weight if True (Default: False). * **sorted** (*By using the weight kwarg the output can additionally be*) – * **Pauli.** (*by the number of non-identity terms in the*) – @@ -226,13 +226,13 @@ python_api_name: qiskit.quantum_info.SparsePauliOp Bind the free `Parameter`s in the coefficients to provided values. - If all the parameters in the circuit are bound to numeric values, the coefficients array will be returned with a [`complex`](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)") dtype. + If all the parameters in the circuit are bound to numeric values, the coefficients array will be returned with a [`complex`](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)") dtype. **Parameters** - * **parameters** (*Mapping\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*] | Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]*) – The values to bind the parameters to. - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `False`, a copy of the operator with the bound parameters is returned. If `True` the operator itself is modified. + * **parameters** (*Mapping\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*] | Sequence\[*[*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*]*) – The values to bind the parameters to. + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `False`, a copy of the operator with the bound parameters is returned. If `True` the operator itself is modified. **Returns** @@ -254,7 +254,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp **Parameters** - **tol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The absolute tolerance to check whether a real or imaginary part should be set to 0. + **tol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The absolute tolerance to check whether a real or imaginary part should be set to 0. **Returns** @@ -273,8 +273,8 @@ python_api_name: qiskit.quantum_info.SparsePauliOp **Parameters** * **other** ([*SparsePauliOp*](#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")) – a SparsePauliOp object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. **Returns** @@ -315,7 +315,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). **Returns** @@ -338,7 +338,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp **Parameters** * **other** ([*SparsePauliOp*](#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")) – an operator object. - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – Absolute numerical tolerance for checking equivalence. + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – Absolute numerical tolerance for checking equivalence. **Returns** @@ -346,7 +346,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### expand @@ -391,9 +391,9 @@ $$ **Parameters** - * **obj** (*Iterable\[Tuple\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")*]]*) – The list of 2-tuples specifying the Pauli terms. - * **dtype** ([*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)")) – The dtype of coeffs (Default: complex). - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits of the operator (Default: None). + * **obj** (*Iterable\[Tuple\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")*]]*) – The list of 2-tuples specifying the Pauli terms. + * **dtype** ([*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)")) – The dtype of coeffs (Default: complex). + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits of the operator (Default: None). **Returns** @@ -421,8 +421,8 @@ $$ **Parameters** * **obj** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an N-qubit operator. - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Optional. Absolute tolerance for checking if coefficients are zero (Default: 1e-8). Since the comparison is to zero, in effect the tolerance used is the maximum of `atol` and `rtol`. - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Optional. relative tolerance for checking if coefficients are zero (Default: 1e-5). Since the comparison is to zero, in effect the tolerance used is the maximum of `atol` and `rtol`. + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Optional. Absolute tolerance for checking if coefficients are zero (Default: 1e-8). Since the comparison is to zero, in effect the tolerance used is the maximum of `atol` and `rtol`. + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Optional. relative tolerance for checking if coefficients are zero (Default: 1e-5). Since the comparison is to zero, in effect the tolerance used is the maximum of `atol` and `rtol`. **Returns** @@ -464,11 +464,11 @@ $$ **Parameters** - * **obj** (*Iterable\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")*]]*) – The list 3-tuples specifying the Paulis. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits of the operator. - * **do\_checks** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – The flag of checking if the input indices are not duplicated + * **obj** (*Iterable\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*],* [*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")*]]*) – The list 3-tuples specifying the Paulis. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits of the operator. + * **do\_checks** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – The flag of checking if the input indices are not duplicated * \*\*(\*\***Default** – True). - * **dtype** ([*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.13)")) – The dtype of coeffs (Default: complex). + * **dtype** ([*type*](https://docs.python.org/3/library/functions.html#type "(in Python v3.14)")) – The dtype of coeffs (Default: complex). **Returns** @@ -513,7 +513,7 @@ $$ **Parameters** - **qubit\_wise** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **qubit\_wise** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – whether the commutation rule is applied to the whole operator, or on a per-qubit basis. For example: @@ -537,7 +537,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[SparsePauliOp](#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[SparsePauliOp](#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")] ### input\_dims @@ -555,8 +555,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Optional. Absolute tolerance for checking if coefficients are zero (Default: 1e-8). - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Optional. Relative tolerance for checking if coefficients are zero (Default: 1e-5). + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Optional. Absolute tolerance for checking if coefficients are zero (Default: 1e-8). + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Optional. Relative tolerance for checking if coefficients are zero (Default: 1e-5). **Returns** @@ -564,7 +564,7 @@ $$ **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### label\_iter @@ -592,7 +592,7 @@ $$ **Parameters** - **sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – optionally return sparse CSR matrices if True, otherwise return Numpy array matrices (Default: False) + **sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – optionally return sparse CSR matrices if True, otherwise return Numpy array matrices (Default: False) **Returns** @@ -612,7 +612,7 @@ $$ **Parameters** - **qubit\_wise** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – whether the commutation rule is applied to the whole operator, or on a per-qubit basis. + **qubit\_wise** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – whether the commutation rule is applied to the whole operator, or on a per-qubit basis. **Returns** @@ -638,7 +638,7 @@ $$ **Parameters** - **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of times to compose with self (n>0). + **n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of times to compose with self (n>0). **Returns** @@ -660,9 +660,9 @@ $$ **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** @@ -684,8 +684,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Optional. Absolute tolerance for checking if coefficients are zero (Default: 1e-8). - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Optional. relative tolerance for checking if coefficients are zero (Default: 1e-5). + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Optional. Absolute tolerance for checking if coefficients are zero (Default: 1e-8). + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Optional. relative tolerance for checking if coefficients are zero (Default: 1e-5). **Returns** @@ -754,7 +754,7 @@ $$ **Parameters** - * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – optionally sort by weight if True (Default: False). + * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – optionally sort by weight if True (Default: False). * **sorted** (*By using the weight kwarg the output can additionally be*) – * **Pauli.** (*by the number of non-identity terms in the*) – @@ -776,7 +776,7 @@ $$ **Parameters** - **ops** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*SparsePauliOp*](#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")*]*) – a list of SparsePauliOps. + **ops** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*SparsePauliOp*](#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")*]*) – a list of SparsePauliOps. **Returns** @@ -826,7 +826,7 @@ $$ **Parameters** - **array** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – return a Numpy array if True, otherwise return a list (Default: False). + **array** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – return a Numpy array if True, otherwise return a list (Default: False). **Returns** @@ -834,7 +834,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") or array + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") or array ### to\_matrix @@ -844,8 +844,8 @@ $$ **Parameters** - * **sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if `True` return a sparse CSR matrix, otherwise return dense Numpy array (the default). - * **force\_serial** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if `True`, use an unthreaded implementation, regardless of the state of the [Qiskit threading-control environment variables](/docs/guides/configure-qiskit-local#environment-variables). By default, this will use threaded parallelism over the available CPUs. + * **sparse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if `True` return a sparse CSR matrix, otherwise return dense Numpy array (the default). + * **force\_serial** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if `True`, use an unthreaded implementation, regardless of the state of the [Qiskit threading-control environment variables](/docs/guides/configure-qiskit-local#environment-variables). By default, this will use threaded parallelism over the available CPUs. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/qiskit.quantum_info.StabilizerState.mdx index 78e3f13a19f..cfb2c55d603 100644 --- a/docs/api/qiskit/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.StabilizerState.mdx @@ -57,7 +57,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** * **data** ([*StabilizerState*](#qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState") *|*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – Data from which the stabilizer state can be constructed. - * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – validate that the stabilizer state data is a valid Clifford. + * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – validate that the stabilizer state data is a valid Clifford. ## Attributes @@ -114,7 +114,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### evolve @@ -125,7 +125,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** * **other** ([*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – The Clifford operator to evolve by. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – a list of stabilizer subsystem positions to apply the operator on. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – a list of stabilizer subsystem positions to apply the operator on. **Returns** @@ -171,7 +171,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** * **oper** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")) – A Pauli or SparsePauliOp operator to evaluate the expectation value. - * **qargs** (*None |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – Subsystems to apply the operator on. + * **qargs** (*None |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – Subsystems to apply the operator on. **Returns** @@ -183,7 +183,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Return type** - [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)") + [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)") ### from\_stabilizer\_list @@ -193,9 +193,9 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** - * **stabilizers** (*Collection\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – list of stabilizer strings - * **allow\_redundant** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – allow redundant stabilizers (i.e., some stabilizers can be products of the others) - * **allow\_underconstrained** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – allow underconstrained set of stabilizers (i.e., the stabilizers do not specify a unique state) + * **stabilizers** (*Collection\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – list of stabilizer strings + * **allow\_redundant** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – allow redundant stabilizers (i.e., some stabilizers can be products of the others) + * **allow\_underconstrained** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – allow underconstrained set of stabilizers (i.e., the stabilizers do not specify a unique state) **Returns** @@ -221,7 +221,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** - **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). **Returns** @@ -231,7 +231,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") ### probabilities @@ -243,8 +243,8 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). - * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of decimal places to round values. If None no rounding is done (Default: None). + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). + * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of decimal places to round values. If None no rounding is done (Default: None). **Returns** @@ -266,8 +266,8 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). - * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of decimal places to round values. If None no rounding is done (Default: None). + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). + * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of decimal places to round values. If None no rounding is done (Default: None). **Returns** @@ -275,7 +275,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") ### probabilities\_dict\_from\_bitstring @@ -289,9 +289,9 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** - * **outcome\_bitstring** (*None or* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – targeted outcome bitstring to perform a measurement calculation for, this will significantly reduce the number of calculation performed (Default: None) - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). - * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of decimal places to round values. If None no rounding is done (Default: None) + * **outcome\_bitstring** (*None or* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – targeted outcome bitstring to perform a measurement calculation for, this will significantly reduce the number of calculation performed (Default: None) + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). + * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of decimal places to round values. If None no rounding is done (Default: None) **Returns** @@ -299,7 +299,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")] + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")] ### purity @@ -313,7 +313,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** @@ -327,7 +327,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** - **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – subsystems to reset, if None all subsystems will be reset to their 0-state (Default: None). + **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – subsystems to reset, if None all subsystems will be reset to their 0-state (Default: None). **Returns** @@ -349,8 +349,8 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** - * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of samples to generate. - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of samples to generate. + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). **Returns** @@ -374,8 +374,8 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** - * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of samples to generate. - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of samples to generate. + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). **Returns** @@ -441,7 +441,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** diff --git a/docs/api/qiskit/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/qiskit.quantum_info.Statevector.mdx index 4a71aebbff1..5fd07a93d03 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Statevector.mdx @@ -17,8 +17,8 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - * **data** (*np.ndarray |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *|*[*Statevector*](#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *|*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – Data from which the statevector can be constructed. This can be either a complex vector, another statevector, a `Operator` with only one column or a `QuantumCircuit` or `Instruction`. If the data is a circuit or instruction, the statevector is constructed by assuming that all qubits are initialized to the zero state. - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| None*) – The subsystem dimension of the state (See additional information). + * **data** (*np.ndarray |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *|*[*Statevector*](#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *|*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – Data from which the statevector can be constructed. This can be either a complex vector, another statevector, a `Operator` with only one column or a `QuantumCircuit` or `Instruction`. If the data is a circuit or instruction, the statevector is constructed by assuming that all qubits are initialized to the zero state. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *| None*) – The subsystem dimension of the state (See additional information). **Raises** @@ -114,16 +114,16 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - * **output** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Select the output method to use for drawing the state. Valid choices are repr, text, latex, latex\_source, qsphere, hinton, bloch, city, or paulivec. Default is repr. Default can be changed by adding the line `state_drawer = ` to `~/.qiskit/settings.conf` under `[default]`. + * **output** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Select the output method to use for drawing the state. Valid choices are repr, text, latex, latex\_source, qsphere, hinton, bloch, city, or paulivec. Default is repr. Default can be changed by adding the line `state_drawer = ` to `~/.qiskit/settings.conf` under `[default]`. * **drawer\_args** – Arguments to be passed directly to the relevant drawing function or constructor (TextMatrix(), array\_to\_latex(), plot\_state\_qsphere(), plot\_state\_hinton() or plot\_bloch\_multivector()). See the relevant function under qiskit.visualization for that function’s documentation. **Returns** - `matplotlib.Figure` or [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") or `TextMatrix` or `IPython.display.Latex`: Drawing of the Statevector. + `matplotlib.Figure` or [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") or `TextMatrix` or `IPython.display.Latex`: Drawing of the Statevector. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – when an invalid output method is selected. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – when an invalid output method is selected. **Examples** @@ -151,8 +151,8 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** * **other** ([*Statevector*](#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) – an object from which a `Statevector` can be constructed. - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – relative tolerance value for comparison. - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – absolute tolerance value for comparison. + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – relative tolerance value for comparison. + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – absolute tolerance value for comparison. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.quantum_info.Statevector **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### evolve @@ -171,7 +171,7 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – The operator to evolve by. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – a list of Statevector subsystem positions to apply the operator on. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – a list of Statevector subsystem positions to apply the operator on. **Returns** @@ -216,7 +216,7 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** * **oper** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator to evaluate expval of. - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to apply operator on. + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to apply operator on. **Returns** @@ -224,7 +224,7 @@ python_api_name: qiskit.quantum_info.Statevector **Return type** - [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)") + [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)") ### from\_instruction @@ -258,8 +258,8 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - * **i** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the basis state element. - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – The subsystem dimensions of the statevector (See additional information). + * **i** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the basis state element. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – The subsystem dimensions of the statevector (See additional information). **Returns** @@ -337,12 +337,12 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### measure @@ -354,7 +354,7 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). **Returns** @@ -364,7 +364,7 @@ python_api_name: qiskit.quantum_info.Statevector **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") ### probabilities @@ -376,8 +376,8 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). - * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of decimal places to round values. If None no rounding is done (Default: None). + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). + * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of decimal places to round values. If None no rounding is done (Default: None). **Returns** @@ -449,8 +449,8 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). - * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of decimal places to round values. If None no rounding is done (Default: None). + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to return probabilities for, if None return for all subsystems (Default: None). + * **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of decimal places to round values. If None no rounding is done (Default: None). **Returns** @@ -458,7 +458,7 @@ python_api_name: qiskit.quantum_info.Statevector **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") ### purity @@ -478,7 +478,7 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – subsystems to reset, if None all subsystems will be reset to their 0-state (Default: None). + **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – subsystems to reset, if None all subsystems will be reset to their 0-state (Default: None). **Returns** @@ -516,8 +516,8 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of samples to generate. - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of samples to generate. + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). **Returns** @@ -541,8 +541,8 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of samples to generate. - * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of samples to generate. + * **qargs** (*None or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). **Returns** @@ -596,7 +596,7 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of decimal places to round values. If None no rounding is done (Default: None). + **decimals** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of decimal places to round values. If None no rounding is done (Default: None). **Returns** @@ -604,7 +604,7 @@ python_api_name: qiskit.quantum_info.Statevector **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") **Example** diff --git a/docs/api/qiskit/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/qiskit.quantum_info.Stinespring.mdx index 5a3480205bb..248d59d7368 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Stinespring.mdx @@ -38,8 +38,8 @@ $$ **Parameters** * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. - * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. - * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the output subsystem dimensions. **Raises** @@ -111,8 +111,8 @@ $$ **Parameters** * **other** ([*Stinespring*](#qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring")) – a Stinespring object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. **Returns** @@ -157,7 +157,7 @@ $$ **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). **Returns** @@ -205,12 +205,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_cptp @@ -226,12 +226,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_unitary @@ -241,12 +241,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### output\_dims @@ -262,7 +262,7 @@ $$ **Parameters** - **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power exponent. + **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power exponent. **Returns** @@ -288,9 +288,9 @@ $$ **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/qiskit.quantum_info.SuperOp.mdx index 4b49f745abf..a8c4697cda9 100644 --- a/docs/api/qiskit/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.SuperOp.mdx @@ -32,8 +32,8 @@ $$ **Parameters** * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. + * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *| None*) – the output subsystem dimensions. **Raises** @@ -103,8 +103,8 @@ $$ **Parameters** * **other** ([*SuperOp*](#qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp")) – a SuperOp object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). - * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **front** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. **Returns** @@ -149,7 +149,7 @@ $$ **Parameters** * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). **Returns** @@ -197,12 +197,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_cptp @@ -212,12 +212,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_tp @@ -227,12 +227,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### is\_unitary @@ -242,12 +242,12 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### output\_dims @@ -263,7 +263,7 @@ $$ **Parameters** - **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – the power exponent. + **n** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – the power exponent. **Returns** @@ -289,9 +289,9 @@ $$ **Parameters** - * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. - * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. - * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – reshape to an N-qubit operator \[Default: None]. + * **input\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. + * **output\_dims** (*None or* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. + * **num\_qubits** (*None or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – reshape to an N-qubit operator \[Default: None]. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.mdx b/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.mdx index 9d05f0294aa..5c837a77c01 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries # Z2Symmetries - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") The \$Z\_2\$ symmetry converter identifies symmetries from the problem hamiltonian and uses them to provide a tapered - more efficient - representation of operators as Paulis for this problem. For each identified symmetry, one qubit can be eliminated in the Pauli representation at the cost of having to test two symmetry sectors (for the two possible eigenvalues - tapering values - of the symmetry). In certain problems such as the finding of the main operator’s ground state, one can a priori identify the symmetry sector of the solution and thus effectively reduce the computational overhead. @@ -22,7 +22,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries **Type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] or None + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")] or None ### tol @@ -32,7 +32,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries **Type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **References** @@ -45,9 +45,9 @@ python_api_name: qiskit.quantum_info.Z2Symmetries * **symmetries** (*Iterable\[*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]*) – Object representing the list of \$Z\_2\$ symmetries. These correspond to the generators of the symmetry group \$langle tau\_1, tau\_2dots rangle>\$. * **sq\_paulis** (*Iterable\[*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]*) – Object representing the list of single-qubit Pauli \$sigma^x\_\{q(i)}\$ anti-commuting with the symmetry \$tau\_i\$ and commuting with all the other symmetries \$tau\_\{jneq i}\$. These operators are used to construct the unitary Clifford operators. - * **sq\_list** (*Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The list of indices \$q(i)\$ of the single-qubit Pauli operators used to build the Clifford operators. - * **tapering\_values** (*Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – List of eigenvalues determining the symmetry sector for each symmetry. - * **tol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Tolerance threshold for ignoring real and complex parts of a coefficient. + * **sq\_list** (*Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – The list of indices \$q(i)\$ of the single-qubit Pauli operators used to build the Clifford operators. + * **tapering\_values** (*Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – List of eigenvalues determining the symmetry sector for each symmetry. + * **tol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Tolerance threshold for ignoring real and complex parts of a coefficient. **Raises** @@ -138,7 +138,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### taper diff --git a/docs/api/qiskit/qiskit.quantum_info.get_clifford_gate_names.mdx b/docs/api/qiskit/qiskit.quantum_info.get_clifford_gate_names.mdx index 49b0dab3d44..4477d4353b5 100644 --- a/docs/api/qiskit/qiskit.quantum_info.get_clifford_gate_names.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.get_clifford_gate_names.mdx @@ -15,6 +15,6 @@ python_api_name: qiskit.quantum_info.get_clifford_gate_names **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.quantum_info.pauli_basis.mdx b/docs/api/qiskit/qiskit.quantum_info.pauli_basis.mdx index 48314a0f555..6873d4c283c 100644 --- a/docs/api/qiskit/qiskit.quantum_info.pauli_basis.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.pauli_basis.mdx @@ -15,8 +15,8 @@ python_api_name: qiskit.quantum_info.pauli_basis **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubits - * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True optionally return the basis sorted by Pauli weight rather than lexicographic order (Default: False) + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubits + * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True optionally return the basis sorted by Pauli weight rather than lexicographic order (Default: False) **Returns** diff --git a/docs/api/qiskit/qiskit.result.Counts.mdx b/docs/api/qiskit/qiskit.result.Counts.mdx index 12b59974d94..91a40a46535 100644 --- a/docs/api/qiskit/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/qiskit.result.Counts.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.result.Counts # Counts - Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") A class to store a counts result from a circuit execution. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.Counts **Parameters** - * **data** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – + * **data** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – The dictionary input for the counts. Where the keys represent a measured classical value and the value is an integer the number of shots with that result. The keys can be one of several formats: @@ -26,15 +26,15 @@ python_api_name: qiskit.result.Counts > * A bit string formatted across register and memory slots. For example, `'00 10'`. > * A dit string, for example `'02'`. Note for objects created with dit strings the `creg_sizes` and `memory_slots` kwargs don’t work and [`hex_outcomes()`](#qiskit.result.Counts.hex_outcomes "qiskit.result.Counts.hex_outcomes") and [`int_outcomes()`](#qiskit.result.Counts.int_outcomes "qiskit.result.Counts.int_outcomes") also do not work. - * **time\_taken** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The duration of the experiment that generated the counts in seconds. + * **time\_taken** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The duration of the experiment that generated the counts in seconds. - * **creg\_sizes** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – a nested list where the inner element is a list of tuples containing both the classical register name and classical register size. For example, `[('c_reg', 2), ('my_creg', 4)]`. + * **creg\_sizes** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – a nested list where the inner element is a list of tuples containing both the classical register name and classical register size. For example, `[('c_reg', 2), ('my_creg', 4)]`. - * **memory\_slots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of total `memory_slots` in the experiment. + * **memory\_slots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of total `memory_slots` in the experiment. **Raises** - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If the input key type is not an `int` or `str`. + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If the input key type is not an `int` or `str`. * [**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – If a dit string key is input with `creg_sizes` and/or `memory_slots`. ## Attributes @@ -78,7 +78,7 @@ python_api_name: qiskit.result.Counts **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") **Raises** @@ -96,7 +96,7 @@ python_api_name: qiskit.result.Counts **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") **Raises** @@ -122,7 +122,7 @@ python_api_name: qiskit.result.Counts **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") **Raises** diff --git a/docs/api/qiskit/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/qiskit.result.ProbDistribution.mdx index 6144b0a78c6..d71bea24839 100644 --- a/docs/api/qiskit/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/qiskit.result.ProbDistribution.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.result.ProbDistribution # ProbDistribution - Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") A generic dict-like class for probability distributions. @@ -17,7 +17,7 @@ python_api_name: qiskit.result.ProbDistribution **Parameters** - * **data** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – + * **data** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – Input probability data. Where the keys represent a measured classical value and the value is a float for the probability of that result. The keys can be one of several formats: @@ -25,12 +25,12 @@ python_api_name: qiskit.result.ProbDistribution > * A bit string e.g. `'0b1011'` or `"01011"` > * An integer - * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of shots the distribution was derived from. + * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of shots the distribution was derived from. **Raises** - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If the input keys are not a string or int - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the string format of the keys is incorrect + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If the input keys are not a string or int + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the string format of the keys is incorrect ## Methods @@ -41,7 +41,7 @@ python_api_name: qiskit.result.ProbDistribution **Parameters** - **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of bits in the binary bitstrings (leading zeros will be padded). If None, a default value will be used. If keys are given as integers or strings with binary or hex prefix, the default value will be derived from the largest key present. If keys are given as bitstrings without prefix, the default value will be derived from the largest key length. + **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of bits in the binary bitstrings (leading zeros will be padded). If None, a default value will be used. If keys are given as integers or strings with binary or hex prefix, the default value will be derived from the largest key present. If keys are given as bitstrings without prefix, the default value will be derived from the largest key length. **Returns** @@ -51,7 +51,7 @@ python_api_name: qiskit.result.ProbDistribution **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") ### clear @@ -87,7 +87,7 @@ python_api_name: qiskit.result.ProbDistribution **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") ### items diff --git a/docs/api/qiskit/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/qiskit.result.QuasiDistribution.mdx index 295af340c16..708f2ad0cc3 100644 --- a/docs/api/qiskit/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/qiskit.result.QuasiDistribution.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.result.QuasiDistribution # QuasiDistribution - Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") A dict-like class for representing quasi-probabilities. @@ -21,7 +21,7 @@ python_api_name: qiskit.result.QuasiDistribution **Parameters** - * **data** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – + * **data** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – Input quasiprobability data. Where the keys represent a measured classical value and the value is a float for the quasiprobability of that result. The keys can be one of several formats: @@ -29,14 +29,14 @@ python_api_name: qiskit.result.QuasiDistribution > * A bit string e.g. `'0b1011'` or `"01011"` > * An integer - * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of shots the distribution was derived from. + * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of shots the distribution was derived from. - * **stddev\_upper\_bound** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – An upper bound for the standard deviation + * **stddev\_upper\_bound** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – An upper bound for the standard deviation **Raises** - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If the input keys are not a string or int - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the string format of the keys is incorrect + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If the input keys are not a string or int + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the string format of the keys is incorrect ## Attributes @@ -55,7 +55,7 @@ python_api_name: qiskit.result.QuasiDistribution **Parameters** - **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of bits in the binary bitstrings (leading zeros will be padded). If None, a default value will be used. If keys are given as integers or strings with binary or hex prefix, the default value will be derived from the largest key present. If keys are given as bitstrings without prefix, the default value will be derived from the largest key length. + **num\_bits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of bits in the binary bitstrings (leading zeros will be padded). If None, a default value will be used. If keys are given as integers or strings with binary or hex prefix, the default value will be derived from the largest key present. If keys are given as bitstrings without prefix, the default value will be derived from the largest key length. **Returns** @@ -65,7 +65,7 @@ python_api_name: qiskit.result.QuasiDistribution **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") ### clear @@ -101,7 +101,7 @@ python_api_name: qiskit.result.QuasiDistribution **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") ### items @@ -119,7 +119,7 @@ python_api_name: qiskit.result.QuasiDistribution **Parameters** - **return\_distance** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Return the L2 distance between distributions. + **return\_distance** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Return the L2 distance between distributions. **Returns** diff --git a/docs/api/qiskit/qiskit.result.Result.mdx b/docs/api/qiskit/qiskit.result.Result.mdx index 9ea571faadf..6857f13412e 100644 --- a/docs/api/qiskit/qiskit.result.Result.mdx +++ b/docs/api/qiskit/qiskit.result.Result.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.result.Result # Result - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Model for Results. @@ -20,7 +20,7 @@ python_api_name: qiskit.result.Result **Type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### backend\_version @@ -30,7 +30,7 @@ python_api_name: qiskit.result.Result **Type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### job\_id @@ -40,7 +40,7 @@ python_api_name: qiskit.result.Result **Type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### success @@ -50,7 +50,7 @@ python_api_name: qiskit.result.Result **Type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### results @@ -60,7 +60,7 @@ python_api_name: qiskit.result.Result **Type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[ExperimentResult] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[ExperimentResult] ### date @@ -70,7 +70,7 @@ python_api_name: qiskit.result.Result **Type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### status @@ -80,7 +80,7 @@ python_api_name: qiskit.result.Result **Type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### header @@ -90,7 +90,7 @@ python_api_name: qiskit.result.Result **Type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") ## Methods @@ -104,7 +104,7 @@ python_api_name: qiskit.result.Result **Parameters** - **experiment** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or None*) – the index of the experiment. Several types are accepted for convenience:: \* str: the name of the experiment. \* QuantumCircuit: the name of the circuit instance will be used. \* int: the position of the experiment. \* None: if there is only one experiment, returns it. + **experiment** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or None*) – the index of the experiment. Several types are accepted for convenience:: \* str: the name of the experiment. \* QuantumCircuit: the name of the circuit instance will be used. \* int: the position of the experiment. \* None: if there is only one experiment, returns it. **Returns** @@ -120,7 +120,7 @@ python_api_name: qiskit.result.Result **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") **Raises** @@ -134,7 +134,7 @@ python_api_name: qiskit.result.Result **Parameters** - **data** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – A dictionary representing the Result to create. It will be in the same format as output by [`to_dict()`](#qiskit.result.Result.to_dict "qiskit.result.Result.to_dict"). + **data** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – A dictionary representing the Result to create. It will be in the same format as output by [`to_dict()`](#qiskit.result.Result.to_dict "qiskit.result.Result.to_dict"). **Returns** @@ -152,7 +152,7 @@ python_api_name: qiskit.result.Result **Parameters** - **experiment** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or None*) – the index of the experiment, as specified by `data([experiment])`. + **experiment** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or None*) – the index of the experiment, as specified by `data([experiment])`. **Returns** @@ -160,7 +160,7 @@ python_api_name: qiskit.result.Result **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] or [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")]] + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")] or [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")]] **Raises** @@ -174,7 +174,7 @@ python_api_name: qiskit.result.Result **Parameters** - **experiment** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or None*) – the index of the experiment, as specified by `data()`. + **experiment** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or None*) – the index of the experiment, as specified by `data()`. **Returns** @@ -190,7 +190,7 @@ python_api_name: qiskit.result.Result **Return type** - List\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")] or np.ndarray + List\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")] or np.ndarray **Raises** @@ -204,8 +204,8 @@ python_api_name: qiskit.result.Result **Parameters** - * **experiment** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or None*) – the index of the experiment, as specified by `data()`. - * **decimals** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of decimals in the statevector. If None, does not round. + * **experiment** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or None*) – the index of the experiment, as specified by `data()`. + * **decimals** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of decimals in the statevector. If None, does not round. **Returns** @@ -213,7 +213,7 @@ python_api_name: qiskit.result.Result **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")] **Raises** @@ -227,8 +227,8 @@ python_api_name: qiskit.result.Result **Parameters** - * **experiment** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or None*) – the index of the experiment, as specified by `data()`. - * **decimals** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of decimals in the unitary. If None, does not round. + * **experiment** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or None*) – the index of the experiment, as specified by `data()`. + * **decimals** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of decimals in the unitary. If None, does not round. **Returns** @@ -238,7 +238,7 @@ python_api_name: qiskit.result.Result **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)")]] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)")]] **Raises** @@ -256,7 +256,7 @@ python_api_name: qiskit.result.Result **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.result.ResultError.mdx b/docs/api/qiskit/qiskit.result.ResultError.mdx index 49e5530f5af..c646faaa541 100644 --- a/docs/api/qiskit/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/qiskit.result.ResultError.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.result.ResultError **Parameters** - **error** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – + **error** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – This is the error record as it comes back from the API. The format is like: diff --git a/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.mdx index 10c0c83ebdb..16ecb3083af 100644 --- a/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis # EvolutionSynthesis - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Interface for evolution synthesis algorithms. @@ -26,7 +26,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – The interface does not implement this method. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – The interface does not implement this method. ## Methods diff --git a/docs/api/qiskit/qiskit.synthesis.LieTrotter.mdx b/docs/api/qiskit/qiskit.synthesis.LieTrotter.mdx index 4e74bc793fa..64d66ae92df 100644 --- a/docs/api/qiskit/qiskit.synthesis.LieTrotter.mdx +++ b/docs/api/qiskit/qiskit.synthesis.LieTrotter.mdx @@ -31,13 +31,13 @@ $$ **Parameters** - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of time steps. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to insert barriers between the atomic evolutions. - * **cx\_structure** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – How to arrange the CX gates for the Pauli evolutions, can be `"chain"`, where next neighbor connections are used, or `"fountain"`, where all qubits are connected to one. This only takes effect when `atomic_evolution is None`. - * **atomic\_evolution** (*Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*], None] | None*) – A function to apply the evolution of a single [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"), or [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") of only commuting terms, to a circuit. The function takes in three arguments: the circuit to append the evolution to, the Pauli operator to evolve, and the evolution time. By default, a single Pauli evolution is decomposed into a chain of `CX` gates and a single `RZ` gate. - * **wrap** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to wrap the atomic evolutions into custom gate objects. This only takes effect when `atomic_evolution is None`. - * **preserve\_order** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `False`, allows reordering the terms of the operator to potentially yield a shallower evolution circuit. Not relevant when synthesizing operator with a single term. - * **atomic\_evolution\_sparse\_observable** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If a custom `atomic_evolution` is passed, which does not yet support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input, set this argument to `False` to automatically apply a conversion to [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). This argument is supported until Qiskit 2.2, at which point all atomic evolutions are required to support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of time steps. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to insert barriers between the atomic evolutions. + * **cx\_structure** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – How to arrange the CX gates for the Pauli evolutions, can be `"chain"`, where next neighbor connections are used, or `"fountain"`, where all qubits are connected to one. This only takes effect when `atomic_evolution is None`. + * **atomic\_evolution** (*Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*], None] | None*) – A function to apply the evolution of a single [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"), or [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") of only commuting terms, to a circuit. The function takes in three arguments: the circuit to append the evolution to, the Pauli operator to evolve, and the evolution time. By default, a single Pauli evolution is decomposed into a chain of `CX` gates and a single `RZ` gate. + * **wrap** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to wrap the atomic evolutions into custom gate objects. This only takes effect when `atomic_evolution is None`. + * **preserve\_order** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `False`, allows reordering the terms of the operator to potentially yield a shallower evolution circuit. Not relevant when synthesizing operator with a single term. + * **atomic\_evolution\_sparse\_observable** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If a custom `atomic_evolution` is passed, which does not yet support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input, set this argument to `False` to automatically apply a conversion to [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). This argument is supported until Qiskit 2.2, at which point all atomic evolutions are required to support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input. ## Attributes @@ -52,7 +52,7 @@ $$ **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – If a custom atomic evolution is set, which cannot be serialized. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – If a custom atomic evolution is set, which cannot be serialized. ## Methods @@ -82,7 +82,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")], ParameterValueType]] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")], ParameterValueType]] ### synthesize diff --git a/docs/api/qiskit/qiskit.synthesis.MatrixExponential.mdx b/docs/api/qiskit/qiskit.synthesis.MatrixExponential.mdx index f9eecb616f4..829c01bfef0 100644 --- a/docs/api/qiskit/qiskit.synthesis.MatrixExponential.mdx +++ b/docs/api/qiskit/qiskit.synthesis.MatrixExponential.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.synthesis.MatrixExponential **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – The interface does not implement this method. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – The interface does not implement this method. ## Methods diff --git a/docs/api/qiskit/qiskit.synthesis.OneQubitEulerDecomposer.mdx b/docs/api/qiskit/qiskit.synthesis.OneQubitEulerDecomposer.mdx index a2a3cb84ac2..c4f77346f43 100644 --- a/docs/api/qiskit/qiskit.synthesis.OneQubitEulerDecomposer.mdx +++ b/docs/api/qiskit/qiskit.synthesis.OneQubitEulerDecomposer.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.synthesis.OneQubitEulerDecomposer # OneQubitEulerDecomposer - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A class for decomposing 1-qubit unitaries into Euler angle rotations. @@ -38,8 +38,8 @@ python_api_name: qiskit.synthesis.OneQubitEulerDecomposer **Parameters** * **unitary** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| np.ndarray*) – 1-qubit unitary matrix - * **simplify** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – reduce gate count in decomposition \[Default: True]. - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – absolute tolerance for checking angles when simplifying returned circuit \[Default: 1e-12]. + * **simplify** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – reduce gate count in decomposition \[Default: True]. + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – absolute tolerance for checking angles when simplifying returned circuit \[Default: 1e-12]. **Returns** @@ -60,8 +60,8 @@ python_api_name: qiskit.synthesis.OneQubitEulerDecomposer **Parameters** - * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the decomposition basis \[Default: `'U3'`] - * **use\_dag** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If true the output from calls to the decomposer will be a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object instead of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). + * **basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the decomposition basis \[Default: `'U3'`] + * **use\_dag** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If true the output from calls to the decomposer will be a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object instead of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). **Raises** @@ -92,7 +92,7 @@ python_api_name: qiskit.synthesis.OneQubitEulerDecomposer **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") ### angles\_and\_phase @@ -110,7 +110,7 @@ python_api_name: qiskit.synthesis.OneQubitEulerDecomposer **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") ### build\_circuit diff --git a/docs/api/qiskit/qiskit.synthesis.ProductFormula.mdx b/docs/api/qiskit/qiskit.synthesis.ProductFormula.mdx index 8bd5d07d738..3e24d4c9364 100644 --- a/docs/api/qiskit/qiskit.synthesis.ProductFormula.mdx +++ b/docs/api/qiskit/qiskit.synthesis.ProductFormula.mdx @@ -17,14 +17,14 @@ python_api_name: qiskit.synthesis.ProductFormula **Parameters** - * **order** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The order of the product formula. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of time steps. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to insert barriers between the atomic evolutions. - * **cx\_structure** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – How to arrange the CX gates for the Pauli evolutions, can be `"chain"`, where next neighbor connections are used, or `"fountain"`, where all qubits are connected to one. This only takes effect when `atomic_evolution is None`. - * **atomic\_evolution** (*Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*], None] | None*) – A function to apply the evolution of a single [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"), or [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") of only commuting terms, to a circuit. The function takes in three arguments: the circuit to append the evolution to, the Pauli operator to evolve, and the evolution time. By default, a single Pauli evolution is decomposed into a chain of `CX` gates and a single `RZ` gate. - * **wrap** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to wrap the atomic evolutions into custom gate objects. Note that setting this to `True` is slower than `False`. This only takes effect when `atomic_evolution is None`. - * **preserve\_order** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `False`, allows reordering the terms of the operator to potentially yield a shallower evolution circuit. Not relevant when synthesizing operator with a single term. - * **atomic\_evolution\_sparse\_observable** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If a custom `atomic_evolution` is passed, which does not yet support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input, set this argument to `False` to automatically apply a conversion to [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). This argument is supported until Qiskit 2.2, at which point all atomic evolutions are required to support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input. + * **order** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The order of the product formula. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of time steps. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to insert barriers between the atomic evolutions. + * **cx\_structure** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – How to arrange the CX gates for the Pauli evolutions, can be `"chain"`, where next neighbor connections are used, or `"fountain"`, where all qubits are connected to one. This only takes effect when `atomic_evolution is None`. + * **atomic\_evolution** (*Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*], None] | None*) – A function to apply the evolution of a single [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"), or [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") of only commuting terms, to a circuit. The function takes in three arguments: the circuit to append the evolution to, the Pauli operator to evolve, and the evolution time. By default, a single Pauli evolution is decomposed into a chain of `CX` gates and a single `RZ` gate. + * **wrap** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to wrap the atomic evolutions into custom gate objects. Note that setting this to `True` is slower than `False`. This only takes effect when `atomic_evolution is None`. + * **preserve\_order** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `False`, allows reordering the terms of the operator to potentially yield a shallower evolution circuit. Not relevant when synthesizing operator with a single term. + * **atomic\_evolution\_sparse\_observable** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If a custom `atomic_evolution` is passed, which does not yet support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input, set this argument to `False` to automatically apply a conversion to [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). This argument is supported until Qiskit 2.2, at which point all atomic evolutions are required to support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input. ## Attributes @@ -39,7 +39,7 @@ python_api_name: qiskit.synthesis.ProductFormula **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – If a custom atomic evolution is set, which cannot be serialized. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – If a custom atomic evolution is set, which cannot be serialized. ## Methods @@ -59,7 +59,7 @@ python_api_name: qiskit.synthesis.ProductFormula **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")], ParameterValueType]] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")], ParameterValueType]] ### synthesize diff --git a/docs/api/qiskit/qiskit.synthesis.QDrift.mdx b/docs/api/qiskit/qiskit.synthesis.QDrift.mdx index b488d222748..45af4c73a58 100644 --- a/docs/api/qiskit/qiskit.synthesis.QDrift.mdx +++ b/docs/api/qiskit/qiskit.synthesis.QDrift.mdx @@ -19,14 +19,14 @@ python_api_name: qiskit.synthesis.QDrift **Parameters** - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of times to repeat the Trotterization circuit. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to insert barriers between the atomic evolutions. - * **cx\_structure** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – How to arrange the CX gates for the Pauli evolutions, can be `"chain"`, where next neighbor connections are used, or `"fountain"`, where all qubits are connected to one. This only takes effect when `atomic_evolution is None`. - * **atomic\_evolution** (*Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*], None] | None*) – A function to apply the evolution of a single [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"), or [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") of only commuting terms, to a circuit. The function takes in three arguments: the circuit to append the evolution to, the Pauli operator to evolve, and the evolution time. By default, a single Pauli evolution is decomposed into a chain of `CX` gates and a single `RZ` gate. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – An optional seed for reproducibility of the random sampling process. - * **wrap** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to wrap the atomic evolutions into custom gate objects. This only takes effect when `atomic_evolution is None`. - * **preserve\_order** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `False`, allows reordering the terms of the operator to potentially yield a shallower evolution circuit. Not relevant when synthesizing operator with a single term. - * **atomic\_evolution\_sparse\_observable** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If a custom `atomic_evolution` is passed, which does not yet support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input, set this argument to `False` to automatically apply a conversion to [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). This argument is supported until Qiskit 2.2, at which point all atomic evolutions are required to support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of times to repeat the Trotterization circuit. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to insert barriers between the atomic evolutions. + * **cx\_structure** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – How to arrange the CX gates for the Pauli evolutions, can be `"chain"`, where next neighbor connections are used, or `"fountain"`, where all qubits are connected to one. This only takes effect when `atomic_evolution is None`. + * **atomic\_evolution** (*Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*], None] | None*) – A function to apply the evolution of a single [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"), or [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") of only commuting terms, to a circuit. The function takes in three arguments: the circuit to append the evolution to, the Pauli operator to evolve, and the evolution time. By default, a single Pauli evolution is decomposed into a chain of `CX` gates and a single `RZ` gate. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – An optional seed for reproducibility of the random sampling process. + * **wrap** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to wrap the atomic evolutions into custom gate objects. This only takes effect when `atomic_evolution is None`. + * **preserve\_order** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `False`, allows reordering the terms of the operator to potentially yield a shallower evolution circuit. Not relevant when synthesizing operator with a single term. + * **atomic\_evolution\_sparse\_observable** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If a custom `atomic_evolution` is passed, which does not yet support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input, set this argument to `False` to automatically apply a conversion to [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). This argument is supported until Qiskit 2.2, at which point all atomic evolutions are required to support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input. ## Attributes @@ -41,7 +41,7 @@ python_api_name: qiskit.synthesis.QDrift **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – If a custom atomic evolution is set, which cannot be serialized. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – If a custom atomic evolution is set, which cannot be serialized. ## Methods @@ -61,7 +61,7 @@ python_api_name: qiskit.synthesis.QDrift **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")], [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")]] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")], [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")]] ### synthesize diff --git a/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.mdx b/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.mdx index 0983ec9bbdf..e4b7994e368 100644 --- a/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.mdx +++ b/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition # SolovayKitaevDecomposition - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") The Solovay Kitaev discrete decomposition algorithm. @@ -17,17 +17,17 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition **Parameters** - * **basic\_approximations** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, np.ndarray] |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[GateSequence] | None*) – + * **basic\_approximations** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, np.ndarray] |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[GateSequence] | None*) – A specification of the basic SO(3) approximations in terms of discrete gates. At each iteration this algorithm, the remaining error is approximated with the closest sequence of gates in this set. If a `str`, this specifies a filename from which to load the approximation. If a `dict`, then this contains `{gates: effective_SO3_matrix}` pairs, e.g. `{"h t": np.array([[0, 0.7071, -0.7071], [0, -0.7071, -0.7071], [-1, 0, 0]]}`. If a list, this contains the same information as the dict, but already converted to `GateSequence` objects, which contain the SO(3) matrix and gates. Either this parameter, or `basis_gates` and `depth` can be specified. - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*] | None*) – A list of discrete (i.e., non-parameterized) standard gates. Defaults to `["h", "t", "tdg"]`. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*] | None*) – A list of discrete (i.e., non-parameterized) standard gates. Defaults to `["h", "t", "tdg"]`. - * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of basis gate combinations to consider in the basis set. This determines how fast (and if) the algorithm converges and should be chosen sufficiently high. + * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of basis gate combinations to consider in the basis set. This determines how fast (and if) the algorithm converges and should be chosen sufficiently high. - * **check\_input** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, perform intermediate steps checking whether the matrices are of expected form. + * **check\_input** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, perform intermediate steps checking whether the matrices are of expected form. ## Attributes @@ -82,7 +82,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition **Parameters** - **data** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – If a string, specifies the path to the file from where to load the data. If a dictionary, directly specifies the decompositions as `{gates: matrix}` or `{gates: (matrix, global_phase)}`. There, `gates` are the names of the gates producing the SO(3) matrix `matrix`, e.g. `{"h t": np.array([[0, 0.7071, -0.7071], [0, -0.7071, -0.7071], [-1, 0, 0]]}` and the `global_phase` can be given to account for a global phase difference between the U(2) matrix of the quantum gates and the stored SO(3) matrix. If not given, the `global_phase` will be assumed to be 0. + **data** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – If a string, specifies the path to the file from where to load the data. If a dictionary, directly specifies the decompositions as `{gates: matrix}` or `{gates: (matrix, global_phase)}`. There, `gates` are the names of the gates producing the SO(3) matrix `matrix`, e.g. `{"h t": np.array([[0, 0.7071, -0.7071], [0, -0.7071, -0.7071], [-1, 0, 0]]}` and the `global_phase` can be given to account for a global phase difference between the U(2) matrix of the quantum gates and the stored SO(3) matrix. If not given, the `global_phase` will be assumed to be 0. **Returns** @@ -90,11 +90,11 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the number of gate combinations and associated matrices does not match. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the number of gate combinations and associated matrices does not match. **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[GateSequence] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[GateSequence] ### query\_basic\_approximation @@ -119,9 +119,9 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition **Parameters** * **gate\_matrix** (*np.ndarray |* [*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – The single-qubit gate to approximate. Can either be a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), where [`Gate.to_matrix()`](qiskit.circuit.Gate#to_matrix "qiskit.circuit.Gate.to_matrix") returns the matrix, or a $2\times 2$ unitary matrix representing the gate. - * **recursion\_degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The recursion degree, called $n$ in the paper. - * **return\_dag** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` return a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"), else a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). - * **check\_input** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` check that the input matrix is valid for the decomposition. Overrides the class attribute with the same name, but only for this function call. + * **recursion\_degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The recursion degree, called $n$ in the paper. + * **return\_dag** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` return a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"), else a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). + * **check\_input** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` check that the input matrix is valid for the decomposition. Overrides the class attribute with the same name, but only for this function call. **Returns** @@ -148,11 +148,11 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition **Parameters** - **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The filename to store the approximations in. + **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The filename to store the approximations in. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the filename has a .npy extension. The format is not .npy, and storing as such can cause errors when loading the file again. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the filename has a .npy extension. The format is not .npy, and storing as such can cause errors when loading the file again. diff --git a/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.mdx b/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.mdx index c0894514b95..9c3c820e631 100644 --- a/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.mdx +++ b/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.mdx @@ -33,18 +33,18 @@ $$ **Parameters** - * **order** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The order of the product formula. - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of time steps. - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to insert barriers between the atomic evolutions. - * **cx\_structure** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – How to arrange the CX gates for the Pauli evolutions, can be `"chain"`, where next neighbor connections are used, or `"fountain"`, where all qubits are connected to one. This only takes effect when `atomic_evolution is None`. - * **atomic\_evolution** (*Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*], None] | None*) – A function to apply the evolution of a single [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"), or [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") of only commuting terms, to a circuit. The function takes in three arguments: the circuit to append the evolution to, the Pauli operator to evolve, and the evolution time. By default, a single Pauli evolution is decomposed into a chain of `CX` gates and a single `RZ` gate. - * **wrap** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to wrap the atomic evolutions into custom gate objects. This only takes effect when `atomic_evolution is None`. - * **preserve\_order** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `False`, allows reordering the terms of the operator to potentially yield a shallower evolution circuit. Not relevant when synthesizing operator with a single term. - * **atomic\_evolution\_sparse\_observable** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If a custom `atomic_evolution` is passed, which does not yet support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input, set this argument to `False` to automatically apply a conversion to [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). This argument is supported until Qiskit 2.2, at which point all atomic evolutions are required to support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input. + * **order** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The order of the product formula. + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of time steps. + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to insert barriers between the atomic evolutions. + * **cx\_structure** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – How to arrange the CX gates for the Pauli evolutions, can be `"chain"`, where next neighbor connections are used, or `"fountain"`, where all qubits are connected to one. This only takes effect when `atomic_evolution is None`. + * **atomic\_evolution** (*Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*qiskit.quantum\_info.Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*], None] | None*) – A function to apply the evolution of a single [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"), or [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") of only commuting terms, to a circuit. The function takes in three arguments: the circuit to append the evolution to, the Pauli operator to evolve, and the evolution time. By default, a single Pauli evolution is decomposed into a chain of `CX` gates and a single `RZ` gate. + * **wrap** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to wrap the atomic evolutions into custom gate objects. This only takes effect when `atomic_evolution is None`. + * **preserve\_order** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `False`, allows reordering the terms of the operator to potentially yield a shallower evolution circuit. Not relevant when synthesizing operator with a single term. + * **atomic\_evolution\_sparse\_observable** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If a custom `atomic_evolution` is passed, which does not yet support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input, set this argument to `False` to automatically apply a conversion to [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). This argument is supported until Qiskit 2.2, at which point all atomic evolutions are required to support [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If order is not even + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If order is not even ## Attributes @@ -59,7 +59,7 @@ $$ **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – If a custom atomic evolution is set, which cannot be serialized. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – If a custom atomic evolution is set, which cannot be serialized. ## Methods @@ -89,7 +89,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")], ParameterValueType]] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")], ParameterValueType]] ### synthesize diff --git a/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer.mdx b/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer.mdx index eb956837ffe..ec48da6a62e 100644 --- a/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer.mdx +++ b/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer.mdx @@ -9,16 +9,16 @@ python_api_name: qiskit.synthesis.TwoQubitBasisDecomposer # TwoQubitBasisDecomposer - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. **Parameters** * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. - * **basis\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Fidelity to be assumed for applications of KAK Gate. Defaults to `1.0`. - * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Basis string to be provided to [`OneQubitEulerDecomposer`](qiskit.synthesis.OneQubitEulerDecomposer "qiskit.synthesis.OneQubitEulerDecomposer") for 1Q synthesis. Valid options are \[`'ZYZ'`, `'ZXZ'`, `'XYX'`, `'U'`, `'U3'`, `'U1X'`, `'PSX'`, `'ZSX'`, `'RR'`]. - * **pulse\_optimize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – If `True`, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If `False`, don’t attempt optimization. If `None`, attempt optimization but don’t raise if unknown. + * **basis\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Fidelity to be assumed for applications of KAK Gate. Defaults to `1.0`. + * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Basis string to be provided to [`OneQubitEulerDecomposer`](qiskit.synthesis.OneQubitEulerDecomposer "qiskit.synthesis.OneQubitEulerDecomposer") for 1Q synthesis. Valid options are \[`'ZYZ'`, `'ZXZ'`, `'XYX'`, `'U'`, `'U3'`, `'U1X'`, `'PSX'`, `'ZSX'`, `'RR'`]. + * **pulse\_optimize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – If `True`, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If `False`, don’t attempt optimization. If `None`, attempt optimization but don’t raise if unknown. ### \_\_call\_\_ @@ -28,10 +28,10 @@ python_api_name: qiskit.synthesis.TwoQubitBasisDecomposer **Parameters** * **unitary** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or ndarray*) – $4 \times 4$ unitary to synthesize. - * **basis\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *or None*) – Fidelity to be assumed for applications of KAK Gate. If given, overrides `basis_fidelity` given at init. - * **approximate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Approximates if basis fidelities are less than 1.0. - * **use\_dag** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If true a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") is returned instead of a `QuantumCircuit` when this class is called. - * **\_num\_basis\_uses** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – force a particular approximation by passing a number in \[0, 3]. + * **basis\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *or None*) – Fidelity to be assumed for applications of KAK Gate. If given, overrides `basis_fidelity` given at init. + * **approximate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Approximates if basis fidelities are less than 1.0. + * **use\_dag** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If true a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") is returned instead of a `QuantumCircuit` when this class is called. + * **\_num\_basis\_uses** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – force a particular approximation by passing a number in \[0, 3]. **Returns** diff --git a/docs/api/qiskit/qiskit.synthesis.TwoQubitControlledUDecomposer.mdx b/docs/api/qiskit/qiskit.synthesis.TwoQubitControlledUDecomposer.mdx index 65fe091340c..4c042f11678 100644 --- a/docs/api/qiskit/qiskit.synthesis.TwoQubitControlledUDecomposer.mdx +++ b/docs/api/qiskit/qiskit.synthesis.TwoQubitControlledUDecomposer.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.synthesis.TwoQubitControlledUDecomposer # TwoQubitControlledUDecomposer - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Decompose two-qubit unitary in terms of a desired $U \sim U_d(\alpha, 0, 0) \sim \text{Ctrl-U}$ gate that is locally equivalent to an [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -18,7 +18,7 @@ python_api_name: qiskit.synthesis.TwoQubitControlledUDecomposer **Parameters** * **rxx\_equivalent\_gate** ([*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – Gate that is locally equivalent to an [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"): $U \sim U_d(\alpha, 0, 0) \sim \text{Ctrl-U}$ gate. Valid options are \[[`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"), [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"), [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"), [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"), [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"), [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"), [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"), [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate")]. - * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Basis string to be provided to [`OneQubitEulerDecomposer`](qiskit.synthesis.OneQubitEulerDecomposer "qiskit.synthesis.OneQubitEulerDecomposer") for 1Q synthesis. Valid options are \[`'ZXZ'`, `'ZYZ'`, `'XYX'`, `'XZX'`, `'U'`, `'U3'`, `'U321'`, `'U1X'`, `'PSX'`, `'ZSX'`, `'ZSXX'`, `'RR'`]. + * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Basis string to be provided to [`OneQubitEulerDecomposer`](qiskit.synthesis.OneQubitEulerDecomposer "qiskit.synthesis.OneQubitEulerDecomposer") for 1Q synthesis. Valid options are \[`'ZXZ'`, `'ZYZ'`, `'XYX'`, `'XZX'`, `'U'`, `'U3'`, `'U321'`, `'U1X'`, `'PSX'`, `'ZSX'`, `'ZSXX'`, `'RR'`]. **Raises** diff --git a/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.mdx b/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.mdx index fecac1bba65..0551cf5b628 100644 --- a/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.mdx +++ b/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.synthesis.TwoQubitWeylDecomposition # TwoQubitWeylDecomposition - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Two-qubit Weyl decomposition. @@ -45,7 +45,7 @@ $$ **Parameters** * **unitary\_matrix** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")) – - * **fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – * **\_specialization** (*two\_qubit\_decompose.Specialization | None*) – ### a @@ -101,7 +101,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") ### circuit @@ -111,9 +111,9 @@ $$ **Parameters** - * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – - * **simplify** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – + * **simplify** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – **Return type** @@ -127,8 +127,8 @@ $$ **Parameters** - * **bytes\_in** ([*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes "(in Python v3.13)")) – - * **requested\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **bytes\_in** ([*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes "(in Python v3.14)")) – + * **requested\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – * **\_specialization** (*two\_qubit\_decompose.Specialization | None*) – **Return type** diff --git a/docs/api/qiskit/qiskit.synthesis.XXDecomposer.mdx b/docs/api/qiskit/qiskit.synthesis.XXDecomposer.mdx index 13fcf1273c5..6930ff43097 100644 --- a/docs/api/qiskit/qiskit.synthesis.XXDecomposer.mdx +++ b/docs/api/qiskit/qiskit.synthesis.XXDecomposer.mdx @@ -9,15 +9,15 @@ python_api_name: qiskit.synthesis.XXDecomposer # XXDecomposer - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of `XX` type (i.e., each locally equivalent to $CAN(\alpha, 0, 0)$ for a possibly varying $alpha$). **Parameters** - * **basis\_fidelity** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – available strengths and fidelity of each. Can be either (1) a dictionary mapping `XX` angle values to fidelity at that angle; or (2) a single float `f`, interpreted as `{pi: f, pi/2: f/2, pi/3: f/3}`. - * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Basis string provided to [`OneQubitEulerDecomposer`](qiskit.synthesis.OneQubitEulerDecomposer "qiskit.synthesis.OneQubitEulerDecomposer") for 1Q synthesis. Defaults to `"U"`. - * **embodiments** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*,* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – A dictionary mapping interaction strengths alpha to native circuits which embody the gate $CAN(\alpha, 0, 0)$. Strengths are taken so that $\pi/2$ represents the class of a full [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). + * **basis\_fidelity** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – available strengths and fidelity of each. Can be either (1) a dictionary mapping `XX` angle values to fidelity at that angle; or (2) a single float `f`, interpreted as `{pi: f, pi/2: f/2, pi/3: f/3}`. + * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Basis string provided to [`OneQubitEulerDecomposer`](qiskit.synthesis.OneQubitEulerDecomposer "qiskit.synthesis.OneQubitEulerDecomposer") for 1Q synthesis. Defaults to `"U"`. + * **embodiments** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*,* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – A dictionary mapping interaction strengths alpha to native circuits which embody the gate $CAN(\alpha, 0, 0)$. Strengths are taken so that $\pi/2$ represents the class of a full [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). * **backup\_optimizer** (*Callable\[...,* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – If supplied, defers synthesis to this callable when [`XXDecomposer`](#qiskit.synthesis.XXDecomposer "qiskit.synthesis.XXDecomposer") has no efficient decomposition of its own. Useful for special cases involving 2 or 3 applications of $XX(\pi/2)$, in which case standard synthesis methods provide lower 1Q gate count. @@ -32,9 +32,9 @@ python_api_name: qiskit.synthesis.XXDecomposer **Parameters** * **unitary** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or ndarray*) – $4 \times 4$ unitary to synthesize. - * **basis\_fidelity** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *or*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Fidelity of basis gates. Can be either (1) a dictionary mapping `XX` angle values to fidelity at that angle; or (2) a single float `f`, interpreted as `{pi: f, pi/2: f/2, pi/3: f/3}`. If given, overrides the basis\_fidelity given at init. - * **approximate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Approximates if basis fidelities are less than 1.0 . - * **use\_dag** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If true a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") is returned instead of a `QuantumCircuit` when this class is called. + * **basis\_fidelity** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *or*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Fidelity of basis gates. Can be either (1) a dictionary mapping `XX` angle values to fidelity at that angle; or (2) a single float `f`, interpreted as `{pi: f, pi/2: f/2, pi/3: f/3}`. If given, overrides the basis\_fidelity given at init. + * **approximate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Approximates if basis fidelities are less than 1.0 . + * **use\_dag** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If true a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") is returned instead of a `QuantumCircuit` when this class is called. **Returns** diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.mdx index eb3423dfd50..82d39c28dde 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.AQC # AQC - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") A generic implementation of the Approximate Quantum Compiler. This implementation is agnostic of the underlying implementation of the approximate circuit, objective, and optimizer. Users may pass corresponding implementations of the abstract classes: @@ -21,7 +21,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.AQC **Parameters** * **optimizer** (*Minimizer | None*) – an optimizer to be used in the optimization procedure of the search for the best approximate circuit. By default, the scipy minimizer with the `L-BFGS-B` method is used with max iterations set to 1000. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – a seed value to be used by a random number generator. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – a seed value to be used by a random number generator. ## Methods diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx index 2c4dcd1bf39..a17dc6d5c13 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx @@ -9,14 +9,14 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit # ApproximateCircuit - Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") A base class that represents an approximate circuit. **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubit this circuit will span. - * **name** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – a name of the circuit. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubit this circuit will span. + * **name** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – a name of the circuit. ## Attributes diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx index b1a6c89f302..00e95d2f69b 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective # ApproximatingObjective - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") A base class for an optimization problem definition. An implementing class must provide at least an implementation of the `objective` method. In such case only gradient free optimizers can be used. Both method, `objective` and `gradient`, preferable to have in an implementation. @@ -62,7 +62,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective **Return type** - [*SupportsFloat*](https://docs.python.org/3/library/typing.html#typing.SupportsFloat "(in Python v3.13)") + [*SupportsFloat*](https://docs.python.org/3/library/typing.html#typing.SupportsFloat "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx index ef36b3baa00..a374a9ddcbb 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx @@ -15,14 +15,14 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits in this circuit. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits in this circuit. * **cnots** (*np.ndarray*) – an array of dimensions `(2, L)` indicating where the CNOT units will be placed. - * **tol** (*Optional\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – angle parameter less or equal this (small) value is considered equal zero and corresponding gate is not inserted into the output circuit (because it becomes identity one in this case). - * **name** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – name of this circuit + * **tol** (*Optional\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – angle parameter less or equal this (small) value is considered equal zero and corresponding gate is not inserted into the output circuit (because it becomes identity one in this case). + * **name** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – name of this circuit **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if an unsupported parameter is passed. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if an unsupported parameter is passed. ## Attributes diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx index f4488d4b8a7..7ad54f4635a 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitObjective.mdx @@ -9,13 +9,13 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitObjective # CNOTUnitObjective - Bases: [`ApproximatingObjective`](qiskit.synthesis.unitary.aqc.ApproximatingObjective "qiskit.synthesis.unitary.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ApproximatingObjective`](qiskit.synthesis.unitary.aqc.ApproximatingObjective "qiskit.synthesis.unitary.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") A base class for a problem definition based on CNOT unit. This class may have different subclasses for objective and gradient computations. **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubits. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubits. * **cnots** (*np.ndarray*) – a CNOT structure to be used in the optimization procedure. ## Attributes diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx index 467bc3cf001..d41f27ab0de 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective.mdx @@ -15,7 +15,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubits. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubits. * **cnots** (*np.ndarray*) – a CNOT structure to be used in the optimization procedure. ## Methods @@ -53,7 +53,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.DefaultCNOTUnitObjective **Return type** - [*SupportsFloat*](https://docs.python.org/3/library/typing.html#typing.SupportsFloat "(in Python v3.13)") + [*SupportsFloat*](https://docs.python.org/3/library/typing.html#typing.SupportsFloat "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx index 5f70d8148f1..bd3c1456a10 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx @@ -15,7 +15,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubits. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubits. * **cnots** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")) – a CNOT structure to be used in the optimization procedure. ## Methods @@ -45,7 +45,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.mdx index c646987e32f..23b542e5a8f 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.mdx @@ -130,10 +130,10 @@ This uses a helper function, [`make_cnot_network`](#qiskit.synthesis.unitary.aqc **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – number of qubits. - * **network\_layout** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – type of network geometry, `{"sequ", "spin", "cart", "cyclic_spin", "cyclic_line"}`. - * **connectivity\_type** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – type of inter-qubit connectivity, `{"full", "line", "star"}`. - * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – depth of the CNOT-network, i.e. the number of layers, where each layer consists of a single CNOT-block; default value will be selected, if `L <= 0`. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – number of qubits. + * **network\_layout** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – type of network geometry, `{"sequ", "spin", "cart", "cyclic_spin", "cyclic_line"}`. + * **connectivity\_type** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – type of inter-qubit connectivity, `{"full", "line", "star"}`. + * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – depth of the CNOT-network, i.e. the number of layers, where each layer consists of a single CNOT-block; default value will be selected, if `L <= 0`. **Returns** @@ -143,7 +143,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.synthesis.unitary.aqc **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if unsupported type of CNOT-network layout or number of qubits or combination of parameters are passed. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if unsupported type of CNOT-network layout or number of qubits or combination of parameters are passed. **Return type** diff --git a/docs/api/qiskit/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/qiskit.transpiler.AnalysisPass.mdx index c86ab2649d4..2accefda3e8 100644 --- a/docs/api/qiskit/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/qiskit.transpiler.AnalysisPass.mdx @@ -40,9 +40,9 @@ python_api_name: qiskit.transpiler.AnalysisPass **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.AnalysisPass **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.AnalysisPass **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.AnalysisPass **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – when this is left unimplemented for a pass. ### update\_status diff --git a/docs/api/qiskit/qiskit.transpiler.CouplingMap.mdx b/docs/api/qiskit/qiskit.transpiler.CouplingMap.mdx index 31f3874be66..6a8f42af668 100644 --- a/docs/api/qiskit/qiskit.transpiler.CouplingMap.mdx +++ b/docs/api/qiskit/qiskit.transpiler.CouplingMap.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.CouplingMap # CouplingMap - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Directed graph specifying fixed coupling. @@ -19,8 +19,8 @@ python_api_name: qiskit.transpiler.CouplingMap **Parameters** - * **couplinglist** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or None*) – An initial coupling graph, specified as an adjacency list containing couplings, e.g. \[\[0,1], \[0,2], \[1,2]]. It is required that nodes are contiguously indexed starting at 0. Missed nodes will be added as isolated nodes in the coupling map. - * **description** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A string to describe the coupling map. + * **couplinglist** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or None*) – An initial coupling graph, specified as an adjacency list containing couplings, e.g. \[\[0,1], \[0,2], \[1,2]]. It is required that nodes are contiguously indexed starting at 0. Missed nodes will be added as isolated nodes in the coupling map. + * **description** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – A string to describe the coupling map. ## Attributes @@ -137,7 +137,7 @@ python_api_name: qiskit.transpiler.CouplingMap **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") ### distance @@ -147,8 +147,8 @@ python_api_name: qiskit.transpiler.CouplingMap **Parameters** - * **physical\_qubit1** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – A physical qubit - * **physical\_qubit2** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Another physical qubit + * **physical\_qubit1** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – A physical qubit + * **physical\_qubit2** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Another physical qubit **Returns** @@ -156,7 +156,7 @@ python_api_name: qiskit.transpiler.CouplingMap **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") **Raises** @@ -210,8 +210,8 @@ python_api_name: qiskit.transpiler.CouplingMap **Parameters** - * **distance** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The code distance for the generated heavy hex graph. The value for distance can be any odd positive integer. The distance relates to the number of qubits by: $n = \frac{5d^2 - 2d - 1}{2}$ where $n$ is the number of qubits and $d$ is the `distance` parameter. - * **bidirectional** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether the edges in the output coupling graph are bidirectional or not. By default this is set to `True` + * **distance** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The code distance for the generated heavy hex graph. The value for distance can be any odd positive integer. The distance relates to the number of qubits by: $n = \frac{5d^2 - 2d - 1}{2}$ where $n$ is the number of qubits and $d$ is the `distance` parameter. + * **bidirectional** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether the edges in the output coupling graph are bidirectional or not. By default this is set to `True` **Returns** @@ -233,8 +233,8 @@ python_api_name: qiskit.transpiler.CouplingMap **Parameters** - * **distance** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The code distance for the generated heavy square graph. The value for distance can be any odd positive integer. The distance relates to the number of qubits by: $n = 3d^2 - 2d$ where $n$ is the number of qubits and $d$ is the `distance` parameter. - * **bidirectional** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether the edges in the output coupling graph are bidirectional or not. By default this is set to `True` + * **distance** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The code distance for the generated heavy square graph. The value for distance can be any odd positive integer. The distance relates to the number of qubits by: $n = 3d^2 - 2d$ where $n$ is the number of qubits and $d$ is the `distance` parameter. + * **bidirectional** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether the edges in the output coupling graph are bidirectional or not. By default this is set to `True` **Returns** @@ -252,9 +252,9 @@ python_api_name: qiskit.transpiler.CouplingMap **Parameters** - * **rows** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of rows to generate the graph with. - * **cols** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of columns to generate the graph with. - * **bidirectional** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether the edges in the output coupling graph are bidirectional or not. By default this is set to `True` + * **rows** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of rows to generate the graph with. + * **cols** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of columns to generate the graph with. + * **bidirectional** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether the edges in the output coupling graph are bidirectional or not. By default this is set to `True` **Returns** @@ -296,7 +296,7 @@ python_api_name: qiskit.transpiler.CouplingMap **Return type** - Tuple([int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)"),[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) + Tuple([int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)"),[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) ### is\_connected @@ -334,8 +334,8 @@ python_api_name: qiskit.transpiler.CouplingMap **Parameters** - * **mapping** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A mapping of reduced qubits to device qubits. - * **check\_if\_connected** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, checks that the reduced coupling map is connected. + * **mapping** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A mapping of reduced qubits to device qubits. + * **check\_if\_connected** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, checks that the reduced coupling map is connected. **Returns** @@ -357,8 +357,8 @@ python_api_name: qiskit.transpiler.CouplingMap **Parameters** - * **physical\_qubit1** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – A physical qubit - * **physical\_qubit2** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Another physical qubit + * **physical\_qubit1** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – A physical qubit + * **physical\_qubit2** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Another physical qubit **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/qiskit.transpiler.InstructionDurations.mdx index 11c59d443ce..f4eff0fa5ec 100644 --- a/docs/api/qiskit/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/qiskit.transpiler.InstructionDurations.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.InstructionDurations # InstructionDurations - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Helper class to provide durations of instructions for scheduling. @@ -20,7 +20,7 @@ python_api_name: qiskit.transpiler.InstructionDurations **Parameters** * **instruction\_durations** (*'InstructionDurationsType' | None*) – - * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – ### from\_backend @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.InstructionDurations **Raises** * [**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If dt and dtm is different in the backend. - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If the backend is the wrong type + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If the backend is the wrong type ### get @@ -54,10 +54,10 @@ python_api_name: qiskit.transpiler.InstructionDurations **Parameters** - * **inst** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – An instruction or its name to be queried. - * **qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – Qubit indices that the instruction acts on. - * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The unit of duration to be returned. It must be ‘s’ or ‘dt’. - * **parameters** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – The value of the parameters of the desired instruction. + * **inst** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – An instruction or its name to be queried. + * **qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – Qubit indices that the instruction acts on. + * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The unit of duration to be returned. It must be ‘s’ or ‘dt’. + * **parameters** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*] | None*) – The value of the parameters of the desired instruction. **Returns** @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.InstructionDurations **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")|[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")|[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") **Raises** @@ -83,7 +83,7 @@ python_api_name: qiskit.transpiler.InstructionDurations **Return type** - [set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")] + [set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")] ### update @@ -94,7 +94,7 @@ python_api_name: qiskit.transpiler.InstructionDurations **Parameters** * **inst\_durations** (*'InstructionDurationsType' | None*) – Instruction durations to be merged into self (overwriting self). - * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Sampling duration in seconds of the target backend. + * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Sampling duration in seconds of the target backend. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/qiskit.transpiler.Layout.mdx index 908a7d8025a..65cbb41a650 100644 --- a/docs/api/qiskit/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.Layout.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.Layout # Layout - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Two-ways dict to represent a Layout. @@ -24,8 +24,8 @@ python_api_name: qiskit.transpiler.Layout **Parameters** - * **virtual\_bit** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – A (qu)bit. For example, (QuantumRegister(3, ‘qr’), 2). - * **physical\_bit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – A physical bit. For example, 3. + * **virtual\_bit** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – A (qu)bit. For example, (QuantumRegister(3, ‘qr’), 2). + * **physical\_bit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – A physical bit. For example, 3. ### add\_register @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.Layout **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") **Raises** @@ -81,7 +81,7 @@ python_api_name: qiskit.transpiler.Layout **Parameters** * **other** ([*Layout*](#qiskit.transpiler.Layout "qiskit.transpiler.layout.Layout")) – The existing [`Layout`](#qiskit.transpiler.Layout "qiskit.transpiler.Layout") to compose this [`Layout`](#qiskit.transpiler.Layout "qiskit.transpiler.Layout") with. - * **qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – A list of [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") objects over which `other` is defined, used to establish the correspondence between the positions of the `other` qubits and the actual qubits. + * **qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – A list of [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") objects over which `other` is defined, used to establish the correspondence between the positions of the `other` qubits and the actual qubits. **Returns** @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.Layout **Parameters** - **input\_dict** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – + **input\_dict** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – e.g.: @@ -139,7 +139,7 @@ python_api_name: qiskit.transpiler.Layout **Parameters** - * **int\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of integers. + * **int\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of integers. * **\*qregs** (*QuantumRegisters*) – The quantum registers to apply the layout to. **Returns** @@ -162,7 +162,7 @@ python_api_name: qiskit.transpiler.Layout **Parameters** - * **qubit\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – e.g.: \[qr\[0], None, qr\[2], qr\[3]] + * **qubit\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – e.g.: \[qr\[0], None, qr\[2], qr\[3]] * **\*qregs** (*QuantumRegisters*) – The quantum registers to apply the layout to. **Returns** @@ -223,8 +223,8 @@ python_api_name: qiskit.transpiler.Layout **Parameters** - * **source\_qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – A list of [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") objects representing the domain of the layout. - * **target\_qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – A list of [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") objects representing the image of the layout. + * **source\_qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – A list of [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") objects representing the domain of the layout. + * **target\_qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – A list of [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") objects representing the image of the layout. **Returns** @@ -246,7 +246,7 @@ python_api_name: qiskit.transpiler.Layout **Parameters** - **bits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – the bits to reorder. + **bits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – the bits to reorder. **Returns** @@ -264,8 +264,8 @@ python_api_name: qiskit.transpiler.Layout **Parameters** - * **left** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Item to swap with right. - * **right** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Item to swap with left. + * **left** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Item to swap with right. + * **right** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)") *or*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Item to swap with left. **Raises** @@ -283,7 +283,7 @@ python_api_name: qiskit.transpiler.Layout **Parameters** - **qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – + **qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – diff --git a/docs/api/qiskit/qiskit.transpiler.OptimizationMetric.mdx b/docs/api/qiskit/qiskit.transpiler.OptimizationMetric.mdx index 2a7dc0e18ff..2cf85b6ff75 100644 --- a/docs/api/qiskit/qiskit.transpiler.OptimizationMetric.mdx +++ b/docs/api/qiskit/qiskit.transpiler.OptimizationMetric.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.OptimizationMetric # OptimizationMetric - Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.14)") Optimization metric considered during transpilation. diff --git a/docs/api/qiskit/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/qiskit.transpiler.PassManager.mdx index eb5f692e383..6b8fd3d4773 100644 --- a/docs/api/qiskit/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/qiskit.transpiler.PassManager.mdx @@ -17,8 +17,8 @@ python_api_name: qiskit.transpiler.PassManager **Parameters** - * **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[Task]*) – A pass set to be added to the pass manager schedule. - * **max\_iteration** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The maximum number of iterations the schedule will be looped if the condition is not met. + * **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[Task]*) – A pass set to be added to the pass manager schedule. + * **max\_iteration** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The maximum number of iterations the schedule will be looped if the condition is not met. ## Methods @@ -29,7 +29,7 @@ python_api_name: qiskit.transpiler.PassManager **Parameters** - **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[Task]*) – A set of transpiler passes to be added to schedule. + **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[Task]*) – A set of transpiler passes to be added to schedule. **Raises** @@ -49,9 +49,9 @@ python_api_name: qiskit.transpiler.PassManager **Parameters** - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. - * **style** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – keys are the pass classes and the values are the colors to make them. An example can be seen in the DEFAULT\_STYLE. An ordered dict can be used to ensure a priority coloring when pass falls into multiple categories. Any values not included in the provided dict will be filled in from the default dict. - * **raw** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, save the raw Dot output instead of the image. + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – file path to save image to. + * **style** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – keys are the pass classes and the values are the colors to make them. An example can be seen in the DEFAULT\_STYLE. An ordered dict can be used to ensure a priority coloring when pass falls into multiple categories. Any values not included in the provided dict will be filled in from the default dict. + * **raw** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, save the raw Dot output instead of the image. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.PassManager **Raises** - [**ImportError**](https://docs.python.org/3/library/exceptions.html#ImportError "(in Python v3.13)") – when nxpd or pydot not installed. + [**ImportError**](https://docs.python.org/3/library/exceptions.html#ImportError "(in Python v3.14)") – when nxpd or pydot not installed. ### remove @@ -73,7 +73,7 @@ python_api_name: qiskit.transpiler.PassManager **Parameters** - **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Pass index to remove, based on the position in [`passes()`](transpiler_passes#module-qiskit.transpiler.passes "qiskit.transpiler.passes"). + **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Pass index to remove, based on the position in [`passes()`](transpiler_passes#module-qiskit.transpiler.passes "qiskit.transpiler.passes"). **Raises** @@ -91,8 +91,8 @@ python_api_name: qiskit.transpiler.PassManager **Parameters** - * **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Pass index to replace, based on the position in passes(). - * **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[Task]*) – A pass set to be added to the pass manager schedule. + * **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Pass index to replace, based on the position in passes(). + * **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[Task]*) – A pass set to be added to the pass manager schedule. **Return type** @@ -108,7 +108,7 @@ python_api_name: qiskit.transpiler.PassManager * **circuits** (*\_CircuitsT*) – Circuit(s) to transform via all the registered passes. - * **output\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The output circuit name. If `None`, it will be set to the same as the input circuit name. + * **output\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The output circuit name. If `None`, it will be set to the same as the input circuit name. * **callback** (*Callable*) – @@ -144,9 +144,9 @@ python_api_name: qiskit.transpiler.PassManager When running transpilation with multi-processing, the callback function is invoked within the context of each sub-process, independently of the parent process. - * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The maximum number of parallel processes to launch if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. + * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The maximum number of parallel processes to launch if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. - * **property\_set** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*object*](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)")*] | None*) – If given, the initial value to use as the [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") for the pass manager pipeline. This can be used to persist analysis from one run to another, in cases where you know the analysis is safe to share. Beware that some analysis will be specific to the input circuit and the particular [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target"), so you should take a lot of care when using this argument. + * **property\_set** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*object*](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)")*] | None*) – If given, the initial value to use as the [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") for the pass manager pipeline. This can be used to persist analysis from one run to another, in cases where you know the analysis is safe to share. Beware that some analysis will be specific to the input circuit and the particular [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target"), so you should take a lot of care when using this argument. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.mdx b/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.mdx index 13303cac1de..0e552ecae34 100644 --- a/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.mdx +++ b/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig # PassManagerConfig - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Pass Manager Configuration. @@ -18,22 +18,22 @@ python_api_name: qiskit.transpiler.PassManagerConfig **Parameters** * **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – Initial position of virtual qubits on physical qubits. - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of basis gate names to unroll to. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of basis gate names to unroll to. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. - * **layout\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the pass to use for choosing initial qubit placement. This will be the plugin name if an external layout stage plugin is being used. - * **routing\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the pass to use for routing qubits on the architecture. This will be a plugin name if an external routing stage plugin is being used. - * **translation\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the pass to use for translating gates to basis\_gates. This will be a plugin name if an external translation stage plugin is being used. - * **scheduling\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the pass to use for scheduling instructions. This will be a plugin name if an external scheduling stage plugin is being used. + * **layout\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the pass to use for choosing initial qubit placement. This will be the plugin name if an external layout stage plugin is being used. + * **routing\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the pass to use for routing qubits on the architecture. This will be a plugin name if an external routing stage plugin is being used. + * **translation\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the pass to use for translating gates to basis\_gates. This will be a plugin name if an external translation stage plugin is being used. + * **scheduling\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the pass to use for scheduling instructions. This will be a plugin name if an external scheduling stage plugin is being used. * **instruction\_durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – Dictionary of duration (in dt) for each instruction. - * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation) - * **seed\_transpiler** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Sets random seed for the stochastic parts of the transpiler. + * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation) + * **seed\_transpiler** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Sets random seed for the stochastic parts of the transpiler. * **timing\_constraints** (*TimingConstraints*) – Hardware time alignment restrictions. - * **unitary\_synthesis\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The string method to use for the [`UnitarySynthesis`](qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") pass. Will search installed plugins for a valid method. You can see a list of installed plugins with [`unitary_synthesis_plugin_names()`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names"). + * **unitary\_synthesis\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The string method to use for the [`UnitarySynthesis`](qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") pass. Will search installed plugins for a valid method. You can see a list of installed plugins with [`unitary_synthesis_plugin_names()`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names"). * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The backend target * **hls\_config** ([*HLSConfig*](qiskit.transpiler.passes.HLSConfig "qiskit.transpiler.passes.HLSConfig")) – An optional configuration class to use for [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") pass. Specifies how to synthesize various high-level objects. - * **init\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The plugin name for the init stage plugin to use - * **optimization\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The plugin name for the optimization stage plugin to use. - * **qubits\_initially\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Indicates whether the input circuit is zero-initialized. + * **init\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The plugin name for the init stage plugin to use + * **optimization\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The plugin name for the optimization stage plugin to use. + * **qubits\_initially\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Indicates whether the input circuit is zero-initialized. ## Methods @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig **Raises** - [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If the backend does not support a configuration() method. + [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – If the backend does not support a configuration() method. diff --git a/docs/api/qiskit/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/qiskit.transpiler.StagedPassManager.mdx index 469bb4dd034..807c67c8ba1 100644 --- a/docs/api/qiskit/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/qiskit.transpiler.StagedPassManager.mdx @@ -34,13 +34,13 @@ python_api_name: qiskit.transpiler.StagedPassManager **Parameters** - * **stages** (*Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – An optional list of stages to use for this instance. If this is not specified the default stages list `['init', 'layout', 'routing', 'translation', 'optimization', 'scheduling']` is used. After instantiation, the final list will be immutable and stored as tuple. If a stage is provided multiple times (i.e. at diferent relative positions), the associated passes, including pre and post, will run once per declaration. + * **stages** (*Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – An optional list of stages to use for this instance. If this is not specified the default stages list `['init', 'layout', 'routing', 'translation', 'optimization', 'scheduling']` is used. After instantiation, the final list will be immutable and stored as tuple. If a stage is provided multiple times (i.e. at diferent relative positions), the associated passes, including pre and post, will run once per declaration. * **kwargs** – The initial [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") values for any stages defined in `stages`. If a argument is not defined the stages will default to `None` indicating an empty/undefined stage. **Raises** - * [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If a stage in the input keyword arguments is not defined. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If an invalid stage name is specified. + * [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – If a stage in the input keyword arguments is not defined. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If an invalid stage name is specified. ## Attributes @@ -69,7 +69,7 @@ python_api_name: qiskit.transpiler.StagedPassManager **Parameters** - **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[Task]*) – A set of transpiler passes to be added to schedule. + **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[Task]*) – A set of transpiler passes to be added to schedule. **Raises** @@ -93,7 +93,7 @@ python_api_name: qiskit.transpiler.StagedPassManager **Parameters** - **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Pass index to remove, based on the position in [`passes()`](transpiler_passes#module-qiskit.transpiler.passes "qiskit.transpiler.passes"). + **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Pass index to remove, based on the position in [`passes()`](transpiler_passes#module-qiskit.transpiler.passes "qiskit.transpiler.passes"). **Raises** @@ -111,8 +111,8 @@ python_api_name: qiskit.transpiler.StagedPassManager **Parameters** - * **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Pass index to replace, based on the position in passes(). - * **passes** (*BasePass |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[BasePass]*) – A pass set to be added to the pass manager schedule. + * **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Pass index to replace, based on the position in passes(). + * **passes** (*BasePass |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[BasePass]*) – A pass set to be added to the pass manager schedule. **Return type** @@ -128,7 +128,7 @@ python_api_name: qiskit.transpiler.StagedPassManager * **circuits** (*\_CircuitsT*) – Circuit(s) to transform via all the registered passes. - * **output\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The output circuit name. If `None`, it will be set to the same as the input circuit name. + * **output\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The output circuit name. If `None`, it will be set to the same as the input circuit name. * **callback** (*Callable | None*) – @@ -164,9 +164,9 @@ python_api_name: qiskit.transpiler.StagedPassManager When running transpilation with multi-processing, the callback function is invoked within the context of each sub-process, independently of the parent process. - * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The maximum number of parallel processes to launch if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. + * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The maximum number of parallel processes to launch if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. - * **property\_set** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*object*](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)")*] | None*) – If given, the initial value to use as the [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") for the pass manager pipeline. This can be used to persist analysis from one run to another, in cases where you know the analysis is safe to share. Beware that some analysis will be specific to the input circuit and the particular [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target"), so you should take a lot of care when using this argument. + * **property\_set** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*object*](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)")*] | None*) – If given, the initial value to use as the [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") for the pass manager pipeline. This can be used to persist analysis from one run to another, in cases where you know the analysis is safe to share. Beware that some analysis will be specific to the input circuit and the particular [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target"), so you should take a lot of care when using this argument. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.Target.mdx b/docs/api/qiskit/qiskit.transpiler.Target.mdx index 63c6b4d0ece..0fe0e5d6749 100644 --- a/docs/api/qiskit/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/qiskit.transpiler.Target.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.Target # Target - + Bases: `BaseTarget` The intent of the `Target` object is to inform Qiskit’s compiler about the constraints of a particular backend so the compiler can compile an input circuit to something that works and is optimized for a device. It currently contains a description of instructions on a backend and their properties as well as some timing information. However, this exact interface may evolve over time as the needs of the compiler change. These changes will be done in a backwards compatible and controlled manner when they are made (either through versioning, subclassing, or mixins) to add on to the set of information exposed by a target. @@ -78,30 +78,102 @@ python_api_name: qiskit.transpiler.Target This class can be queried via the mapping protocol, using the instruction’s name as a key. You can modify any property for an instruction via the [`update_instruction_properties()`](#qiskit.transpiler.Target.update_instruction_properties "qiskit.transpiler.Target.update_instruction_properties") method. Modification via the mapping protocol or mutating the attributes of a [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") object is **not** supported and doing so will invalidate the internal state of the object. - This class assumes that qubit indices start at 0 and are a contiguous set if you want a submapping the bits will need to be reindexed in a new\`\`Target\`\` object. + This class assumes that qubit indices start at 0 and are a contiguous set if you want a submapping the bits will need to be reindexed in a new [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") object. This class only supports additions of gates, qargs, and properties. If you need to remove one of these the best option is to iterate over an existing object and create a new subset (or use one of the methods to do this). The object internally caches different views and these would potentially be invalidated by removals. - Create a new `Target` object + ## Subclassing - **Parameters** + While it is technically possible to subclass [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"), beware that the majority of the built-in information is in Rust and is queried from Rust in built-in transpiler passes. Python-space overrides are not visible to Rust, and you should not rely on these to change the behavior of Qiskit’s built-in transpiler passes. [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") is largely supposed to be a representation of a QPU that has specialized *constructors*, not specialized subclasses; the usual API for constructing a [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") should be a function that returns a base [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"), not a subclass with a custom initializer. + + You may use subclassing to add *addition* Python-space properties to your [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"), for example to then interpret in custom backend-specific transpiler stages; the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") is passed to stage-plugin constructors. + + You should not subclass [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") to attempt to modify the behavior of Qiskit’s built-in passes; the Python-space subclassing will not be seen by passes written in Rust. + + Further, as the core of [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") is written in Rust, it uses [`__new__()`](https://docs.python.org/3/reference/datamodel.html#object.__new__ "(in Python v3.14)") as its initializer, and you must ensure that the correct arguments are passed through to the underlying implementation. If you override the signature of the [`__init__()`](https://docs.python.org/3/reference/datamodel.html#object.__init__ "(in Python v3.14)") method, you must also include an override of [`__new__()`](https://docs.python.org/3/reference/datamodel.html#object.__new__ "(in Python v3.14)") with the same signature, which calls `super().__new__()` in a correct manner. + + Create a new [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") object. + + **param description** + + An optional string to describe the Target. + + **type description** + + str + + **param num\_qubits** + + An optional int to specify the number of qubits the backend target has. This is not a hard limit on the construction; any call to [`add_instruction()`](#qiskit.transpiler.Target.add_instruction "qiskit.transpiler.Target.add_instruction") will cause the set num\_qubits to update to accommodate any concrete `qargs` in the given properties. + + This can be explicitly set to `None` to indicate a [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") representing a simulator or other abstract machine that imposes no limits on the number of qubits. In this case, all instructions added to the target should be global (with `properties=None` or `properties={None: None}`). + + **type num\_qubits** + + int + + **param dt** + + The system time resolution of input signals in seconds + + **type dt** + + float + + **param granularity** + + An integer value representing minimum pulse gate resolution in units of `dt`. A user-defined pulse gate should have duration of a multiple of this granularity value. + + **type granularity** + + int - * **description** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – An optional string to describe the Target. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – An optional int to specify the number of qubits the backend target has. If not set it will be implicitly set based on the qargs when `add_instruction()` is called. Note this must be set if the backend target is for a noiseless simulator that doesn’t have constraints on the instructions so the transpiler knows how many qubits are available. - * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The system time resolution of input signals in seconds - * **granularity** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – An integer value representing minimum pulse gate resolution in units of `dt`. A user-defined pulse gate should have duration of a multiple of this granularity value. - * **min\_length** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – An integer value representing minimum pulse gate length in units of `dt`. A user-defined pulse gate should be longer than this length. - * **pulse\_alignment** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – An integer value representing a time resolution of gate instruction starting time. Gate instruction should start at time which is a multiple of the alignment value. - * **acquire\_alignment** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – An integer value representing a time resolution of measure instruction starting time. Measure instruction should start at time which is a multiple of the alignment value. - * **qubit\_properties** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") objects defining the characteristics of each qubit on the target device. If specified the length of this list must match the number of qubits in the target, where the index in the list matches the qubit number the properties are defined for. If some qubits don’t have properties available you can set that entry to `None` - * **concurrent\_measurements** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of sets of qubits that must be measured together. This must be provided as a nested list like `[[0, 1], [2, 3, 4]]`. + **param min\_length** - **Raises** + An integer value representing minimum pulse gate length in units of `dt`. A user-defined pulse gate should be longer than this length. - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If both `num_qubits` and `qubit_properties` are both defined and the value of `num_qubits` differs from the length of `qubit_properties`. + **type min\_length** + + int + + **param pulse\_alignment** + + An integer value representing a time resolution of gate instruction starting time. Gate instruction should start at time which is a multiple of the alignment value. + + **type pulse\_alignment** + + int + + **param acquire\_alignment** + + An integer value representing a time resolution of measure instruction starting time. Measure instruction should start at time which is a multiple of the alignment value. + + **type acquire\_alignment** + + int + + **param qubit\_properties** + + A list of [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") objects defining the characteristics of each qubit on the target device. If specified the length of this list must match the number of qubits in the target, where the index in the list matches the qubit number the properties are defined for. If some qubits don’t have properties available you can set that entry to `None` + + **type qubit\_properties** + + list + + **param concurrent\_measurements** + + A list of sets of qubits that must be measured together. This must be provided as a nested list like `[[0, 1], [2, 3, 4]]`. + + **type concurrent\_measurements** + + list + + **raises ValueError** + + If both `num_qubits` and `qubit_properties` are both defined and the value of `num_qubits` differs from the length of `qubit_properties`. ## Attributes @@ -179,7 +251,7 @@ python_api_name: qiskit.transpiler.Target ### add\_instruction - + Add a new instruction to the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") As `Target` objects are strictly additive this is the primary method for modifying a `Target`. Typically, you will use this to fully populate a `Target` before using it in [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). For example: @@ -207,27 +279,27 @@ python_api_name: qiskit.transpiler.Target **Parameters** * **instruction** (*Union\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*,* [*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]]*) – The operation object to add to the map. If it’s parameterized any value of the parameter can be set. Optionally for variable width instructions (such as control flow operations such as `ForLoop` or `MCXGate`) you can specify the class. If the class is specified than the `name` argument must be specified. When a class is used the gate is treated as global and not having any properties set. - * **properties** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – A dictionary of qarg entries to an [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") object for that instruction implementation on the backend. Properties are optional for any instruction implementation, if there are no [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") available for the backend the value can be None. If there are no constraints on the instruction (as in a noiseless/ideal simulation) this can be set to `{None, None}` which will indicate it runs on all qubits (or all available permutations of qubits for multi-qubit gates). The first `None` indicates it applies to all qubits and the second `None` indicates there are no [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") for the instruction. By default, if properties is not set it is equivalent to passing `{None: None}`. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – An optional name to use for identifying the instruction. If not specified the [`name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") attribute of `gate` will be used. All gates in the `Target` need unique names. Backends can differentiate between different parameterization of a single gate by providing a unique name for each (e.g. “rx30”, “rx60”, \`”rx90”\`\` similar to the example in the documentation for the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") class). - * **angle\_bounds** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – The bounds on the parameters for a given gate. This is specified by a list of tuples (low, high) which represent the low and high bound (inclusively) on what float values are allowed for the parameter in that position. If a parameter doesn’t have an angle bound you can use `None` to represent that. For example if a 3 parameter gate only had a bound on the second parameter you would represent that with: `[None, [0, 3.14], None]` which means the first and third parameter allow any value but the second parameter only accepts values between 0 and 3.14. + * **properties** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – A dictionary of qarg entries to an [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") object for that instruction implementation on the backend. Properties are optional for any instruction implementation, if there are no [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") available for the backend the value can be None. If there are no constraints on the instruction (as in a noiseless/ideal simulation) this can be set to `{None, None}` which will indicate it runs on all qubits (or all available permutations of qubits for multi-qubit gates). The first `None` indicates it applies to all qubits and the second `None` indicates there are no [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") for the instruction. By default, if properties is not set it is equivalent to passing `{None: None}`. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – An optional name to use for identifying the instruction. If not specified the [`name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") attribute of `gate` will be used. All gates in the `Target` need unique names. Backends can differentiate between different parameterization of a single gate by providing a unique name for each (e.g. “rx30”, “rx60”, \`”rx90”\`\` similar to the example in the documentation for the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") class). + * **angle\_bounds** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – The bounds on the parameters for a given gate. This is specified by a list of tuples (low, high) which represent the low and high bound (inclusively) on what float values are allowed for the parameter in that position. If a parameter doesn’t have an angle bound you can use `None` to represent that. For example if a 3 parameter gate only had a bound on the second parameter you would represent that with: `[None, [0, 3.14], None]` which means the first and third parameter allow any value but the second parameter only accepts values between 0 and 3.14. **Raises** - * [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If gate is already in map + * [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.14)") – If gate is already in map * [**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If an operation class is passed in for `instruction` and no name is specified or `properties` is set. ### build\_coupling\_map - + Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. If there is a mix of two qubit operations that have a connectivity constraint and those that are globally defined this will also return `None` because the globally connectivity means there is no constraint on the target. If you wish to see the constraints of the two qubit operations that have constraints you should use the `two_q_gate` argument to limit the output to the gates which have a constraint. **Parameters** - * **two\_q\_gate** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – An optional gate name for a two qubit gate in the `Target` to generate the coupling map for. If specified the output coupling map will only have edges between qubits where this gate is present. - * **filter\_idle\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to `True` the output [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") will remove any qubits that don’t have any operations defined in the target. Note that using this argument will result in an output [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") object which has holes in its indices which might differ from the assumptions of the class. The typical use case of this argument is to be paired with [`CouplingMap.connected_components()`](qiskit.transpiler.CouplingMap#connected_components "qiskit.transpiler.CouplingMap.connected_components") which will handle the holes as expected. + * **two\_q\_gate** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – An optional gate name for a two qubit gate in the `Target` to generate the coupling map for. If specified the output coupling map will only have edges between qubits where this gate is present. + * **filter\_idle\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to `True` the output [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") will remove any qubits that don’t have any operations defined in the target. Note that using this argument will result in an output [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") object which has holes in its indices which might differ from the assumptions of the class. The typical use case of this argument is to be paired with [`CouplingMap.connected_components()`](qiskit.transpiler.CouplingMap#connected_components "qiskit.transpiler.CouplingMap.connected_components") which will handle the holes as expected. **Returns** @@ -241,13 +313,13 @@ python_api_name: qiskit.transpiler.Target **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If a non-two qubit gate is passed in for `two_q_gate`. - * [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.13)") – If an Instruction not in the `Target` is passed in for `two_q_gate`. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If a non-two qubit gate is passed in for `two_q_gate`. + * [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.14)") – If an Instruction not in the `Target` is passed in for `two_q_gate`. ### durations - + Get an InstructionDurations object from the target **Returns** @@ -263,7 +335,7 @@ python_api_name: qiskit.transpiler.Target ### from\_configuration - + Create a target object from the individual global configuration Prior to the creation of the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") class, the constraints of a backend were represented by a collection of different objects which combined represent a subset of the information contained in the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). This function provides a simple interface to convert those separate objects to a [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). @@ -272,14 +344,14 @@ python_api_name: qiskit.transpiler.Target **Parameters** - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – The list of basis gate names for the backend. For the target to be created these names must either be in the output from [`get_standard_gate_name_mapping()`](circuit_library#qiskit.circuit.library.get_standard_gate_name_mapping "qiskit.circuit.library.get_standard_gate_name_mapping") or present in the specified `custom_name_mapping` argument. - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of qubits supported on the backend. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – The list of basis gate names for the backend. For the target to be created these names must either be in the output from [`get_standard_gate_name_mapping()`](circuit_library#qiskit.circuit.library.get_standard_gate_name_mapping "qiskit.circuit.library.get_standard_gate_name_mapping") or present in the specified `custom_name_mapping` argument. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of qubits supported on the backend. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") *| None*) – The coupling map representing connectivity constraints on the backend. If specified all gates from `basis_gates` will be supported on all qubits (or pairs of qubits). * **instruction\_durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") *| None*) – Optional instruction durations for instructions. If specified it will take priority for setting the `duration` field in the [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") objects for the instructions in the target. - * **concurrent\_measurements** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of sets of qubits that must be measured together. This must be provided as a nested list like `[[0, 1], [2, 3, 4]]`. - * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – The system time resolution of input signals in seconds + * **concurrent\_measurements** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of sets of qubits that must be measured together. This must be provided as a nested list like `[[0, 1], [2, 3, 4]]`. + * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – The system time resolution of input signals in seconds * **timing\_constraints** (*TimingConstraints | None*) – Optional timing constraints to include in the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") - * **custom\_name\_mapping** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – An optional dictionary that maps custom gate/operation names in `basis_gates` to an [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") object representing that gate/operation. By default, most standard gates names are mapped to the standard gate object from [`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library") this only needs to be specified if the input `basis_gates` defines gates in names outside that set. + * **custom\_name\_mapping** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Any] | None*) – An optional dictionary that maps custom gate/operation names in `basis_gates` to an [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") object representing that gate/operation. By default, most standard gates names are mapped to the standard gate object from [`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library") this only needs to be specified if the input `basis_gates` defines gates in names outside that set. **Returns** @@ -293,7 +365,7 @@ python_api_name: qiskit.transpiler.Target * [**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If the input basis gates contain > 2 qubits and `coupling_map` is * **specified.** – - * [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") – If no mapping is available for a specified `basis_gate`. + * [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") – If no mapping is available for a specified `basis_gate`. ### gate\_has\_angle\_bounds @@ -303,7 +375,7 @@ python_api_name: qiskit.transpiler.Target **Parameters** - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The instruction name to check if it has an angle bound set + **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The instruction name to check if it has an angle bound set **Returns** @@ -311,25 +383,25 @@ python_api_name: qiskit.transpiler.Target **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### get - + Gets an item from the Target. If not found return a provided default or None. ### get\_non\_global\_operation\_names - + Return the non-global operation names for the target The non-global operations are those in the target which don’t apply on all qubits (for single qubit operations) or all multi-qubit qargs (for multi-qubit operations). **Parameters** - **strict\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to `True` the multi-qubit operations considered as non-global respect the strict direction (or order of qubits in the qargs is significant). For example, if `cx` is defined on `(0, 1)` and `ecr` is defined over `(1, 0)` by default neither would be considered non-global, but if `strict_direction` is set `True` both `cx` and `ecr` would be returned. + **strict\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to `True` the multi-qubit operations considered as non-global respect the strict direction (or order of qubits in the qargs is significant). For example, if `cx` is defined on `(0, 1)` and `ecr` is defined over `(1, 0)` by default neither would be considered non-global, but if `strict_direction` is set `True` both `cx` and `ecr` would be returned. **Returns** @@ -337,7 +409,7 @@ python_api_name: qiskit.transpiler.Target **Return type** - List\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")] + List\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")] ### has\_angle\_bounds @@ -351,12 +423,12 @@ python_api_name: qiskit.transpiler.Target **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### instruction\_properties - + Get the instruction properties for a specific instruction tuple This method is to be used in conjunction with the [`instructions`](#qiskit.transpiler.Target.instructions "qiskit.transpiler.Target.instructions") attribute of a [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") object. You can use this method to quickly get the instruction properties for an element of [`instructions`](#qiskit.transpiler.Target.instructions "qiskit.transpiler.Target.instructions") by using the index in that list. However, if you’re not working with [`instructions`](#qiskit.transpiler.Target.instructions "qiskit.transpiler.Target.instructions") directly it is likely more efficient to access the target directly via the name and qubits to get the instruction properties. For example, if [`instructions`](#qiskit.transpiler.Target.instructions "qiskit.transpiler.Target.instructions") returned: @@ -381,7 +453,7 @@ python_api_name: qiskit.transpiler.Target **Parameters** - **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The index of the instruction tuple from the [`instructions`](#qiskit.transpiler.Target.instructions "qiskit.transpiler.Target.instructions") attribute. For, example if you want the properties from the third element in [`instructions`](#qiskit.transpiler.Target.instructions "qiskit.transpiler.Target.instructions") you would set this to be `2`. + **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The index of the instruction tuple from the [`instructions`](#qiskit.transpiler.Target.instructions "qiskit.transpiler.Target.instructions") attribute. For, example if you want the properties from the third element in [`instructions`](#qiskit.transpiler.Target.instructions "qiskit.transpiler.Target.instructions") you would set this to be `2`. **Returns** @@ -399,13 +471,13 @@ python_api_name: qiskit.transpiler.Target **Parameters** - * **operation\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the operation for the instruction. Either this or `operation_class` must be specified, if both are specified `operation_class` will take priority and this argument will be ignored. + * **operation\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the operation for the instruction. Either this or `operation_class` must be specified, if both are specified `operation_class` will take priority and this argument will be ignored. - * **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – The tuple of qubit indices for the instruction. If this is not specified then this method will return `True` if the specified operation is supported on any qubits. The typical application will always have this set (otherwise it’s the same as just checking if the target contains the operation). Normally you would not set this argument if you wanted to check more generally that the target supports an operation with the `parameters` on any qubits. + * **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – The tuple of qubit indices for the instruction. If this is not specified then this method will return `True` if the specified operation is supported on any qubits. The typical application will always have this set (otherwise it’s the same as just checking if the target contains the operation). Normally you would not set this argument if you wanted to check more generally that the target supports an operation with the `parameters` on any qubits. * **operation\_class** ([*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]*) – The operation class to check whether the target supports a particular operation by class rather than by name. This lookup is more expensive as it needs to iterate over all operations in the target instead of just a single lookup. If this is specified it will supersede the `operation_name` argument. The typical use case for this operation is to check whether a specific variant of an operation is supported on the backend. For example, if you wanted to check whether a [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") was supported on a specific qubit with a fixed angle. That fixed angle variant will typically have a name different from the object’s [`name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") attribute (`"rx"`) in the target. This can be used to check if any instances of the class are available in such a case. - * **parameters** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – + * **parameters** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of parameters to check if the target supports them on the specified qubits. If the instruction supports the parameter values specified in the list on the operation and qargs specified this will return `True` but if the parameters are not supported on the specified instruction it will return `False`. If this argument is not specified this method will return `True` if the instruction is supported independent of the instruction parameters. If specified with any [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the list, that entry will be treated as supporting any value, however parameter names will not be checked (for example if an operation in the target is listed as parameterized with `"theta"` and `"phi"` is passed into this function that will return `True`). For example, if called with: @@ -422,7 +494,7 @@ python_api_name: qiskit.transpiler.Target will return `True` if an RXGate(pi/4) exists on qubit 0. - * **check\_angle\_bounds** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to True (the default) the value of `parameters` will be validated against any angle bounds set in the target. If any of the values in `parameters` are set to be [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") instances this flag will have no effect as angle bounds only impact non-parameterized operations in the circuit. + * **check\_angle\_bounds** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to True (the default) the value of `parameters` will be validated against any angle bounds set in the target. If any of the values in `parameters` are set to be [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") instances this flag will have no effect as angle bounds only impact non-parameterized operations in the circuit. **Returns** @@ -430,18 +502,18 @@ python_api_name: qiskit.transpiler.Target **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### items - + Returns pairs of Gate names and its property map (str, dict\[tuple, InstructionProperties]) ### keys - + Return the keys (operation\_names) of the Target @@ -452,7 +524,7 @@ python_api_name: qiskit.transpiler.Target **Parameters** - **instruction** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The instruction name to get the [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instance for + **instruction** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The instruction name to get the [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instance for **Returns** @@ -470,7 +542,7 @@ python_api_name: qiskit.transpiler.Target **Parameters** - **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – A `qargs` tuple of the qubits to get the gates that apply to it. For example, `(0,)` will return the set of all instructions that apply to qubit 0. If set to `None` this will return the names for any globally defined operations in the target. + **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – A `qargs` tuple of the qubits to get the gates that apply to it. For example, `(0,)` will return the set of all instructions that apply to qubit 0. If set to `None` this will return the names for any globally defined operations in the target. **Returns** @@ -478,11 +550,11 @@ python_api_name: qiskit.transpiler.Target **Return type** - [set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)") + [set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.14)") **Raises** - [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") – If `qargs` is not in target + [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") – If `qargs` is not in target ### operations\_for\_qargs @@ -492,7 +564,7 @@ python_api_name: qiskit.transpiler.Target **Parameters** - **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – A qargs tuple of the qubits to get the gates that apply to it. For example, `(0,)` will return the set of all instructions that apply to qubit 0. If set to `None` this will return any globally defined operations in the target. + **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – A qargs tuple of the qubits to get the gates that apply to it. For example, `(0,)` will return the set of all instructions that apply to qubit 0. If set to `None` this will return any globally defined operations in the target. **Returns** @@ -500,21 +572,21 @@ python_api_name: qiskit.transpiler.Target **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** - [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") – If qargs is not in target + [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") – If qargs is not in target ### qargs\_for\_operation\_name - + Get the qargs for a given operation name **Parameters** - **operation** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The operation name to get qargs for + **operation** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The operation name to get qargs for **Returns** @@ -522,21 +594,21 @@ python_api_name: qiskit.transpiler.Target **Return type** - [set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)") + [set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.14)") ### seconds\_to\_dt - + Convert a given duration in seconds to units of dt **Parameters** - **duration** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The duration in seconds, such as in an [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") field for an instruction in the target. + **duration** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The duration in seconds, such as in an [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") field for an instruction in the target. **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") **Returns** @@ -550,8 +622,8 @@ python_api_name: qiskit.transpiler.Target **Parameters** - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The instruction name to check the angle bounds of - * **angles** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of float parameter values for `name` to see if they conform to the defined angle bounds. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The instruction name to check the angle bounds of + * **angles** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of float parameter values for `name` to see if they conform to the defined angle bounds. **Returns** @@ -559,7 +631,7 @@ python_api_name: qiskit.transpiler.Target **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") **Raises** @@ -569,7 +641,7 @@ python_api_name: qiskit.transpiler.Target ### timing\_constraints - + Get an `TimingConstraints` object from the target **Returns** @@ -583,26 +655,38 @@ python_api_name: qiskit.transpiler.Target ### update\_instruction\_properties - + Update the property object for an instruction qarg pair already in the Target. For ease of access, a user is able to obtain the mapping between an instruction’s applicable qargs and its instruction properties via the mapping protocol (using `__getitem__`), with the instruction’s name as the key. This method is the only way to modify/update the properties of an instruction in the `Target`. Usage of the mapping protocol for modifications is not supported. **Parameters** - * **instruction** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The instruction name to update - * **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – The qargs to update the properties of + * **instruction** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The instruction name to update + * **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – The qargs to update the properties of * **properties** ([*InstructionProperties*](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties")) – The properties to set for this instruction **Raises** - [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)") – If `instruction` or `qarg` are not in the target + [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.14)") – If `instruction` or `qarg` are not in the target ### values - + Return the Property Map (qargs -> InstructionProperties) of every instruction in the Target + + **Parameters** + + * **description** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – + * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – + * **granularity** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **min\_length** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **pulse\_alignment** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **acquire\_alignment** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – + * **qubit\_properties** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *| None*) – + * **concurrent\_measurements** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *| None*) – diff --git a/docs/api/qiskit/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/qiskit.transpiler.TransformationPass.mdx index a578f9e41f5..98d50387718 100644 --- a/docs/api/qiskit/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/qiskit.transpiler.TransformationPass.mdx @@ -40,9 +40,9 @@ python_api_name: qiskit.transpiler.TransformationPass **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.TransformationPass **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.TransformationPass **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.TransformationPass **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – when this is left unimplemented for a pass. ### update\_status diff --git a/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx b/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx index 500551b7185..5a53167380a 100644 --- a/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.TranspileLayout # TranspileLayout - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Layout attributes for the output circuit from transpiler. @@ -90,9 +90,9 @@ python_api_name: qiskit.transpiler.TranspileLayout **Parameters** * **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – - * **input\_qubit\_mapping** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **input\_qubit\_mapping** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – * **final\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout") *| None*) – - * **\_input\_qubit\_count** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **\_input\_qubit\_count** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – * **\_output\_qubit\_list** (*List\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*] | None*) – ### final\_layout @@ -143,7 +143,7 @@ python_api_name: qiskit.transpiler.TranspileLayout **Parameters** - **filter\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to `False` any ancillas allocated in the output circuit will be included in the layout. + **filter\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to `False` any ancillas allocated in the output circuit will be included in the layout. **Returns** @@ -151,7 +151,7 @@ python_api_name: qiskit.transpiler.TranspileLayout **Return type** - [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] + [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")] ### final\_virtual\_layout @@ -192,7 +192,7 @@ python_api_name: qiskit.transpiler.TranspileLayout **Parameters** - **filter\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to `False` any ancillas allocated in the output circuit will be included in the layout. + **filter\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to `False` any ancillas allocated in the output circuit will be included in the layout. **Returns** @@ -259,7 +259,7 @@ python_api_name: qiskit.transpiler.TranspileLayout **Parameters** - **filter\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to `True` any ancilla qubits added to the transpiler will not be included in the output. + **filter\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to `True` any ancilla qubits added to the transpiler will not be included in the output. **Returns** @@ -267,7 +267,7 @@ python_api_name: qiskit.transpiler.TranspileLayout **Return type** - [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] + [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")] ### initial\_virtual\_layout @@ -279,7 +279,7 @@ python_api_name: qiskit.transpiler.TranspileLayout **Parameters** - **filter\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to `True` only qubits in the input circuit will be in the returned layout. Any ancilla qubits added to the output circuit will be filtered from the returned object. + **filter\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to `True` only qubits in the input circuit will be in the returned layout. Any ancilla qubits added to the output circuit will be filtered from the returned object. **Returns** @@ -303,7 +303,7 @@ python_api_name: qiskit.transpiler.TranspileLayout **Return type** - [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] + [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")] ### write\_into\_property\_set @@ -339,7 +339,7 @@ python_api_name: qiskit.transpiler.TranspileLayout **Parameters** - **property\_set** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*object*](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)")*]*) – the [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") (or general [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) that the output should be written into. This mutates the input in place. + **property\_set** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*object*](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)")*]*) – the [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") (or general [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) that the output should be written into. This mutates the input in place. diff --git a/docs/api/qiskit/qiskit.transpiler.WrapAngleRegistry.mdx b/docs/api/qiskit/qiskit.transpiler.WrapAngleRegistry.mdx index 82e81ddce35..ec496ca4e31 100644 --- a/docs/api/qiskit/qiskit.transpiler.WrapAngleRegistry.mdx +++ b/docs/api/qiskit/qiskit.transpiler.WrapAngleRegistry.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.WrapAngleRegistry # WrapAngleRegistry - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Registry of Angle Wrapping function diff --git a/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager.mdx b/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager.mdx index 91753f29118..a8c1d7619bb 100644 --- a/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager.mdx +++ b/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager.mdx @@ -25,7 +25,7 @@ python_api_name: qiskit.transpiler.generate_preset_pass_manager **Parameters** - * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The optimization level to generate a [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager") for. By default optimization level 2 is used if this is not specified. This can be 0, 1, 2, or 3. Higher levels generate potentially more optimized circuits, at the expense of longer transpilation time: @@ -38,42 +38,42 @@ python_api_name: qiskit.transpiler.generate_preset_pass_manager * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing a backend compilation target. The following attributes will be inferred from this argument if they are not set: `coupling_map` and `basis_gates`. - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of basis gate names to unroll to (e.g: `['u1', 'u2', 'u3', 'cx']`). + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of basis gate names to unroll to (e.g: `['u1', 'u2', 'u3', 'cx']`). - * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – + * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – Directed graph represented a coupling map. Multiple formats are supported: 1. `CouplingMap` instance 2. List, must be given as an adjacency matrix, where each entry specifies all directed two-qubit interactions supported by backend, e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]` - * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Backend sample time (resolution) in seconds. If `None` (default) and a backend is provided, `backend.dt` is used. + * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Backend sample time (resolution) in seconds. If `None` (default) and a backend is provided, `backend.dt` is used. - * **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout") *| List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – Initial position of virtual qubits on physical qubits. + * **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout") *| List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – Initial position of virtual qubits on physical qubits. - * **layout\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The `Pass` to use for choosing initial qubit placement. Valid choices are `'trivial'`, `'dense'`, and `'sabre'`, representing [`TrivialLayout`](qiskit.transpiler.passes.TrivialLayout "qiskit.transpiler.passes.TrivialLayout"), [`DenseLayout`](qiskit.transpiler.passes.DenseLayout "qiskit.transpiler.passes.DenseLayout") and [`SabreLayout`](qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") respectively. This can also be the external plugin name to use for the `layout` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"layout"` for the `stage_name` argument. + * **layout\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The `Pass` to use for choosing initial qubit placement. Valid choices are `'trivial'`, `'dense'`, and `'sabre'`, representing [`TrivialLayout`](qiskit.transpiler.passes.TrivialLayout "qiskit.transpiler.passes.TrivialLayout"), [`DenseLayout`](qiskit.transpiler.passes.DenseLayout "qiskit.transpiler.passes.DenseLayout") and [`SabreLayout`](qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") respectively. This can also be the external plugin name to use for the `layout` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"layout"` for the `stage_name` argument. - * **routing\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The pass to use for routing qubits on the architecture. Valid choices are `'basic'`, `'lookahead'`, `'sabre'`, and `'none'` representing [`BasicSwap`](qiskit.transpiler.passes.BasicSwap "qiskit.transpiler.passes.BasicSwap"), [`LookaheadSwap`](qiskit.transpiler.passes.LookaheadSwap "qiskit.transpiler.passes.LookaheadSwap"), [`SabreSwap`](qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap"), and erroring if routing is required respectively. This can also be the external plugin name to use for the `routing` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"routing"` for the `stage_name` argument. + * **routing\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The pass to use for routing qubits on the architecture. Valid choices are `'basic'`, `'lookahead'`, `'sabre'`, and `'none'` representing [`BasicSwap`](qiskit.transpiler.passes.BasicSwap "qiskit.transpiler.passes.BasicSwap"), [`LookaheadSwap`](qiskit.transpiler.passes.LookaheadSwap "qiskit.transpiler.passes.LookaheadSwap"), [`SabreSwap`](qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap"), and erroring if routing is required respectively. This can also be the external plugin name to use for the `routing` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"routing"` for the `stage_name` argument. - * **translation\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The method to use for translating gates to basis gates. Valid choices `'translator'`, `'synthesis'` representing [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator"), and [`UnitarySynthesis`](qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") respectively. This can also be the external plugin name to use for the `translation` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"translation"` for the `stage_name` argument. + * **translation\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The method to use for translating gates to basis gates. Valid choices `'translator'`, `'synthesis'` representing [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator"), and [`UnitarySynthesis`](qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") respectively. This can also be the external plugin name to use for the `translation` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"translation"` for the `stage_name` argument. - * **scheduling\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The pass to use for scheduling instructions. Valid choices are `'alap'` and `'asap'`. This can also be the external plugin name to use for the `scheduling` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"scheduling"` for the `stage_name` argument. + * **scheduling\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The pass to use for scheduling instructions. Valid choices are `'alap'` and `'asap'`. This can also be the external plugin name to use for the `scheduling` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"scheduling"` for the `stage_name` argument. - * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation). + * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation). - * **seed\_transpiler** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Sets random seed for the stochastic parts of the transpiler. + * **seed\_transpiler** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Sets random seed for the stochastic parts of the transpiler. - * **unitary\_synthesis\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the unitary synthesis method to use. By default `'default'` is used. You can see a list of installed plugins with [`unitary_synthesis_plugin_names()`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names"). + * **unitary\_synthesis\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the unitary synthesis method to use. By default `'default'` is used. You can see a list of installed plugins with [`unitary_synthesis_plugin_names()`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names"). - * **unitary\_synthesis\_plugin\_config** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – An optional configuration dictionary that will be passed directly to the unitary synthesis plugin. By default this setting will have no effect as the default unitary synthesis method does not take custom configuration. This should only be necessary when a unitary synthesis plugin is specified with the `unitary_synthesis_method` argument. As this is custom for each unitary synthesis plugin refer to the plugin documentation for how to use this option. + * **unitary\_synthesis\_plugin\_config** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – An optional configuration dictionary that will be passed directly to the unitary synthesis plugin. By default this setting will have no effect as the default unitary synthesis method does not take custom configuration. This should only be necessary when a unitary synthesis plugin is specified with the `unitary_synthesis_method` argument. As this is custom for each unitary synthesis plugin refer to the plugin documentation for how to use this option. * **hls\_config** ([*HLSConfig*](qiskit.transpiler.passes.HLSConfig "qiskit.transpiler.passes.HLSConfig")) – An optional configuration class [`HLSConfig`](qiskit.transpiler.passes.HLSConfig "qiskit.transpiler.passes.HLSConfig") that will be passed directly to [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") transformation pass. This configuration class allows to specify for various high-level objects the lists of synthesis algorithms and their parameters. - * **init\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The plugin name to use for the `init` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). By default an external plugin is not used. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"init"` for the stage name argument. + * **init\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The plugin name to use for the `init` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). By default an external plugin is not used. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"init"` for the stage name argument. - * **optimization\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The plugin name to use for the `optimization` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). By default an external plugin is not used. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"optimization"` for the `stage_name` argument. + * **optimization\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The plugin name to use for the `optimization` stage of the output [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). By default an external plugin is not used. You can see a list of installed plugins by using [`list_stage_plugins()`](transpiler_plugins#qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins "qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins") with `"optimization"` for the `stage_name` argument. - * **qubits\_initially\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Indicates whether the input circuit is zero-initialized. + * **qubits\_initially\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Indicates whether the input circuit is zero-initialized. **Returns** @@ -85,6 +85,6 @@ python_api_name: qiskit.transpiler.generate_preset_pass_manager **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if an invalid value for `optimization_level` is passed in. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if an invalid value for `optimization_level` is passed in. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index a95664279e6..f4f93db7aa6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -53,9 +53,9 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -73,7 +73,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 18f459a534a..2b92094b38b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -53,9 +53,9 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -73,7 +73,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.mdx index f37218c47d3..a32f2ef98b2 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.mdx @@ -50,9 +50,9 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -70,7 +70,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 3d95883f355..9132a02c29c 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.mdx index 337b17631d9..f8fdd5529f2 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.mdx @@ -20,7 +20,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap **Parameters** * **coupling\_map** (*Union\[*[*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")*,* [*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – Directed graph represented a coupling map. - * **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if true, it will only pretend to do routing, i.e., no swap is effectively added. + * **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if true, it will only pretend to do routing, i.e., no swap is effectively added. ## Attributes @@ -49,9 +49,9 @@ python_api_name: qiskit.transpiler.passes.BasicSwap **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -69,7 +69,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.mdx index 4c27c7c39ce..2381608330d 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.mdx @@ -95,9 +95,9 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -105,7 +105,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -115,7 +115,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.mdx index 4d0702a07a6..50b5a0919f1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.mdx @@ -25,10 +25,10 @@ python_api_name: qiskit.transpiler.passes.CSPLayout **Parameters** * **coupling\_map** (*Union\[*[*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")*,* [*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – Directed graph representing a coupling map. - * **strict\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, considers the direction of the coupling map. Default is False. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Sets the seed of the PRNG. - * **call\_limit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Amount of times that `constraint.RecursiveBacktrackingSolver.recursiveBacktracking` will be called. None means no call limit. Default: 1000. - * **time\_limit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Amount of seconds that the pass will try to find a solution. None means no time limit. Default: 10 seconds. + * **strict\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, considers the direction of the coupling map. Default is False. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Sets the seed of the PRNG. + * **call\_limit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Amount of times that `constraint.RecursiveBacktrackingSolver.recursiveBacktracking` will be called. None means no call limit. Default: 1000. + * **time\_limit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Amount of seconds that the pass will try to find a solution. None means no time limit. Default: 10 seconds. ## Attributes @@ -57,9 +57,9 @@ python_api_name: qiskit.transpiler.passes.CSPLayout **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -77,7 +77,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.mdx index 6f40392a347..a0143ada50a 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -47,9 +47,9 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.mdx index 74f0eb88aaa..0edfc0c90bb 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.mdx @@ -20,7 +20,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap **Parameters** * **coupling\_map** (*Union\[*[*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")*,* [*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – Directed graph representing a coupling map. - * **property\_set\_field** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – An optional string to specify the property set field to store the result of the check. If not provided the result is stored in the property set field `"is_swap_mapped"`. + * **property\_set\_field** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – An optional string to specify the property set field to store the result of the check. If not provided the result is stored in the property set field `"is_swap_mapped"`. ## Attributes @@ -49,9 +49,9 @@ python_api_name: qiskit.transpiler.passes.CheckMap **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -69,7 +69,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.mdx index 7a1b470826b..79e3d4ac096 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -40,9 +40,9 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.mdx index 8b11544edd3..99c1f16c0db 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -40,9 +40,9 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CollectAndCollapse.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CollectAndCollapse.mdx index 71ac1816b1e..bf0f7c22c4c 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CollectAndCollapse.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CollectAndCollapse.mdx @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse * **collect\_function** (*callable*) – a function that takes a DAG and returns a list of “collected” blocks of nodes * **collapse\_function** (*callable*) – a function that takes a DAG and a list of “collected” blocks, and consolidates each block. - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, exploits commutativity relations between nodes. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, exploits commutativity relations between nodes. ## Attributes @@ -52,9 +52,9 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.mdx index 7541f4958c8..342a1c1ded1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.mdx @@ -17,13 +17,13 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords **Parameters** - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, exploits commutativity relations between nodes. - * **split\_blocks** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets. - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – specifies the minimum number of gates in the block for the block to be collected. - * **split\_layers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets. - * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – specifies if blocks should be collected started from the end of the circuit. - * **matrix\_based** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – specifies whether to collect unitary gates which are Clifford gates only for certain parameters (based on their unitary matrix). - * **max\_block\_width** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – specifies the maximum width of the block (that is, the number of qubits over which the block is defined) for the block to be collected. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, exploits commutativity relations between nodes. + * **split\_blocks** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets. + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – specifies the minimum number of gates in the block for the block to be collected. + * **split\_layers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – specifies if blocks should be collected started from the end of the circuit. + * **matrix\_based** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – specifies whether to collect unitary gates which are Clifford gates only for certain parameters (based on their unitary matrix). + * **max\_block\_width** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – specifies the maximum width of the block (that is, the number of qubits over which the block is defined) for the block to be collected. ## Attributes @@ -52,9 +52,9 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.mdx index 9ab8af342c9..beff0b53ce2 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -17,12 +17,12 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions **Parameters** - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, exploits commutativity relations between nodes. - * **split\_blocks** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets. - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – specifies the minimum number of gates in the block for the block to be collected. - * **split\_layers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets. - * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – specifies if blocks should be collected started from the end of the circuit. - * **max\_block\_width** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – specifies the maximum width of the block (that is, the number of qubits over which the block is defined) for the block to be collected. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, exploits commutativity relations between nodes. + * **split\_blocks** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets. + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – specifies the minimum number of gates in the block for the block to be collected. + * **split\_layers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, splits collected blocks into sub-blocks over disjoint qubit subsets. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – specifies if blocks should be collected started from the end of the circuit. + * **max\_block\_width** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – specifies the maximum width of the block (that is, the number of qubits over which the block is defined) for the block to be collected. ## Attributes @@ -51,9 +51,9 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -71,7 +71,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index e38410773fc..dfef8ab00e3 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -52,9 +52,9 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### find\_set @@ -78,7 +78,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.mdx index dd33e7e7221..d506bc04696 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.mdx index 268cefc23dc..1b10346bc99 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -23,7 +23,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation **Parameters** - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – Basis gates to consider, e.g. `['u3', 'cx']`. For the effects of this pass, the basis is the set intersection between the `basis_gates` parameter and the gates in the dag. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – Basis gates to consider, e.g. `['u3', 'cx']`. For the effects of this pass, the basis is the set intersection between the `basis_gates` parameter and the gates in the dag. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `basis_gates` and `target` are specified then this argument will take precedence and `basis_gates` will be ignored. ## Attributes @@ -53,9 +53,9 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -73,7 +73,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx index d47bc2af947..c7a9e8ddda7 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx @@ -45,9 +45,9 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -55,7 +55,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index 86e153e8e42..2699acbf7db 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -102,9 +102,9 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -112,7 +112,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -122,7 +122,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.mdx index f18ca72a18f..9c62762fc2c 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -8,13 +8,15 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks # ConsolidateBlocks - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Replace each block of consecutive gates by a single Unitary node. Pass to consolidate sequences of uninterrupted gates acting on the same qubits into a Unitary node, to be resynthesized later, to a potentially more optimal subcircuit. + This pass reads the [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") key `ConsolidateBlocks_qubit_map` which it uses to communicate with recursive worker instances of itself for control-flow operations. The key should never be observable in a user-facing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") pipeline (it is only set in internal [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") instances), but the pass may return incorrect results or error if another pass sets this key. + **Notes** This pass assumes that the ‘blocks\_list’ property that it reads is given such that blocks are in topological order. The blocks are collected by a previous pass, such as Collect2qBlocks. @@ -26,9 +28,9 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks **Parameters** * **kak\_basis\_gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Basis gate for KAK decomposition. - * **force\_consolidate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Force block consolidation. - * **basis\_gates** (*List(*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*)*) – Basis gates from which to choose a KAK gate. - * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – a float between $[0.0, 1.0]$. Lower approximates more. + * **force\_consolidate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Force block consolidation. + * **basis\_gates** (*List(*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*)*) – Basis gates from which to choose a KAK gate. + * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – a float between $[0.0, 1.0]$. Lower approximates more. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The target object for the compilation target backend. ## Attributes @@ -58,9 +60,9 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -68,7 +70,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -78,12 +80,12 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run - + Run the ConsolidateBlocks pass on dag. Iterate over each block and replace it with an equivalent Unitary on the same wires. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.mdx index b1ad196c1a6..9c63c379e47 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -78,9 +78,9 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -88,7 +88,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -98,7 +98,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.mdx index b4842425901..1ef469ba505 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -19,8 +19,8 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction **Parameters** - * **instruction\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – The instruction or instructions to check are in the DAG. The output in the property set is set to `contains_` prefixed on each value for this parameter. - * **recurse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if `True` (default), then recurse into control-flow operations. + * **instruction\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| Iterable\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – The instruction or instructions to check are in the DAG. The output in the property set is set to `contains_` prefixed on each value for this parameter. + * **recurse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if `True` (default), then recurse into control-flow operations. ## Attributes @@ -49,9 +49,9 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -69,7 +69,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ContextAwareDynamicalDecoupling.mdx b/docs/api/qiskit/qiskit.transpiler.passes.ContextAwareDynamicalDecoupling.mdx index 5d45cf084b0..3e0d0acb2c0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ContextAwareDynamicalDecoupling.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.ContextAwareDynamicalDecoupling.mdx @@ -103,9 +103,9 @@ python_api_name: qiskit.transpiler.passes.ContextAwareDynamicalDecoupling **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.passes.ContextAwareDynamicalDecoupling **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### get\_orthogonal\_sequence @@ -123,11 +123,11 @@ python_api_name: qiskit.transpiler.passes.ContextAwareDynamicalDecoupling **Parameters** - **order** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **order** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")], [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[qiskit.circuit.gate.Gate](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")]] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")], [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[[qiskit.circuit.gate.Gate](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")]] ### name @@ -137,7 +137,7 @@ python_api_name: qiskit.transpiler.passes.ContextAwareDynamicalDecoupling **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run @@ -151,7 +151,7 @@ python_api_name: qiskit.transpiler.passes.ContextAwareDynamicalDecoupling **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – when this is left unimplemented for a pass. **Return type** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ContractIdleWiresInControlFlow.mdx b/docs/api/qiskit/qiskit.transpiler.passes.ContractIdleWiresInControlFlow.mdx index cd671a35625..3b977e80a05 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ContractIdleWiresInControlFlow.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.ContractIdleWiresInControlFlow.mdx @@ -40,9 +40,9 @@ python_api_name: qiskit.transpiler.passes.ContractIdleWiresInControlFlow **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.ContractIdleWiresInControlFlow **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.ContractIdleWiresInControlFlow **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.passes.ContractIdleWiresInControlFlow **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – when this is left unimplemented for a pass. ### update\_status diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CountOps.mdx index 0fdf6f4c972..42d98a6acaf 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CountOps.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.CountOps **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CountOps **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.CountOps **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 8fb27f0ceba..ff66f0a1bcb 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.mdx index b09bf3b68d5..294e24879a4 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.mdx index 67330ccfef1..31add90d9de 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -40,9 +40,9 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Decompose.mdx index 3925d919532..f297ae4d5b8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Decompose.mdx @@ -45,9 +45,9 @@ python_api_name: qiskit.transpiler.passes.Decompose **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -55,7 +55,7 @@ python_api_name: qiskit.transpiler.passes.Decompose **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.passes.Decompose **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.mdx index e25f03bdbe6..64c5433e82d 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.mdx @@ -53,9 +53,9 @@ python_api_name: qiskit.transpiler.passes.DenseLayout **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -73,7 +73,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Depth.mdx index c983f02c4bf..6a7734205f5 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Depth.mdx @@ -44,9 +44,9 @@ python_api_name: qiskit.transpiler.passes.Depth **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Depth **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.Depth **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ElidePermutations.mdx b/docs/api/qiskit/qiskit.transpiler.passes.ElidePermutations.mdx index a1490db254c..f1d856e0031 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ElidePermutations.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.ElidePermutations.mdx @@ -56,9 +56,9 @@ python_api_name: qiskit.transpiler.passes.ElidePermutations **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.ElidePermutations **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -76,7 +76,7 @@ python_api_name: qiskit.transpiler.passes.ElidePermutations **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index bebf5b28078..4841464e4b2 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Error.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Error.mdx index cff89d47154..45e8c1cfd78 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Error.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Error.mdx @@ -17,8 +17,8 @@ python_api_name: qiskit.transpiler.passes.Error **Parameters** - * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – Error message, if not provided a generic error will be used. This can be either a raw string, or a callback function that accepts the current `property_set` and returns the desired message. - * **action** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the action to perform. Default: ‘raise’. The options are: \* `'raise'`: Raises a `TranspilerError` exception with msg \* `'warn'`: Raises a non-fatal warning with msg \* `'log'`: logs in `logging.getLogger(__name__)` + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – Error message, if not provided a generic error will be used. This can be either a raw string, or a callback function that accepts the current `property_set` and returns the desired message. + * **action** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the action to perform. Default: ‘raise’. The options are: \* `'raise'`: Raises a `TranspilerError` exception with msg \* `'warn'`: Raises a non-fatal warning with msg \* `'log'`: logs in `logging.getLogger(__name__)` **Raises** @@ -51,9 +51,9 @@ python_api_name: qiskit.transpiler.passes.Error **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.Error **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -71,7 +71,7 @@ python_api_name: qiskit.transpiler.passes.Error **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.mdx b/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.mdx index 5521cf36eab..2fde4b5d6d6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.mdx @@ -67,9 +67,9 @@ python_api_name: qiskit.transpiler.passes.FilterOpNodes **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -77,7 +77,7 @@ python_api_name: qiskit.transpiler.passes.FilterOpNodes **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -87,7 +87,7 @@ python_api_name: qiskit.transpiler.passes.FilterOpNodes **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.mdx index 82689723320..d1de0a81775 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint **Parameters** - **property\_to\_check** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The property to check if a fixed point was reached. + **property\_to\_check** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The property to check if a fixed point was reached. ## Attributes @@ -48,9 +48,9 @@ python_api_name: qiskit.transpiler.passes.FixedPoint **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.mdx index a27916b9033..7d2b371a8ab 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -52,9 +52,9 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.mdx index 81d24252aba..c5c7d8ffe51 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.mdx @@ -79,9 +79,9 @@ python_api_name: qiskit.transpiler.passes.GateDirection **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -89,7 +89,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -99,7 +99,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.mdx index e346c926bf1..fa47341bcc1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis **Parameters** - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – The list of strings representing the set of basis gates. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – The list of strings representing the set of basis gates. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The target representing the backend. If specified this will be used instead of the `basis_gates` parameter ## Attributes @@ -47,9 +47,9 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.HLSConfig.mdx b/docs/api/qiskit/qiskit.transpiler.passes.HLSConfig.mdx index 02def935f77..887d5580bed 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.HLSConfig.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.HLSConfig.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.passes.HLSConfig # HLSConfig - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") The high-level-synthesis config allows to specify a list of “methods” used by [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") transformation pass to synthesize different types of higher-level objects. @@ -49,9 +49,9 @@ python_api_name: qiskit.transpiler.passes.HLSConfig **Parameters** - * **use\_default\_on\_unspecified** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if True, every higher-level-object without an explicitly specified list of methods will be synthesized using the “default” algorithm if it exists. - * **plugin\_selection** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – if set to `"sequential"` (default), for every higher-level-object the synthesis pass will consider the specified methods sequentially, stopping at the first method that is able to synthesize the object. If set to `"all"`, all the specified methods will be considered, and the best synthesized circuit, according to `plugin_evaluation_fn` will be chosen. - * **plugin\_evaluation\_fn** (*Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*],* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – a callable that evaluates the quality of the synthesized quantum circuit in the case that `plugin_selection="sequential"`; a smaller value means a better circuit. If `None`, the quality of the circuit is its size (i.e. the number of gates that it contains). + * **use\_default\_on\_unspecified** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if True, every higher-level-object without an explicitly specified list of methods will be synthesized using the “default” algorithm if it exists. + * **plugin\_selection** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – if set to `"sequential"` (default), for every higher-level-object the synthesis pass will consider the specified methods sequentially, stopping at the first method that is able to synthesize the object. If set to `"all"`, all the specified methods will be considered, and the best synthesized circuit, according to `plugin_evaluation_fn` will be chosen. + * **plugin\_evaluation\_fn** (*Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*],* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – a callable that evaluates the quality of the synthesized quantum circuit in the case that `plugin_selection="sequential"`; a smaller value means a better circuit. If `None`, the quality of the circuit is its size (i.e. the number of gates that it contains). * **kwargs** – a dictionary mapping higher-level-objects to lists of synthesis methods. ## Methods diff --git a/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.mdx b/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.mdx index 4466c45c7f3..f463bccb4ce 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.mdx @@ -82,9 +82,9 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -92,7 +92,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -102,7 +102,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.mdx index 0f191ad6990..81a48521c71 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -15,7 +15,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer **Parameters** - **size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – size of gate cache, in number of gates + **size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – size of gate cache, in number of gates **Raises** @@ -48,9 +48,9 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.mdx index 0f281adfd19..7fd077bb68e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -54,9 +54,9 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.mdx index 31c3e0fde45..57da548b728 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.mdx @@ -77,9 +77,9 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -87,7 +87,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -97,7 +97,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.mdx index 1184e4a7b1c..24bb0d70e4a 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -20,7 +20,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance **Parameters** * **coupling\_map** (*Union\[*[*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")*,* [*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – Directed graph represented a coupling map. - * **property\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The property name to save the score. Default: layout\_score + * **property\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The property name to save the score. Default: layout\_score ## Attributes @@ -49,9 +49,9 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -69,7 +69,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.LayoutTransformation.mdx b/docs/api/qiskit/qiskit.transpiler.passes.LayoutTransformation.mdx index 2b3b8ab1fd8..553a9b0dd31 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.LayoutTransformation.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.LayoutTransformation.mdx @@ -20,10 +20,10 @@ python_api_name: qiskit.transpiler.passes.LayoutTransformation **Parameters** * **coupling\_map** – Directed graph representing a coupling map. - * **from\_layout** (*Union\[*[*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – The starting layout of qubits onto physical qubits. If the type is str, look up property\_set when this pass runs. - * **to\_layout** (*Union\[*[*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – The final layout of qubits on physical qubits. If the type is str, look up `property_set` when this pass runs. - * **seed** (*Union\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, np.random.default\_rng]*) – Seed to use for random trials. - * **trials** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – How many randomized trials to perform, taking the best circuit as output. + * **from\_layout** (*Union\[*[*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – The starting layout of qubits onto physical qubits. If the type is str, look up property\_set when this pass runs. + * **to\_layout** (*Union\[*[*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")*,* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – The final layout of qubits on physical qubits. If the type is str, look up `property_set` when this pass runs. + * **seed** (*Union\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*, np.random.default\_rng]*) – Seed to use for random trials. + * **trials** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – How many randomized trials to perform, taking the best circuit as output. ## Attributes @@ -52,9 +52,9 @@ python_api_name: qiskit.transpiler.passes.LayoutTransformation **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.LayoutTransformation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.LayoutTransformation **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index dfd21573145..ddd6733a891 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -40,9 +40,9 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.LitinskiTransformation.mdx b/docs/api/qiskit/qiskit.transpiler.passes.LitinskiTransformation.mdx index 2d632342469..40631160cde 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.LitinskiTransformation.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.LitinskiTransformation.mdx @@ -60,9 +60,9 @@ python_api_name: qiskit.transpiler.passes.LitinskiTransformation **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -70,7 +70,7 @@ python_api_name: qiskit.transpiler.passes.LitinskiTransformation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -80,7 +80,7 @@ python_api_name: qiskit.transpiler.passes.LitinskiTransformation **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.mdx index 8a062d1d6c3..ece3d39dcbc 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -34,9 +34,9 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap **Parameters** * **coupling\_map** (*Union\[*[*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")*,* [*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – CouplingMap of the target backend. - * **search\_depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – lookahead tree depth when ranking best SWAP options. - * **search\_width** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – lookahead tree width when ranking best SWAP options. - * **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if true, it will only pretend to do routing, i.e., no swap is effectively added. + * **search\_depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – lookahead tree depth when ranking best SWAP options. + * **search\_width** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – lookahead tree width when ranking best SWAP options. + * **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if true, it will only pretend to do routing, i.e., no swap is effectively added. ## Attributes @@ -65,9 +65,9 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -75,7 +75,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -85,7 +85,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 05dce1e395d..f2b370e956a 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -77,9 +77,9 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -87,7 +87,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -97,7 +97,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.mdx b/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.mdx index 128207175df..5a6b2fb552a 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.mdx @@ -29,9 +29,9 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint **Parameters** - * **property\_set\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of property set keys that will be used to evaluate the local minimum. The values of these property set keys will be used as a tuple for comparison - * **prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix to use for the property set key that is used for tracking previous evaluations - * **backtrack\_depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The maximum number of entries to store. If this number is reached and the next iteration doesn’t have a decrease in the number of values the minimum of the previous n will be set as the output dag and `minimum_point` will be set to `True` in the property set + * **property\_set\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of property set keys that will be used to evaluate the local minimum. The values of these property set keys will be used as a tuple for comparison + * **prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The prefix to use for the property set key that is used for tracking previous evaluations + * **backtrack\_depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The maximum number of entries to store. If this number is reached and the next iteration doesn’t have a decrease in the number of values the minimum of the previous n will be set as the output dag and `minimum_point` will be set to `True` in the property set ## Attributes @@ -60,9 +60,9 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -70,7 +70,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -80,7 +80,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.mdx index eb92bace7d5..531baa80802 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.mdx index ef51b98dc23..797bea44d4f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -17,8 +17,8 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates **Parameters** - * **basis** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – Basis gates to consider, e.g. \[‘u3’, ‘cx’]. For the effects of this pass, the basis is the set intersection between the basis parameter and the set \{‘u1’,’u2’,’u3’, ‘u’, ‘p’}. - * **eps** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – EPS to check against + * **basis** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – Basis gates to consider, e.g. \[‘u3’, ‘cx’]. For the effects of this pass, the basis is the set intersection between the basis parameter and the set \{‘u1’,’u2’,’u3’, ‘u’, ‘p’}. + * **eps** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – EPS to check against * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `basis` and `target` are specified then this argument will take precedence and `basis` will be ignored. ## Attributes @@ -60,9 +60,9 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -70,7 +70,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -80,7 +80,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 3228ba1af6b..0e9306a509f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -25,7 +25,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition **Parameters** - * **basis** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – Basis gates to consider, e.g. \[‘u3’, ‘cx’]. For the effects of this pass, the basis is the set intersection between the basis parameter and the Euler basis. Ignored if `target` is also specified. + * **basis** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – Basis gates to consider, e.g. \[‘u3’, ‘cx’]. For the effects of this pass, the basis is the set intersection between the basis parameter and the Euler basis. Ignored if `target` is also specified. * **target** (*Optional\[*[*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object corresponding to the compilation target. When specified, any argument specified for `basis_gates` is ignored. ## Attributes @@ -55,9 +55,9 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -75,7 +75,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index 85ffa3642f9..facfb5c75e8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -21,8 +21,8 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation **Parameters** - * **basis** (*List\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – See also Optimize1qGatesDecomposition. - * **run\_to\_completion** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, this pass retries until it is unable to do any more work. If False, it finds and performs one optimization, and for full optimization the user is obligated to re-call the pass until the output stabilizes. + * **basis** (*List\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – See also Optimize1qGatesDecomposition. + * **run\_to\_completion** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, this pass retries until it is unable to do any more work. If False, it finds and performs one optimization, and for full optimization the user is obligated to re-call the pass until the output stabilizes. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `basis` and this are specified then this argument will take precedence and `basis` will be ignored. ## Attributes @@ -52,9 +52,9 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeAnnotated.mdx b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeAnnotated.mdx index acadcd05fd7..f93ffdf283c 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeAnnotated.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeAnnotated.mdx @@ -57,9 +57,9 @@ python_api_name: qiskit.transpiler.passes.OptimizeAnnotated **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeAnnotated **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -77,7 +77,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeAnnotated **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffordT.mdx b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffordT.mdx index 675b9f5ae4d..20fd491cf87 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffordT.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffordT.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffordT **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffordT **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffordT **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.mdx b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.mdx index a457ed958b3..f8f3c71c643 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.mdx @@ -40,9 +40,9 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeSwapBeforeMeasure.mdx b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeSwapBeforeMeasure.mdx index f7d77641b58..3c82ca4631e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeSwapBeforeMeasure.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeSwapBeforeMeasure.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.OptimizeSwapBeforeMeasure **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeSwapBeforeMeasure **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeSwapBeforeMeasure **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.mdx index e7e9206723d..e6935961f75 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.mdx @@ -75,9 +75,9 @@ python_api_name: qiskit.transpiler.passes.PadDelay **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -85,7 +85,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### get\_duration @@ -101,7 +101,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index 538e2bda035..2105de1245c 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -110,7 +110,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling * [**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – When invalid DD sequence is specified. * [**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – When pulse gate with the duration which is non-multiple of the alignment constraint value is found. - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If `dd_sequence` is not specified + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If `dd_sequence` is not specified ## Attributes @@ -139,9 +139,9 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -149,7 +149,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### get\_duration @@ -165,7 +165,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.mdx index a0e2dfb14f6..84b1441c6bb 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -59,9 +59,9 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -69,7 +69,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -79,7 +79,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 693eff5a184..d7a5a5dc082 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index 65644f7e015..b30dc8c170b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -44,9 +44,9 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalReset.mdx b/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalReset.mdx index ea006085775..2a48f416f46 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalReset.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalReset.mdx @@ -40,9 +40,9 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalReset **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalReset **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalReset **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent.mdx b/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent.mdx index 25165fa65de..a230f71a05c 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent.mdx @@ -59,9 +59,9 @@ $$ **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -69,7 +69,7 @@ $$ **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -79,7 +79,7 @@ $$ **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run @@ -93,7 +93,7 @@ $$ **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – when this is left unimplemented for a pass. **Return type** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 8b587ab9685..d6acb3376cb 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -40,9 +40,9 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx b/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx index 1ae15b15024..4b787754bc6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ResourceEstimation.mdx b/docs/api/qiskit/qiskit.transpiler.passes.ResourceEstimation.mdx index 5d2793a295d..2c836224c68 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ResourceEstimation.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.ResourceEstimation.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.ResourceEstimation **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ResourceEstimation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.ResourceEstimation **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.mdx index f3077dc902b..8543f361b4b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.mdx @@ -138,9 +138,9 @@ python_api_name: qiskit.transpiler.passes.SabreLayout **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -148,7 +148,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -158,7 +158,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.mdx b/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.mdx index bec2be7e931..7f83008654b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.mdx @@ -108,9 +108,9 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -118,7 +118,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -128,7 +128,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.mdx index 3dfc78ef2ff..ee570331d21 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.mdx @@ -32,10 +32,10 @@ python_api_name: qiskit.transpiler.passes.SabreSwap **Parameters** * **coupling\_map** (*Union\[*[*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")*,* [*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – CouplingMap of the target backend. - * **heuristic** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The type of heuristic to use when deciding best swap strategy (‘basic’ or ‘lookahead’ or ‘decay’). - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – random seed used to tie-break among candidate swaps. - * **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – if true, it only pretend to do routing, i.e., no swap is effectively added. - * **trials** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of seed trials to run sabre with. These will be run in parallel (unless the PassManager is already running in parallel). If not specified this defaults to the number of physical CPUs on the local system. For reproducible results it is recommended that you set this explicitly, as the output will be deterministic for a fixed number of trials. + * **heuristic** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The type of heuristic to use when deciding best swap strategy (‘basic’ or ‘lookahead’ or ‘decay’). + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – random seed used to tie-break among candidate swaps. + * **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – if true, it only pretend to do routing, i.e., no swap is effectively added. + * **trials** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of seed trials to run sabre with. These will be run in parallel (unless the PassManager is already running in parallel). If not specified this defaults to the number of physical CPUs on the local system. For reproducible results it is recommended that you set this explicitly, as the output will be deterministic for a fixed number of trials. **Raises** @@ -108,9 +108,9 @@ python_api_name: qiskit.transpiler.passes.SabreSwap **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -118,7 +118,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -128,7 +128,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.mdx index d0d50af2296..ec594d5dacd 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.mdx @@ -51,9 +51,9 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -71,7 +71,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.mdx index 17488387e5c..5d136f20f39 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout **Parameters** - **layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout") *or List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + **layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout") *or List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – the layout to set. It can be: @@ -53,9 +53,9 @@ python_api_name: qiskit.transpiler.passes.SetLayout **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -73,7 +73,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Size.mdx index 216b3221d36..8cd2f7e5388 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Size.mdx @@ -46,9 +46,9 @@ python_api_name: qiskit.transpiler.passes.Size **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.Size **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.Size **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.mdx b/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.mdx index ddfa9d14336..c2f1657b62a 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.mdx @@ -131,9 +131,9 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -141,7 +141,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -151,7 +151,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries.mdx index c8e4a75dba1..bd0e6c65d09 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries.mdx @@ -49,9 +49,9 @@ python_api_name: qiskit.transpiler.passes.Split2QUnitaries **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.Split2QUnitaries **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -69,7 +69,7 @@ python_api_name: qiskit.transpiler.passes.Split2QUnitaries **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.StarPreRouting.mdx b/docs/api/qiskit/qiskit.transpiler.passes.StarPreRouting.mdx index 1757670446b..9e177a0b0cf 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.StarPreRouting.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.StarPreRouting.mdx @@ -86,7 +86,7 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting **Parameters** * **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") *|*[*DAGDependency*](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.dagdependency.DAGDependency")) – - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – ### execute @@ -96,9 +96,9 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -106,7 +106,7 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -116,7 +116,7 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run @@ -130,7 +130,7 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – when this is left unimplemented for a pass. ### star\_preroute diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.mdx index 0005b14324b..2276df8eb89 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -15,10 +15,10 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization **Parameters** - * **template\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*()]*) – list of the different template circuit to apply. - * **heuristics\_backward\_param** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – \[length, survivor] Those are the parameters for applying heuristics on the backward part of the algorithm. This part of the algorithm creates a tree of matching scenario. This tree grows exponentially. The heuristics evaluate which scenarios have the longest match and keep only those. The length is the interval in the tree for cutting it and survivor is the number of scenarios that are kept. We advise to use l=3 and s=1 to have serious time advantage. We remind that the heuristics implies losing a part of the maximal matches. Check reference for more details. - * **heuristics\_qubits\_param** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – \[length] The heuristics for the qubit choice make guesses from the dag dependency of the circuit in order to limit the number of qubit configurations to explore. The length is the number of successors or not predecessors that will be explored in the dag dependency of the circuit, each qubits of the nodes are added to the set of authorized qubits. We advise to use length=1. Check reference for more details. - * **user\_cost\_dict** (*Dict\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – quantum cost dictionary passed to TemplateSubstitution to configure its behavior. This will override any default values if None is not given. The key is the name of the gate and the value its quantum cost. + * **template\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*()]*) – list of the different template circuit to apply. + * **heuristics\_backward\_param** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – \[length, survivor] Those are the parameters for applying heuristics on the backward part of the algorithm. This part of the algorithm creates a tree of matching scenario. This tree grows exponentially. The heuristics evaluate which scenarios have the longest match and keep only those. The length is the interval in the tree for cutting it and survivor is the number of scenarios that are kept. We advise to use l=3 and s=1 to have serious time advantage. We remind that the heuristics implies losing a part of the maximal matches. Check reference for more details. + * **heuristics\_qubits\_param** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – \[length] The heuristics for the qubit choice make guesses from the dag dependency of the circuit in order to limit the number of qubit configurations to explore. The length is the number of successors or not predecessors that will be explored in the dag dependency of the circuit, each qubits of the nodes are added to the set of authorized qubits. We advise to use length=1. Check reference for more details. + * **user\_cost\_dict** (*Dict\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – quantum cost dictionary passed to TemplateSubstitution to configure its behavior. This will override any default values if None is not given. The key is the name of the gate and the value its quantum cost. ## Attributes @@ -47,9 +47,9 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.mdx index 9c73b95e0f4..bb42d933b1b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -55,9 +55,9 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -75,7 +75,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.mdx b/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.mdx index 8148084cc3f..be30dbc04b7 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.mdx @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If neither of `supported_gates` and `target` are passed. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If neither of `supported_gates` and `target` are passed. ## Attributes @@ -97,9 +97,9 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -117,7 +117,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.mdx index 41808aef8b5..c9c68c136ea 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.mdx @@ -56,9 +56,9 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -76,7 +76,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.mdx index 1fbb6f2af6f..57dac52bd5f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -19,13 +19,13 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis **Parameters** - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – List of gate names to target. If this is not specified the `target` argument must be used. If both this and the `target` are specified the value of `target` will be used and this will be ignored. - * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation). Approximation can make the synthesized circuit cheaper at the cost of straying from the original unitary. If None, approximation is done based on gate fidelities. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – List of gate names to target. If this is not specified the `target` argument must be used. If both this and the `target` are specified the value of `target` will be used and this will be ignored. + * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation). Approximation can make the synthesized circuit cheaper at the cost of straying from the original unitary. If None, approximation is done based on gate fidelities. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – the coupling map of the target in case synthesis is done on a physical circuit. The directionality of the coupling\_map will be taken into account if `pulse_optimize` is `True`/`None` and `natural_direction` is `True`/`None`. - * **pulse\_optimize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to optimize pulses during synthesis. A value of `None` will attempt it but fall back if it does not succeed. A value of `True` will raise an error if pulse-optimized synthesis does not succeed. - * **natural\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to apply synthesis considering directionality of 2-qubit gates. Only applies when `pulse_optimize` is `True` or `None`. The natural direction is determined by first checking to see whether the coupling map is unidirectional. If there is no coupling map or the coupling map is bidirectional, the gate direction with the shorter duration from the target properties will be used. If set to True, and a natural direction can not be determined, raises [`TranspilerError`](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError"). If set to None, no exception will be raised if a natural direction can not be determined. - * **synth\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – List of gates to synthesize. If None and `pulse_optimize` is False or None, default to `['unitary']`. If `None` and `pulse_optimize == True`, default to `['unitary', 'swap']` - * **method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The unitary synthesis method plugin to use. + * **pulse\_optimize** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to optimize pulses during synthesis. A value of `None` will attempt it but fall back if it does not succeed. A value of `True` will raise an error if pulse-optimized synthesis does not succeed. + * **natural\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to apply synthesis considering directionality of 2-qubit gates. Only applies when `pulse_optimize` is `True` or `None`. The natural direction is determined by first checking to see whether the coupling map is unidirectional. If there is no coupling map or the coupling map is bidirectional, the gate direction with the shorter duration from the target properties will be used. If set to True, and a natural direction can not be determined, raises [`TranspilerError`](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError"). If set to None, no exception will be raised if a natural direction can not be determined. + * **synth\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – List of gates to synthesize. If None and `pulse_optimize` is False or None, default to `['unitary']`. If `None` and `pulse_optimize == True`, default to `['unitary', 'swap']` + * **method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The unitary synthesis method plugin to use. * **min\_qubits** – The minimum number of qubits in the unitary to synthesize. If this is set and the unitary is less than the specified number of qubits it will not be synthesized. * **plugin\_config** – Optional extra configuration arguments (as a `dict`) which are passed directly to the specified unitary synthesis plugin. By default, this will have no effect as the default plugin has no extra arguments. Refer to the documentation of your unitary synthesis plugin on how to use this. * **target** – The optional [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") for the target device the pass is compiling for. If specified this will supersede the values set for `basis_gates` and `coupling_map`. @@ -61,9 +61,9 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -71,7 +71,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -81,7 +81,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.mdx index b938bc7a7d4..83cecfd88ed 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -18,7 +18,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore **Parameters** * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The target object representing the compilation target. If specified any multi-qubit instructions in the circuit when the pass is run that are supported by the target device will be left in place. If both this and `basis_gates` are specified only the target will be checked. - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of basis gate names that the target device supports. If specified any gate names in the circuit which are present in this list will not be unrolled. If both this and `target` are specified only the target will be used for checking which gates are supported. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of basis gate names that the target device supports. If specified any gate names in the circuit which are present in this list will not be unrolled. If both this and `target` are specified only the target will be used for checking which gates are supported. ## Attributes @@ -47,9 +47,9 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index cf1e7c364f5..50e575aa6b0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions * **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – The equivalence library which will be used by the BasisTranslator pass. (Instructions in this library will not be unrolled by this pass.) - * **basis\_gates** (*Optional\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]]*) – Target basis names to unroll to, e.g. `['u3', 'cx']`. Ignored if `target` is also specified. + * **basis\_gates** (*Optional\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]]*) – Target basis names to unroll to, e.g. `['u3', 'cx']`. Ignored if `target` is also specified. * **target** (*Optional\[*[*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – @@ -58,9 +58,9 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -78,7 +78,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.mdx b/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.mdx index db77067700e..22d26ed06c1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.mdx @@ -21,7 +21,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops **Parameters** - **max\_target\_depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Optional. Checks if the unrolled block is over a particular subcircuit depth. To disable the check, use `-1` (Default). + **max\_target\_depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Optional. Checks if the unrolled block is over a particular subcircuit depth. To disable the check, use `-1` (Default). ## Attributes @@ -50,9 +50,9 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -70,7 +70,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.mdx index f5991a6062c..e87dfec94a1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.mdx @@ -37,16 +37,16 @@ python_api_name: qiskit.transpiler.passes.VF2Layout **Parameters** * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph representing a coupling map. - * **strict\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, considers the direction of the coupling map. Default is False. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Sets the seed of the PRNG. -1 Means no node shuffling. - * **call\_limit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of state visits to attempt in each execution of VF2. - * **time\_limit** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The total time limit in seconds to run `VF2Layout` - * **max\_trials** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The maximum number of trials to run VF2 to find a layout. If this is not specified the number of trials will be limited based on the number of edges in the interaction graph or the coupling graph (whichever is larger) if no other limits are set. If set to a value \<= 0 no limit on the number of trials will be set. + * **strict\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, considers the direction of the coupling map. Default is False. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Sets the seed of the PRNG. -1 Means no node shuffling. + * **call\_limit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of state visits to attempt in each execution of VF2. + * **time\_limit** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The total time limit in seconds to run `VF2Layout` + * **max\_trials** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The maximum number of trials to run VF2 to find a layout. If this is not specified the number of trials will be limited based on the number of edges in the interaction graph or the coupling graph (whichever is larger) if no other limits are set. If set to a value \<= 0 no limit on the number of trials will be set. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the backend device to run `VF2Layout` on. If specified it will supersede a set value for `coupling_map` if the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") contains connectivity constraints. If the value of `target` models an ideal backend without any constraints then the value of `coupling_map` will be used. **Raises** - [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – At runtime, if neither `coupling_map` or `target` are provided. + [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – At runtime, if neither `coupling_map` or `target` are provided. ## Attributes @@ -75,9 +75,9 @@ python_api_name: qiskit.transpiler.passes.VF2Layout **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -85,7 +85,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -95,7 +95,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.mdx index 2b52bdfba37..745403dc1e3 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -40,15 +40,15 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout **Parameters** * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the backend device to run `VF2PostLayout` on. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Sets the seed of the PRNG. -1 Means no node shuffling. - * **call\_limit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of state visits to attempt in each execution of VF2. - * **time\_limit** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The total time limit in seconds to run `VF2PostLayout` - * **strict\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether the pass is configured to follow the strict direction in the coupling graph. If this is set to false, the pass will treat any edge in the coupling graph as a weak edge and the interaction graph will be undirected. For the purposes of evaluating layouts the avg error rate for each qubit and 2q link will be used. This enables the pass to be run prior to basis translation and work with any 1q and 2q operations. However, if `strict_direction=True` the pass expects the input [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object to [`run()`](#qiskit.transpiler.passes.VF2PostLayout.run "qiskit.transpiler.passes.VF2PostLayout.run") to be in the target set of instructions. - * **max\_trials** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The maximum number of trials to run VF2 to find a layout. A value of `0` (the default) means ‘unlimited’. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Sets the seed of the PRNG. -1 Means no node shuffling. + * **call\_limit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of state visits to attempt in each execution of VF2. + * **time\_limit** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The total time limit in seconds to run `VF2PostLayout` + * **strict\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether the pass is configured to follow the strict direction in the coupling graph. If this is set to false, the pass will treat any edge in the coupling graph as a weak edge and the interaction graph will be undirected. For the purposes of evaluating layouts the avg error rate for each qubit and 2q link will be used. This enables the pass to be run prior to basis translation and work with any 1q and 2q operations. However, if `strict_direction=True` the pass expects the input [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object to [`run()`](#qiskit.transpiler.passes.VF2PostLayout.run "qiskit.transpiler.passes.VF2PostLayout.run") to be in the target set of instructions. + * **max\_trials** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The maximum number of trials to run VF2 to find a layout. A value of `0` (the default) means ‘unlimited’. **Raises** - [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – At runtime, if `target` isn’t provided. + [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – At runtime, if `target` isn’t provided. ## Attributes @@ -77,9 +77,9 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -87,7 +87,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -97,7 +97,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Width.mdx index 60b2023baf4..8a3f5758aa1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Width.mdx @@ -42,9 +42,9 @@ python_api_name: qiskit.transpiler.passes.Width **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.Width **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.Width **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run diff --git a/docs/api/qiskit/qiskit.transpiler.passes.WrapAngles.mdx b/docs/api/qiskit/qiskit.transpiler.passes.WrapAngles.mdx index eebe124fdce..ef7ad7f1399 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.WrapAngles.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.WrapAngles.mdx @@ -20,8 +20,7 @@ python_api_name: qiskit.transpiler.passes.WrapAngles from qiskit.circuit.library import RZGate from qiskit.dagcircuit import DAGCircuit from qiskit.transpiler.passes import WrapAngles - from qiskit.transpiler.target import Target - from qiskit.transpiler import WrapAngleRegistry + from qiskit.transpiler import Target, WrapAngleRegistry param = Parameter("a") circuit = QuantumCircuit(1) @@ -52,8 +51,13 @@ python_api_name: qiskit.transpiler.passes.WrapAngles **Parameters** - * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") that - * **registry** ([*WrapAngleRegistry*](qiskit.transpiler.WrapAngleRegistry "qiskit.transpiler.WrapAngleRegistry")) – The registry of wrapping functions used by the pass to wrap the angles of a gate. If not specified the global `WRAP_ANGLE_REGISTRY` object defined in this module will be used. Unless you are planning to run this pass standalone or are building a custom [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") including this pass you will want to rely on `WRAP_ANGLE_REGISTRY`. + * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target QPU. + + * **registry** ([*WrapAngleRegistry*](qiskit.transpiler.WrapAngleRegistry "qiskit.transpiler.WrapAngleRegistry")) – + + The registry of wrapping functions used by the pass to wrap the angles of a gate. If not specified the global [`WRAP_ANGLE_REGISTRY`](transpiler_passes#qiskit.transpiler.passes.qiskit.transpiler.passes.utils.wrap_angles.WRAP_ANGLE_REGISTRY "qiskit.transpiler.passes.qiskit.transpiler.passes.utils.wrap_angles.WRAP_ANGLE_REGISTRY") object will be used. + + Unless you are planning to run this pass standalone or are building a custom [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") including this pass you will want to rely on [`WRAP_ANGLE_REGISTRY`](transpiler_passes#qiskit.transpiler.passes.qiskit.transpiler.passes.utils.wrap_angles.WRAP_ANGLE_REGISTRY "qiskit.transpiler.passes.qiskit.transpiler.passes.utils.wrap_angles.WRAP_ANGLE_REGISTRY"). ## Attributes @@ -82,9 +86,9 @@ python_api_name: qiskit.transpiler.passes.WrapAngles **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)") *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)") *| None*) – A callback function which is caller per execution of optimization task. **Returns** @@ -92,7 +96,7 @@ python_api_name: qiskit.transpiler.passes.WrapAngles **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)"), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -102,7 +106,7 @@ python_api_name: qiskit.transpiler.passes.WrapAngles **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") ### run @@ -116,7 +120,7 @@ python_api_name: qiskit.transpiler.passes.WrapAngles **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.14)") – when this is left unimplemented for a pass. ### update\_status diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisC04.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisC04.mdx index 5d956052cc4..30259afd507 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisC04.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisC04.mdx @@ -29,7 +29,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthes * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisDefault.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisDefault.mdx index 1222591d192..9da1cf7ec61 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisDefault.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisDefault.mdx @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthes * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisV95.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisV95.mdx index 38ddea9ffec..cc28a120d8b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisV95.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisV95.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthes * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisC04.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisC04.mdx index 0b0ed9255e8..dcfa40358c0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisC04.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisC04.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthes * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisD00.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisD00.mdx index 302cd1972c8..d90aec71315 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisD00.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisD00.mdx @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthes * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisDefault.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisDefault.mdx index 61785a19d84..135cc8894f6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisDefault.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisDefault.mdx @@ -35,7 +35,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthes * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisR25.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisR25.mdx index 21455610220..ba8b24892b0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisR25.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisR25.mdx @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthes * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisV95.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisV95.mdx index c38ac0d40bd..bd0086724ad 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisV95.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisV95.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthes * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesis2s.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesis2s.mdx index df914688e36..c5e4e9782d4 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesis2s.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesis2s.mdx @@ -25,7 +25,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSyn * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisDefault.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisDefault.mdx index 7a6fee983b5..2cb969ce588 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisDefault.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisDefault.mdx @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSyn * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisNoAux.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisNoAux.mdx index 6fe41091186..7a9ae5bfa62 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisNoAux.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisNoAux.mdx @@ -25,7 +25,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSyn * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisDefault.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisDefault.mdx index f426f0e3edf..c560b5d1657 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisDefault.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisDefault.mdx @@ -25,7 +25,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisDef * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisNoAux.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisNoAux.mdx index b050c18ba51..2d0f76c5789 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisNoAux.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisNoAux.mdx @@ -25,7 +25,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisNoA * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisVChain.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisVChain.mdx index ce9985b9850..b3618b1f330 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisVChain.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisVChain.mdx @@ -25,7 +25,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisVCh * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisXGate.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisXGate.mdx index eb199a70bda..0611864d116 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisXGate.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisXGate.mdx @@ -25,7 +25,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisXGa * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisC04.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisC04.mdx index eb64cbc8494..c629b9c6497 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisC04.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisC04.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynt * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisD00.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisD00.mdx index 7d1bb96f17c..89996469d55 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisD00.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisD00.mdx @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynt * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisDefault.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisDefault.mdx index ed59b7b6e7d..2fe8974e5e8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisDefault.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisDefault.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynt * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisV17.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisV17.mdx index 5423d7c73ce..d49a75135af 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisV17.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisV17.mdx @@ -29,7 +29,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynt * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisV95.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisV95.mdx index 1ca29f6a692..6945c2f86d6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisV95.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisV95.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynt * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisDefault.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisDefault.mdx index 71b02a41175..75ee53c4ed8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisDefault.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisDefault.mdx @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthe * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisH18.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisH18.mdx index 780b85624c8..0ad32cc75dd 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisH18.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisH18.mdx @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthe * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisR17.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisR17.mdx index ea3791c21f3..29facaf77a3 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisR17.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthesisR17.mdx @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.MultiplierSynthe * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisDefault.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisDefault.mdx index 8f5f869fe5b..98a6096837a 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisDefault.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisDefault.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSy * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisRustiq.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisRustiq.mdx index cb8847bcaa4..0fc1454def0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisRustiq.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisRustiq.mdx @@ -55,7 +55,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSy * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.WeightedSumSynthesisDefault.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.WeightedSumSynthesisDefault.mdx index af98ce51e7d..99c972766ad 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.WeightedSumSynthesisDefault.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.WeightedSumSynthesisDefault.mdx @@ -31,7 +31,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.hls_plugins.WeightedSumSynth * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx index a0ecedc8e63..6dbc5f6093d 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPlugin - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Abstract high-level synthesis plugin class. @@ -27,7 +27,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu * **high\_level\_object** ([*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation")) – The Operation to synthesize to a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend in case synthesis is done on a physical circuit. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend. - * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – List of qubits over which the operation is defined in case synthesis is done on a physical circuit. * **options** – Additional method-specific optional kwargs. **Returns** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx index fe63c5693ac..86ef88aba02 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu # HighLevelSynthesisPluginManager - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Class tracking the installed high-level-synthesis plugins. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 1e8cbcee4d6..07bd4f75876 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPlugin - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") Abstract unitary synthesis plugin class diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx index 5d46437b90f..cea77954e4f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.mdx @@ -9,7 +9,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi # UnitarySynthesisPluginManager - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Unitary Synthesis plugin manager class diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.mdx index 6518da91f49..082b117931f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_plugin_names.mdx @@ -15,7 +15,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_ **Parameters** - **op\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The operation name to find the installed plugins for. For example, if you provide `"clifford"` as the input it will find all the installed clifford synthesis plugins that can synthesize [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") objects. The name refers to the [`Operation.name`](qiskit.circuit.Operation#name "qiskit.circuit.Operation.name") attribute of the relevant objects. + **op\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The operation name to find the installed plugins for. For example, if you provide `"clifford"` as the input it will find all the installed clifford synthesis plugins that can synthesize [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") objects. The name refers to the [`Operation.name`](qiskit.circuit.Operation#name "qiskit.circuit.Operation.name") attribute of the relevant objects. **Returns** @@ -23,6 +23,6 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.high_level_synthesis_ **Return type** - [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")] + [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")] diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.mdx b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.mdx index df37e59c5d8..72f385bb375 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.mdx @@ -19,6 +19,6 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") diff --git a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx index 06e04f242e0..986ce50b603 100644 --- a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx +++ b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx @@ -8,8 +8,8 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePlugin - - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") A `PassManagerStagePlugin` is a plugin interface object for using custom stages in [`transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). @@ -19,13 +19,13 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### pass\_manager - + This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements **Parameters** * **pass\_manager\_config** ([*PassManagerConfig*](qiskit.transpiler.PassManagerConfig "qiskit.transpiler.passmanager_config.PassManagerConfig")) – A configuration object that defines all the target device specifications and any user specified options to [`transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") or [`generate_preset_pass_manager()`](qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") - * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The optimization level of the transpilation, if set this should be used to set values for any tunable parameters to trade off runtime for potential optimization. Valid values should be `0`, `1`, `2`, or `3` and the higher the number the more optimization is expected. + * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The optimization level of the transpilation, if set this should be used to set values for any tunable parameters to trade off runtime for potential optimization. Valid values should be `0`, `1`, `2`, or `3` and the higher the number the more optimization is expected. **Return type** diff --git a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 4e4d34c1334..0fe1324f4a3 100644 --- a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -8,8 +8,8 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl # PassManagerStagePluginManager - - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.14)") Manager class for preset pass manager stage plugins. @@ -17,13 +17,13 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### get\_passmanager\_stage - + Get a stage **Parameters** - * **stage\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – - * **plugin\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **stage\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – + * **plugin\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – * **pm\_config** ([*PassManagerConfig*](qiskit.transpiler.PassManagerConfig "qiskit.transpiler.passmanager_config.PassManagerConfig")) – **Return type** diff --git a/docs/api/qiskit/qiskit.visualization.array_to_latex.mdx b/docs/api/qiskit/qiskit.visualization.array_to_latex.mdx index 3d920426e40..b71733ed659 100644 --- a/docs/api/qiskit/qiskit.visualization.array_to_latex.mdx +++ b/docs/api/qiskit/qiskit.visualization.array_to_latex.mdx @@ -17,13 +17,13 @@ python_api_name: qiskit.visualization.array_to_latex * **array** (*ndarray*) – The array to be converted to latex, must have dimension 1 or 2 and contain only numerical data. - * **precision** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – For numbers not close to integers or common terms, the number of decimal places to round to. + * **precision** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – For numbers not close to integers or common terms, the number of decimal places to round to. - * **prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Latex string to be prepended to the latex, intended for labels. + * **prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Latex string to be prepended to the latex, intended for labels. - * **source** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `False`, will return IPython.display.Latex object. If display is `True`, will instead return the LaTeX source string. + * **source** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `False`, will return IPython.display.Latex object. If display is `True`, will instead return the LaTeX source string. - * **max\_size** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*(*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*) or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **max\_size** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*(*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*) or* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The maximum size of the output Latex array. @@ -38,12 +38,12 @@ python_api_name: qiskit.visualization.array_to_latex **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") or IPython.display.Latex + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") or IPython.display.Latex **Raises** - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – If array can not be interpreted as a numerical numpy array. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the dimension of array is not 1 or 2. + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – If array can not be interpreted as a numerical numpy array. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the dimension of array is not 1 or 2. * [**MissingOptionalLibraryError**](exceptions#qiskit.exceptions.MissingOptionalLibraryError "qiskit.exceptions.MissingOptionalLibraryError") – If `source` is `False` and `IPython.display.Latex` cannot be imported. Or if sympy is not installed. diff --git a/docs/api/qiskit/qiskit.visualization.circuit_drawer.mdx b/docs/api/qiskit/qiskit.visualization.circuit_drawer.mdx index b03e8c0609e..72c94c7796a 100644 --- a/docs/api/qiskit/qiskit.visualization.circuit_drawer.mdx +++ b/docs/api/qiskit/qiskit.visualization.circuit_drawer.mdx @@ -29,11 +29,11 @@ python_api_name: qiskit.visualization.circuit_drawer * **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The circuit to visualize. - * **scale** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – Scale of image to draw (shrink if `< 1.0`). Only used by the `mpl`, `latex` and `latex_source` outputs. Defaults to `1.0`. + * **scale** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *| None*) – Scale of image to draw (shrink if `< 1.0`). Only used by the `mpl`, `latex` and `latex_source` outputs. Defaults to `1.0`. - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – File path to save image to. Defaults to `None` (result not saved in a file). + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – File path to save image to. Defaults to `None` (result not saved in a file). - * **style** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **style** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Style name, file name of style JSON file, or a dictionary specifying the style. @@ -53,39 +53,39 @@ python_api_name: qiskit.visualization.circuit_drawer specified in `~/.qiskit/settings.conf`. - * **output** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Select the output method to use for drawing the circuit. Valid choices are `text`, `mpl`, `latex`, `latex_source`. By default, the `text` drawer is used unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative backend set as the default. For example, `circuit_drawer = latex`. If the output kwarg is set, that backend will always be used over the default in the user config file. + * **output** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Select the output method to use for drawing the circuit. Valid choices are `text`, `mpl`, `latex`, `latex_source`. By default, the `text` drawer is used unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative backend set as the default. For example, `circuit_drawer = latex`. If the output kwarg is set, that backend will always be used over the default in the user config file. - * **interactive** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – When set to `True`, show the circuit in a new window (for `mpl` this depends on the matplotlib backend being used supporting this). Note when used with either the text or the `latex_source` output type this has no effect and will be silently ignored. Defaults to `False`. + * **interactive** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – When set to `True`, show the circuit in a new window (for `mpl` this depends on the matplotlib backend being used supporting this). Note when used with either the text or the `latex_source` output type this has no effect and will be silently ignored. Defaults to `False`. - * **reverse\_bits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – When set to `True`, reverse the bit order inside registers for the output visualization. Defaults to `False` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_reverse_bits = True`. + * **reverse\_bits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – When set to `True`, reverse the bit order inside registers for the output visualization. Defaults to `False` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_reverse_bits = True`. - * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Enable/disable drawing barriers in the output circuit. Defaults to `True`. + * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Enable/disable drawing barriers in the output circuit. Defaults to `True`. - * **justify** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Options are `"left"`, `"right"` or `"none"` (str). If anything else is supplied, left justified will be used instead. It refers to where gates should be placed in the output circuit if there is an option. `none` results in each gate being placed in its own column. Defaults to `left`. + * **justify** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Options are `"left"`, `"right"` or `"none"` (str). If anything else is supplied, left justified will be used instead. It refers to where gates should be placed in the output circuit if there is an option. `none` results in each gate being placed in its own column. Defaults to `left`. - * **vertical\_compression** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – `high`, `medium` or `low`. It merges the lines generated by the text output so the drawing will take less vertical room. Default is `medium`. Only used by the `text` output, will be silently ignored otherwise. + * **vertical\_compression** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – `high`, `medium` or `low`. It merges the lines generated by the text output so the drawing will take less vertical room. Default is `medium`. Only used by the `text` output, will be silently ignored otherwise. - * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Include (or not) idle wires (wires with no circuit elements) in output visualization. The string `"auto"` is also possible, in which case idle wires are show except that the circuit has a layout attached. Default is `"auto"` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_idle_wires = False`. + * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Include (or not) idle wires (wires with no circuit elements) in output visualization. The string `"auto"` is also possible, in which case idle wires are show except that the circuit has a layout attached. Default is `"auto"` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_idle_wires = False`. - * **with\_layout** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Include layout information, with labels on the physical layout. Default is `True`. + * **with\_layout** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Include layout information, with labels on the physical layout. Default is `True`. - * **fold** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – Sets pagination. It can be disabled using -1. In `text`, sets the length of the lines. This is useful when the drawing does not fit in the console. If None (default), it will try to guess the console width using `shutil.get_terminal_size()`. However, if running in jupyter, the default line length is set to 80 characters. In `mpl`, it is the number of (visual) layers before folding. Default is 25. + * **fold** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – Sets pagination. It can be disabled using -1. In `text`, sets the length of the lines. This is useful when the drawing does not fit in the console. If None (default), it will try to guess the console width using `shutil.get_terminal_size()`. However, if running in jupyter, the default line length is set to 80 characters. In `mpl`, it is the number of (visual) layers before folding. Default is 25. * **ax** (*Any | None*) – Only used by the mpl backend. An optional `matplotlib.axes.Axes` object to be used for the visualization output. If none is specified, a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. - * **initial\_state** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Adds $|0\rangle$ in the beginning of the qubit wires and $0$ to classical wires. Default is `False`. + * **initial\_state** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Adds $|0\rangle$ in the beginning of the qubit wires and $0$ to classical wires. Default is `False`. - * **cregbundle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – If set to `True`, bundle classical registers. Default is `True`, except for when `output` is set to `"text"`. + * **cregbundle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – If set to `True`, bundle classical registers. Default is `True`, except for when `output` is set to `"text"`. - * **wire\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – A list of integers used to reorder the display of the bits. The list must have an entry for every bit with the bits in the range 0 to (`num_qubits` + `num_clbits`). + * **wire\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – A list of integers used to reorder the display of the bits. The list must have an entry for every bit with the bits in the range 0 to (`num_qubits` + `num_clbits`). - * **expr\_len** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of characters to display if an [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") is used for the condition in a [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp"). If this number is exceeded, the string will be truncated at that number and ‘…’ added to the end. + * **expr\_len** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of characters to display if an [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") is used for the condition in a [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp"). If this number is exceeded, the string will be truncated at that number and ‘…’ added to the end. - * **measure\_arrows** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – If True, draw an arrow from each measure box down the the classical bit or register where the measure value is placed. If False, do not draw arrow, but instead place the name of the bit or register in the measure box. Default is `True` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_measure_arrows = False`. + * **measure\_arrows** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – If True, draw an arrow from each measure box down the the classical bit or register where the measure value is placed. If False, do not draw arrow, but instead place the name of the bit or register in the measure box. Default is `True` unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative value set. For example, `circuit_measure_arrows = False`. **Returns** - `TextDrawing` or `matplotlib.figure` or `PIL.Image` or [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"): + `TextDrawing` or `matplotlib.figure` or `PIL.Image` or [`str`](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"): * **`TextDrawing` (if `output='text'`)** @@ -106,7 +106,7 @@ python_api_name: qiskit.visualization.circuit_drawer **Raises** * [**VisualizationError**](visualization#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – when an invalid output method is selected - * [**ImportError**](https://docs.python.org/3/library/exceptions.html#ImportError "(in Python v3.13)") – when the output methods requires non-installed libraries. + * [**ImportError**](https://docs.python.org/3/library/exceptions.html#ImportError "(in Python v3.14)") – when the output methods requires non-installed libraries. **Example** diff --git a/docs/api/qiskit/qiskit.visualization.dag_drawer.mdx b/docs/api/qiskit/qiskit.visualization.dag_drawer.mdx index 0b1efd8e64c..33c09767c00 100644 --- a/docs/api/qiskit/qiskit.visualization.dag_drawer.mdx +++ b/docs/api/qiskit/qiskit.visualization.dag_drawer.mdx @@ -19,11 +19,11 @@ python_api_name: qiskit.visualization.dag_drawer * **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") *or*[*DAGDependency*](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency")) – The dag to draw. - * **scale** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – scaling factor + * **scale** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – scaling factor - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to (format inferred from name) + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – file path to save image to (format inferred from name) - * **style** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **style** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Style name, file name of style JSON file, or a dictionary specifying the style. @@ -53,7 +53,7 @@ python_api_name: qiskit.visualization.dag_drawer * [**VisualizationError**](visualization#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – when style is not recognized. * [**InvalidFileError**](exceptions#qiskit.exceptions.InvalidFileError "qiskit.exceptions.InvalidFileError") – when filename provided is not valid - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the file extension for `filename` is not an image type supported by Graphviz. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the file extension for `filename` is not an image type supported by Graphviz. **Example** diff --git a/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.mdx b/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.mdx index 80f886fe24c..4400ddf9761 100644 --- a/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.mdx +++ b/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.mdx @@ -18,8 +18,8 @@ python_api_name: qiskit.visualization.pass_manager_drawer **Parameters** * **pass\_manager** ([*PassManager*](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager")) – the pass manager to be drawn - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to - * **style** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *or OrderedDict*) – keys are the pass classes and the values are the colors to make them. An example can be seen in the DEFAULT\_STYLE. An ordered dict can be used to ensure a priority coloring when pass falls into multiple categories. Any values not included in the provided dict will be filled in from the default dict + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – file path to save image to + * **style** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *or OrderedDict*) – keys are the pass classes and the values are the colors to make them. An example can be seen in the DEFAULT\_STYLE. An ordered dict can be used to ensure a priority coloring when pass falls into multiple categories. Any values not included in the provided dict will be filled in from the default dict * **raw** ([*Bool*](circuit_classical#qiskit.circuit.classical.types.Bool "qiskit.circuit.classical.types.Bool")) – True if you want to save the raw Dot output not an image. The default is False. **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx b/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx index 1ca93e95dbd..aaa5ad6e5da 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx @@ -18,12 +18,12 @@ python_api_name: qiskit.visualization.plot_bloch_multivector **Parameters** * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. - * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that represents the plot title - * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – size of each individual Bloch sphere figure, in inches. - * **reverse\_bits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, plots qubits following Qiskit’s convention \[Default:False]. - * **font\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Font size for the Bloch ball figures. - * **title\_font\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Font size for the title. - * **title\_pad** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Padding for the title (suptitle `y` position is `0.98` + * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – a string that represents the plot title + * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – size of each individual Bloch sphere figure, in inches. + * **reverse\_bits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True, plots qubits following Qiskit’s convention \[Default:False]. + * **font\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Font size for the Bloch ball figures. + * **title\_font\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Font size for the title. + * **title\_pad** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Padding for the title (suptitle `y` position is `0.98` * **title\_pad/100**\*\*)\*\*\*\*.\*\* (*and the image height will be extended by 1 +*) – **Returns** @@ -32,7 +32,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.6)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.7)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx b/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx index aff7117ab02..acae87e143d 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx @@ -17,12 +17,12 @@ python_api_name: qiskit.visualization.plot_bloch_vector **Parameters** - * **bloch** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[double]*) – array of three elements where \[\, \, \] (Cartesian) or \[\, \, \] (spherical in radians) \ is inclination angle from +z direction \ is azimuth from +x direction - * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that represents the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.6)")) – An Axes to use for rendering the bloch sphere - * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. Has no effect is passing `ax`. - * **coord\_type** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that specifies coordinate type for bloch (Cartesian or spherical), default is Cartesian - * **font\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Font size. + * **bloch** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[double]*) – array of three elements where \[\, \, \] (Cartesian) or \[\, \, \] (spherical in radians) \ is inclination angle from +z direction \ is azimuth from +x direction + * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – a string that represents the plot title + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.7)")) – An Axes to use for rendering the bloch sphere + * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – Figure size in inches. Has no effect is passing `ax`. + * **coord\_type** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – a string that specifies coordinate type for bloch (Cartesian or spherical), default is Cartesian + * **font\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Font size. **Returns** @@ -30,7 +30,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.6)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.7)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.mdx b/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.mdx index c9c8406c7ea..0db3dc2861d 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout * **backend** ([*Backend*](qiskit.providers.Backend "qiskit.providers.Backend")) – Target backend. - * **view** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **view** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – How to label qubits in the layout. Options: diff --git a/docs/api/qiskit/qiskit.visualization.plot_coupling_map.mdx b/docs/api/qiskit/qiskit.visualization.plot_coupling_map.mdx index b97b96c4e62..954564705d5 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_coupling_map.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_coupling_map.mdx @@ -15,22 +15,22 @@ python_api_name: qiskit.visualization.plot_coupling_map **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits defined and plotted. - * **qubit\_coordinates** (*List\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – A list of two-element lists, with entries of each nested list being the planar coordinates in a 0-based square grid where each qubit is located. - * **coupling\_map** (*List\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – A list of two-element lists, with entries of each nested list being the qubit numbers of the bonds to be plotted. - * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Output figure size (wxh) in inches. - * **plot\_directed** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Plot directed coupling map. - * **label\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Label the qubits. - * **qubit\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Size of qubit marker. - * **line\_width** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Width of lines. - * **font\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Font size of qubit labels. - * **qubit\_color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of colors for the qubits - * **qubit\_labels** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of qubit labels - * **line\_color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of colors for each line from coupling\_map. - * **font\_color** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The font color for the qubit labels. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits defined and plotted. + * **qubit\_coordinates** (*List\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – A list of two-element lists, with entries of each nested list being the planar coordinates in a 0-based square grid where each qubit is located. + * **coupling\_map** (*List\[List\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – A list of two-element lists, with entries of each nested list being the qubit numbers of the bonds to be plotted. + * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – Output figure size (wxh) in inches. + * **plot\_directed** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Plot directed coupling map. + * **label\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Label the qubits. + * **qubit\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Size of qubit marker. + * **line\_width** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Width of lines. + * **font\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Font size of qubit labels. + * **qubit\_color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of colors for the qubits + * **qubit\_labels** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of qubit labels + * **line\_color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of colors for each line from coupling\_map. + * **font\_color** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The font color for the qubit labels. * **ax** (*Axes*) – A Matplotlib axes instance. - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. - * **planar** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If the coupling map is planar or not. Default: `True` (i.e. it is planar) + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – file path to save image to. + * **planar** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If the coupling map is planar or not. Default: `True` (i.e. it is planar) **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx b/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx index a099f5b8241..47033e99500 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx @@ -15,17 +15,17 @@ python_api_name: qiskit.visualization.plot_distribution **Parameters** - * **data** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – This is either a list of dictionaries or a single dict containing the values to represent (ex \{‘001’: 130}) - * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. - * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – String or list of strings for distribution bar colors. - * **number\_to\_keep** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of terms to plot per dataset. The rest is made into a single bar called ‘rest’. If multiple datasets are given, the `number_to_keep` applies to each dataset individually, which may result in more bars than `number_to_keep + 1`. The `number_to_keep` applies to the total values, rather than the x-axis sort. + * **data** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – This is either a list of dictionaries or a single dict containing the values to represent (ex \{‘001’: 130}) + * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – Figure size in inches. + * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – String or list of strings for distribution bar colors. + * **number\_to\_keep** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of terms to plot per dataset. The rest is made into a single bar called ‘rest’. If multiple datasets are given, the `number_to_keep` applies to each dataset individually, which may result in more bars than `number_to_keep + 1`. The `number_to_keep` applies to the total values, rather than the x-axis sort. * **sort** (*string*) – Could be ‘asc’, ‘desc’, ‘hamming’, ‘value’, or ‘value\_desc’. If set to ‘value’ or ‘value\_desc’ the x axis will be sorted by the maximum probability for each bitstring. Defaults to ‘asc’. - * **target\_string** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Target string if ‘sort’ is a distance measure. - * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of strings to use for labels of the data. The number of entries must match the length of data (if data is a list or 1 if it’s a dict) - * **bar\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Label each bar in histogram with probability value. - * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A string to use for the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.6)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. + * **target\_string** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Target string if ‘sort’ is a distance measure. + * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of strings to use for labels of the data. The number of entries must match the length of data (if data is a list or 1 if it’s a dict) + * **bar\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Label each bar in histogram with probability value. + * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – A string to use for the plot title + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.7)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – file path to save image to. **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_error_map.mdx b/docs/api/qiskit/qiskit.visualization.plot_error_map.mdx index 7c2d60a65aa..4081ecff4d9 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_error_map.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_error_map.mdx @@ -16,8 +16,8 @@ python_api_name: qiskit.visualization.plot_error_map **Parameters** * **backend** ([*Backend*](qiskit.providers.Backend "qiskit.providers.Backend")) – Given backend. - * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. - * **show\_title** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Show the title or not. + * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – Figure size in inches. + * **show\_title** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Show the title or not. * **qubit\_coordinates** (*Sequence*) – An optional sequence input (list or array being the most common) of 2d coordinates for each qubit. The length of the sequence much mast the number of qubits on the backend. The sequence should be the planar coordinates in a 0-based square grid where each qubit is located. **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_gate_map.mdx b/docs/api/qiskit/qiskit.visualization.plot_gate_map.mdx index effebcfe004..9e9cd62c380 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_gate_map.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_gate_map.mdx @@ -16,18 +16,18 @@ python_api_name: qiskit.visualization.plot_gate_map **Parameters** * **backend** ([*Backend*](qiskit.providers.Backend "qiskit.providers.Backend")) – The backend instance that will be used to plot the device gate map. - * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Output figure size (wxh) in inches. - * **plot\_directed** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Plot directed coupling map. - * **label\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Label the qubits. - * **qubit\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Size of qubit marker. - * **line\_width** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Width of lines. - * **font\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Font size of qubit labels. - * **qubit\_color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of colors for the qubits - * **qubit\_labels** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of qubit labels - * **line\_color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of colors for each line from coupling\_map. - * **font\_color** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The font color for the qubit labels. + * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – Output figure size (wxh) in inches. + * **plot\_directed** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Plot directed coupling map. + * **label\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Label the qubits. + * **qubit\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Size of qubit marker. + * **line\_width** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Width of lines. + * **font\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Font size of qubit labels. + * **qubit\_color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of colors for the qubits + * **qubit\_labels** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of qubit labels + * **line\_color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of colors for each line from coupling\_map. + * **font\_color** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The font color for the qubit labels. * **ax** (*Axes*) – A Matplotlib axes instance. - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – file path to save image to. * **qubit\_coordinates** (*Sequence*) – An optional sequence input (list or array being the most common) of 2d coordinates for each qubit. The length of the sequence much match the number of qubits on the backend. The sequence should be the planar coordinates in a 0-based square grid where each qubit is located. **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx b/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx index 3e7768840dc..dd8a48bea37 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx @@ -15,17 +15,17 @@ python_api_name: qiskit.visualization.plot_histogram **Parameters** - * **data** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – This is either a list of dictionaries or a single dict containing the values to represent (ex `{'001': 130}`) - * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. - * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – String or list of strings for histogram bar colors. - * **number\_to\_keep** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of terms to plot per dataset. The rest is made into a single bar called ‘rest’. If multiple datasets are given, the `number_to_keep` applies to each dataset individually, which may result in more bars than `number_to_keep + 1`. The `number_to_keep` applies to the total values, rather than the x-axis sort. + * **data** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – This is either a list of dictionaries or a single dict containing the values to represent (ex `{'001': 130}`) + * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – Figure size in inches. + * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – String or list of strings for histogram bar colors. + * **number\_to\_keep** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of terms to plot per dataset. The rest is made into a single bar called ‘rest’. If multiple datasets are given, the `number_to_keep` applies to each dataset individually, which may result in more bars than `number_to_keep + 1`. The `number_to_keep` applies to the total values, rather than the x-axis sort. * **sort** (*string*) – Could be ‘asc’, ‘desc’, ‘hamming’, ‘value’, or ‘value\_desc’. If set to ‘value’ or ‘value\_desc’ the x axis will be sorted by the number of counts for each bitstring. Defaults to ‘asc’. - * **target\_string** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Target string if ‘sort’ is a distance measure. - * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of strings to use for labels of the data. The number of entries must match the length of data (if data is a list or 1 if it’s a dict) - * **bar\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Label each bar in histogram with counts value. - * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A string to use for the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.6)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. + * **target\_string** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Target string if ‘sort’ is a distance measure. + * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of strings to use for labels of the data. The number of entries must match the length of data (if data is a list or 1 if it’s a dict) + * **bar\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Label each bar in histogram with counts value. + * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – A string to use for the plot title + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.7)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – file path to save image to. **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx index 0ceff85ae5c..e64ccd15fa7 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx @@ -18,12 +18,12 @@ python_api_name: qiskit.visualization.plot_state_city **Parameters** * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. - * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that represents the plot title - * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. - * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of len=2 giving colors for real and imaginary components of matrix elements. - * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Transparency value for bars - * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.6)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. - * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.6)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_real only the imaginary component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – a string that represents the plot title + * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – Figure size in inches. + * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of len=2 giving colors for real and imaginary components of matrix elements. + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – Transparency value for bars + * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.7)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.7)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_real only the imaginary component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -31,12 +31,12 @@ python_api_name: qiskit.visualization.plot_state_city **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.6)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.7)") **Raises** * [**MissingOptionalLibraryError**](exceptions#qiskit.exceptions.MissingOptionalLibraryError "qiskit.exceptions.MissingOptionalLibraryError") – Requires matplotlib. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – When ‘color’ is not a list of len=2. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – When ‘color’ is not a list of len=2. * [**VisualizationError**](visualization#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state. **Examples** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx index e574b987804..4bba4d1cdc9 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx @@ -18,11 +18,11 @@ python_api_name: qiskit.visualization.plot_state_hinton **Parameters** * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – An N-qubit quantum state. - * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that represents the plot title - * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. - * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.6)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. - * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.6)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – a string that represents the plot title + * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – Figure size in inches. + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – file path to save image to. + * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.7)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.7)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -30,7 +30,7 @@ python_api_name: qiskit.visualization.plot_state_hinton **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.6)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.7)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx index 8b0069df3ea..76d5d347863 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx @@ -25,10 +25,10 @@ $$ **Parameters** * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. - * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that represents the plot title - * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. - * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Color of the coefficient value bars. - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.6)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – a string that represents the plot title + * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – Figure size in inches. + * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – Color of the coefficient value bars. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.7)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -36,7 +36,7 @@ $$ **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.6)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.7)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx index 7d18ce849de..86322c4dbba 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx @@ -16,11 +16,11 @@ python_api_name: qiskit.visualization.plot_state_qsphere **Parameters** * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. - * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.6)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. - * **show\_state\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – An optional boolean indicating whether to show labels for each basis state. - * **show\_state\_phases** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – An optional boolean indicating whether to show the phase for each basis state. - * **use\_degrees** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – An optional boolean indicating whether to use radians or degrees for the phase values in the plot. + * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – Figure size in inches. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.10.7)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **show\_state\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – An optional boolean indicating whether to show labels for each basis state. + * **show\_state\_phases** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – An optional boolean indicating whether to show the phase for each basis state. + * **use\_degrees** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – An optional boolean indicating whether to use radians or degrees for the phase values in the plot. **Returns** @@ -28,7 +28,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.6)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.10.7)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.timeline_drawer.mdx b/docs/api/qiskit/qiskit.visualization.timeline_drawer.mdx index 01458206d63..cdcdcfdfde6 100644 --- a/docs/api/qiskit/qiskit.visualization.timeline_drawer.mdx +++ b/docs/api/qiskit/qiskit.visualization.timeline_drawer.mdx @@ -29,23 +29,23 @@ python_api_name: qiskit.visualization.timeline_drawer * **program** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – Program to visualize. This program should be a QuantumCircuit which is transpiled with a scheduling\_method, thus containing gate time information. - * **style** ([*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*] | None*) – Stylesheet options. This can be dictionary or preset stylesheet classes. See `IQXStandard`, `IQXSimple`, and `IQXDebugging` for details of preset stylesheets. See also the stylesheet section for details of configuration keys. + * **style** ([*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")*] | None*) – Stylesheet options. This can be dictionary or preset stylesheet classes. See `IQXStandard`, `IQXSimple`, and `IQXDebugging` for details of preset stylesheets. See also the stylesheet section for details of configuration keys. - * **time\_range** ([*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)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – Set horizontal axis limit. + * **time\_range** ([*Tuple*](https://docs.python.org/3/library/typing.html#typing.Tuple "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – Set horizontal axis limit. - * **disable\_bits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[Bits]*) – List of qubits of classical bits not shown in the output image. + * **disable\_bits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[Bits]*) – List of qubits of classical bits not shown in the output image. - * **show\_clbits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – A control property to show classical bits. Set True to show classical bits. + * **show\_clbits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – A control property to show classical bits. Set True to show classical bits. - * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – A control property to show idle timeline. Set True to show timeline without gates. + * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – A control property to show idle timeline. Set True to show timeline without gates. - * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – A control property to show barrier instructions. Set True to show barrier instructions. + * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – A control property to show barrier instructions. Set True to show barrier instructions. - * **show\_delays** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – A control property to show delay instructions. Set True to show delay instructions. + * **show\_delays** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – A control property to show delay instructions. Set True to show delay instructions. - * **show\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – A control property to show annotations, i.e. name, of gates. Set True to show annotations. + * **show\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – A control property to show annotations, i.e. name, of gates. Set True to show annotations. - * **plotter** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **plotter** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Name of plotter API to generate an output image. One of following APIs should be specified: @@ -57,15 +57,15 @@ python_api_name: qiskit.visualization.timeline_drawer axis and style kwargs may depend on the plotter. - * **axis** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)") *| None*) – Arbitrary object passed to the plotter. If this object is provided, the plotters uses given axis instead of internally initializing a figure object. This object format depends on the plotter. See plotters section for details. + * **axis** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)") *| None*) – Arbitrary object passed to the plotter. If this object is provided, the plotters uses given axis instead of internally initializing a figure object. This object format depends on the plotter. See plotters section for details. - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – If provided the output image is dumped into a file under the filename. + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – If provided the output image is dumped into a file under the filename. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.target.Target") *| None*) – The target for the backend the timeline is being generated for. - * **show\_idle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – DEPRECATED. + * **show\_idle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – DEPRECATED. - * **show\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – DEPRECATED. + * **show\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – DEPRECATED. **Returns** @@ -268,33 +268,33 @@ python_api_name: qiskit.visualization.timeline_drawer * **program** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – - * **style** ([*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*] | None*) – + * **style** ([*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)")*] | None*) – - * **time\_range** ([*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)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **time\_range** ([*Tuple*](https://docs.python.org/3/library/typing.html#typing.Tuple "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – - * **disable\_bits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[Bits]*) – + * **disable\_bits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[Bits]*) – - * **show\_clbits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + * **show\_clbits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – - * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – - * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – - * **show\_delays** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + * **show\_delays** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – - * **show\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **show\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – - * **plotter** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **plotter** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – - * **axis** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)") *| None*) – + * **axis** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.14)") *| None*) – - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.target.Target") *| None*) – - * **show\_idle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + * **show\_idle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – - * **show\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + * **show\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – **Examples** diff --git a/docs/api/qiskit/qiskit.visualization.visualize_transition.mdx b/docs/api/qiskit/qiskit.visualization.visualize_transition.mdx index 651e6efaf6d..7af016ed385 100644 --- a/docs/api/qiskit/qiskit.visualization.visualize_transition.mdx +++ b/docs/api/qiskit/qiskit.visualization.visualize_transition.mdx @@ -20,10 +20,10 @@ python_api_name: qiskit.visualization.visualize_transition **Parameters** * **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Qiskit single-qubit QuantumCircuit. Gates supported are h,x, y, z, rx, ry, rz, s, sdg, t, tdg and u1. - * **trace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Controls whether to display tracing vectors - history of 10 past vectors at each step of the animation. - * **saveas** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – User can choose to save the animation as a video to their filesystem. This argument is a string of path with filename and extension (e.g. “movie.mp4” to save the video in current working directory). - * **fpg** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Frames per gate. Finer control over animation smoothness and computational needs to render the animation. Works well for tkinter GUI as it is, for jupyter GUI it might be preferable to choose fpg between 5-30. - * **spg** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Seconds per gate. How many seconds should animation of individual gate transitions take. + * **trace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Controls whether to display tracing vectors - history of 10 past vectors at each step of the animation. + * **saveas** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – User can choose to save the animation as a video to their filesystem. This argument is a string of path with filename and extension (e.g. “movie.mp4” to save the video in current working directory). + * **fpg** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Frames per gate. Finer control over animation smoothness and computational needs to render the animation. Works well for tkinter GUI as it is, for jupyter GUI it might be preferable to choose fpg between 5-30. + * **spg** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Seconds per gate. How many seconds should animation of individual gate transitions take. **Returns** diff --git a/docs/api/qiskit/qpy.mdx b/docs/api/qiskit/qpy.mdx index bc2660d0974..ae158dec6b7 100644 --- a/docs/api/qiskit/qpy.mdx +++ b/docs/api/qiskit/qpy.mdx @@ -56,7 +56,7 @@ with open('twenty_bells.qpy', 'rb') as fd: ### load - + Load a QPY binary file This function is used to load a serialized QPY Qiskit program file and create [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects from its contents. For example: @@ -84,7 +84,7 @@ with open('twenty_bells.qpy', 'rb') as fd: * **file\_obj** (*BinaryIO*) – A file like object that contains the QPY binary data for a circuit. * **metadata\_deserializer** (*Optional\[*[*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[JSONDecoder]]*) – An optional JSONDecoder class that will be used for the `cls` kwarg on the internal `json.load` call used to deserialize the JSON payload used for the `.metadata` attribute for any programs in the QPY file. If this is not specified the circuit metadata will be parsed as JSON with the stdlib `json.load()` function using the default `JSONDecoder` class. - * **annotation\_factories** (*Optional\[Mapping\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Callable\[\[],* [*annotation.QPYSerializer*](circuit_annotation#qiskit.circuit.annotation.QPYSerializer "qiskit.circuit.annotation.QPYSerializer")*]]]*) – Mapping of namespaces to functions that create new instances of `annotation.QPUSerializer`, for handling the loading of custom [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects. + * **annotation\_factories** (*Optional\[Mapping\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Callable\[\[],* [*annotation.QPYSerializer*](circuit_annotation#qiskit.circuit.annotation.QPYSerializer "qiskit.circuit.annotation.QPYSerializer")*]]]*) – Mapping of namespaces to functions that create new instances of `annotation.QPUSerializer`, for handling the loading of custom [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects. **Returns** @@ -93,7 +93,7 @@ with open('twenty_bells.qpy', 'rb') as fd: **Raises** * [**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if `file_obj` is not a valid QPY file - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – When invalid data type is loaded. + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – When invalid data type is loaded. * [**MissingOptionalLibraryError**](exceptions#qiskit.exceptions.MissingOptionalLibraryError "qiskit.exceptions.MissingOptionalLibraryError") – If the `symengine` engine library is not installed when loading a QPY version 10, 11, or 12 payload that is using symengine symbolic encoding and contains [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") instances. * [**QpyError**](#qiskit.qpy.QpyError "qiskit.qpy.QpyError") – if known but unsupported data type is loaded. @@ -104,7 +104,7 @@ with open('twenty_bells.qpy', 'rb') as fd: ### dump - + Write QPY binary data to a file This function is used to save a circuit to a file for later use or transfer between machines. The QPY format is backwards compatible and can be loaded with future versions of Qiskit. @@ -147,9 +147,9 @@ with open('twenty_bells.qpy', 'rb') as fd: * **metadata\_serializer** (*Optional\[*[*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[JSONEncoder]]*) – An optional JSONEncoder class that will be passed the `.metadata` attribute for each program in `programs` and will be used as the `cls` kwarg on the json.dump()\` call to JSON serialize that dictionary. - * **use\_symengine** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – This flag is no longer used by QPY versions supported by this function and will have no impact on the generated QPY payload except to set a field in a QPY v13 file header which is unused. + * **use\_symengine** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – This flag is no longer used by QPY versions supported by this function and will have no impact on the generated QPY payload except to set a field in a QPY v13 file header which is unused. - * **version** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **version** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The QPY format version to emit. By default this defaults to the latest supported format of [`QPY_VERSION`](#qiskit.qpy.QPY_VERSION "qiskit.qpy.QPY_VERSION"), however for compatibility reasons if you need to load the generated QPY payload with an older version of Qiskit you can also select an older QPY format version down to the minimum supported export version, which only can change during a Qiskit major version release, to generate an older QPY format version. You can access the current QPY version and minimum compatible version with [`qpy.QPY_VERSION`](#qiskit.qpy.QPY_VERSION "qiskit.qpy.QPY_VERSION") and [`qpy.QPY_COMPATIBILITY_VERSION`](#qiskit.qpy.QPY_COMPATIBILITY_VERSION "qiskit.qpy.QPY_COMPATIBILITY_VERSION") respectively. @@ -161,17 +161,17 @@ with open('twenty_bells.qpy', 'rb') as fd: If serializing a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") that contains [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects with `version` set low with the intent to load the payload using a historical release of Qiskit, it is safest to set the `use_symengine` flag to `False`. Versions of Qiskit prior to 1.2.4 cannot load QPY files containing `symengine`-serialized [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects unless the version of `symengine` used between the loading and generating environments matches. - * **annotation\_factories** (*Optional\[Mapping\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Callable\[\[],* [*annotation.QPYSerializer*](circuit_annotation#qiskit.circuit.annotation.QPYSerializer "qiskit.circuit.annotation.QPYSerializer")*]]]*) – Mapping of namespaces to functions that create new instances of `annotation.QPUSerializer`, for handling the dumping of custom [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects. The subsequent call to [`load()`](#qiskit.qpy.load "qiskit.qpy.load") will need to use similar serializer objects, that understand the custom output format of those serializers. + * **annotation\_factories** (*Optional\[Mapping\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*, Callable\[\[],* [*annotation.QPYSerializer*](circuit_annotation#qiskit.circuit.annotation.QPYSerializer "qiskit.circuit.annotation.QPYSerializer")*]]]*) – Mapping of namespaces to functions that create new instances of `annotation.QPUSerializer`, for handling the dumping of custom [`Annotation`](qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects. The subsequent call to [`load()`](#qiskit.qpy.load "qiskit.qpy.load") will need to use similar serializer objects, that understand the custom output format of those serializers. **Raises** - * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – When invalid data type is input. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – When an unsupported version number is passed in for the `version` argument. + * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.14)") – When invalid data type is input. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – When an unsupported version number is passed in for the `version` argument. ### get\_qpy\_version - + This function identifies the QPY version of the file. This function will read the header of `file_obj` and will return the QPY format version. It will **not** advance the cursor of `file_obj`. If you are using this for a subsequent read, such as to call [`load()`](#qiskit.qpy.load "qiskit.qpy.load"), you can pass `file_obj` directly. For example: @@ -186,7 +186,7 @@ with open('twenty_bells.qpy', 'rb') as fd: **Parameters** - **file\_obj** ([*BinaryIO*](https://docs.python.org/3/library/typing.html#typing.BinaryIO "(in Python v3.13)")) – A file like object that contains the QPY binary data for a circuit. + **file\_obj** ([*BinaryIO*](https://docs.python.org/3/library/typing.html#typing.BinaryIO "(in Python v3.14)")) – A file like object that contains the QPY binary data for a circuit. **Returns** @@ -194,7 +194,7 @@ with open('twenty_bells.qpy', 'rb') as fd: **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") These functions will raise a custom subclass of [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") if they encounter problems during serialization or deserialization. @@ -220,9 +220,9 @@ When a lower-than-maximum target QPY version is set for serialization, but the o **Parameters** - * **feature** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a description of the problematic feature. - * **required** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the minimum version of QPY that would be required to represent this feature. - * **target** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the version of QPY that is being used in the serialization. + * **feature** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – a description of the problematic feature. + * **required** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the minimum version of QPY that would be required to represent this feature. + * **target** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the version of QPY that is being used in the serialization. ### qiskit.qpy.QPY\_VERSION @@ -232,7 +232,7 @@ When a lower-than-maximum target QPY version is set for serialization, but the o **Type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### qiskit.qpy.QPY\_COMPATIBILITY\_VERSION @@ -242,7 +242,7 @@ When a lower-than-maximum target QPY version is set for serialization, but the o **Type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") diff --git a/docs/api/qiskit/quantum_info.mdx b/docs/api/qiskit/quantum_info.mdx index edd0fb55fd7..e9e34ce6db2 100644 --- a/docs/api/qiskit/quantum_info.mdx +++ b/docs/api/qiskit/quantum_info.mdx @@ -85,8 +85,8 @@ $$ * **channel** (*QuantumChannel or* [*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – noisy quantum channel. * **target** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or None*) – target unitary operator. If None target is the identity operator \[Default: None]. - * **require\_cp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – check if input and target channels are completely-positive and if non-CP log warning containing negative eigenvalues of Choi-matrix \[Default: True]. - * **require\_tp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – check if input and target channels are trace-preserving and if non-TP log warning containing negative eigenvalues of partial Choi-matrix $Tr_{\text{out}}[\mathcal{E}] - I$ \[Default: True]. + * **require\_cp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – check if input and target channels are completely-positive and if non-CP log warning containing negative eigenvalues of Choi-matrix \[Default: True]. + * **require\_tp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – check if input and target channels are trace-preserving and if non-TP log warning containing negative eigenvalues of partial Choi-matrix $Tr_{\text{out}}[\mathcal{E}] - I$ \[Default: True]. **Returns** @@ -94,7 +94,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** @@ -132,8 +132,8 @@ $$ * **channel** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or QuantumChannel*) – input quantum channel. * **target** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or QuantumChannel or None*) – target quantum channel. If None target is the identity operator \[Default: None]. - * **require\_cp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – check if input and target channels are completely-positive and if non-CP log warning containing negative eigenvalues of Choi-matrix \[Default: True]. - * **require\_tp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – check if input and target channels are trace-preserving and if non-TP log warning containing negative eigenvalues of partial Choi-matrix $Tr_{\text{out}}[\mathcal{E}] - I$ \[Default: True]. + * **require\_cp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – check if input and target channels are completely-positive and if non-CP log warning containing negative eigenvalues of Choi-matrix \[Default: True]. + * **require\_tp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – check if input and target channels are trace-preserving and if non-TP log warning containing negative eigenvalues of partial Choi-matrix $Tr_{\text{out}}[\mathcal{E}] - I$ \[Default: True]. **Returns** @@ -141,7 +141,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** @@ -167,8 +167,8 @@ $$ * **channel** (*QuantumChannel*) – noisy quantum channel. * **target** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or None*) – target unitary operator. If None target is the identity operator \[Default: None]. - * **require\_cp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – check if input and target channels are completely-positive and if non-CP log warning containing negative eigenvalues of Choi-matrix \[Default: True]. - * **require\_tp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – check if input and target channels are trace-preserving and if non-TP log warning containing negative eigenvalues of partial Choi-matrix $Tr_{\text{out}}[\mathcal{E}] - I$ \[Default: True]. + * **require\_cp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – check if input and target channels are completely-positive and if non-CP log warning containing negative eigenvalues of Choi-matrix \[Default: True]. + * **require\_tp** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – check if input and target channels are trace-preserving and if non-TP log warning containing negative eigenvalues of partial Choi-matrix $Tr_{\text{out}}[\mathcal{E}] - I$ \[Default: True]. **Returns** @@ -176,7 +176,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** @@ -193,7 +193,7 @@ $$ **Parameters** * **choi** ([*Choi*](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") *or QuantumChannel*) – a quantum channel object or Choi-matrix array. - * **solver** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The solver to use. + * **solver** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The solver to use. * **kwargs** – optional arguments to pass to CVXPY solver. **Returns** @@ -202,7 +202,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** @@ -240,7 +240,7 @@ $$ * **state1** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – the first quantum state. * **state2** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – the second quantum state. - * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – check if the inputs are valid quantum states \[Default: True] + * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – check if the inputs are valid quantum states \[Default: True] **Returns** @@ -248,7 +248,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** @@ -269,7 +269,7 @@ $$ **Parameters** * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a quantum state. - * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – check if input state is valid \[Default: True] + * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – check if input state is valid \[Default: True] **Returns** @@ -277,7 +277,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** @@ -315,7 +315,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** @@ -338,7 +338,7 @@ $$ **Parameters** * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a quantum state. - * **base** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the base of the logarithm \[Default: 2]. + * **base** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the base of the logarithm \[Default: 2]. **Returns** @@ -346,7 +346,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** @@ -370,7 +370,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** @@ -395,7 +395,7 @@ $$ **Parameters** * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a bipartite state. - * **base** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the base of the logarithm \[Default: 2]. + * **base** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the base of the logarithm \[Default: 2]. **Returns** @@ -403,7 +403,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** @@ -427,7 +427,7 @@ $$ **Parameters** * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – the input state. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – The subsystems to trace over. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – The subsystems to trace over. **Returns** @@ -470,7 +470,7 @@ $$ **Parameters** * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – the input state. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – the list of Input state positions corresponding to subsystem $B$. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – the list of Input state positions corresponding to subsystem $B$. **Returns** @@ -478,7 +478,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)") **Raises** @@ -506,7 +506,7 @@ $$ **Parameters** * **pvec** (*array\_like*) – a probability vector. - * **base** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the base of the logarithm \[Default: 2]. + * **base** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the base of the logarithm \[Default: 2]. **Returns** @@ -514,7 +514,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") ### commutator @@ -591,7 +591,7 @@ $$ * **a** (*OperatorTypeT*) – Operator a. * **b** (*OperatorTypeT*) – Operator b. * **c** (*OperatorTypeT*) – Operator c. - * **commutator** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` compute the double commutator, if `False` the double anti-commutator. + * **commutator** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` compute the double commutator, if `False` the double anti-commutator. **Returns** @@ -619,8 +619,8 @@ $$ **Parameters** - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the dimensions of the state. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – the dimensions of the state. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. **Returns** @@ -642,10 +642,10 @@ $$ **Parameters** - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the dimensions of the DensityMatrix. - * **rank** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or None*) – Optional, the rank of the density matrix. The default value is full-rank. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – the dimensions of the DensityMatrix. + * **rank** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or None*) – Optional, the rank of the density matrix. The default value is full-rank. * **method** (*string*) – Optional. The method to use. ‘Hilbert-Schmidt’: (Default) sample from the Hilbert-Schmidt metric. ‘Bures’: sample from the Bures metric. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. **Returns** @@ -669,8 +669,8 @@ $$ **Parameters** - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input dimensions of the Operator. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – the input dimensions of the Operator. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. **Returns** @@ -690,9 +690,9 @@ $$ **Parameters** - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input dimension of the Operator. - * **traceless** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Optional. If True subtract diagonal entries to return a traceless hermitian operator (Default: False). - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – the input dimension of the Operator. + * **traceless** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Optional. If True subtract diagonal entries to return a traceless hermitian operator (Default: False). + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. **Returns** @@ -710,9 +710,9 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits. - * **group\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Optional. If True generate random phase. Otherwise the phase will be set so that the Pauli coefficient is +1 (default: False). - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits. + * **group\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Optional. If True generate random phase. Otherwise the phase will be set so that the Pauli coefficient is +1 (default: False). + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. **Returns** @@ -732,8 +732,8 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits for the Clifford - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits for the Clifford + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. **Returns** @@ -757,10 +757,10 @@ $$ **Parameters** - * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input dimension of the channel. - * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input dimension of the channel. - * **rank** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Optional. The rank of the quantum channel Choi-matrix. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – the input dimension of the channel. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")) – the input dimension of the channel. + * **rank** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Optional. The rank of the quantum channel Choi-matrix. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. **Returns** @@ -782,8 +782,8 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits for the CNOTDihedral object. - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or RandomState*) – Optional. Set a fixed seed or generator for RNG. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits for the CNOTDihedral object. + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or RandomState*) – Optional. Set a fixed seed or generator for RNG. **Returns** @@ -801,10 +801,10 @@ $$ **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – the number of qubits. - * **size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Optional. The length of the Pauli list (Default: 1). - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. - * **phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True the Pauli phases are randomized, otherwise the phases are fixed to 0. \[Default: True] + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – the number of qubits. + * **size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Optional. The length of the Pauli list (Default: 1). + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *or np.random.Generator*) – Optional. Set a fixed seed or generator for RNG. + * **phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If True the Pauli phases are randomized, otherwise the phases are fixed to 0. \[Default: True] **Returns** @@ -824,8 +824,8 @@ $$ **Parameters** - * **dist\_p** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – First dict of counts. - * **dist\_q** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – Second dict of counts. + * **dist\_p** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – First dict of counts. + * **dist\_q** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – Second dict of counts. **Returns** @@ -833,7 +833,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **References** @@ -851,8 +851,8 @@ $$ **Parameters** - * **dist\_p** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – First dict of counts. - * **dist\_q** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – Second dict of counts. + * **dist\_p** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – First dict of counts. + * **dist\_q** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – Second dict of counts. **Returns** @@ -860,7 +860,7 @@ $$ **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Example** diff --git a/docs/api/qiskit/release-notes/2.2.mdx b/docs/api/qiskit/release-notes/2.2.mdx index f9472eab4e3..ed3d49552c6 100644 --- a/docs/api/qiskit/release-notes/2.2.mdx +++ b/docs/api/qiskit/release-notes/2.2.mdx @@ -14,10 +14,76 @@ in_page_toc_max_heading_level: 3 +## 2.2.3 + + + +### Prelude + +Qiskit 2.2.3 fixes a bug that was introduced by Qiskit 2.2.2 when using the [`run()`](/docs/api/qiskit/qiskit.transpiler.PassManager#run "qiskit.transpiler.PassManager.run") method on a [`PassManager`](/docs/api/qiskit/qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for more than one circuit. + + + +### Upgrade Notes + +* [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") now reads a [`PropertySet`](/docs/api/qiskit/qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") key `ConsolidateBlocks_qubit_map` on entry. This key and its value are not public and should not be read or written to by other passes. + + + +### Bug Fixes + +* Fixed re-use of the same [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") instance on multiple circuits, including calls to [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") with more than one circuit and no process-based parallelization. A bug introduced in Qiskit 2.2.2 caused the pass to panic or produce invalid output if the same instance was re-used on differing circuits. + + + + + +## 2.2.2 + + + + + +### Prelude + +Qiskit 2.2.2 is a bugfix release for the v2.2 minor version series. + + + + + +### Bug Fixes + +* Fixed the implementation of [`__deepcopy__()`](https://docs.python.org/3/library/copy.html#object.__deepcopy__ "(in Python v3.14)") in [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") which did not deep-copy circuit parameters. As a consequence, mutating a [`BoxOp`](/docs/api/qiskit/qiskit.circuit.BoxOp "qiskit.circuit.BoxOp") in a copied circuit no longer affects the original circuit. + +* Fixed an issue in the [`Optimize1qGatesDecomposition`](/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition") pass when the pass is initialized with a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") containing 1-qubit gates with fixed angle parameters. Previously, the pass would potentially output gates not included in the target as it did not check whether the gates in the target supported arbitrary parameter values. Fixed [#14743](https://github.com/Qiskit/qiskit/issues/14743). + +* Fixed incorrect behavior in the [`BasisTranslator`](/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") pass where a multi-qubit gate within a [`ControlFlowOp`](/docs/api/qiskit/qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp") block would track using its local qubit indices instead of using the absolute indices from the source circuit. + +* The [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") transpiler pass will now correctly evaluate whether a given gate is hardware-supported while recursing into control-flow operations. + +* [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") can now handle writing out to `.gz` files opened using the standard-library [`gzip`](https://docs.python.org/3/library/gzip.html#module-gzip "(in Python v3.14)") module with QPY versions 16 or greater. See [#15157](https://github.com/Qiskit/qiskit/pull/15157) for details. + +* Fixed the method [`MCPhaseGate.inverse()`](/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate#inverse "qiskit.circuit.library.MCPhaseGate.inverse") to preserve the control states of open-controlled gates when computing their inverses. + +* [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") will now return a Python-space exception instead of panicking when it detects invalid or out-of-date analysis in the legacy `run_list` or `block_list` [`PropertySet`](/docs/api/qiskit/qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") keys. Fixed [#14646](https://github.com/Qiskit/qiskit/issues/14646). + +* [`Optimize1qGatesDecomposition`](/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition") will now raise a [`TranspilerError`](/docs/api/qiskit/transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") instead of a Rust-space panic when attempting to run on a circuit that is too large for the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target"). Fixed [#15116](https://github.com/Qiskit/qiskit/issues/15116). + +* The scheduling passes, [`ALAPScheduleAnalysis`](/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis "qiskit.transpiler.passes.ALAPScheduleAnalysis") and [`ASAPScheduleAnalysis`](/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis "qiskit.transpiler.passes.ASAPScheduleAnalysis"), will now correctly handle circuits with no operations in them. Previously they raised a [`TranspilerError`](/docs/api/qiskit/transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") falsely claiming “No durations provided”. Fixed [#15145](https://github.com/Qiskit/qiskit/issues/15145). + +* Fixed a failure in the circuit text drawer, which could occur when circuit blocks inside control flow operations were defined on different registers than the outer circuit. This situation could for example happen when appending [`ControlFlowOp`](/docs/api/qiskit/qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp") operations directly, or for circuits after transpilation. + + + + + ## 2.2.1 + + ### Prelude Qiskit 2.2.1 is a small patch release that fixes several bugs identified in the 2.2.0 release. @@ -30,25 +96,27 @@ Qiskit 2.2.1 is a small patch release that fixes several bugs identified in the + + ### Bug Fixes * [`DAGCircuit.apply_operation_back()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#apply_operation_back "qiskit.dagcircuit.DAGCircuit.apply_operation_back"), [`apply_operation_back()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#apply_operation_back "qiskit.dagcircuit.DAGCircuit.apply_operation_back") and `circuit_to_dag()` will now add new edges in a deterministic order. The previous behavior could cause certain transpiler passes (such as [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap")) to traverse the DAG in non-deterministic orders. * [`DAGCircuit.apply_operation_front()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#apply_operation_front "qiskit.dagcircuit.DAGCircuit.apply_operation_front") can no longer insert invalid self loops when handling nodes that include classical conditions. -* Fixed an issue with [`pickle`](https://docs.python.org/3/library/pickle.html#module-pickle "(in Python v3.13)") support for the [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") where a [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") instance would error when being pickled after the [`SabreSwap.run()`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap#run "qiskit.transpiler.passes.SabreSwap.run") method was run. Fixed [#15071](https://github.com/Qiskit/qiskit/issues/15071). +* Fixed an issue with [`pickle`](https://docs.python.org/3/library/pickle.html#module-pickle "(in Python v3.14)") support for the [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") where a [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") instance would error when being pickled after the [`SabreSwap.run()`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap#run "qiskit.transpiler.passes.SabreSwap.run") method was run. Fixed [#15071](https://github.com/Qiskit/qiskit/issues/15071). * Fixed an issue where [`is_unitary()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#is_unitary "qiskit.quantum_info.SparsePauliOp.is_unitary") was not properly respecting the input tolerance values when checking if an operator is unitary. The method now correctly uses the provided `atol` and `rtol` parameters when simplifying the operator and checking if it equals the identity. This fixes [#14107](https://github.com/Qiskit/qiskit/issues/14107). - + ## 2.2.0 - + ### Prelude @@ -66,22 +134,22 @@ The v2.2 release series is the final minor release series with support Python 3. * Added new standalone transpiler pass functions to the C API. These functions take in a `QkCircuit` to run the pass on and are equivalent to calling an instantiated pass. - > | Transpiler pass | C API Counterpart | - > | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - > | [`BasisTranslator`](/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") | [`qk_transpiler_pass_standalone_basis_translator()`](/docs/api/qiskit-c/qk-transpiler-passes) | - > | [`CommutativeCancellation`](/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation "qiskit.transpiler.passes.CommutativeCancellation") | [`qk_transpiler_pass_standalone_commutative_cancellation()`](/docs/api/qiskit-c/qk-transpiler-passes) | - > | [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") | [`qk_transpiler_pass_standalone_consolidate_blocks()`](/docs/api/qiskit-c/qk-transpiler-passes) | + > | Transpiler pass | C API Counterpart | + > | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + > | [`BasisTranslator`](/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") | [`qk_transpiler_pass_standalone_basis_translator()`](/docs/api/qiskit-c/qk-transpiler-passes) | + > | [`CommutativeCancellation`](/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation "qiskit.transpiler.passes.CommutativeCancellation") | [`qk_transpiler_pass_standalone_commutative_cancellation()`](/docs/api/qiskit-c/qk-transpiler-passes) | + > | [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") | [`qk_transpiler_pass_standalone_consolidate_blocks()`](/docs/api/qiskit-c/qk-transpiler-passes) | > | [`ElidePermutations`](/docs/api/qiskit/qiskit.transpiler.passes.ElidePermutations "qiskit.transpiler.passes.ElidePermutations") | [`qk_transpiler_pass_standalone_elide_permutations()`](/docs/api/qiskit-c/qk-transpiler-passes) | - > | [`CheckGateDirection`](/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") | [`qk_transpiler_pass_standalone_check_gate_direction()`](/docs/api/qiskit-c/qk-transpiler-passes) | - > | [`GateDirection`](/docs/api/qiskit/qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") | [`qk_transpiler_pass_standalone_gate_direction()`](/docs/api/qiskit-c/qk-transpiler-passes) | + > | [`CheckGateDirection`](/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") | [`qk_transpiler_pass_standalone_check_gate_direction()`](/docs/api/qiskit-c/qk-transpiler-passes) | + > | [`GateDirection`](/docs/api/qiskit/qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") | [`qk_transpiler_pass_standalone_gate_direction()`](/docs/api/qiskit-c/qk-transpiler-passes) | > | [`InverseCancellation`](/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation "qiskit.transpiler.passes.InverseCancellation") | [`qk_transpiler_pass_standalone_inverse_cancellation()`](/docs/api/qiskit-c/qk-transpiler-passes) | - > | [`Optimize1qGatesDecomposition`](/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition") | [`qk_transpiler_standalone_optimize_1q_sequences()`](/docs/api/qiskit-c/qk-transpiler-passes) | + > | [`Optimize1qGatesDecomposition`](/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition") | [`qk_transpiler_standalone_optimize_1q_sequences()`](/docs/api/qiskit-c/qk-transpiler-passes) | > | [`RemoveDiagonalGatesBeforeMeasure`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure "qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure") | [`qk_transpiler_pass_standalone_remove_diagonal_gates_before_measure()`](/docs/api/qiskit-c/qk-transpiler-passes) | - > | [`RemoveIdentityEquivalent`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent "qiskit.transpiler.passes.RemoveIdentityEquivalent") | [`qk_transpiler_pass_standalone_remove_identity_equivalent()`](/docs/api/qiskit-c/qk-transpiler-passes) | - > | [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") | [`qk_transpiler_pass_standalone_sabre_layout()`](/docs/api/qiskit-c/qk-transpiler-passes) | - > | [`Split2QUnitaries`](/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries "qiskit.transpiler.passes.Split2QUnitaries") | [`qk_transpiler_pass_standalone_split_2q_unitaries()`](/docs/api/qiskit-c/qk-transpiler-passes) | - > | [`UnitarySynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") | [`qk_transpiler_pass_standalone_unitary_synthesis()`](/docs/api/qiskit-c/qk-transpiler-passes) | - > | [`VF2Layout`](/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout") | [`qk_transpiler_pass_standalone_vf2_layout()`](/docs/api/qiskit-c/qk-transpiler-passes) | + > | [`RemoveIdentityEquivalent`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent "qiskit.transpiler.passes.RemoveIdentityEquivalent") | [`qk_transpiler_pass_standalone_remove_identity_equivalent()`](/docs/api/qiskit-c/qk-transpiler-passes) | + > | [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") | [`qk_transpiler_pass_standalone_sabre_layout()`](/docs/api/qiskit-c/qk-transpiler-passes) | + > | [`Split2QUnitaries`](/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries "qiskit.transpiler.passes.Split2QUnitaries") | [`qk_transpiler_pass_standalone_split_2q_unitaries()`](/docs/api/qiskit-c/qk-transpiler-passes) | + > | [`UnitarySynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") | [`qk_transpiler_pass_standalone_unitary_synthesis()`](/docs/api/qiskit-c/qk-transpiler-passes) | + > | [`VF2Layout`](/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout") | [`qk_transpiler_pass_standalone_vf2_layout()`](/docs/api/qiskit-c/qk-transpiler-passes) | * The `QkTarget` type can now represent targets that support parameterized `QkGate` types that accept any parameter value. Previously, these gates could only be added to the target with a fixed angle value supported by using [`qk_target_entry_new_fixed()`](/docs/api/qiskit-c/qk-target-entry) to create the `QkTargetEntry`. Now, the [`qk_target_entry_new()`](/docs/api/qiskit-c/qk-target-entry) function can be used with parameterized gates. When it is used with parameterized gates, this function indicates that the gate in the target supports any value for all of the gate’s parameters. For example: @@ -262,13 +330,13 @@ The v2.2 release series is the final minor release series with support Python 3. * Added support for a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") to specify angle bounds on instructions. Prior to this release a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") could specify that an operation that took a parameter either would allow any valid value or a specific value. For example, if `RZGate(Parameter("theta"))` were added to the target that would indicate an [`RZGate`](/docs/api/qiskit/qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate") with any value for theta were allowed. While if `RZGate(math.pi)` were added to the target that would indicate [`RZGate`](/docs/api/qiskit/qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate") that only $\pi$ is the only allowed value on the target. This new feature enables restricting the allowed angles to be any `float` value between a an inclusive bound. For example, you can add `RZGate(math.pi)` to a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") and restrict the angle value between the values 0 and $2\pi$. - There are several methods available for working with the angle bounds on the target. The first is [`Target.add_instruction()`](/docs/api/qiskit/qiskit.transpiler.Target#add_instruction "qiskit.transpiler.Target.add_instruction") which has a new `angle_bounds` keyword argument that is used to add an angle bound to an instruction in the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target"). To work with angle bounds you will also want to register a callback function to the global `WRAP_ANGLE_REGISTRY` registry that will tell the transpiler and [`WrapAngles`](/docs/api/qiskit/qiskit.transpiler.passes.WrapAngles "qiskit.transpiler.passes.WrapAngles") pass how to adjust gates for angle bounds. The callback function will take a list of arbitrary `float` values representing the gate angles from the circuit, as well as the qubit indices in the circuit the gate was operating on and it will return a [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") that represents an equivalent circuit for the gate with that angle but respecting the angle bounds and other [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") constraints. For example: + There are several methods available for working with the angle bounds on the target. The first is [`Target.add_instruction()`](/docs/api/qiskit/qiskit.transpiler.Target#add_instruction "qiskit.transpiler.Target.add_instruction") which has a new `angle_bounds` keyword argument that is used to add an angle bound to an instruction in the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target"). To work with angle bounds you will also want to register a callback function to the global [`WRAP_ANGLE_REGISTRY`](/docs/api/qiskit/transpiler_passes#qiskit.transpiler.passes.qiskit.transpiler.passes.utils.wrap_angles.WRAP_ANGLE_REGISTRY "qiskit.transpiler.passes.qiskit.transpiler.passes.utils.wrap_angles.WRAP_ANGLE_REGISTRY") registry that will tell the transpiler and [`WrapAngles`](/docs/api/qiskit/qiskit.transpiler.passes.WrapAngles "qiskit.transpiler.passes.WrapAngles") pass how to adjust gates for angle bounds. The callback function will take a list of arbitrary `float` values representing the gate angles from the circuit, as well as the qubit indices in the circuit the gate was operating on and it will return a [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") that represents an equivalent circuit for the gate with that angle but respecting the angle bounds and other [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") constraints. For example: ```python import math from qiskit.dagcircuit import DAGCircuit - from qiskit.transpiler import target + from qiskit.transpiler import Target from qiskit.transpiler.passes.utils.wrap_angles import WRAP_ANGLE_REGISTRY target = Target(num_qubits=1) @@ -347,7 +415,7 @@ The v2.2 release series is the final minor release series with support Python 3. ![\_images/release\_notes-1.png](/docs/images/api/qiskit/release_notes-1.avif) -* [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") now has a manual implementation of [`__deepcopy__()`](https://docs.python.org/3/library/copy.html#object.__deepcopy__ "(in Python v3.13)"). This is orders of magnitude faster than the previous implicit implementation from the pickle protocol, especially for large circuits. This also directly benefits compilation performance when running [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") or running the preset pass managers returned by [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") at `optimization_level=3` as optimization level 3 internally deep copies the [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") for each iteration of the optimization loop in the `optimization` stage. +* [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") now has a manual implementation of [`__deepcopy__()`](https://docs.python.org/3/library/copy.html#object.__deepcopy__ "(in Python v3.14)"). This is orders of magnitude faster than the previous implicit implementation from the pickle protocol, especially for large circuits. This also directly benefits compilation performance when running [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") or running the preset pass managers returned by [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") at `optimization_level=3` as optimization level 3 internally deep copies the [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") for each iteration of the optimization loop in the `optimization` stage. * A new method, [`DAGCircuit.make_physical()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#make_physical "qiskit.dagcircuit.DAGCircuit.make_physical"), is provided, which efficiently replaces the qubits in the [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") with the canonical physical-qubit register, potentially including expansion. A similar method, [`QuantumCircuit.ensure_physical()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#ensure_physical "qiskit.circuit.QuantumCircuit.ensure_physical") is also available. @@ -413,6 +481,8 @@ The v2.2 release series is the final minor release series with support Python 3. + + ### Upgrade Notes * The minimum support Rust version for building Qiskit from source (including building the C API in standalone mode) has been increased from Rust 1.79 to Rust 1.85. This change was necessary to enable using a newer version of the Rust linear algebra library [faer](https://crates.io/crates/faer) that is used inside Qiskit. There were issues identified when running Qiskit on Windows with the previous version of faer. These were fixed in the newer release, however a newer version of the Rust compiler is required to build the newer version of faer. @@ -429,11 +499,11 @@ The v2.2 release series is the final minor release series with support Python 3. ### C API Upgrade Notes -* Most usage of uintptr\_t\` has been changed to `size_t`. Specifically the following usages have been changed: +* Most usage of `uintptr_t` has been changed to `size_t`. Specifically the following usages have been changed: - > * [`QkOpCount::count`](/docs/api/qiskit-c/qk-circuit) - > * [`QkOpCounts::len`](/docs/api/qiskit-c/qk-circuit) - > * [`QkObsTerm::len`](/docs/api/qiskit-c/qk-obs-term) + > * [`QkOpCount.count`](/docs/api/qiskit-c/qk-circuit) + > * [`QkOpCounts.len`](/docs/api/qiskit-c/qk-circuit) + > * [`QkObsTerm.len`](/docs/api/qiskit-c/qk-obs-term) > * The return type of [`qk_circuit_num_instructions()`](/docs/api/qiskit-c/qk-circuit). > * The `index` argument in [`qk_circuit_get_instruction()`](/docs/api/qiskit-c/qk-circuit). > * The `boundaries` argument in [`qk_obs_new()`](/docs/api/qiskit-c/qk-obs). @@ -452,7 +522,7 @@ The v2.2 release series is the final minor release series with support Python 3. ### Quantum Information Upgrade Notes -* [`SparsePauliOp.assign_parameters()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#assign_parameters "qiskit.quantum_info.SparsePauliOp.assign_parameters") will now set the dtype of the output [`coeffs`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#coeffs "qiskit.quantum_info.SparsePauliOp.coeffs") array to [`complex`](https://docs.python.org/3/library/functions.html#complex "(in Python v3.13)") if all parameters are fully bound to numeric values. +* [`SparsePauliOp.assign_parameters()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#assign_parameters "qiskit.quantum_info.SparsePauliOp.assign_parameters") will now set the dtype of the output [`coeffs`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#coeffs "qiskit.quantum_info.SparsePauliOp.coeffs") array to [`complex`](https://docs.python.org/3/library/functions.html#complex "(in Python v3.14)") if all parameters are fully bound to numeric values. @@ -462,7 +532,7 @@ The v2.2 release series is the final minor release series with support Python 3. - + ### Transpiler Upgrade Notes @@ -482,7 +552,7 @@ The v2.2 release series is the final minor release series with support Python 3. - + ### Bug Fixes @@ -595,4129 +665,11 @@ The v2.2 release series is the final minor release series with support Python 3. ## 2.1.0rc1 - - -### New Features - -* Added C++ support for the C API. The generated header now allows calling objects and functions from C++ directly. For example, a 100-qubit observable with the term XYZ on the first 3 qubits can be constructed as - - ```c - #include - #include - #include - #include - - int main() { - uint32_t num_qubits = 100; - - // Use smart pointer with custom deleter to manage QkObs memory - QkObs *obs = qk_obs_zero(num_qubits); - - // Construct the observable term - std::complex coeff = 2.0; - std::vector bit_terms = {QkBitTerm_X, QkBitTerm_Y, QkBitTerm_Z}; - std::vector indices = {0, 1, 2}; - - QkObsTerm term { - .coeff = coeff, - .len = bit_terms.size(), - .bit_terms = bit_terms.data(), - .indices = indices.data(), - .num_qubits = num_qubits - }; - - qk_obs_add_term(obs.get(), &term); - - // Print observable properties - std::cout << "num_qubits: " << qk_obs_num_qubits(obs) << "\n"; - std::cout << "num_terms: " << qk_obs_num_terms(obs) << "\n"; - - qk_obs_free(obs); - return 0; - } - ``` - - Note that `std::complex` is compatible with `QkComplex64`. - -* Improved synthesis of multi-controlled [`CZGate`](/docs/api/qiskit/qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate") gates. - -* Improved the default plugin for synthesizing [`AnnotatedOperation`](/docs/api/qiskit/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") objects. The improvement is especially useful when creating and transpiling controlled circuits with controlled gates within them. For example: - - ```python - from qiskit.circuit import QuantumCircuit - from qiskit.circuit.library import CXGate - from qiskit.compiler import transpile - - inner = QuantumCircuit(5) - inner.append(CXGate().control(3, annotated=True), [0, 1, 2, 3, 4]) - controlled_inner_gate = inner.to_gate().control(2, annotated=True) - qc = QuantumCircuit(15) - qc.append(controlled_inner_gate, [0, 1, 2, 3, 4, 5, 6]) - qct = transpile(qc, basis_gates=["cx", "u"]) - ``` - - This code creates a quantum circuit `qc` that contains a 2-controlled quantum circuit with a 3-controlled CX-gate within it. With the improvement, the number of CX-gates in the transpiled circuit is reduced from `378` to `30`. Note that by specifying `annotated=True` when defining control logic, the controlled gates are created as annotated operations. This avoids eager synthesis, allows the transpiler to detect that `controlled_inner_gate` is equivalent to a 6-controlled X-gate, and to choose the best synthesis method available for multi-controlled X-gates, in particular utilizing available ancilla qubits. - -* The function [`adder_qft_d00()`](/docs/api/qiskit/synthesis#qiskit.synthesis.adder_qft_d00 "qiskit.synthesis.adder_qft_d00") used for synthesize [`ModularAdderGate`](/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate "qiskit.circuit.library.ModularAdderGate") and [`HalfAdderGate`](/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate "qiskit.circuit.library.HalfAdderGate") gates now accepts an addional parameter `annotated`. If `True`, the inverse-QFT-gate within the adders is implemented as an annotated operations, allowing the transpiler to apply additional optimizations. - -* Incorporated the [`SparseObservable`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") class with the `ObservablesArray` class. \* There is no change in behavior of existing methods of `ObservablesArray`, except for the method `coerce_observable()`, whose return type is changed to SparseObservable. \* The new method `apply_layout()` performs an apply\_layout operation on each observable in the array. \* The new method `equivalent()` returns True if two arrays store equivalent observables. \* The new methods `get_sparse_observable()` and `sparse_observables_array()` return information about the contents of the array. \* Estimator pubs can now be defined using `SparseObservable` objects, in addition to the existing options of str, Pauli, SparsePauliOp, and Mapping\[Union\[str, Pauli], float]. However projective observables are not yet supported when executing circuits. Projective observables are 0, 1, +, -, r, l. Currently only Pauli’s are supported: I, X, Y, Z. - -* Introduces the [`QubitSparsePauli`](/docs/api/qiskit/qiskit.quantum_info.QubitSparsePauli "qiskit.quantum_info.QubitSparsePauli"), [`QubitSparsePauliList`](/docs/api/qiskit/qiskit.quantum_info.QubitSparsePauliList "qiskit.quantum_info.QubitSparsePauliList"), and [`PauliLindbladMap`](/docs/api/qiskit/qiskit.quantum_info.PauliLindbladMap "qiskit.quantum_info.PauliLindbladMap") classes. These classes represent, respectively, a single phase-less Pauli operator, a list of phase-less Pauli operators, and a Pauli Lindblad map, all stored in qubit-sparse format. - - - - - -### C API Features - -* Added support for querying the Qiskit version via the C API using the following definitions: - - * `QISKIT_VERSION`: The version as human readable `char*` (e.g. `"2.2.0"`). - * `QISKIT_VERSION_HEX`: The version as HEX. - * `QISKIT_VERSION_MAJOR`: The major version number. - * `QISKIT_VERSION_MINOR`: The minor version number. - * `QISKIT_VERSION_PATCH`: The patch version number. - * `QISKIT_RELEASE_LEVEL`: The release level, e.g. `0xF` for final or `0xC` for release candidates. - * `QISKIT_RELEASE_SERIAL`: The release serial, e.g. `1` for the first release candidate. - * `QISKIT_GET_VERSION_HEX`: A macro returning the version a HEX, given major, minor, patch, level, and serial. - - For example, to check if the current version is at least 2.2.0, you can use: - - ```c - if (QISKIT_VERSION_HEX >= QISKIT_GET_VERSION_HEX(2, 2, 0, 0xF, 0)) { - // Code for version 2.2.0 (final) or later - } - ``` - - - - - -### Circuits Features - -* Added a function `random_circuit_from_graph()` that generates a random circuit that induces the same interaction graph as the interaction graph specified by interaction\_graph. - - The probability of randomly drawing an edge from the interaction graph as a two-qubit gate can be set by the user in the weight attribute of an edge in the input interaction graph. If the user does not set the probability, each edge is drawn uniformly, i.e. each two-qubit gate represented by an edge in the interaction graph has the same probability of getting added to the random circuit. If only a subset of edge probabilities are set, ValueError will be raised. - - This is an example where ‘cp\_map’ is a list of edges with some arbitrary weights. - - ```python - from qiskit.circuit.random.utils import random_circuit_from_graph - import rustworkx as rx - pydi_graph = rx.PyDiGraph() - n_q = 5 - cp_map = [(0, 1, 0.18), (1, 2, 0.15), (2, 3, 0.15), (3, 4, 0.22)] - pydi_graph.add_nodes_from(range(n_q)) - pydi_graph.add_edges_from(cp_map) - # cp_map can be passed in directly as interaction_graph - qc = random_circuit_from_graph(interaction_graph = pydi_graph, - min_2q_gate_per_edge = 1, - max_operands = 2, - measure = True, - conditional = True, - reset = True, - seed = 0, - insert_1q_oper = True, - prob_conditional = 0.21, - prob_reset = 0.1) - qc.draw(output='mpl') - ``` - - ![\_images/release\_notes-2.png](/docs/images/api/qiskit/release_notes-2.avif) - -* Added `QuantumCircuit.has_control_flow()` to check if a circuit contains any control flow operations. - -* A new module [`qiskit.circuit.annotation`](/docs/api/qiskit/circuit_annotation#module-qiskit.circuit.annotation "qiskit.circuit.annotation") and principle object [`Annotation`](/docs/api/qiskit/qiskit.circuit.Annotation "qiskit.circuit.Annotation") have been added. - - Annotations are a way of tagging instructions (currently only [`BoxOp`](/docs/api/qiskit/qiskit.circuit.BoxOp "qiskit.circuit.BoxOp"), in the initial implementation) with local, user-custom data. This data is intended to be consumed by custom transpiler passes. Annotations provide a way to attach data to specific instructions, rather than using the global-context object [`PropertySet`](/docs/api/qiskit/qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") during compilation. - - All [`Annotation`](/docs/api/qiskit/qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects have a [`namespace`](/docs/api/qiskit/qiskit.circuit.Annotation#namespace "qiskit.circuit.Annotation.namespace"). This string key is used for lookups, so consumers can tell if they handle a particular annotation or not. There are currently no methods for querying any abstract semantics of an [`Annotation`](/docs/api/qiskit/qiskit.circuit.Annotation "qiskit.circuit.Annotation") subclass, but these are expected to expand in the future. - - See [`qiskit.circuit.annotation`](/docs/api/qiskit/circuit_annotation#module-qiskit.circuit.annotation "qiskit.circuit.annotation") for a full discussion of the capabilities and use cases. - -* [`BoxOp`](/docs/api/qiskit/qiskit.circuit.BoxOp "qiskit.circuit.BoxOp") instances (created by [`QuantumCircuit.box()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#box "qiskit.circuit.QuantumCircuit.box")) can now be annotated with custom [`Annotation`](/docs/api/qiskit/qiskit.circuit.Annotation "qiskit.circuit.Annotation") instances. The equality of two boxes depends on the annotations being equal. - - Typically, this is achieved by passing a list of annotations as the sole positional argument when using [`QuantumCircuit.box()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#box "qiskit.circuit.QuantumCircuit.box") in context-manager form: - - ```python - from qiskit.circuit import annotation, QuantumCircuit - - class MyAnnotation(annotation.Annotation): - namespace = "my.annotation" - - def __eq__(self, other): - return isinstance(other, MyAnnotation) - - qc = QuantumCircuit() - with qc.box([MyAnnotation()]): - pass - ``` - -* The C API for Qiskit has been extended with support for building and interacting with quantum circuits. - -* Improve the synthesis of a multi-controlled [`U1Gate`](/docs/api/qiskit/qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"), so that it will not grow exponentially with the number of controls. - -* The `BoxOp.duration` field can now be an [`expr.Expr`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") node with type [`Duration`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.types.Duration "qiskit.circuit.classical.types.Duration"), just like `Delay.duration`. This includes stretches. - -* Adds an equivalence between an [`XXPlusYYGate`](/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate "qiskit.circuit.library.XXPlusYYGate") and its decomposition into an [`RXXGate`](/docs/api/qiskit/qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate") followed by an [`RYYGate`](/docs/api/qiskit/qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate") to the equivalence library. - - - -### Primitives Features - -* To make [`PrimitiveJob`](/docs/api/qiskit/qiskit.primitives.PrimitiveJob "qiskit.primitives.PrimitiveJob") serializable, [`DataBin`](/docs/api/qiskit/qiskit.primitives.DataBin "qiskit.primitives.DataBin") has been updated to be pickleable. As a result, [`PrimitiveResult`](/docs/api/qiskit/qiskit.primitives.PrimitiveResult "qiskit.primitives.PrimitiveResult") is now also pickleable. - - - - - -### OpenQASM Features - -* [`qasm3.dump()`](/docs/api/qiskit/qasm3#qiskit.qasm3.dump "qiskit.qasm3.dump") and [`qasm3.dumps()`](/docs/api/qiskit/qasm3#qiskit.qasm3.dumps "qiskit.qasm3.dumps") have a new `annotation_handlers` argument, which is used to provide instances of [`annotation.OpenQASM3Serializer`](/docs/api/qiskit/circuit_annotation#qiskit.circuit.annotation.OpenQASM3Serializer "qiskit.circuit.annotation.OpenQASM3Serializer") to the OpenQASM 3 export process, which can serialize custom [`Annotation`](/docs/api/qiskit/qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects to OpenQASM 3. - -* When `qiskit_qasm3_import>=0.6.0` is installed, [`qasm3.load()`](/docs/api/qiskit/qasm3#qiskit.qasm3.load "qiskit.qasm3.load") and [`qasm3.loads()`](/docs/api/qiskit/qasm3#qiskit.qasm3.loads "qiskit.qasm3.loads") have a new `annotation_handlers` argument, which is used to provide instances of [`annotation.OpenQASM3Serializer`](/docs/api/qiskit/circuit_annotation#qiskit.circuit.annotation.OpenQASM3Serializer "qiskit.circuit.annotation.OpenQASM3Serializer") to the OpenQASM 3 import process, which can deserialize custom [`Annotation`](/docs/api/qiskit/qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects from OpenQASM 3. This support is currently limited to `box` statements, as this is the only place Qiskit can represent annotations in its data model. - - - - - -### QPY Features - -* QPY version 15 is released, including support for the new [`Annotation`](/docs/api/qiskit/qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects, with support from external serializers and deserializers. The format allows such serializers to be stateful, and safe places in the binary format are allocated for the custom state objects and custom annotation representations. - -* [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") and [`qpy.load()`](/docs/api/qiskit/qpy#qiskit.qpy.load "qiskit.qpy.load") now have an optional `annotation_factories` argument, which is used to provide constructor functions of [`annotation.QPYSerializer`](/docs/api/qiskit/circuit_annotation#qiskit.circuit.annotation.QPYSerializer "qiskit.circuit.annotation.QPYSerializer") objects to handle [`Annotation`](/docs/api/qiskit/qiskit.circuit.Annotation "qiskit.circuit.Annotation") subclasses. These must be supplied by the user, similar to `metadata_serializer`, as in general, Qiskit cannot know about all possible externally-defined [`Annotation`](/docs/api/qiskit/qiskit.circuit.Annotation "qiskit.circuit.Annotation") objects. - -* Added a new function [`get_qpy_version()`](/docs/api/qiskit/qpy#qiskit.qpy.get_qpy_version "qiskit.qpy.get_qpy_version") to the `qpy()` module. This function will inspect a QPY file and retrieve the QPY format version used in the payload. The version is returned as an integer, which can be used for logging or debugging purposes. see [#14201](https://github.com/Qiskit/qiskit/issues/14201). - - - - - -### Synthesis Features - -* Added new synthesis algorithm for [`HalfAdderGate`](/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate "qiskit.circuit.library.HalfAdderGate") that requires no ancillary qubits and has better CX count compared to [`adder_qft_d00()`](/docs/api/qiskit/synthesis#qiskit.synthesis.adder_qft_d00 "qiskit.synthesis.adder_qft_d00"): - - * [`adder_ripple_r25()`](/docs/api/qiskit/synthesis#qiskit.synthesis.adder_ripple_r25 "qiskit.synthesis.adder_ripple_r25") - -* Added new decompositions for [`MCXGate`](/docs/api/qiskit/qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate") utilizing clean ancillae, improving circuit depth and efficiency: - - * [`synth_mcx_1_clean_kg24()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_1_clean_kg24 "qiskit.synthesis.synth_mcx_1_clean_kg24"), using 1 additional clean ancilla qubit - * [`synth_mcx_1_dirty_kg24()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_1_dirty_kg24 "qiskit.synthesis.synth_mcx_1_dirty_kg24"), using 1 additional dirty ancilla qubit - * [`synth_mcx_2_clean_kg24()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_2_clean_kg24 "qiskit.synthesis.synth_mcx_2_clean_kg24"), using 2 additional clean ancillary qubits - * [`synth_mcx_2_dirty_kg24()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_2_dirty_kg24 "qiskit.synthesis.synth_mcx_2_dirty_kg24"), using 2 additional dirty ancillary qubits - - Example usage: - - ```python - from qiskit.synthesis.multi_controlled import synth_mcx_1_clean_kg24 - - n_ctrls = 10 - qc = synth_mcx_1_clean_kg24(n_ctrls) - qc.draw() - ``` - -* The Quantum Shannon Decomposition ([`qs_decomposition()`](/docs/api/qiskit/synthesis#qiskit.synthesis.qs_decomposition "qiskit.synthesis.qs_decomposition")) includes an optimization that reduces the [`CXGate`](/docs/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") count in the case that the input unitary happens to be a controlled unitary. - -* The synthesis function [`synth_mcx_1_clean_b95()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_1_clean_b95 "qiskit.synthesis.synth_mcx_1_clean_b95") now produces a circuit with fewer CX-gates. - -* The [`SolovayKitaevDecomposition`](/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition "qiskit.synthesis.SolovayKitaevDecomposition") class has additional arguments in the initializer, which allows it to be directly constructed from a set of `basis_gates` and a `depth` for the basic approximations. - -* Added [`SolovayKitaevDecomposition.save_basic_approximations()`](/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition#save_basic_approximations "qiskit.synthesis.SolovayKitaevDecomposition.save_basic_approximations") to save the set of basic approximations the class uses into a binary format. This change, in combination with the new initializer arguments, allows to skip the explicit use of [`generate_basic_approximations()`](/docs/api/qiskit/synthesis#qiskit.synthesis.generate_basic_approximations "qiskit.synthesis.generate_basic_approximations") and only rely on [`SolovayKitaevDecomposition`](/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition "qiskit.synthesis.SolovayKitaevDecomposition"). - -* The standard equivalence library has additional equivalences for [`CSGate`](/docs/api/qiskit/qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate") and [`CSdgGate`](/docs/api/qiskit/qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate"). When transpiling to the \[“cx”, “u”] basis set, the [`BasisTranslator`](/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") transpiler pass now uses 2 [`CXGate`](/docs/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") gates instead of 3 for [`CSdgGate`](/docs/api/qiskit/qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate"), and in addition reduces the number of single-qubit gates in both cases. - - - - - -### Transpiler Features - -* The function [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") now generates a special pass manager when the basis set consists of Clifford+T gates only. Formally, a Clifford+T basis set must contain either a [`TGate`](/docs/api/qiskit/qiskit.circuit.library.TGate "qiskit.circuit.library.TGate") or [`TdgGate`](/docs/api/qiskit/qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate") (or both), and only Clifford gates in addition. The full list of supported Clifford gates can be obtained using [`get_clifford_gate_names()`](/docs/api/qiskit/qiskit.quantum_info.get_clifford_gate_names "qiskit.quantum_info.get_clifford_gate_names"). - - For example: - - ```python - from qiskit.circuit import QuantumCircuit - from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager - from qiskit.quantum_info import get_clifford_gate_names - - basis_gates = get_clifford_gate_names() + ["t", "tdg"] - pm = generate_preset_pass_manager(basis_gates=basis_gates) - - qc = QuantumCircuit(1) - qc.rx(0.8, 0) - qct = pm.run(qc) - print(qct.count_ops()) - ``` - - Previously, the generated pass manager was not able to handle the example above, as it was not able to decompose single-qubit rotation gates of type [`UGate`](/docs/api/qiskit/qiskit.circuit.library.UGate "qiskit.circuit.library.UGate") into Clifford+T gates. Instead, the new pass manager uses the the Solovay-Kitaev decomposition to approximate single-qubit rotation gates using `H`, `T` and `Tdg` gates, and calls the [`BasisTranslator`](/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") transpiler pass to further translate the gates into the target basis set. The new pass manager also has other changes as to enable a more efficient translation into Clifford+T gates. - - It is important to note that the specified Clifford+T basis gate set should be universal, or else transpilation might not succeed. While the gate set `["h", "t", "tdg"]``or even ``["h", "t"]` is sufficient for universality, it is recommended to add more Clifford gates to the set if possible, as otherwise the translation might be less efficient. For example, not including S-gate might trigger decomposing S-gates into pairs of T-gates (that is, decomposing Clifford gates into non-Clifford gates, which might not be the desired behavior). - - Here is an additional slightly larger example: - - ```python - from qiskit.circuit import QuantumCircuit - from qiskit.circuit.library import QFTGate - from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager - - qc = QuantumCircuit(4) - qc.append(QFTGate(4), [0, 1, 2, 3]) - - basis_gates = ["cx", "s", "sdg", "h", "t", "tdg"] - pm = generate_preset_pass_manager(basis_gates=basis_gates, optimization_level=2) - - qc = QuantumCircuit(4) - qc.append(QFTGate(4), [0, 1, 2, 3]) - - qct = pm.run(qc) - print(qct.count_ops()) - ``` - -* Added new high-level-synthesis plugin for synthesizing a [`HalfAdderGate`](/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate "qiskit.circuit.library.HalfAdderGate"): - - * [`HalfAdderSynthesisR25`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisR25 "qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisR25"), based on `adder_ripple_rv_25()`. - - The [`HalfAdderSynthesisDefault`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisDefault "qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisDefault") has also been updated to follow the following sequence of half adder synthesizers: `"HalfAdder.ripple_r25"` when the number of qubits is $\leq 3$, `"HalfAdder.ripple_c04"` when 1 ancillary qubit is available, `"HalfAdder.ripple_r25"` in all remaining cases. - -* Added multiple high-level-synthesis plugins for synthesizing an [`MCXGate`](/docs/api/qiskit/qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"): - - * [`MCXSynthesis1CleanKG24`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesis1CleanKG24 "qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesis1CleanKG24"), based on [`synth_mcx_1_clean_kg24()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_1_clean_kg24 "qiskit.synthesis.synth_mcx_1_clean_kg24"). - * [`MCXSynthesis1DirtyKG24`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesis1DirtyKG24 "qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesis1DirtyKG24"), based on [`synth_mcx_1_dirty_kg24()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_1_dirty_kg24 "qiskit.synthesis.synth_mcx_1_dirty_kg24"). - * [`MCXSynthesis2CleanKG24`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesis2CleanKG24 "qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesis2CleanKG24"), based on [`synth_mcx_2_clean_kg24()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_2_clean_kg24 "qiskit.synthesis.synth_mcx_2_clean_kg24"). - * [`MCXSynthesis2DirtyKG24`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesis2DirtyKG24 "qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesis2DirtyKG24"), based on [`synth_mcx_2_dirty_kg24()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_2_dirty_kg24 "qiskit.synthesis.synth_mcx_2_dirty_kg24"). - - The [`MCXSynthesisDefault`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisDefault "qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisDefault") has also been updated to follow the following sequence of MCX synthesizers: “mcx.2\_clean\_kg24”, “mcx.1\_clean\_kg24”, “mcx.n\_clean\_m15”, “mcx.n\_dirty\_i15”, “mcx.2\_dirty\_kg24”, “mcx.1\_dirty\_kg24” “mcx.1\_clean\_b95”, “mcx.noaux\_v24”. - -* [`VF2PostLayout`](/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout") has been added at the end of the default optimization stage when using optimization level 3. - -* Support for creation and interaction with the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") have been added to the Qiskit C API. - - Here’s an example of how it is used: - - ```C - #include - #include - - // Create a Target with space for 2 qubit operations - QkTarget *target = qk_target_new(2); - - // Create a Target Entry for a CRX Gate with fixed parameters - double crx_params[1] = {3.14}; - QkTargetEntry *cx_entry = qk_target_entry_new_fixed(QkGate_CRX, crx_params); - - // Add mapping between (0, 1) and properties duration of 1.93e-9 and error 3.17e-10. - uint32_t qargs[2] = {0, 1}; - qk_target_entry_add(entry, qargs, 2, 1.93e-9, 3.17e-10); - // Add mapping between (1, 0) and properties duration of 1.27e-9 and no error. - uint32_t rev_qargs[2] = {1, 0}; - qk_target_entry_add(entry, rev_qargs, 2, 1.27e-9, NAN); - - // Add CRX entry to the target. - QkExitCode result_crx = qk_target_add_instruction(target, entry); - - // Add global Y gate entry to the target - QkExitCode result_crx = qk_target_add_instruction(target, qk_target_entry_new(QkGate_Y)); - ``` - -* Added a new [`OptimizeCliffordT`](/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffordT "qiskit.transpiler.passes.OptimizeCliffordT") transpiler optimization pass that merges pairs of consecutive `T`-gates into `S`-gates and pairs of consecutive `Tdg`-gates into `Sdg`-gates. This optimization is particularly effective for reducing T-count following Solovay-Kitaev decomposition, which produces multiple consecutive `T` or `Tdg` gates. For example: - - ```python - from qiskit.circuit import QuantumCircuit - from qiskit.transpiler.passes import SolovayKitaev, OptimizeCliffordT - - qc = QuantumCircuit(1) - qc.rx(0.8, 0) - - # Run Solovay-Kitaev pass on qc - transpiled = SolovayKitaev()(qc) - print(transpiled.count_ops().get("t", 0) + transpiled.count_ops().get("tdg", 0)) - - # Run Clifford+T optimization - optimized = OptimizeCliffordT()(transpiled) - print(optimized.count_ops().get("t", 0) + optimized.count_ops().get("tdg", 0)) - ``` - -* Added the [`ContextAwareDynamicalDecoupling`](/docs/api/qiskit/qiskit.transpiler.passes.ContextAwareDynamicalDecoupling "qiskit.transpiler.passes.ContextAwareDynamicalDecoupling") pass, which implements a context-aware dynamical decoupling based on Walsh-Hadamard sequences. The inserted delay sequences will be mutually orthogonal to sequences on neighboring qubits, and take into account control/target spectators of CX and ECR gates. See [arXiv:2403.06852](https://arxiv.org/abs/2403.06852) for more information. - - Example: - - ```python - from qiskit.circuit.library import QFT - from qiskit.transpiler import PassManager - from qiskit.transpiler.passes import ALAPScheduleAnalysis, ContextAwareDynamicalDecoupling - from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager - from qiskit_ibm_runtime.fake_provider import FakeSherbrooke - - num_qubits = 10 - circuit = QFT(num_qubits) - circuit.measure_all() - - target = FakeSherbrooke().target - - pm = generate_preset_pass_manager(optimization_level=2, target=target) - dd = PassManager([ - ALAPScheduleAnalysis(target=target), - ContextAwareDynamicalDecoupling(target=target), - ]) - - transpiled = pm.run(circuit) - with_dd = dd.run(transpiled) - - print(with_dd.draw(idle_wires=False)) - ``` - -* Adds [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") attributes [`num_stretches`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#num_stretches "qiskit.dagcircuit.DAGCircuit.num_stretches"), [`num_captured_stretches`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#num_captured_stretches "qiskit.dagcircuit.DAGCircuit.num_captured_stretches"), and [`num_declared_stretches`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#num_declared_stretches "qiskit.dagcircuit.DAGCircuit.num_declared_stretches"). - -* Added a new unitary synthesis plugin `CliffordUnitarySynthesis` that attempts to syntesize a given unitary gate by checking if it can be represented by a Clifford, in which case it returns a circuit implementing this unitary and consisting only of Clifford gates. - - The plugin is invoked by the [`UnitarySynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") transpiler pass when the parameter `method` is set to `"clifford"`. - - In addition, the parameter `plugin_config` of [`UnitarySynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") can be used to pass the following plugin-specific parameters: - - * min\_qubits: the minumum number of qubits to consider (the default value is 1). - * max\_qubits: the maximum number of qubits to consider (the default value is 3). - - For example: - - ```python - import math - - from qiskit.circuit import QuantumCircuit - from qiskit.circuit.library import UnitaryGate - from qiskit.quantum_info import Operator - from qiskit.transpiler.passes import UnitarySynthesis - - # clifford unitary over 2 qubits - c2 = QuantumCircuit(2) - c2.h(0) - c2.rz(math.pi / 4, 1) - c2.rz(math.pi / 4, 1) - c2.sdg(1) - uc2 = UnitaryGate(Operator(c2).data) - - # non-clifford unitary over 2 qubits - n2 = QuantumCircuit(2) - n2.h(0) - n2.rz(math.pi / 4, 1) - n2.sdg(1) - un2 = UnitaryGate(Operator(n2).data) - - # quantum circuit with two unitary gates - qc = QuantumCircuit(3) - qc.append(uc2, [2, 1]) - qc.append(un2, [0, 2]) - - transpiled = UnitarySynthesis(method="clifford")(qc) - ``` - - Executing the code above resynthesized the first unitary gate into Clifford gates, while the second gate remains unchanged. - - If we modify the example above as follows: - - ```python - config = {"min_qubits": 3} - transpiled = UnitarySynthesis(method="clifford", plugin_config=config)(qc) - ``` - - then both unitary gates remain unchanged. - - - - - -### Visualization Features - -* Introduced custom styles for the dag\_drawer() function. This allows you to pass a dictionary to the style parameter with custom attributes that changes the style of the DAG the function returns. For example: - - ```python - from qiskit import QuantumRegister, ClassicalRegister, QuantumCircuit - from qiskit.converters import circuit_to_dag - from qiskit.visualization import dag_drawer - - q = QuantumRegister(3, 'q') - c = ClassicalRegister(3, 'c') - circ = QuantumCircuit(q, c) - circ.h(q[0]) - circ.cx(q[0], q[1]) - circ.measure(q[0], c[0]) - circ.rz(0.5, q[1]).c_if(c, 2) - - dag = circuit_to_dag(circ) - - style = { - "inputnodecolor": "pink", - "outputnodecolor": "lightblue", - "opnodecolor": "red", - } - - dag_drawer(dag, style=style) - ``` - -* Box instructions whose vertical spans do not overlap are now rendered in the same vertical slice, when possible. - - - - + -### Upgrade Notes +### Deprecation Notes -* The `python-dateutil` library is no longer a dependency of Qiskit. Since Qiskit 2.0.0 nothing in the library was actively using the library anymore and Qiskit didn’t actually depend on the library anymore. This release removes it from the dependency list so it is not automatically installed as a prerequisite anymore. If you were relying on Qiskit to install dateutil for you as a dependency you will now need to ensure you’re manually installing it (which is best practice for direct dependencies). - -* `sympy` is no longer a requirement for installing Qiskit. After the migration to a Rust based symbolic engine for the [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") class the uses of SymPy are isolated to some visualization utilities, the [`TemplateOptimization`](/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization "qiskit.transpiler.passes.TemplateOptimization") transpiler pass, [`ParameterExpression.sympify()`](/docs/api/qiskit/qiskit.circuit.ParameterExpression#sympify "qiskit.circuit.ParameterExpression.sympify") (which is explicitly for SymPy interoperability) and [`SparsePauliOp.simplify()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#simplify "qiskit.quantum_info.SparsePauliOp.simplify") if using parameterized coefficients. This functionality is not the most commonly used so SymPy is now treated as an optional dependency and those functions will raise a `MissingOptionalLibrary` exception if they’re used and SymPy is not installed. - -* The dependency on `symengine` which was used for building [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects has been removed. It has been replaced by a internal symbolic engine and is no longer required for core functionality in Qiskit. The only exception is that symengine was embedded into QPY formats 10, 11, and 12 so it is still required if you are deserializing those formats. The dependency on symengine for [`qpy.load()`](/docs/api/qiskit/qpy#qiskit.qpy.load "qiskit.qpy.load") was made explicitly optional in 2.0.0, but if you were previously relying on symengine getting installed by default for this functionality you will now need to manually install it to load the payload. - - - - - -### Circuits Upgrade Notes - -* The circuit definition of [`HalfAdderGate`](/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate "qiskit.circuit.library.HalfAdderGate") has been upgraded to use [`adder_ripple_r25()`](/docs/api/qiskit/synthesis#qiskit.synthesis.adder_ripple_r25 "qiskit.synthesis.adder_ripple_r25"). To obtain the old behaviour, use the definition of [`adder_qft_d00()`](/docs/api/qiskit/synthesis#qiskit.synthesis.adder_qft_d00 "qiskit.synthesis.adder_qft_d00") instead. - -* [`excitation_preserving()`](/docs/api/qiskit/qiskit.circuit.library.excitation_preserving "qiskit.circuit.library.excitation_preserving") and [`ExcitationPreserving`](/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving "qiskit.circuit.library.ExcitationPreserving") now use a single [`XXPlusYYGate`](/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate "qiskit.circuit.library.XXPlusYYGate") where before it used an [`RXXGate`](/docs/api/qiskit/qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate") followed by an [`RYYGate`](/docs/api/qiskit/qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). - -* The control method of [`UnitaryGate`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate") now uses [`qs_decomposition()`](/docs/api/qiskit/synthesis#qiskit.synthesis.qs_decomposition "qiskit.synthesis.qs_decomposition") instead of [`Isometry`](/docs/api/qiskit/qiskit.circuit.library.Isometry "qiskit.circuit.library.Isometry") for decomposition. This change reduces the number of [`CXGate`](/docs/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") by approximately 2x. - -* The definitions of certain standard gates have been updated according to the following principles: - - * When available, a definition using Clifford gates is preferred over one that includes non-Clifford gates. - * When available, a definition using Clifford+T gates is preferred over one that includes `UGate`. - * The use of `PhaseGate` is preferred over `U1Gate`. - * The use of `UGate` is preferred over `U2Gate` and `U3Gate`. - - Crucially, the following invariant still holds: by recursively expanding gate definitions, any gate can be ultimately expressed using only the `["cx", "u"]` basis. - -* Qiskit now uses its own, Rust-based symbolic expression library to implement the internals of [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") and [`Parameter`](/docs/api/qiskit/qiskit.circuit.Parameter "qiskit.circuit.Parameter"). As this is a new implementation of the core symbolic math engine used for [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") there might be minor differences in the exact behavior of some functionality. It should always produce equivalent results for the documented API. Please open an issue if there are any problems with correctness found. - - - - - -### Synthesis Upgrade Notes - -* The synthesis function [`synth_mcx_1_clean_b95()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_1_clean_b95 "qiskit.synthesis.synth_mcx_1_clean_b95") now produces a circuit with fewer layers of wrappings. - -* The serialization format in for basic approximations in the Solovay Kitaev algorithms has been changed from `.npy` to another binary format, based on Rust’s `serde` and `bincode`. All routines loading basic approximations (such as [`generate_basic_approximations()`](/docs/api/qiskit/synthesis#qiskit.synthesis.generate_basic_approximations "qiskit.synthesis.generate_basic_approximations"), [`SolovayKitaevDecomposition.load_basic_approximations()`](/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition#load_basic_approximations "qiskit.synthesis.SolovayKitaevDecomposition.load_basic_approximations") or the initializer of [`SolovayKitaev`](/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev "qiskit.transpiler.passes.SolovayKitaev")) still support loading the legacy format. Any new file, however, will be stored in the new format. If you relied on the old format, downgrade Qiskit to \<2.2 and store the required files. - -* The default values for [`SolovayKitaev`](/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev "qiskit.transpiler.passes.SolovayKitaev") (and related classes) have increased to `depth=12` and `reps=5`. This is due to the underlying implementation now being in Rust, which allows us to increase the default precision, while still being significantly faster than the previous Python version. - - - - - -### Transpiler Upgrade Notes - -* [The built-in layout plugins](/docs/api/qiskit/transpiler#transpiler-preset-stage-layout) for the present pass managers will no longer contain their principal component (e.g. a [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") instance for [the “sabre” stage](/docs/api/qiskit/transpiler#transpiler-preset-stage-layout-sabre)) if no coupling constraints are provided. Previously, the plugins would construct invalid instances of their layout passes, under an assumption that separate logic would prevent the passes from executing and raising exceptions. - - This should have no meaningful effect on the use of the preset pass managers or the plugins, since it was already never valid to call the passes in an invalid state . - - - -### Deprecation Notes - -* Support for running Qiskit with Python 3.9 has been deprecated and will be removed in the Qiskit 2.3.0 release. The 2.3.0 is the first release after Python 3.9 goes end of life and is no longer supported. \[1] This means that starting in the 2.3.0 release you will need to upgrade the Python version you’re using to Python 3.9 or above. - - \[1] [https://devguide.python.org/versions/](https://devguide.python.org/versions/) - - - -### C API Deprecations - -* Deprecated the macro `QISKIT_VERSION_NUMERIC` in favor of the direct replacement `QISKIT_GET_VERSION_HEX`. This macro can be used to generate a hexanumeric version format from decimal version numbers. - - - - - -### Circuits Deprecations - -* The circuit library underwent a refactoring in the Qiskit 1.3 release, in which alternatives for objects of type [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") were provided that are either a [`Instruction`](/docs/api/qiskit/qiskit.circuit.Instruction "qiskit.circuit.Instruction") or a Python function for construction. This refactoring allows the compiler to reason about high-level instructions, and reduces the overhead for circuits that do not require high-level optimizations. - - All [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") subclasses are now deprecated in favor of their alternatives introduced in Qiskit 1.3. As part of this, the `BlueprintCircuit` is also deprecated. All have an extended deprecation period and will only be removed for Qiskit 3.0. - - The `BlueprintCircuit` does not have a direct replacement, instead use a [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") directly or a function that generates circuits. See [`qiskit.circuit.library`](/docs/api/qiskit/circuit_library#module-qiskit.circuit.library "qiskit.circuit.library") and the migration guide for more details, but some common circuits have the following replacements: - - > * [`QFT`](/docs/api/qiskit/qiskit.circuit.library.QFT "qiskit.circuit.library.QFT") `-->` [`QFTGate`](/docs/api/qiskit/qiskit.circuit.library.QFTGate "qiskit.circuit.library.QFTGate") - > * [`TwoLocal`](/docs/api/qiskit/qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") `-->` `n_local()` (this is not a typo, this function covers the [`NLocal`](/docs/api/qiskit/qiskit.circuit.library.NLocal "qiskit.circuit.library.NLocal") and [`TwoLocal`](/docs/api/qiskit/qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") functionality) - > * [`EfficientSU2`](/docs/api/qiskit/qiskit.circuit.library.EfficientSU2 "qiskit.circuit.library.EfficientSU2") `-->` `efficient_su2()` - > * [`RealAmplitudes`](/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes") `-->` `real_amplitudes()` - > * [`ZZFeatureMap`](/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap") `-->` [`zz_feature_map()`](/docs/api/qiskit/qiskit.circuit.library.zz_feature_map "qiskit.circuit.library.zz_feature_map") - > * [`QuantumVolume`](/docs/api/qiskit/qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume") `-->` [`quantum_volume()`](/docs/api/qiskit/qiskit.circuit.library.quantum_volume "qiskit.circuit.library.quantum_volume") - > * [`EvolvedOperatorAnsatz`](/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.EvolvedOperatorAnsatz") `-->` [`evolved_operator_ansatz()`](/docs/api/qiskit/qiskit.circuit.library.evolved_operator_ansatz "qiskit.circuit.library.evolved_operator_ansatz") - > * [`MCXGrayCode`](/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode "qiskit.circuit.library.MCXGrayCode") `-->` [`synth_mcx_gray_code()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_gray_code "qiskit.synthesis.synth_mcx_gray_code") - > * [`MCXRecursive`](/docs/api/qiskit/qiskit.circuit.library.MCXRecursive "qiskit.circuit.library.MCXRecursive") `-->` [`synth_mcx_n_dirty_i15()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_n_dirty_i15 "qiskit.synthesis.synth_mcx_n_dirty_i15") - > * [`MCXVChain`](/docs/api/qiskit/qiskit.circuit.library.MCXVChain "qiskit.circuit.library.MCXVChain") `-->` [`synth_mcx_n_clean_m15()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_n_clean_m15 "qiskit.synthesis.synth_mcx_n_clean_m15") - -* The deprecated tuple-like interface for [`CircuitInstruction`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") was not removed in this release as originally planned. It will be removed in Qiskit 3.0.0 instead. Instead, use the `operation`, `qubits`, and `clbits` named attributes. - - - -### Security Issues - -* Fixed a security vulnerability in [`qpy.load()`](/docs/api/qiskit/qpy#qiskit.qpy.load "qiskit.qpy.load") when loading payloads that use `sympy` to serialize [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects and other symbolic expressions. This potentially includes any QPY payload using QPY version \< 10, and optionally 10, 11, and 12 depending on the symbolic encoding used in the serialization step ([`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump")). - - - - - -### Bug Fixes - -* Fixes a bug where style=plain did not show circuit labels for the nodes of the DAG. - -* Fixed a visualization bug in the text circuit drawer where post-transpilation control-flow operations could have their closing “bracket” rendered vertically out of order. See [#14271](https://github.com/Qiskit/qiskit/issues/14271) for more detail. - -* Fixed a bug in the [`UnitarySynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") transpiler pass, where the pass ignored the `synth_gates` parameter and only synthesized the `unitary` gates. The pass now correctly synthesizes all gates specified in the `synth_gates` parameter. Fixed [#14343](https://github.com/Qiskit/qiskit/issues/14343). - -* Fixed edge-cases in the `Makefile` configuration for Windows, where the pre-defined environment variable `OS` did not match the output of the `uname -s` command. - -* Fixed the name of the [`OrGate`](/docs/api/qiskit/qiskit.circuit.library.OrGate "qiskit.circuit.library.OrGate"), that was set to “and” instead of “or”, and could have possibly led to several problems. - -* Fixed an issue in the [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") transpiler pass where it would fail to consolidate some blocks if the KAK gate selected (either directly or via the target) is supercontrolled and not [`CXGate`](/docs/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). Fixed [#14413](https://github.com/Qiskit/qiskit/issues/14413) - -* Fixed a bug in [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") that would cause output [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes to become input nodes during `deepcopy` and pickling. - -* Fixed an oversight in the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") class where setting a new value for the `dt` attribute and subsequently calling `target.durations()` would not show the updated `dt` value in the returned [`InstructionDurations`](/docs/api/qiskit/qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object. This is now fixed through an invalidation of the internal target instruction durations cache in the `dt` setter. - -* Added missing `repr` support for [`Duration`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.types.Duration "qiskit.circuit.classical.types.Duration"). - -* Added missing support for Python pickling of [`Duration`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.types.Duration "qiskit.circuit.classical.types.Duration"). This was preventing parallel transpilation of circuits with [`delay()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#delay "qiskit.circuit.QuantumCircuit.delay") instructions that use duration expressions. - -* Fixed a problem in [`BasisTranslator`](/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") transpiler pass, where the global phase of the DAG was not updated correctly. Fixed [#14074](https://github.com/Qiskit/qiskit/issues/14074). - -* Fixed a problem in [`HighLevelSynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") transpiler pass that caused it to erroneously terminate early on certain circuits with control flow operations. Fixed [#14338](https://github.com/Qiskit/qiskit-terra/issues/14338) - -* Fixed the construction of Instantaneous Quantum Polynomial time (IQP) circuits in [`IQP`](/docs/api/qiskit/qiskit.circuit.library.IQP "qiskit.circuit.library.IQP") and by [`iqp()`](/docs/api/qiskit/qiskit.circuit.library.iqp_function#qiskit.circuit.library.iqp "qiskit.circuit.library.iqp"). The previous implementation incorrectly used powers of the $\sqrt{T}$ gate instead of powers of the $T$ gate. - -* Fixed a bug in the [`PauliEvolutionSynthesisDefault`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisDefault "qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisDefault") and [`PauliEvolutionSynthesisRustiq`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisRustiq "qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisRustiq") plugins that modified the .synthesis attribute of the original circuit when setting `preserve_order=False`. The behavior of the plugins has been restored and the original circuit is now preserved throughout the transpilation pipeline. - -* Fixed a bug in meth `qpy.load` where it could fail to deserialize circuits whose parameters had been re-assigned to parameters with the same names. Fixed [#13720](https://github.com/Qiskit/qiskit/issues/13720), [#13720](https://github.com/Qiskit/qiskit/issues/14088), and [#13720](https://github.com/Qiskit/qiskit/issues/14089). - -* Fixed a bug in QPY ([`qiskit.qpy`](/docs/api/qiskit/qpy#module-qiskit.qpy "qiskit.qpy")) where circuits containing gates of class [`MCMTGate`](/docs/api/qiskit/qiskit.circuit.library.MCMTGate "qiskit.circuit.library.MCMTGate") would fail to serialize. See [#13965](https://github.com/Qiskit/qiskit/issues/13965). - -* [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") and [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") will no longer panic when applying the routing result to a circuit that uses [`expr.Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") or [`Stretch`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch") objects in a nested control-flow scope. - -* [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") will now correctly propagate a circuit’s [`name`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#name "qiskit.dagcircuit.DAGCircuit.name") and [`metadata`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#metadata "qiskit.dagcircuit.DAGCircuit.metadata") fields when performing as a joint layout and routing pass. - -* Fixed a problem in the [`SolovayKitaevSynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis "qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis") unitary synthesis plugin, where repeatedly running the plugin with different basis gates incorrectly reused the basis gates from the first run only. The problem was due to ignoring the basis gates when caching basic approximations, and is now fixed. - -* Fixed a problem in the [`SolovayKitaev`](/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev "qiskit.transpiler.passes.SolovayKitaev") transpiler pass where the pass could crash due to encountering a 180 degree rotation in the internal recursion, which was not handled correctly. - -* Fixed a problem in the [`SolovayKitaev`](/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev "qiskit.transpiler.passes.SolovayKitaev") transpiler pass where the generated approximation could have a phase that differs by $\pi$ from the correct value. This resulted due to the internal $SO(3)$ representation, which requires additional handling to obtain the correct sign of the qubit gate matrix. Fixed [#9552](https://github.com/Qiskit/qiskit-terra/issues/9552) - -* [`GenericBackendV2`](/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2") now correctly allows [`BoxOp`](/docs/api/qiskit/qiskit.circuit.BoxOp "qiskit.circuit.BoxOp") when `control_flow=True`. - -* When synthesizing an [`MCXGate`](/docs/api/qiskit/qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate") gate with 3 controls, the synthesis functon [`synth_mcx_n_dirty_i15()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_n_dirty_i15 "qiskit.synthesis.synth_mcx_n_dirty_i15") used to require one auxiliary qubit, producing a circuit with 5 qubits (3 control, 1 target, and 1 auxiliary). However, the actual synthesis algorithm does not make use of this auxiliary qubit. This behavior is now fixed: the synthesized circuit is over 4 qubits (3 control and 1 target), allowing to apply the synthesis function in a slighty larger number of cases. - -* Circuits containing delays with stretches (see [`QuantumCircuit.add_stretch()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#add_stretch "qiskit.circuit.QuantumCircuit.add_stretch")) can now successfully compile using the preset pass-managers ([`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager")) when targetting a backend that has alignment constraints, for example IBM Quantum Eagle devices like `ibm_sherbrooke`. - -* The fallback error heuristic in [`VF2Layout`](/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout") and [`VF2PostLayout`](/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout"), used when there were no reported error rates, could previously assign errors greater than one, and have unpredictable effects on the resulting layout scores. - - - - - -### Other Notes - -* A new optional extra dependency variant `qpy-compat` was added. This target should be installed if you plan to load qpy files as it installs extra requirements used for loading QPY files using format versions \< 13. If you are only using newer qpy format you do no need to install this. By default [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") only generates QPY >=13. You can install this new optional variant with `` pip install qiskit[qpy-compat]` `` - -* The relative weights of the “basic” and “lookahead” components of the [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") and [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") heuristics have been modified when extended-set tracking is active (as it always is in [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout"), and is by default in [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap")). The heuristic component relating to the distance between qubits in an individual gate in the front layer now no longer weakens proportional to the number of gates in the front layer; this behavior was a historical choice, but at large circuit sizes, has the accidental effect of causing the front layer to be nearly ignored, which is disastrous for efficiency. - - The resulting routing improvements should be most noticeable for circuits that can frequently be stratified into layers of more than 20 parallel two-qubit gates. - -* The Matplotlib circuit drawer will now insert less extraneous space inside the left edge when drawing [`BoxOp`](/docs/api/qiskit/qiskit.circuit.BoxOp "qiskit.circuit.BoxOp") instances in circuits. - - - - - -## 2.0.0rc1 - - - - - -### Prelude - -This release adds support for `stretch` variables to [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") which are used to express relationships between instruction durations. For example, in order to ensure a sequence of gates between two barriers will be left-aligned, whatever their actual durations may be, we can do the following: - -```python -from qiskit import QuantumCircuit -from numpy import pi - -qc = QuantumCircuit(5) -qc.barrier() -qc.cx(0, 1) -qc.u(pi/4, 0, pi/2, 2) -qc.cx(3, 4) - -a = qc.add_stretch("a") -b = qc.add_stretch("b") -c = qc.add_stretch("c") - -# Use the stretches as Delay duration. -qc.delay(a, [0, 1]) -qc.delay(b, 2) -qc.delay(c, [3, 4]) -qc.barrier() -``` - -For additional context and examples, refer to the [OpenQASM 3 language specification.](https://openqasm.com/language/delays.html#duration-and-stretch-types) - - - - - -### New Features - -* Support for the Linux aarch64 platform has been promoted to tier 1 support as documented in: - - [/guides/install-qiskit#operating-system-support](/docs/guides/install-qiskit#operating-system-support) - - from its previous support level of tier 2 in the 1.x release series. - -* Introduced a C API to build and interact with sparse observables. While the API surface in this release is fairly small, just covering the [`SparseObservable`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") class this new API lays the foundation for Qiskit’s C interface. - - The detailed syntax and more information is available under the C API docs, but a minimal example to construct the 100-qubit observable `X0 Y1 Z1` is: - - ```c - #include - #include - #include - #include - - int main(int argc, char *argv[]) { - // build a 100-qubit empty observable - uint32_t num_qubits = 100; - QkObs *obs = qk_obs_zero(num_qubits); - - // add the term 2 * (X0 Y1 Z2) to the observable - complex double coeff = 2; - QkBitTerm bit_terms[3] = {QkBitTerm_X, QkBitTerm_Y, QkBitTerm_Z}; - uint32_t indices[3] = {0, 1, 2}; - QkObsTerm term = {coeff, 3, bit_terms, indices, num_qubits}; - qk_obs_add_term(obs, &term); - - // print some properties - printf("num_qubits: %u\n", qk_obs_num_qubits(obs)); - printf("num_terms: %lu\n", qk_obs_num_terms(obs)); - - // free the memory allocated for the observable - qk_obs_free(obs); - - return 0; - } - ``` - - - - - -### Circuits Features - -* Added a new [`get_control_flow_name_mapping()`](/docs/api/qiskit/circuit#qiskit.circuit.get_control_flow_name_mapping "qiskit.circuit.get_control_flow_name_mapping") convenience function that returns a mapping of Qiskit’s control-flow operation names to their corresponding class. Example usage: - - ```python - from qiskit.circuit import get_control_flow_name_mapping - - ctrl_flow_name_map = get_control_flow_name_mapping() - if_else_object = ctrl_flow_name_map["if_else"] - - print(if_else_object) - ``` - - ```text - - ``` - -* Added a new method, [`QuantumCircuit.estimate_duration()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#estimate_duration "qiskit.circuit.QuantumCircuit.estimate_duration"), to compute the estimated duration of a scheduled circuit output from the [`transpiler`](/docs/api/qiskit/transpiler#module-qiskit.transpiler "qiskit.transpiler"). This should be used if you need an estimate of the full circuit duration instead of the deprecated [`QuantumCircuit.duration`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#duration "qiskit.circuit.QuantumCircuit.duration") attribute. - -* The new [`BitFlipOracleGate`](/docs/api/qiskit/qiskit.circuit.library.BitFlipOracleGate "qiskit.circuit.library.BitFlipOracleGate") and [`PhaseOracleGate`](/docs/api/qiskit/qiskit.circuit.library.PhaseOracleGate "qiskit.circuit.library.PhaseOracleGate") have the same interface as [`PhaseOracle`](/docs/api/qiskit/qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle") (except the evaluate\_bitstring method). Bit-flip oracle gate synthesizes a bit flip oracle instead of a phase flip oracle, meaning it acts on one additional qubit and can be seen as applying a controlled X operation, where the control is the value of the expression encoded by the oracle. - - ```python - from qiskit import QuantumCircuit - from qiskit.circuit.library.bit_flip_oracle import BitFlipOracleGate - from qiskit.circuit.library.phase_oracle import PhaseOracleGate - qc = QuantumCircuit(5) - bool_expr = "(x0 & x1 | ~x2) & x4" - oracle = BitFlipOracleGate(bool_expr) - qc.compose(oracle, inplace=True) - print(qc) - ``` - - ```text - ┌─────────────────────┐ - q_0: ┤0 ├ - │ │ - q_1: ┤1 ├ - │ │ - q_2: ┤2 (x0 & x1 | ~x2)... ├ - │ │ - q_3: ┤3 ├ - │ │ - q_4: ┤4 ├ - └─────────────────────┘ - ``` - - ```python - print(qc.decompose()) - ``` - - ```text - q_0: ──o────■────■── - │ │ │ - q_1: ──┼────o────■── - │ │ │ - q_2: ──o────o────┼── - │ │ │ - q_3: ──■────■────■── - ┌─┴─┐┌─┴─┐┌─┴─┐ - q_4: ┤ X ├┤ X ├┤ X ├ - └───┘└───┘└───┘ - ``` - - ```python - qc = QuantumCircuit(5) - bool_expr = "(x0 & x1 | ~x2) & x4" - oracle = PhaseOracleGate(bool_expr) - qc.compose(oracle, inplace=True) - print(qc) - ``` - - ```text - ┌───────────────┐ - q_0: ┤0 ├ - │ │ - q_1: ┤1 ├ - │ Phase oracle │ - q_2: ┤2 ├ - │ │ - q_3: ┤3 ├ - └───────────────┘ - q_4: ───────────────── - ``` - - ```python - print(qc.decompose()) - ``` - - ```text - q_0: ─o──■──■─ - │ │ │ - q_1: ─┼──o──■─ - │ │ │ - q_2: ─o──o──┼─ - │ │ │ - q_3: ─■──■──■─ - - q_4: ───────── - ``` - -* Added a new argument `approximation_degree` to [`CommutationChecker.commute()`](/docs/api/qiskit/qiskit.circuit.CommutationChecker#commute "qiskit.circuit.CommutationChecker.commute") and [`CommutationChecker.commute_nodes()`](/docs/api/qiskit/qiskit.circuit.CommutationChecker#commute_nodes "qiskit.circuit.CommutationChecker.commute_nodes"), which allows to set the approximation threshold for when gates are said to commute. See the docstring of [`CommutationChecker`](/docs/api/qiskit/qiskit.circuit.CommutationChecker "qiskit.circuit.CommutationChecker") for more detail. - -* A new method, [`QuantumCircuit.noop()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#noop "qiskit.circuit.QuantumCircuit.noop"), allows qubits to be marked as explicitly used within a control-flow builder scope, without adding a corresponding operation to them. - -* The classical realtime-expressions module [`qiskit.circuit.classical`](/docs/api/qiskit/circuit_classical#module-qiskit.circuit.classical "qiskit.circuit.classical") can now represent constant expressions. The [`Expr`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") class now has a bool `const` attribute which indicates the expression’s const-ness. This allows us to enforce that expressions in certain contexts must be possible to evaluate at compile time. - - All [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") expressions are considered to be non-const, while all [`Value`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") expressions are const. - - An expression comprised only of other const expressions is also const: - - ```python - from qiskit.circuit.classical import expr - - assert expr.bit_and(5, 6).const - ``` - - An expression that contains any non-const expression is non-const: - - ```python - from qiskit.circuit.classical import expr, types - - assert not expr.bit_and(5, expr.Var.new("a", types.Uint(5)).const - ``` - -* The classical realtime-expressions module [`qiskit.circuit.classical`](/docs/api/qiskit/circuit_classical#module-qiskit.circuit.classical "qiskit.circuit.classical") can now represent duration using the new types [`Duration`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.types.Duration "qiskit.circuit.classical.types.Duration"). - - The module [`qiskit.circuit`](/docs/api/qiskit/circuit#module-qiskit.circuit "qiskit.circuit") also has a new `Duration` class which can be used as a literal value within classical expressions. - - The [`lift()`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.lift "qiskit.circuit.classical.expr.lift") function can be used to create a value expression from a `Duration` instance: - - ```python - from qiskit.circuit import Duration - from qiskit.circuit.classical import expr - - expr.lift(Duration.dt(1000)) - # Value(Duration.dt(1000), Duration()) - ``` - -* The classical realtime-expressions module [`qiskit.circuit.classical`](/docs/api/qiskit/circuit_classical#module-qiskit.circuit.classical "qiskit.circuit.classical") can now represent IEEE-754 double-precision floating point values using the new type [`Float`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.types.Float "qiskit.circuit.classical.types.Float"). - - The [`lift()`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.lift "qiskit.circuit.classical.expr.lift") function can be used to create a value expression from a Python float: - - ```python - from qiskit.circuit.classical import expr - - expr.lift(5.0) - # >>> Value(5.0, Float()) - ``` - - This type is intended primarily for use in timing-related (duration and stretch) expressions. It is not compatible with bitwise or logical operations, though it can be used (dangerously) with these if first explicitly cast to something else. - -* Reduce the number of two-qubit gates when decomposing some multi-controlled single-qubit unitary gates. For example, - - * For multi-controlled [`YGate`](/docs/api/qiskit/qiskit.circuit.library.YGate "qiskit.circuit.library.YGate") on 10 qubits, we reduce the [`CXGate`](/docs/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") count by 56%, - * For multi-controlled [`HGate`](/docs/api/qiskit/qiskit.circuit.library.HGate "qiskit.circuit.library.HGate") on 10 qubits, we reduce the [`CXGate`](/docs/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") count by 56%, - * For multi-controlled [`SXGate`](/docs/api/qiskit/qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate") and [`SXdgGate`](/docs/api/qiskit/qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate") on 10 qubits, we reduce the [`CXGate`](/docs/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") count by 80%, - * For multi-controlled [`UGate`](/docs/api/qiskit/qiskit.circuit.library.UGate "qiskit.circuit.library.UGate") on 10 qubits, we reduce the [`CXGate`](/docs/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") count by 31%. - -* The classical realtime-expressions module [`qiskit.circuit.classical`](/docs/api/qiskit/circuit_classical#module-qiskit.circuit.classical "qiskit.circuit.classical") can now represent arithmetic operations [`add()`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.add "qiskit.circuit.classical.expr.add"), [`sub()`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.sub "qiskit.circuit.classical.expr.sub"), [`mul()`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.mul "qiskit.circuit.classical.expr.mul"), and [`div()`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.div "qiskit.circuit.classical.expr.div") on numeric and timing operands. - - For example: - - ```python - from qiskit.circuit import QuantumCircuit, ClassicalRegister, Duration - from qiskit.circuit.classical import expr - - # Subtract two integers - cr = ClassicalRegister(4, "cr") - qc = QuantumCircuit(cr) - with qc.if_test(expr.equal(expr.sub(cr, 2), 3)): - pass - - # Multiply a Duration by a Float - with qc.if_test(expr.less(expr.mul(Duration.dt(200), 2.0), Duration.ns(500))): - pass - - # Divide a Duration by a Duration to get a Float - with qc.if_test(expr.greater(expr.div(Duration.dt(200), Duration.dt(400)), 0.5)): - pass - ``` - - For additional examples, see the module-level documentation linked above. - -* [`UCGate`](/docs/api/qiskit/qiskit.circuit.library.UCGate "qiskit.circuit.library.UCGate") now includes a `mux_simp` boolean attribute that enables the search for simplifications of Carvalho et al., implemented in `_simplify()`. This optimization, enabled by default, identifies and removes unnecessary controls from the multiplexer, reducing the number of CX gates and circuit depth, especially in separable state preparation with [`Initialize`](/docs/api/qiskit/qiskit.circuit.library.Initialize "qiskit.circuit.library.Initialize"). - -* The [`PauliEvolutionGate`](/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate") now natively supports [`SparseObservable`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s as input. This efficiently allows to handle evolution under projectors, which are implemented as controls of a phase rotation and require less gates than explicitly expanding the projector in terms of Paulis. For example: - - ```python - from qiskit.circuit.library import PauliEvolutionGate - from qiskit.quantum_info import SparseObservable - - obs = SparseObservable("001") - evo_proj = PauliEvolutionGate(obs, time=1) - print(evo_proj.definition.draw()) - ``` - -* A new expression node [`Stretch`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch") has been added to the classical expression system to represent `stretch` variables. To create a new ```stretch` variable, you can use :meth:`.QuantumCircuit.add_stretch`. The resulting expression is a constant expression of type :class:`~.types.Duration`, which can currently be used as the ``duration``` argument of a [`delay()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#delay "qiskit.circuit.QuantumCircuit.delay"). - - The [`Stretch`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch") expression is most similar to the existing [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") expression used to represent classical variables in a circuit, except it is constant and is always of type [`Duration`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.types.Duration "qiskit.circuit.classical.types.Duration"). It can be used in other expressions (e.g. you can multiply it by a numeric constant) and [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") provides full scoping support for it (e.g. it can be captured by or declared within a control flow scope). - -* Added [`Gate`](/docs/api/qiskit/qiskit.circuit.Gate "qiskit.circuit.Gate") versions of the single-register arithmetic gates, which allow the compiler to perform high-level optimizations compared to their [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") variants. These are: - - > * [`ExactReciprocalGate`](/docs/api/qiskit/qiskit.circuit.library.ExactReciprocalGate "qiskit.circuit.library.ExactReciprocalGate") (replacing [`ExactReciprocal`](/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal "qiskit.circuit.library.ExactReciprocal")) - > * [`IntegerComparatorGate`](/docs/api/qiskit/qiskit.circuit.library.IntegerComparatorGate "qiskit.circuit.library.IntegerComparatorGate") (replacing [`IntegerComparator`](/docs/api/qiskit/qiskit.circuit.library.IntegerComparator "qiskit.circuit.library.IntegerComparator")) - > * [`LinearPauliRotationsGate`](/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotationsGate "qiskit.circuit.library.LinearPauliRotationsGate") (replacing [`LinearPauliRotations`](/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations "qiskit.circuit.library.LinearPauliRotations")) - > * [`PiecewiseLinearPauliRotationsGate`](/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotationsGate "qiskit.circuit.library.PiecewiseLinearPauliRotationsGate") (replacing [`PiecewiseLinearPauliRotations`](/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations "qiskit.circuit.library.PiecewiseLinearPauliRotations")) - > * [`PiecewiseChebyshevGate`](/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshevGate "qiskit.circuit.library.PiecewiseChebyshevGate") (replacing [`PiecewiseChebyshev`](/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev "qiskit.circuit.library.PiecewiseChebyshev")) - > * [`PiecewisePolynomialPauliRotationsGate`](/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotationsGate "qiskit.circuit.library.PiecewisePolynomialPauliRotationsGate") (replacing [`PiecewisePolynomialPauliRotations`](/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations "qiskit.circuit.library.PiecewisePolynomialPauliRotations")) - > * [`PolynomialPauliRotationsGate`](/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotationsGate "qiskit.circuit.library.PolynomialPauliRotationsGate") (replacing [`PolynomialPauliRotations`](/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations "qiskit.circuit.library.PolynomialPauliRotations")) - > * [`LinearAmplitudeFunctionGate`](/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunctionGate "qiskit.circuit.library.LinearAmplitudeFunctionGate") (replacing [`LinearAmplitudeFunction`](/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction "qiskit.circuit.library.LinearAmplitudeFunction")) - > * [`QuadraticFormGate`](/docs/api/qiskit/qiskit.circuit.library.QuadraticFormGate "qiskit.circuit.library.QuadraticFormGate") (replacing [`QuadraticForm`](/docs/api/qiskit/qiskit.circuit.library.QuadraticForm "qiskit.circuit.library.QuadraticForm")) - > * [`WeightedSumGate`](/docs/api/qiskit/qiskit.circuit.library.WeightedSumGate "qiskit.circuit.library.WeightedSumGate") (replacing [`WeightedAdder`](/docs/api/qiskit/qiskit.circuit.library.WeightedAdder "qiskit.circuit.library.WeightedAdder")) - - - - - -### Primitives Features - -* Added `to_bool_array()` method to `BitArray` class that returns the bit array as a boolean NumPy array. The `order` argument can be used to specify the endianness of the output array. - -* Expanded the docstring of `ObservablesArray.tolist()` to make it clear it might return a scalar in the case the observables array is of dimension 0. - - - -### Providers Features - -* Added the ability to set the `dt` property of [`GenericBackendV2`](/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2") in the class initializer with a new `dt` argument. Example usage: - - ```python - from qiskit.providers.fake_provider import GenericBackendV2 - backend = GenericBackendV2( - num_qubits=5, - basis_gates=["cx", "id", "rz", "sx", "x"], - dt= 2.22*e-10, - seed=42) - ``` - - - - - -### Quantum Information Features - -* Added [`SparseObservable.to_sparse_list()`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable#to_sparse_list "qiskit.quantum_info.SparseObservable.to_sparse_list") to obtain a sparse list representation of a [`SparseObservable`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable"). For example: - - ```python - from qiskit.quantum_info import SparseObservable - - obs = SparseObservable.from_list([("+II", 1), ("-II", 1)]) - print(obs.to_sparse_list()) # [("+", [2], 1), ("-", [2], 1)] - ``` - -* Added [`SparseObservable.as_paulis()`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable#as_paulis "qiskit.quantum_info.SparseObservable.as_paulis") to express a sparse observable in terms of Paulis only by expanding all projectors. For example: - - ```python - from qiskit.quantum_info import SparseObservable - - obs = SparseObservable("+-") - obs_paulis = obs.as_paulis() # 1/4 ( II + XI - IX - XX ) - ``` - -* Support construction of a [`SparsePauliOp`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") from a [`SparseObservable`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") via the new method `SparsePauliOp.from_sparse_observable`. It is important to remember that [`SparseObservable`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable")s can efficiently represent projectors, which require an exponential number of terms in the [`SparsePauliOp`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). - -* [`SparseObservable`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") now supports operator composition using the [`compose()`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable#compose "qiskit.quantum_info.SparseObservable.compose") method, similar to other [`quantum_info`](/docs/api/qiskit/quantum_info#module-qiskit.quantum_info "qiskit.quantum_info") classes. This is analagous to matrix multiplication, though the method is entirely matrix free. - -* [`SparseObservable.BitTerm`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable#bitterm "qiskit.quantum_info.SparseObservable.BitTerm") as a new attribute, [`label`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable#label "qiskit.quantum_info.SparseObservable.BitTerm.label"), which contains the single-character Python string used to represent the term in string labels. - -* The method [`StabilizerState.expectation_value()`](/docs/api/qiskit/qiskit.quantum_info.StabilizerState#expectation_value "qiskit.quantum_info.StabilizerState.expectation_value") can now accept an operator of type [`SparsePauliOp`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"). - - - - - -### Synthesis Features - -* Add a [`TwoQubitControlledUDecomposer`](/docs/api/qiskit/qiskit.synthesis.TwoQubitControlledUDecomposer "qiskit.synthesis.TwoQubitControlledUDecomposer") that decomposes any two-qubit unitary in terms of basis two-qubit fractional gates, such as [`RZZGate`](/docs/api/qiskit/qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate") (or two-gates gates which are locally equivalent to [`RZZGate`](/docs/api/qiskit/qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate") up to single qubit gates). - - For example: - - ```python - from qiskit.circuit.library import RZZGate - from qiskit.synthesis import TwoQubitControlledUDecomposer - from qiskit.quantum_info import random_unitary - - unitary = random_unitary(4, seed=1) - decomposer = TwoQubitControlledUDecomposer(RZZGate, euler_basis="ZXZ") - circ = decomposer(unitary) - circ.draw(output='mpl') - ``` - -* Added synthesis functions [`synth_integer_comparator_2s()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_integer_comparator_2s "qiskit.synthesis.synth_integer_comparator_2s") and [`synth_integer_comparator_greedy()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_integer_comparator_greedy "qiskit.synthesis.synth_integer_comparator_greedy") to compile gates implementing an integer comparison, such as represented by [`IntegerComparatorGate`](/docs/api/qiskit/qiskit.circuit.library.IntegerComparatorGate "qiskit.circuit.library.IntegerComparatorGate"). The corresponding high-level synthesis plugins are [`IntComparatorSynthesis2s`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesis2s "qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesis2s") and [`IntComparatorSynthesisNoAux`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisNoAux "qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisNoAux"). To let the compiler select the optimal decomposition based on the availably auxiliary qubits, use [`IntComparatorSynthesisDefault`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisDefault "qiskit.transpiler.passes.synthesis.hls_plugins.IntComparatorSynthesisDefault"). - -* Added [`synth_weighted_sum_carry()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_weighted_sum_carry "qiskit.synthesis.synth_weighted_sum_carry") to synthesize [`WeightedSumGate`](/docs/api/qiskit/qiskit.circuit.library.WeightedSumGate "qiskit.circuit.library.WeightedSumGate") objects. This is currently the only available synthesis method, with the corresponding high-level synthesis plugin [`WeightedSumSynthesisDefault`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.WeightedSumSynthesisDefault "qiskit.transpiler.passes.synthesis.hls_plugins.WeightedSumSynthesisDefault"). - - - - - -### Transpiler Features - -* Added support for two-qubit fractional basis gates, such as [`RZZGate`](/docs/api/qiskit/qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"), to the [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") transpiler pass. The decomposition itself is done using the [`TwoQubitControlledUDecomposer`](/docs/api/qiskit/qiskit.synthesis.TwoQubitControlledUDecomposer "qiskit.synthesis.TwoQubitControlledUDecomposer"). - - For example: - - ```python - from qiskit import QuantumCircuit - from qiskit.transpiler import generate_preset_pass_manager - from qiskit.transpiler.passes import ConsolidateBlocks - - qc = QuantumCircuit(2) - qc.rzz(0.1, 0, 1) - qc.rzz(0.2, 0, 1) - consolidate_pass = ConsolidateBlocks(basis_gates=["rz", "rzz", "sx", "x", "rx"]) - block = consolidate_pass(qc) # consolidate the circuit into a single unitary block - block.draw(output='mpl') - - pm = generate_preset_pass_manager( - optimization_level=2, basis_gates=["rz", "rzz", "sx", "x", "rx"] - ) - tqc = pm.run(qc) # synthesizing the circuit into basis gates - tqc.draw(output='mpl') - ``` - -* Added support for two-qubit fractional basis gates, such as [`RZZGate`](/docs/api/qiskit/qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"), to the [`UnitarySynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") transpiler pass. The decomposition is done using the [`TwoQubitControlledUDecomposer`](/docs/api/qiskit/qiskit.synthesis.TwoQubitControlledUDecomposer "qiskit.synthesis.TwoQubitControlledUDecomposer"), and supports both standard and custom basis gates. - - For example: - - ```python - from qiskit import QuantumCircuit - from qiskit.quantum_info import random_unitary - from qiskit.transpiler.passes import UnitarySynthesis - from qiskit.converters import circuit_to_dag, dag_to_circuit - - unitary = random_unitary(4, seed=1) - qc = QuantumCircuit(2) - qc.append(unitary, [0, 1]) - dag = circuit_to_dag(qc) - circ = UnitarySynthesis(basis_gates=['rzz', 'rx', 'rz']).run(dag) - dag_to_circuit(circ).draw(output='mpl') - ``` - -* Added a new transpiler pass, `LightCone` that is used to get the lightcone of a circuit when measuring a subset of qubits or a specific Pauli string. For example if you had a circuit like: - - > ![\_images/release\_notes-3.png](/docs/images/api/qiskit/release_notes-3.avif) - - running the pass would eliminate the gates that do not affect the outcome. - - > ```python - > from qiskit.transpiler.passes.optimization.light_cone import LightCone - > from qiskit.transpiler.passmanager import PassManager - > from qiskit.circuit import QuantumCircuit - > - > qc = QuantumCircuit(3,1) - > qc.h(range(3)) - > qc.cx(0,1) - > qc.cx(2,1) - > qc.h(range(3)) - > qc.measure(0,0) - > - > pm = PassManager([LightCone()]) - > new_circuit = pm.run(qc) - > new_circuit.draw("mpl") - > ``` - > - > ![\_images/release\_notes-4.png](/docs/images/api/qiskit/release_notes-4.avif) - -* Added a new argument `max_block_width` to the class [`BlockCollector`](/docs/api/qiskit/qiskit.dagcircuit.BlockCollector "qiskit.dagcircuit.BlockCollector") and to the transpiler passes [`CollectLinearFunctions`](/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions "qiskit.transpiler.passes.CollectLinearFunctions") and [`CollectCliffords`](/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords "qiskit.transpiler.passes.CollectCliffords"). This argument allows to restrict the maximum number of qubits over which a block of nodes is defined. - - For example: - - ```python - from qiskit.circuit import QuantumCircuit - from qiskit.transpiler.passes import CollectLinearFunctions - - qc = QuantumCircuit(5) - qc.h(0) - qc.cx(0, 1) - qc.cx(1, 2) - qc.cx(2, 3) - qc.cx(3, 4) - - # Collects all CX-gates into a single block - qc1 = CollectLinearFunctions()(qc) - qc1.draw(output='mpl') - - # Collects CX-gates into two blocks of width 3 - qc2 = CollectLinearFunctions(max_block_width=3)(qc) - qc2.draw(output='mpl') - ``` - -* Added a new option, `collect_from_back`, to [`CollectMultiQBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks "qiskit.transpiler.passes.CollectMultiQBlocks"). When set to `True`, the blocks are collected in the reverse direction, from the outputs towards the inputs of the circuit. The blocks are still reported following the normal topological order. This leads to an additional flexibility provided by the pass, and additional optimization opportunities when combined with a circuit resynthesis method. - -* Added a new argument `approximation_degree` to [`CommutationAnalysis`](/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis "qiskit.transpiler.passes.CommutationAnalysis"), which allows setting the approximation threshold for when gates are said to commute. See the class docstring for more information. - -* A new transpiler pass, [`ContractIdleWiresInControlFlow`](/docs/api/qiskit/qiskit.transpiler.passes.ContractIdleWiresInControlFlow "qiskit.transpiler.passes.ContractIdleWiresInControlFlow"), is available from [`qiskit.transpiler.passes`](/docs/api/qiskit/transpiler_passes#module-qiskit.transpiler.passes "qiskit.transpiler.passes"). This pass removes qubits from control-flow blocks if the semantics allow this, and the qubit is idle throughout the control-flow operation. Previously, the routing stage of the preset pass managers might have done this as an accidental side-effect of how they worked, but the behavior is now more properly placed in an optimization pass. - -* A new [routing plugin stage](/docs/api/qiskit/transpiler#transpiler-preset-stage-routing) is added, called `"default"`. In Qiskit 2.0, this is simply an alias for the previous default `"sabre"`. The underlying default algorithm may change over the course of the Qiskit 2.x series for some or all targets, but you can always set `routing_method="sabre"` explicitly to maintain the current behavior. - -* A new [translation plugin stage](/docs/api/qiskit/transpiler#transpiler-preset-stage-translation) is added, called `"default"`. In Qiskit 2.0, this is simply an alias for the previous default `"translator"`. The underlying default algorithm may change over the course of the Qiskit 2.x series for some or all targets, but you can always set `translation_method="translator"` explicitly to maintain the current behavior. - -* The [`HighLevelSynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") transpiler pass now synthesizes objects of type [`AnnotatedOperation`](/docs/api/qiskit/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") via the plugin interface. - -* [`PassManager.run()`](/docs/api/qiskit/qiskit.transpiler.PassManager#run "qiskit.transpiler.PassManager.run") now accepts a `property_set` argument, which can be set to a [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.13)")-like object to provide the initial values of the pipeline’s [`PropertySet`](/docs/api/qiskit/qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet"). This can be used to recommence a partially applied compilation, or to reuse certain analysis from a prior compilation in a new place. - -* The scheduling passes [`PadDelay`](/docs/api/qiskit/qiskit.transpiler.passes.PadDelay "qiskit.transpiler.passes.PadDelay") and [`PadDynamicalDecoupling`](/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling "qiskit.transpiler.passes.PadDynamicalDecoupling") has new arguments on their constructors `target` and `durations` these are used to specify the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") or [`InstructionDurations`](/docs/api/qiskit/qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") respectively. This is required to provide the durations for the instructions in the circuit when this pass is run. - -* Added a new method to the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") class has a new method, [`seconds_to_dt()`](/docs/api/qiskit/qiskit.transpiler.Target#seconds_to_dt "qiskit.transpiler.Target.seconds_to_dt"). This is used to translate a duration in seconds to a number of discretized time steps of the system time resolution specified in the [`Target.dt`](/docs/api/qiskit/qiskit.transpiler.Target#dt "qiskit.transpiler.Target.dt") attribute. This is typically useful for converting the [`InstructionProperties.duration`](/docs/api/qiskit/qiskit.transpiler.InstructionProperties#duration "qiskit.transpiler.InstructionProperties.duration") value to units of `dt`. - -* The `synth_cnot_depth_line_kms()` pass was ported into rust, with preliminary benchmarks pointing at a factor of 20x speedup. - -* The `synth_cx_cz_depth_line_my()` pass was ported into rust, with preliminary benchmarks pointing at a factor of 70x speedup. - -* The [`Split2QUnitaries`](/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries "qiskit.transpiler.passes.Split2QUnitaries") transpiler pass has been upgraded to handle the case where the unitary in consideration can be written as a SWAP gate and two 1-qubit gates. In this case, it splits the unitary and also applies virtual swapping similar to what is done in [`ElidePermutations`](/docs/api/qiskit/qiskit.transpiler.passes.ElidePermutations "qiskit.transpiler.passes.ElidePermutations"). This functionality can be controlled with a new argument, `split_swap`, on the constructor of :class\`.Split2QUnitaries\` which can be used to disable splitting swap equivalent gates. - - - -### Misc. Features - -* [`qiskit.utils`](/docs/api/qiskit/utils#module-qiskit.utils "qiskit.utils") now contains utilities to provide better control and inspection of Qiskit’s [`multiprocessing`](https://docs.python.org/3/library/multiprocessing.html#module-multiprocessing "(in Python v3.13)") parallelization settings. In particular, one can now use [`should_run_in_parallel()`](/docs/api/qiskit/utils#qiskit.utils.should_run_in_parallel "qiskit.utils.should_run_in_parallel") to query whether [`parallel_map()`](/docs/api/qiskit/utils#qiskit.utils.parallel_map "qiskit.utils.parallel_map") (and pass managers) will launch subprocesses for suitable inputs, and use the context manager [`should_run_in_parallel.override()`](/docs/api/qiskit/utils#qiskit.utils.should_run_in_parallel.override "qiskit.utils.should_run_in_parallel.override") to temporarily override most system and user configuration around this decision. - - An additional function, [`default_num_processes()`](/docs/api/qiskit/utils#qiskit.utils.default_num_processes "qiskit.utils.default_num_processes") reads the default maximum number of subprocesses that Qiskit will use for process-based parallelism. - -* A new environment variable, `QISKIT_IGNORE_USER_SETTINGS`, now controls whether to read the user settings file on `import qiskit`. If set to the string `true`, the settings file will not be read. This is useful for isolating certain instances of Qiskit from the system environment, such as for testing. - - - - - -### Upgrade Notes - -* Qiskit no longer supports Linux i686 and 32 bit Windows. Starting in Qiskit 2.0 a 64 bit platform is needed to run Qiskit. The user base for 32bit architectures is relatively small and as Qiskit continues to focus on improving performance to handle the increased scale in the complexity of quantum computing hardware maintaining support for 32 bit platforms is proving increasingly difficult. This coupled with the larger scientific/numeric Python community’s trend away from 32 bit platform support maintaining support for 32bit platforms is no longer viable. Qiskit 1.x will still continue to support 32 bit platforms, but starting in this 2.0.0 release Qiskit no longer supports these platforms, will not publish pre-compiled binaries for these platforms any longer, and there is no longer any guarantee of being able to build from source on 32 bit platforms. - -* The minimum supported Rust version for building Qiskit from source is now 1.79. This has been raised from the previous minimum supported Rust version of 1.70 in the Qiskit 1.x release series. - -* Increased the minimum threshold for when gates are assumed to be the identity in [`RemoveIdentityEquivalent`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent "qiskit.transpiler.passes.RemoveIdentityEquivalent") from machine epsilon to `1e-12` to account for round-off errors in the fidelity calculation and for consistency with the other classes, such as [`CommutationAnalysis`](/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis "qiskit.transpiler.passes.CommutationAnalysis") and [`TwoQubitWeylDecomposition`](/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition"). - -* Updated the metric used to check commutations in [`CommutationChecker`](/docs/api/qiskit/qiskit.circuit.CommutationChecker "qiskit.circuit.CommutationChecker"). Two gates are assumed to commute if the average gate fidelity of the commutation is above `1 - 1e-12`. This value is chosen to account for round-off errors in the fidelity calculation and for consistency with [`RemoveIdentityEquivalent`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent "qiskit.transpiler.passes.RemoveIdentityEquivalent") and [`TwoQubitWeylDecomposition`](/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition"). See the class docstring for more information. - -* `BlueprintCircuit.copy_empty_like()` now returns an empty [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") with the same number of qubits/clbits and the same metadata as the original circuit, instead of a `BlueprintCircuit`. This change is to mitigate unexpected behavior where dealing with an “empty” copy of a blueprint circuit would re-build the circuit data. Note that `BlueprintCircuit.copy()` still returns a `BlueprintCircuit`. Related: [#13535](https://github.com/Qiskit/qiskit/issues/13535) - -* Qiskit Pulse has been completely removed in this release, following its deprecation in Qiskit 1.3. This include all pulse module files, pulse visualization functionality, support for `ScheduleBlock` and pulse-gate serialization/deserialization capability in QPY, calibrations management in [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") and [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") and pulse-based fake backends. For more details about the removed components related to pulse, see the corresponding sections below. - - Note that Pulse migration to Qiskit Dynamics, as was the initial plan following the deprecation of Pulse, has been put on hold due to Qiskit Dynamics development priorities. Users wanting to use Qiskit Pulse as a frontend to supporting backends or in other uses-cases can still use it via Qiskit versions prior to 2.0, which include Pulse functionality. - -* The functions `sequence` and `schedule` from the [`compiler`](/docs/api/qiskit/compiler#module-qiskit.compiler "qiskit.compiler") module have been removed following their deprecation in Qiskit 1.3. They relied on being able to translate circuits to pulse using backend definitions, a capability that is no longer present. For this reason they have been removed with no proposed alternative. Note that this removals relate to the Pulse package which is also being removed in Qiskit 2.0. - - - - - -### Circuits Upgrade Notes - -* [`Bit`](/docs/api/qiskit/circuit#qiskit.circuit.Bit "qiskit.circuit.Bit") and [`Register`](/docs/api/qiskit/circuit#qiskit.circuit.Register "qiskit.circuit.Register") as well as their subclassess are no longer guaranteed to be comparable using `is` checks, due to conversions to and from Python which may re-allocate each instance exposed to Python. - -* [`Bit`](/docs/api/qiskit/circuit#qiskit.circuit.Bit "qiskit.circuit.Bit") and [`Register`](/docs/api/qiskit/circuit#qiskit.circuit.Register "qiskit.circuit.Register") (and their subclasses) can no longer be subclassed. This was never intended to be supported behavior, and doing so would cause unspecified behavior in Qiskit. It is no longer possible to do this as an implementation detail of the classes. - -* It is no longer possible to create instances of the base [`Bit`](/docs/api/qiskit/circuit#qiskit.circuit.Bit "qiskit.circuit.Bit") and [`Register`](/docs/api/qiskit/circuit#qiskit.circuit.Register "qiskit.circuit.Register") classes is no longer possible. Directly instantiating these classes was clearly documented as something that was **not** supported and being able to do it was was just an implementation artifact of how the class heirarchy in previous releases. Starting in this release it is no longer possible to do this. - -* The [`PhaseOracle`](/docs/api/qiskit/qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle") no longer relies on the tweedledum library but might not be synthesized as effectively as before. [`BitFlipOracleGate`](/docs/api/qiskit/qiskit.circuit.library.BitFlipOracleGate "qiskit.circuit.library.BitFlipOracleGate") was added as an alternative to directly synthesizing `BooleanExpression`, as this class is removed in Qiskit 2.0. A [`PhaseOracleGate`](/docs/api/qiskit/qiskit.circuit.library.PhaseOracleGate "qiskit.circuit.library.PhaseOracleGate") was added and will replace [`PhaseOracle`](/docs/api/qiskit/qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle") in Qiskit 3.0. - - The interface of [`PhaseOracle`](/docs/api/qiskit/qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle") was simplified; it no longer accepts a synthesizer parameter, and the expression parameter can only be a string; ClassicalElement has been deprecated in Qiskit 1.4. - - [`PhaseOracle`](/docs/api/qiskit/qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle") is used exactly as before: - - ```python - from qiskit.circuit.library.phase_oracle import PhaseOracle - bool_expr = "(x0 & x1 | ~x2) & x4" - oracle = PhaseOracle(bool_expr) - print(oracle) - ``` - - ```text - q_0: ─o──■──■─ - │ │ │ - q_1: ─┼──o──■─ - │ │ │ - q_2: ─o──o──┼─ - │ │ │ - q_3: ─■──■──■─ - ``` - -* The method [`QuantumCircuit.measure_active()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#measure_active "qiskit.circuit.QuantumCircuit.measure_active") has changed the name of the classical register it creates, as the previous name conflicted with an OpenQASM reserved word. Instead of `measure`, it is now called `meas`, aligning with the register name used by [`measure_all()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#measure_all "qiskit.circuit.QuantumCircuit.measure_all"). - -* [`DAGCircuit.control_flow_op_nodes()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#control_flow_op_nodes "qiskit.dagcircuit.DAGCircuit.control_flow_op_nodes") now always returns a list, even if empty. Previously, it returned `None` if empty, and never returned the empty list, which required special handling. If you need to explicitly test for emptiness in both Qiskit 1.x and 2.x, you can do: - - ```python - control_flow_nodes = dag.control_flow_op_nodes() - if not control_flow_nodes: - # There are no control-flow nodes. - pass - ``` - -* The generic control method for gates now avoids attempting to translate gates into a supported basis, if the gate is already supported. This can slightly change the synthesis of the controlled gate, although it should not increase the two-qubit gate count. - -* Converting a quantum circuit to a gate with [`converters.circuit_to_instruction()`](/docs/api/qiskit/converters#qiskit.converters.circuit_to_instruction "qiskit.converters.circuit_to_instruction") fails properly when given circuit contains control flow instructions. - -* The internal function `qiskit.circuit.add_control.add_control` was removed, as it is not part of the public API. It had fragile preconditions to uphold and was a common source of bugs. Uses of `add_control(SomeGate(...), ...)` should change to `SomeGate(...).control(...)` using [`Gate.control()`](/docs/api/qiskit/qiskit.circuit.Gate#control "qiskit.circuit.Gate.control") instead, which is far safer. - -* The [`ParameterExpression.sympify()`](/docs/api/qiskit/qiskit.circuit.ParameterExpression#sympify "qiskit.circuit.ParameterExpression.sympify") method can now raise a `MissingOptionalLibrary` exception if `sympy` is not installed. In the Qiskit 1.x releases sympy was always guaranteed to be installed, but starting in 2.x this is no longer a hard requirement and may only be needed if you are using this method. As this functionality explicitly requires `sympy` you will need to ensure you have `sympy` installed to use the method. - -* The deprecated argument `.dag` for [`DAGNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode") and its subclasses [`DAGOpNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode"), [`DAGOutNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode"), and [`DAGInNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode"). `dag` was optional parameter when constructing these objects that was unused and ignored since the 1.3.0 release. The parameter was deprecated in 1.4 and has now been is removed. - -* The [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") methods: - - * `cast` - * `cbit_argument_conversion` - * `cls_instances` - * `cls_prefix` - * `qbit_argument_conversion` - - have been removed, following their deprecation in Qiskit 1.2. These methods were internal helper functions, and never intended to be public API. No replacement is provided. - -* The deprecated attributes for [`Instruction`](/docs/api/qiskit/qiskit.circuit.Instruction "qiskit.circuit.Instruction") and [`Gate`](/docs/api/qiskit/qiskit.circuit.Gate "qiskit.circuit.Gate"): `duration` and `unit` have been removed. This includes setting the `unit` or `duration` arguments for any [`qiskit.circuit.Instruction`](/docs/api/qiskit/qiskit.circuit.Instruction "qiskit.circuit.Instruction") or subclass. These attributes were deprecated in Qiskit 1.3.0 and were used to attach a custom execution duration and unit for that duration to an individual instruction. However, the source of truth of the duration of a gate is the [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") which contains the duration for each instruction supported on the backend. The duration of an instruction is not something that’s typically user adjustable and is an immutable property of the backend. If you were previously using this capability to experiment with different durations for gates you can mutate the [`InstructionProperties.duration`](/docs/api/qiskit/qiskit.transpiler.InstructionProperties#duration "qiskit.transpiler.InstructionProperties.duration") field in a given [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") to set a custom duration for an instruction on a backend (the unit is always in seconds in the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target")). - -* The deprecated attribute for [`qiskit.circuit.Instruction`](/docs/api/qiskit/qiskit.circuit.Instruction "qiskit.circuit.Instruction") and [`Gate`](/docs/api/qiskit/qiskit.circuit.Gate "qiskit.circuit.Gate"): `condition` has been removed. These attributes were deprecated in the 1.3.0 release. This functionality has been superseded by the [`IfElseOp`](/docs/api/qiskit/qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") class which can be used to describe a classical condition in a circuit. - -* The deprecated methods for [`Instruction`](/docs/api/qiskit/qiskit.circuit.Instruction "qiskit.circuit.Instruction") and [`Gate`](/docs/api/qiskit/qiskit.circuit.Gate "qiskit.circuit.Gate"): `c_if` and `condition_bits` have been removed. These methods were deprecated in the 1.3.0 release. This functionality has been superseded by the [`IfElseOp`](/docs/api/qiskit/qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") class which can be used to describe a classical condition in a circuit. For example, a circuit previously using `Instruction.c_if()` like: - - ```python - from qiskit.circuit import QuantumCircuit - - qc = QuantumCircuit(2, 2) - qc.h(0) - qc.x(0).c_if(0, 1) - qc.z(1.c_if(1, 0) - qc.measure(0, 0) - qc.measure(1, 1) - ``` - - can be rewritten as: - - ```python - qc = QuantumCircuit(2, 2) - qc.h(0) - with expected.if_test((expected.clbits[0], True)): - qc.x(0) - with expected.if_test((expected.clbits[1], False)): - qc.z(1) - qc.measure(0, 0) - qc.measure(1, 1) - ``` - -* The deprecated method `InstructionSet.c_if` has been removed. This method was deprecated in the 1.3.0 release. This functionality has been superseded by the [`IfElseOp`](/docs/api/qiskit/qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") class which can be used to describe a classical condition in a circuit. - -* As part of Pulse removal in Qiskit 2.0, the `calibrations` property has been removed from the [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") and [`DAGDependency`](/docs/api/qiskit/qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency") classes. In addition, the method `has_calibration_for` has been removed from the [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") and [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") classes and `add_calibration` has been removed from [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). - -* The `classical_function` was removed. This module was dependent on the tweedledum library which is no longer compatible with newer versions of Python. As an alternative, the [`PhaseOracleGate`](/docs/api/qiskit/qiskit.circuit.library.PhaseOracleGate "qiskit.circuit.library.PhaseOracleGate") and [`BitFlipOracleGate`](/docs/api/qiskit/qiskit.circuit.library.BitFlipOracleGate "qiskit.circuit.library.BitFlipOracleGate") classes can be used to generate circuits from boolean expressions. - -* The internal representation of [`UnitaryGate`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate") has changed when they’re added to a [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). The object stored in the circuit will not necessarily share a common reference to the object added to the circuit anymore. This was never guaranteed to be the case and mutating the [`UnitaryGate`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate") object directly or by reference was unsound and always likely to corrupt the circuit, especially if you changed the matrix. If you need to mutate an element in the circuit (which is **not** recommended as it’s inefficient and error prone) you should ensure that you do something like: - - ```python - from qiskit.circuit import QuantumCircuit - from qiskit.quantum_info import random_unitary - from qiskit.circuit.library import UnitaryGate - import numpy as np - - qc = QuantumCircuit(2) - qc.unitary(np.eye(2, dtype=complex)) - - new_op = UnitaryGate(random_unitary(2)) - qc.data[0] = qc.data[0].replace(operation=new_op) - ``` - - This also applies to [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") too, but you can use [`DAGCircuit.substitute_node()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#substitute_node "qiskit.dagcircuit.DAGCircuit.substitute_node") instead. - -* The [`CircuitInstruction.params`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#params "qiskit.circuit.CircuitInstruction.params") attribute for a [`CircuitInstruction`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") that contains an [`UnitaryGate`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate") for its [`operation`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#operation "qiskit.circuit.CircuitInstruction.operation") will no longer contain the underlying unitary matrix for the gate. This is because the internal representation of the gate no longer treats the matrix object as a parameter. If you need to access the matrix of the gate you can do this either via the [`CircuitInstruction.matrix`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#matrix "qiskit.circuit.CircuitInstruction.matrix") or the [`UnitaryGate.params`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate#params "qiskit.circuit.library.UnitaryGate.params") field of the [`CircuitInstruction.operation`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#operation "qiskit.circuit.CircuitInstruction.operation"). - - - -### Primitives Upgrade Notes - -* As a consequence of the removal of the `BackendV1` model, the [`BackendSamplerV2`](/docs/api/qiskit/qiskit.primitives.BackendSamplerV2 "qiskit.primitives.BackendSamplerV2") and [`BackendEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2 "qiskit.primitives.BackendEstimatorV2") classes no longer accept inputs of type `BackendV1` in their `backend` input argument. - -* Primitive V1 implementations and V1-exclusive non-versioned type aliases, deprecated in Qiskit 1.2, have been removed. These interfaces have been superseded by their V2 counterparts. The removal includes the following classes implementing V1 interfaces: - - * `Estimator`, in favor of the V2 equivalent, [`StatevectorEstimator`](/docs/api/qiskit/qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator") - * `Sampler`, in favor of the V2 equivalent, [`StatevectorSampler`](/docs/api/qiskit/qiskit.primitives.StatevectorSampler "qiskit.primitives.StatevectorSampler") - * `BackendEstimator`, in favor of the V2 equivalent, [`BackendEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2 "qiskit.primitives.BackendEstimatorV2") - * `BackendSampler`, in favor of the V2 equivalent, [`BackendSamplerV2`](/docs/api/qiskit/qiskit.primitives.BackendSamplerV2 "qiskit.primitives.BackendSamplerV2") - - As well as the following non-versioned type aliases: - - * `BaseEstimator`, alias for [`BaseEstimatorV1`](/docs/api/qiskit/qiskit.primitives.BaseEstimatorV1 "qiskit.primitives.BaseEstimatorV1") - * `BaseSampler`, alias for [`BaseSamplerV1`](/docs/api/qiskit/qiskit.primitives.BaseSamplerV1 "qiskit.primitives.BaseSamplerV1") - - This removal does NOT affect the explicitly-versioned `BaseEstimatorV1` and `BaseSamplerV1` abstract interface definitions or related result and job classes, which have been kept to maintain backward compatibitily. - - In addition, the following utility functions have been removed. These functions were only used in Primitive V1 implementations: - - * `init_circuit()`, to initialize a circuit from a [`Statevector`](/docs/api/qiskit/qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector"), use [`QuantumCircuit.initialize()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#initialize "qiskit.circuit.QuantumCircuit.initialize") instead, - * `init_observable()`, use the constructor of [`SparsePauliOp`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") instead, - * `final_measurement_mapping()`, use `QuantumCircuit.layout()` and [`SparsePauliOp.apply_layout()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#apply_layout "qiskit.quantum_info.SparsePauliOp.apply_layout") to adjust an operator for a layout. Otherwise, use `mthree.utils.final_measurement_mapping`. See [Mthree Utility functions](https://qiskit-extensions.github.io/mthree/apidocs/utils.html) for details. - - - -### Providers Upgrade Notes - -* The `configuration` method of [`BasicSimulator`](/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator "qiskit.providers.basic_provider.BasicSimulator") has been removed following its deprecation in Qiskit 1.3. This method returned a `BackendConfiguration` instance, and this class was part of the deprecated `BackendV1` workflow. The individual configuration elements can be retrieved directly from the backend or from the contained [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") instance `(backend.target)`. - -* The `run_experiment` method of [`BasicSimulator`](/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator "qiskit.providers.basic_provider.BasicSimulator") has also been removed. This method took an instance of the `QasmQobjExperiment` class as an input argument, and the class has been deprecated since Qiskit 1.2. - -* The `BackendV1` model has been removed following its deprecation in Qiskit 1.2.0. This includes the `BackendV1` class as well as related modules and utils, as they have been superseded by the [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") model. The list of removed items includes: - - * `BackendV1` class: the core of the removed model - - * All elements in qiskit/providers/models, as they were used to represent components of the `BackendV1` model: - - > * `BackendConfiguration` - > * `BackendProperties` - > * `BackendStatus` - > * `QasmBackendConfiguration` - > * `PulseBackendConfiguration` - > * `UchannelLO` - > * `GateConfig` - > * `PulseDefaults` - > * `PulseQobjDef` - > * `Command` - > * `GateProperties` - > * `Nduv` - > * `JobStatus`: This class has been superseded by the more widely used [`JobStatus`](/docs/api/qiskit/qiskit.providers.JobStatus "qiskit.providers.JobStatus") - > * `PulseDefaults` - - * `BackendV2Converter` class: used to convert from `BackendV1` to [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") - - * `convert_to_target` function: used to build a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") instance from legacy `BackendV1` components (such as `BackendConfiguration` or `BackendProperties`) - - * `BackendPropertyError` and `BackendConfigurationError`: exceptions linked to removed classes - -* The [`BasicSimulator`](/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator "qiskit.providers.basic_provider.BasicSimulator") backend no longer can simulate classical control flow. It only supported using `.c_if()`/`.condition` for modeling control flow, as this has now been removed from Qiskit’s data model it no longer can support control flow. - -* All fake backend classes based on the deprecated `BackendV1` have been removed from the [`providers.fake_provider`](/docs/api/qiskit/providers_fake_provider#module-qiskit.providers.fake_provider "qiskit.providers.fake_provider") module. These classes have been deprecated since Qiskit 1.2 and were part of the deprecated `BackendV1` workflow. Their use in tests has been replaced with the [`GenericBackendV2`](/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2") class, which allows to create custom instances of [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") that implement a simulated [`BackendV2.run()`](/docs/api/qiskit/qiskit.providers.BackendV2#run "qiskit.providers.BackendV2.run"). The removal affects: - - * Base classes: - - * `FakeBackend` - * `FakePulseBackend` - * `FakeQasmBackend` - - * Fake backends for special testing purposes: \* `Fake1Q` \* `FakeOpenPulse2Q` \* `FakeOpenPulse3Q` - - * Legacy fake backends: - - * `Fake5QV1` - * `Fake20QV1` - * `Fake7QPulseV1` - * `Fake27QPulseV1` - * `Fake127QPulseV1` - -* As part of Pulse removal in Qiskit 2.0, the following methods have been removed: - - > * `qiskit.providers.BackendV2.instruction_schedule_map` - > * `qiskit.providers.BackendV2.drive_channel` - > * `qiskit.providers.BackendV2.measure_channel` - > * `qiskit.providers.BackendV2.acquire_channel` - > * `qiskit.providers.BackendV2.control_channel` - -* As part of Pulse removal in Qiskit 2.0, pulse support has been removed from [`GenericBackendV2`](/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2"). This includes the ability to initialize the backend with custom calibrations (`calibrate_instructions` argument) and pulse channels information. - -* Removed the abstract base classes `Provider` and `ProviderV1` which have been deprecated since Qiskit 1.1.0. The abstraction provided by these interface definitions were not providing a huge value, solely just the attributes `name`, `backends`, and a `get_backend()` method. A \_provider\_, as a concept, will continue existing as a collection of backends. If you’re implementing a provider currently you can adjust your code by simply removing `ProviderV1` as the parent class of your implementation. As part of this you probably would want to add an implementation of `get_backend` for backwards compatibility. For example: - - ```python - def get_backend(self, name=None, **kwargs): - backend = self.backends(name, **kwargs) - if len(backends) > 1: - raise QiskitBackendNotFoundError("More than one backend matches the criteria") - if not backends: - raise QiskitBackendNotFoundError("No backend matches the criteria") - return backends[0] - ``` - - - - - -### QPY Upgrade Notes - -* The [`qpy.load()`](/docs/api/qiskit/qpy#qiskit.qpy.load "qiskit.qpy.load") function can now raise a `MissingOptionalLibrary` exception if a QPY v10, v11, or v12 payload is passed in that is using symengine symbolic expressions and symengine is not installed. Or if sympy is not installed for any other QPY payload \< v13. In the Qiskit 1.x releases symengine and sympy were always guaranteed to be installed, but starting in 2.x this is no longer a hard requirement and may only be needed if you’re deserializing a QPY file that was generated using symengine. Parsing these QPY payloads requires symengine (0.11.0 or 0.13.0) as it’s usage is baked into the format specification for QPY v10, v11, and v12 so if the payload requires it there is no option but to install a compatible version of symengine. Similarly, sympy was was used for [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") encoding for all QPY versions from 1 through 12. - -* The minimum QPY compatibility version, [`QPY_COMPATIBILITY_VERSION`](/docs/api/qiskit/qpy#qiskit.qpy.QPY_COMPATIBILITY_VERSION "qiskit.qpy.QPY_COMPATIBILITY_VERSION"), has been raised to 13 from 10 in the 1.x release. This version controls the minimum version of QPY that can be emitted by the [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") function. This means [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") can only emit QPY v13 and v14 in this release. QPY v13 is still compatible with Qiskit 1.3.x and 1.4.x which means payloads can be generated in Qiskit 2.x that can be loaded with the Qiskit 1.x release series still. - - This change was necessary as QPY versions 10 through 12 requires either the sympy and symengine libraries to generate a serialization for [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects, but in Qiskit 2.x neither library is required for the [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object. - -* With the removal of Pulse in Qiskit 2.0, support for serializing `ScheduleBlock` programs via the [`qiskit.qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") function has been removed. Users can still load payloads containing pulse gates using the [`qiskit.qpy.load()`](/docs/api/qiskit/qpy#qiskit.qpy.load "qiskit.qpy.load") function, however those will be treated as opaque custom instructions. Loading `ScheduleBlock` payloads is not supported anymore and will result with a [`QpyError`](/docs/api/qiskit/qpy#qiskit.qpy.QpyError "qiskit.qpy.QpyError") exception. - - - - - -### Synthesis Upgrade Notes - -* The plugins for [`LinearFunction`](/docs/api/qiskit/qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction") no longer raise an error if another object than [`LinearFunction`](/docs/api/qiskit/qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction") is passed into the `run` method. Instead, `None` is returned, which is consistent with the other plugins. If you relied on this error being raised, you can manually perform an instance-check. - -* The `atomic_evolution` argument to [`ProductFormula`](/docs/api/qiskit/qiskit.synthesis.ProductFormula "qiskit.synthesis.ProductFormula") (and its subclasses [`QDrift`](/docs/api/qiskit/qiskit.synthesis.QDrift "qiskit.synthesis.QDrift"), [`LieTrotter`](/docs/api/qiskit/qiskit.synthesis.LieTrotter "qiskit.synthesis.LieTrotter") and `SuzukiTrotter` ) has a new function signature. Rather than taking some Pauli operator and time coefficient and returning the evolution circuit, the new function takes in an existing circuit and should append the evolution of the provided Pauli and given time to this circuit. This new implementation benefits from significantly better performance. - - - - - -### Transpiler Upgrade Notes - -* The [routing plugin stage](/docs/api/qiskit/transpiler#transpiler-preset-stage-routing) name `default` is now reserved for the Qiskit built-in plugin of the same name. - -* The default [routing plugin stage](/docs/api/qiskit/transpiler#transpiler-preset-stage-routing) is now `"default"`. In Qiskit 2.0, this is simply an alias for the previous default `"sabre"`. The underlying default algorithm may change over the course of the Qiskit 2.x series for some or all targets, but you can always set `routing_method="sabre"` explicitly to maintain the current behavior. - -* The [translation plugin stage](/docs/api/qiskit/transpiler#transpiler-preset-stage-translation) name `default` is now reserved for the Qiskit built-in plugin of the same name. - -* The default [translation plugin stage](/docs/api/qiskit/transpiler#transpiler-preset-stage-translation) is now `"default"`. In Qiskit 2.0, this is simply an alias for the previous default `"translator"`. The underlying default algorithm may change over the course of the Qiskit 2.x series for some or all targets, but you can always set `translation_method="translator"` explicitly to maintain the current behavior. - -* The deprecated transpiler passes `ASAPSchedule`, `ALAPSchedule`, `DynamicalDecoupling`, and `AlignMeasures` have been removed. These passes were marked as deprecated. They have been replaced by the [`ALAPScheduleAnalysis`](/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis "qiskit.transpiler.passes.ALAPScheduleAnalysis"), [`ASAPScheduleAnalysis`](/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis "qiskit.transpiler.passes.ASAPScheduleAnalysis"), [`PadDynamicalDecoupling`](/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling "qiskit.transpiler.passes.PadDynamicalDecoupling"), and [`ConstrainedReschedule`](/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule "qiskit.transpiler.passes.ConstrainedReschedule") passes respectively which can be used instead. - -* In the case that neither a target nor a set of basis gates are specified, the [`HighLevelSynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") transpiler pass synthesizes circuits with annotated operations with fewer layers of wrappings than before (this happens, for instance, for the circuit produced by [`multiplier_cumulative_h18()`](/docs/api/qiskit/synthesis#qiskit.synthesis.multiplier_cumulative_h18 "qiskit.synthesis.multiplier_cumulative_h18")). - -* The keyword argument `property_set` is now reserved in [`BasePassManager.run()`](/docs/api/qiskit/qiskit.passmanager.BasePassManager#run "qiskit.passmanager.BasePassManager.run"), and cannot be used as a `kwarg` that will be forwarded to the subclass’s conversion from the front-end representation to the internal representation. - -* The following deprecated uses of the `BackendProperties` object in the transpilation pipeline have been removed in Qiskit 2.0: - - * `backend_properties` input argument in [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") - * `backend_properties` input argument in [`PassManagerConfig`](/docs/api/qiskit/qiskit.transpiler.PassManagerConfig "qiskit.transpiler.PassManagerConfig") - * `backend_properties` input argument in [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") - * `backend_properties` input argument in [`generate_routing_passmanager()`](/docs/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_routing_passmanager "qiskit.transpiler.preset_passmanagers.generate_routing_passmanager") - * `backend_properties` input argument in [`generate_translation_passmanager()`](/docs/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_translation_passmanager "qiskit.transpiler.preset_passmanagers.generate_translation_passmanager") - * `backend_properties` input argument [`Target.from_configuration()`](/docs/api/qiskit/qiskit.transpiler.Target#from_configuration "qiskit.transpiler.Target.from_configuration") - - The following passes have also been updated to only accept a `target` instead of: - - * `backend_prop` input argument in [`DenseLayout`](/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout "qiskit.transpiler.passes.DenseLayout") - * `properties` input argument in [`VF2Layout`](/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout") - * `properties` and `coupling_map` input arguments in [`VF2PostLayout`](/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout") - * `backend_props` input argument in [`UnitarySynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") - - The `BackendProperties` class has been deprecated since Qiskit 1.2, as it was part of the BackendV1 workflow. Specific instruction properties such as gate errors or durations can be added to a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") upon construction through the [`Target.add_instruction()`](/docs/api/qiskit/qiskit.transpiler.Target#add_instruction "qiskit.transpiler.Target.add_instruction") method, and communicated to the relevant transpiler passes through the target input argument. - -* As a consequence of the removal of the `BackendV1` model, the accepted input types of the following transpiler objects have been updated: - - > * The [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") and [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") functions no longer accept inputs of type `BackendV1` in their `backend` input argument. - > * The [`Target.from_configuration()`](/docs/api/qiskit/qiskit.transpiler.Target#from_configuration "qiskit.transpiler.Target.from_configuration") method no longer accepts a `backend_properties` argument - > * The `Target.target_to_backend_properties()` method has been removed - -* The [`ResetAfterMeasureSimplification`](/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification "qiskit.transpiler.passes.ResetAfterMeasureSimplification") transpiler pass now will use an [`IfElseOp`](/docs/api/qiskit/qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") to condition the execution of the [`XGate`](/docs/api/qiskit/qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") instead of setting a `condition` attribute on the gate. This is because the `condition` attribute has been removed from the Qiskit data model. - -* The deprecated `ConvertConditionsToIfOps` transpiler pass has been removed. The underlying `condition` attribute of [`Instruction`](/docs/api/qiskit/qiskit.circuit.Instruction "qiskit.circuit.Instruction") class has been removed so this transpiler pass no longer had anything to convert from. Instead you should directly use [`IfElseOp`](/docs/api/qiskit/qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") to classically condition the execution of an operation. - -* The [`PadDelay`](/docs/api/qiskit/qiskit.transpiler.passes.PadDelay "qiskit.transpiler.passes.PadDelay") and [`PadDynamicalDecoupling`](/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling "qiskit.transpiler.passes.PadDynamicalDecoupling") transpiler passes now require a new argument when constructed. Either `target` or `durations` need to be specified with a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") or [`InstructionDurations`](/docs/api/qiskit/qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") respectively. Without these the passes will not be able to determine the duration of instructions in the circuit and will error. Previously these passes would determine these values from the now removed `duration` attribute of [`Instruction`](/docs/api/qiskit/qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects. - -* The previously deprecated argument `propagate_condition` on the [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") methods [`substitute_node_with_dag()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#substitute_node_with_dag "qiskit.dagcircuit.DAGCircuit.substitute_node_with_dag") and [`substitute_node()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#substitute_node "qiskit.dagcircuit.DAGCircuit.substitute_node") has been removed. These arguments were deprecated in Qiskit 1.4.0 and were removed because the larger removal of `Instruction.condition` it no longer served a purpose. - -* The previously deprecated `AlignMeasures` transpiler pass has been removed. This pass was deprecated in Qiskit 1.1.0. Instead the [`ConstrainedReschedule`](/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule "qiskit.transpiler.passes.ConstrainedReschedule") pass should be used. [`ConstrainedReschedule`](/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule "qiskit.transpiler.passes.ConstrainedReschedule") performs the same function and also supports aligning to additional timing constraints. - -* When calling [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") or [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and specifying the `instruction_durations` argument with a list instead of an [`InstructionDurations`](/docs/api/qiskit/qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object and the list specifies durations in units of `dt` a `dt` parameter is required if scheduling the circuit. - -* Removed the deprecated `DAGNode.sort_key` attribute. This attribute was deprecated in the Qiskit 1.4.0 release. As the lexicographical topological sorting is done internally and rust and the sort key attribute was unused this was removed to remove the overhead from DAG node creation. If you were relying on the sort key you can reproduce it from a given node using something like: - - ```python - def get_sort_key(node: DAGNode): - if isinstance(node, (DAGInNode, DAGOutNode)): - return str(node.wire) - return ",".join( - f"{dag.find_bit(q).index:04d}" for q in itertools.chain(node.qargs, node.cargs) - ) - ``` - -* The following [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") input arguments, deprecated since Qiskit 1.3 , have been removed from the API: - - > * instruction\_durations - > * timing\_constraints - - In addition to this, the specification of custom basis gates through the `basis` gate argument of [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager"), also deprecated in Qiskit 1.3, is no longer allowed, and a `ValueError` will be raised in these cases. - - The information formerly provided through these can still be specified via the `backend` or `target` arguments. You can build a Target instance with defined instruction durations doing: - - ```python - Target.from_configuration(..., instruction_durations=...) - ``` - - For specific timing constraints: - - ```python - Target.from_configuration(..., timing_constraints=...) - ``` - - And for custom basis gates, you can manually add them to the target or use `.from_configuration` with a custom name mapping, for example: - - ```python - from qiskit.circuit.library import XGate - from qiskit.transpiler.target import Target - - basis_gates = ["my_x", "cx"] - custom_name_mapping = {"my_x": XGate()} - target = Target.from_configuration( - basis_gates=basis_gates, num_qubits=2, custom_name_mapping=custom_name_mapping - ) - ``` - -* The [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") interfaces now raise a `UserWarning` when providing a `coupling_map` and/or `basis_gates` along with a `backend`. In these cases there are multiple sources of truth, the user intentions are not always clear, and there can be conflicts that [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") may not know how to resolve. In these cases, we highly encourage the creation of a custom target that combines the chosen constraints. - - One of these situations is the specification of a gate with 3 or more qubits in backend or basis\_gates together with a custom coupling map. The coupling map does not provide the necessary connectivity details to be able to determine the action of the gate. In these cases, [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") now raise a `ValueError`. - -* As part of Pulse removal in Qiskit 2.0, all pulse and calibration related functionality in the transpiler has been removed. This includes the following: - - The following passes and function have been removed: - - > * `qiskit.transpiler.passes.PulseGates` pass - > * `qiskit.transpiler.passes.ValidatePulseGates` pass - > * `qiskit.transpiler.passes.RXCalibrationBuilder` pass - > * `qiskit.transpiler.passes.RZXCalibrationBuilder` pass - > * `qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho` pass - > * `qiskit.transpiler.passes.EchoRZXWeylDecomposition` pass - > * `qiskit.transpiler.passes.NoramlizeRXAngle` pass - > * `qiskit.transpiler.passes.rzx_templates()` function - - The `inst_map` argument has been removed from the following elements: - - > * The [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") and [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") functions - > * The [`Target.from_configuration()`](/docs/api/qiskit/qiskit.transpiler.Target#from_configuration "qiskit.transpiler.Target.from_configuration") method - > * The constructor of the [`PassManagerConfig`](/docs/api/qiskit/qiskit.transpiler.PassManagerConfig "qiskit.transpiler.PassManagerConfig") class - - Calibration support has been removed: - - > * `calibration` has been removed from the [`InstructionProperties`](/docs/api/qiskit/qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") ‘s constructor and is no longer a property of that class. - > * The `has_calibration`, `get_calibration`, `instruction_schedule_map` and `update_from_instruction_schedule_map` methods have been removed from the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") class. - -* The deprecated `StochasticSwap` transpiler pass, and its associated built-in routing stage plugin “stochastic”, have been removed. These were marked as deprecated in the Qiskit 1.3.0 release. The pass has been superseded by the [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") which should be used instead as it offers better performance and output quality. For example if the pass was previously invoked via the transpile function such as with: - - ```python - from qiskit import transpile - from qiskit.circuit import QuantumCircuit - from qiskit.transpiler import CouplingMap - from qiskit.providers.fake_provider import GenericBackendV2 - - - qc = QuantumCircuit(4) - qc.h(0) - qc.cx(0, range(1, 4)) - qc.measure_all() - - cmap = CouplingMap.from_heavy_hex(3) - backend = GenericBackendV2(num_qubits=cmap.size(), coupling_map=cmap) - - tqc = transpile( - qc, - routing_method="stochastic", - layout_method="dense", - seed_transpiler=12342, - target=backend.target - ) - ``` - - this should be replaced with: - - ```python - tqc = transpile( - qc, - routing_method="sabre", - layout_method="dense", - seed_transpiler=12342, - target=backend.target - ) - ``` - -* The pass `qiskit.transpiler.passes.CXCancellation` was removed. It was deprecated in favor of class:.InverseCancellation, which is more generic. `CXCancellation` is fully semantically equivalent to `InverseCancellation([CXGate()])`. - -* The [`SolovayKitaev`](/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev "qiskit.transpiler.passes.SolovayKitaev") transpiler pass no longer raises an exception on circuits that contain single-qubit operations without a `to_matrix` method (such as measures, barriers, control-flow operations) or parameterized single-qubit operations, but will leave them unchanged. - -* Plugins for the [translation stage of the preset compiler](/docs/api/qiskit/transpiler#transpiler-preset-stage-translation) are now required to respect gate directionality in the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") in their output. Previously, [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") would generate a [`PassManager`](/docs/api/qiskit/qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") that contained fix-up passes if needed. You must now include these in your own custom stage, if your stage does not guarantee that it respects directionality. - - You can use the [`GateDirection`](/docs/api/qiskit/qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass to perform the same fix-ups that Qiskit used to do. For example: - - ```python - from qiskit.transpiler import PassManager - from qiskit.transpiler.passes import GateDirection - from qiskit.transpiler.preset_passmanagers.plugin import PassManagerStagePlugin - - class YourTranslationPlugin(PassManagerStagePlugin): - def pass_manager(self, pass_manager_config, optimization_level): - pm = PassManager([ - # ... whatever your current setup is ... - ]) - # Add the two-qubit directionality-fixing pass. - pm.append(GateDirection( - pass_manager_config.coupling_map, - pass_manager_config.target, - )) - return pm - ``` - -* The [preset pass managers](/docs/api/qiskit/transpiler#transpiler-preset) no longer populate the implicit `pre_optimization` stage of their output [`StagedPassManager`](/docs/api/qiskit/qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). You can now safely assign your own [`PassManager`](/docs/api/qiskit/qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") to this field. You could previously only append to the existing [`PassManager`](/docs/api/qiskit/qiskit.transpiler.PassManager "qiskit.transpiler.PassManager"). - -* The default value for the [`generate_routing_passmanager()`](/docs/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_routing_passmanager "qiskit.transpiler.preset_passmanagers.generate_routing_passmanager") argument `seed_transpiler` has changed from `None` to `-1`. This was done because this flag was only used to configure the [`VF2PostLayout`](/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout") transpiler pass in the output, and for that pass in particular the randomization typically only hurts performance and is not desirable. If you were relying on the previous default value you can restore this behavior by explicitly setting the argument `seed_transpiler=None`. If you were explicitly setting a seed value for this parameter there is no change in behavior. - - - -### Visualization Upgrade Notes - -* The `idle_wires` parameter in all circuit drawers has been extended with a new option, `"auto"`, which is now the default behavior. If you still want to display wires without instructions, explicitly set `idle_wires=True`. - - When set to `"auto"`, the behavior is as follows: - If the circuit has a defined `.layout` attribute, `idle_wires` is automatically set to `False` (hiding idle wires). - Otherwise, `idle_wires` remains `True` (showing all wires, as previous default). - - Here an example. A circuit without a layout, using `idle_wires="auto"`: - - ```text - qr_0: ──────── - ┌───┐┌─┐ - qr_1: ┤ H ├┤M├ - └───┘└╥┘ - cr_0: ══════╬═ - ║ - cr_1: ══════╩═ - ``` - - Once a layout is applied, `idle_wires="auto"` sets `idle_wires` to `False`, hiding idle wires: - - ```text - ┌───┐┌─┐ - qr_1 -> 1 ┤ H ├┤M├ - └───┘└╥┘ - cr_1: ══════╩═ - ``` - - If you want to display all wires in a laid-out circuit, set `idle_wires=True` explicitly: - - ```text - qr_0 -> 0 ──────── - ┌───┐┌─┐ - qr_1 -> 1 ┤ H ├┤M├ - └───┘└╥┘ - ancilla_0 -> 2 ──────╫─ - ║ - cr_0: ══════╬═ - ║ - cr_1: ══════╩═ - ``` - - As quantum computers scale to more qubits, even small circuits can produce large circuit representations after transpilation. The `"auto"` setting helps improve readability by hiding unnecessary wires when possible. - -* The [`array_to_latex()`](/docs/api/qiskit/qiskit.visualization.array_to_latex "qiskit.visualization.array_to_latex") and [`Operator.draw()`](/docs/api/qiskit/qiskit.quantum_info.Operator#draw "qiskit.quantum_info.Operator.draw") methods can now raise a `MissingOptionalLibrary` exception if the `sympy` library is not installed. In the Qiskit 1.x releases symengine and sympy were always guaranteed to be installed, but starting in 2.x this is no longer a hard requirement. The latex visualization for a matrix relies on the sympy library, so if you’re using this functionality you should ensure that you have sympy installed. - -* As a consequence of the removal of the `BackendV1` model, the [`plot_gate_map()`](/docs/api/qiskit/qiskit.visualization.plot_gate_map "qiskit.visualization.plot_gate_map"), [`plot_error_map()`](/docs/api/qiskit/qiskit.visualization.plot_error_map "qiskit.visualization.plot_error_map") and [`plot_circuit_layout()`](/docs/api/qiskit/qiskit.visualization.plot_circuit_layout "qiskit.visualization.plot_circuit_layout") functions no longer accept inputs of type `BackendV1` in their `backend` input argument. - -* The timeline drawer now requires the target argument is specified when called. As instructions no longer contain duration attributes this extra argument is required to specify the durations for all the supported instructions. Without the argument the timeline drawer does not have access to this information. - -* As part of the Pulse removal in Qiskit 2.0, support for pulse drawing via `qiskit.visualization.pulse_drawer` has been removed. - - - -### Misc. Upgrade Notes - -* The `deprecate_function` and `deprecate_arguments` decorators had been deprecated since 0.24, released on May 2023, and have been removed in 2.0. Current ``deprecate_func`()`` replaces `@deprecate_function` and current `deprecate_arg()` replaces `@deprecate_arguments`. - -* The `assemble` function and related capabilities (contained in the `assembler` module) have been removed from the codebase following their deprecation in Qiskit 1.2. `assemble` was used to generate `Qobj` in the context of the deprecated `BackendV1` workflow. The conversion is no longer necessary as the transpilation and primitives pipeline handles quantum circuits directly, rendering the `Qobj` obsolete. - - The removal includes the following public API components: - - > * `qiskit.compiler.assemble` function - > * `qiskit.assembler.assemble_circuits` function - > * `qiskit.assembler.assemble_schedules` function - > * `qiskit.assembler.disassemble` function - > * `qiskit.assembler.RunConfig` class - > * `qiskit.circuit.Instruction.assemble` method - -* The `Qobj` structure and related classes, deprecated in Qiskit 1.2.0, have been removed. They were introduced as part of the `BackendV1` workflow and are no longer necessary for interacting with [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") backends. This removal includes: - - * `QobjExperimentHeader` - * `QobjHeader` - * `QasmQobj` - * `QasmQobjInstruction` - * `QasmQobjExperimentConfig` - * `QasmQobjExperiment` - * `QasmQobjConfig` - * `QasmExperimentCalibrations` - * `GateCalibration` - * `PulseQobj` - * `PulseQobjInstruction` - * `PulseQobjExperimentConfig` - * `PulseQobjExperiment` - * `PulseQobjConfig` - * `QobjMeasurementOption` - * `PulseLibraryItem` - -* The `MeasLevel` and :class\`.MeasReturnType\` classes, previously defined in `qobj/utils.py`, have been migrated to `result/models.py` following the removal of the `qobj` module. These classes were not part of the public API. The import path has been updated from: `from qiskit.qobj.utils import MeasLevel, MeasReturnType` to: `from qiskit.result import MeasLevel, MeasReturnType`. - -* The use of positional arguments in the constructor of [`Result`](/docs/api/qiskit/qiskit.result.Result "qiskit.result.Result") has been disabled. Please set all arguments using kwarg syntax, i.e: `Result(backend_name="name", ....)`. In addition to this, the `qobj_id` argument will no longer be used in the construction of the [`Result`](/docs/api/qiskit/qiskit.result.Result "qiskit.result.Result") internals. It is still possible to set `qobj_id` as a generic kwarg, which will land in the metadata field with the other generic kwargs. - -* As part of Pulse removal in Qiskit 2.0, the `sequence` and `schedule_circuit` functions from `qiskit.scheduler` together with the `ScheduleConfig` class have been removed. - -* The `qiskit.result.mitigation` module has been removed following its deprecation in Qiskit 1.3. The removal includes the `LocalReadoutMitigator` and `CorrelatedReadoutMitigator` classes as well as the associated utils. - - There is no alternative path in Qiskit, as their functionality had been superseded by the mthree package, found in [https://github.com/Qiskit/qiskit-addon-mthree](https://github.com/Qiskit/qiskit-addon-mthree). - - - - - -### Circuits Deprecations - -* The deprecated [`QuantumCircuit.duration`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#duration "qiskit.circuit.QuantumCircuit.duration") attribute was not removed in this release as originally planned, it will be removed as part of the Qiskit 3.0.0 release instead. This functionality has been superseded by the [`QuantumCircuit.estimate_duration()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#estimate_duration "qiskit.circuit.QuantumCircuit.estimate_duration") method which should be used instead. - -* The Multiple-Control-Multiple-Target in `MCMT` is now deprecated and replaced by [`MCMTGate`](/docs/api/qiskit/qiskit.circuit.library.MCMTGate "qiskit.circuit.library.MCMTGate"), which is a proper [`Gate`](/docs/api/qiskit/qiskit.circuit.Gate "qiskit.circuit.Gate") subclass. Using a gate instead of a circuit allows the compiler to reason about the object at a higher level of abstraction and allows for multiple synthesis plugins. - - - -### Transpiler Deprecations - -* The deprecated [`DAGCircuit.duration`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#duration "qiskit.dagcircuit.DAGCircuit.duration") attribute was not removed in this release as originally planned, it will be removed as part of the Qiskit 3.0.0 release instead. This functionality has been superseded by the [`QuantumCircuit.estimate_duration()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#estimate_duration "qiskit.circuit.QuantumCircuit.estimate_duration") method which should be used instead. - -* The `propagate_condition` argument of [`DAGCircuit.substitute_node()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#substitute_node "qiskit.dagcircuit.DAGCircuit.substitute_node") and [`DAGCircuit.substitute_node_with_dag()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#substitute_node_with_dag "qiskit.dagcircuit.DAGCircuit.substitute_node_with_dag") has been deprecated. With the removal of `Instruction.condition` from the Qiskit data model this option no longer serves a purpose. If it is set it no longer has any effect. It is not removed from the signature to maintain compatibility during the migration from Qiskit 1.x -> 2.0. This option will be removed in Qiskit 3.0. - -* The function [`generate_pre_op_passmanager()`](/docs/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_pre_op_passmanager "qiskit.transpiler.preset_passmanagers.generate_pre_op_passmanager") is deprecated. It is no longer used in the Qiskit preset pass managers, and its purpose is defunct; it originally generated a fix-up stage for translation plugins that did not respect ISA directionality. Translation stages are now required to respect directionality, so the functionality is not needed, and most likely, no replacement is required. - - - - - -### Bug Fixes - -* Fixed a bug where the barrier labels were incorrectly positioned when using the `reverse_bits = True` parameter in the [`QuantumCircuit.draw()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#draw "qiskit.circuit.QuantumCircuit.draw") method. The bug caused the labels on barrier operations to be misaligned, leading to potential confusion in circuit visualizations. Fixed [#13609](https://github.com/Qiskit/qiskit/issues/13609). - -* Fixed an inconsistency in dealing with close-to-identity gates in the transpilation process, where gates that are close to the identity were assumed to commute with everything, but not removed. The underlying issue were different metrics used in [`RemoveIdentityEquivalent`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent "qiskit.transpiler.passes.RemoveIdentityEquivalent") and [`CommutationAnalysis`](/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis "qiskit.transpiler.passes.CommutationAnalysis") (and, by extension, [`CommutativeInverseCancellation`](/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation "qiskit.transpiler.passes.CommutativeInverseCancellation")). Both now use the average gate fidelity and the same threshold to assess whether a gate should be treated as identity (such as a rotation gate with very small angle). See either of the aforementioned classes’ docstrings for more information. Fixed [#13547](https://github.com/Qiskit/qiskit/issues/13547). - -* Applied a small regularisation factor against ill-conditioned Hermitian matrices in super-operator representations. - -* Commutation relations of [`Instruction`](/docs/api/qiskit/qiskit.circuit.Instruction "qiskit.circuit.Instruction")s with float-only `params` were eagerly cached by the [`CommutationChecker`](/docs/api/qiskit/qiskit.circuit.CommutationChecker "qiskit.circuit.CommutationChecker"), using the `params` as key to query the relation. This could lead to faulty results, if the instruction’s definition depended on additional information that just the [`params`](/docs/api/qiskit/qiskit.circuit.Instruction#params "qiskit.circuit.Instruction.params") attribute, such as e.g. the case for [`PauliEvolutionGate`](/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate"). This behavior is now fixed, and the commutation checker only conservatively caches commutations for Qiskit-native standard gates. This can incur a performance cost if you were relying on your custom gates being cached, however, we cannot guarantee safe caching for custom gates, as they might rely on information beyond [`params`](/docs/api/qiskit/qiskit.circuit.Instruction#params "qiskit.circuit.Instruction.params"). - -* Fixed a bug in the `CommmutationChecker`, where checking commutation of instruction with non-numeric values in the [`params`](/docs/api/qiskit/qiskit.circuit.Instruction#params "qiskit.circuit.Instruction.params") attribute (such as the [`PauliGate`](/docs/api/qiskit/qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate")) could raise an error. Fixed [#13570](https://github.com/Qiskit/qiskit/issues/13570). - -* Fixed a bug where calling [`QuantumCircuit.decompose()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#decompose "qiskit.circuit.QuantumCircuit.decompose") on an instruction that had no definition inside a `c_if` block would raise an error. Fixed [#13493](https://github.com/Qiskit/qiskit/issues/13493). - -* Operations inside a control flow (e.g. [`QuantumCircuit.for_loop()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#for_loop "qiskit.circuit.QuantumCircuit.for_loop")) were not correctly decomposed when calling [`QuantumCircuit.decompose()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#decompose "qiskit.circuit.QuantumCircuit.decompose"). This behavior is now fixed and instructions are unrolled. Fixed [#13544](https://github.com/Qiskit/qiskit/issues/13544). - -* Comparisons of [`Delay`](/docs/api/qiskit/circuit#qiskit.circuit.Delay "qiskit.circuit.Delay") instructions, including within circuits, now require the units to be equal as well as the duration value. - -* The [`CommutationChecker`](/docs/api/qiskit/qiskit.circuit.CommutationChecker "qiskit.circuit.CommutationChecker") did not handle commutations of the [`CRXGate`](/docs/api/qiskit/qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"), [`CRYGate`](/docs/api/qiskit/qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate") and [`CRZGate`](/docs/api/qiskit/qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate") correctly for angles $\pi(4k + 2)$ for $k \in \mathbb Z$. In these cases, the controlled rotations were falsely assumed to commute with any gate. Now these gates correctly commute with any gate if the rotation angle is a multiple of $4\pi$. - -* Added default definitions for [`FullAdderGate`](/docs/api/qiskit/qiskit.circuit.library.FullAdderGate "qiskit.circuit.library.FullAdderGate"), [`HalfAdderGate`](/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate "qiskit.circuit.library.HalfAdderGate"), [`ModularAdderGate`](/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate "qiskit.circuit.library.ModularAdderGate") and [`MultiplierGate`](/docs/api/qiskit/qiskit.circuit.library.MultiplierGate "qiskit.circuit.library.MultiplierGate") gates, allowing to contruct [`Operator`](/docs/api/qiskit/qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")s from quantum circuits containing these gates. - -* Fixed the number of clean ancilla qubits required by [`FullAdderSynthesisV95`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisV95 "qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisV95"), [`HalfAdderSynthesisV95`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisV95 "qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisV95"), and [`ModularAdderSynthesisV95`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisV95 "qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisV95") plugins. - -* Added missing [`FullAdderSynthesisDefault`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisDefault "qiskit.transpiler.passes.synthesis.hls_plugins.FullAdderSynthesisDefault") plugin that chooses the best decomposition for [`FullAdderGate`](/docs/api/qiskit/qiskit.circuit.library.FullAdderGate "qiskit.circuit.library.FullAdderGate") based on the number of clean ancilla qubits available. - -* Fixed [`HalfAdderSynthesisDefault`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisDefault "qiskit.transpiler.passes.synthesis.hls_plugins.HalfAdderSynthesisDefault") and [`ModularAdderSynthesisDefault`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisDefault "qiskit.transpiler.passes.synthesis.hls_plugins.ModularAdderSynthesisDefault") plugins, for [`HalfAdderGate`](/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate "qiskit.circuit.library.HalfAdderGate") and [`ModularAdderGate`](/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate "qiskit.circuit.library.ModularAdderGate") respectively, to choose the best decomposition based on the number of clean ancilla qubits available. - -* Fix incorrect behavior in `CircuitData` in which, upon parameter assignment, we attempted to modify the cached operation inside of a `PackedInstruction`. Now we instead discard said cache prompting the `PackedInstruction` to build a new Python operation should it be needed. - -* Fixed a bug in [`QuantumCircuit.assign_parameters()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#assign_parameters "qiskit.circuit.QuantumCircuit.assign_parameters"), occurring when assigning parameters to standard gates whose definition has already been triggered. In this case, the new values were not properly propagated to the gate instances. While the circuit itself was still compiled as expected, inspecting the individual operations would still show the old parameter. - - For example: - - ```python - from qiskit.circuit.library import EfficientSU2 - - circuit = EfficientSU2(2, flatten=True) - circuit.assign_parameters([1.25] * circuit.num_parameters, inplace=True) - print(circuit.data[0].operation.params) # would print θ[0] instead of 1.25 - ``` - - Fixed [#13478](https://github.com/Qiskit/qiskit/issues/13478). - -* Fixed a bug in the [`CommutationChecker`](/docs/api/qiskit/qiskit.circuit.CommutationChecker "qiskit.circuit.CommutationChecker") which could fail upon checking the commutation relation of a two-qubit Pauli rotation with a gate that is not in the commutation cache. For example: - - ```python - import numpy as np - from qiskit.circuit.library import RXXGate, RGate - from qiskit.circuit.commutation_library import SessionCommutationChecker as scc - - res = scc.commute(RGate(2, 2), [1], [], RXXGate(np.pi / 2), [0, 1], []) - ``` - - This behavior is now resolved and the commutation relation correctly computed. Fixed [#13742](https://github.com/Qiskit/qiskit/issues/13742). - -* Fixed a bug that caused the circuit library functions [`efficient_su2()`](/docs/api/qiskit/qiskit.circuit.library.efficient_su2 "qiskit.circuit.library.efficient_su2"), [`real_amplitudes()`](/docs/api/qiskit/qiskit.circuit.library.real_amplitudes "qiskit.circuit.library.real_amplitudes"), [`excitation_preserving()`](/docs/api/qiskit/qiskit.circuit.library.excitation_preserving "qiskit.circuit.library.excitation_preserving") and [`pauli_two_design()`](/docs/api/qiskit/qiskit.circuit.library.pauli_two_design "qiskit.circuit.library.pauli_two_design") to error out when constructed for `num_qubits==1`. For a single qubit these circuits will not contain any 2-qubit gates. - -* Fixed a series of bugs when processing circuit with parameterized global phases, where upon assignment the global phase was not correctly assigned. Known cases this affected include: - - * assigning parameters after calling [`QuantumCircuit.decompose()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#decompose "qiskit.circuit.QuantumCircuit.decompose") on a circuit, where the decomposition introduces a global phase - * assigning parameters on a circuit constructed from a DAG via [`dag_to_circuit()`](/docs/api/qiskit/converters#qiskit.converters.dag_to_circuit "qiskit.converters.dag_to_circuit") - * assigning parameters on circuits created with [`pauli_twirl_2q_gates()`](/docs/api/qiskit/circuit#qiskit.circuit.pauli_twirl_2q_gates "qiskit.circuit.pauli_twirl_2q_gates"), where the circuit to be twirled had a parameterized global phase - - Fixed [#13534](https://github.com/Qiskit/qiskit/issues/13534). - -* Previously the [`HighLevelSynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") transpiler pass synthesized an instruction for which a synthesis plugin is available, regardless of whether the instruction is already supported by the target or a part of the explicitly passed `basis_gates`. This behavior is now fixed, so that such already supported instructions are no longer synthesized. - -* An issue where [`QuantumCircuit.qubit_stop_time()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#qubit_stop_time "qiskit.circuit.QuantumCircuit.qubit_stop_time") and [`QuantumCircuit.qubit_duration()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#qubit_duration "qiskit.circuit.QuantumCircuit.qubit_duration") returned incorrect time (duration) was fixed. It was triggered when some qubits have instructions but other qubits are idle. Fixes [#8729](https://github.com/Qiskit/qiskit/issues/8729). - -* The transpilation pass [`InverseCancellation`](/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation "qiskit.transpiler.passes.InverseCancellation") now runs inside of flow controlled blocks. Previously, it ignored the pairs of gates in classical blocks that could be cancelled. Refer to [#13437](https://github.com/Qiskit/qiskit/issues/13437) for more details. - -* Fixed a bug where any instruction called `"mcmt"` would be passed into the high-level synthesis routine for a [`MCMTGate`](/docs/api/qiskit/qiskit.circuit.library.MCMTGate "qiskit.circuit.library.MCMTGate"), which causes a failure or invalid result. In particular, this could happen accidentally when handling the [`MCMT`](/docs/api/qiskit/qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT") \_circuit\_, named `"mcmt"`, and implicitly converting it into an instruction e.g. when appending it to a circuit. Fixed [#13563](https://github.com/Qiskit/qiskit/issues/13563). - -* Fixed a bug in [`RZGate.control()`](/docs/api/qiskit/qiskit.circuit.library.RZGate#control "qiskit.circuit.library.RZGate.control") for more than 1 control qubit, which used an unnecessarily expensive decomposition. Fixed [#13473](https://github.com/Qiskit/qiskit/issues/13473). - -* Fixed a bug in the basis approximation generation for [`SolovayKitaev`](/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev "qiskit.transpiler.passes.SolovayKitaev"). Previously, generating discrete basis approximations using `generate_basis_approximations` for a basis containing `"sx"` or `"sxdg"` gates would fail. This has now been fixed. - -* Fix a bug in the multi-controlled rotation circuit methods [`QuantumCircuit.mcrx()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#mcrx "qiskit.circuit.QuantumCircuit.mcrx"), [`QuantumCircuit.mcry()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#mcry "qiskit.circuit.QuantumCircuit.mcry"), and [`QuantumCircuit.mcrz()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#mcrz "qiskit.circuit.QuantumCircuit.mcrz"), when the user provides an unbounded parameter, as well as when calling [`RXGate.control()`](/docs/api/qiskit/qiskit.circuit.library.RXGate#control "qiskit.circuit.library.RXGate.control"), [`RYGate.control()`](/docs/api/qiskit/qiskit.circuit.library.RYGate#control "qiskit.circuit.library.RYGate.control") or [`RZGate.control()`](/docs/api/qiskit/qiskit.circuit.library.RZGate#control "qiskit.circuit.library.RZGate.control") where the rotation angle is a [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression"). Previously, the user got an error that this gate cannot be synthesized with unbound parameter, and now these multi-controlled rotation circuits can be synthesized without raising an error. - -* The [`PauliEvolutionGate`](/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate"), if used with a product formula synthesis (this is the default), did not correctly handle all-identity terms in the operator. The all-identity term should introduce a global phase equal to `-evolution_time`, but was off by a factor of 2 and could break for parameterized times. This behavior is now fixed. Fixed [#13625](https://github.com/Qiskit/qiskit/issues/13625). - -* Fixed an inconsistency in the circuit generated by a Pauli evolution synthesis with [`SuzukiTrotter`](/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter "qiskit.synthesis.SuzukiTrotter") or [`LieTrotter`](/docs/api/qiskit/qiskit.synthesis.LieTrotter "qiskit.synthesis.LieTrotter") (the default) method. For parameterized evolution times, the resulting circuits contained parameters with a spurious, zero complex part, which affected the output of [`ParameterExpression.sympify()`](/docs/api/qiskit/qiskit.circuit.ParameterExpression#sympify "qiskit.circuit.ParameterExpression.sympify"). The output now correctly is only real. Fixed [#13642](https://github.com/Qiskit/qiskit/pull/13642). - -* Fixed a bug that caused [`PauliList.insert()`](/docs/api/qiskit/qiskit.quantum_info.PauliList#insert "qiskit.quantum_info.PauliList.insert") with `qubit=True` to produce a phase attribute with the wrong shape when the original object was length 1. Fixed [#13623](https://github.com/Qiskit/qiskit/issues/13623). - -* Fixed a bug in the [`RemoveIdentityEquivalent`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent "qiskit.transpiler.passes.RemoveIdentityEquivalent") transpiler pass, where gates close to identity up to a global phase were removed from the circuit, but the global phase of the circuit was not updated. In particular, [`RemoveIdentityEquivalent`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent "qiskit.transpiler.passes.RemoveIdentityEquivalent") now removes non-parameterized [`GlobalPhaseGate`](/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate "qiskit.circuit.library.GlobalPhaseGate") gates. - -* Circuits compiled using a preset passmanager constructed by [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") will now correctly retain their [`name`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#name "qiskit.circuit.QuantumCircuit.name") attribute, as they do with [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). - -* Fix a bug in [`qasm3.Exporter`](/docs/api/qiskit/qasm3#qiskit.qasm3.Exporter "qiskit.qasm3.Exporter") that caused the exporter to crash when handling a unitary gate due to incorrect processing of its `params` field. - -* Fixed a bug in [`random_clifford()`](/docs/api/qiskit/quantum_info#qiskit.quantum_info.random_clifford "qiskit.quantum_info.random_clifford") that stopped it from sampling the full Clifford group. - -* Fixed a bug in the [`Target.instruction_supported()`](/docs/api/qiskit/qiskit.transpiler.Target#instruction_supported "qiskit.transpiler.Target.instruction_supported") method where targets with `self.num_qubits==None` would always return `false` independently of the supported basis set. - -* Fixed a bug in the [`UnitarySynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") transpiler pass, where blocks of [`UnitaryGate`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate")s on 3 qubits or more were not correctly synthesized. This led, e.g., to the circuit being overwritten with the last processed block or to internal panics when encountering measurements after such a block. Fixed [#13586](https://github.com/Qiskit/qiskit/issues/13586). - -* Fixed a bug in the [`UnitarySynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis") transpiler pass where non-2-qubit gates would be included in the available 2 qubit basis, causing the `TwoQubitWeylDecomposition` to panic because of the dimension mismatch. - -* Fixed a bug that caused [`Statevector.expectation_value()`](/docs/api/qiskit/qiskit.quantum_info.Statevector#expectation_value "qiskit.quantum_info.Statevector.expectation_value") to yield incorrect results for the identity operator when the statevector was not normalized. - -* Calling an [`AnalysisPass`](/docs/api/qiskit/qiskit.transpiler.AnalysisPass "qiskit.transpiler.AnalysisPass") or a [`TransformationPass`](/docs/api/qiskit/qiskit.transpiler.TransformationPass "qiskit.transpiler.TransformationPass") like a function (as in `pass_ = MyPass(); pass_(qc)`) will now respect any requirements that the pass might have. For example, scheduling passes such as [`ALAPScheduleAnalysis`](/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis "qiskit.transpiler.passes.ALAPScheduleAnalysis") require that [`TimeUnitConversion`](/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion "qiskit.transpiler.passes.TimeUnitConversion") runs before them. Running the pass via a [`PassManager`](/docs/api/qiskit/qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") always respected this requirement, but until this note, it was not respected by calling the pass directly. - -* When a [`TranspilerError`](/docs/api/qiskit/transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") subclass is raised by a pass inside a call to `PassManger.run()`, the exception will now be propagated through losslessly, rather than becoming a chained exception with an erased type. - -* [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") will no longer contract idle qubit wires out of control-flow blocks during routing. This was generally a valid optimization, but not an expected side effect of a routing pass. You can now use the [`ContractIdleWiresInControlFlow`](/docs/api/qiskit/qiskit.transpiler.passes.ContractIdleWiresInControlFlow "qiskit.transpiler.passes.ContractIdleWiresInControlFlow") pass to perform this contraction. - -* When [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") is used to do both layout and routing simultaneously (as is the case for the default options to [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager")) on a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") or [`CouplingMap`](/docs/api/qiskit/qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") with disjoint connectivity, and the input circuit fits into a single component of the coupling map, the routing permutation will now be tracked correctly. - - Previously, any qubits in the coupling map that were not connected, even indirectly, to a qubit used by the routed circuit would not be included in the final routing permutation. This could cause surprising behaviour a long way from the point of failure, even if compilation appeared to succeed, such as calls to [`TranspileLayout.final_index_layout()`](/docs/api/qiskit/qiskit.transpiler.TranspileLayout#final_index_layout "qiskit.transpiler.TranspileLayout.final_index_layout") raising [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.13)"). - - This bug did not affect backends that were fully connected, as most are. - -* Fixed a bug where a initializing [`SparsePauliOp`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") with a large number of Pauli-`Y` terms (typically $\geq 100$) and no explicit `coeffs` would result in a coefficient close to 1 but with a floating point error. The coefficient is now correctly 1 per default. Fixed [#13522](https://github.com/Qiskit/qiskit/issues/13522). - -* Fixed a per-process based non-determinism in SparsePauliOp.to\_matrix. The exact order of the floating-point operations in the summation would previously vary per process, but will now be identical between different invocations of the same script. See [#13413](https://github.com/Qiskit/qiskit/issues/13413). - - - - - -## 1.3.0rc1 - - - - - -### New Features - -* Support for level 1 data was added to [`BackendSamplerV2`](/docs/api/qiskit/qiskit.primitives.BackendSamplerV2 "qiskit.primitives.BackendSamplerV2") as was support for passing options through to the `run()` method of the wrapped [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). The run options can be specified using a `"run_options"` entry inside of the `options` dicitonary passed to [`BackendSamplerV2`](/docs/api/qiskit/qiskit.primitives.BackendSamplerV2 "qiskit.primitives.BackendSamplerV2"). The `"run_options"` entry should be a dictionary mapping argument names to values for passing to the backend’s `run()` method. When a `"meas_level"` option with a value of 1 is set in the run options, the results from the backend will be treated as level 1 results rather as bit arrays (the level 2 format). - - - - - -### Circuits Features - -* Improved the functionality of [`CommutationChecker`](/docs/api/qiskit/qiskit.circuit.CommutationChecker "qiskit.circuit.CommutationChecker") to include support for the following parameterized gates with free parameters: [`RXXGate`](/docs/api/qiskit/qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"),:class:.RYYGate,:class:.RZZGate,:class:.RZXGate, [`RXGate`](/docs/api/qiskit/qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"),:class:.RYGate,:class:.RZGate,:class:.PhaseGate, [`U1Gate`](/docs/api/qiskit/qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"),:class:.CRXGate,:class:.CRYGate,:class:.CRZGate, [`CPhaseGate`](/docs/api/qiskit/qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). - - Before these were only supported with bound parameters. - -* Added a new function [`quantum_volume()`](/docs/api/qiskit/qiskit.circuit.library.quantum_volume "qiskit.circuit.library.quantum_volume") for generating a quantum volume [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as defined in A. Cross et al. Validating quantum computers using randomized model circuits, Phys. Rev. A 100, 032328 (2019) [https://link.aps.org/doi/10.1103/PhysRevA.100.032328](https://link.aps.org/doi/10.1103/PhysRevA.100.032328). This new function differs from the existing [`QuantumVolume`](/docs/api/qiskit/qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume") class in that it returns a [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object instead of building a subclass object. The second is that this new function is multithreaded and implemented in rust so it generates the output circuit \~10x faster than the [`QuantumVolume`](/docs/api/qiskit/qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume") class. - -* Improved the runtime performance of constructing the [`QuantumVolume`](/docs/api/qiskit/qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume") class with the `classical_permutation` argument set to `True`. Internally it now calls the [`quantum_volume()`](/docs/api/qiskit/qiskit.circuit.library.quantum_volume "qiskit.circuit.library.quantum_volume") function which is written in Rust which is \~10x faster to generate a quantum volume circuit. - -* Added a new circuit manipulation function [`pauli_twirl_2q_gates()`](/docs/api/qiskit/circuit#qiskit.circuit.pauli_twirl_2q_gates "qiskit.circuit.pauli_twirl_2q_gates") that can be used to apply Pauli twirling to a given circuit. This only works for twirling a fixed set of two-qubit gates, currently [`CXGate`](/docs/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`ECRGate`](/docs/api/qiskit/qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"), [`CZGate`](/docs/api/qiskit/qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"), [`iSwapGate`](/docs/api/qiskit/qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). For example: - - ```python - from qiskit.circuit import QuantumCircuit, pauli_twirl_2q_gates - - qc = QuantumCircuit(2) - qc.cx(0, 1) - twirled_circuit = pauli_twirl_2q_gates(qc, seed=123456) - twirled_circuit.draw("mpl") - ``` - - ![\_images/release\_notes-5.png](/docs/images/api/qiskit/release_notes-5.avif) - -* Added binary arithmetic gates for inplace addition two $n$-qubit registers, that is $|a\rangle |b\rangle \mapsto |a\rangle |a+b\rangle$. The [`ModularAdderGate`](/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate "qiskit.circuit.library.ModularAdderGate") implements addition modulo $2^n$, the `AdderGate` implements standard addition including a carry-out, and the [`FullAdderGate`](/docs/api/qiskit/qiskit.circuit.library.FullAdderGate "qiskit.circuit.library.FullAdderGate") includes a carry-in qubit. See the respective documentations for details and examples. - - In contrast to the existing library circuits, such as [`CDKMRippleCarryAdder`](/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder "qiskit.circuit.library.CDKMRippleCarryAdder"), handling the abstract gate allows the compiler (or user) to select the optimal gate synthesis, depending on the circuit’s context. - -* Added the [`MultiplierGate`](/docs/api/qiskit/qiskit.circuit.library.MultiplierGate "qiskit.circuit.library.MultiplierGate") for multiplication of two $n$-qubit registers, that is $|a\rangle |b\rangle \mapsto |a\rangle |b\rangle |a \cdot b\rangle$. See the class documentations for details and examples. - -* Quantum circuits in `qiskit.circuit.library.boolean_logic` now have equivalent representations as [`Gate`](/docs/api/qiskit/qiskit.circuit.Gate "qiskit.circuit.Gate") objects: - - * [`AndGate`](/docs/api/qiskit/qiskit.circuit.library.AndGate "qiskit.circuit.library.AndGate"), representing [`AND`](/docs/api/qiskit/qiskit.circuit.library.AND "qiskit.circuit.library.AND"), - * [`OrGate`](/docs/api/qiskit/qiskit.circuit.library.OrGate "qiskit.circuit.library.OrGate"), representing [`OR`](/docs/api/qiskit/qiskit.circuit.library.OR "qiskit.circuit.library.OR"), - * [`BitwiseXorGate`](/docs/api/qiskit/qiskit.circuit.library.BitwiseXorGate "qiskit.circuit.library.BitwiseXorGate"), representing [`XOR`](/docs/api/qiskit/qiskit.circuit.library.XOR "qiskit.circuit.library.XOR"), - * [`InnerProductGate`](/docs/api/qiskit/qiskit.circuit.library.InnerProductGate "qiskit.circuit.library.InnerProductGate"), representing [`InnerProduct`](/docs/api/qiskit/qiskit.circuit.library.InnerProduct "qiskit.circuit.library.InnerProduct"). - -* Specialized implementations of [`__eq__()`](https://docs.python.org/3/reference/datamodel.html#object.__eq__ "(in Python v3.13)") have been added for all standard-library circuit gates. Most of the standard gates already specialized this method, but a few did not, and could cause significant slowdowns in unexpected places. - -* Added [`evolved_operator_ansatz()`](/docs/api/qiskit/qiskit.circuit.library.evolved_operator_ansatz "qiskit.circuit.library.evolved_operator_ansatz"), [`hamiltonian_variational_ansatz()`](/docs/api/qiskit/qiskit.circuit.library.hamiltonian_variational_ansatz "qiskit.circuit.library.hamiltonian_variational_ansatz"), and [`qaoa_ansatz()`](/docs/api/qiskit/qiskit.circuit.library.qaoa_ansatz "qiskit.circuit.library.qaoa_ansatz") to the circuit library to implement variational circuits based on operator evolutions. [`evolved_operator_ansatz()`](/docs/api/qiskit/qiskit.circuit.library.evolved_operator_ansatz "qiskit.circuit.library.evolved_operator_ansatz") and [`qaoa_ansatz()`](/docs/api/qiskit/qiskit.circuit.library.qaoa_ansatz "qiskit.circuit.library.qaoa_ansatz") are functionally equivalent to [`EvolvedOperatorAnsatz`](/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.EvolvedOperatorAnsatz") and [`QAOAAnsatz`](/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz "qiskit.circuit.library.QAOAAnsatz"), but generally more performant. - - The [`hamiltonian_variational_ansatz()`](/docs/api/qiskit/qiskit.circuit.library.hamiltonian_variational_ansatz "qiskit.circuit.library.hamiltonian_variational_ansatz") is designed to take a single Hamiltonian and automatically split it into commuting terms to implement a Hamiltonian variational ansatz. This could already be achieved manually by using the [`EvolvedOperatorAnsatz`](/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.EvolvedOperatorAnsatz"), but is now more convenient to use. - -* Added [`grover_operator()`](/docs/api/qiskit/qiskit.circuit.library.grover_operator "qiskit.circuit.library.grover_operator") to construct a Grover operator circuit, used in e.g. Grover’s algorithm and amplitude estimation/amplification. This function is similar to [`GroverOperator`](/docs/api/qiskit/qiskit.circuit.library.GroverOperator "qiskit.circuit.library.GroverOperator"), but does not require choosing the implementation of the multi-controlled X gate a-priori and let’s the compiler choose the optimal decomposition instead. In addition to this, it does not wrap the circuit into an opaque gate and is faster as less decompositions are required to transpile. - - Example: - - ```python - from qiskit.circuit import QuantumCircuit - from qiskit.circuit.library import grover_operator - - oracle = QuantumCircuit(2) - oracle.z(0) # good state = first qubit is |1> - grover_op = grover_operator(oracle, insert_barriers=True) - print(grover_op.draw()) - ``` - -* Added a new argument `"apply_synthesis"` to [`Decompose`](/docs/api/qiskit/qiskit.transpiler.passes.Decompose "qiskit.transpiler.passes.Decompose"), which allows the transpiler pass to apply high-level synthesis to decompose objects that are only defined by a synthesis routine. For example: - - ```python - from qiskit import QuantumCircuit - from qiskit.quantum_info import Clifford - from qiskit.transpiler.passes import Decompose - - cliff = Clifford(HGate()) - circuit = QuantumCircuit(1) - circuit.append(cliff, [0]) - - # Clifford has no .definition, it is only defined by synthesis - nothing_happened = Decompose()(circuit) - - # this internally runs the HighLevelSynthesis pass to decompose the Clifford - decomposed = Decompose(apply_synthesis=True)(circuit) - ``` - -* Added the [`iqp()`](/docs/api/qiskit/qiskit.circuit.library.iqp_function#qiskit.circuit.library.iqp "qiskit.circuit.library.iqp") function to construct Instantaneous Quantum Polynomial time (IQP) circuits. In addition to the existing [`IQP`](/docs/api/qiskit/qiskit.circuit.library.IQP "qiskit.circuit.library.IQP") class, the function also allows construction of random IQP circuits: - - ```python - from qiskit.circuit.library import iqp - - random_iqp = iqp(num_qubits=4) - print(random_iqp.draw()) - ``` - -* Added the [`MCMTGate`](/docs/api/qiskit/qiskit.circuit.library.MCMTGate "qiskit.circuit.library.MCMTGate") to represent a multi-control multi-target operation as a gate. This gate representation of the existing [`MCMT`](/docs/api/qiskit/qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT") circuit allows the compiler to select the best available implementation according to the number and the state of auxiliary qubits present in the circuit. - - Specific implementation can be chosen by specifying the high-level synthesis plugin: - - ```python - from qiskit import QuantumCircuit, transpile - from qiskit.circuit.library import MCMTGate, HGate - from qiskit.transpiler.passes import HLSConfig # used for the synthesis config - - mcmt = MCMTGate(HGate(), num_ctrl_qubits=5, num_target_qubits=3) - - circuit = QuantumCircuit(20) - circuit.append(mcmt, range(mcmt.num_qubits)) - - config = HLSConfig(mcmt=["vchain"]) # alternatively use the "noaux" method - synthesized = transpile(circuit, hls_config=config) - ``` - - The [`MCMTGate`](/docs/api/qiskit/qiskit.circuit.library.MCMTGate "qiskit.circuit.library.MCMTGate") in addition also supports custom (i.e., open) control states of the control qubits. - -* As a part of circuit library modernization, each of the following quantum circuits is either also represented as a [`Gate`](/docs/api/qiskit/qiskit.circuit.Gate "qiskit.circuit.Gate") object or can be constructed using a synthesis method: - - * [`GraphState`](/docs/api/qiskit/qiskit.circuit.library.GraphState "qiskit.circuit.library.GraphState") is represented by [`GraphStateGate`](/docs/api/qiskit/qiskit.circuit.library.GraphStateGate "qiskit.circuit.library.GraphStateGate"), - * [`FourierChecking`](/docs/api/qiskit/qiskit.circuit.library.FourierChecking "qiskit.circuit.library.FourierChecking") can be constructed using `fourier_checking()`, - * [`UnitaryOverlap`](/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap "qiskit.circuit.library.UnitaryOverlap") can be constructed using `unitary_overlap()`, - * [`HiddenLinearFunction`](/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction "qiskit.circuit.library.HiddenLinearFunction") can be constructed using `hidden_linear_function()`, - * [`PhaseEstimation`](/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation "qiskit.circuit.library.PhaseEstimation") can be constructed using `phase_estimation()`. - -* Added circuit library functions [`pauli_feature_map()`](/docs/api/qiskit/qiskit.circuit.library.pauli_feature_map "qiskit.circuit.library.pauli_feature_map"), [`z_feature_map()`](/docs/api/qiskit/qiskit.circuit.library.z_feature_map "qiskit.circuit.library.z_feature_map"), [`zz_feature_map()`](/docs/api/qiskit/qiskit.circuit.library.zz_feature_map "qiskit.circuit.library.zz_feature_map") to construct Pauli feature map circuits. These functions are approximately 8x faster than the current circuit library objects, [`PauliFeatureMap`](/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap"), [`ZFeatureMap`](/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap "qiskit.circuit.library.ZFeatureMap"), and [`ZZFeatureMap`](/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap"), and will replace them in the future. Note, that the new functions return a plain [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") instead of a `BlueprintCircuit`. - - The functions can be used as drop-in replacement: - - ```python - from qiskit.circuit.library import pauli_feature_map, PauliFeatureMap - - fm = pauli_feature_map(20, paulis=["z", "xx", "yyy"]) - also_fm = PauliFeatureMap(20, paulis=["z", "xx", "yyy"]).decompose() - ``` - - - - - -### OpenQASM Features - -* The class [`qasm3.CustomGate`](/docs/api/qiskit/qasm3#qiskit.qasm3.CustomGate "qiskit.qasm3.CustomGate") is now inspectable programmatically. Its [`constructor`](/docs/api/qiskit/qasm3#qiskit.qasm3.CustomGate.constructor "qiskit.qasm3.CustomGate.constructor"), [`name`](/docs/api/qiskit/qasm3#qiskit.qasm3.CustomGate.name "qiskit.qasm3.CustomGate.name"), [`num_params`](/docs/api/qiskit/qasm3#qiskit.qasm3.CustomGate.num_params "qiskit.qasm3.CustomGate.num_params") and [`num_qubits`](/docs/api/qiskit/qasm3#qiskit.qasm3.CustomGate.num_qubits "qiskit.qasm3.CustomGate.num_qubits") can now be viewed from Python after the object has been constructed. This allows you to inspect the contents of provided data attributes like [`STDGATES_INC_GATES`](/docs/api/qiskit/qasm3#qiskit.qasm3.STDGATES_INC_GATES "qiskit.qasm3.STDGATES_INC_GATES"). - - - - - -### QPY Features - -* Added a new QPY format version 13 that adds a Qiskit native representation of [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects. - - - - - -### Quantum Information Features - -* The performance of [`SparsePauliOp.from_operator()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#from_operator "qiskit.quantum_info.SparsePauliOp.from_operator") has been optimized on top of the algorithm improvements methods introduced in Qiskit 1.0. It is now approximately five times faster than before for fully dense matrices, taking approximately 40ms to decompose a 10q operator involving all Pauli terms. - -* Added a new argument `assume_unitary` to [`qiskit.quantum_info.Operator.power()`](/docs/api/qiskit/qiskit.quantum_info.Operator#power "qiskit.quantum_info.Operator.power"). When `True`, we use a faster method based on Schur’s decomposition to raise an `Operator` to a fractional power. - -* Added `SparsePauliOperator.to_sparse_list()` to convert an operator into a sparse list format. This works inversely to `SparsePauliOperator.from_sparse_list()`. For example: - - ```python - from qiskit.quantum_info import SparsePauliOp - - op = SparsePauliOp(["XIII", "IZZI"], coeffs=[1, 2]) - sparse = op.to_sparse_list() # [("X", [3], 1), ("ZZ", [1, 2], 2)] - - other = SparsePauliOp.from_sparse_list(sparse, op.num_qubits) - print(other == op) # True - ``` - -* The performance of [`Pauli.to_label()`](/docs/api/qiskit/qiskit.quantum_info.Pauli#to_label "qiskit.quantum_info.Pauli.to_label") has significantly improved for large Paulis. - -* The method [`Operator.power()`](/docs/api/qiskit/qiskit.quantum_info.Operator#power "qiskit.quantum_info.Operator.power") has a new parameter `branch_cut_rotation`. This can be used to shift the branch-cut point of the root around, which can affect which matrix is chosen as the principal root. By default, it is set to a small positive rotation to make roots of operators with a real-negative eigenvalue (like Pauli operators) more stable against numerical precision differences. - -* A new observable class has been added. [`SparseObservable`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") represents observables as a sum of terms, similar to [`SparsePauliOp`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"), but with two core differences: - - 1. Each complete term is stored as (effectively) a series of `(qubit, bit_term)` pairs, without storing qubits that undergo the identity for that term. This significantly improves the memory usage of observables such as the weighted sum of Paulis $\sum_i c_i Z_i$. - 2. The single-qubit term alphabet is overcomplete for the operator space; it can represent Pauli operators (like [`SparsePauliOp`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")), but also projectors onto the eigenstates of the Pauli operators, like $\lvert 0\rangle\langle 0\rangle$. Such projectors can be measured on hardware equally as efficiently as their corresponding Pauli operator, but [`SparsePauliOp`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") would require an exponential number of terms to represent ${\lvert0\rangle\langle0\rvert}^{\otimes n}$ over $n$ qubits, while [`SparseObservable`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") needs only a single term. - - You can construct and manipulate [`SparseObservable`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") using an interface familiar to users of [`SparsePauliOp`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"): - - ```python - from qiskit.quantum_info import SparseObservable - - obs = SparseObservable.from_sparse_list([ - ("XZY", (2, 1, 0), 1.5j), - ("+-", (100, 99), 0.5j), - ("01", (50, 49), 0.5), - ]) - ``` - - [`SparseObservable`](/docs/api/qiskit/qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") is not currently supported as an input format to the primitives ([`qiskit.primitives`](/docs/api/qiskit/primitives#module-qiskit.primitives "qiskit.primitives")), but we expect to expand these interfaces to include them in the future. - - - - - -### Synthesis Features - -* Added [`adder_qft_d00()`](/docs/api/qiskit/synthesis#qiskit.synthesis.adder_qft_d00 "qiskit.synthesis.adder_qft_d00"), [`adder_ripple_c04()`](/docs/api/qiskit/synthesis#qiskit.synthesis.adder_ripple_c04 "qiskit.synthesis.adder_ripple_c04"), and [`adder_ripple_v95()`](/docs/api/qiskit/synthesis#qiskit.synthesis.adder_ripple_v95 "qiskit.synthesis.adder_ripple_v95") to synthesize the adder gates, [`ModularAdderGate`](/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate "qiskit.circuit.library.ModularAdderGate"), `AdderGate`, and [`FullAdderGate`](/docs/api/qiskit/qiskit.circuit.library.FullAdderGate "qiskit.circuit.library.FullAdderGate"). - -* Added [`multiplier_cumulative_h18()`](/docs/api/qiskit/synthesis#qiskit.synthesis.multiplier_cumulative_h18 "qiskit.synthesis.multiplier_cumulative_h18") and [`multiplier_qft_r17()`](/docs/api/qiskit/synthesis#qiskit.synthesis.multiplier_qft_r17 "qiskit.synthesis.multiplier_qft_r17") to synthesize the [`MultiplierGate`](/docs/api/qiskit/qiskit.circuit.library.MultiplierGate "qiskit.circuit.library.MultiplierGate"). - -* Added [`synth_mcmt_vchain()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcmt_vchain "qiskit.synthesis.synth_mcmt_vchain") to synthesize the multi-control multi-target gate with a linear number of Toffoli gates and k-1 auxiliary qubits for k control qubits, along with the high-level synthesis plugin [`MCMTSynthesisVChain`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisVChain "qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisVChain"). - -* Added a high-level synthesis plugin structure for the [`MCMTGate`](/docs/api/qiskit/qiskit.circuit.library.MCMTGate "qiskit.circuit.library.MCMTGate"), including the [`MCMTSynthesisNoAux`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisNoAux "qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisNoAux") (for no auxiliary qubits), the aforementioned [`MCMTSynthesisVChain`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisVChain "qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisVChain") (using `num_control - 1` auxiliary qubits), and the [`MCMTSynthesisDefault`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisDefault "qiskit.transpiler.passes.synthesis.hls_plugins.MCMTSynthesisDefault") to let the compiler choose the optimal decomposition. - -* Added [`ProductFormula.expand()`](/docs/api/qiskit/qiskit.synthesis.ProductFormula#expand "qiskit.synthesis.ProductFormula.expand") which allows to view the expansion of a product formula in a sparse Pauli format. - -* Added the plugin structure for the [`PauliEvolutionGate`](/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate"). The default plugin, [`PauliEvolutionSynthesisDefault`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisDefault "qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisDefault"), constructs circuit as before, but faster as it internally uses Rust. The larger the circuit (e.g. by the Hamiltonian size, the number of timesteps, or the Suzuki-Trotter order), the higher the speedup. For example, a 100-qubit Heisenberg Hamiltonian with 10 timesteps and a 4th-order Trotter formula is now constructed \~9.4x faster. The new plugin, [`PauliEvolutionSynthesisRustiq`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisRustiq "qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisRustiq"), uses the synthesis algorithm that is described in the paper “Faster and shorter synthesis of Hamiltonian simulation circuits” by de Brugière and Martiel ([https://arxiv.org/abs/2404.03280](https://arxiv.org/abs/2404.03280)) and is implemented in [https://github.com/smartiel/rustiq-core](https://github.com/smartiel/rustiq-core). For example: - - ```python - from qiskit.circuit import QuantumCircuit - from qiskit.quantum_info import SparsePauliOp - from qiskit.circuit.library import PauliEvolutionGate - from qiskit.compiler import transpile - from qiskit.transpiler.passes import HLSConfig - - op = SparsePauliOp(["XXX", "YYY", "IZZ"]) - qc = QuantumCircuit(4) - qc.append(PauliEvolutionGate(op), [0, 1, 3]) - config = HLSConfig(PauliEvolution=[("rustiq", {"upto_phase": False})]) - tqc = transpile(qc, basis_gates=["cx", "u"], hls_config=config) - tqc.draw(output='mpl') - ``` - - This code snippet uses the `"rustiq"` plugin to synthesize [`PauliEvolutionGate`](/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate") objects in the quantum circuit qc. The plugin is called with the additional option `"upto_phase" = False` allowing to obtain smaller circuits at the expense of possibly not preserving the global phase. For the full list of supported options, see documentation for [`PauliEvolutionSynthesisRustiq`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisRustiq "qiskit.transpiler.passes.synthesis.hls_plugins.PauliEvolutionSynthesisRustiq"). - -* Added a new argument `preserve_order` to [`ProductFormula`](/docs/api/qiskit/qiskit.synthesis.ProductFormula "qiskit.synthesis.ProductFormula"), which allows re-ordering the Pauli terms in the Hamiltonian before the product formula expansion, to compress the final circuit depth. By setting this to `False`, a term of form - -$$ -Z_0 Z_1 + X_1 X_2 + Y_2 Y_3 -$$ - - will be re-ordered to - -$$ -Z_0 Z_1 + Y_2 Y_3 + X_1 X_2 -$$ - - which will lead to the `RZZ` and `RYY` rotations being applied in parallel, instead of three sequential rotations in the first part. - - This option can be set via the plugin interface: - - ```python - from qiskit import QuantumCircuit, transpile - from qiskit.circuit.library import PauliEvolutionGate - from qiskit.quantum_info import SparsePauliOp - from qiskit.synthesis.evolution import SuzukiTrotter - from qiskit.transpiler.passes import HLSConfig - - op = SparsePauliOp(["XXII", "IYYI", "IIZZ"]) - time, reps = 0.1, 1 - - synthesis = SuzukiTrotter(order=2, reps=reps) - hls_config = HLSConfig(PauliEvolution=[("default", {"preserve_order": False})]) - - circuit = QuantumCircuit(op.num_qubits) - circuit.append(PauliEvolutionGate(op, time), circuit.qubits) - - tqc = transpile(circuit, basis_gates=["u", "cx"], hls_config=hls_config) - print(tqc.draw()) - ``` - - - - - -### Transpiler Features - -* Add an argument `matrix_based` to the [`CollectCliffords()`](/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords "qiskit.transpiler.passes.CollectCliffords") transpiler pass. If the new parameter `matrix_based=True`, the [`CollectCliffords()`](/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords "qiskit.transpiler.passes.CollectCliffords") transpiler pass can collect `RZGate(np.pi/2)` gates and other unitary gates that are [`Clifford()`](/docs/api/qiskit/qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") gates for certain parameters. - -* The [`RemoveIdentityEquivalent`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent "qiskit.transpiler.passes.RemoveIdentityEquivalent") transpiler pass is now run as part of the preset pass managers at optimization levels 2 and 3. The pass is run in the `init` stage and the `optimization` stage, because the optimizations it applies are valid in both stages and the pass is fast to execute. - -* The [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") transpiler pass has been updated to run an additional 2 or 3 layout trials by default independently of the `layout_trials` keyword argument’s value. A trivial layout and its reverse are included for all backends, just like the [`DenseLayout`](/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout "qiskit.transpiler.passes.DenseLayout") trial that was added in 1.2.0. In addition to this, the largest rings on an IBM backend heavy hex connectivity graph are added if the backends are 127, 133, or 156 qubits. This can provide a good starting point for some circuits on these commonly run backends, while for all others it’s just an additional “random trial”. - -* Improved handling of ancilla qubits in the [`HighLevelSynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") transpiler pass. For example, a circuit may have custom gates whose definitions include [`MCXGate`](/docs/api/qiskit/qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate")s. Now the synthesis algorithms for the inner MCX-gates can use the ancilla qubits available on the global circuit but outside the custom gates’ definitions. - -* Port most of the logic of the transpiler pass [`ElidePermutations`](/docs/api/qiskit/qiskit.transpiler.passes.ElidePermutations "qiskit.transpiler.passes.ElidePermutations") to Rust. - -* Added a new transpiler pass, [`RemoveIdentityEquivalent`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveIdentityEquivalent "qiskit.transpiler.passes.RemoveIdentityEquivalent") that is used to remove gates that are equivalent to an identity up to some tolerance. For example if you had a circuit like: - - > ![\_images/release\_notes-6.png](/docs/images/api/qiskit/release_notes-6.avif) - - running the pass would eliminate the [`CPhaseGate`](/docs/api/qiskit/qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"): - - > ```python - > from qiskit.circuit import QuantumCircuit - > from qiskit.transpiler.passes import RemoveIdentityEquivalent - > - > qc = QuantumCircuit(2) - > qc.cp(1e-20, 0, 1) - > - > removal_pass = RemoveIdentityEquivalent() - > result = removal_pass(qc) - > result.draw("mpl") - > ``` - > - > ![\_images/release\_notes-7.png](/docs/images/api/qiskit/release_notes-7.avif) - -* The `ConsolidateGates` pass will now run the equivalent of the [`Collect2qBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks "qiskit.transpiler.passes.Collect2qBlocks") pass internally if it was not run in a pass manager prior to the pass. Previously it was required that [`Collect2qBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks "qiskit.transpiler.passes.Collect2qBlocks") or [`Collect1qRuns`](/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns "qiskit.transpiler.passes.Collect1qRuns") were run prior to [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") for [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") to do anything. By doing the collection internally the overhead of the pass is reduced. If [`Collect2qBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks "qiskit.transpiler.passes.Collect2qBlocks") or [`Collect1qRuns`](/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns "qiskit.transpiler.passes.Collect1qRuns") are run prior to [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") the collected runs by those passes from the property set are used and there is no change in behavior for the pass. - - - - - -### Visualization Features - -* The [`timeline_drawer()`](/docs/api/qiskit/qiskit.visualization.timeline_drawer "qiskit.visualization.timeline_drawer") visualization function has a new argument `target`, used to specify a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") object for the visualization. By default the function used the `Instruction.duration` to get the duration of a given instruction, but specifying the target will leverage the timing details inside the target instead. - - - -### Known Issues - -* Versions of Qiskit before 1.2.4 will not be able to load QPY files dumped using [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump"), even with `version` set appropriately, if: - - * there are unbound [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")s in the QPY file, - * the `use_symengine=True` flag was set (which is the default in Qiskit >= 1.0.0) in [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump"), - * the version of `symengine` installed in the generating and loading environments are not within the same minor version. - - This applies regardless of the version of Qiskit used in the generation (at least up to Qiskit 1.2.4 inclusive). - - If you want to maximize compatibility with older versions of Qiskit, you should set `use_symengine=False`. Newer versions of Qiskit should not require this. - -* QPY files from the Qiskit 0.45 series can, under a very specific and unlikely set of circumstances, fail to load with any newer version of Qiskit, including Qiskit 1.2.4. The criteria are: - - * the [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or `ScheduleBlock` to be dumped contained unbound [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects, - * the installed version of `symengine` was in the 0.9 series (which was the most recent release during the support window of Qiskit 0.45), - * the `use_symengine=True` flag was set (which was *not* the default). - - Later versions of Qiskit used during generation are not affected, because they required newer versions than `symengine` 0.9. - - In this case, you can recover the QPY file by reloading it with an environment with Qiskit 0.45.3 and `symengine` 0.9.2 installed. Then, use [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") with `use_symengine=False` to re-export the file. This will then be readable by any newer version of Qiskit. - -* When using QPY formats 10, 11, or 12 there is a dependency on the version of `symengine` installed in the payload for serialized `ParamerExpression` if there is mismatched version of the installed `symengine` package between the environment that generated the payload with [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") and the installed version that is trying to load the payload with [`qpy.load()`](/docs/api/qiskit/qpy#qiskit.qpy.load "qiskit.qpy.load"). If this is encountered you will need to install the symengine version from the error message emitted to load the payload. QPY format version >= 13 (or \< 10) will not have this issue and it is recommended if you’re serializing [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects as part of your circuit or any `ScheduleBlock` objects you use version 13 to avoid this issue in the future. - - - - - -### Upgrade Notes - -* The supported versions of [symengine](https://pypi.org/project/symengine/) have been pre-emptively capped at \< 0.14.0 (which is expected to be the next minor version, as of this release of Qiskit). This has been done to protect against a potential incompatibility in [`qpy`](/docs/api/qiskit/qpy#module-qiskit.qpy "qiskit.qpy") when serializing [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects. The serialization used in [QPY Format](/docs/api/qiskit/qpy#qpy-format) versions 10, 11, and 12 for [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects is tied to the symengine version used to generate it, and there is the potential for a future symengine release to not be compatible. This upper version cap is to prevent a future release of symengine causing incompatibilities when trying to load QPY files using `qpy.load`. - -* When using [`BackendSamplerV2`](/docs/api/qiskit/qiskit.primitives.BackendSamplerV2 "qiskit.primitives.BackendSamplerV2"), circuit metadata is no longer cleared before passing circuits to the `run()` method of the wrapped [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") instance. - -* The following classes now use the $\sqrt{X}$ operation to diagonalize the Pauli-Y operator: [`PauliEvolutionGate`](/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate"), [`EvolvedOperatorAnsatz`](/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.EvolvedOperatorAnsatz"), [`PauliFeatureMap`](/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap"). Previously, these classes used either $H S$ or $R_X(-\pi/2)$ as basis transformation. Using the $\sqrt{X}$ operation, represented by the [`SXGate`](/docs/api/qiskit/qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate") is more efficient as it uses only a single gate implemented as singleton. - - - - - -### Circuits Upgrade Notes - -* The [`QuantumVolume`](/docs/api/qiskit/qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume") class will generate circuits with different unitary matrices and permutations for a given seed value from the previous Qiskit release. This is due to using a new internal random number generator for the circuit generation that will generate the circuit more quickly. If you need an exact circuit with the same seed you can use the previous release of Qiskit and generate the circuit with the `flatten=True` argument and export the circuit with [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") and then load it with this release. - - - - - -### QPY Upgrade Notes - -* The [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") function will now emit format version 13 by default. This means payloads generated with this function by default will only be compatible with Qiskit >= 1.3.0. If you need for the payload to be loaded by a older version of Qiskit you can use the `version` flag on [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") to emit a version compatible with earlier releases of Qiskit. You can refer to [QPY Compatibility](/docs/api/qiskit/qpy#qpy-compatibility) for more details on this. - - - - - -### Deprecation Notes - -* The Qiskit Pulse package is being deprecated and will be removed in Qiskit 2.0.0. Pulse-level access is currently only supported on a subset of Eagle devices and not supported on the Heron architecture. Furthermore, newer IBM Quantum architectures will not support pulse-level access. As a consequence, supporting Pulse as a first-class citizen frontend in the Qiskit SDK itself makes little sense going forward. The deprecation includes all pulse code in `qiskit.pulse` as well as functionality dependant or related to pulse such as pulse visualization, serialization and custom calibration support. For more details see the deprecation sections. - - The Pulse package as a whole, along with directly related components in Qiskit, will be moved to the [Qiskit Dynamics](https://github.com/qiskit-community/qiskit-dynamics) repository to further enable pulse and low-level control simulation. - - - - - -### Circuits Deprecations - -* Deprecated the `Instruction.condition` attribute and the `Instruction.c_if()` method. They will be removed in Qiskit 2.0, along with any uses in the Qiskit data model. This functionality has been superseded by the [`IfElseOp`](/docs/api/qiskit/qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") class which can be used to describe a classical condition in a circuit. For example, a circuit using `Instruction.c_if()` like: - - ```python - from qiskit.circuit import QuantumCircuit - - qc = QuantumCircuit(2, 2) - qc.h(0) - qc.x(0).c_if(0, 1) - qc.z(1.c_if(1, 0) - qc.measure(0, 0) - qc.measure(1, 1) - ``` - - can be rewritten as: - - ```python - qc = QuantumCircuit(2, 2) - qc.h(0) - with expected.if_test((expected.clbits[0], True)): - qc.x(0) - with expected.if_test((expected.clbits[1], False)): - qc.z(1) - qc.measure(0, 0) - qc.measure(1, 1) - ``` - - The now deprecated `ConvertConditionsToIfOps` transpiler pass can be used to automate this conversion for existing circuits. - -* ## As part of the Qiskit Pulse package deprecation, the following dependencies are deprecated as well: - - * `qiskit.circuit.QuantumCircuit.calibrations` - * `qiskit.circuit.QuantumCircuit.has_calibration_for()` - * `qiskit.circuit.QuantumCircuit.add_calibration()` - * `qiskit.dagcircuit.DAGCircuit.calibrations` - * `qiskit.dagcircuit.DAGCircuit.has_calibration_for()` - * `qiskit.dagcircuit.DAGCircuit.add_calibration()` - * `qiskit.dagcircuit.DAGDependency.calibrations` - -* The [`QuantumCircuit.unit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#unit "qiskit.circuit.QuantumCircuit.unit") and [`QuantumCircuit.duration`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#duration "qiskit.circuit.QuantumCircuit.duration") attributes have been deprecated and will be removed in Qiskit 2.0.0. These attributes were used to track the estimated duration and unit of that duration to execute on the circuit. However, the values of these attributes were always limited, as they would only be properly populated if the transpiler were run with the correct settings. The duration was also only a guess based on the longest path on the sum of the duration of [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") and wouldn’t ever correctly account for control flow or conditionals in the circuit. - -* The [`DAGCircuit.unit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#unit "qiskit.dagcircuit.DAGCircuit.unit") and [`DAGCircuit.duration`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#duration "qiskit.dagcircuit.DAGCircuit.duration") attributes have been deprecated and will be removed in Qiskit 2.0.0. These attributes were used to track the estimated duration and unit of that duration to execute on the circuit. However, the values of these attributes were always limited, as they would only be properly populated if the transpiler were run with the correct settings. The duration was also only a guess based on the longest path on the sum of the duration of [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") and wouldn’t ever correctly account for control flow or conditionals in the circuit. - -* The `Instruction.duration` and `Instruction.unit` attributes have been deprecated and will be removed in Qiskit 2.0.0. This includes setting the `unit` or `duration` arguments for any [`qiskit.circuit.Instruction`](/docs/api/qiskit/qiskit.circuit.Instruction "qiskit.circuit.Instruction") or subclass. These attributes were used to attach a custom execution duration and unit for that duration to an individual instruction. However, the source of truth of the duration of a gate is the [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") which contains the duration for each instruction supported on the backend. The duration of an instruction is not something that’s typically user adjustable and is an immutable property of the backend. If you were previously using this capability to experiment with different durations for gates you can mutate the [`InstructionProperties.duration`](/docs/api/qiskit/qiskit.transpiler.InstructionProperties#duration "qiskit.transpiler.InstructionProperties.duration") field in a given [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") to set a custom duration for an instruction on a backend (the unit is always in seconds in the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target")). - - - -### Providers Deprecations - -* The `BasicSimulator.configuration()` method is deprecated and will be removed in 2.0.0. This method returned a legacy `providers.models.BackendConfiguration` instance which is part of the deprecated `BackendV1` model. This model has been replaced with [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2"), where the constraints are stored directly in the backend instance or the underlying [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") (`backend.target`). - - Here is a quick guide for accessing the most common `BackendConfiguration` attributes in the `BackendV2` model:”” - - > BackendV1 model (deprecated) ————> BackendV2 model —————————- ————— backend.configuration().backend\_name backend.name backend.configuration().backend\_version backend.backend\_version backend.configuration().n\_qubits backend.num\_qubits backend.configuration().num\_qubits backend.num\_qubits backend.configuration().basis\_gates backend.target.operation\_names (\*) backend.configuration().coupling\_map backend.target.build\_coupling\_map() backend.configuration().local No representation backend.configuration().simulator No representation backend.configuration().conditional No representation backend.configuration().open\_pulse No representation backend.configuration().memory No representation backend.configuration().max\_shots No representation - - (\*) Note that `backend.target.operation_names` includes `basis_gates` and additional non-gate instructions, in some implementations it might be necessary to filter the output. - - See [this guide](/docs/guides/qiskit-backendv1-to-v2) for more information on migrating to the `BackendV2` model. - -* ## As part of the Qiskit Pulse package deprecation, all pulse-related functionality in [`qiskit.providers.BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") class is being deprecated. This includes the following methods: - - * `instruction_schedule_map()` - * `drive_channel()` - * `measure_channel()` - * `acquire_channel()` - * `control_channel()` - - Consequently, the corresponding channel methods in the `qiskit.providers.BackendV2Converter` and [`qiskit.providers.fake_provider.GenericBackendV2`](/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2") classes are being deprecated as well. - - In addition, the pulse\_channels and calibrate\_instructions arguments in the [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") initializer method are being deprecated. - -* The defaults argument is being deprecated from the `qiskit.providers.backend_compat.convert_to_target()` function. - - - -### QPY Deprecations - -* As part of the Qiskit Pulse package deprecation, serializing a `qiskit.pulse.ScheduleBlock`-based payloads is being deprecated. In particular, passing `qiskit.pulse.ScheduleBlock` objects to the programs argument in the [`qiskit.qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") function is being deprecated. - - - - - -### Transpiler Deprecations - -* The transpiler pass `ConvertConditionsToIfOps` has been deprecated and will be removed in Qiskit 2.0.0. This class is now deprecated because the underlying data model for `Instruction.condition` which this pass is converting from has been deprecated and will be removed in 2.0.0. - -* Providing custom gates through the `basis_gates` argument is deprecated for both [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and `generate_preset_pass_manager()`, this functionality will be removed in Qiskit 2.0. Custom gates are still supported in the [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") model, and can be provided through the `target` argument. One can build a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") instance from scratch or use the [`Target.from_configuration()`](/docs/api/qiskit/qiskit.transpiler.Target#from_configuration "qiskit.transpiler.Target.from_configuration") method with the `custom_name_mapping` argument. For example: - - ```python - from qiskit.circuit.library import XGate - from qiskit.transpiler.target import Target - - basis_gates = ["my_x", "cx"] - custom_name_mapping = {"my_x": XGate()} - target = Target.from_configuration( - basis_gates=basis_gates, num_qubits=2, custom_name_mapping=custom_name_mapping - ) - ``` - -* ## As part of the Qiskit Pulse package deprecation, pulse-related aspects in the [`qiskit.transpiler.Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") class are being deprecated. These include: - - * `calibration` - * `update_from_instruction_schedule_map()` - * `has_calibration()` - * `get_calibration()` - * `instruction_schedule_map()` - - ## In addition the following transpiler passer are also being deprecated: - - * `PulseGates` - * `ValidatePulseGates` - * `RXCalibrationBuilder` - * `RZXCalibrationBuilder` - * `EchoRZXWeylDecomposition` - -* The inst\_map argument in [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager"), `from_configuration()`, [`PassManagerConfig`](/docs/api/qiskit/qiskit.transpiler.PassManagerConfig "qiskit.transpiler.PassManagerConfig") initializer and `generate_scheduling()` is being deprecated. - -* The calibration argument in [`InstructionProperties()`](/docs/api/qiskit/qiskit.transpiler.InstructionProperties "qiskit.transpiler.target.InstructionProperties") initializer methods is being deprecated. - -* The following [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") arguments are deprecated in favor of defining a custom [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target"): `instruction_durations`, `timing_constraints`, and `backend_properties`. These arguments can be used to build a target with [`Target.from_configuration()`](/docs/api/qiskit/qiskit.transpiler.Target#from_configuration "qiskit.transpiler.Target.from_configuration"): - - ```python - Target.from_configuration( - ... - backend_properties = backend_properties, - instruction_durations = instruction_durations, - timing_constraints = timing_constraints - ) - ``` - -* The method [`PassManagerConfig.from_backend()`](/docs/api/qiskit/qiskit.transpiler.PassManagerConfig#from_backend "qiskit.transpiler.PassManagerConfig.from_backend") will stop supporting inputs of type `BackendV1` in the backend parameter in a future release no earlier than 2.0. `BackendV1` is deprecated and implementations should move to [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). - - - -### Visualization Deprecations - -* As part of the Qiskit Pulse package deprecation, pulse drawing via `qiskit.visualization.pulse_drawer()` is being deprecated. - - - -### Misc. Deprecations - -* The `qiskit.result.mitigation` module has been deprecated and will be removed in the 2.0 release. The deprecation includes the `LocalReadoutMitigator` and `CorrelatedReadoutMitigator` classes as well as the associated utils. Their functionality has been superseded by the mthree package, found in [https://github.com/Qiskit/qiskit-addon-mthree](https://github.com/Qiskit/qiskit-addon-mthree). - -* ## As part of the Qiskit Pulse package deprecation, the following functions and class are being deprecated as well: - - * `qiskit.compiler.schedule()` - * `qiskit.compiler.sequence()` - * `qiskit.assembler.assemble_schedules()` - * `qiskit.scheduler.methods.as_soon_as_possible()` - * `qiskit.scheduler.methods.as_late_as_possible()` - * `qiskit.scheduler.schedule_circuit.schedule_circuit()` - * `qiskit.scheduler.ScheduleConfig` - - - - - -### Bug Fixes - -* Fixed a bug in the transpiler pass [`ElidePermutations`](/docs/api/qiskit/qiskit.transpiler.passes.ElidePermutations "qiskit.transpiler.passes.ElidePermutations") where the qubit mapping was not updated correctly in the presence of [`PermutationGate`](/docs/api/qiskit/qiskit.circuit.library.PermutationGate "qiskit.circuit.library.PermutationGate")s. - -* Fixed a potential source of non-determinism in [`DenseLayout`](/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout "qiskit.transpiler.passes.DenseLayout") (and by extension [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout")) when targeting a [`CouplingMap`](/docs/api/qiskit/qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") or [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") that has more than one subgraph with the same degree of connectivity. In these case the exact output layout from the pass could previously fluctuate based on the number of local CPUs and thread execution speed. - -* The `HighLevelSynthesis` transpiler pass no longer raises an exception when encountering a custom gate that is called “qft” but is not an instance of [`QFTGate`](/docs/api/qiskit/qiskit.circuit.library.QFTGate "qiskit.circuit.library.QFTGate"). Instead, the synthesis plugins for QFT gates ignore such a gate, and the gate’s definition is used (if provided). - -* Fixed an issue introduced in the now [yanked](https://peps.python.org/pep-0592/) 1.2.3 bugfix release that would cause an exception with the error message “Qiskit doesn’t support loading a symengine payload generated with symengine >= 1.0” to be raised whenever loading a QPY file that was generated with a different symengine version from the version installed by the loading. This issue could only occur in 1.2.3. - -* Fixed an issue with [`qpy.load()`](/docs/api/qiskit/qpy#qiskit.qpy.load "qiskit.qpy.load") when loading a QPY file containing a [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression"), if the versions of `symengine` installed in the generating and loading environments were not the same. For example, if a QPY file containing [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")s was generated using Qiskit 1.2.2 with `symengine==0.11.0` installed, Qiskit 1.2.2 with `syengine==0.13.0` installed would be unable to load it. - - Previously, an error would have been raised by `symengine` around this version mismatch. This has been worked around for `symengine` 0.11 and 0.13 (there was no 0.12), but if you’re trying to use different versions of `symengine` and there is a mismatch, this version of Qiskit still might not work. - -* Fixed an issue when running [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") or [`run()`](/docs/api/qiskit/qiskit.transpiler.StagedPassManager#run "qiskit.transpiler.StagedPassManager.run") on a pass manager generated by [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") using `optimization_level` 2 or 3 when the `routing_method` argument is set to `"none"` to explicitly disable routing. Previously under these conditions the transpiler would run the `ElidePermutation` pass as part of the init stage as under normal conditions this is a useful optimization to remove [`SwapGate`](/docs/api/qiskit/qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") and [`PermutationGate`](/docs/api/qiskit/qiskit.circuit.library.PermutationGate "qiskit.circuit.library.PermutationGate") instances from the circuit. But when `routing_method="none"` this optimization wasn’t expected as it permutes the circuit in a similar manner to routing which shouldn’t be performed when `routing_method="none"`. This has been fixed by no longer running `ElidePermutation` if `routing_method="none"` is set. Fixed [#13144](https://github.com/Qiskit/qiskit/issues/13144) - -* The OpenQASM 2 importer previously would output incorrect [`Gate`](/docs/api/qiskit/qiskit.circuit.Gate "qiskit.circuit.Gate") instances for gate calls referring to a `gate` definition that followed a prior `gate` definition that was being treated as a built-in operation by a [`CustomInstruction`](/docs/api/qiskit/qasm2#qiskit.qasm2.CustomInstruction "qiskit.qasm2.CustomInstruction"). See [#13339](https://github.com/Qiskit/qiskit/issues/13339) for more detail. - -* The OpenQASM 3 exporter has restored its behavior of accepting non-standard-library include files in the `includes` argument to [`qasm3.dump()`](/docs/api/qiskit/qasm3#qiskit.qasm3.dump "qiskit.qasm3.dump"), [`dumps()`](/docs/api/qiskit/qasm3#qiskit.qasm3.dumps "qiskit.qasm3.dumps"), and [`Exporter`](/docs/api/qiskit/qasm3#qiskit.qasm3.Exporter "qiskit.qasm3.Exporter"). These will insert a suitable `include` statement into the output as before, and the exporter remains unaware of the intended gates in that include file; you should pass the gates you expect it to define in the `basis_gates` argument to the same functions. - - We expect to improve the export mechanism against non-standard include files in a future release of Qiskit. - -* Fixed a performance regression in [`QuantumCircuit.assign_parameters()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#assign_parameters "qiskit.circuit.QuantumCircuit.assign_parameters") introduced in Qiskit 1.2.0 when calling the method in a tight loop, binding only a small number of parameters out of a heavily parametric circuit on each iteration. If possible, it is still more performant to call [`assign_parameters()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#assign_parameters "qiskit.circuit.QuantumCircuit.assign_parameters") only once, with all assignments at the same time, as this reduces the proportion of time spent on input normalization and error-checking overhead. - -* For [`BasicSimulator`](/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator "qiskit.providers.basic_provider.BasicSimulator"), the `basis_gates` entry in the configuration instance returned by the `configuration()` is now a list rather than a `dict_keys` instance, matching the expected type and allowing for configuration instance to be deep copied. - -* Fixed a bug in [`QuantumCircuit.decompose()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#decompose "qiskit.circuit.QuantumCircuit.decompose") where objects that could be synthesized with [`HighLevelSynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") were first synthesized and then decomposed immediately (i.e., they were decomposed twice instead of once). This affected, e.g., [`MCXGate`](/docs/api/qiskit/qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate") or [`Clifford`](/docs/api/qiskit/qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"), among others. - -* Fixed a bug in [`QuantumCircuit.decompose()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#decompose "qiskit.circuit.QuantumCircuit.decompose"), where high-level objects without a definition were not decomposed if they were explicitly set via the `"gates_to_decompose"` argument. For example, previously the following did not perform a decomposition but now works as expected: - - ```python - from qiskit import QuantumCircuit - from qiskit.quantum_info import Clifford - from qiskit.transpiler.passes import Decompose - - cliff = Clifford(HGate()) - circuit = QuantumCircuit(1) - circuit.append(cliff, [0]) - - decomposed = Decompose(gates_to_decompose=["clifford"])(circuit) - ``` - -* Fixed [`Operator.power()`](/docs/api/qiskit/qiskit.quantum_info.Operator#power "qiskit.quantum_info.Operator.power") when called with non-integer powers on a matrix whose Schur form is not diagonal (for example, most non-unitary matrices). - -* [`Operator.power()`](/docs/api/qiskit/qiskit.quantum_info.Operator#power "qiskit.quantum_info.Operator.power") will now more reliably return the expected principal value from a fractional matrix power of a unitary matrix with a $-1$ eigenvalue. This is tricky in general, because floating-point rounding effects can cause a matrix to \_truly\_ have an eigenvalue on the negative side of the branch cut (even if its exact mathematical relation would not), and imprecision in various BLAS calls can falsely find the wrong side of the branch cut. - - [`Operator.power()`](/docs/api/qiskit/qiskit.quantum_info.Operator#power "qiskit.quantum_info.Operator.power") now shifts the branch-cut location for matrix powers to be a small complex rotation away from $-1$. This does not solve the problem, it just shifts it to a place where it is far less likely to be noticeable for the types of operators that usually appear. Use the new `branch_cut_rotation` parameter to have more control over this. - - See [#13305](https://github.com/Qiskit/qiskit/issues/13305). - - - - - -## 1.3.0b1 - - - - - -### New Features - -* Added a new class [`QFTGate`](/docs/api/qiskit/qiskit.circuit.library.QFTGate "qiskit.circuit.library.QFTGate") for natively representing Quantum Fourier Transforms (QFTs). The older way of representing QFTs via quantum circuits, see [`QFT`](/docs/api/qiskit/qiskit.circuit.library.QFT "qiskit.circuit.library.QFT"), remains for backward compatibility. The new way of representing a QFT via a gate avoids synthesizing its definition circuit when the gate is declared, delaying the actual synthesis to the transpiler. It also allows to easily choose between several different algorithms for synthesizing QFTs, which are available as high-level-synthesis plugins. - -* Added a synthesis method [`synth_qft_full()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_qft_full "qiskit.synthesis.synth_qft_full") for constructing a QFT circuit assuming a fully-connected architecture. - -* Added two high-level-synthesis plugins for synthesizing a [`QFTGate`](/docs/api/qiskit/qiskit.circuit.library.QFTGate "qiskit.circuit.library.QFTGate"). The class [`QFTSynthesisFull`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.QFTSynthesisFull "qiskit.transpiler.passes.synthesis.hls_plugins.QFTSynthesisFull") is based on [`synth_qft_full()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_qft_full "qiskit.synthesis.synth_qft_full") and synthesizes a QFT gate assuming all-to-all connectivity. The class [`QFTSynthesisLine`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.QFTSynthesisLine "qiskit.transpiler.passes.synthesis.hls_plugins.QFTSynthesisLine") is based on [`synth_qft_line()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_qft_line "qiskit.synthesis.synth_qft_line") and synthesizes a QFT gate assuming linear nearest neighbor connectivity. - -* [`MCXVChain`](/docs/api/qiskit/qiskit.circuit.library.MCXVChain "qiskit.circuit.library.MCXVChain") has two new Boolean parameters relative\_phase and action\_only. If action\_only the circuit does not clean the dirty qubits. If relative\_phase the gate is implemented up to a global phase. Both parameters are used to optimize the decomposition of MCXVChain. - -* Added two parameters to [`GenericBackendV2`](/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2") to exclude error (noise\_info) and pulse channel information (pulse\_channels) from the construction of the backend. These parameters are true by default, replicating the initial default behavior of the constructor. A memory-sensitive user may set these options to False to reduce the memory overhead by 40x when transpiling on large- scale [`GenericBackendV2`](/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2"). - -* The [`StabilizerState`](/docs/api/qiskit/qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState") class now has a new method [`probabilities_dict_from_bitstring()`](/docs/api/qiskit/qiskit.quantum_info.StabilizerState#probabilities_dict_from_bitstring "qiskit.quantum_info.StabilizerState.probabilities_dict_from_bitstring") allowing the user to pass single bitstring to measure an outcome for. Previouslly the [`probabilities_dict()`](/docs/api/qiskit/qiskit.quantum_info.StabilizerState#probabilities_dict "qiskit.quantum_info.StabilizerState.probabilities_dict") would be utilized and would at worst case calculate (2^n) number of probability calculations (depending on the state), even if a user wanted a single result. With this new method the user can calculate just the single outcome bitstring value a user passes to measure the probability for. As the number of qubits increases, the more prevelant the performance enhancement may be (depending on the state) as only 1 bitstring result is measured. - -* Implemented `UniformSuperpositionGate` class, which allows the creation of a uniform superposition state using the Shukla-Vedula algorithm. This feature facilitates the creation of quantum circuits that produce a uniform superposition state $\frac{1}{\sqrt{M}} \sum_{j=0}^{M-1} |j\rangle$, where $M$ is a positive integer representing the number of computational basis states with an amplitude of $\frac{1}{\sqrt{M}}$. This implementation supports the efficient creation of uniform superposition states, requiring only $O(\log_2 (M))$ qubits and $O(\log_2 (M))$ gates. Usage example: - - ```python - from qiskit import QuantumCircuit - from qiskit.circuit.library.data_preparation import UniformSuperpositionGate - - M = 5 - num_qubits = 3 - usp_gate = UniformSuperpositionGate(M, num_qubits) - qc = QuantumCircuit(num_qubits) - qc.append(usp_gate, list(range(num_qubits))) - - qc.draw() - ``` - - - - - -### Circuits Features - -* Added support for `AnnotatedOperation.params()` and [`AnnotatedOperation.validate_parameter()`](/docs/api/qiskit/qiskit.circuit.AnnotatedOperation#validate_parameter "qiskit.circuit.AnnotatedOperation.validate_parameter"), which enable circuit-level parameter handling (such as binding parameters) for annotated operations. - -* [`CircuitInstruction`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") and [`DAGOpNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") each have new methods to query various properties of their internal [`Operation`](/docs/api/qiskit/qiskit.circuit.Operation "qiskit.circuit.Operation"), without necessarily needing to access it. These methods are: - - * [`CircuitInstruction.is_standard_gate()`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#is_standard_gate "qiskit.circuit.CircuitInstruction.is_standard_gate") and [`DAGOpNode.is_standard_gate()`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode#is_standard_gate "qiskit.dagcircuit.DAGOpNode.is_standard_gate"), - * [`CircuitInstruction.is_controlled_gate()`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#is_controlled_gate "qiskit.circuit.CircuitInstruction.is_controlled_gate") and [`DAGOpNode.is_controlled_gate()`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode#is_controlled_gate "qiskit.dagcircuit.DAGOpNode.is_controlled_gate"), - * [`CircuitInstruction.is_directive()`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#is_directive "qiskit.circuit.CircuitInstruction.is_directive") and [`DAGOpNode.is_directive()`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode#is_directive "qiskit.dagcircuit.DAGOpNode.is_directive"), - * [`CircuitInstruction.is_control_flow()`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#is_control_flow "qiskit.circuit.CircuitInstruction.is_control_flow") and [`DAGOpNode.is_control_flow()`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode#is_control_flow "qiskit.dagcircuit.DAGOpNode.is_control_flow"), and - * [`CircuitInstruction.is_parameterized()`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#is_parameterized "qiskit.circuit.CircuitInstruction.is_parameterized") and [`DAGOpNode.is_parameterized()`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode#is_parameterized "qiskit.dagcircuit.DAGOpNode.is_parameterized"). - - If applicable, using any of these methods is significantly faster than querying [`CircuitInstruction.operation`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#operation "qiskit.circuit.CircuitInstruction.operation") or [`DAGOpNode.op`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode#op "qiskit.dagcircuit.DAGOpNode.op") directly, especially if the instruction or node represents a Qiskit standard gate. This is because the standard gates are stored natively in Rust, and their Python representation is only created when requested. - -* A native rust representation of Qiskit’s standard gate library has been added. When a standard gate is added to a [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") it is now represented in a more efficient manner directly in Rust seamlessly. Accessing that gate object from a circuit or dag will return a new Python object representing the standard gate. This leads to faster and more efficient transpilation and manipulation of circuits for functionality written in Rust. - -* Improved performance of the method [`DAGCircuit.quantum_causal_cone()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#quantum_causal_cone "qiskit.dagcircuit.DAGCircuit.quantum_causal_cone") by not examining the same non-directive node multiple times when reached from different paths. - -* Replacing the internal synthesis algorithm of [`StatePreparation`](/docs/api/qiskit/qiskit.circuit.library.StatePreparation "qiskit.circuit.library.StatePreparation") and [`Initialize`](/docs/api/qiskit/qiskit.circuit.library.Initialize "qiskit.circuit.library.Initialize") of Shende et al. by the algorithm given in [`Isometry`](/docs/api/qiskit/qiskit.circuit.library.Isometry "qiskit.circuit.library.Isometry") of Iten et al. The new algorithm reduces the number of CX gates and the circuit depth by a factor of 2. - -* [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") now supports the unary `+` operator. - -* Added a new function to `qiskit.circuit.random` that allows to generate a pseudo-random Clifford circuit with gates from the standard library: [`random_clifford_circuit()`](/docs/api/qiskit/circuit_random#qiskit.circuit.random.random_clifford_circuit "qiskit.circuit.random.random_clifford_circuit"). Example usage: - - ```python - from qiskit.circuit.random import random_clifford_circuit - - circ = random_clifford_circuit(num_qubits=2, num_gates=6) - circ.draw(output='mpl') - ``` - - ![\_images/release\_notes-8.png](/docs/images/api/qiskit/release_notes-8.avif) - -* A new data attribute, [`qiskit.circuit.CONTROL_FLOW_OP_NAMES`](/docs/api/qiskit/circuit#qiskit.circuit.CONTROL_FLOW_OP_NAMES "qiskit.circuit.CONTROL_FLOW_OP_NAMES"), is available to easily find and check whether a given [`Instruction`](/docs/api/qiskit/qiskit.circuit.Instruction "qiskit.circuit.Instruction") is a control-flow operation by name. - -* The standard equivalence library ([`SessionEquivalenceLibrary`](/docs/api/qiskit/circuit#qiskit.circuit.SessionEquivalenceLibrary "qiskit.circuit.SessionEquivalenceLibrary")) now has rules that can directly convert between Qiskit’s standard-library 2q continuous Ising-type interactions (e.g. [`CPhaseGate`](/docs/api/qiskit/qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"), [`RZZGate`](/docs/api/qiskit/qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"), [`RZXGate`](/docs/api/qiskit/qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"), and so on) using local equivalence relations. Previously, several of these conversions would go via a 2-CX form, which resulted in less efficient circuit generation. - - - In general, the [`BasisTranslator`](/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") is not guaranteed to find the “best” equivalence relation for a given [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target"), but will always find an equivalence if one exists. We rely on more expensive resynthesis and gate-optimization passes in the transpiler to improve the output. These passes are currently not as effective for basis sets with a continuously parametrized two-qubit interaction as they are for discrete super-controlled two-qubit interactions. - - -* The random\_circuit function from qiskit.circuit.random.utils has a new feature where users can specify a distribution num\_operand\_distribution (a dict) that specifies the ratio of 1-qubit, 2-qubit, 3-qubit, and 4-qubit gates in the random circuit. For example, if num\_operand\_distribution = \{1: 0.25, 2: 0.25, 3: 0.25, 4: 0.25} is passed to the function then the generated circuit will have approximately 25% of 1-qubit, 2-qubit, 3-qubit, and 4-qubit gates (The order in which the dictionary is passed does not matter i.e. you can specify num\_operand\_distribution = \{3: 0.5, 1: 0.0, 4: 0.3, 2: 0.2} and the function will still work as expected). Also it should be noted that the if num\_operand\_distribution is not specified then max\_operands will default to 4 and a random circuit with a random gate distribution will be generated. If both num\_operand\_distribution and max\_operands are specified at the same time then num\_operand\_distribution will be used to generate the random circuit. Example usage: - - ```python - from qiskit.circuit.random import random_circuit - - circ = random_circuit(num_qubits=6, depth=5, num_operand_distribution = {1: 0.25, 2: 0.25, 3: 0.25, 4: 0.25}) - circ.draw(output='mpl') - ``` - -* [`PauliFeatureMap`](/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap") and [`ZZFeatureMap`](/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap") now support specifying the entanglement as a dictionary where the keys represent the number of qubits, and the values are lists of integer tuples that define which qubits are entangled with one another. This allows for more flexibility in constructing feature maps tailored to specific quantum algorithms. Example usage: - - ```python - from qiskit.circuit.library import PauliFeatureMap - entanglement = { - 1: [(0,), (2,)], - 2: [(0, 1), (1, 2)], - 3: [(0, 1, 2)], - } - qc = PauliFeatureMap(3, reps=2, paulis=['Z', 'ZZ', 'ZZZ'], entanglement=entanglement, insert_barriers=True) - qc.decompose().draw('mpl') - ``` - -* The [`count_ops()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#count_ops "qiskit.circuit.QuantumCircuit.count_ops") method in [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") has been re-written in Rust. It now runs between 3 and 9 times faster. - -* Added the `insert_barriers` keyword argument to the [`repeat()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#repeat "qiskit.circuit.QuantumCircuit.repeat") method. Setting it to `True` will insert barriers between circuit repetitions. - -* [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") has several new methods to work with and inspect manual [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") variables. - - See [Working with real-time typed classical data](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#circuit-real-time-methods) for more in-depth discussion on all of these. - - The new methods are: - - * [`add_var()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#add_var "qiskit.circuit.QuantumCircuit.add_var") - * [`add_input()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#add_input "qiskit.circuit.QuantumCircuit.add_input") - * [`add_capture()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#add_capture "qiskit.circuit.QuantumCircuit.add_capture") - * [`add_uninitialized_var()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#add_uninitialized_var "qiskit.circuit.QuantumCircuit.add_uninitialized_var") - * [`get_var()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#get_var "qiskit.circuit.QuantumCircuit.get_var") - * [`has_var()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#has_var "qiskit.circuit.QuantumCircuit.has_var") - * [`iter_vars()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#iter_vars "qiskit.circuit.QuantumCircuit.iter_vars") - * [`iter_declared_vars()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#iter_declared_vars "qiskit.circuit.QuantumCircuit.iter_declared_vars") - * [`iter_captured_vars()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#iter_captured_vars "qiskit.circuit.QuantumCircuit.iter_captured_vars") - * [`iter_input_vars()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#iter_input_vars "qiskit.circuit.QuantumCircuit.iter_input_vars") - * [`store()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#store "qiskit.circuit.QuantumCircuit.store") - - In addition, there are several new dynamic attributes on [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") surrounding these variables: - - * [`num_vars`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#num_vars "qiskit.circuit.QuantumCircuit.num_vars") - * [`num_input_vars`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#num_input_vars "qiskit.circuit.QuantumCircuit.num_input_vars") - * [`num_captured_vars`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#num_captured_vars "qiskit.circuit.QuantumCircuit.num_captured_vars") - * [`num_declared_vars`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#num_declared_vars "qiskit.circuit.QuantumCircuit.num_declared_vars") - -* [`ControlFlowOp`](/docs/api/qiskit/qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp") and its subclasses now have a [`iter_captured_vars()`](/docs/api/qiskit/qiskit.circuit.ControlFlowOp#iter_captured_vars "qiskit.circuit.ControlFlowOp.iter_captured_vars") method, which will return an iterator over the unique variables captured in any of its immediate blocks. - -* [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") has several new methods to work with and inspect manual [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") variables. These are largely equivalent to their [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") counterparts, except that the [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") ones are optimized for programmatic access with already defined objects, while the [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") methods are more focussed on interactive human use. - - The new methods are: - - * [`add_input_var()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#add_input_var "qiskit.dagcircuit.DAGCircuit.add_input_var") - * [`add_captured_var()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#add_captured_var "qiskit.dagcircuit.DAGCircuit.add_captured_var") - * [`add_declared_var()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#add_declared_var "qiskit.dagcircuit.DAGCircuit.add_declared_var") - * [`has_var()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#has_var "qiskit.dagcircuit.DAGCircuit.has_var") - * [`iter_vars()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#iter_vars "qiskit.dagcircuit.DAGCircuit.iter_vars") - * [`iter_declared_vars()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#iter_declared_vars "qiskit.dagcircuit.DAGCircuit.iter_declared_vars") - * [`iter_captured_vars()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#iter_captured_vars "qiskit.dagcircuit.DAGCircuit.iter_captured_vars") - * [`iter_input_vars()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#iter_input_vars "qiskit.dagcircuit.DAGCircuit.iter_input_vars") - - There are also new public attributes: - - * [`num_vars`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#num_vars "qiskit.dagcircuit.DAGCircuit.num_vars") - * [`num_input_vars`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#num_input_vars "qiskit.dagcircuit.DAGCircuit.num_input_vars") - * [`num_captured_vars`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#num_captured_vars "qiskit.dagcircuit.DAGCircuit.num_captured_vars") - * [`num_declared_vars`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#num_declared_vars "qiskit.dagcircuit.DAGCircuit.num_declared_vars") - -* [`DAGCircuit.wires`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#wires "qiskit.dagcircuit.DAGCircuit.wires") will now also contain any [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") manual variables in the circuit as well, as these are also classical data flow. - -* A new method, [`Var.new()`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var.new "qiskit.circuit.classical.expr.Var.new"), is added to manually construct a real-time classical variable that owns its memory. - -* [`QuantumCircuit.compose()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#compose "qiskit.circuit.QuantumCircuit.compose") has two need keyword arguments, `var_remap` and `inline_captures` to better support real-time classical variables. - - `var_remap` can be used to rewrite [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes in the circuit argument as its instructions are inlined onto the base circuit. This can be used to avoid naming conflicts. - - `inline_captures` can be set to `True` (defaults to `False`) to link all [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes tracked as “captures” in the argument circuit with the same [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes in the base circuit, without attempting to redeclare the variables. This can be used, in combination with [`QuantumCircuit.copy_empty_like()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#copy_empty_like "qiskit.circuit.QuantumCircuit.copy_empty_like")’s `vars_mode="captures"` handling, to build up a circuit layer by layer, containing variables. - -* [`DAGCircuit.compose()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#compose "qiskit.dagcircuit.DAGCircuit.compose") has a new keyword argument, `inline_captures`, which can be set to `True` to inline “captured” [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes on the argument circuit onto the base circuit without redeclaring them. In conjunction with the `vars_mode="captures"` option to several [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") methods, this can be used to combine DAGs that operate on the same variables. - -* [`QuantumCircuit.copy_empty_like()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#copy_empty_like "qiskit.circuit.QuantumCircuit.copy_empty_like") and [`DAGCircuit.copy_empty_like()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#copy_empty_like "qiskit.dagcircuit.DAGCircuit.copy_empty_like") have a new keyword argument, `vars_mode` which controls how any memory-owning [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes are tracked in the output. By default (`"alike"`), the variables are declared in the same input/captured/local mode as the source. This can be set to `"captures"` to convert all variables to captures (useful with [`compose()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#compose "qiskit.circuit.QuantumCircuit.compose")) or `"drop"` to remove them. - -* A new `vars_mode` keyword argument has been added to the [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") methods: - - * [`separable_circuits()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#separable_circuits "qiskit.dagcircuit.DAGCircuit.separable_circuits") - * [`layers()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#layers "qiskit.dagcircuit.DAGCircuit.layers") - * [`serial_layers()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#serial_layers "qiskit.dagcircuit.DAGCircuit.serial_layers") - - which has the same meaning as it does for [`copy_empty_like()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#copy_empty_like "qiskit.dagcircuit.DAGCircuit.copy_empty_like"). - - - - - -### Primitives Features - -* Added a new method [`BitArray.postselect()`](/docs/api/qiskit/qiskit.primitives.BitArray#postselect "qiskit.primitives.BitArray.postselect") that returns all shots containing specified bit values. Example usage: - - ```python - from qiskit.primitives.containers import BitArray - - ba = BitArray.from_counts({'110': 2, '100': 4, '000': 3}) - print(ba.postselect([0,2], [0,1]).get_counts()) - # {'110': 2, '100': 4} - ``` - -* The metadata of Primitives V2 implementations, i.e., [`StatevectorSampler`](/docs/api/qiskit/qiskit.primitives.StatevectorSampler "qiskit.primitives.StatevectorSampler"), [`StatevectorEstimator`](/docs/api/qiskit/qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator"), [`BackendSamplerV2`](/docs/api/qiskit/qiskit.primitives.BackendSamplerV2 "qiskit.primitives.BackendSamplerV2") and [`BackendEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2 "qiskit.primitives.BackendEstimatorV2"), has been updated to match that of IBM quantum devices. - - * `version` and `circuit_metadata` are added for all V2 implementations - * `shots` is added for [`BackendSamplerV2`](/docs/api/qiskit/qiskit.primitives.BackendSamplerV2 "qiskit.primitives.BackendSamplerV2") and [`BackendEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2 "qiskit.primitives.BackendEstimatorV2") - * `precision` is renamed with `target_precision` for [`StatevectorEstimator`](/docs/api/qiskit/qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator") - - Note that metadata of [`StatevectorEstimator`](/docs/api/qiskit/qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator") does not have `shots` because the class computes expectation values with [`Statevector`](/docs/api/qiskit/qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") and shots are not used. - -* `Estimator` and [`StatevectorEstimator`](/docs/api/qiskit/qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator") return expectation values in a stochastic way if the input circuit includes a reset for a some subsystems. The result was not reproducible, but it is now reproducible if a random seed is set. For example: - - ```python - from qiskit.primitives import StatevectorEstimator - - estimator = StatevectorEstimator(seed=123) - ``` - - or: - - ```python - from qiskit.primitives import Estimator - - estimator = Estimator(options={"seed":123}) - ``` - - - - - -### OpenQASM Features - -* The internal symbol table of the OpenQASM 3 exporter ([`qiskit.qasm3`](/docs/api/qiskit/qasm3#module-qiskit.qasm3 "qiskit.qasm3")) has been rewritten, which should result in cleaner outputs when using Qiskit standard-library gates that are not in the OpenQASM 3 standard-library headers, and more deterministic outputs. For example, using several [`RZXGate`](/docs/api/qiskit/qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate")s will now result in only a single parametric definition, and when naming collisions occur, the symbol table will assign a deterministic counter to make names unique, rather than a non-deterministic integer (previously, the object identity was used). - -* The vendored version of the OpenQASM 3.0 standard library has been updated to match [the state as of commit 4ca1d79383](https://github.com/openqasm/openqasm/blob/4ca1d793833b24a195dcb8a5db99f1bd21b0d32f/examples/stdgates.inc). This should generally have no effect on your use of Qiskit, unless you were retrieving our vendored file for your own use. - -* The OpenQASM 3 exporter supports manual-storage [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes on circuits. - - - - - -### QPY Features - -* QPY ([`qiskit.qpy`](/docs/api/qiskit/qpy#module-qiskit.qpy "qiskit.qpy")) format version 12 has been added, which includes support for memory-owning [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") variables. See [Version 12](/docs/api/qiskit/qpy#qpy-version-12) for more detail on the format changes. - - - - - -### Synthesis Features - -* Port internal binary matrix utils from Python to Rust, including binary matrix multiplication, gaussian elimination, rank calculation, binary matrix inversion, and random invertible binary matrix generation. These functions are not part of the Qiskit API, and porting them to rust improves the performance of certain synthesis methods. - -* [`MCXRecursive`](/docs/api/qiskit/qiskit.circuit.library.MCXRecursive "qiskit.circuit.library.MCXRecursive") with $k$ control qubits and a single clean auxiliary qubit now requires at most $16k-8$ CX gates. - -* Port [`synth_permutation_acg()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_permutation_acg "qiskit.synthesis.synth_permutation_acg"), used to synthesize qubit permutations, to Rust. This produces an approximate 3x performance improvement on 1000 qubit circuits. - -* Port [`synth_permutation_basic()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_permutation_basic "qiskit.synthesis.synth_permutation_basic"), used to synthesize qubit permutations, to Rust. - -* Port `synth_cnot_full_pmh()`, used to synthesize a linear function into a CX network, to Rust. This produces approximately 44x speedup, as measured on 100 qubit circuits. - -* The function `synth_cnot_full_pmh()` now allows choosing the (heuristically) optimal `section_size` by setting it to `None`. Then, a value is chosen which attempts to minimize the upper bound on the number of CX gates, that is $\alpha \log_2(n)$ where $n$ is the number of qubits and $\alpha \approx 0.56$. - -* The function [`synth_clifford_bm()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_clifford_bm "qiskit.synthesis.synth_clifford_bm") was ported to Rust. Recall that this function optimally synthesizes [`Clifford`](/docs/api/qiskit/qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") operators on 1, 2 or 3 qubits with respect to the number of CX-gates. This leads to a significant increase in performance. For Cliffords over 3 qubits, the speedup in on the order of 80 times. - -* The function [`synth_clifford_greedy()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_clifford_greedy "qiskit.synthesis.synth_clifford_greedy") that synthesizes [`Clifford`](/docs/api/qiskit/qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") operators was ported to Rust, leading to a significant increase in performance for all numbers of qubits. For Cliffords over 50 qubits, the speedup is on the order of 1000 times. - -* Port [`synth_permutation_depth_lnn_kms()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_permutation_depth_lnn_kms "qiskit.synthesis.synth_permutation_depth_lnn_kms"), used to synthesize permutations for linear connectivity, to Rust. - -* Added synthesis functions [`synth_mcx_gray_code()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_gray_code "qiskit.synthesis.synth_mcx_gray_code") and [`synth_mcx_noaux_v24()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_noaux_v24 "qiskit.synthesis.synth_mcx_noaux_v24") that synthesize multi-controlled X gates. These functions do not require additional ancilla qubits. - -* Added synthesis functions [`synth_c3x()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_c3x "qiskit.synthesis.synth_c3x") and [`synth_c4x()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_c4x "qiskit.synthesis.synth_c4x") that synthesize 3-controlled and 4-controlled X-gates respectively. - -* Add a synthesis function [`synth_mcx_n_dirty_i15()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_n_dirty_i15 "qiskit.synthesis.synth_mcx_n_dirty_i15") that synthesizes a multi-controlled X gate with $k$ controls using $k - 2$ dirty ancillary qubits producing a circuit with at most $8 * k - 6$ CX gates, by Iten et. al. (arXiv:1501.06911). - -* Add a synthesis function [`synth_mcx_n_clean_m15()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_n_clean_m15 "qiskit.synthesis.synth_mcx_n_clean_m15") that synthesizes a multi-controlled X gate with $k$ controls using $k - 2$ clean ancillary qubits producing a circuit with at most $6 * k - 6$ CX gates, by Maslov (arXiv:1508.03273). - -* Add a synthesis function [`synth_mcx_1_clean_b95()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_1_clean_b95 "qiskit.synthesis.synth_mcx_1_clean_b95") that synthesizes a multi-controlled X gate with $k$ controls using a single clean ancillary qubit producing a circuit with at most $16 * k - 8$ CX gates, by Barenco et al. (arXiv:quant-ph/9503016). - -* The function [`random_clifford()`](/docs/api/qiskit/quantum_info#qiskit.quantum_info.random_clifford "qiskit.quantum_info.random_clifford") was ported to Rust, improving the runtime by a factor of 3. - -* Port :func: .synth\_cz\_depth\_line\_mr to Rust. This function synthesizes a CZ circuit for linear nearest neighbor (LNN) connectivity, based on the Maslov and Roetteler method. On a 350x350 binary matrix, the Rust implementation yields a speedup of about 30 times. - -* Port :func: .synth\_permutation\_reverse\_lnn\_kms to Rust, which synthesizes a reverse permutation for linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. - -* Added the `wrap` keyword argument to the [`ProductFormula`](/docs/api/qiskit/qiskit.synthesis.ProductFormula "qiskit.synthesis.ProductFormula") classes which (when enabled) wraps individual Pauli evolution terms. This can be useful when visualizing circuits. - - - - - -### Transpiler Features - -* Added a new import path option for [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager"), so that it can now be imported as: - - ```python - from qiskit import generate_preset_pass_manager - ``` - - instead of having to type the full path: - - ```python - from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager - ``` - - The function is also importable from the [`qiskit.transpiler`](/docs/api/qiskit/transpiler#module-qiskit.transpiler "qiskit.transpiler") module as: - - ```python - from qiskit.transpiler import generate_preset_pass_manager - ``` - -* Added a new user config file option `sabre_all_threads` and a corresponding environment variable `QISKIT_SABRE_ALL_THREADS`. When this flag is set the preset pass managers will run the [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") and [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") transpiler passes using all the available CPUs on the local system. Using this option is a tradeoff between determinism of output between different computers and potentially better output with fewer [`SwapGate`](/docs/api/qiskit/qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")s. - - These transpiler passes run multiple random trials in parallel and pick the output which results in the fewest [`SwapGate`](/docs/api/qiskit/qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")s. As a rule of thumb, if you run more trials, this provides the algorithm more opportunities to find a better result. By default, the preset pass managers use a fixed number of trials, in this release 5 trials for levels 0 and 1, and 20 trials for levels 2 and 3, but these numbers may change in future releases (and were different in historical releases). Using a fixed number of trials results in deterministic results regardless of the local system, because even with a fixed seed if you were to default to the number of local CPUs available the results would different when running between different computers. - - If the default number of trials for a given optimization level is higher than the number of local CPUs it will use the optimization level default which is higher. - -* The `optimization_level` argument for the [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") function is now optional. If it’s not specified it will default to using optimization level 2. As the argument is now optional, the first positional argument has been expanded to enable passing a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") or a [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") as the first argument for more convenient construction. For example: - - ```python - from qiskit.transpiler.preset_passmanager import generate_preset_pass_manager - from qiskit.providers.fake_provider import GenericBackendV2 - - backend = GenericBackendV2(100) - - generate_preset_pass_manager(backend.Target) - ``` - - will construct a default pass manager for the 100 qubit :class\`.GenericBackendV2\` instance. - -* Added a new pass [`Split2QUnitaries`](/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries "qiskit.transpiler.passes.Split2QUnitaries") that iterates over all two-qubit gates or unitaries in a circuit and replaces them with two single-qubit unitaries, if possible without introducing errors, i.e. the two-qubit gate/unitary is actually a (kronecker) product of single-qubit unitaries. - -* The passes [`Collect2qBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks "qiskit.transpiler.passes.Collect2qBlocks"), [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") and [`Split2QUnitaries`](/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries "qiskit.transpiler.passes.Split2QUnitaries") have been added to the `init` stage of the preset pass managers with optimization level 2 and optimization level 3. The modification of the init stage should allow for a more efficient routing for quantum circuits that either: - - > * contain two-qubit unitaries/gates that are actually a product of single-qubit gates - > * contain multiple two-qubit gates in a continuous block of two-qubit gates. - - In the former case, the routing of the two-qubit gate can simply be skipped as no real interaction between a pair of qubits occurs. In the latter case, the lookahead space of routing algorithms is not ‘polluted’ by superfluous two-qubit gates, i.e. for routing it is sufficient to only consider one single two-qubit gate per continuous block of two-qubit gates. These passes are not run if the pass managers target a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") that has a discrete basis gate set, i.e. all basis gates have are not parameterized. - -* Port part of the logic from the `StarPrerouting`, used to find a star graph connectivity subcircuit and replaces it with a linear routing equivalent. - -* The function `star_preroute()` now performs the heavily lifting to transform the dag by in the rust space by taking advantage of the functions `_build_sabre_dag()` and `_apply_sabre_result()`. - -* A new `dt` argument has been added to [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") to match the set of arguments of [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). This will allow for the internal conversion of transpilation constraints to a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") representation. - -* Added multiple high-level-synthesis plugins for synthesizing an [`MCXGate`](/docs/api/qiskit/qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"): - - * [`MCXSynthesisNCleanM15`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisNCleanM15 "qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisNCleanM15"), based on [`synth_mcx_n_clean_m15()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_n_clean_m15 "qiskit.synthesis.synth_mcx_n_clean_m15"). - * [`MCXSynthesisNDirtyI15`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisNDirtyI15 "qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisNDirtyI15"), based on [`synth_mcx_n_dirty_i15()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_n_dirty_i15 "qiskit.synthesis.synth_mcx_n_dirty_i15"). - * [`MCXSynthesis1CleanB95`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesis1CleanB95 "qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesis1CleanB95"), based on [`synth_mcx_1_clean_b95()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_1_clean_b95 "qiskit.synthesis.synth_mcx_1_clean_b95"). - * [`MCXSynthesisNoAuxV24`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisNoAuxV24 "qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisNoAuxV24"), based on [`synth_mcx_noaux_v24()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_noaux_v24 "qiskit.synthesis.synth_mcx_noaux_v24"). - * [`MCXSynthesisGrayCode`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisGrayCode "qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisGrayCode"), based on [`synth_mcx_gray_code()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_mcx_gray_code "qiskit.synthesis.synth_mcx_gray_code"). - - As well: - - * [`MCXSynthesisDefault`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisDefault "qiskit.transpiler.passes.synthesis.hls_plugins.MCXSynthesisDefault"), choosing the most efficient synthesis method based on the number of clean and dirty ancilla qubits available. - - As an example, consider how the transpilation of the following circuit: - - ```python - from qiskit.circuit import QuantumCircuit - from qiskit.compiler import transpile - - qc = QuantumCircuit(7) - qc.x(0) - qc.mcx([0, 1, 2, 3], [4]) - qc.mcx([0, 1, 2, 3, 4], [5]) - qc.mcx([0, 1, 2, 3, 4, 5], [6]) - - transpile(qc) - ``` - - For the first MCX gate, qubits `5` and `6` can be used as clean ancillas, and the best available synthesis method `synth_mcx_n_clean_m15` will get chosen. For the second MCX gate, qubit `6` can be used as a clean ancilla, the method `synth_mcx_n_clean_m15` no longer applies, so the method `synth_mcx_1_clean_b95` will get chosen. For the third MCX gate, there are no ancilla qubits, and the method `synth_mcx_noaux_v24` will get chosen. - -* The implementation of the [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") has been rewritten in Rust. This rewrite of the Python class should be fully API compatible with the previous Python implementation of the class. While the class was previously implemented using [rustworkx](https://www.rustworkx.org/) and its underlying data graph structure existed in Rust, the implementation of the class and all the data was stored in Python. This new version of [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") stores a Rust native representation for all its data and is fully implemented in Rust. This new implementation should be more efficient in memory usage as it compresses the qubit and clbit representation for instructions at rest. It also enables speed up for transpiler passes as they can fully manipulate a [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") from Rust. - -* A new argument `qubits_initially_zero` has been added to [`qiskit.compiler.transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"), [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager"), and to [`PassManagerConfig`](/docs/api/qiskit/qiskit.transpiler.PassManagerConfig "qiskit.transpiler.PassManagerConfig"). If set to `True`, the qubits are assumed to be initially in the state $|0\rangle$, potentially allowing additional optimization opportunities for individual transpiler passes. - -* The constructor for [`HighLevelSynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") transpiler pass now accepts an additional argument `qubits_initially_zero`. If set to `True`, the pass assumes that the qubits are initially in the state $|0\rangle$. In addition, the pass keeps track of clean and dirty auxiliary qubits throughout the run, and passes this information to plugins via kwargs `num_clean_ancillas` and `num_dirty_ancillas`. - -* Added a new method `DAGCircuit.control_flow_ops()` which provides a fast path to get all the [`DAGOpNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") in a [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") that contain a [`ControlFlowOp`](/docs/api/qiskit/qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp"). This was possible before using the [`DAGCircuit.op_nodes()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#op_nodes "qiskit.dagcircuit.DAGCircuit.op_nodes") method and passing the [`ControlFlowOp`](/docs/api/qiskit/qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp") class as a filter, but this new function will perform the operation faster. - -* Ported the entirety of the [`Optimize1qGatesDecomposition`](/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition") transpiler pass to Rust. This improves the runtime performance of the pass between 5x to 10x. - -* Added a Rust implementation of [`CommutationAnalysis`](/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis "qiskit.transpiler.passes.CommutationAnalysis") in `analyze_commutations()`. - -* The the [`CommutationChecker`](/docs/api/qiskit/qiskit.circuit.CommutationChecker "qiskit.circuit.CommutationChecker") class has been reimplemented in Rust. This retains the same functionality as before but is now significantly in most cases. - -* The [`RemoveDiagonalGatesBeforeMeasure`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure "qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure") transpiler pass has been upgraded to include more diagonal gates: [`PhaseGate`](/docs/api/qiskit/qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"), [`CPhaseGate`](/docs/api/qiskit/qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"), [`CSGate`](/docs/api/qiskit/qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate"), [`CSdgGate`](/docs/api/qiskit/qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate") and [`CCZGate`](/docs/api/qiskit/qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate"). In addition, the code of the [`RemoveDiagonalGatesBeforeMeasure`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure "qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure") was ported to Rust, and is now x20 faster for a 20 qubit circuit. - - - - - -### Visualization Features - -* The user configuration file has a new option `circuit_idle_wires`, which takes a Boolean value. This allows users to set their preferred default behavior of the `idle_wires` option of the circuit drawers [`QuantumCircuit.draw()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#draw "qiskit.circuit.QuantumCircuit.draw") and [`circuit_drawer()`](/docs/api/qiskit/qiskit.visualization.circuit_drawer "qiskit.visualization.circuit_drawer"). For example, adding a section to `~/.qiskit/settings.conf` with: - - ```text - [default] - circuit_idle_wires = false - ``` - - will change the default to display the bits in reverse order. - -* The text and [Matplotlib](https://matplotlib.org) circuit drawers ([`QuantumCircuit.draw()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#draw "qiskit.circuit.QuantumCircuit.draw")) have minimal support for displaying expressions involving manual real-time variables. The [`Store`](/docs/api/qiskit/circuit#qiskit.circuit.Store "qiskit.circuit.Store") operation and the variable initializations are not yet supported; for large-scale dynamic circuits, we recommend using the OpenQASM 3 export capabilities ([`qasm3.dumps()`](/docs/api/qiskit/qasm3#qiskit.qasm3.dumps "qiskit.qasm3.dumps")) to get a textual representation of a circuit. - - - - - -### Misc. Features - -* Added a new build-time environment variable `QISKIT_NO_CACHE_GATES` which when set to a value of `1` (i.e. `QISKIT_NO_CACHE_GATES=1`) which decreases the memory overhead of a [`CircuitInstruction`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") and [`DAGOpNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") object at the cost of decreased runtime on multiple accesses to [`CircuitInstruction.operation`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#operation "qiskit.circuit.CircuitInstruction.operation") and [`DAGOpNode.op`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode#op "qiskit.dagcircuit.DAGOpNode.op"). If this environment variable is set when building the Qiskit python package from source the caching of the return of these attributes will be disabled. - - - - - -### Upgrade Notes - -* The minimum supported version of Python is now 3.9, this has been raised from the previous minimum support version of 3.8. This change was necessary because the upstream cPython project no longer supports Python 3.8. - - - - - -### Circuits Upgrade Notes - -* The `annotated` argument of the [`Gate.control()`](/docs/api/qiskit/qiskit.circuit.Gate#control "qiskit.circuit.Gate.control") method is now `None`, which allows Qiskit to choose whether to annotate a controlled operation. If the concrete implementation (`annotated=False`) is available, it will be returned by default. Otherwise, the annotated implementation will be returned (`annotated=True`). This allows, for example, to defer the synthesis of controlled, parameterized gates. - -* The [`Operation`](/docs/api/qiskit/qiskit.circuit.Operation "qiskit.circuit.Operation") instances of [`DAGOpNode.op`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode#op "qiskit.dagcircuit.DAGOpNode.op") being returned will not necessarily share a common reference to the underlying object anymore. This was never guaranteed to be the case and mutating the [`op`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode#op "qiskit.dagcircuit.DAGOpNode.op") directly by reference was unsound and always likely to corrupt the dag’s internal state tracking Due to the internal refactor of the [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") and [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") to store standard gates in rust the output object from [`DAGOpNode.op`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode#op "qiskit.dagcircuit.DAGOpNode.op") will now likely be a copy instead of a shared instance. If you need to mutate an element should ensure that you either do: - - ```python - op = dag_node.op - op.params[0] = 3.14159 - dag_node.op = op - ``` - - or: - - ```python - op = dag_node.op - op.params[0] = 3.14159 - dag.substitute_node(dag_node, op) - ``` - - instead of doing something like: - - ```python - dag_node.op.params[0] = 3.14159 - ``` - - which will not work for any standard gates in this release. It would have likely worked by chance in a previous release but was never an API guarantee. - -* The [`Operation`](/docs/api/qiskit/qiskit.circuit.Operation "qiskit.circuit.Operation") instances of [`CircuitInstruction.operation`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#operation "qiskit.circuit.CircuitInstruction.operation") being returned will not necessarily share a common reference to the underlying object anymore. This was never guaranteed to be the case and mutating the [`operation`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#operation "qiskit.circuit.CircuitInstruction.operation") directly by reference was unsound and always likely to corrupt the circuit, especially when parameters were in use. Due to the internal refactor of the QuantumCircuit to store standard gates in rust the output object from [`CircuitInstruction.operation`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#operation "qiskit.circuit.CircuitInstruction.operation") will now likely be a copy instead of a shared instance. If you need to mutate an element in the circuit (which is strongly **not** recommended as it’s inefficient and error prone) you should ensure that you do: - - ```python - from qiskit.circuit import QuantumCircuit - - qc = QuantumCircuit(1) - qc.p(0) - - op = qc.data[0].operation - op.params[0] = 3.14 - - qc.data[0] = qc.data[0].replace(operation=op) - ``` - - instead of doing something like: - - ```python - from qiskit.circuit import QuantumCircuit - - qc = QuantumCircuit(1) - qc.p(0) - - qc.data[0].operation.params[0] = 3.14 - ``` - - which will not work for any standard gates in this release. It would have likely worked by chance in a previous release but was never an API guarantee. - - - - - -### Primitives Upgrade Notes - -* [`BitArray.slice_bits()`](/docs/api/qiskit/qiskit.primitives.BitArray#slice_bits "qiskit.primitives.BitArray.slice_bits") and [`BitArray.slice_shots()`](/docs/api/qiskit/qiskit.primitives.BitArray#slice_shots "qiskit.primitives.BitArray.slice_shots") will now raise `IndexError` when indices are out of bounds. They used to raise `ValueError` in the case. - -* `BitArray.__getitem__()` will now raise `IndexError` when indices are out of bounds or the number of dimensions of indices does not match that of BitArray. They used to raise `ValueError` in the case. - - - - - -### Providers Upgrade Notes - -* Implementations of [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") (and `BackendV1`) may desire to update their [`run()`](/docs/api/qiskit/qiskit.providers.BackendV2#run "qiskit.providers.BackendV2.run") methods to eagerly reject inputs containing typed classical variables (see [`qiskit.circuit.classical`](/docs/api/qiskit/circuit_classical#module-qiskit.circuit.classical "qiskit.circuit.classical")) and the [`Store`](/docs/api/qiskit/circuit#qiskit.circuit.Store "qiskit.circuit.Store") instruction, if they do not have support for them. The new [`Store`](/docs/api/qiskit/circuit#qiskit.circuit.Store "qiskit.circuit.Store") instruction is treated by the transpiler as an always-available “directive” (like [`Barrier`](/docs/api/qiskit/circuit#qiskit.circuit.Barrier "qiskit.circuit.Barrier")); if your backends do not support this won’t be caught by the [`transpiler`](/docs/api/qiskit/transpiler#module-qiskit.transpiler "qiskit.transpiler"). - - See [Real-time variables](/docs/api/qiskit/providers#providers-guide-real-time-variables) for more information. - - - - - -### QPY Upgrade Notes - -* The value of [`qiskit.qpy.QPY_VERSION`](/docs/api/qiskit/qpy#qiskit.qpy.QPY_VERSION "qiskit.qpy.QPY_VERSION") is now 12. [`QPY_COMPATIBILITY_VERSION`](/docs/api/qiskit/qpy#qiskit.qpy.QPY_COMPATIBILITY_VERSION "qiskit.qpy.QPY_COMPATIBILITY_VERSION") is unchanged at 10. - - - - - -### Synthesis Upgrade Notes - -* The `atomic_evolution` argument to [`ProductFormula`](/docs/api/qiskit/qiskit.synthesis.ProductFormula "qiskit.synthesis.ProductFormula") (and its subclasses) has a new function signature. Rather than taking some Pauli operator and time coefficient and returning the evolution circuit, the new function takes in an existing circuit and should append the evolution of the provided Pauli and given time to this circuit. This new implementation benefits from significantly better performance. - -* [`LieTrotter`](/docs/api/qiskit/qiskit.synthesis.LieTrotter "qiskit.synthesis.LieTrotter") and [`SuzukiTrotter`](/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter "qiskit.synthesis.SuzukiTrotter") no longer wrap the individually evolved Pauli terms into gate definitions. If you rely on a certain decomposition level of your circuit, you have to remove one level of [`decompose()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#decompose "qiskit.circuit.QuantumCircuit.decompose") or add the `wrap=True` keyword argument to your synthesis object. - - - - - -### Transpiler Upgrade Notes - -* The default `optimization_level` used by the [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") function when one is not specified has been changed to level 2. This makes it consistent with the default used by [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") which is used internally by [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). Optimization level 2 provides a much better balance between the run time of the function and the optimizations it performs, it’s a better tradeoff to use by default. - - The API of [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") remains unchanged because, fundamentally, level 2 and level 1 have the same semantics. If you were previously relying on the implicit default of level 1, you can simply set the argument `optimization_level=1` when you call [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). Similarly you can change the default back in your local environment by using a user config file and setting the `transpile_optimization_level` field to 1. - - The only potential issue is that your transpilation workflow may be relying on an implicit trivial layout (where qubit 0 in the circuit passed to [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") is mapped to qubit 0 on the target backend/coupling, 1->1, 2->2, etc.) without specifying `optimization_level=1`, `layout_method="trivial"`, or explicitly setting `initial_layout` when calling [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). This behavior was a side effect of the preset pass manager construction in optimization level 1 and is not mirrored in level 2. If you need this behavior you can use any of the three options listed previously to make this behavior explicit. - - Similarly, if you were targeting a discrete basis gate set you may encounter an issue using the new default with optimization level 2 (or running explicitly optimization level 3), as the additional optimization passes that run in level 2 and 3 don’t work in all cases with a discrete basis. You can explicitly set `optimization_level=1` manually in this case. In general the transpiler does not currently fully support discrete basis sets and if you’re relying on this you should likely construct a pass manager manually to build a compilation pipeline that will work with your target. - -* The default routing pass used by optimization level 0 for [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") and [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") has been changed from `StochasticSwap` to [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap"). The [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap") pass performs exactly the same function but performs better in both runtime and output quality (in number of swap gates and depth) compared to `StochasticSwap`. For `optimization_level=0` this shouldn’t matter because it’s not expected to run routing for the typical use case of level 0. - - If you were relying on the previous default routing algorithm for any reason you can use the `routing_method` argument for [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") to `"stochastic"` to use the `StochasticSwap` pass. - -* The [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") function has been upgraded to, when possible, internally convert transpiler constraints into a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") instance. If a backend input of type `BackendV1` is provided, it will be converted to [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") to expose its [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target"). This change does not require any user action. - -* [`DAGNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode") objects (and its subclasses [`DAGInNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode"), [`DAGOutNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode"), and [`DAGOpNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")) no longer return references to the same underlying object from [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") methods. This was never a guarantee before that all returned nodes would be shared reference to the same object, but with the migration of the [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") to Rust when a [`DAGNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode") a new [`DAGNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode") instance is generated on the fly when a node is returned to Python. These objects will evaluate as equal using `==` or similar checks that rely on `__eq__` but will no longer identify as the same object. - -* The [`DAGOpNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") instances returned from the [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") are no longer shared references to the underlying data stored on the DAG. In previous release it was possible to do something like: - - ```python - for node in dag.op_nodes(): - node.op = new_op - ``` - - however this type of mutation was always unsound as it could break the DAG’s internal caching and cause corruption of the data structure. Instead you should use the API provided by [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") for mutation such as [`DAGCircuit.substitute_node()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#substitute_node "qiskit.dagcircuit.DAGCircuit.substitute_node"), [`DAGCircuit.substitute_node_with_dag()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#substitute_node_with_dag "qiskit.dagcircuit.DAGCircuit.substitute_node_with_dag"), or `DAGCircuit.contract_node()`. For example the above code block would become: - - ```python - for node in dag.op_nodes(): - dag.substitute_node(node, new_op) - ``` - - This is similar to an upgrade note from 1.2.0 where this was noted on for mutation of the [`DAGOpNode.op`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode#op "qiskit.dagcircuit.DAGOpNode.op") attribute, not the [`DAGOpNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") itself. However in 1.3 this extends to the entire object, not just it’s inner `op` attribute. In general this type of mutation was always unsound and not supported, but could previously have potentially worked in some cases. - -* The [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") now assumes that the qubits are initially in the state $|0\rangle$. To avoid this assumption, one can set the argument `qubits_initially_zero` to `False`. - - - - - -### Misc. Upgrade Notes - -* The minimum version of rustworkx required to run this release has been increased from 0.14.0 to 0.15.0. This is required because Qiskit is now using new functionality added in the rustworkx 0.15.0 release which improves performance. - - - - - -### Circuits Deprecations - -* The following circuit methods were not intended for public use, but were accidentally left documented in the public API during the 1.0 release. They are now deprecated from Qiskit 1.2 and will be removed in Qiskit 2.0: - - > * `QuantumCircuit.cast` - > * `QuantumCircuit.cls_instances` - > * `QuantumCircuit.cls_prefix` - > * `QuantumCircuit.cbit_argument_conversion` - > * `QuantumCircuit.qbit_argument_conversion` - -* Treating [`CircuitInstruction`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") as a tuple-like iterable is deprecated, and this legacy path way will be removed in Qiskit 2.0. You should use the attribute-access fields [`operation`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#operation "qiskit.circuit.CircuitInstruction.operation"), [`qubits`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#qubits "qiskit.circuit.CircuitInstruction.qubits"), and [`clbits`](/docs/api/qiskit/qiskit.circuit.CircuitInstruction#clbits "qiskit.circuit.CircuitInstruction.clbits") instead. For example: - - ```python - from qiskit.circuit import QuantumCircuit - - qc = QuantumCircuit(2, 2) - qc.h(0) - qc.cx(0, 1) - qc.measure([0, 1], [0, 1]) - - # Deprecated. - for op, qubits, clbits in qc.data: - pass - # New style. - for instruction in qc.data: - op = instruction.operation - qubits = instruction.qubits - clbits = instruction.clbits - ``` - - - -### Primitives Deprecations - -* Primitive V1 implementations and V1-exclusive non-versioned type aliases are now deprecated in favor of their V2 counterparts. The deprecation is extended to the following classes implementing V1 interfaces: - - * `Estimator`, in favor of the V2 equivalent, [`StatevectorEstimator`](/docs/api/qiskit/qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator") - * `Sampler`, in favor of the V2 equivalent, [`StatevectorSampler`](/docs/api/qiskit/qiskit.primitives.StatevectorSampler "qiskit.primitives.StatevectorSampler") - * `BackendEstimator`, in favor of the V2 equivalent, [`BackendEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2 "qiskit.primitives.BackendEstimatorV2") - * `BackendSampler`, in favor of the V2 equivalent, [`BackendSamplerV2`](/docs/api/qiskit/qiskit.primitives.BackendSamplerV2 "qiskit.primitives.BackendSamplerV2") - - As well as the following non-versioned type aliases: - - * `BaseEstimator`, alias for [`BaseEstimatorV1`](/docs/api/qiskit/qiskit.primitives.BaseEstimatorV1 "qiskit.primitives.BaseEstimatorV1") - * `BaseSampler`, alias for [`BaseSamplerV1`](/docs/api/qiskit/qiskit.primitives.BaseSamplerV1 "qiskit.primitives.BaseSamplerV1") - - This deprecation does NOT affect the explicitly-versioned `BaseEstimatorV1` and `BaseSamplerV1` abstract interface definitions or related result and job classes. - - In addition, the following utility functions are deprecated: - - * `init_circuit()`, to initialize a circuit from a [`Statevector`](/docs/api/qiskit/qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector"), use [`QuantumCircuit.initialize()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#initialize "qiskit.circuit.QuantumCircuit.initialize") instead, - * `init_observable()`, use the constructor of [`SparsePauliOp`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") instead, - * `final_measurement_mapping()`, use `QuantumCircuit.layout()` and [`SparsePauliOp.apply_layout()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#apply_layout "qiskit.quantum_info.SparsePauliOp.apply_layout") to adjust an operator for a layout. Otherwise, use `mthree.utils.final_measurement_mapping`. See [Mthree Utility functions](https://qiskit-extensions.github.io/mthree/apidocs/utils.html) for details. - - - - - -### Providers Deprecations - -* The `BackendV1` class is deprecated and it will be removed not earlier than the next major release. There are several migration paths available depending on the main purpose of the backend object: - - ```python - - To expose backend information with no access to execution (just a hardware description), consider constructing a :class:`.Target` directly. - - To provides access to execution capabilities, consider relying on the primitives interfaces instead. - - Alternatively, to continue providing simultaneous :class:`.Target` (hardware information) and ``run`` (execution) capabilities, consider moving to :class:`.BackendV2` (see ). - ``` - -* The models in `qiskit.providers.models` are part of the deprecated `BackendV1` workflow and no longer necessary for [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). If a user workflow requires these representations it likely relies on deprecated functionality and should be updated to use [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). - -* The Qobj structure and related classes are now deprecated, they were introduced as part of the BackendV1 workflow and are no longer necessary for interacting with [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") backends. Remote backend interaction should be done via QPY or OpenQASM instead. - - - - - -### Transpiler Deprecations - -* The assemble function is now deprecated and will be removed in the 2.0 release. The function was primarily used to create a Qobj, which is no longer necessary in [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2")-based workflows. It was also used for binding parameters, a functionality fully covered by [`assign_parameters()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#assign_parameters "qiskit.circuit.QuantumCircuit.assign_parameters"). - -* Deprecated `StochasticSwap` which has been superseded by [`SabreSwap`](/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap"). If the class is called from the transpile function, the change would be, for example: - - ```python - from qiskit import transpile - from qiskit.circuit import QuantumCircuit - from qiskit.transpiler import CouplingMap - from qiskit.providers.fake_provider import GenericBackendV2 - - - qc = QuantumCircuit(4) - qc.h(0) - qc.cx(0, range(1, 4)) - qc.measure_all() - - cmap = CouplingMap.from_heavy_hex(3) - backend = GenericBackendV2(num_qubits=cmap.size(), coupling_map=cmap) - - tqc = transpile( - qc, - routing_method="stochastic", - layout_method="dense", - seed_transpiler=12342, - target=backend.target - ) - ``` - - to: - - ```python - tqc = transpile( - qc, - routing_method="sabre", - layout_method="sabre", - seed_transpiler=12342, - target=backend.target - ) - ``` - - While for a pass manager, the change would be: - - ```python - passmanager = PassManager(StochasticSwap(coupling, 20, 13)) - new_qc = passmanager.run(qc) - ``` - - to: - - ```python - passmanager = PassManager(SabreSwap(backend.target, "basic")) - new_qc = passmanager.run(qc) - ``` - - - - - -### Visualization Deprecations - -* The `transition_visualization()` function has been deprecated and will be removed in the 2.0.0 release. This function had a number of limitations which limited it’s utility to only very specific use cases and didn’t fit in with the rest of the Qiskit visualization module. - -* The `justify` argument of `circuit_drawer()` or `QuantumCircuit.draw()`, will no longer support invalid values (previously changing them to the default), and in a future release they will error. Valid justify values are `"left"`, `"right"` or `"none"`. - - - - - -### Bug Fixes - -* Fixes an issue with the visualizations of some backends/coupling maps that showed as folded on their own. The default \`\`neato\` setting \<[https://graphviz.org/docs/layouts/neato/](https://graphviz.org/docs/layouts/neato/)>\`\_ works well in most cases. However, `prism` overlap returns a more regular layout for other scenarios. - -* Fixed a series of issues when controlling parameterized standard gates. The controlled version of some gates (e.g. [`RXXGate`](/docs/api/qiskit/qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate") or [`RYGate`](/docs/api/qiskit/qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate") for more than 1 control) cannot be synthesized if they contain unbound parameters. Previously, calling `.control()` but now we create an [`AnnotatedOperation`](/docs/api/qiskit/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") as placeholder. This allows to insert the controlled gate into a circuit, bind the parameters at a later stage, and then synthesize the operation. Fixes [#10311](https://github.com/Qiskit/qiskit/issues/10311), [#10697](https://github.com/Qiskit/qiskit/issues/10697), and [#12135](https://github.com/Qiskit/qiskit/issues/12135). - -* The [`SGate`](/docs/api/qiskit/qiskit.circuit.library.SGate "qiskit.circuit.library.SGate") and [`SdgGate`](/docs/api/qiskit/qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate") now correctly return a [`CSGate`](/docs/api/qiskit/qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate"), resp. [`CSdgGate`](/docs/api/qiskit/qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate"), if they are controlled on a single control qubit. - -* Parametric controlled standard-library gates (such as [`CRXGate`](/docs/api/qiskit/qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate")) will now get correctly extracted to a Rust-space standard gate when using [`QuantumCircuit.append()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#append "qiskit.circuit.QuantumCircuit.append") and the gate object. Previously there was a discrepancy where using the [`QuantumCircuit.crx()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#crx "qiskit.circuit.QuantumCircuit.crx") method would cause a correct extraction in Rust space, but the `append()` form would not. The bug should generally not have caused any unsoundness from Python. - -* Fixed a bug in [`TwoQubitBasisDecomposer`](/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer "qiskit.synthesis.TwoQubitBasisDecomposer") where the Rust-based code would panic if the given KAK gate wasn’t a Rust-space `StandardGate`. - -* Fixed a bug where [`InstructionDurations.from_backend()`](/docs/api/qiskit/qiskit.transpiler.InstructionDurations#from_backend "qiskit.transpiler.InstructionDurations.from_backend") did not work for [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") backends. Fixed #12760 \<[https://github.com/Qiskit/qiskit/issues/12760](https://github.com/Qiskit/qiskit/issues/12760)>. - -* Fixed a bug in [`BitArray.from_counts()`](/docs/api/qiskit/qiskit.primitives.BitArray#from_counts "qiskit.primitives.BitArray.from_counts") and [`BitArray.from_samples()`](/docs/api/qiskit/qiskit.primitives.BitArray#from_samples "qiskit.primitives.BitArray.from_samples"). Previously these would raise an error if given data containing only zeros, and no value for the optional argument `num_bits`. Now they produce a [`BitArray`](/docs/api/qiskit/qiskit.primitives.BitArray "qiskit.primitives.BitArray") with [`BitArray.num_bits`](/docs/api/qiskit/qiskit.primitives.BitArray#num_bits "qiskit.primitives.BitArray.num_bits") set to 1. - -* Fixed a bug in the [`ConsolidateBlocks`](/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks") transpiler pass, when the input circuit contains a custom opaque gate and neither the `basis_gates` or `target` options are set the pass would raise a `QiskitError` and fail. This has been corrected so that the in these situations the transpiler pass will not consolidate the block identified containing a custom gate instead of failing. - -* Fixed the definition of the [`CUGate`](/docs/api/qiskit/qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate") matrix in Rust-space. While this was not noticable while handling the [`CUGate`](/docs/api/qiskit/qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate") purely on Python side, this had knock-on effects when transpiler passes were using the Rust representation, such as could happen in `Consolidate2qBlocks`. Fixed [#13118](https://github.com/Qiskit/qiskit/issues/13118). - -* Fixed a bug in [`PadDynamicalDecoupling`](/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling "qiskit.transpiler.passes.PadDynamicalDecoupling"), which previously did not correctly display the error message that a delay is not pulse-aligned, if the previous or following node was an input/output node. Now, the error message is correctly displayed. - -* Fixed a bug in [`HoareOptimizer`](/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer "qiskit.transpiler.passes.HoareOptimizer") where a controlled gate was simplified by removing its controls but the new gate was not handled correctly. - -* The keyword argument `order` of the function [`BitArray.from_bool_array()`](/docs/api/qiskit/qiskit.primitives.BitArray#from_bool_array "qiskit.primitives.BitArray.from_bool_array") should be ‘little’ or ‘big’. Added checks to raise error if an invalid value is entered. - -* Improve the decomposition of the gate generated by [`QuantumCircuit.mcx()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#mcx "qiskit.circuit.QuantumCircuit.mcx") without using ancilla qubits, so that the number of [`CXGate`](/docs/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") will grow quadratically in the number of qubits and not exponentially. - -* Fixed the behavior of `generate_preset_pass_manager()` to raise a ValueError exception if not provided with a non-negative integer seed\_transpiler argument. - -* Fixed an edge case in [`SabreLayout`](/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout"), where in rare cases on large devices and challenging circuits, the routing would fail. This was due to the release valve making more than one two-qubit gate routable, where only one was expected. Fixed [#13081](https://github.com/Qiskit/qiskit/issues/13081). - -* Fixed a bug in [`Split2QUnitaries`](/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries "qiskit.transpiler.passes.Split2QUnitaries") where it would fail to run on circuits with custom gates that didn’t implement `__array__()`. See [#12984](https://github.com/Qiskit/qiskit/issues/12970). - -* Fixed a bug in [`StatePreparation`](/docs/api/qiskit/qiskit.circuit.library.StatePreparation "qiskit.circuit.library.StatePreparation") where the `normalize` argument was ignored for input arrays. Fixed [#12984](https://github.com/Qiskit/qiskit/issues/12984). - -* Fixed a bug of [`StatevectorSampler`](/docs/api/qiskit/qiskit.primitives.StatevectorSampler "qiskit.primitives.StatevectorSampler") that ignored gates with `c_if`. It will raise an error because [`Statevector`](/docs/api/qiskit/qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") cannot handle `c_if`. - -* Fixed a bug where various synthesis methods created circuits without quantum or classical registers. This also affected functions that internally used the synthesis methods, such as [`Clifford.to_circuit()`](/docs/api/qiskit/qiskit.quantum_info.Clifford#to_circuit "qiskit.quantum_info.Clifford.to_circuit"). Fixed [#13041](https://github.com/Qiskit/qiskit/issues/13041). - -* Fix a bug that caused the method `Initialize.gates_to_uncompute()` fail. - -* [`MCXVChain`](/docs/api/qiskit/qiskit.circuit.library.MCXVChain "qiskit.circuit.library.MCXVChain") with k controls and k-2 dirty auxiliary qubits now requires 8k-6 cx gates. - -* Fixed a bug in `synth_cnot_full_pmh()` where providing a `section_size` that did not divide the number of qubits without remainder could lead to wrong results. Now any `section_size` (at most equal to the number of qubits) synthesizes the correct circuit. For a (heuristically) optimal value, set `section_size=None`. - -* The OpenQASM 3 exporter will now correctly error when asked to use a keyword or other invalid identifier as a “basis gate”, as it has no way of putting out correct output in these cases. - -* The OpenQASM 3 exporter ([`qiskit.qasm3`](/docs/api/qiskit/qasm3#module-qiskit.qasm3 "qiskit.qasm3")) will now correctly export multiple instances of [`PauliEvolutionGate`](/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate") from a circuit. Previously, only a single instance would be exported, and all other instances would silently use the same (incorrect) version. - -* The OpenQASM 3 exporter ([`qiskit.qasm3`](/docs/api/qiskit/qasm3#module-qiskit.qasm3 "qiskit.qasm3")) will now correctly escape gate names. Previously, a gate whose name was an invalid OpenQASM 3 identifier would cause invalid OpenQASM 3 to be generated. - -* Fixed an edge case when transpiling a circuit with `optimization_level` 2 or 3 with an incomplete 1-qubit basis gate set on a circuit containing 2-qubit gates, that can be implemented as a product of single qubit gates. This bug is resolved by restricting [`Split2QUnitaries`](/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries "qiskit.transpiler.passes.Split2QUnitaries") to consider only [`UnitaryGate`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate") objects. Fixed [#12970](https://github.com/Qiskit/qiskit/issues/12970). - -* A series of input-handling inconsistencies between [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") have been fixed. These inconsistencies would lead to different transpilation outputs for the same inputs, or [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") failing for certain input combinations accepted by [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). - -* Changes the way in which the [`BackendEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2 "qiskit.primitives.BackendEstimatorV2") class calculates the `std` to ensure that it matches the correct formula. - -* Fixed an issue where `circuit_drawer()` or the `QuantumCircuit.draw()` method would not raise a warning when an invalid value was passed to the `justify` argument, before changing it to the default. Now, it will raise a warning if an invalid value is passed. Valid justify values are `"left"`, `"right"` or `"none"`. Refer to #12089 \<[https://github.com/Qiskit/qiskit/issues/12089](https://github.com/Qiskit/qiskit/issues/12089)> for more details. - -* Fixed an issue with [`DAGCircuit.apply_operation_back()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#apply_operation_back "qiskit.dagcircuit.DAGCircuit.apply_operation_back") and [`DAGCircuit.apply_operation_front()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#apply_operation_front "qiskit.dagcircuit.DAGCircuit.apply_operation_front") where previously if you set a [`Clbit`](/docs/api/qiskit/circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") object to the input for the `qargs` argument it would silently be accepted. This has been fixed so the type mismatch is correctly identified and an exception is raised. - -* Fixed [`SparsePauliOp.apply_layout()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#apply_layout "qiskit.quantum_info.SparsePauliOp.apply_layout") and [`Pauli.apply_layout()`](/docs/api/qiskit/qiskit.quantum_info.Pauli#apply_layout "qiskit.quantum_info.Pauli.apply_layout") to raise [`QiskitError`](/docs/api/qiskit/exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") if duplicate indices or negative indices are provided as part of a layout. - -* Fixed a missing decorator in [`C3SXGate`](/docs/api/qiskit/qiskit.circuit.library.C3SXGate "qiskit.circuit.library.C3SXGate") that made it fail if [`Gate.to_matrix()`](/docs/api/qiskit/qiskit.circuit.Gate#to_matrix "qiskit.circuit.Gate.to_matrix") was called. The gate matrix is now return as expected. - -* Fixed a bug with the `"circular"` and `"sca"` entanglement for [`NLocal`](/docs/api/qiskit/qiskit.circuit.library.NLocal "qiskit.circuit.library.NLocal") circuits and its derivatives. For entanglement blocks of more than 2 qubits, the circular entanglement was previously missing some connections. For example, for 4 qubits and a block size of 3 the code previously used: - - ```python - [(2, 3, 0), (0, 1, 2), (1, 2, 3)] - ``` - - but now is correctly adding the `(3, 0, 1)` connections, that is: - - ```python - [(2, 3, 0), (3, 0, 1), (0, 1, 2), (1, 2, 3)] - ``` - - As such, the `"circular"` and `"sca"` entanglements use `num_qubits` entangling blocks per layer. - -* Add more Clifford gates to the [`CollectCliffords()`](/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords "qiskit.transpiler.passes.CollectCliffords") transpiler pass. In particular, we have added the gates `ECRGate()`, `DCXGate()`, `iSWAPGate()`, `SXGate()` and `SXdgGate()` to this transpiler pass. - -* Fix a bug in [`Isometry`](/docs/api/qiskit/qiskit.circuit.library.Isometry "qiskit.circuit.library.Isometry") due to an unnecessary assertion, that led to an error in [`UnitaryGate.control()`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate#control "qiskit.circuit.library.UnitaryGate.control") when [`UnitaryGate`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate") had more that two qubits. - -* The [`QuantumCircuit.parameters`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#parameters "qiskit.circuit.QuantumCircuit.parameters") attribute will now correctly be empty when using [`QuantumCircuit.copy_empty_like()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#copy_empty_like "qiskit.circuit.QuantumCircuit.copy_empty_like") on a parametric circuit. Previously, an internal cache would be copied over without invalidation. Fix [#12617](https://github.com/Qiskit/qiskit/issues/12617). - -* [`QuantumCircuit.depth()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#depth "qiskit.circuit.QuantumCircuit.depth") will now correctly handle operations that do not have operands, such as [`GlobalPhaseGate`](/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate "qiskit.circuit.library.GlobalPhaseGate"). - -* [`QuantumCircuit.depth()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#depth "qiskit.circuit.QuantumCircuit.depth") will now count the variables and clbits used in real-time expressions as part of the depth calculation. - -* Fix the [`SolovayKitaev`](/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev "qiskit.transpiler.passes.SolovayKitaev") transpiler pass when loading basic approximations from an exising `.npy` file. Previously, loading a stored approximation which allowed for further reductions (e.g. due to gate cancellations) could cause a runtime failure. Additionally, the global phase difference of the U(2) gate product and SO(3) representation was lost during a save-reload procedure. Fixes [Qiskit/qiskit#12576](https://github.com/Qiskit/qiskit/issues/12576). - -* Fixed [`SparsePauliOp.apply_layout()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#apply_layout "qiskit.quantum_info.SparsePauliOp.apply_layout") to work correctly with zero-qubit operators. For example, if you previously created a 0 qubit and applied a layout like: - - ```python - op = SparsePauliOp("") - op.apply_layout(None, 3) - ``` - - this would have previously raised an error. Now this will correctly return an operator of the form: `SparsePauliOp(['III'], coeffs=[1.+0.j])` - -* Fixed a bug when [`SparsePauliOp.paulis`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#paulis "qiskit.quantum_info.SparsePauliOp.paulis") is set to be a [`PauliList`](/docs/api/qiskit/qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") with nonzero phase, where subsequent calls to several [`SparsePauliOp`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") methods would produce incorrect results. Now when [`SparsePauliOp.paulis`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#paulis "qiskit.quantum_info.SparsePauliOp.paulis") is set to a [`PauliList`](/docs/api/qiskit/qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") with nonzero phase, the phase is absorbed into [`SparsePauliOp.coeffs`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#coeffs "qiskit.quantum_info.SparsePauliOp.coeffs"), and the phase of the input [`PauliList`](/docs/api/qiskit/qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") is set to zero. - -* Fixed an oversight in the [`Commuting2qGateRouter`](/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter "qiskit.transpiler.passes.Commuting2qGateRouter") transpiler pass where the qreg permutations were not added to the pass property set, so they would have to be tracked manually by the user. Now it’s possible to access the permutation through the output circuit’s `layout` property and plug the pass into any transpilation pipeline without loss of information. - -* Fixed a floating-point imprecision when scaling certain pulse units between seconds and nanoseconds. If the pulse was symbolically defined, an unnecessary floating-point error could be introduced by the scaling for certain builds of `symengine`, which could manifest in unexpected results once the symbols were fully bound. See [#12392](https://github.com/Qiskit/qiskit/pull/12392). - -* Fixed a bug in `qiskit.visualization.pulse_v2.interface.draw()` that didn’t draw pulse schedules when the draw function was called with a [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") argument. Because the V2 backend doesn’t report hardware channel frequencies, the generated drawing will show ‘no freq.’ below each channel label. - -* Fixed an issue with [`dag_drawer()`](/docs/api/qiskit/qiskit.visualization.dag_drawer "qiskit.visualization.dag_drawer") and [`DAGCircuit.draw()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#draw "qiskit.dagcircuit.DAGCircuit.draw") when attempting to visualize a [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") instance that contained [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") wires. The visualizer would raise an exception trying to do this which has been fixed so the expected visualization will be generated. - -* The [`VF2Layout`](/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout") pass would raise an exception when provided with a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") instance without connectivity constraints. This would be the case with targets from Aer 0.13. The issue is now fixed. - -* Fixes an error when calling the method [`UnitaryGate.repeat()`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate#repeat "qiskit.circuit.library.UnitaryGate.repeat"). Refer to [#11990](https://github.com/Qiskit/qiskit/issues/11990) for more details. - -* The constructor [`GenericBackendV2`](/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2 "qiskit.providers.fake_provider.GenericBackendV2") was allowing to create malformed backends because it accepted basis gates that couldn’t be allocated in the backend size . That is, a backend with a single qubit should not accept a basis with two-qubit gates. - -* [`PassManager.run()`](/docs/api/qiskit/qiskit.transpiler.PassManager#run "qiskit.transpiler.PassManager.run") will no longer waste time serializing itself when given multiple inputs if it is only going to work in serial. - -* [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") was updated so that fully bound instances that compare equal to instances of Python’s built-in numeric types (like `float` and `int`) also have hash values that match those of the other instances. This change ensures that these types can be used interchangeably as dictionary keys. See [#12488](https://github.com/Qiskit/qiskit/pull/12488). - -* Fixed that the entanglement in [`PauliFeatureMap`](/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap") and [`ZZFeatureMap`](/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap") could be given as `List[int]` or `List[List[int]]`, which was incompatible with the fact that entanglement blocks of different sizes are used. Instead, the entanglement can be given as dictionary with `{block_size: entanglement}` pairs. - -* Fixed a bug in `plot_coupling_map()` that caused the edges of the coupling map to be colored incorrectly. See [https://github.com/Qiskit/qiskit/pull/12369](https://github.com/Qiskit/qiskit/pull/12369) for details. - -* The OpenQASM 2 parser ([`qiskit.qasm2`](/docs/api/qiskit/qasm2#module-qiskit.qasm2 "qiskit.qasm2")) can now handle conditionals with integers that do not fit within a 64-bit integer. Fixed [#12773](https://github.com/Qiskit/qiskit/issues/12773). - -* The OpenQASM 2.0 parser ([`qasm2.load()`](/docs/api/qiskit/qasm2#qiskit.qasm2.load "qiskit.qasm2.load") and [`qasm2.loads()`](/docs/api/qiskit/qasm2#qiskit.qasm2.loads "qiskit.qasm2.loads")) can now evaluate gate-angle expressions including integer operands that would overflow the system-size integer. These will be evaluated in a double-precision floating-point context, just like the rest of the expression always has been. Beware: an arbitrarily large integer will not necessarily be exactly representable in double-precision floating-point, so there is a chance that however the circuit was generated, it had already lost all numerical precision modulo $2\pi$. - -* Custom gates (those stemming from a `gate` statement) in imported OpenQASM 2 programs will now have an [`Gate.to_matrix()`](/docs/api/qiskit/qiskit.circuit.Gate#to_matrix "qiskit.circuit.Gate.to_matrix") implementation. Previously they would have no matrix definition, meaning that roundtrips through OpenQASM 2 could needlessly lose the ability to derive the gate matrix. Note, though, that the matrix is calculated by recursively finding the matrices of the inner gate definitions, as [`Operator`](/docs/api/qiskit/qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") does, which might be less performant than before the round-trip. - -* Previously, [`DAGCircuit.replace_block_with_op()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#replace_block_with_op "qiskit.dagcircuit.DAGCircuit.replace_block_with_op") allowed to place an `n`-qubit operation onto a block of `m` qubits, leaving the DAG in an invalid state. This behavior has been fixed, and the attempt will raise a [`DAGCircuitError`](/docs/api/qiskit/dagcircuit#qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError"). - -* `Target.has_calibration()` has been updated so that it does not raise an exception for an instruction that has been added to the target with `None` for its instruction properties. Fixes [#12525](https://github.com/Qiskit/qiskit/issues/12525). - - - - - -## 1.1.0rc1 - - - - - -### New Features - -* Extended the commutation analysis performed by [`CommutationChecker`](/docs/api/qiskit/qiskit.circuit.CommutationChecker "qiskit.circuit.CommutationChecker") to only operate on hardware circuits to also work with abstract circuits, i.e. each operation in the input quantum circuit is now checked for its matrix representation before proceeding to the analysis. In addition, the operation is now checked for its ability to be cached in the session commutation library. For example, this now enables computing whether [`AnnotatedOperation`](/docs/api/qiskit/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") commute. This enables transpiler passes that rely on [`CommutationChecker`](/docs/api/qiskit/qiskit.circuit.CommutationChecker "qiskit.circuit.CommutationChecker") internally, such as [`CommutativeCancellation`](/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation "qiskit.transpiler.passes.CommutativeCancellation"), during earlier stages of a default transpilation pipeline (prior to basis translation). - -* The methods [`power()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#power "qiskit.circuit.QuantumCircuit.power"), [`power()`](/docs/api/qiskit/qiskit.circuit.Gate#power "qiskit.circuit.Gate.power"), as well as the similar methods of subclasses of [`Gate`](/docs/api/qiskit/qiskit.circuit.Gate "qiskit.circuit.Gate") (such as of [`SGate`](/docs/api/qiskit/qiskit.circuit.library.SGate "qiskit.circuit.library.SGate")) all have an additional argument `annotated`. The default value of `False` corresponds to the existing behavior. Furthermore, for standard gates with an explicitly defined `power` method, the argument `annotated` has no effect, for example both `SGate().power(1.5, annotated=False)` and `SGate().power(1.5, annotated=True)` return a `PhaseGate`. The difference manifests for gates without an explicitly defined power method. The value of `False` returns a [`UnitaryGate`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate"), just as before, while the value of `True` returns an [`AnnotatedOperation`](/docs/api/qiskit/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") that represents the instruction modified with the “power modifier”. - -* The implementation [`BackendEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2 "qiskit.primitives.BackendEstimatorV2") of [`BaseEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2") was added. This estimator supports `BackendV1` and [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). - - ```python - import numpy as np - from qiskit import transpile - from qiskit.circuit.library import IQP - from qiskit.primitives import BackendEstimatorV2 - from qiskit.providers.fake_provider import Fake7QPulseV1 - from qiskit.quantum_info import SparsePauliOp, random_hermitian - - backend = Fake7QPulseV1() - estimator = BackendEstimatorV2(backend=backend) - n_qubits = 5 - mat = np.real(random_hermitian(n_qubits, seed=1234)) - circuit = IQP(mat) - observable = SparsePauliOp("Z" * n_qubits) - isa_circuit = transpile(circuit, backend=backend, optimization_level=1) - isa_observable = observable.apply_layout(isa_circuit.layout) - job = estimator.run([(isa_circuit, isa_observable)], precision=0.01) - result = job.result() - print(f"> Expectation value: {result[0].data.evs}") - print(f"> Standard error: {result[0].data.stds}") - print(f"> Metadata: {result[0].metadata}") - ``` - -* The implementation [`BackendSamplerV2`](/docs/api/qiskit/qiskit.primitives.BackendSamplerV2 "qiskit.primitives.BackendSamplerV2") of [`BaseSamplerV2`](/docs/api/qiskit/qiskit.primitives.BaseSamplerV2 "qiskit.primitives.BaseSamplerV2") was added. This sampler supports `BackendV1` and [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") that allow `memory` option to compute bitstrings. - - ```python - import numpy as np - from qiskit import transpile - from qiskit.circuit.library import IQP - from qiskit.primitives import BackendSamplerV2 - from qiskit.providers.fake_provider import Fake7QPulseV1 - from qiskit.quantum_info import random_hermitian - - backend = Fake7QPulseV1() - sampler = BackendSamplerV2(backend=backend) - n_qubits = 5 - mat = np.real(random_hermitian(n_qubits, seed=1234)) - circuit = IQP(mat) - circuit.measure_all() - isa_circuit = transpile(circuit, backend=backend, optimization_level=1) - job = sampler.run([isa_circuit], shots=100) - result = job.result() - print(f"> bitstrings: {result[0].data.meas.get_bitstrings()}") - print(f"> counts: {result[0].data.meas.get_counts()}") - print(f"> Metadata: {result[0].metadata}") - ``` - -* Added `ctrl_state` parameter to `QuantumCircuit.mcp()` and `MCPhaseGate()`. - - The `QuantumCircuit.mcp()` function and `MCPhaseGate()` have been updated to include a `ctrl_state` parameter. This enhancement allows users to specify the control state of the multi-controlled phase gate. The parameter can accept either a decimal value or a bitstring and defaults to controlling the ‘1’ state if not provided. - - ```python - from qiskit import QuantumCircuit - - qc = QuantumCircuit(4) - qc.mcp(0.2,[0,1,2],3,ctrl_state=2) - ``` - -* The transpiler pass [`ElidePermutations`](/docs/api/qiskit/qiskit.transpiler.passes.ElidePermutations "qiskit.transpiler.passes.ElidePermutations") runs by default with optimization level 2 and 3. Intuitively, removing [`SwapGate`](/docs/api/qiskit/qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")s and [`PermutationGate`](/docs/api/qiskit/qiskit.circuit.library.PermutationGate "qiskit.circuit.library.PermutationGate")s in a virtual circuit is almost always beneficial, as it makes the circuit shorter and easier to route. As [`OptimizeSwapBeforeMeasure`](/docs/api/qiskit/qiskit.transpiler.passes.OptimizeSwapBeforeMeasure "qiskit.transpiler.passes.OptimizeSwapBeforeMeasure") is a special case of [`ElidePermutations`](/docs/api/qiskit/qiskit.transpiler.passes.ElidePermutations "qiskit.transpiler.passes.ElidePermutations"), it has been removed from optimization level 3. - -* Added a new optimization transpiler pass, [`ElidePermutations`](/docs/api/qiskit/qiskit.transpiler.passes.ElidePermutations "qiskit.transpiler.passes.ElidePermutations"), which is designed to run prior to the [Layout stage](/docs/api/qiskit/transpiler#transpiler-preset-stage-layout) and will optimize away any [`SwapGate`](/docs/api/qiskit/qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")s and [`PermutationGate`](/docs/api/qiskit/qiskit.circuit.library.PermutationGate "qiskit.circuit.library.PermutationGate")s in a circuit by permuting virtual qubits. For example, taking a circuit with [`SwapGate`](/docs/api/qiskit/qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")s: - - ![\_images/release\_notes-9.png](/docs/images/api/qiskit/release_notes-9.avif) - - will remove the swaps when the pass is run: - - ```python - from qiskit.transpiler.passes import ElidePermutations - from qiskit.circuit import QuantumCircuit - - qc = QuantumCircuit(3) - qc.h(0) - qc.swap(0, 1) - qc.swap(2, 0) - qc.cx(1, 0) - qc.measure_all() - - ElidePermutations()(qc).draw("mpl") - ``` - - ![\_images/release\_notes-10.png](/docs/images/api/qiskit/release_notes-10.avif) - - The pass also sets the `virtual_permutation_layout` property set, storing the permutation of the virtual qubits that was optimized away. - -* The [`KMSSynthesisLinearFunction`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.KMSSynthesisLinearFunction "qiskit.transpiler.passes.synthesis.hls_plugins.KMSSynthesisLinearFunction") plugin for synthesizing [`LinearFunction`](/docs/api/qiskit/qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction") objects now accepts two additional options `use_inverted` and `use_transposed`. These option modify the matrix on which the underlying synthesis algorithm runs by possibly inverting and/or transposing it, and then suitably adjust the synthesized circuit. By varying these options, we generally get different synthesized circuits, and in cases may obtain better results than for their default values. - -* The [`PMHSynthesisLinearFunction`](/docs/api/qiskit/qiskit.transpiler.passes.synthesis.hls_plugins.PMHSynthesisLinearFunction "qiskit.transpiler.passes.synthesis.hls_plugins.PMHSynthesisLinearFunction") plugin for synthesizing [`LinearFunction`](/docs/api/qiskit/qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction") objects now accepts several additional options. The option `section_size` is passed to the underlying synthesis method. The options `use_inverted` and `use_transposed` modify the matrix on which the underlying synthesis algorithm runs by possibly inverting and/or transposing it, and then suitably adjust the synthesized circuit. By varying these options, we generally get different synthesized circuits, and in cases may obtain better results than for their default values. - -* The [`HLSConfig`](/docs/api/qiskit/qiskit.transpiler.passes.HLSConfig "qiskit.transpiler.passes.HLSConfig") now has two additional optional arguments. The argument `plugin_selection` can be set either to `"sequential"` or to `"all"`. If set to “sequential” (default), for every higher-level-object the [`HighLevelSynthesis`](/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") pass will consider the specified methods sequentially, in the order they appear in the list, stopping at the first method that is able to synthesize the object. If set to “all”, all the specified methods will be considered, and the best synthesized circuit, according to `plugin_evaluation_fn` will be chosen. The argument `plugin_evaluation_fn` is an optional callable that evaluates the quality of the synthesized quantum circuit; a smaller value means a better circuit. When set to `None`, the quality of the circuit is its size (i.e. the number of gates that it contains). - - The following example illustrates the new functionality: - - ```python - from qiskit import QuantumCircuit - from qiskit.circuit.library import LinearFunction - from qiskit.synthesis.linear import random_invertible_binary_matrix - from qiskit.transpiler.passes import HighLevelSynthesis, HLSConfig - - # Create a circuit with a linear function - mat = random_invertible_binary_matrix(7, seed=37) - qc = QuantumCircuit(7) - qc.append(LinearFunction(mat), [0, 1, 2, 3, 4, 5, 6]) - - # Run different methods with different parameters, - # choosing the best result in terms of depth. - hls_config = HLSConfig( - linear_function=[ - ("pmh", {}), - ("pmh", {"use_inverted": True}), - ("pmh", {"use_transposed": True}), - ("pmh", {"use_inverted": True, "use_transposed": True}), - ("pmh", {"section_size": 1}), - ("pmh", {"section_size": 3}), - ("kms", {}), - ("kms", {"use_inverted": True}), - ], - plugin_selection="all", - plugin_evaluation_fn=lambda circuit: circuit.depth(), - ) - - # synthesize - qct = HighLevelSynthesis(hls_config=hls_config)(qc) - ``` - - In the example, we run multiple synthesis methods with different parameters, choosing the best circuit in terms of depth. Note that optimizing `circuit.size()` instead would pick a different circuit. - -* Added ctrl\_state parameter to `QuantumCircuit.mcx()`. - - The `QuantumCircuit.mcx()` function in the quantum circuit library has been enhanced to include a ctrl\_state parameter, allowing users to specify the control state of the multi-controlled X gate. This parameter can accept either a decimal value or a bitstring and defaults to controlling the ‘1’ state if not provided. - - ```python - from qiskit import QuantumCircuit - - qc = QuantumCircuit(3, 3) - qc.mcx([0, 1], 2, ctrl_state="00") - ``` - -* Added the [`CommutativeCancellation`](/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation "qiskit.transpiler.passes.CommutativeCancellation") pass to the `init` stage of the preset pass managers for optimization levels 2 and 3. This enables the preset pass managers to cancel additional logical operations at the beginning of the compilation pipeline. - -* Added a new method [`Layout.inverse()`](/docs/api/qiskit/qiskit.transpiler.Layout#inverse "qiskit.transpiler.Layout.inverse") which is used for taking the inverse of a [`Layout`](/docs/api/qiskit/qiskit.transpiler.Layout "qiskit.transpiler.Layout") object. Added a new method [`Layout.compose()`](/docs/api/qiskit/qiskit.transpiler.Layout#compose "qiskit.transpiler.Layout.compose") which is used for composing two [`Layout`](/docs/api/qiskit/qiskit.transpiler.Layout "qiskit.transpiler.Layout") objects together. Added a new method [`Layout.to_permutation()`](/docs/api/qiskit/qiskit.transpiler.Layout#to_permutation "qiskit.transpiler.Layout.to_permutation") which is used for creating a permutation corresponding to a [`Layout`](/docs/api/qiskit/qiskit.transpiler.Layout "qiskit.transpiler.Layout") object. - -* This release of Qiskit finalizes support for NumPy 2.0. Qiskit will continue to support both Numpy 1.x and 2.x for the foreseeable future. - -* Added a new reduction to the [`OptimizeAnnotated`](/docs/api/qiskit/qiskit.transpiler.passes.OptimizeAnnotated "qiskit.transpiler.passes.OptimizeAnnotated") transpiler pass. This reduction looks for annotated operations (objects of type [`AnnotatedOperation`](/docs/api/qiskit/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") that consist of a base operation `B` and a list `M` of control, inverse and power modifiers) with the following properties: - - * the base operation `B` needs to be synthesized (i.e. it’s not already supported by the target or belongs to the equivalence library) - * the definition circuit for `B` can be expressed as `P -- Q -- R` with $R = P^{-1}$ - - In this case the modifiers can be moved to the `Q`-part only. As a specific example, controlled QFT-based adders have the form `control - [QFT -- U -- IQFT]`, which can be simplified to `QFT -- control-[U] -- IQFT`. By removing the controls over `QFT` and `IQFT` parts of the circuit, one obtains significantly fewer gates in the transpiled circuit. - -* Added two new methods to the [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") class: [`qiskit.dagcircuit.DAGCircuit.op_successors()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#op_successors "qiskit.dagcircuit.DAGCircuit.op_successors") returns an iterator to [`DAGOpNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") successors of a node, and [`qiskit.dagcircuit.DAGCircuit.op_successors()`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit#op_successors "qiskit.dagcircuit.DAGCircuit.op_successors") returns an iterator to [`DAGOpNode`](/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") predecessors of a node. - -* Added a new transpiler pass, [`RemoveFinalReset`](/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalReset "qiskit.transpiler.passes.RemoveFinalReset"), which will remove any [`Reset`](/docs/api/qiskit/circuit#qiskit.circuit.Reset "qiskit.circuit.Reset") operation which is the final instruction on a qubit wire. For example, taking a circuit with final [`Reset`](/docs/api/qiskit/circuit#qiskit.circuit.Reset "qiskit.circuit.Reset")s: - - ![\_images/release\_notes-11.png](/docs/images/api/qiskit/release_notes-11.avif) - - will remove the final resets when the pass is run: - - ```python - from qiskit.transpiler.passes import RemoveFinalReset - from qiskit.circuit import QuantumCircuit - - qc = QuantumCircuit(3, 1) - qc.reset(0) - qc.h(range(3)) - qc.cx(1, 0) - qc.measure(0, 0) - qc.reset(range(3)) - RemoveFinalReset()(qc).draw("mpl") - ``` - - ![\_images/release\_notes-12.png](/docs/images/api/qiskit/release_notes-12.avif) - -* The performance of [`SparsePauliOp.to_matrix()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#to_matrix "qiskit.quantum_info.SparsePauliOp.to_matrix") has been greatly improved for both dense and sparse forms. By default, both will now take advantage of threaded parallelism available on your system, subject to the `RAYON_NUM_THREADS` environment variable. You can temporarily force serial execution using the new `force_serial` Boolean argument to [`to_matrix()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#to_matrix "qiskit.quantum_info.SparsePauliOp.to_matrix"). - -* Added a new transpiler pass [`StarPreRouting`](/docs/api/qiskit/qiskit.transpiler.passes.StarPreRouting "qiskit.transpiler.passes.StarPreRouting") which is designed to identify star connectivity subcircuits and then replace them with an optimal linear routing. This is useful for certain circuits that are composed of this circuit connectivity such as Bernstein Vazirani and QFT. For example: - - > - - - - - -### Circuits Features - -* A [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") can now contain typed classical variables: - - ```python - from qiskit.circuit import QuantumCircuit, ClassicalRegister, QuantumRegister - from qiskit.circuit.classical import expr, types - - qr = QuantumRegister(2, "q") - cr = ClassicalRegister(2, "c") - qc = QuantumCircuit(qr, cr) - # Add two input variables to the circuit with different types. - a = qc.add_input("a", types.Bool()) - mask = qc.add_input("mask", types.Uint(2)) - - # Test whether the input variable was true at runtime. - with qc.if_test(a) as else_: - qc.x(0) - with else_: - qc.h(0) - - qc.cx(0, 1) - qc.measure(qr, cr) - - # Add a typed variable manually, initialized to the same value as the classical register. - b = qc.add_var("b", expr.lift(cr)) - - qc.reset([0, 1]) - qc.h(0) - qc.cx(0, 1) - qc.measure(qr, cr) - - # Store some calculated value into the `b` variable. - qc.store(b, expr.bit_and(b, cr)) - # Test whether we had equality, up to a mask. - with qc.if_test(expr.equal(expr.bit_and(b, mask), mask)): - qc.x(0) - ``` - - These variables can be specified either as *inputs* to the circuit, or as scoped variables. The circuit object does not yet have support for representing typed classical-variable *outputs*, but this will be added later when hardware and the result interfaces are in more of a position to support it. Circuits that represent a block of an inner scope may also capture variables from outer scopes. - - A variable is a [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node, which can now contain an arbitrary type, and represents a unique memory location within its live range when added to a circuit. These can be constructed in a circuit using [`QuantumCircuit.add_var()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#add_var "qiskit.circuit.QuantumCircuit.add_var") and [`add_input()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#add_input "qiskit.circuit.QuantumCircuit.add_input"), or at a lower level using [`Var.new()`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var.new "qiskit.circuit.classical.expr.Var.new"). - - Variables can be manually stored to, using the [`Store`](/docs/api/qiskit/circuit#qiskit.circuit.Store "qiskit.circuit.Store") instruction and its corresponding circuit method [`QuantumCircuit.store()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#store "qiskit.circuit.QuantumCircuit.store"). This includes writing to [`Clbit`](/docs/api/qiskit/circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") and [`ClassicalRegister`](/docs/api/qiskit/circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") instances wrapped in [`Var`](/docs/api/qiskit/circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes. - - Variables can be used wherever classical expressions (see [`qiskit.circuit.classical.expr`](/docs/api/qiskit/circuit_classical#module-qiskit.circuit.classical.expr "qiskit.circuit.classical.expr")) are valid. Currently this is the target expressions of control-flow operations, though we plan to expand this to gate parameters in the future, as the type and expression system are expanded. - - See [Real-time classical computation](/docs/api/qiskit/circuit#circuit-repr-real-time-classical) for more discussion of these variables, and the associated data model. - - These are supported throughout the transpiler, through QPY serialization ([`qiskit.qpy`](/docs/api/qiskit/qpy#module-qiskit.qpy "qiskit.qpy")), OpenQASM 3 export ([`qiskit.qasm3`](/docs/api/qiskit/qasm3#module-qiskit.qasm3 "qiskit.qasm3")), and have initial support through the circuit visualizers (see [`QuantumCircuit.draw()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#draw "qiskit.circuit.QuantumCircuit.draw")). - - - The new classical variables and storage will take some time to become supported on hardware and simulator backends. They are not supported in the primitives interfaces ([`qiskit.primitives`](/docs/api/qiskit/primitives#module-qiskit.primitives "qiskit.primitives")), but will likely inform those interfaces as they evolve. - - -* The classical realtime-expressions module [`qiskit.circuit.classical`](/docs/api/qiskit/circuit_classical#module-qiskit.circuit.classical "qiskit.circuit.classical") can now represent indexing and bitshifting of unsigned integers and bitlikes (e.g. [`ClassicalRegister`](/docs/api/qiskit/circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")). For example, it is now possible to compare one register with the bitshift of another: - - ```python - from qiskit.circuit import QuantumCircuit, ClassicalRegister - from qiskit.circuit.classical import expr - - cr1 = ClassicalRegister(4, "cr1") - cr2 = ClassicalRegister(4, "cr2") - qc = QuantumCircuit(cr1, cr2) - with qc.if_test(expr.equal(cr1, expr.shift_left(cr2, 2))): - pass - ``` - - Qiskit can also represent a condition that dynamically indexes into a register: - - ```python - with qc.if_test(expr.index(cr1, cr2)): - pass - ``` - -* The construction performance of [`NLocal`](/docs/api/qiskit/qiskit.circuit.library.NLocal "qiskit.circuit.library.NLocal") and its derived circuit-library subclasses (e.g. [`EfficientSU2`](/docs/api/qiskit/qiskit.circuit.library.EfficientSU2 "qiskit.circuit.library.EfficientSU2") and [`RealAmplitudes`](/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes")) has significantly improved, when the rotation and/or entanglement subblocks are simple applications of a single Qiskit standard-library gate. Since these circuits are constructed lazily, you might not see the improvement immediately on instantiation of the class, but instead on first access to its internal structure. Performance improvements are on the order of ten times faster. - -* [`QuantumCircuit.append()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#append "qiskit.circuit.QuantumCircuit.append") now has a `copy` keyword argument, which defaults to `True`. When an instruction with runtime parameters ([`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")s) is appended to a circuit, by default, the circuit has always created a copy of the instruction so that if [`QuantumCircuit.assign_parameters()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#assign_parameters "qiskit.circuit.QuantumCircuit.assign_parameters") attempts to mutate the instruction in place, it does not affect other references to the same instruction. Now, setting `copy=False` allows you to override this, so you can avoid the copy penalty if you know your instructions will not be used in other locations. - -* [`QuantumCircuit.compose()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#compose "qiskit.circuit.QuantumCircuit.compose") now has a `copy` keyword argument, which defaults to `True`. By default, [`compose()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#compose "qiskit.circuit.QuantumCircuit.compose") copies all instructions, so that mutations from one circuit do not affect any other. If `copy=False`, then instructions from the other circuit will become directly owned by the new circuit, which may involve mutating them in place. The other circuit must not be used afterwards, in this case. - -* Construction time for [`QuantumVolume`](/docs/api/qiskit/qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume") circuits has been significantly improved, on the order of 10x or a bit more. The internal SU4 gates will now also use more bits of randomness during their generation, leading to more representative volume circuits, especially at large widths and depths. - -* [`QuantumVolume`](/docs/api/qiskit/qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume") now has a `flatten` keyword argument. This defaults to `False`, where the constructed circuit contains a single instruction that in turn contains the actual volume structure. If set `True`, the circuit will directly have the volumetric SU4 matrices. - -* [`UnitaryGate`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate") now accepts an optional `num_qubits` argument. The only effect of this is to skip the inference of the qubit count, which can be helpful for performance when many gates are being constructed. - -* All of the “standard gates” in the circuit library ([`qiskit.circuit.library`](/docs/api/qiskit/circuit_library#module-qiskit.circuit.library "qiskit.circuit.library")) can now be specified by string name for the entangling operations in [`TwoLocal`](/docs/api/qiskit/qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") circuits, such as [`RealAmplitudes`](/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes") and [`EfficientSU2`](/docs/api/qiskit/qiskit.circuit.library.EfficientSU2 "qiskit.circuit.library.EfficientSU2"). - - - - - -### Primitives Features - -* Version 2 of the primitives is introduced via a new base class for both the sampler and the estimator, along with new types for their inputs and outputs. The emphasis of this new version is on performing vectorized calls to the primitive `run()` methods, so that sweeps over parameter value sets and observables can be efficiently specified. See [`StatevectorSampler`](/docs/api/qiskit/qiskit.primitives.StatevectorSampler "qiskit.primitives.StatevectorSampler") and [`StatevectorEstimator`](/docs/api/qiskit/qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator") for reference implementations of the V2 primitives. - - Moreover, the estimator has gained a `precision` argument in the [`run()`](/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2#run "qiskit.primitives.BaseEstimatorV2.run") method that specifies the targeted precision of the expectation value estimates. Analogously, the sampler has moved `shots` out of the options and into the arguments of the [`run()`](/docs/api/qiskit/qiskit.primitives.BaseSamplerV2#run "qiskit.primitives.BaseSamplerV2.run") method. The sampler has also been changed to return the outputs (e.g. bitstrings) from every shot, rather than providing a [`Counts`](/docs/api/qiskit/qiskit.result.Counts "qiskit.result.Counts")-like return, and also to store data from separate [`ClassicalRegister`](/docs/api/qiskit/circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")s . This enables derived classes to implement sampler support for circuits with classical control flow. - - The primitive V2 base classes are: - - * [`BaseSamplerV2`](/docs/api/qiskit/qiskit.primitives.BaseSamplerV2 "qiskit.primitives.BaseSamplerV2") - * [`BaseEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2") - - The new types which are used for inputs and outputs are: - - * `SamplerPubLike`: primitive unified bloc (PUB) of sampler inputs; a union type of allowed inputs to a sampler - * `EstimatorPubLike`: Primitive unified bloc (PUB) of estimator inputs; a union type of allowed inputs to an estimator - * [`PubResult`](/docs/api/qiskit/qiskit.primitives.PubResult "qiskit.primitives.PubResult"): the data and metadata resulting from a single PUB’s execution - * [`DataBin`](/docs/api/qiskit/qiskit.primitives.DataBin "qiskit.primitives.DataBin"): A namespace to hold data from a single PUB’s execution - * [`BitArray`](/docs/api/qiskit/qiskit.primitives.BitArray "qiskit.primitives.BitArray"): an array-valued collection of bit values in a dense format - * [`PrimitiveResult`](/docs/api/qiskit/qiskit.primitives.PrimitiveResult "qiskit.primitives.PrimitiveResult"): an iterable of [`PubResult`](/docs/api/qiskit/qiskit.primitives.PubResult "qiskit.primitives.PubResult")s along with metadata - -* The reference implementation [`StatevectorEstimator`](/docs/api/qiskit/qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator") of [`BaseEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2") was added. As seen in the example below, this estimator (and all V2 estimators) supports providing arrays of observables and/or arrays of parameter value sets that are attached to particular circuits. - - Each tuple of `(circuit, observables, parameter values, precision)`, called an estimator primitive unified bloc (PUB), produces its own array-based result. The `run()` method can be given many pubs at once. - - ```python - from qiskit.circuit import Parameter, QuantumCircuit - from qiskit.primitives import StatevectorEstimator - from qiskit.quantum_info import Pauli, SparsePauliOp - - import matplotlib.pyplot as plt - import numpy as np - - # Define a circuit with two parameters. - circuit = QuantumCircuit(2) - circuit.h(0) - circuit.cx(0, 1) - circuit.ry(Parameter("a"), 0) - circuit.rz(Parameter("b"), 0) - circuit.cx(0, 1) - circuit.h(0) - - # Define a sweep over parameter values, where the second axis is over - # the two parameters in the circuit. - params = np.vstack([ - np.linspace(-np.pi, np.pi, 100), - np.linspace(-4 * np.pi, 4 * np.pi, 100) - ]).T - - # Define three observables. Many formats are supported here including - # classes such as qiskit.quantum_info.SparsePauliOp. The inner length-1 - # lists cause this array of observables to have shape (3, 1), rather - # than shape (3,) if they were omitted. - observables = [ - [SparsePauliOp(["XX", "IY"], [0.5, 0.5])], - [Pauli("XX")], - [Pauli("IY")] - ] - - # Instantiate a new statevector simulation based estimator object. - estimator = StatevectorEstimator() - - # Estimate the expectation value for all 300 combinations of - # observables and parameter values, where the pub result will have - # shape (3, 100). This shape is due to our array of parameter - # bindings having shape (100,), combined with our array of observables - # having shape (3, 1) - pub = (circuit, observables, params) - job = estimator.run([pub]) - - # Extract the result for the 0th pub (this example only has one pub). - result = job.result()[0] - - # Error-bar information is also available, but the error is 0 - # for this StatevectorEstimator. - result.data.stds - - # Pull out the array-based expectation value estimate data from the - # result and plot a trace for each observable. - for idx, pauli in enumerate(observables): - plt.plot(result.data.evs[idx], label=pauli) - plt.legend() - ``` - -* The reference implementation [`StatevectorSampler`](/docs/api/qiskit/qiskit.primitives.StatevectorSampler "qiskit.primitives.StatevectorSampler") of [`BaseSamplerV2`](/docs/api/qiskit/qiskit.primitives.BaseSamplerV2 "qiskit.primitives.BaseSamplerV2") was added. As seen in the example below, this sampler (and all V2 samplers) supports providing arrays of parameter value sets to bind against a single circuit. - - Each tuple of `(circuit, parameter values, shots)`, called a sampler primitive unified bloc (PUB), produces its own array-based result. The `run()` method can be given many pubs at once. - - ```python - from qiskit.circuit import ( - Parameter, QuantumCircuit, ClassicalRegister, QuantumRegister - ) - from qiskit.primitives import StatevectorSampler - - import matplotlib.pyplot as plt - import numpy as np - - # Define our circuit registers, including classical registers - # called 'alpha' and 'beta'. - qreg = QuantumRegister(3) - alpha = ClassicalRegister(2, "alpha") - beta = ClassicalRegister(1, "beta") - - # Define a quantum circuit with two parameters. - circuit = QuantumCircuit(qreg, alpha, beta) - circuit.h(0) - circuit.cx(0, 1) - circuit.cx(1, 2) - circuit.ry(Parameter("a"), 0) - circuit.rz(Parameter("b"), 0) - circuit.cx(1, 2) - circuit.cx(0, 1) - circuit.h(0) - circuit.measure([0, 1], alpha) - circuit.measure([2], beta) - - # Define a sweep over parameter values, where the second axis is over. - # the two parameters in the circuit. - params = np.vstack([ - np.linspace(-np.pi, np.pi, 100), - np.linspace(-4 * np.pi, 4 * np.pi, 100) - ]).T - - # Instantiate a new statevector simulation based sampler object. - sampler = StatevectorSampler() - - # Start a job that will return shots for all 100 parameter value sets. - pub = (circuit, params) - job = sampler.run([pub], shots=256) - - # Extract the result for the 0th pub (this example only has one pub). - result = job.result()[0] - - # There is one BitArray object for each ClassicalRegister in the - # circuit. Here, we can see that the BitArray for alpha contains data - # for all 100 sweep points, and that it is indeed storing data for 2 - # bits over 256 shots. - assert result.data.alpha.shape == (100,) - assert result.data.alpha.num_bits == 2 - assert result.data.alpha.num_shots == 256 - - # We can work directly with a binary array in performant applications. - raw = result.data.alpha.array - - # For small registers where it is anticipated to have many counts - # associated with the same bitstrings, we can turn the data from, - # for example, the 22nd sweep index into a dictionary of counts. - counts = result.data.alpha.get_counts(22) - - # Or, convert into a list of bitstrings that preserve shot order. - bitstrings = result.data.alpha.get_bitstrings(22) - print(bitstrings) - ``` - -* Added methods to join multiple [`BitArray`](/docs/api/qiskit/qiskit.primitives.BitArray "qiskit.primitives.BitArray") objects along various axes. - - * [`concatenate()`](/docs/api/qiskit/qiskit.primitives.BitArray#concatenate "qiskit.primitives.BitArray.concatenate"): join arrays along an existing axis of the arrays. - * [`concatenate_bits()`](/docs/api/qiskit/qiskit.primitives.BitArray#concatenate_bits "qiskit.primitives.BitArray.concatenate_bits"): join arrays along the bit axis. - * [`concatenate_shots()`](/docs/api/qiskit/qiskit.primitives.BitArray#concatenate_shots "qiskit.primitives.BitArray.concatenate_shots"): join arrays along the shots axis. - - ```python - ba = BitArray.from_samples(['00', '11']) - print(ba) - # BitArray() - - # reshape the bit array because `concatenate` requires an axis. - ba_ = ba.reshape(1, 2) - print(ba_) - # BitArray() - - ba2 = BitArray.concatenate([ba_, ba_]) - print(ba2.get_bitstrings()) - # ['00', '11', '00', '11'] - - # `concatenate_bits` and `concatenates_shots` do not require any axis. - - ba3 = BitArray.concatenate_bits([ba, ba]) - print(ba3.get_bitstrings()) - # ['0000', '1111'] - - ba4 = BitArray.concatenate_shots([ba, ba]) - print(ba4.get_bitstrings()) - # ['00', '11', '00', '11'] - ``` - -* Added methods to generate a subset of [`BitArray`](/docs/api/qiskit/qiskit.primitives.BitArray "qiskit.primitives.BitArray") object by slicing along various axes. - - * `__getitem__()`: slice the array along an existing axis of the array. - * [`slice_bits()`](/docs/api/qiskit/qiskit.primitives.BitArray#slice_bits "qiskit.primitives.BitArray.slice_bits"): slice the array along the bit axis. - * [`slice_shots()`](/docs/api/qiskit/qiskit.primitives.BitArray#slice_shots "qiskit.primitives.BitArray.slice_shots"): slice the array along the shot axis. - - ```python - ba = BitArray.from_samples(['0000', '0001', '0010', '0011'], 4) - print(ba) - # BitArray() - print(ba.get_bitstrings()) - # ['0000', '0001', '0010', '0011'] - - ba2 = ba.reshape(2, 2) - print(ba2) - # BitArray() - print(ba2[0].get_bitstrings()) - # ['0000', '0001'] - print(ba2[1].get_bitstrings()) - # ['0010', '0011'] - - ba3 = ba.slice_bits([0, 2]) - print(ba3.get_bitstrings()) - # ['00', '01', '00', '01'] - - ba4 = ba.slice_shots([0, 2]) - print(ba3.get_bitstrings()) - # ['0000', '0010'] - ``` - -* Added a method [`transpose()`](/docs/api/qiskit/qiskit.primitives.BitArray#transpose "qiskit.primitives.BitArray.transpose") to transpose a [`BitArray`](/docs/api/qiskit/qiskit.primitives.BitArray "qiskit.primitives.BitArray"). - - ```python - ba = BitArray.from_samples(['00', '11']).reshape(2, 1, 1) - print(ba) - # BitArray() - print(ba.transpose()) - # BitArray() - ``` - -* Added a method [`expectation_values()`](/docs/api/qiskit/qiskit.primitives.BitArray#expectation_values "qiskit.primitives.BitArray.expectation_values") to compute expectation values of diagonal operators. - - ```python - ba = BitArray.from_samples(['01', '11']) - print(ba.expectation_values(["IZ", "ZI", "01"])) - # [-1. 0. 0.5] - ``` - -* qiskit.primitives.containers.DataBin now satisfies the qiskit.primitives.containers.Shaped protocol. This means that every DataBin instance now has the additional attributes \* shape: tuple\[int, …] the leading shape of every entry in the instance \* ndim: int the length of shape \* size: int the product of the entries of shape The shape can be passed to the constructor. - -* Added mapping-like features to [`DataBin`](/docs/api/qiskit/qiskit.primitives.DataBin "qiskit.primitives.DataBin"), i.e., `__getitem__`, `__contains__`, `__iter__`, [`keys()`](/docs/api/qiskit/qiskit.primitives.DataBin#keys "qiskit.primitives.DataBin.keys"), [`values()`](/docs/api/qiskit/qiskit.primitives.DataBin#values "qiskit.primitives.DataBin.values"), and [`items()`](/docs/api/qiskit/qiskit.primitives.DataBin#items "qiskit.primitives.DataBin.items"). - - ```python - from qiskit import QuantumCircuit - from qiskit.primitives import StatevectorSampler - - circuit = QuantumCircuit(1) - circuit.h(0) - circuit.measure_all() - - sampler = StatevectorSampler() - result = sampler.run([circuit]).result() - databin = result[0].data - for creg, arr in databin.items(): - print(creg, arr) - for creg in databin: - print(creg, databin[creg]) - ``` - -* The subclass [`SamplerPubResult`](/docs/api/qiskit/qiskit.primitives.SamplerPubResult "qiskit.primitives.SamplerPubResult") of [`PubResult`](/docs/api/qiskit/qiskit.primitives.PubResult "qiskit.primitives.PubResult") was added, which [`BaseSamplerV2`](/docs/api/qiskit/qiskit.primitives.BaseSamplerV2 "qiskit.primitives.BaseSamplerV2") implementations can return. The main feature added in this new subclass is [`join_data()`](/docs/api/qiskit/qiskit.primitives.SamplerPubResult#join_data "qiskit.primitives.SamplerPubResult.join_data"), which joins together (a subset of) the contents of [`data`](/docs/api/qiskit/qiskit.primitives.PubResult#data "qiskit.primitives.PubResult.data") into a single object. This enables the following patterns: - - ```python - job_result = sampler.run([pub1, pub2, pub3], shots=123).result() - - # assuming all returned data entries are BitArrays - counts1 = job_result[0].join_data().get_counts() - bistrings2 = job_result[1].join_data().get_bitstrings() - array3 = job_result[2].join_data().array - ``` - - - - - -### Providers Features - -* The [`BasicSimulator`](/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator "qiskit.providers.basic_provider.BasicSimulator") python-based simulator included in [`qiskit.providers.basic_provider`](/docs/api/qiskit/providers_basic_provider#module-qiskit.providers.basic_provider "qiskit.providers.basic_provider") now includes all the standard gates (`qiskit.circuit.library .standard_gates`) up to 3 qubits. - - - -### Pulse Features - -* It is now possible to assign parameters to pulse `Schedule` and `ScheduleBlock` objects by specifying the parameter name as a string. The parameter name can be used to assign values to all parameters within the Schedule or ScheduleBlock that have the same name. Moreover, the parameter name of a ParameterVector can be used to assign all values of the vector simultaneously (the list of values should therefore match the length of the vector). - -* The `assign_parameters` methods of `Schedule` and `ScheduleBlock` now support assigning a [`ParameterVector`](/docs/api/qiskit/qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") to a list of parameter values simultaneously in addition to assigning individual [`Parameter`](/docs/api/qiskit/qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances to individual values. - - - - - -### Quantum Information Features - -* Added a new [`apply_layout()`](/docs/api/qiskit/qiskit.quantum_info.Pauli#apply_layout "qiskit.quantum_info.Pauli.apply_layout") method that is equivalent to [`apply_layout()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#apply_layout "qiskit.quantum_info.SparsePauliOp.apply_layout"). This method is used to apply a [`TranspileLayout`](/docs/api/qiskit/qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") layout from the transpiler to a [`Pauli`](/docs/api/qiskit/qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") observable that was built for an input circuit. This enables working with `BaseEstimator` / [`BaseEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2") implementations and local transpilation when the input is of type [`Pauli`](/docs/api/qiskit/qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"). For example: - - ```python - from qiskit.circuit.library import RealAmplitudes - from qiskit.primitives import BackendEstimatorV2 - from qiskit.providers.fake_provider import GenericBackendV2 - from qiskit.quantum_info import Pauli - from qiskit.transpiler.preset_passmanagers import generate_preset_pass_manager - - psi = RealAmplitudes(num_qubits=2, reps=2) - H1 = Pauli("XI") - backend = GenericBackendV2(num_qubits=7) - estimator = BackendEstimatorV2(backend=backend) - thetas = [0, 1, 1, 2, 3, 5] - pm = generate_preset_pass_manager(optimization_level=3, backend=backend) - transpiled_psi = pm.run(psi) - permuted_op = H1.apply_layout(transpiled_psi.layout) - res = estimator.run([(transpiled_psi, permuted_op, thetas)]).result() - ``` - - where an input circuit is transpiled locally before it’s passed to `run`. Transpilation expands the original circuit from 2 to 7 qubits (the size of `backend`) and permutes its layout, which is then applied to `H1` using [`apply_layout()`](/docs/api/qiskit/qiskit.quantum_info.Pauli#apply_layout "qiskit.quantum_info.Pauli.apply_layout") to reflect the transformations performed by `pm.run()`. - -* Adds the [`PauliList.noncommutation_graph()`](/docs/api/qiskit/qiskit.quantum_info.PauliList#noncommutation_graph "qiskit.quantum_info.PauliList.noncommutation_graph") and [`SparsePauliOp.noncommutation_graph()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#noncommutation_graph "qiskit.quantum_info.SparsePauliOp.noncommutation_graph") methods, exposing the construction of non-commutation graphs, recasting the measurement operator grouping problem into a graph coloring problem. This permits users to work with these graphs directly, for example to explore coloring algorithms other than the one used by [`SparsePauliOp.group_commuting()`](/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp#group_commuting "qiskit.quantum_info.SparsePauliOp.group_commuting"). - - - - - -### Synthesis Features - -* Added a new argument, `use_dag`, to the [`TwoQubitBasisDecomposer.__call__()`](/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer#__call__ "qiskit.synthesis.TwoQubitBasisDecomposer.__call__") and [`XXDecomposer.__call__()`](/docs/api/qiskit/qiskit.synthesis.XXDecomposer#__call__ "qiskit.synthesis.XXDecomposer.__call__") methods. This argument is used to control whether a [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") is returned when calling a [`TwoQubitBasisDecomposer`](/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer "qiskit.synthesis.TwoQubitBasisDecomposer") or [`XXDecomposer`](/docs/api/qiskit/qiskit.synthesis.XXDecomposer "qiskit.synthesis.XXDecomposer") instance instead of the default [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). For example: - - ```python - from qiskit.circuit.library import CXGate - from qiskit.quantum_info import random_unitary - from qiskit.synthesis import TwoQubitBasisDecomposer - - decomposer = TwoQubitBasisDecomposer(CXGate(), euler_basis="PSX") - decomposer(random_unitary(4), use_dag=True) - ``` - - will return a [`DAGCircuit`](/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") when calling the [`TwoQubitBasisDecomposer`](/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer "qiskit.synthesis.TwoQubitBasisDecomposer") instance `decomposer`. - -* [`LieTrotter.synthesize()`](/docs/api/qiskit/qiskit.synthesis.LieTrotter#synthesize "qiskit.synthesis.LieTrotter.synthesize") now uses [`QuantumCircuit.repeat()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#repeat "qiskit.circuit.QuantumCircuit.repeat") to generate additional reps after the first. This reduces the number of [`QuantumCircuit.compose()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#compose "qiskit.circuit.QuantumCircuit.compose") calls by a factor of `reps` and significantly reduces the runtime for larger operators. - -* Add a new synthesis method [`synth_permutation_reverse_lnn_kms()`](/docs/api/qiskit/synthesis#qiskit.synthesis.synth_permutation_reverse_lnn_kms "qiskit.synthesis.synth_permutation_reverse_lnn_kms") of reverse permutations for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. This algorithm synthesizes the reverse permutation on $n$ qubits over a linear nearest-neighbor architecture using CX gates with depth $2 * n + 2$. - -* The [`TwoQubitBasisDecomposer`](/docs/api/qiskit/qiskit.synthesis.TwoQubitBasisDecomposer "qiskit.synthesis.TwoQubitBasisDecomposer") class has been rewritten in Rust which greatly improves the runtime performance. - -* The [`TwoQubitWeylDecomposition`](/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition") synthesis class has been rewritten in Rust for better performance. - - - - - -### Transpiler Features - -* The following analysis passes now accept constraints encoded in a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target") thanks to a new `target` input argument: - - > * [`InstructionDurationCheck`](/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck "qiskit.transpiler.passes.InstructionDurationCheck") - > * [`ConstrainedReschedule`](/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule "qiskit.transpiler.passes.ConstrainedReschedule") - > * `ValidatePulseGates` - - The target constraints will have priority over user-provided constraints, for coherence with the rest of the transpiler pipeline. - - - - - -### Upgrade Notes - -* Removes the hard-coding of style options for [`plot_histogram()`](/docs/api/qiskit/qiskit.visualization.plot_histogram "qiskit.visualization.plot_histogram"). This allows Matplotlib style files to be faithfully applied to the figures. Users looking to go beyond the defaults set by Matplotlib can make their own style files, or pass a Matplotlib `Axes` object to `plot_histogram` and post-apply any customizations. - -* The [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") function has been upgraded to internally convert backend inputs of type `BackendV1` to [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2"), which allows the transpilation pipeline to now access the backend constraints through a [`Target`](/docs/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target"). This change does not require any user action. - - - - - -### Circuits Upgrade Notes - -* The random-number usage of [`QuantumVolume`](/docs/api/qiskit/qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume") has changed, so you will get a different circuit for a fixed seed between older versions of Qiskit and this version. The random-unitary generation now uses more bits of entropy, so large circuits will be less biased. - -* The internal [`UnitaryGate`](/docs/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate") instances in the definition of a [`QuantumVolume`](/docs/api/qiskit/qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume") circuit will no longer have a [`label`](/docs/api/qiskit/qiskit.circuit.Instruction#label "qiskit.circuit.Instruction.label") field set. Previously this was set to the string `su4_` where `` was a three-digit number denoting the seed of an internal Numpy pRNG instance for that gate. Doing this was a serious performance problem, and the seed ought not to have been useful; if you need to retrieve the matrix from the gate, simply use the [`Gate.to_matrix()`](/docs/api/qiskit/qiskit.circuit.Gate#to_matrix "qiskit.circuit.Gate.to_matrix") method. - - - - - -### Primitives Upgrade Notes - -* The function qiskit.primitives.containers.make\_data\_bin() no longer creates and returns a qiskit.primitives.containers.DataBin subclass. It instead always returns the DataBin class. However, it continues to exist for backwards compatibility, though will eventually be deprecated. All users should migrate to construct DataBin instances directly, instead of instantiating subclasses as output by make\_data\_bin(). - - - - - -### Synthesis Upgrade Notes - -* The [`TwoQubitWeylDecomposition`](/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition") no longer will self-specialize into a subclass on creation. This was an internal detail of the [`TwoQubitWeylDecomposition`](/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition") previously, and was not a documented public behavior as all the subclasses behaved the same and were only used for internal dispatch. However, as it was discoverable behavior this release note is to document that this will no longer occur and all instances of [`TwoQubitWeylDecomposition`](/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition") will be of the same type. There is no change in behavior for public methods of the class. - - - - - -### Transpiler Upgrade Notes - -* The preset [`StagedPassManager`](/docs/api/qiskit/qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager") returned for optimization level 2 by [`generate_preset_pass_manager()`](/docs/api/qiskit/qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager") and [`level_2_pass_manager()`](/docs/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.level_2_pass_manager "qiskit.transpiler.preset_passmanagers.level_2_pass_manager") have been reworked to provide a better balance between runtime and optimization. This means the output circuits will change compared to earlier releases. If you need an exact pass manager from level 2 in earlier releases you can either build it manually or use it from an earlier release and save the circuits with [`qpy`](/docs/api/qiskit/qpy#module-qiskit.qpy "qiskit.qpy") to load with a newer release. - - - - - -### Deprecation Notes - -* Support for running Qiskit with Python 3.8 has been deprecated and will be removed in the Qiskit 1.3.0 release. The 1.3.0 is the first release after Python 3.8 goes end of life and is no longer supported. \[1] This means that starting in the 1.3.0 release you will need to upgrade the Python version you’re using to Python 3.9 or above. +* Support for running Qiskit with Python 3.9 has been deprecated and will be removed in the Qiskit 2.3.0 release. The 2.3.0 is the first release after Python 3.9 goes end of life and is no longer supported. \[1] This means that starting in the 2.3.0 release you will need to upgrade the Python version you’re using to Python 3.9 or above. \[1] [https://devguide.python.org/versions/](https://devguide.python.org/versions/) -* The parameters `show_idle` and `show_barrier` in the timeline drawers had been replaced by `idle_wires` and `plot_barriers` respectively to match the circuit drawer parameters. Their previous names are now deprecated and will be removed in the next major release. The new parameters are fully equivalent. - - - - - -### Providers Deprecations - -* The abstract base classes `Provider` and `ProviderV1` are now deprecated and will be removed in Qiskit 2.0.0. The abstraction provided by these interface definitions were not providing a huge value. solely just the attributes `name`, `backends`, and a `get_backend()`. A \_provider\_, as a concept, will continue existing as a collection of backends. If you’re implementing a provider currently you can adjust your code by simply removing `ProviderV1` as the parent class of your implementation. As part of this you probably would want to add an implementation of `get_backend` for backwards compatibility. For example: - - ```python - def get_backend(self, name=None, **kwargs): - backend = self.backends(name, **kwargs) - if len(backends) > 1: - raise QiskitBackendNotFoundError("More than one backend matches the criteria") - if not backends: - raise QiskitBackendNotFoundError("No backend matches the criteria") - return backends[0] - ``` - - - -### Synthesis Deprecations - -* The [`TwoQubitWeylDecomposition.specialize()`](/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition#specialize "qiskit.synthesis.TwoQubitWeylDecomposition.specialize") method is now deprecated and will be removed in the Qiskit 2.0.0 release. This method never had a public purpose and was unsafe for an end user to call as it would mutate the calculated decomposition in the object and produce invalid fields in the object. It was only used internally to construct a new [`TwoQubitWeylDecomposition`](/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition") object. Despite this it was still a documented part of the public API for the class and is now being deprecated without any potential replacement. This release it always will raise a `NotImplementedError` when called because the specialization subclassing has been removed as part of the Rust rewrite of the class. - - - - - -### Transpiler Deprecations - -* The pass `qiskit.transpiler.passes.CXCancellation` was deprecated in favor of class:.InverseCancellation, which is more generic. `CXCancellation` is fully semantically equivalent to `InverseCancellation([CXGate()])`. - -* The transpilation pass `qiskit.transpiler.passes.ALAPSchedule` is now deprecated. It was pending for deprecation since Qiskit 0.37 (with Terra 0.21), released on June 2022. The pass is replaced by [`ALAPScheduleAnalysis`](/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis "qiskit.transpiler.passes.ALAPScheduleAnalysis"), which is an analysis pass. - -* The transpilation pass `qiskit.transpiler.passes.ASAPSchedule` is now deprecated. It was pending for deprecation since Qiskit 0.37 (with Terra 0.21), released on June 2022. It has been superseded by [`ASAPScheduleAnalysis`](/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis "qiskit.transpiler.passes.ASAPScheduleAnalysis") and the new scheduling workflow. - -* The transpilation pass `qiskit.transpiler.passes.DynamicalDecoupling` is now deprecated. It was pending for deprecation since Qiskit 0.37 (with Terra 0.21), released on June 2022. Instead, use [`PadDynamicalDecoupling`](/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling "qiskit.transpiler.passes.PadDynamicalDecoupling"), which performs the same function but requires scheduling and alignment analysis passes to run prior to it. - -* The transpilation pass `qiskit.transpiler.passes.AlignMeasures` is now deprecated. It was pending for deprecation since Qiskit 0.37 (with Terra 0.21), released on June 2022. Instead, use [`ConstrainedReschedule`](/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule "qiskit.transpiler.passes.ConstrainedReschedule"), which performs the same function and also supports aligning to additional timing constraints. - - - - - -### Bug Fixes - -* Fixed an issue with the [`qpy.dump()`](/docs/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") function where, when the `use_symengine` flag was set to a truthy object that evaluated to `True` but was not actually the boolean `True`, the generated QPY payload would be corrupt. For example, if you set `use_symengine` to [`HAS_SYMENGINE`](/docs/api/qiskit/utils#qiskit.utils.optionals.HAS_SYMENGINE "qiskit.utils.optionals.HAS_SYMENGINE"), this object evaluates to `True` when cast as a bool, but isn’t actually `True`. - -* Fixed an issue with the [`circuit_drawer()`](/docs/api/qiskit/qiskit.visualization.circuit_drawer "qiskit.visualization.circuit_drawer") function and [`QuantumCircuit.draw()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#draw "qiskit.circuit.QuantumCircuit.draw") method when loading a matplotlib style via the user configuration file. - -* Fixed an issue where the [`ConstrainedReschedule`](/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule "qiskit.transpiler.passes.ConstrainedReschedule") transpiler pass would previously error if the circuit contained a [`Reset`](/docs/api/qiskit/circuit#qiskit.circuit.Reset "qiskit.circuit.Reset") instruction. This has been corrected so that the pass no longer errors, however an actual hardware may behave differently from what Qiskit scheduler assumes especially for mid-circuit measurements and resets. Qiskit scheduler raises `RuntimeWarning` if it encounters circuit containing either. Fixed [#10354](https://github.com/Qiskit/qiskit/issues/10354) - -* Fixed an issue with the [`CommutationChecker`](/docs/api/qiskit/qiskit.circuit.CommutationChecker "qiskit.circuit.CommutationChecker") class where it would error if a gate’s [`name`](/docs/api/qiskit/qiskit.circuit.Gate#name "qiskit.circuit.Gate.name") attribute was UTF8 encoded. Previously only gate names with ascii encoding would work. Fixed [#12501](https://github.com/Qiskit/qiskit/issues/12051) - -* Fixed a performance issue in the [`BackendSamplerV2`](/docs/api/qiskit/qiskit.primitives.BackendSamplerV2 "qiskit.primitives.BackendSamplerV2") and [`BackendEstimatorV2`](/docs/api/qiskit/qiskit.primitives.BackendEstimatorV2 "qiskit.primitives.BackendEstimatorV2"). Fixed [#12290](https://github.com/Qiskit/qiskit-terra/issues/12290) - -* Fixed an issue with the `convert_to_target()` where the converter would incorrectly ignore control flow instructions if they were specified in the `BackendConfiguration.supported_instructions` attribute which is the typical location that control flow instructions are specified in a `BackendConfiguration` object. Fixed [#11872](https://github.com/Qiskit/qiskit/issues/11872). - -* Fixed an issue with the `circuit_drawer()` or `QuantumCircuit.draw()` when using the `mpl` output option where the program would hang if the circuit being drawn had a ControlFlow operation in it and the `fold` option was set to -1 (meaning no fold). Fixed [#12012](https://github.com/Qiskit/qiskit/issues/12012). - -* Fixed a bug in the conversion of custom pulse instructions to the legacy `qiskit.qobj` format. The bug was introduced in Qiskit 1.0.0 and caused conversion of instructions with custom pulse shapes to raise an error. After the fix, the conversion is carried out correctly, and the custom pulse is converted to `pulse.Waveform` as it should. Fixed [#11828](https://github.com/Qiskit/qiskit/issues/11828). - -* A bug in [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") has been fixed where custom `instruction_durations`, `dt` and `backend_properties` constraints would be ignored when provided at the same time as a backend of type [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). The behavior after the fix is now independent of whether the provided backend is of type `BackendV1` or type [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). Similarly, custom `timing_constraints` are now overridden by `target` inputs but take precedence over `BackendV1` and [`BackendV2`](/docs/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") inputs. - -* Calling [`EquivalenceLibrary.set_entry()`](/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary#set_entry "qiskit.circuit.EquivalenceLibrary.set_entry") will now correctly update the internal graph object of the library. Previously, the metadata would be updated, but the graph structure would be unaltered, meaning that users like [`BasisTranslator`](/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") would still use the old rules. Fixed [#11958](https://github.com/Qiskit/qiskit/issues/11958). - -* The [`EvolvedOperatorAnsatz`](/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.EvolvedOperatorAnsatz") now correctly handles the case where the operators argument is an empty list. Previously, this would result in an error. - -* From now on, [`EvolvedOperatorAnsatz`](/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.EvolvedOperatorAnsatz") will not have any qregs when thera are zero qubits, instead of having a [`QuantumRegister`](/docs/api/qiskit/circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") instance with zero qubits. This behavior aligns more consistently with its superclass [`QuantumCircuit`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). - -* The method [`Instruction.repeat()`](/docs/api/qiskit/qiskit.circuit.Instruction#repeat "qiskit.circuit.Instruction.repeat") now moves a set `condition` to the outer returned [`Instruction`](/docs/api/qiskit/qiskit.circuit.Instruction "qiskit.circuit.Instruction") and leave the inner gates of its definition unconditional. Previously, the method would leave [`ClassicalRegister`](/docs/api/qiskit/circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") instances within the inner definition, which was an invalid state, and would manifest itself as seemingly unrelated bugs later, such as during transpilation or export. Fixed [#11935](https://github.com/Qiskit/qiskit/issues/11935). - -* Fixed an issue in the [`InverseCancellation`](/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation "qiskit.transpiler.passes.InverseCancellation") transpiler pass where in some cases it would incorrectly cancel a self-inverse parameterized gate even if the parameter value didn’t match. Fixed [#11815](https://github.com/Qiskit/qiskit/issues/11815) - -* Improve the decomposition of the gates [`MCXGate`](/docs/api/qiskit/qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate") and [`MCPhaseGate`](/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate") without using ancilla qubits, so that the number of [`CXGate`](/docs/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") will grow quadratically in the number of qubits and not exponentially. - -* A bug that crashes the `convert_to_target()` function when qubit properties (either T1, T2 or frequency) are missing was fixed. The missing property values in [`QubitProperties`](/docs/api/qiskit/qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") are filled with `None`. - -* [`BasePassManager.run()`](/docs/api/qiskit/qiskit.passmanager.BasePassManager#run "qiskit.passmanager.BasePassManager.run") will no longer leak the previous [`PropertySet`](/docs/api/qiskit/qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") into new workflows when called more than once. Previously, the same [`PropertySet`](/docs/api/qiskit/qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") as before would be used to initialize follow-on runs, which could mean that invalid property information was being given to tasks. The behavior now matches that of Qiskit 0.44. Fixed [#11784](https://github.com/Qiskit/qiskit/issues/11784). - -* [`Pauli.evolve()`](/docs/api/qiskit/qiskit.quantum_info.Pauli#evolve "qiskit.quantum_info.Pauli.evolve") now correctly handles quantum circuits containing ECR gates. Formerly they were not recognized as Clifford gates, and an error was raised. - -* Fixed a bug in [`Pauli.evolve()`](/docs/api/qiskit/qiskit.quantum_info.Pauli#evolve "qiskit.quantum_info.Pauli.evolve") where evolving by a circuit with a name matching certain Clifford gates (‘cx’, ‘cz’, etc) would evolve the Pauli according to the name of the circuit, not by the contents of the circuit. This bug occurred only with the non-default option `frame='s'`. - -* Fixed a performance issue in the [`qpy.load()`](/docs/api/qiskit/qpy#qiskit.qpy.load "qiskit.qpy.load") function when deserializing QPY payloads with large numbers of qubits or clbits in a circuit. - -* Fixed a bug where `qiskit.primitives.containers.estimator_pub.EstimatorPub.coerce()` and `qiskit.primitives.containers.sampler_pub.SamplerPub.coerce()` improperly handle the case where the parameter values are a `BindingsArray` instance, giving rise to a `ValueError` whenever it is attempted. - -* Fixed a bug in the handling of `default_alignment` argument of `build()`. Inputs of type `AlignmentKind` are now correctly processed as default alignments. - -* Fixed a bug in `qiskit.pulse.utils.format_parameter_value()` function that unintentionally converts large enough integer numbers into float values or causes unexpected rounding. See [qiskit/#11971](https://github.com/Qiskit/qiskit/issues/11971) for details. - -* Fix incorrect implemention of qDRIFT, negative coefficients of the Hamiltonian are now added back whereas they were always forced to be positive. - -* A bug has been fixed in `convert_durations_to_dt()` where the function would blindly apply a conversion from seconds to `dt` on circuit durations, independently of the original units of the attribute. This could lead to wrong orders of magnitude in the reported circuit durations. - -* The preset pass managers of [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") will no longer fail on circuits with control flow, if no hardware target or basis-gate set is specified. They will now treat such abstract targets as permitting all control-flow operations. Fixed [#11906](https://github.com/Qiskit/qiskit/issues/11906). - -* The method `qiskit.instruction.Instruction.soft_compare()` is meant to compare whether two gates match in their name, number of qubits, number of clbits, and the number of parameters. However, there was a typo where it would not check the number of qubits and number of clbits for a match. This resolves the apparent typo. - -* The default `init` plugin was not properly raising a [`TranspilerError`](/docs/api/qiskit/transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") when called with an invalid optimization level. - -* Fixed qiskit.primitives.containers.observables\_array.ObservablesArray.coerce() so that it returns a 0-d array when the input is a single, unnested observable. Previously, it erroneously upgraded to a single dimension, with shape (1,). - -* Fixed an issue with the [`Operator.from_circuit()`](/docs/api/qiskit/qiskit.quantum_info.Operator#from_circuit "qiskit.quantum_info.Operator.from_circuit") constructor method where it would incorrectly interpret the final layout permutation resulting in an invalid Operator being constructed. Previously, the final layout was processed without regards for the initial layout, i.e. the initialization was incorrect for all quantum circuits that have a non-trivial initial layout. - -* [`Parameter`](/docs/api/qiskit/qiskit.circuit.Parameter "qiskit.circuit.Parameter") was updated so that instances that compare equal always have the same hash. Previously, only the [`Parameter.uuid`](/docs/api/qiskit/qiskit.circuit.Parameter#uuid "qiskit.circuit.Parameter.uuid") was compared, so `Paramemter` instances with different names could compare equal if they had been constructed using a common value for the `uuid` parameter (which is usually not passed explicitly). - -* [`Parameter`](/docs/api/qiskit/qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances used as stand-ins for `input` variables in OpenQASM 3 programs will now have their names escaped to avoid collisions with built-in gates during the export to OpenQASM 3. Previously there could be a naming clash, and the exporter would generate invalid OpenQASM 3. - -* Fixed bug in [`QuantumCircuit.draw()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#draw "qiskit.circuit.QuantumCircuit.draw") that was causing custom style dictionaries for the Matplotlib drawer to be modified upon execution. - -* [`QuantumCircuit.append()`](/docs/api/qiskit/qiskit.circuit.QuantumCircuit#append "qiskit.circuit.QuantumCircuit.append") with `copy=True` (its default) will now correctly copy instructions parametrized by [`ParameterExpression`](/docs/api/qiskit/qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") instances, and not just by [`Parameter`](/docs/api/qiskit/qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances. - -* The internal handling of custom circuit calibrations and [`InstructionDurations`](/docs/api/qiskit/qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") has been offloaded from the [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") function to the individual transpiler passes: `qiskit.transpiler.passes.scheduling.DynamicalDecoupling`, `qiskit.transpiler.passes.scheduling.padding.DynamicalDecoupling`. Before, instruction durations from circuit calibrations would not be taken into account unless they were manually incorporated into instruction\_durations input argument, but the passes that need it now analyze the circuit and pick the most relevant duration value according to the following priority order: target > custom input > circuit calibrations. - -* Fixed a bug in [`transpile()`](/docs/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") where the `num_processes` argument would only be used if `dt` or `instruction_durations` were provided. - - - - - -### Other Notes - -* Support for the arm64 macOS platform has been promoted from Tier 3 to Tier 1. Previously the platform was at Tier 3 because there was no available CI environment for testing Qiskit on the platform. Now that Github has made an arm64 macOS environment available to open source projects [\[1\]](#id96) we’re testing the platform along with the other Tier 1 supported platforms. - - - - \[[1](#id95)] - - [https://github.blog/changelog/2024-01-30-github-actions-introducing-the-new-m1-macos-runner-available-to-open-source/](https://github.blog/changelog/2024-01-30-github-actions-introducing-the-new-m1-macos-runner-available-to-open-source/) - diff --git a/docs/api/qiskit/result.mdx b/docs/api/qiskit/result.mdx index 77755d5f43c..73ebe8dce10 100644 --- a/docs/api/qiskit/result.mdx +++ b/docs/api/qiskit/result.mdx @@ -33,11 +33,11 @@ python_api_name: qiskit.result **Parameters** - * **result** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *|*[*Result*](qiskit.result.Result "qiskit.result.result.Result")) – result to be marginalized (a Result object or a dict(str, int) of counts). - * **indices** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – The bit positions of interest to marginalize over. If `None` (default), do not marginalize at all. - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Default: False. Operates on the original Result argument if True, leading to loss of original Job Result. It has no effect if `result` is a dict. - * **format\_marginal** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Default: False. If True, takes the output of marginalize and formats it with placeholders between cregs and for non-indices. - * **marginalize\_memory** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – If True, then also marginalize the memory field (if present). If False, remove the memory field from the result. If None, leave the memory field as is. + * **result** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *|*[*Result*](qiskit.result.Result "qiskit.result.result.Result")) – result to be marginalized (a Result object or a dict(str, int) of counts). + * **indices** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – The bit positions of interest to marginalize over. If `None` (default), do not marginalize at all. + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Default: False. Operates on the original Result argument if True, leading to loss of original Job Result. It has no effect if `result` is a dict. + * **format\_marginal** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Default: False. If True, takes the output of marginalize and formats it with placeholders between cregs and for non-indices. + * **marginalize\_memory** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – If True, then also marginalize the memory field (if present). If False, remove the memory field from the result. If None, leave the memory field as is. **Returns** @@ -47,7 +47,7 @@ python_api_name: qiskit.result **Return type** - [Result](qiskit.result.Result "qiskit.result.Result") or [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")([str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) + [Result](qiskit.result.Result "qiskit.result.Result") or [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")([str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) **Raises** @@ -63,9 +63,9 @@ python_api_name: qiskit.result **Parameters** - * **counts** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – result to be marginalized - * **indices** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – The bit positions of interest to marginalize over. If `None` (default), do not marginalize at all. - * **format\_marginal** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Default: False. If True, takes the output of marginalize and formats it with placeholders between cregs and for non-indices. + * **counts** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – result to be marginalized + * **indices** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – The bit positions of interest to marginalize over. If `None` (default), do not marginalize at all. + * **format\_marginal** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Default: False. If True, takes the output of marginalize and formats it with placeholders between cregs and for non-indices. **Returns** @@ -73,7 +73,7 @@ python_api_name: qiskit.result **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")([str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")([str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) **Raises** @@ -90,12 +90,12 @@ python_api_name: qiskit.result **Parameters** - * **memory** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] |* [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")) – The input memory list, this is either a list of hexadecimal strings to be marginalized representing measure level 2 memory or a numpy array representing level 0 measurement memory (single or avg) or level 1 measurement memory (single or avg). - * **indices** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – The bit positions of interest to marginalize over. If `None` (default), do not marginalize at all. - * **int\_return** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to `True` the output will be a list of integers. By default the return type is a bit string. This and `hex_return` are mutually exclusive and can not be specified at the same time. This option only has an effect with memory level 2. - * **hex\_return** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to `True` the output will be a list of hexadecimal strings. By default the return type is a bit string. This and `int_return` are mutually exclusive and can not be specified at the same time. This option only has an effect with memory level 2. - * **avg\_data** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If a 2 dimensional numpy array is passed in for `memory` this can be set to `True` to indicate it’s a avg level 0 data instead of level 1 single data. - * **parallel\_threshold** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of elements in `memory` to start running in multiple threads. If `len(memory)` is >= this value, the function will run in multiple threads. By default this is set to 1000. + * **memory** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*] |* [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")) – The input memory list, this is either a list of hexadecimal strings to be marginalized representing measure level 2 memory or a numpy array representing level 0 measurement memory (single or avg) or level 1 measurement memory (single or avg). + * **indices** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | None*) – The bit positions of interest to marginalize over. If `None` (default), do not marginalize at all. + * **int\_return** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to `True` the output will be a list of integers. By default the return type is a bit string. This and `hex_return` are mutually exclusive and can not be specified at the same time. This option only has an effect with memory level 2. + * **hex\_return** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to `True` the output will be a list of hexadecimal strings. By default the return type is a bit string. This and `int_return` are mutually exclusive and can not be specified at the same time. This option only has an effect with memory level 2. + * **avg\_data** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If a 2 dimensional numpy array is passed in for `memory` this can be set to `True` to indicate it’s a avg level 0 data instead of level 1 single data. + * **parallel\_threshold** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of elements in `memory` to start running in multiple threads. If `len(memory)` is >= this value, the function will run in multiple threads. By default this is set to 1000. **Returns** @@ -107,7 +107,7 @@ python_api_name: qiskit.result **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if both `int_return` and `hex_return` are set to `True` + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if both `int_return` and `hex_return` are set to `True` ## Distributions @@ -128,7 +128,7 @@ python_api_name: qiskit.result **Parameters** - * **dist** ([*Counts*](qiskit.result.Counts "qiskit.result.Counts") *or*[*QuasiDistribution*](qiskit.result.QuasiDistribution "qiskit.result.QuasiDistribution") *or*[*ProbDistribution*](qiskit.result.ProbDistribution "qiskit.result.ProbDistribution") *or*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – Input sampled distribution + * **dist** ([*Counts*](qiskit.result.Counts "qiskit.result.Counts") *or*[*QuasiDistribution*](qiskit.result.QuasiDistribution "qiskit.result.QuasiDistribution") *or*[*ProbDistribution*](qiskit.result.ProbDistribution "qiskit.result.ProbDistribution") *or*[*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – Input sampled distribution * **oper** (str or [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") or SparsePauliOp) – The operator for the observable **Returns** @@ -137,7 +137,7 @@ python_api_name: qiskit.result **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") **Raises** diff --git a/docs/api/qiskit/synthesis.mdx b/docs/api/qiskit/synthesis.mdx index 71aa03ba920..fc7912b12ac 100644 --- a/docs/api/qiskit/synthesis.mdx +++ b/docs/api/qiskit/synthesis.mdx @@ -40,8 +40,8 @@ python_api_name: qiskit.synthesis **Parameters** - * **state** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]] | np.ndarray\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]*) – $n \times n$ boolean invertible matrix, describing the state of the input circuit. - * **section\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The size of each section in the Patel–Markov–Hayes algorithm \[1]. If `None` it is chosen to be $\max(2, \alpha\log_2(n))$ with $\alpha = 0.56$, which approximately minimizes the upper bound on the number of row operations given in \[1] Eq. (3). + * **state** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*]] | np.ndarray\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*]*) – $n \times n$ boolean invertible matrix, describing the state of the input circuit. + * **section\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The size of each section in the Patel–Markov–Hayes algorithm \[1]. If `None` it is chosen to be $\max(2, \alpha\log_2(n))$ with $\alpha = 0.56$, which approximately minimizes the upper bound on the number of row operations given in \[1] Eq. (3). **Returns** @@ -49,7 +49,7 @@ python_api_name: qiskit.synthesis **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – When `section_size` is larger than the number of columns. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – When `section_size` is larger than the number of columns. **Return type** @@ -69,7 +69,7 @@ python_api_name: qiskit.synthesis **Parameters** - **mat** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")*\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]*) – A boolean invertible matrix. + **mat** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")*\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*]*) – A boolean invertible matrix. **Returns** @@ -151,7 +151,7 @@ python_api_name: qiskit.synthesis **Parameters** - * **cnots** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + * **cnots** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]]*) – A matrix whose columns are the parities to be synthesized e.g.: @@ -168,9 +168,9 @@ python_api_name: qiskit.synthesis x1^x2 + x0 + x0^x3 + x0^x1^x2 + x0^x1^x3 + x0^x1 ``` - * **angles** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – A list containing all the phase-shift gates which are to be applied, in the same order as in `cnots`. A number is interpreted as the angle of $p(angle)$, otherwise the elements have to be `'t'`, `'tdg'`, `'s'`, `'sdg'` or `'z'`. + * **angles** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – A list containing all the phase-shift gates which are to be applied, in the same order as in `cnots`. A number is interpreted as the angle of $p(angle)$, otherwise the elements have to be `'t'`, `'tdg'`, `'s'`, `'sdg'` or `'z'`. - * **section\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The size of every section in the Patel–Markov–Hayes algorithm. `section_size` must be a factor of the number of qubits. + * **section\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The size of every section in the Patel–Markov–Hayes algorithm. `section_size` must be a factor of the number of qubits. **Returns** @@ -200,7 +200,7 @@ python_api_name: qiskit.synthesis **Parameters** - **pattern** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | np.ndarray\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – Permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation. That is, `pattern[k] = m` when the permutation maps qubit `m` to position `k`. As an example, the pattern `[2, 4, 3, 0, 1]` means that qubit `2` goes to position `0`, qubit `4` goes to position `1`, etc. + **pattern** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | np.ndarray\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – Permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation. That is, `pattern[k] = m` when the permutation maps qubit `m` to position `k`. As an example, the pattern `[2, 4, 3, 0, 1]` means that qubit `2` goes to position `0`, qubit `4` goes to position `1`, etc. **Returns** @@ -224,7 +224,7 @@ python_api_name: qiskit.synthesis **Parameters** - **pattern** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | np.ndarray\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – Permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation. That is, `pattern[k] = m` when the permutation maps qubit `m` to position `k`. As an example, the pattern `[2, 4, 3, 0, 1]` means that qubit `2` goes to position `0`, qubit `4` goes to position `1`, etc. + **pattern** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | np.ndarray\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – Permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation. That is, `pattern[k] = m` when the permutation maps qubit `m` to position `k`. As an example, the pattern `[2, 4, 3, 0, 1]` means that qubit `2` goes to position `0`, qubit `4` goes to position `1`, etc. **Returns** @@ -246,7 +246,7 @@ python_api_name: qiskit.synthesis **Parameters** - **pattern** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | np.ndarray\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – Permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation. That is, `pattern[k] = m` when the permutation maps qubit `m` to position `k`. As an example, the pattern `[2, 4, 3, 0, 1]` means that qubit `2` goes to position `0`, qubit `4` goes to position `1`, etc. + **pattern** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*] | np.ndarray\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")*]*) – Permutation pattern, describing which qubits occupy the positions 0, 1, 2, etc. after applying the permutation. That is, `pattern[k] = m` when the permutation maps qubit `m` to position `k`. As an example, the pattern `[2, 4, 3, 0, 1]` means that qubit `2` goes to position `0`, qubit `4` goes to position `1`, etc. **Returns** @@ -271,7 +271,7 @@ python_api_name: qiskit.synthesis **Parameters** - **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits. + **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits. **Returns** @@ -298,7 +298,7 @@ python_api_name: qiskit.synthesis **Parameters** * **clifford** ([*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – A Clifford operator. - * **method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Optional, a synthesis method (`'AG'` or `'greedy'`). If set this overrides optimal decomposition for $N \leq 3$ qubits. + * **method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Optional, a synthesis method (`'AG'` or `'greedy'`). If set this overrides optimal decomposition for $N \leq 3$ qubits. **Returns** @@ -573,9 +573,9 @@ python_api_name: qiskit.synthesis **Parameters** * **stab** ([*StabilizerState*](qiskit.quantum_info.StabilizerState "qiskit.quantum_info.states.stabilizerstate.StabilizerState")) – A stabilizer state. - * **cz\_synth\_func** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")*],* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")*]*) – A function to decompose the CZ sub-circuit. It gets as input a boolean symmetric matrix, and outputs a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). - * **cz\_func\_reverse\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – `True` only if `cz_synth_func` is [`synth_cz_depth_line_mr()`](#qiskit.synthesis.synth_cz_depth_line_mr "qiskit.synthesis.synth_cz_depth_line_mr"), since this function returns a circuit that reverts the order of qubits. - * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, validates the synthesis process. + * **cz\_synth\_func** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.14)")*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.3)")*],* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")*]*) – A function to decompose the CZ sub-circuit. It gets as input a boolean symmetric matrix, and outputs a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). + * **cz\_func\_reverse\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – `True` only if `cz_synth_func` is [`synth_cz_depth_line_mr()`](#qiskit.synthesis.synth_cz_depth_line_mr "qiskit.synthesis.synth_cz_depth_line_mr"), since this function returns a circuit that reverts the order of qubits. + * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, validates the synthesis process. **Returns** @@ -624,10 +624,10 @@ python_api_name: qiskit.synthesis **Parameters** - * **stabilizers** ([*Collection*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Collection "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – List of stabilizer strings - * **allow\_redundant** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Allow redundant stabilizers (i.e., some stabilizers can be products of the others) - * **allow\_underconstrained** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Allow underconstrained set of stabilizers (i.e., the stabilizers do not specify a unique state) - * **invert** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Return inverse circuit + * **stabilizers** ([*Collection*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Collection "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – List of stabilizer strings + * **allow\_redundant** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Allow redundant stabilizers (i.e., some stabilizers can be products of the others) + * **allow\_underconstrained** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Allow underconstrained set of stabilizers (i.e., the stabilizers do not specify a unique state) + * **invert** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Return inverse circuit **Returns** @@ -664,9 +664,9 @@ python_api_name: qiskit.synthesis **Parameters** - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – The gates from which to create the sequences of gates. - * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The maximum depth of the approximations. - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – If provided, the basic approximations are stored in this file. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – The gates from which to create the sequences of gates. + * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The maximum depth of the approximations. + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – If provided, the basic approximations are stored in this file. **Returns** @@ -674,11 +674,11 @@ python_api_name: qiskit.synthesis **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `basis_gates` contains an invalid gate identifier. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `basis_gates` contains an invalid gate identifier. **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[GateSequence] + [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")\[GateSequence] ## Basis Change Synthesis @@ -696,9 +696,9 @@ python_api_name: qiskit.synthesis **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits on which the Quantum Fourier Transform acts. - * **approximation\_degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The degree of approximation (0 for no approximation). It is possible to implement the QFT approximately by ignoring controlled-phase rotations with the angle beneath a threshold. This is discussed in more detail in [https://arxiv.org/abs/quant-ph/9601018](https://arxiv.org/abs/quant-ph/9601018) or [https://arxiv.org/abs/quant-ph/0403071](https://arxiv.org/abs/quant-ph/0403071). - * **do\_swaps** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to synthesize the “QFT” or the “QFT-with-reversal” operation. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits on which the Quantum Fourier Transform acts. + * **approximation\_degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The degree of approximation (0 for no approximation). It is possible to implement the QFT approximately by ignoring controlled-phase rotations with the angle beneath a threshold. This is discussed in more detail in [https://arxiv.org/abs/quant-ph/9601018](https://arxiv.org/abs/quant-ph/9601018) or [https://arxiv.org/abs/quant-ph/0403071](https://arxiv.org/abs/quant-ph/0403071). + * **do\_swaps** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to synthesize the “QFT” or the “QFT-with-reversal” operation. **Returns** @@ -724,12 +724,12 @@ python_api_name: qiskit.synthesis **Parameters** - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits on which the Quantum Fourier Transform acts. - * **do\_swaps** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Whether to synthesize the “QFT” or the “QFT-with-reversal” operation. - * **approximation\_degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The degree of approximation (0 for no approximation). It is possible to implement the QFT approximately by ignoring controlled-phase rotations with the angle beneath a threshold. This is discussed in more detail in [https://arxiv.org/abs/quant-ph/9601018](https://arxiv.org/abs/quant-ph/9601018) or [https://arxiv.org/abs/quant-ph/0403071](https://arxiv.org/abs/quant-ph/0403071). - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, barriers are inserted for improved visualization. - * **inverse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, the inverse Quantum Fourier Transform is constructed. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The name of the circuit. + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits on which the Quantum Fourier Transform acts. + * **do\_swaps** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Whether to synthesize the “QFT” or the “QFT-with-reversal” operation. + * **approximation\_degree** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The degree of approximation (0 for no approximation). It is possible to implement the QFT approximately by ignoring controlled-phase rotations with the angle beneath a threshold. This is discussed in more detail in [https://arxiv.org/abs/quant-ph/9601018](https://arxiv.org/abs/quant-ph/9601018) or [https://arxiv.org/abs/quant-ph/0403071](https://arxiv.org/abs/quant-ph/0403071). + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, barriers are inserted for improved visualization. + * **inverse** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, the inverse Quantum Fourier Transform is constructed. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The name of the circuit. **Returns** @@ -788,8 +788,8 @@ $$ **Parameters** * **mat** (*np.ndarray*) – unitary matrix to decompose - * **opt\_a1** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – whether to try optimization A.1 from \[1, 2]. This should eliminate 2 `cx` per call. - * **opt\_a2** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – whether to try optimization A.2 from \[1, 2]. This decomposes two qubit unitaries into a diagonal gate and a two `cx` unitary and reduces overall `cx` count by $4^{n-2} - 1$. This optimization should not be done if the original unitary is controlled. + * **opt\_a1** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – whether to try optimization A.1 from \[1, 2]. This should eliminate 2 `cx` per call. + * **opt\_a2** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") *| None*) – whether to try optimization A.2 from \[1, 2]. This decomposes two qubit unitaries into a diagonal gate and a two `cx` unitary and reduces overall `cx` count by $4^{n-2} - 1$. This optimization should not be done if the original unitary is controlled. * **decomposer\_1q** (*Callable\[\[np.ndarray],* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – optional 1Q decomposer. If None, uses [`OneQubitEulerDecomposer`](qiskit.synthesis.OneQubitEulerDecomposer "qiskit.synthesis.OneQubitEulerDecomposer"). * **decomposer\_2q** (*Callable\[\[np.ndarray],* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – optional 2Q decomposer. If None, uses [`TwoQubitBasisDecomposer`](qiskit.synthesis.TwoQubitBasisDecomposer "qiskit.synthesis.TwoQubitBasisDecomposer"). @@ -832,8 +832,8 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** * **unitary** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or np.ndarray*) – The 4x4 unitary to synthesize. - * **basis\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *or None*) – If given the assumed fidelity for applications of [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). - * **approximate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` approximate if `basis_fidelity` is less than 1.0. + * **basis\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *or None*) – If given the assumed fidelity for applications of [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). + * **approximate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` approximate if `basis_fidelity` is less than 1.0. **Returns** @@ -875,9 +875,9 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Base gate to be applied to the targets. - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of control qubits. - * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of target qubits. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – Optional control state as an integer. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of control qubits. + * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of target qubits. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – Optional control state as an integer. **Returns** @@ -914,9 +914,9 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of control qubits. - * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of target qubits. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – Optional control state as an integer. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of control qubits. + * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of target qubits. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – Optional control state as an integer. **Returns** @@ -934,7 +934,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. + **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. **Returns** @@ -960,7 +960,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. + **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. **Returns** @@ -986,7 +986,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. + **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. **Returns** @@ -1012,7 +1012,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. + **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. **Returns** @@ -1040,9 +1040,9 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. - * **relative\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, the method applies the optimized multi-controlled X gate up to a relative phase, in a way that, by lemma 8 of \[1], the relative phases of the `action part` cancel out with the phases of the `reset part`. - * **action\_only** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, the method applies only the `action part` of lemma 8 of \[1]. + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. + * **relative\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, the method applies the optimized multi-controlled X gate up to a relative phase, in a way that, by lemma 8 of \[1], the relative phases of the `action part` cancel out with the phases of the `reset part`. + * **action\_only** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – when set to `True`, the method applies only the `action part` of lemma 8 of \[1]. **Returns** @@ -1064,7 +1064,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. + **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. **Returns** @@ -1086,7 +1086,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. + **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. **Returns** @@ -1113,7 +1113,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. + **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. **Returns** @@ -1137,7 +1137,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. + **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. **Returns** @@ -1161,7 +1161,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of control qubits. + **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of control qubits. **Returns** @@ -1220,9 +1220,9 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. - * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The kind of adder, can be `"half"` for a half adder or `"fixed"` for a fixed-sized adder. A half adder contains a carry-out to represent the most-significant bit, but the fixed-sized adder doesn’t and hence performs addition modulo `2 ** num_state_qubits`. - * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, creates appropriate control and inverse operations as `AnnotatedOperation` objects. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. + * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The kind of adder, can be `"half"` for a half adder or `"fixed"` for a fixed-sized adder. A half adder contains a carry-out to represent the most-significant bit, but the fixed-sized adder doesn’t and hence performs addition modulo `2 ** num_state_qubits`. + * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True`, creates appropriate control and inverse operations as `AnnotatedOperation` objects. **Return type** @@ -1294,12 +1294,12 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. - * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The kind of adder, can be `"full"` for a full adder, `"half"` for a half adder, or `"fixed"` for a fixed-sized adder. A full adder includes both carry-in and carry-out, a half only carry-out, and a fixed-sized adder neither carry-in nor carry-out. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. + * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The kind of adder, can be `"full"` for a full adder, `"half"` for a half adder, or `"fixed"` for a fixed-sized adder. A full adder includes both carry-in and carry-out, a half only carry-out, and a fixed-sized adder neither carry-in nor carry-out. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_state_qubits` is lower than 1. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_state_qubits` is lower than 1. **Return type** @@ -1343,12 +1343,12 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The size of the register. - * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The kind of adder, can be `"full"` for a full adder, `"half"` for a half adder, or `"fixed"` for a fixed-sized adder. A full adder includes both carry-in and carry-out, a half only carry-out, and a fixed-sized adder neither carry-in nor carry-out. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The size of the register. + * **kind** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The kind of adder, can be `"full"` for a full adder, `"half"` for a half adder, or `"fixed"` for a fixed-sized adder. A full adder includes both carry-in and carry-out, a half only carry-out, and a fixed-sized adder neither carry-in nor carry-out. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_state_qubits` is lower than 1. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_state_qubits` is lower than 1. **Return type** @@ -1394,7 +1394,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The size of the register. + **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The size of the register. **Returns** @@ -1402,7 +1402,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_qubits` is lower than 1. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_qubits` is lower than 1. **Return type** @@ -1420,7 +1420,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The size of the register. + **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The size of the register. **Returns** @@ -1428,7 +1428,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_qubits` is less than 1. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_qubits` is less than 1. **Return type** @@ -1462,12 +1462,12 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. - * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of result qubits to limit the output to. If number of result qubits is $n$, multiplication modulo $2^n$ is performed to limit the output to the specified number of qubits. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. + * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of result qubits to limit the output to. If number of result qubits is $n$, multiplication modulo $2^n$ is performed to limit the output to the specified number of qubits. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_result_qubits` is given and not valid, meaning not in `[num_state_qubits, 2 * num_state_qubits]`. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_result_qubits` is given and not valid, meaning not in `[num_state_qubits, 2 * num_state_qubits]`. **Return type** @@ -1497,12 +1497,12 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. - * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of result qubits to limit the output to. If number of result qubits is $n$, multiplication modulo $2^n$ is performed to limit the output to the specified number of qubits. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits in either input register for state $|a\rangle$ or $|b\rangle$. The two input registers must have the same number of qubits. + * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – The number of result qubits to limit the output to. If number of result qubits is $n$, multiplication modulo $2^n$ is performed to limit the output to the specified number of qubits. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If `num_result_qubits` is given and not valid, meaning not in `[num_state_qubits, 2 * num_state_qubits]`. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If `num_result_qubits` is given and not valid, meaning not in `[num_state_qubits, 2 * num_state_qubits]`. **Return type** @@ -1550,9 +1550,9 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits encoding the value to compare to. - * **value** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The value to compare to. - * **geq** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` flip the target bit if the qubit state is $\geq$ than the value, otherwise implement $<$. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits encoding the value to compare to. + * **value** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The value to compare to. + * **geq** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` flip the target bit if the qubit state is $\geq$ than the value, otherwise implement $<$. **Returns** @@ -1578,9 +1578,9 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits encoding the value to compare to. - * **value** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The value to compare to. - * **geq** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` flip the target bit if the qubit state is $\geq$ than the value, otherwise implement $<$. + * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The number of qubits encoding the value to compare to. + * **value** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The value to compare to. + * **geq** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` flip the target bit if the qubit state is $\geq$ than the value, otherwise implement $<$. **Returns** diff --git a/docs/api/qiskit/transpiler.mdx b/docs/api/qiskit/transpiler.mdx index 6605f232d9a..b3b36f3fc75 100644 --- a/docs/api/qiskit/transpiler.mdx +++ b/docs/api/qiskit/transpiler.mdx @@ -628,15 +628,15 @@ In general, the requirement is that **all the same circuit modifications are mad Some tips for ensuring this include: -* Be very careful when iterating over hash-based containers. Iteration over Python’s [`set`](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)") is non-deterministic due to hash-seed randomization. In Rust, iteration over the standard-library hash-based containers, including `hashbrown` equivalents with their default hashers is non-deterministic. +* Be very careful when iterating over hash-based containers. Iteration over Python’s [`set`](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.14)") is non-deterministic due to hash-seed randomization. In Rust, iteration over the standard-library hash-based containers, including `hashbrown` equivalents with their default hashers is non-deterministic. - Iteration over Python’s [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *is* deterministic, and guaranteed to be in insertion order if there have been no removals, and arbitrary but still deterministic order if there have been deterministic removals. + Iteration over Python’s [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") *is* deterministic, and guaranteed to be in insertion order if there have been no removals, and arbitrary but still deterministic order if there have been deterministic removals. - In Python, if you need to create a [`set`](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)") and then iterate over it, consider instead using a [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") with all the values being `None` as a substitute. Using a [`set`](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)") purely for membership testing is no trouble. + In Python, if you need to create a [`set`](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.14)") and then iterate over it, consider instead using a [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") with all the values being `None` as a substitute. Using a [`set`](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.14)") purely for membership testing is no trouble. - In Rust, use `indexmap` and its structs `IndexMap` and `IndexSet` as replacements for `HashMap` and `HashSet`, respectively; they have similar deterministic-iteration properties to Python’s [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)"). + In Rust, use `indexmap` and its structs `IndexMap` and `IndexSet` as replacements for `HashMap` and `HashSet`, respectively; they have similar deterministic-iteration properties to Python’s [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)"). * If your pass as stochastic components, ensure that you accept a `seed` input, and make your output pure if this is supplied as an integer. Typically this means storing the seed, and instantiating a new pRNG from this seed at the start of each call to `BasePass.run()`. diff --git a/docs/api/qiskit/transpiler_passes.mdx b/docs/api/qiskit/transpiler_passes.mdx index 6504d6c17a3..a4977646695 100644 --- a/docs/api/qiskit/transpiler_passes.mdx +++ b/docs/api/qiskit/transpiler_passes.mdx @@ -155,3 +155,15 @@ These are post qubit selection. | [`UnrollForLoops`](qiskit.transpiler.passes.UnrollForLoops "qiskit.transpiler.passes.UnrollForLoops")(\*args, \*\*kwargs) | `UnrollForLoops` transpilation pass unrolls for-loops when possible. | | [`WrapAngles`](qiskit.transpiler.passes.WrapAngles "qiskit.transpiler.passes.WrapAngles")(\*args, \*\*kwargs) | Wrap angles outside the bound specified in the target. | +## Additional data + +### qiskit.transpiler.passes.utils.wrap\_angles.WRAP\_ANGLE\_REGISTRY + + + A global instance of [`WrapAngleRegistry`](qiskit.transpiler.WrapAngleRegistry "qiskit.transpiler.WrapAngleRegistry") that is used by default by [`WrapAngles`](qiskit.transpiler.passes.WrapAngles "qiskit.transpiler.passes.WrapAngles") when no explicit registry is specified. See the documentation of [`WrapAngles`](qiskit.transpiler.passes.WrapAngles "qiskit.transpiler.passes.WrapAngles") for how to add entries to a registry. + + + Due to an oversight in Qiskit 2.2, this import path is the only valid way to access the object in that version, despite traversing two non-public internal modules. + + + diff --git a/docs/api/qiskit/transpiler_plugins.mdx b/docs/api/qiskit/transpiler_plugins.mdx index f5dae01635b..2a8976300c8 100644 --- a/docs/api/qiskit/transpiler_plugins.mdx +++ b/docs/api/qiskit/transpiler_plugins.mdx @@ -49,31 +49,32 @@ from qiskit.transpiler.preset_passmanagers import common from qiskit.transpiler import PassManager from qiskit.transpiler.passes import VF2Layout, TrivialLayout from qiskit.transpiler.passes.layout.vf2_layout import VF2LayoutStopReason +from qiskit.passmanager import ConditionalController def _vf2_match_not_found(property_set): - return property_set["layout"] is None or ( - property_set["VF2Layout_stop_reason"] is not None - and property_set["VF2Layout_stop_reason"] is not VF2LayoutStopReason.SOLUTION_FOUND + return property_set.get("layout") is None or ( + property_set.get("VF2Layout_stop_reason") is not None + and property_set.get("VF2Layout_stop_reason") + is not VF2LayoutStopReason.SOLUTION_FOUND + ) class VF2LayoutPlugin(PassManagerStagePlugin): - def pass_manager(self, pass_manager_config, optimization_level): layout_pm = PassManager( [ VF2Layout( coupling_map=pass_manager_config.coupling_map, - properties=pass_manager_config.backend_properties, - max_trials=optimization_level * 10 + 1 - target=pass_manager_config.target - ) + max_trials=optimization_level * 10 + 1, + target=pass_manager_config.target, + ), + ConditionalController( + TrivialLayout(pass_manager_config.coupling_map), + condition=_vf2_match_not_found, + ), ] ) - layout_pm.append( - TrivialLayout(pass_manager_config.coupling_map), - condition=_vf2_match_not_found, - ) layout_pm += common.generate_embed_passmanager(pass_manager_config.coupling_map) return layout_pm ``` @@ -96,12 +97,12 @@ There isn’t a limit to the number of plugins a single package can include as l ### list\_stage\_plugins - + Get a list of installed plugins for a stage. **Parameters** - **stage\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The stage name to get the plugin names for + **stage\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The stage name to get the plugin names for **Returns** @@ -118,7 +119,7 @@ There isn’t a limit to the number of plugins a single package can include as l ### passmanager\_stage\_plugins - + Return a dict with, for each stage name, the class type of the plugin. This function is useful for getting more information about a plugin: @@ -146,7 +147,7 @@ There isn’t a limit to the number of plugins a single package can include as l **Parameters** - **stage** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The stage name to get + **stage** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The stage name to get **Returns** @@ -154,7 +155,7 @@ There isn’t a limit to the number of plugins a single package can include as l **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") **Raises** diff --git a/docs/api/qiskit/transpiler_preset.mdx b/docs/api/qiskit/transpiler_preset.mdx index 544d03f6691..11de7c2816d 100644 --- a/docs/api/qiskit/transpiler_preset.mdx +++ b/docs/api/qiskit/transpiler_preset.mdx @@ -156,12 +156,12 @@ This module contains functions for generating the preset pass managers for the t **Parameters** * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object representing the backend - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of str gate names that represent the basis gates on the backend target - * **approximation\_degree** (*Optional\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – The heuristic approximation degree to use. Can be between 0 and 1. - * **unitary\_synthesis\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The unitary synthesis method to use. You can see a list of installed plugins with [`unitary_synthesis_plugin_names()`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names"). - * **unitary\_synthesis\_plugin\_config** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – The optional dictionary plugin configuration, this is plugin specific refer to the specified plugin’s documentation for how to use. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of str gate names that represent the basis gates on the backend target + * **approximation\_degree** (*Optional\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – The heuristic approximation degree to use. Can be between 0 and 1. + * **unitary\_synthesis\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The unitary synthesis method to use. You can see a list of installed plugins with [`unitary_synthesis_plugin_names()`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names"). + * **unitary\_synthesis\_plugin\_config** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – The optional dictionary plugin configuration, this is plugin specific refer to the specified plugin’s documentation for how to use. * **hls\_config** ([*HLSConfig*](qiskit.transpiler.passes.HLSConfig "qiskit.transpiler.passes.HLSConfig")) – An optional configuration class to use for [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") pass. Specifies how to synthesize various high-level objects. - * **qubits\_initially\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Indicates whether the input circuit is zero-initialized. + * **qubits\_initially\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Indicates whether the input circuit is zero-initialized. * **optimization\_metric** ([*OptimizationMetric*](qiskit.transpiler.OptimizationMetric "qiskit.transpiler.OptimizationMetric")) – the [`OptimizationMetric`](qiskit.transpiler.OptimizationMetric "qiskit.transpiler.OptimizationMetric") object that the metric used when optimizing the unrolling. **Returns** @@ -205,11 +205,11 @@ This module contains functions for generating the preset pass managers for the t * **routing\_pass** ([*TransformationPass*](qiskit.transpiler.TransformationPass "qiskit.transpiler.TransformationPass")) – The pass which will perform the routing * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object representing the backend * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map of the backend to route for - * **vf2\_call\_limit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The internal call limit for the vf2 post layout pass. If this is `None` or `0` the vf2 post layout will not be run. - * **seed\_transpiler** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Sets random seed for the stochastic parts of the transpiler. This is currently only used for [`VF2PostLayout`](qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout") and the default value of `-1` is strongly recommended (which is no randomization). If a value of `None` is provided this will seed from system entropy. - * **check\_trivial** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If set to true this will condition running the [`VF2PostLayout`](qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout") pass after routing on whether a trivial layout was tried and was found to not be perfect. This is only needed if the constructed pass manager runs [`TrivialLayout`](qiskit.transpiler.passes.TrivialLayout "qiskit.transpiler.passes.TrivialLayout") as a first layout attempt and uses it if it’s a perfect layout (as is the case with preset pass manager level 1). - * **use\_barrier\_before\_measurement** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If true (the default) the [`BarrierBeforeFinalMeasurements`](qiskit.transpiler.passes.BarrierBeforeFinalMeasurements "qiskit.transpiler.passes.BarrierBeforeFinalMeasurements") transpiler pass will be run prior to the specified pass in the `routing_pass` argument. - * **vf2\_max\_trials** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The maximum number of trials to run VF2 when evaluating the vf2 post layout pass. If this is `None` or `0` the vf2 post layout will not be run. + * **vf2\_call\_limit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The internal call limit for the vf2 post layout pass. If this is `None` or `0` the vf2 post layout will not be run. + * **seed\_transpiler** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Sets random seed for the stochastic parts of the transpiler. This is currently only used for [`VF2PostLayout`](qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout") and the default value of `-1` is strongly recommended (which is no randomization). If a value of `None` is provided this will seed from system entropy. + * **check\_trivial** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If set to true this will condition running the [`VF2PostLayout`](qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout") pass after routing on whether a trivial layout was tried and was found to not be perfect. This is only needed if the constructed pass manager runs [`TrivialLayout`](qiskit.transpiler.passes.TrivialLayout "qiskit.transpiler.passes.TrivialLayout") as a first layout attempt and uses it if it’s a perfect layout (as is the case with preset pass manager level 1). + * **use\_barrier\_before\_measurement** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If true (the default) the [`BarrierBeforeFinalMeasurements`](qiskit.transpiler.passes.BarrierBeforeFinalMeasurements "qiskit.transpiler.passes.BarrierBeforeFinalMeasurements") transpiler pass will be run prior to the specified pass in the `routing_pass` argument. + * **vf2\_max\_trials** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – The maximum number of trials to run VF2 when evaluating the vf2 post layout pass. If this is `None` or `0` the vf2 post layout will not be run. **Returns** @@ -235,7 +235,7 @@ This module contains functions for generating the preset pass managers for the t * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object representing the backend * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – The coupling map to use - * **remove\_reset\_in\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True` include the remove reset in zero pass in the generated PassManager + * **remove\_reset\_in\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If `True` include the remove reset in zero pass in the generated PassManager **Returns** @@ -254,14 +254,14 @@ This module contains functions for generating the preset pass managers for the t **Parameters** * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object representing the backend - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of str gate names that represent the basis gates on the backend target - * **method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The basis translation method to use - * **approximation\_degree** (*Optional\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – The heuristic approximation degree to use. Can be between 0 and 1. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – A list of str gate names that represent the basis gates on the backend target + * **method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The basis translation method to use + * **approximation\_degree** (*Optional\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")*]*) – The heuristic approximation degree to use. Can be between 0 and 1. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – the coupling map of the backend in case synthesis is done on a physical circuit. The directionality of the coupling\_map will be taken into account if pulse\_optimize is True/None and natural\_direction is True/None. - * **unitary\_synthesis\_plugin\_config** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – The optional dictionary plugin configuration, this is plugin specific refer to the specified plugin’s documentation for how to use. - * **unitary\_synthesis\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The unitary synthesis method to use. You can see a list of installed plugins with [`unitary_synthesis_plugin_names()`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names"). + * **unitary\_synthesis\_plugin\_config** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – The optional dictionary plugin configuration, this is plugin specific refer to the specified plugin’s documentation for how to use. + * **unitary\_synthesis\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The unitary synthesis method to use. You can see a list of installed plugins with [`unitary_synthesis_plugin_names()`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names"). * **hls\_config** ([*HLSConfig*](qiskit.transpiler.passes.HLSConfig "qiskit.transpiler.passes.HLSConfig")) – An optional configuration class to use for [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") pass. Specifies how to synthesize various high-level objects. - * **qubits\_initially\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Indicates whether the input circuit is zero-initialized. + * **qubits\_initially\_zero** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Indicates whether the input circuit is zero-initialized. **Returns** @@ -283,8 +283,8 @@ This module contains functions for generating the preset pass managers for the t **Parameters** - * **instruction\_durations** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – The dictionary of instruction durations - * **scheduling\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The scheduling method to use, can either be `'asap'`/`'as_soon_as_possible'` or `'alap'`/`'as_late_as_possible'` + * **instruction\_durations** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – The dictionary of instruction durations + * **scheduling\_method** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The scheduling method to use, can either be `'asap'`/`'as_soon_as_possible'` or `'alap'`/`'as_late_as_possible'` * **timing\_constraints** (*TimingConstraints*) – Hardware time alignment restrictions. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object representing the backend diff --git a/docs/api/qiskit/utils.mdx b/docs/api/qiskit/utils.mdx index 5f119782974..a712092c206 100644 --- a/docs/api/qiskit/utils.mdx +++ b/docs/api/qiskit/utils.mdx @@ -26,9 +26,9 @@ python_api_name: qiskit.utils **Parameters** * **func** (*Callable*) – The function to modify. - * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The full deprecation message. - * **since** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The version the deprecation started at. - * **pending** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Is the deprecation still pending? + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The full deprecation message. + * **since** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – The version the deprecation started at. + * **pending** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Is the deprecation still pending? **Return type** @@ -44,15 +44,15 @@ python_api_name: qiskit.utils **Parameters** - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The name of the deprecated argument. - * **since** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The version the deprecation started at. If the deprecation is pending, set the version to when that started; but later, when switching from pending to deprecated, update since to the new version. - * **deprecation\_description** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – What is being deprecated? E.g. “Setting my\_func()’s my\_arg argument to None.” If not set, will default to “\{func\_name}’s argument \{name}”. - * **additional\_msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Put here any additional information, such as what to use instead (if new\_alias is not set). For example, “Instead, use the argument new\_arg, which is similar but does not impact the circuit’s setup.” - * **pending** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Set to True if the deprecation is still pending. - * **package\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The package name shown in the deprecation message (e.g. the PyPI package name). - * **new\_alias** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – If the arg has simply been renamed, set this to the new name. The decorator will dynamically update the kwargs so that when the user sets the old arg, it will be passed in as the new\_alias arg. - * **predicate** (*Callable\[\[Any],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*] | None*) – Only log the runtime warning if the predicate returns True. This is useful to deprecate certain values or types for an argument, e.g. lambda my\_arg: isinstance(my\_arg, dict). Regardless of if a predicate is set, the runtime warning will only log when the user specifies the argument. - * **removal\_timeline** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – How soon can this deprecation be removed? Expects a value like “no sooner than 6 months after the latest release” or “in release 9.99”. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The name of the deprecated argument. + * **since** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The version the deprecation started at. If the deprecation is pending, set the version to when that started; but later, when switching from pending to deprecated, update since to the new version. + * **deprecation\_description** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – What is being deprecated? E.g. “Setting my\_func()’s my\_arg argument to None.” If not set, will default to “\{func\_name}’s argument \{name}”. + * **additional\_msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Put here any additional information, such as what to use instead (if new\_alias is not set). For example, “Instead, use the argument new\_arg, which is similar but does not impact the circuit’s setup.” + * **pending** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Set to True if the deprecation is still pending. + * **package\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The package name shown in the deprecation message (e.g. the PyPI package name). + * **new\_alias** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – If the arg has simply been renamed, set this to the new name. The decorator will dynamically update the kwargs so that when the user sets the old arg, it will be passed in as the new\_alias arg. + * **predicate** (*Callable\[\[Any],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*] | None*) – Only log the runtime warning if the predicate returns True. This is useful to deprecate certain values or types for an argument, e.g. lambda my\_arg: isinstance(my\_arg, dict). Regardless of if a predicate is set, the runtime warning will only log when the user specifies the argument. + * **removal\_timeline** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – How soon can this deprecation be removed? Expects a value like “no sooner than 6 months after the latest release” or “in release 9.99”. **Returns** @@ -74,13 +74,13 @@ python_api_name: qiskit.utils **Parameters** - * **since** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The version the deprecation started at. If the deprecation is pending, set the version to when that started; but later, when switching from pending to deprecated, update `since` to the new version. - * **additional\_msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – Put here any additional information, such as what to use instead. For example, “Instead, use the function `new_func` from the module `.`, which is similar but uses GPU acceleration.” - * **pending** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Set to `True` if the deprecation is still pending. - * **package\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The package name shown in the deprecation message (e.g. the PyPI package name). - * **removal\_timeline** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – How soon can this deprecation be removed? Expects a value like “no sooner than 6 months after the latest release” or “in release 9.99”. - * **is\_property** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If the deprecated function is a @property, set this to True so that the generated message correctly describes it as such. (This isn’t necessary for property setters, as their docstring is ignored by Python.) - * **stacklevel** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Stack level passed to [`warnings.warn()`](https://docs.python.org/3/library/warnings.html#warnings.warn "(in Python v3.13)"). + * **since** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The version the deprecation started at. If the deprecation is pending, set the version to when that started; but later, when switching from pending to deprecated, update `since` to the new version. + * **additional\_msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – Put here any additional information, such as what to use instead. For example, “Instead, use the function `new_func` from the module `.`, which is similar but uses GPU acceleration.” + * **pending** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – Set to `True` if the deprecation is still pending. + * **package\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – The package name shown in the deprecation message (e.g. the PyPI package name). + * **removal\_timeline** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – How soon can this deprecation be removed? Expects a value like “no sooner than 6 months after the latest release” or “in release 9.99”. + * **is\_property** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – If the deprecated function is a @property, set this to True so that the generated message correctly describes it as such. (This isn’t necessary for property setters, as their docstring is ignored by Python.) + * **stacklevel** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Stack level passed to [`warnings.warn()`](https://docs.python.org/3/library/warnings.html#warnings.warn "(in Python v3.14)"). **Returns** @@ -100,8 +100,8 @@ python_api_name: qiskit.utils **Parameters** - * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – The number to apply prefix to. - * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – String prefix. + * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – The number to apply prefix to. + * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – String prefix. **Returns** @@ -109,7 +109,7 @@ python_api_name: qiskit.utils **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") | [ParameterExpression](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") | [ParameterExpression](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") This may induce tiny value error due to internal representation of float object. See [https://docs.python.org/3/tutorial/floatingpoint.html](https://docs.python.org/3/tutorial/floatingpoint.html) for details. @@ -117,16 +117,16 @@ python_api_name: qiskit.utils **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the `units` aren’t recognized. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the `units` aren’t recognized. **Parameters** - * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – - * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – + * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – **Return type** - [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") | [ParameterExpression](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") + [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)") | [ParameterExpression](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") ### detach\_prefix @@ -146,8 +146,8 @@ python_api_name: qiskit.utils **Parameters** - * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – The number to find prefix. - * **decimal** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – Optional. An arbitrary integer number to represent a precision of the value. If specified, it tries to round the mantissa and adjust the prefix to rounded value. For example, 999\_999.91 will become 999.9999 k with `decimal=4`, while 1.0 M with `decimal=3` or less. + * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – The number to find prefix. + * **decimal** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – Optional. An arbitrary integer number to represent a precision of the value. If specified, it tries to round the mantissa and adjust the prefix to rounded value. For example, 999\_999.91 will become 999.9999 k with `decimal=4`, while 1.0 M with `decimal=3` or less. **Returns** @@ -155,7 +155,7 @@ python_api_name: qiskit.utils **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)"), [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)"), [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")] This may induce tiny value error due to internal representation of float object. See [https://docs.python.org/3/tutorial/floatingpoint.html](https://docs.python.org/3/tutorial/floatingpoint.html) for details. @@ -163,17 +163,17 @@ python_api_name: qiskit.utils **Raises** - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the `value` is out of range. - * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the `value` is not real number. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the `value` is out of range. + * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – If the `value` is not real number. **Parameters** - * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – - * **decimal** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)")) – + * **decimal** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)"), [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.14)")\[[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.14)"), [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")] ## Class tools @@ -189,14 +189,14 @@ python_api_name: qiskit.utils **Parameters** - * **cls** ([*Type*](https://docs.python.org/3/library/typing.html#typing.Type "(in Python v3.13)")) – the class to modify. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the name of the method on the class to wrap. - * **before** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)") *| None*) – a callable that should be called before the method that is being wrapped. - * **after** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)") *| None*) – a callable that should be called after the method that is being wrapped. + * **cls** ([*Type*](https://docs.python.org/3/library/typing.html#typing.Type "(in Python v3.14)")) – the class to modify. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the name of the method on the class to wrap. + * **before** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)") *| None*) – a callable that should be called before the method that is being wrapped. + * **after** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)") *| None*) – a callable that should be called after the method that is being wrapped. **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if the named method is not defined on the class or any parent class. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if the named method is not defined on the class or any parent class. ## Multiprocessing @@ -219,7 +219,7 @@ python_api_name: qiskit.utils **Return type** - [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") + [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") ### is\_main\_process @@ -238,7 +238,7 @@ python_api_name: qiskit.utils **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ### local\_hardware\_info @@ -254,7 +254,7 @@ python_api_name: qiskit.utils **Return type** - [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") + [dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)") ### should\_run\_in\_parallel @@ -262,7 +262,7 @@ python_api_name: qiskit.utils Decide whether a multiprocessing function should spawn subprocesses for parallelization. - In particular, this is how [`parallel_map()`](#qiskit.utils.parallel_map "qiskit.utils.parallel_map") decides whether to use multiprocessing or not. The `num_processes` argument alone does not enforce parallelism; by default, Qiskit will only use process-based parallelism when a `fork`-like process spawning start method is in effect. You can override this decision either by setting the [`multiprocessing`](https://docs.python.org/3/library/multiprocessing.html#module-multiprocessing "(in Python v3.13)") start method you use, setting the `QISKIT_PARALLEL` environment variable to `"TRUE"`, or setting `parallel = true` in your user settings file. + In particular, this is how [`parallel_map()`](#qiskit.utils.parallel_map "qiskit.utils.parallel_map") decides whether to use multiprocessing or not. The `num_processes` argument alone does not enforce parallelism; by default, Qiskit will only use process-based parallelism when a `fork`-like process spawning start method is in effect. You can override this decision either by setting the [`multiprocessing`](https://docs.python.org/3/library/multiprocessing.html#module-multiprocessing "(in Python v3.14)") start method you use, setting the `QISKIT_PARALLEL` environment variable to `"TRUE"`, or setting `parallel = true` in your user settings file. This function includes two context managers that can be used to temporarily modify the return value of this function: @@ -275,7 +275,7 @@ python_api_name: qiskit.utils **Parameters** - **value** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **value** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")) – ### ignore\_user\_settings @@ -288,11 +288,11 @@ python_api_name: qiskit.utils **Parameters** - **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – the maximum number of processes requested for use (`None` implies the default). + **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)") *| None*) – the maximum number of processes requested for use (`None` implies the default). **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") **Examples** @@ -306,7 +306,7 @@ python_api_name: qiskit.utils ``` -A helper function for calling a custom function with Python [`ProcessPoolExecutor`](https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.ProcessPoolExecutor "(in Python v3.13)"). Tasks can be executed in parallel using this function. +A helper function for calling a custom function with Python [`ProcessPoolExecutor`](https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.ProcessPoolExecutor "(in Python v3.14)"). Tasks can be executed in parallel using this function. ### parallel\_map @@ -323,9 +323,9 @@ A helper function for calling a custom function with Python [`ProcessPoolExecuto * **task** (*func*) – Function that is to be called for each value in `values`. * **values** (*array\_like*) – List or array of values for which the `task` function is to be evaluated. - * **task\_args** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – Optional additional arguments to the `task` function. - * **task\_kwargs** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – Optional additional keyword argument to the `task` function. - * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Number of processes to spawn. If not given, the return value of [`default_num_processes()`](#qiskit.utils.default_num_processes "qiskit.utils.default_num_processes") is used. + * **task\_args** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.14)")) – Optional additional arguments to the `task` function. + * **task\_kwargs** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.14)")) – Optional additional keyword argument to the `task` function. + * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.14)")) – Number of processes to spawn. If not given, the return value of [`default_num_processes()`](#qiskit.utils.default_num_processes "qiskit.utils.default_num_processes") is used. **Returns** @@ -570,7 +570,7 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager - Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.14)") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -616,7 +616,7 @@ from qiskit.utils import LazyImportTester **Return type** - [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") + [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)") ##### disable\_locally @@ -632,7 +632,7 @@ from qiskit.utils import LazyImportTester **Parameters** - **feature\_or\_callable** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *or Callable*) – the name of the feature that requires these dependencies. If this function is called directly as a decorator (for example `@HAS_X.require_in_call` as opposed to `@HAS_X.require_in_call("my feature")`), then the feature name will be taken to be the function name, or class and method name as appropriate. + **feature\_or\_callable** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *or Callable*) – the name of the feature that requires these dependencies. If this function is called directly as a decorator (for example `@HAS_X.require_in_call` as opposed to `@HAS_X.require_in_call("my feature")`), then the feature name will be taken to be the function name, or class and method name as appropriate. **Returns** @@ -650,7 +650,7 @@ from qiskit.utils import LazyImportTester **Parameters** - **feature\_or\_class** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *or*[*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")) – the name of the feature that requires these dependencies. If this function is called directly as a decorator (for example `@HAS_X.require_in_instance` as opposed to `@HAS_X.require_in_instance("my feature")`), then the feature name will be taken as the name of the class. + **feature\_or\_class** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *or*[*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")) – the name of the feature that requires these dependencies. If this function is called directly as a decorator (for example `@HAS_X.require_in_instance` as opposed to `@HAS_X.require_in_instance("my feature")`), then the feature name will be taken as the name of the class. **Returns** @@ -668,7 +668,7 @@ from qiskit.utils import LazyImportTester **Parameters** - **feature** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – the name of the feature that is requiring these dependencies. + **feature** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")) – the name of the feature that is requiring these dependencies. **Raises** @@ -685,15 +685,15 @@ from qiskit.utils import LazyImportTester **Parameters** - * **name\_map\_or\_modules** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]] |* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – if a name map, then a dictionary where the keys are modules or packages, and the values are iterables of names to try and import from that module. It should be valid to write `from import , , ...`. If simply a string or iterable of strings, then it should be valid to write `import ` for each of them. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – - * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*], None] | None*) – - * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – - * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **name\_map\_or\_modules** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*,* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]] |* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – if a name map, then a dictionary where the keys are modules or packages, and the values are iterables of names to try and import from that module. It should be valid to write `from import , , ...`. If simply a string or iterable of strings, then it should be valid to write `import ` for each of them. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – + * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)")*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*], None] | None*) – + * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if no modules are given. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if no modules are given. #### LazySubprocessTester @@ -705,14 +705,14 @@ from qiskit.utils import LazyImportTester **Parameters** - * **command** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – the strings that make up the command to be run. For example, `["pdflatex", "-version"]`. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – - * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*], None] | None*) – - * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – - * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **command** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.14)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)")*]*) – the strings that make up the command to be run. For example, `["pdflatex", "-version"]`. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – + * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.14)")*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.14)")*], None] | None*) – + * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.14)") *| None*) – **Raises** - [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – if an empty command is given. + [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.14)") – if an empty command is given. diff --git a/public/docs/api/qiskit-c/objects.inv b/public/docs/api/qiskit-c/objects.inv index 5c1b3ac593c..fd5e64e7a38 100644 Binary files a/public/docs/api/qiskit-c/objects.inv and b/public/docs/api/qiskit-c/objects.inv differ diff --git a/public/docs/api/qiskit/objects.inv b/public/docs/api/qiskit/objects.inv index 85169f6ef66..65a6d1a1cc4 100644 Binary files a/public/docs/api/qiskit/objects.inv and b/public/docs/api/qiskit/objects.inv differ diff --git a/public/docs/images/api/qiskit/circuit_random-1.avif b/public/docs/images/api/qiskit/circuit_random-1.avif index e1d0254ea65..e4f34a6d5f7 100644 Binary files a/public/docs/images/api/qiskit/circuit_random-1.avif and b/public/docs/images/api/qiskit/circuit_random-1.avif differ diff --git a/public/docs/images/api/qiskit/circuit_random-3.avif b/public/docs/images/api/qiskit/circuit_random-3.avif index 5035cf2f520..6ef3d5193a3 100644 Binary files a/public/docs/images/api/qiskit/circuit_random-3.avif and b/public/docs/images/api/qiskit/circuit_random-3.avif differ diff --git a/public/docs/images/api/qiskit/providers_fake_provider-1_01.avif b/public/docs/images/api/qiskit/providers_fake_provider-1_01.avif index 9252372f887..4a89a620e99 100644 Binary files a/public/docs/images/api/qiskit/providers_fake_provider-1_01.avif and b/public/docs/images/api/qiskit/providers_fake_provider-1_01.avif differ diff --git a/public/docs/images/api/qiskit/providers_fake_provider-1_02.avif b/public/docs/images/api/qiskit/providers_fake_provider-1_02.avif index c2bdb27d912..c19f422f680 100644 Binary files a/public/docs/images/api/qiskit/providers_fake_provider-1_02.avif and b/public/docs/images/api/qiskit/providers_fake_provider-1_02.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-circuit-ControlledGate-2.avif b/public/docs/images/api/qiskit/qiskit-circuit-ControlledGate-2.avif index b66e4c4cff7..21fc77bb5a5 100644 Binary files a/public/docs/images/api/qiskit/qiskit-circuit-ControlledGate-2.avif and b/public/docs/images/api/qiskit/qiskit-circuit-ControlledGate-2.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-circuit-library-AndGate-1.avif b/public/docs/images/api/qiskit/qiskit-circuit-library-AndGate-1.avif index e2875cbe289..5d2a1ba1958 100644 Binary files a/public/docs/images/api/qiskit/qiskit-circuit-library-AndGate-1.avif and b/public/docs/images/api/qiskit/qiskit-circuit-library-AndGate-1.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-circuit-library-AndGate-2.avif b/public/docs/images/api/qiskit/qiskit-circuit-library-AndGate-2.avif index d55b749c55b..f97c4066e2c 100644 Binary files a/public/docs/images/api/qiskit/qiskit-circuit-library-AndGate-2.avif and b/public/docs/images/api/qiskit/qiskit-circuit-library-AndGate-2.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-circuit-library-BitwiseXorGate-1.avif b/public/docs/images/api/qiskit/qiskit-circuit-library-BitwiseXorGate-1.avif index 88d15307a36..4d0ae36472a 100644 Binary files a/public/docs/images/api/qiskit/qiskit-circuit-library-BitwiseXorGate-1.avif and b/public/docs/images/api/qiskit/qiskit-circuit-library-BitwiseXorGate-1.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-circuit-library-InnerProductGate-1.avif b/public/docs/images/api/qiskit/qiskit-circuit-library-InnerProductGate-1.avif index 1874f46b4ab..b1d0c340145 100644 Binary files a/public/docs/images/api/qiskit/qiskit-circuit-library-InnerProductGate-1.avif and b/public/docs/images/api/qiskit/qiskit-circuit-library-InnerProductGate-1.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-circuit-library-OrGate-1.avif b/public/docs/images/api/qiskit/qiskit-circuit-library-OrGate-1.avif index 7b2c62737a7..5b540d312b8 100644 Binary files a/public/docs/images/api/qiskit/qiskit-circuit-library-OrGate-1.avif and b/public/docs/images/api/qiskit/qiskit-circuit-library-OrGate-1.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-circuit-library-OrGate-2.avif b/public/docs/images/api/qiskit/qiskit-circuit-library-OrGate-2.avif index 1cf0a9d0fd5..cfde2ab5b3e 100644 Binary files a/public/docs/images/api/qiskit/qiskit-circuit-library-OrGate-2.avif and b/public/docs/images/api/qiskit/qiskit-circuit-library-OrGate-2.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.avif b/public/docs/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.avif index 7469befdee0..20a2992a183 100644 Binary files a/public/docs/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.avif and b/public/docs/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.avif b/public/docs/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.avif index bc30c61e42b..a9ac596e25e 100644 Binary files a/public/docs/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.avif and b/public/docs/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-circuit-library-random_iqp-1.avif b/public/docs/images/api/qiskit/qiskit-circuit-library-random_iqp-1.avif index 3ec0d22860b..932d71b41a3 100644 Binary files a/public/docs/images/api/qiskit/qiskit-circuit-library-random_iqp-1.avif and b/public/docs/images/api/qiskit/qiskit-circuit-library-random_iqp-1.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-circuit-library-unitary_overlap-1.avif b/public/docs/images/api/qiskit/qiskit-circuit-library-unitary_overlap-1.avif index 513e6f287e5..4f954b34506 100644 Binary files a/public/docs/images/api/qiskit/qiskit-circuit-library-unitary_overlap-1.avif and b/public/docs/images/api/qiskit/qiskit-circuit-library-unitary_overlap-1.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.avif b/public/docs/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.avif index 69ba42ce076..9d5f672ece9 100644 Binary files a/public/docs/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.avif and b/public/docs/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-visualization-plot_error_map-1.avif b/public/docs/images/api/qiskit/qiskit-visualization-plot_error_map-1.avif index 83957e72e66..3bf894e6664 100644 Binary files a/public/docs/images/api/qiskit/qiskit-visualization-plot_error_map-1.avif and b/public/docs/images/api/qiskit/qiskit-visualization-plot_error_map-1.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-1.avif b/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-1.avif index 96ef2ecd30d..ce59ff5b477 100644 Binary files a/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-1.avif and b/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-1.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-2.avif b/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-2.avif index c536f1de8d8..db8bb8f5a9a 100644 Binary files a/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-2.avif and b/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-2.avif differ diff --git a/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-3.avif b/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-3.avif index c8ec1ba5df2..d16dbdec1ae 100644 Binary files a/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-3.avif and b/public/docs/images/api/qiskit/qiskit-visualization-timeline_drawer-3.avif differ diff --git a/public/docs/images/api/qiskit/release_notes-10.avif b/public/docs/images/api/qiskit/release_notes-10.avif deleted file mode 100644 index 85d235ccb22..00000000000 Binary files a/public/docs/images/api/qiskit/release_notes-10.avif and /dev/null differ diff --git a/public/docs/images/api/qiskit/release_notes-11.avif b/public/docs/images/api/qiskit/release_notes-11.avif deleted file mode 100644 index 0d297b3c873..00000000000 Binary files a/public/docs/images/api/qiskit/release_notes-11.avif and /dev/null differ diff --git a/public/docs/images/api/qiskit/release_notes-12.avif b/public/docs/images/api/qiskit/release_notes-12.avif deleted file mode 100644 index 89f5cac58eb..00000000000 Binary files a/public/docs/images/api/qiskit/release_notes-12.avif and /dev/null differ diff --git a/public/docs/images/api/qiskit/release_notes-2.avif b/public/docs/images/api/qiskit/release_notes-2.avif deleted file mode 100644 index a332095088c..00000000000 Binary files a/public/docs/images/api/qiskit/release_notes-2.avif and /dev/null differ diff --git a/public/docs/images/api/qiskit/release_notes-3.avif b/public/docs/images/api/qiskit/release_notes-3.avif deleted file mode 100644 index e42c3a2bc84..00000000000 Binary files a/public/docs/images/api/qiskit/release_notes-3.avif and /dev/null differ diff --git a/public/docs/images/api/qiskit/release_notes-4.avif b/public/docs/images/api/qiskit/release_notes-4.avif deleted file mode 100644 index e416bbffaa8..00000000000 Binary files a/public/docs/images/api/qiskit/release_notes-4.avif and /dev/null differ diff --git a/public/docs/images/api/qiskit/release_notes-5.avif b/public/docs/images/api/qiskit/release_notes-5.avif deleted file mode 100644 index 4ba9c5e7ae9..00000000000 Binary files a/public/docs/images/api/qiskit/release_notes-5.avif and /dev/null differ diff --git a/public/docs/images/api/qiskit/release_notes-6.avif b/public/docs/images/api/qiskit/release_notes-6.avif deleted file mode 100644 index 7b5e0dfbfd1..00000000000 Binary files a/public/docs/images/api/qiskit/release_notes-6.avif and /dev/null differ diff --git a/public/docs/images/api/qiskit/release_notes-7.avif b/public/docs/images/api/qiskit/release_notes-7.avif deleted file mode 100644 index 355b56a3a39..00000000000 Binary files a/public/docs/images/api/qiskit/release_notes-7.avif and /dev/null differ diff --git a/public/docs/images/api/qiskit/release_notes-8.avif b/public/docs/images/api/qiskit/release_notes-8.avif deleted file mode 100644 index 0ce848dc771..00000000000 Binary files a/public/docs/images/api/qiskit/release_notes-8.avif and /dev/null differ diff --git a/public/docs/images/api/qiskit/release_notes-9.avif b/public/docs/images/api/qiskit/release_notes-9.avif deleted file mode 100644 index 480d175f631..00000000000 Binary files a/public/docs/images/api/qiskit/release_notes-9.avif and /dev/null differ diff --git a/public/docs/images/api/qiskit/transpiler-10.avif b/public/docs/images/api/qiskit/transpiler-10.avif index cc0a52175ed..1717a3e09b1 100644 Binary files a/public/docs/images/api/qiskit/transpiler-10.avif and b/public/docs/images/api/qiskit/transpiler-10.avif differ diff --git a/public/docs/images/api/qiskit/transpiler-9.avif b/public/docs/images/api/qiskit/transpiler-9.avif index 961c13fca88..8ea48ebf2ff 100644 Binary files a/public/docs/images/api/qiskit/transpiler-9.avif and b/public/docs/images/api/qiskit/transpiler-9.avif differ diff --git a/scripts/js/lib/api/Metadata.ts b/scripts/js/lib/api/Metadata.ts index d7a77e72172..b331c16f4d4 100644 --- a/scripts/js/lib/api/Metadata.ts +++ b/scripts/js/lib/api/Metadata.ts @@ -21,12 +21,19 @@ export type ApiObjectName = | "exception" | "data" // C API types - | "struct" + | "cStruct" | "cFunction" - | "typedef" - | "enum" - | "enumerator" - | "structMember"; + | "cTypedef" + | "cEnum" + | "cEnumerator" + | "cStructMember" + // C++ types used by historical Qiskit C API versions + | "cppStruct" + | "cppFunction" + | "cppTypedef" + | "cppEnum" + | "cppEnumerator" + | "cppStructMember"; interface ApiObjectInfo { htmlSelector: string; @@ -40,19 +47,28 @@ interface ApiObjectInfo { * it'll be displayed on the website). */ export const API_OBJECTS: { [K in ApiObjectName]: ApiObjectInfo } = { + // Python API types class: { htmlSelector: "dl.py.class", tagName: "class" }, exception: { htmlSelector: "dl.py.exception", tagName: "class" }, attribute: { htmlSelector: "dl.py.attribute", tagName: "attribute" }, property: { htmlSelector: "dl.py.property", tagName: "attribute" }, function: { htmlSelector: "dl.py.function", tagName: "function" }, - cFunction: { htmlSelector: "dl.cpp.function", tagName: "function" }, method: { htmlSelector: "dl.py.method", tagName: "function" }, data: { htmlSelector: "dl.py.data", tagName: "attribute" }, - struct: { htmlSelector: "dl.cpp.struct", tagName: "class" }, - typedef: { htmlSelector: "dl.cpp.type", tagName: "class" }, - enum: { htmlSelector: "dl.cpp.enum", tagName: "class" }, - enumerator: { htmlSelector: "dl.cpp.enumerator", tagName: "attribute" }, - structMember: { htmlSelector: "dl.cpp.var", tagName: "attribute" }, + // C API types + cFunction: { htmlSelector: "dl.c.function", tagName: "function" }, + cStruct: { htmlSelector: "dl.c.struct", tagName: "class" }, + cTypedef: { htmlSelector: "dl.c.type", tagName: "class" }, + cEnum: { htmlSelector: "dl.c.enum", tagName: "class" }, + cEnumerator: { htmlSelector: "dl.c.enumerator", tagName: "attribute" }, + cStructMember: { htmlSelector: "dl.c.var", tagName: "attribute" }, + // C++ types used by historical Qiskit C API versions + cppFunction: { htmlSelector: "dl.cpp.function", tagName: "function" }, + cppStruct: { htmlSelector: "dl.cpp.struct", tagName: "class" }, + cppTypedef: { htmlSelector: "dl.cpp.type", tagName: "class" }, + cppEnum: { htmlSelector: "dl.cpp.enum", tagName: "class" }, + cppEnumerator: { htmlSelector: "dl.cpp.enumerator", tagName: "attribute" }, + cppStructMember: { htmlSelector: "dl.cpp.var", tagName: "attribute" }, } as const; export type Metadata = { diff --git a/scripts/js/lib/api/generateApiComponents.ts b/scripts/js/lib/api/generateApiComponents.ts index b221ef93a37..52f5291b021 100644 --- a/scripts/js/lib/api/generateApiComponents.ts +++ b/scripts/js/lib/api/generateApiComponents.ts @@ -132,19 +132,28 @@ function prepareProps( ); const preparePropsPerApiType: Record ComponentProps> = { + // Python API types class: prepClassOrException, exception: prepClassOrException, property: prepAttributeOrProperty, attribute: prepAttributeOrProperty, method: prepMethod, function: prepFunction, - cFunction: prepFunction, data: prepAttributeOrProperty, - struct: prepClassOrException, - typedef: prepClassOrException, - enum: prepClassOrException, - enumerator: prepAttributeOrProperty, - structMember: prepAttributeOrProperty, + // C API types + cFunction: prepFunction, + cStruct: prepClassOrException, + cTypedef: prepClassOrException, + cEnum: prepClassOrException, + cEnumerator: prepAttributeOrProperty, + cStructMember: prepAttributeOrProperty, + // C++ types used by historical Qiskit C API versions + cppFunction: prepFunction, + cppStruct: prepClassOrException, + cppTypedef: prepClassOrException, + cppEnum: prepClassOrException, + cppEnumerator: prepAttributeOrProperty, + cppStructMember: prepAttributeOrProperty, }; const githubSourceLink = prepareGitHubLink($child, apiType === "method"); diff --git a/scripts/js/lib/links/ignores.ts b/scripts/js/lib/links/ignores.ts index 33f52703f93..8ab49ab0024 100644 --- a/scripts/js/lib/links/ignores.ts +++ b/scripts/js/lib/links/ignores.ts @@ -14,7 +14,12 @@ // Ignored files // ----------------------------------------------------------------------------------- -export const IGNORED_FILES: Set = new Set([]); +export const IGNORED_FILES: Set = new Set([ + // The Qiskit C API objects.inv have a lot of broken links that we should fix. Recently, + // the Qiskit team changed their linking of the C++ domain references to C, which created + // a ton of broken links. See https://github.com/Qiskit/qiskit/pull/15250 + "public/docs/api/qiskit-c/objects.inv", +]); // ----------------------------------------------------------------------------------- // Always ignored URLs - prefer to use more precise ignores @@ -421,36 +426,7 @@ const FILES_TO_IGNORES__EXPECTED: FilesToIgnores = mergeFilesToIgnores( function _qiskitCRegexes(): FilesToIgnores { return { - "public/docs/api/qiskit-c/objects.inv": [ - "/docs/api/qiskit-c/qk-complex-64#qk_complex64_from_native", - "/docs/api/qiskit-c/qk-complex-64#qk_complex64_from_native.value", - "/docs/api/qiskit-c/qk-complex-64#qk_complex64_to_native", - "/docs/api/qiskit-c/qk-complex-64#qk_complex64_to_native.value", - "/docs/api/qiskit-c/qk-circuit#qkdelayunit_ms", - "/docs/api/qiskit-c/qk-circuit#qkdelayunit_ns", - "/docs/api/qiskit-c/qk-circuit#qkdelayunit_ps", - "/docs/api/qiskit-c/qk-circuit#qkdelayunit_s", - "/docs/api/qiskit-c/qk-circuit#qkdelayunit_us", - "/docs/api/qiskit-c/index#c_api", - "/docs/api/qiskit-c/qk-complex-64#structqkcomplex64", - "/docs/api/qiskit-c/qk-complex-64#structqkcomplex64_1a1d0477d0d30b088dfd322e85b4be5464", - "/docs/api/qiskit-c/qk-complex-64#structqkcomplex64_1ae08ef5279f405357144d24ec1147b5f9", - "/docs/api/qiskit-c/version#qiskit_version_patch", - "/docs/api/qiskit-c/version#qiskit_version_minor", - "/docs/api/qiskit-c/version#qiskit_version_major", - "/docs/api/qiskit-c/version#qiskit_version_hex", - "/docs/api/qiskit-c/version#qiskit_version", - "/docs/api/qiskit-c/version#qiskit_release_serial", - "/docs/api/qiskit-c/version#qiskit_release_level", - "/docs/api/qiskit-c/version#qiskit_get_version_hex", - ], - "docs/api/qiskit-c/qk-transpiler.mdx": [ - "#_cppv412qk_transpilepk9qkcircuitpk8qktargetpk18qktranspileoptionsp17qktranspileresultppc", - "#structqktranspileoptions", - ], - "docs/api/qiskit-c/qk-vf-2-layout-result.mdx": [ - "qk-transpiler-passes#_cppv440qk_transpiler_pass_standalone_vf2_layoutpk9qkcircuitpk8qktargetb7int64_td7int64_t", - ], + "docs/api/qiskit-c/qk-transpiler.mdx": ["#structqktranspileoptions"], }; }