diff --git a/docs/api/qiskit/dev/_toc.json b/docs/api/qiskit/dev/_toc.json index b7a5a06e53b..a246c0af544 100644 --- a/docs/api/qiskit/dev/_toc.json +++ b/docs/api/qiskit/dev/_toc.json @@ -798,6 +798,10 @@ "title": "BackendSampler", "url": "/api/qiskit/dev/qiskit.primitives.BackendSampler" }, + { + "title": "BaseEstimatorV2", + "url": "/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2" + }, { "title": "BaseSamplerV2", "url": "/api/qiskit/dev/qiskit.primitives.BaseSamplerV2" diff --git a/docs/api/qiskit/dev/circuit_classical.md b/docs/api/qiskit/dev/circuit_classical.md index 5df109fdab1..76c2915baa0 100644 --- a/docs/api/qiskit/dev/circuit_classical.md +++ b/docs/api/qiskit/dev/circuit_classical.md @@ -650,7 +650,7 @@ A typical consumer of the expression tree wants to recursively walk through the -`qiskit.circuit.classical.expr.ExprVisitor`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.ExprVisitor(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py "view source code") 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 organised such that non-existent methods will never be called. diff --git a/docs/api/qiskit/dev/primitives.md b/docs/api/qiskit/dev/primitives.md index 86f837d75fe..b5d7a9e13e4 100644 --- a/docs/api/qiskit/dev/primitives.md +++ b/docs/api/qiskit/dev/primitives.md @@ -22,9 +22,9 @@ python_api_name: qiskit.primitives ## Overview of EstimatorV2 -`BaseEstimatorV2` is a primitive that estimates expectation values for provided quantum circuit and observable combinations. +[`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.base.base_estimator.BaseEstimatorV2") is a primitive that estimates expectation values for provided quantum circuit and observable combinations. -Following construction, an estimator is used by calling its `run()` method with a list of pubs (Primitive Unified Blocs). Each pub contains three values that, together, define a computation unit of work for the estimator to complete: +Following construction, an estimator is used by calling its [`run()`](qiskit.primitives.BaseEstimatorV2#run "qiskit.primitives.BaseEstimatorV2.run") method with a list of pubs (Primitive Unified Blocs). Each pub contains three values that, together, define a computation unit of work for the estimator to complete: * a single [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), possibly parametrized, whose final state we define as $\psi(\theta)$, * one or more observables (specified as any `ObservablesArrayLike`, including [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"), [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp"), `str`) that specify which expectation values to estimate, denoted $H_j$, and @@ -232,17 +232,23 @@ print([q.binary_probabilities() for q in job_result.quasi_dists]) ## EstimatorV2 -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| [`StatevectorEstimator`](qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator")(\*\[, default\_precision, ...]) | Simple implementation of `BaseEstimatorV2` with full state vector simulation. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2")() | Estimator base class version 2. | +| [`StatevectorEstimator`](qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator")(\*\[, default\_precision, ...]) | Simple implementation of [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2") with full state vector simulation. | ## Sampler +| | | +| ----------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| [`BaseSampler`](qiskit.primitives.BaseSampler#qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") | alias of `BaseSamplerV1` | +| [`Sampler`](qiskit.primitives.Sampler "qiskit.primitives.Sampler")(\*\[, options]) | Sampler class. | +| [`BackendSampler`](qiskit.primitives.BackendSampler "qiskit.primitives.BackendSampler")(backend\[, options, ...]) | A `BaseSampler` implementation that provides an interface for leveraging the sampler interface from any backend. | + +## SamplerV2 + | | | | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`BaseSampler`](qiskit.primitives.BaseSampler#qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") | alias of `BaseSamplerV1` | -| [`Sampler`](qiskit.primitives.Sampler "qiskit.primitives.Sampler")(\*\[, options]) | Sampler class. | -| [`BackendSampler`](qiskit.primitives.BackendSampler "qiskit.primitives.BackendSampler")(backend\[, options, ...]) | A `BaseSampler` implementation that provides an interface for leveraging the sampler interface from any backend. | | [`BaseSamplerV2`](qiskit.primitives.BaseSamplerV2 "qiskit.primitives.BaseSamplerV2")() | Sampler base class version 2. | | [`StatevectorSampler`](qiskit.primitives.StatevectorSampler "qiskit.primitives.StatevectorSampler")(\*\[, default\_shots, seed]) | Simple implementation of [`BaseSamplerV2`](qiskit.primitives.BaseSamplerV2 "qiskit.primitives.BaseSamplerV2") using full state vector simulation. | diff --git a/docs/api/qiskit/dev/providers.md b/docs/api/qiskit/dev/providers.md index 8da29b323d4..3dac2d0727b 100644 --- a/docs/api/qiskit/dev/providers.md +++ b/docs/api/qiskit/dev/providers.md @@ -32,7 +32,7 @@ Each minor version release of qiskit-terra **may** increment the version of any To enable providers to have time to adjust to changes in this interface Terra will support multiple versions of each class at once. Given the nature of one version per release the version deprecation policy is a bit more conservative than the standard deprecation policy. Terra will support a provider interface version for a minimum of 3 minor releases or the first release after 6 months from the release that introduced a version, whichever is longer, prior to a potential deprecation. After that the standard deprecation policy will apply to that interface version. This will give providers and users sufficient time to adapt to potential breaking changes in the interface. So for example lets say in 0.19.0 `BackendV2` is introduced and in the 3 months after the release of 0.19.0 we release 0.20.0, 0.21.0, and 0.22.0, then 7 months after 0.19.0 we release 0.23.0. In 0.23.0 we can deprecate BackendV2, and it needs to still be supported and can’t be removed until the deprecation policy completes. -It’s worth pointing out that Terra’s version support policy doesn’t mean providers themselves will have the same support story, they can (and arguably should) update to newer versions as soon as they can, the support window is just for Terra’s supported versions. Part of this lengthy window prior to deprecation is to give providers enough time to do their own deprecation of a potential end user impacting change in a user facing part of the interface prior to bumping their version. For example, let’s say we changed the signature to `Backend.run()` in `BackendV34` in a backwards incompatible way. Before Aer could update its [`AerSimulator`](https://qiskit.org/ecosystem/aer/stubs/qiskit_aer.AerSimulator.html#qiskit_aer.AerSimulator "(in Qiskit Aer v0.13.1)") class to be based on version 34 they’d need to deprecate the old signature prior to switching over. The changeover for Aer is not guaranteed to be lockstep with Terra so we need to ensure there is a sufficient amount of time for Aer to complete its deprecation cycle prior to removing version 33 (ie making version 34 mandatory/the minimum version). +It’s worth pointing out that Terra’s version support policy doesn’t mean providers themselves will have the same support story, they can (and arguably should) update to newer versions as soon as they can, the support window is just for Terra’s supported versions. Part of this lengthy window prior to deprecation is to give providers enough time to do their own deprecation of a potential end user impacting change in a user facing part of the interface prior to bumping their version. For example, let’s say we changed the signature to `Backend.run()` in `BackendV34` in a backwards incompatible way. Before Aer could update its [`AerSimulator`](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html#qiskit_aer.AerSimulator "(in Qiskit Aer v0.13.3)") class to be based on version 34 they’d need to deprecate the old signature prior to switching over. The changeover for Aer is not guaranteed to be lockstep with Terra so we need to ensure there is a sufficient amount of time for Aer to complete its deprecation cycle prior to removing version 33 (ie making version 34 mandatory/the minimum version). ## Abstract Classes diff --git a/docs/api/qiskit/dev/pulse.md b/docs/api/qiskit/dev/pulse.md index 87d92bacdcc..08f552de5f7 100644 --- a/docs/api/qiskit/dev/pulse.md +++ b/docs/api/qiskit/dev/pulse.md @@ -246,7 +246,7 @@ Return a new schedule with implicit acquires from the measurement mapping replac **Parameters** -* **schedule** ([*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule") *|*[*Instruction*](#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction")) – Schedule to be aligned. +* **schedule** (*ScheduleComponent*) – Schedule to be aligned. * **meas\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]]*) – List of lists of qubits that are measured together. **Returns** @@ -255,7 +255,7 @@ A `Schedule` with the additional acquisition instructions. **Return type** -[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule") +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") ### align\_measures @@ -365,7 +365,7 @@ Optimization pass to replace identical pulses. **Parameters** -**schedules** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*qiskit.pulse.schedule.Schedule*](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule")*]*) – Schedules to compress. +**schedules** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")*]*) – Schedules to compress. **Returns** @@ -373,7 +373,7 @@ Compressed schedules. **Return type** -[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[[qiskit.pulse.schedule.Schedule](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule")] +[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule")] ### flatten @@ -895,7 +895,7 @@ with pulse.build(backend): **Parameters** -**qubits** ([*Iterable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – Tuple or list of ordered qubits of the form (control\_qubit, target\_qubit). +**qubits** (*Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – Tuple or list of ordered qubits of the form (control\_qubit, target\_qubit). **Returns** @@ -903,7 +903,7 @@ List of control channels associated with the supplied ordered list of qubits. **Return type** -[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[[qiskit.pulse.channels.ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")] +[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[chans.ControlChannel] ### drive\_channel @@ -1540,7 +1540,7 @@ None **Return type** -Generator\[None, None, None] +Generator\[(None, None, None)] **Notes** @@ -1594,7 +1594,7 @@ None **Return type** -Generator\[None, None, None] +Generator\[(None, None, None)] **Notes** @@ -1635,7 +1635,7 @@ None **Return type** -[*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)")\[None, None, None] +Generator\[(None, None, None)] ### align\_right @@ -1672,7 +1672,7 @@ None **Return type** -[*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)")\[None, None, None] +Generator\[(None, None, None)] ### align\_sequential @@ -1709,7 +1709,7 @@ None **Return type** -[*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)")\[None, None, None] +Generator\[(None, None, None)] ### frequency\_offset @@ -1746,7 +1746,7 @@ assert len(pulse_prog.instructions) == 4 **Parameters** * **frequency** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – Amount of frequency offset in Hz. -* **channels** (*PulseChannel*) – Channels to offset frequency of. +* **channels** (*chans.PulseChannel*) – Channels to offset frequency of. * **compensate\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Compensate for accumulated phase accumulated with respect to the channels’ frame at its initial frequency. **Yields** @@ -1755,7 +1755,7 @@ None **Return type** -[*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)")\[None, None, None] +Generator\[(None, None, None)] ### phase\_offset @@ -1784,7 +1784,7 @@ assert len(pulse_prog.instructions) == 3 **Parameters** * **phase** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – Amount of phase offset in radians. -* **channels** (*PulseChannel*) – Channels to offset phase of. +* **channels** (*chans.PulseChannel*) – Channels to offset phase of. **Yields** @@ -1792,7 +1792,7 @@ None **Return type** -[*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)")\[None, None, None] +Generator\[(None, None, None)] ### Macros @@ -1903,7 +1903,7 @@ The `register`s the qubit measurement results will be stored in. **Return type** -[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[[qiskit.pulse.channels.MemorySlot](qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")] +[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[chans.MemorySlot] ### delay\_qubits @@ -2052,7 +2052,7 @@ with pulse.build(backend): **Return type** -[set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.12)")\[[qiskit.pulse.channels.Channel](#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] +[set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.12)")\[chans.Channel] ### samples\_to\_seconds diff --git a/docs/api/qiskit/dev/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/dev/qiskit.circuit.ClassicalRegister.md index bc3587c450d..ca2dd90857d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/dev/qiskit.circuit.ClassicalRegister.md @@ -40,7 +40,7 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None ### instances\_counter -`= count(0)` +`= count(2)` diff --git a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.md index 46f358e974c..993eb0fd2f1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.md @@ -273,7 +273,7 @@ A tuple with single arguments. **Return type** -[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.12)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]] +Iterable\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]] ### c\_if diff --git a/docs/api/qiskit/dev/qiskit.circuit.Delay.md b/docs/api/qiskit/dev/qiskit.circuit.Delay.md index b79674f7f21..a15845188cd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Delay.md @@ -186,7 +186,7 @@ A tuple with single arguments. **Return type** -[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.12)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]] +Iterable\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]] ### c\_if diff --git a/docs/api/qiskit/dev/qiskit.circuit.Gate.md b/docs/api/qiskit/dev/qiskit.circuit.Gate.md index a9fa0dbb21b..eb84ba210d9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Gate.md @@ -193,7 +193,7 @@ A tuple with single arguments. **Return type** -[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.12)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]] +Iterable\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]] ### c\_if diff --git a/docs/api/qiskit/dev/qiskit.circuit.Parameter.md b/docs/api/qiskit/dev/qiskit.circuit.Parameter.md index d7f29f71527..143134a8881 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/dev/qiskit.circuit.Parameter.md @@ -152,7 +152,7 @@ A new expression parameterized by any parameters which were not bound by paramet **Return type** -[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") +[ParameterExpression](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") ### conjugate @@ -164,7 +164,7 @@ Return the conjugate. **Return type** -[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") +[ParameterExpression](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") ### cos @@ -200,7 +200,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co **Return type** -[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") | [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.12)") +[ParameterExpression](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") | [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.12)") ### is\_real diff --git a/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.md index 1b1682d3536..b6e4638159c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/dev/qiskit.circuit.ParameterExpression.md @@ -86,7 +86,7 @@ A new expression parameterized by any parameters which were not bound by assignm **Return type** -[*ParameterExpression*](#qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") +[ParameterExpression](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") ### bind @@ -117,7 +117,7 @@ A new expression parameterized by any parameters which were not bound by paramet **Return type** -[*ParameterExpression*](#qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") +[ParameterExpression](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") ### conjugate @@ -129,7 +129,7 @@ Return the conjugate. **Return type** -[*ParameterExpression*](#qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") +[ParameterExpression](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") ### cos @@ -165,7 +165,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co **Return type** -[*ParameterExpression*](#qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") | [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.12)") +[ParameterExpression](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") | [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.12)") ### is\_real @@ -248,7 +248,7 @@ A new expression with the specified parameters replaced. **Return type** -[*ParameterExpression*](#qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") +[ParameterExpression](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") ### sympify diff --git a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md index c36bebf1fd8..721f5b91961 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.md @@ -147,7 +147,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 182` +`= 164` @@ -3194,7 +3194,7 @@ q_0: ┤ bottom ├ ⊗ q_0: ┤ top ├ = q_0: ─┤ top ├── **Return type** -[*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") | None +[QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") | None **Examples** diff --git a/docs/api/qiskit/dev/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/dev/qiskit.circuit.QuantumRegister.md index f1503bca0b1..e89e0dc9d12 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/dev/qiskit.circuit.QuantumRegister.md @@ -40,7 +40,7 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None ### instances\_counter -`= count(5)` +`= count(1)` diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.md index 39d6ab47cd7..0cfb4f4ba47 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -190,7 +190,7 @@ A tuple with single arguments. **Return type** -[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.12)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]] +Iterable\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]] ### c\_if diff --git a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.md index c5661ef95ec..50d8225a0a6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/dev/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -241,7 +241,7 @@ A tuple with single arguments. **Return type** -[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.12)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]] +Iterable\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]] ### c\_if diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.AND.md b/docs/api/qiskit/dev/qiskit.circuit.library.AND.md index f6c6fe0bb61..d21238e7b1d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.AND.md @@ -80,7 +80,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 192` +`= 174` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.md index f8c5a60e6d5..d9bb3c068b9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.md @@ -26,8 +26,8 @@ Create a new 3-qubit controlled sqrt-X gate. **Parameters** -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** – An optional label for the gate \[Default: `None`] +* **ctrl\_state** – control state expressed as integer, string (e.g.\`\`’110’`), or ``None`. If `None`, use all 1s. ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.md index fb1e41f6114..9d354310351 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C3XGate.md @@ -166,8 +166,8 @@ Controlled version of this gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -184,5 +184,17 @@ controlled version of this gate. `inverse(annotated=False)` -Invert this gate. The C4X is its own inverse. +Invert this gate. The C3X is its own inverse. + +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[C3XGate](#qiskit.circuit.library.C3XGate "qiskit.circuit.library.C3XGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.md index b876c4c3ac8..b06922edb36 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C4XGate.md @@ -170,8 +170,8 @@ Controlled version of this gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -190,3 +190,15 @@ controlled version of this gate. Invert this gate. The C4X is its own inverse. +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[C4XGate](#qiskit.circuit.library.C4XGate "qiskit.circuit.library.C4XGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.md index 78d3b35b494..010e4d86adc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CCXGate.md @@ -222,8 +222,8 @@ Controlled version of this gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -242,3 +242,15 @@ controlled version of this gate. Return an inverted CCX gate (also a CCX). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[CCXGate](#qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.md index 8dc9c2df775..dd77c261143 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CCZGate.md @@ -194,3 +194,15 @@ Get the time unit of duration. Return inverted CCZ gate (itself). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[CCZGate](#qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.md index 7de6f9e631f..2669f109a9c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -126,7 +126,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 158` +`= 179` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.md index ce76c08e494..5887e20884f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.md @@ -193,8 +193,8 @@ Controlled version of this gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.md index 84c2cb3906e..11e20d52b40 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.md @@ -211,3 +211,15 @@ Get the time unit of duration. Return inverse CRX gate (i.e. with the negative rotation angle). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[CRXGate](#qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.md index ea306bb2c6e..0c108d7466f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.md @@ -209,5 +209,19 @@ Get the time unit of duration. `inverse(annotated=False)` -Return inverse CRY gate (i.e. with the negative rotation angle). +Return inverse CRY gate (i.e. with the negative rotation angle) + +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[CRYGate](#qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate") + +. diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.md index 398f9da692f..979d2dce859 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.md @@ -213,3 +213,15 @@ Get the time unit of duration. Return inverse CRZ gate (i.e. with the negative rotation angle). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – + +**when set to `True`, this is typically used to return an** + +`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 [`CRZGate`](#qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate") with an inverted parameter value. + +**Returns:** + +CRZGate: inverse gate. + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.md index b221bd6ad81..907042e1533 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSGate.md @@ -185,6 +185,18 @@ Get the time unit of duration. Return inverse of CSGate (CSdgGate). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse of [`CSGate`](#qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate") + +**Return type** + +[CSdgGate](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.md index fb152062492..0749b913c55 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSdgGate.md @@ -185,6 +185,18 @@ Get the time unit of duration. Return inverse of CSdgGate (CSGate). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse of [`CSdgGate`](#qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate") + +**Return type** + +[CSGate](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.md index 7f8e318e826..b2e59d0d55b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSwapGate.md @@ -228,3 +228,15 @@ Get the time unit of duration. Return inverse CSwap gate (itself). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[CSwapGate](#qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.md index ac2a4c53d3f..a9677e706ab 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.md @@ -191,8 +191,8 @@ Controlled version of this gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -209,5 +209,17 @@ controlled version of this gate. `inverse(annotated=False)` -Return inverted CU1 gate ($CU1(\lambda)^{\dagger} = CU1(-\lambda)$) +Return inverted CU1 gate ($CU1(\lambda)^{\dagger} = CU1(-\lambda))$ + +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[CU1Gate](#qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.md index 9c3b1703b4d..d87610e9b32 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.md @@ -213,5 +213,17 @@ Get the time unit of duration. Return inverted CU3 gate. -$CU3(\theta,\phi,\lambda)^{\dagger} =CU3(-\theta,-\phi,-\lambda)$) +$CU3(\theta,\phi,\lambda)^{\dagger} =CU3(-\theta,-\phi,-\lambda))$ + +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[CU3Gate](#qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.md index 5d2f968b44e..e7025e5f43b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.md @@ -203,5 +203,17 @@ Get the time unit of duration. Return inverted CU gate. -$CU(\theta,\phi,\lambda,\gamma)^{\dagger} = CU(-\theta,-\phi,-\lambda,-\gamma)$) +$CU(\theta,\phi,\lambda,\gamma)^{\dagger} = CU(-\theta,-\phi,-\lambda,-\gamma))$ + +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[CUGate](#qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.md index ae3f60abf8f..1463cae5522 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CXGate.md @@ -218,8 +218,8 @@ Return a controlled-X gate with more control lines. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -238,3 +238,15 @@ controlled version of this gate. Return inverted CX gate (itself). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[CXGate](#qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.md index d61363d489e..af69120b594 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CYGate.md @@ -207,3 +207,15 @@ Get the time unit of duration. Return inverted CY gate (itself). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[CYGate](#qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.md index de709b09a0a..2413daca912 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CZGate.md @@ -188,3 +188,15 @@ Get the time unit of duration. Return inverted CZ gate (itself). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[CZGate](#qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.md index 198f373e44d..022ec31cb99 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.md @@ -108,7 +108,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 158` +`= 179` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.md index 0bd020f0f3e..ae3c72705ea 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.md @@ -97,7 +97,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 158` +`= 179` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.md index d51e285cf8a..a16c07bb1fd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ECRGate.md @@ -173,3 +173,15 @@ Get the time unit of duration. Return inverse ECR gate (itself). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[ECRGate](#qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.md index ed4fcc3355d..613609f5c2f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.md @@ -159,7 +159,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 158` +`= 179` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.md b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.md index 81554c0f9b1..4a5fe8698ab 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.md @@ -93,7 +93,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 160` +`= 179` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.md b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.md index 7c3061e5c85..219492bfad9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.md @@ -93,7 +93,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 164` +`= 179` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.md index 54d23b06d03..a5f60ce41f0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.md @@ -93,7 +93,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 167` +`= 189` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.md index 15ef7774050..3eb4ffe1179 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GlobalPhaseGate.md @@ -139,7 +139,19 @@ Get the time unit of duration. `inverse(annotated=False)` -Return inverted GlobalPhaseGate gate. +Return inverse GlobalPhaseGate gate. $\text{GlobalPhaseGate}(\lambda)^{\dagger} = \text{GlobalPhaseGate}(-\lambda)$ +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[GlobalPhaseGate](#qiskit.circuit.library.GlobalPhaseGate "qiskit.circuit.library.GlobalPhaseGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.md index 0c6864ea6e0..ffaa3368c21 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.md @@ -98,7 +98,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 172` +`= 194` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.md index b76c6f62b2c..bd3958a6801 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.md @@ -209,7 +209,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 174` +`= 196` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.HGate.md index 39b22144b31..b6559fd6228 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HGate.md @@ -152,8 +152,8 @@ One control qubit returns a CH gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -172,3 +172,15 @@ controlled version of this gate. Return inverted H gate (itself). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[HGate](#qiskit.circuit.library.HGate "qiskit.circuit.library.HGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.md index be45ebdbeeb..5a57e93b44d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -110,7 +110,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 174` +`= 196` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.md index 9345a474ada..fcc5f9c828c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.md @@ -22,7 +22,7 @@ This gate resolves to a [`UnitaryGate`](qiskit.circuit.library.UnitaryGate "qisk * **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.12)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – Time evolution parameter. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – Unitary name for backend \[Default: None]. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – Unitary name for backend \[Default: `None`]. **Raises** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.md index 4e3226ffe75..5d94cffcdb3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.md @@ -100,7 +100,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 176` +`= 198` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.IGate.md index ea7fd631e50..b4f72aa14e6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IGate.md @@ -144,7 +144,21 @@ Get the time unit of duration. `inverse(annotated=False)` -Invert this gate. +Returne the inverse gate (itself). + +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[IGate](#qiskit.circuit.library.IGate "qiskit.circuit.library.IGate") + +. ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IQP.md b/docs/api/qiskit/dev/qiskit.circuit.library.IQP.md index 3f134f35af7..6f0fc206db8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IQP.md @@ -88,7 +88,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 181` +`= 203` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.md index 346964c4789..d99d0f92404 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.md @@ -99,7 +99,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 194` +`= 216` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.md index afd25e5e930..3e20fb0029e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.md @@ -79,7 +79,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 196` +`= 218` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.md index 623ff843dbe..d74addd9cee 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -114,7 +114,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 196` +`= 218` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.md index 07e74b26b27..49fa1902175 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.md @@ -95,7 +95,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 196` +`= 218` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.md index c43f3992e6c..e3bb92eb3bb 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.md @@ -92,7 +92,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 196` +`= 218` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.md index 681e5783f4c..905c16727ab 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.md @@ -116,7 +116,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 197` +`= 219` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.md index 50630d52f1a..b5098153962 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.md @@ -185,8 +185,8 @@ Controlled version of this gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.md index ef0537f47d1..c7b561663a5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.md @@ -172,8 +172,8 @@ Return a multi-controlled-X gate with more control lines. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -206,3 +206,15 @@ This staticmethod might be necessary to check the number of ancillas before crea Invert this gate. The MCX is its own inverse. +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[MCXGate](#qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.md index 6aa63b8813e..1c03c287d5f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.md @@ -169,3 +169,15 @@ Get the time unit of duration. Invert this gate. The MCX is its own inverse. +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[MCXGrayCode](#qiskit.circuit.library.MCXGrayCode "qiskit.circuit.library.MCXGrayCode") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.md index 21725f2a927..9a563d72e96 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.md @@ -177,3 +177,15 @@ Get the number of required ancilla qubits. Invert this gate. The MCX is its own inverse. +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[MCXRecursive](#qiskit.circuit.library.MCXRecursive "qiskit.circuit.library.MCXRecursive") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.md index 864d8423405..7898ef3f32e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.md @@ -175,3 +175,15 @@ Get the number of required ancilla qubits. Invert this gate. The MCX is its own inverse. +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[MCXVChain](#qiskit.circuit.library.MCXVChain "qiskit.circuit.library.MCXVChain") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.md index 4ab4898a637..d0eeb066b3b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.md @@ -145,7 +145,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 198` +`= 220` @@ -414,7 +414,7 @@ The entangler map for the current block in the current repetition. **Return type** -[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.12)")\[[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.12)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")]] +Sequence\[Sequence\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")]] ### get\_unentangled\_qubits diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.OR.md b/docs/api/qiskit/dev/qiskit.circuit.library.OR.md index 45da9408084..af4e776468d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.OR.md @@ -80,7 +80,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 201` +`= 223` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.md index a97331baf43..0c500de802b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.md @@ -208,7 +208,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 206` +`= 228` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.md index c563c5e3825..6e6043b6540 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.md @@ -143,7 +143,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 207` +`= 229` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.md index efafe5d540f..ff24e7cbfc2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.md @@ -82,7 +82,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 225` +`= 247` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.md index 48a365a5721..9f685dc9cd6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.md @@ -99,7 +99,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 207` +`= 301` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.md index 289baff3ffc..f55341ccf79 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.md @@ -174,8 +174,8 @@ Return a (multi-)controlled-Phase gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -194,6 +194,18 @@ controlled version of this gate. Return inverted Phase gate ($Phase(\lambda)^{\dagger} = Phase(-\lambda)$) +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +PGate + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.md index 9aadb35385e..b352ed2a991 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.md @@ -76,7 +76,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 209` +`= 303` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.md index 79983e57f63..7e1b687a8cd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.md @@ -121,7 +121,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 211` +`= 305` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index fd3d2e559b0..5a008fd4850 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -104,7 +104,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 271` +`= 365` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index d6f324a0fce..c2949083fbe 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -162,7 +162,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 211` +`= 305` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.md index faf2af0f685..008609409a4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.md @@ -122,7 +122,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 214` +`= 158` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.md index a930e9fdf26..bbc3c082ce2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.md @@ -137,7 +137,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 271` +`= 158` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QFT.md b/docs/api/qiskit/dev/qiskit.circuit.library.QFT.md index 02fc7f4a449..d05b6bd8f1b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QFT.md @@ -115,7 +115,7 @@ True, if barriers are inserted, False if not. ### instances -`= 169` +`= 161` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.md index da27f3822b5..ccc355ededf 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.md @@ -101,7 +101,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 283` +`= 170` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.md index 600850f460b..4a679d38a39 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.md @@ -87,7 +87,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 286` +`= 173` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.md index 5b56425e325..bc5ef735bef 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.md @@ -89,7 +89,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 417` +`= 304` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RGate.md index ff48591c3f5..50cfea01953 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RGate.md @@ -145,9 +145,19 @@ Get the time unit of duration. `inverse(annotated=False)` -Invert this gate. +Invert this gate as: $r(θ, φ)^dagger = r(-θ, φ)$ -r(θ, φ)^dagger = r(-θ, φ) +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[RGate](#qiskit.circuit.library.RGate "qiskit.circuit.library.RGate") ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.md index 84c0bbf4422..585ecde13a2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RXGate.md @@ -150,8 +150,8 @@ Return a (multi-)controlled-RX gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -172,6 +172,18 @@ Return inverted RX gate. $RX(\lambda)^{\dagger} = RX(-\lambda)$ +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[RXGate](#qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.md index 3224e3f4b4b..004fb185ea8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RXXGate.md @@ -173,6 +173,18 @@ Get the time unit of duration. Return inverse RXX gate (i.e. with the negative rotation angle). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[RXXGate](#qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.md index a8ddf5b5d09..a9d552c2f3c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RYGate.md @@ -150,8 +150,8 @@ Return a (multi-)controlled-RY gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -168,10 +168,22 @@ controlled version of this gate. `inverse(annotated=False)` -Return inverted RY gate. +Return inverse RY gate. $RY(\lambda)^{\dagger} = RY(-\lambda)$ +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[RYGate](#qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.md index 288479b6ea8..14f14e7b54a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RYYGate.md @@ -173,6 +173,18 @@ Get the time unit of duration. Return inverse RYY gate (i.e. with the negative rotation angle). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[RYYGate](#qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.md index 3b725d0a60e..0119d9e5d2e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.md @@ -160,8 +160,8 @@ Return a (multi-)controlled-RZ gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -182,6 +182,18 @@ Return inverted RZ gate $RZ(\lambda)^{\dagger} = RZ(-\lambda)$ +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[RZGate](#qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.md index 1d2680c79cc..64802022c54 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZXGate.md @@ -213,6 +213,18 @@ Get the time unit of duration. Return inverse RZX gate (i.e. with the negative rotation angle). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – + +**when set to `True`, this is typically used to return an** + +`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 [`RZXGate`](#qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate") with an inverted parameter value. + +**Returns:** + +RZXGate: inverse gate. + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.md index 912e07ddad2..6f3c7993b8f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZZGate.md @@ -185,6 +185,18 @@ Get the time unit of duration. Return inverse RZZ gate (i.e. with the negative rotation angle). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[RZZGate](#qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.md index b4776cf5ded..13bfb184b14 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.md @@ -197,7 +197,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 417` +`= 304` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.SGate.md index 1a324dceff8..1f23c832d19 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SGate.md @@ -150,6 +150,18 @@ Get the time unit of duration. Return inverse of S (SdgGate). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse of [`SGate`](#qiskit.circuit.library.SGate "qiskit.circuit.library.SGate") + +**Return type** + +[SdgGate](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.md index 872669ccf4a..aea17039151 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SXGate.md @@ -161,8 +161,8 @@ One control returns a CSX gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -181,3 +181,15 @@ controlled version of this gate. Return inverse SX gate (i.e. SXdg). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse of [`SXGate`](#qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). + +**Return type** + +[SXdgGate](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.md index d148c5898b7..484f05a02ab 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SXdgGate.md @@ -146,3 +146,15 @@ Get the time unit of duration. Return inverse SXdg gate (i.e. SX). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse of [`SXdgGate`](#qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate") + +**Return type** + +[SXGate](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.md index c0f75045dff..547fa331832 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.md @@ -150,6 +150,18 @@ Get the time unit of duration. Return inverse of Sdg (SGate). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse of [`SdgGate`](#qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate") + +**Return type** + +[SGate](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.md index 72b62d30be4..6ef613050dc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SwapGate.md @@ -160,8 +160,8 @@ One control returns a CSWAP (Fredkin) gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -180,3 +180,15 @@ controlled version of this gate. Return inverse Swap gate (itself). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[SwapGate](#qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.TGate.md index e1cbd8f6f8c..2b62d1203af 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TGate.md @@ -150,6 +150,18 @@ Get the time unit of duration. Return inverse T gate (i.e. Tdg). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse of [`TGate`](#qiskit.circuit.library.TGate "qiskit.circuit.library.TGate") + +**Return type** + +[TdgGate](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.md index e765fce1ad7..a66b0d76dd1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TdgGate.md @@ -150,6 +150,18 @@ Get the time unit of duration. Return inverse Tdg gate (i.e. T). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse of [`TdgGate`](#qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate") + +**Return type** + +[TGate](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.md index 5b42ad8b4cf..17a30fdcff8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.md @@ -209,7 +209,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 417` +`= 304` @@ -399,5 +399,5 @@ Overloading to handle the special case of 1 qubit where the entanglement are ign **Return type** -[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.12)")\[[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.12)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")]] +Sequence\[Sequence\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")]] diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.md index d826bdf928a..5aae9626ccd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U1Gate.md @@ -187,8 +187,8 @@ Return a (multi-)controlled-U1 gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -205,5 +205,17 @@ controlled version of this gate. `inverse(annotated=False)` -Return inverted U1 gate ($U1(\lambda)^{\dagger} = U1(-\lambda)$) +Return inverted U1 gate ($U1(\lambda)^{\dagger} = U1(-\lambda))$ + +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[U1Gate](#qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.md index 76760639f6e..72376533e36 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U2Gate.md @@ -183,5 +183,17 @@ Get the time unit of duration. Return inverted U2 gate. -$U2(\phi, \lambda)^{\dagger} =U2(-\lambda-\pi, -\phi+\pi)$) +$U2(\phi, \lambda)^{\dagger} =U2(-\lambda-\pi, -\phi+\pi))$ + +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[U2Gate](#qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.md index 018d2710f18..979ecfb22ce 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.U3Gate.md @@ -181,8 +181,8 @@ Return a (multi-)controlled-U3 gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -201,5 +201,17 @@ controlled version of this gate. Return inverted U3 gate. -$U3(\theta,\phi,\lambda)^{\dagger} =U3(-\theta,-\lambda,-\phi)$) +$U3(\theta,\phi,\lambda)^{\dagger} =U3(-\theta,-\lambda,-\phi))$ + +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[U3Gate](#qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.UGate.md index f2892af8b4a..3acf68457ae 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UGate.md @@ -164,8 +164,8 @@ Return a (multi-)controlled-U gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -184,5 +184,17 @@ controlled version of this gate. Return inverted U gate. -$U(\theta,\phi,\lambda)^{\dagger} =U(-\theta,-\lambda,-\phi)$) +$U(\theta,\phi,\lambda)^{\dagger} =U(-\theta,-\lambda,-\phi))$ + +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[UGate](#qiskit.circuit.library.UGate "qiskit.circuit.library.UGate") diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.md index b787ab21e24..9497dc9873d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.md @@ -39,7 +39,7 @@ Create a gate from a numeric unitary matrix. **Parameters** * **data** ([*numpy.ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v1.26)") *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| BaseOperator*) – Unitary operator. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – Unitary name for backend \[Default: None]. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – Unitary name for backend \[Default: `None`]. * **check\_input** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – 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. **Raises** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.md b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.md index 9af5f9e57f6..97950ee33f4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.md @@ -109,7 +109,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 158` +`= 304` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.md index bdad31175c9..9915bacf142 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.md @@ -98,7 +98,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 158` +`= 304` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.md index 206d945ef93..9738e71aee4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.md @@ -101,7 +101,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 158` +`= 304` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.XGate.md index 438de48475a..681603d2c98 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XGate.md @@ -170,8 +170,8 @@ One control returns a CX gate. Two controls returns a CCX gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -190,3 +190,15 @@ controlled version of this gate. Return inverted X gate (itself). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[XGate](#qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.md b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.md index 066485ebb62..ea2dc4f39e4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.md @@ -82,7 +82,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 160` +`= 306` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.md index 80b6a31330b..6ae2b88aa35 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XXMinusYYGate.md @@ -183,6 +183,18 @@ Get the time unit of duration. Inverse gate. +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[XXMinusYYGate](#qiskit.circuit.library.XXMinusYYGate "qiskit.circuit.library.XXMinusYYGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.md index 59ac6166aa2..e775c88745e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XXPlusYYGate.md @@ -183,6 +183,18 @@ Get the time unit of duration. Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate. + +**Return type** + +[XXPlusYYGate](#qiskit.circuit.library.XXPlusYYGate "qiskit.circuit.library.XXPlusYYGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.YGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.YGate.md index d44e7c1dba1..9f235042841 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.YGate.md @@ -170,8 +170,8 @@ One control returns a CY gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -190,3 +190,15 @@ controlled version of this gate. Return inverted Y gate ($Y^{\dagger} = Y$) +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[YGate](#qiskit.circuit.library.YGate "qiskit.circuit.library.YGate") + diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.md index 175ab98b4d4..c940fb9aa48 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.md @@ -175,7 +175,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 162` +`= 308` diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.md index 04ad1fa008c..2a7bb6a52d6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZGate.md @@ -170,8 +170,8 @@ One control returns a CZ gate. **Parameters** * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of control qubits. -* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – An optional label for the gate \[Default: None] -* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. +* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – An optional label for the gate \[Default: `None`] +* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| 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.12)")) – indicates whether the controlled gate can be implemented as an annotated gate. **Returns** @@ -190,6 +190,18 @@ controlled version of this gate. Return inverted Z gate (itself). +**Parameters** + +**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – when set to `True`, this is typically used to return an `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** + +inverse gate (self-inverse). + +**Return type** + +[ZGate](#qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate") + ### power diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.md index 63294273c2e..e62c51bcba3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.md @@ -180,7 +180,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 162` +`= 308` diff --git a/docs/api/qiskit/dev/qiskit.passmanager.BaseController.md b/docs/api/qiskit/dev/qiskit.passmanager.BaseController.md index 8f6f3a1dd24..4e0308c38ef 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.BaseController.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.BaseController.md @@ -36,9 +36,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -46,7 +46,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### iter\_tasks @@ -60,7 +60,7 @@ Controller subclass can consume the state to build a proper task pipeline. The u **Parameters** -* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – The state of the passmanager workflow at the beginning of this flow controller’s execution. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – The state of the passmanager workflow at the beginning of this flow controller’s execution. * **state** – the state of pass manager after the execution of the last task that was yielded. The generator does not need to inspect this if it is irrelevant to its logic, nor update it. **Yields** @@ -69,5 +69,5 @@ Controller subclass can consume the state to build a proper task pipeline. The u **Return type** -[*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] +Generator\[Task, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState"), None] diff --git a/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.md b/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.md index e1fd1b7a2e5..ad4ad770b1d 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.md @@ -42,9 +42,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### iter\_tasks @@ -66,7 +66,7 @@ Controller subclass can consume the state to build a proper task pipeline. The u **Parameters** -* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – The state of the passmanager workflow at the beginning of this flow controller’s execution. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – The state of the passmanager workflow at the beginning of this flow controller’s execution. * **state** – the state of pass manager after the execution of the last task that was yielded. The generator does not need to inspect this if it is irrelevant to its logic, nor update it. **Yields** @@ -75,5 +75,5 @@ Controller subclass can consume the state to build a proper task pipeline. The u **Return type** -[*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] +Generator\[Task, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState"), None] diff --git a/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.md b/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.md index cae471ec512..a8cb9671eff 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.md @@ -44,9 +44,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -54,7 +54,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### iter\_tasks @@ -68,7 +68,7 @@ Controller subclass can consume the state to build a proper task pipeline. The u **Parameters** -* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – The state of the passmanager workflow at the beginning of this flow controller’s execution. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – The state of the passmanager workflow at the beginning of this flow controller’s execution. * **state** – the state of pass manager after the execution of the last task that was yielded. The generator does not need to inspect this if it is irrelevant to its logic, nor update it. **Yields** @@ -77,5 +77,5 @@ Controller subclass can consume the state to build a proper task pipeline. The u **Return type** -[*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] +Generator\[Task, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState"), None] diff --git a/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.md b/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.md index c7580928927..fd8fb0095b1 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.md @@ -42,9 +42,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### iter\_tasks @@ -66,7 +66,7 @@ Controller subclass can consume the state to build a proper task pipeline. The u **Parameters** -* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")) – The state of the passmanager workflow at the beginning of this flow controller’s execution. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – The state of the passmanager workflow at the beginning of this flow controller’s execution. * **state** – the state of pass manager after the execution of the last task that was yielded. The generator does not need to inspect this if it is irrelevant to its logic, nor update it. **Yields** @@ -75,5 +75,5 @@ Controller subclass can consume the state to build a proper task pipeline. The u **Return type** -[*Generator*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)")\[*Task*, [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState"), None] +Generator\[Task, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState"), None] diff --git a/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.md b/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.md index b268b18ad26..a47de29c7ce 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.md @@ -30,9 +30,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,7 +40,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.md b/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.md index 54af3ff4e2c..21e7762b8ea 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.md +++ b/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.md @@ -64,7 +64,7 @@ Return the value for key if key is in the dictionary, else default. `pop(k[, d]) → v, remove specified key and return the corresponding value.` -If key is not found, default is returned if given, otherwise KeyError is raised +If key is not found, d is returned if given, otherwise KeyError is raised ### popitem diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.md index dcf622da9f9..9dc13b04ab0 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimator.md @@ -22,11 +22,11 @@ Initialize a new BackendEstimator instance **Parameters** -* **backend** ([*BackendV1*](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") *|*[*BackendV2*](qiskit.providers.BackendV2 "qiskit.providers.BackendV2")) – Required: the backend to run the primitive on -* **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") *| None*) – Default options. -* **abelian\_grouping** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Whether the observable should be grouped into commuting -* **bound\_pass\_manager** ([*PassManager*](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") *| None*) – An optional pass manager to run after parameter binding. -* **skip\_transpilation** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If this is set to True the internal compilation of the input circuits is skipped and the circuit objects will be directly executed when this object is called. +* **backend** – Required: the backend to run the primitive on +* **options** – Default options. +* **abelian\_grouping** – Whether the observable should be grouped into commuting +* **bound\_pass\_manager** – An optional pass manager to run after parameter binding. +* **skip\_transpilation** – If this is set to True the internal compilation of the input circuits is skipped and the circuit objects will be directly executed when this object is called. ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.md index c949da27688..807e3f1ac6d 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendSampler.md @@ -22,10 +22,10 @@ Initialize a new BackendSampler **Parameters** -* **backend** ([*BackendV1*](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") *|*[*BackendV2*](qiskit.providers.BackendV2 "qiskit.providers.BackendV2")) – Required: the backend to run the sampler primitive on -* **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") *| None*) – Default options. -* **bound\_pass\_manager** ([*PassManager*](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") *| None*) – An optional pass manager to run after parameter binding. -* **skip\_transpilation** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If this is set to True the internal compilation of the input circuits is skipped and the circuit objects will be directly executed when this objected is called. +* **backend** – Required: the backend to run the sampler primitive on +* **options** – Default options. +* **bound\_pass\_manager** – An optional pass manager to run after parameter binding. +* **skip\_transpilation** – If this is set to True the internal compilation of the input circuits is skipped and the circuit objects will be directly executed when this objected is called. **Raises** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.md b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.md new file mode 100644 index 00000000000..80961a152e5 --- /dev/null +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.md @@ -0,0 +1,45 @@ +--- +title: BaseEstimatorV2 +description: API reference for qiskit.primitives.BaseEstimatorV2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.primitives.BaseEstimatorV2 +--- + +# BaseEstimatorV2 + + + +`qiskit.primitives.BaseEstimatorV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/base/base_estimator.py "view source code") + +Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") + +Estimator base class version 2. + +An estimator estimates expectation values for provided quantum circuit and observable combinations. + +An Estimator implementation must treat the [`run()`](#qiskit.primitives.BaseEstimatorV2.run "qiskit.primitives.BaseEstimatorV2.run") method `precision=None` kwarg as using a default `precision` value. The default value and methods to set it can be determined by the Estimator implementor. + +## Methods + +### run + + + +`abstract run(pubs, *, precision=None)` + +Estimate expectation values for each provided pub (Primitive Unified Bloc). + +**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.12)") *| 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** + +A job object that contains results. + +**Return type** + +BasePrimitiveJob\[[PrimitiveResult](qiskit.primitives.PrimitiveResult "qiskit.primitives.PrimitiveResult")\[[PubResult](qiskit.primitives.PubResult "qiskit.primitives.PubResult")]] + diff --git a/docs/api/qiskit/dev/qiskit.primitives.Estimator.md b/docs/api/qiskit/dev/qiskit.primitives.Estimator.md index 0cd24f9bdd6..752b4b6e440 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/dev/qiskit.primitives.Estimator.md @@ -23,7 +23,7 @@ Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator#qi **Parameters** -**options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") *| None*) – Default options. +**options** – Default options. **Raises** diff --git a/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.md b/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.md index 4379f0fa39e..476ac20f63a 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.md +++ b/docs/api/qiskit/dev/qiskit.primitives.PrimitiveResult.md @@ -18,8 +18,8 @@ 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.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, 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. +* **pub\_results** – Pub results. +* **metadata** – 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/dev/qiskit.primitives.Sampler.md b/docs/api/qiskit/dev/qiskit.primitives.Sampler.md index c36fd004e85..112db62ee7e 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/dev/qiskit.primitives.Sampler.md @@ -25,7 +25,7 @@ Sampler class. **Parameters** -**options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") *| None*) – Default options. +**options** – Default options. **Raises** diff --git a/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.md index 5374a2b1c63..c650b1d161b 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.md @@ -33,7 +33,7 @@ where the i-th elements of `result` correspond to the circuit given by `circuits ### quasi\_dists -`list[qiskit.result.distributions.quasi.QuasiDistribution]` +`list[QuasiDistribution]` diff --git a/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.md b/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.md index bbd39b86d76..1fc1ff24f88 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.md +++ b/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.md @@ -12,9 +12,9 @@ python_api_name: qiskit.primitives.StatevectorEstimator `qiskit.primitives.StatevectorEstimator(*, default_precision=0.0, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/primitives/statevector_estimator.py "view source code") -Bases: `BaseEstimatorV2` +Bases: [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.base.base_estimator.BaseEstimatorV2") -Simple implementation of `BaseEstimatorV2` with full state vector simulation. +Simple implementation of [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2") with full state vector simulation. This class is implemented via [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") which turns provided circuits into pure state vectors. These states are subsequently acted on by :class:\~.SparsePauliOp\`, which implies that, at present, this implementation is only compatible with Pauli-based observables. diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.md b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.md index 26135176907..335ea09d7b9 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.md +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.md @@ -363,7 +363,7 @@ Run an experiment (circuit) and return a single experiment result. **Parameters** -**experiment** ([*QasmQobjExperiment*](qiskit.qobj.QasmQobjExperiment "qiskit.qobj.qasm_qobj.QasmQobjExperiment")) – experiment from qobj experiments list +**experiment** ([*QasmQobjExperiment*](qiskit.qobj.QasmQobjExperiment "qiskit.qobj.QasmQobjExperiment")) – experiment from qobj experiments list **Returns** diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.md index 11538dc0d01..72354569ae9 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake127QPulseV1.md @@ -57,7 +57,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends_v1/fake_127q_pulse'` +`= '/home/vsts/work/1/s/.tox/docs/lib/python3.8/site-packages/qiskit/providers/fake_provider/backends_v1/fake_127q_pulse'` diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.md index c9044bef1ee..82bebc8c435 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake20QV1.md @@ -57,7 +57,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends_v1/fake_20q'` +`= '/home/vsts/work/1/s/.tox/docs/lib/python3.8/site-packages/qiskit/providers/fake_provider/backends_v1/fake_20q'` diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.md index 0c2ca85d595..3705c503212 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake27QPulseV1.md @@ -69,7 +69,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends_v1/fake_27q_pulse'` +`= '/home/vsts/work/1/s/.tox/docs/lib/python3.8/site-packages/qiskit/providers/fake_provider/backends_v1/fake_27q_pulse'` diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.md index d5892edf2e9..3aaa9156d8a 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake5QV1.md @@ -55,7 +55,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends_v1/fake_5q'` +`= '/home/vsts/work/1/s/.tox/docs/lib/python3.8/site-packages/qiskit/providers/fake_provider/backends_v1/fake_5q'` diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.md index 321b1a7898c..363ed77e7ea 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.Fake7QPulseV1.md @@ -63,7 +63,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends_v1/fake_7q_pulse'` +`= '/home/vsts/work/1/s/.tox/docs/lib/python3.8/site-packages/qiskit/providers/fake_provider/backends_v1/fake_7q_pulse'` diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.md b/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.md index 73f3fe291b9..8e41da45639 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.md +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.md @@ -219,7 +219,7 @@ This is required to be implemented if the backend supports Pulse scheduling. **Parameters** -**qubits** ([*Iterable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. +**qubits** (*Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – Tuple or list of qubits of the form `(control_qubit, target_qubit)`. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.pulse.Schedule.md b/docs/api/qiskit/dev/qiskit.pulse.Schedule.md index 4cbf0bbe18a..3e91f39defb 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/dev/qiskit.pulse.Schedule.md @@ -186,7 +186,7 @@ Assign the parameters in this schedule according to the input. **Parameters** -* **value\_dict** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")*\[*[*qiskit.circuit.parameterexpression.ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")*,* [*Union*](https://docs.python.org/3/library/typing.html#typing.Union "(in Python v3.12)")*\[*[*qiskit.circuit.parameterexpression.ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")*]]*) – A mapping from Parameters to either numeric values or another Parameter expression. +* **value\_dict** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")*\[*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*, ParameterValueType]*) – A mapping from Parameters to either numeric values or another Parameter expression. * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Set `True` to override this instance with new parameter. **Returns** @@ -195,7 +195,7 @@ Schedule with updated parameters. **Return type** -[*Schedule*](#qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule") +[Schedule](#qiskit.pulse.Schedule "qiskit.pulse.Schedule") ### ch\_duration @@ -359,7 +359,7 @@ Parameter objects that have corresponding name. **Return type** -[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[[qiskit.circuit.parameter.Parameter](qiskit.circuit.Parameter "qiskit.circuit.parameter.Parameter")] +[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[[Parameter](qiskit.circuit.Parameter "qiskit.circuit.Parameter")] ### initialize\_from @@ -462,8 +462,8 @@ Only matches at the top-level of the schedule tree. If you wish to perform this **Parameters** -* **old** ([*Schedule*](#qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule") *|*[*Instruction*](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction")) – Instruction to replace. -* **new** ([*Schedule*](#qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule") *|*[*Instruction*](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction")) – Instruction to replace with. +* **old** (*ScheduleComponent*) – Instruction to replace. +* **new** (*ScheduleComponent*) – Instruction to replace with. * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Replace instruction by mutably modifying this `Schedule`. **Returns** @@ -476,7 +476,7 @@ The modified schedule with `old` replaced by `new`. **Return type** -[*Schedule*](#qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule") +[Schedule](#qiskit.pulse.Schedule "qiskit.pulse.Schedule") ### shift diff --git a/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.md index 02275103158..beafa210c31 100644 --- a/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/dev/qiskit.pulse.ScheduleBlock.md @@ -241,7 +241,7 @@ Assign the parameters in this schedule according to the input. **Parameters** -* **value\_dict** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")*\[*[*qiskit.circuit.parameterexpression.ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")*,* [*Union*](https://docs.python.org/3/library/typing.html#typing.Union "(in Python v3.12)")*\[*[*qiskit.circuit.parameterexpression.ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")*,* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")*]]*) – A mapping from Parameters to either numeric values or another Parameter expression. +* **value\_dict** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")*\[*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*, ParameterValueType]*) – A mapping from Parameters to either numeric values or another Parameter expression. * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Set `True` to override this instance with new parameter. **Returns** @@ -254,7 +254,7 @@ Schedule with updated parameters. **Return type** -[*ScheduleBlock*](#qiskit.pulse.ScheduleBlock "qiskit.pulse.schedule.ScheduleBlock") +[ScheduleBlock](#qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") ### assign\_references @@ -468,7 +468,7 @@ Parameter objects that have corresponding name. **Return type** -[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[[qiskit.circuit.parameter.Parameter](qiskit.circuit.Parameter "qiskit.circuit.parameter.Parameter")] +[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")\[[Parameter](qiskit.circuit.Parameter "qiskit.circuit.Parameter")] ### initialize\_from @@ -541,8 +541,8 @@ Return a `ScheduleBlock` with the `old` component replaced with a `new` componen **Parameters** -* **old** ([*ScheduleBlock*](#qiskit.pulse.ScheduleBlock "qiskit.pulse.schedule.ScheduleBlock") *|*[*Instruction*](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction")) – Schedule block component to replace. -* **new** ([*ScheduleBlock*](#qiskit.pulse.ScheduleBlock "qiskit.pulse.schedule.ScheduleBlock") *|*[*Instruction*](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction")) – Schedule block component to replace with. +* **old** (*BlockComponent*) – Schedule block component to replace. +* **new** (*BlockComponent*) – Schedule block component to replace with. * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Replace instruction by mutably modifying this `ScheduleBlock`. **Returns** @@ -551,5 +551,5 @@ The modified schedule block with `old` replaced by `new`. **Return type** -[*ScheduleBlock*](#qiskit.pulse.ScheduleBlock "qiskit.pulse.schedule.ScheduleBlock") +[ScheduleBlock](#qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.md b/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.md index f04e39b68fe..13f0797ad41 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.md +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.md @@ -160,7 +160,7 @@ The second step of the reduction consists in replacing these qubits with the pos **Parameters** -**operator** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp")) – The to-be-tapered operator. +**operator** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")) – The to-be-tapered operator. **Returns** @@ -180,7 +180,7 @@ Operate the second part of the tapering. This function assumes that the input op **Parameters** -**operator** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp")) – Partially tapered operator resulting from a call to [`convert_clifford()`](#qiskit.quantum_info.Z2Symmetries.convert_clifford "qiskit.quantum_info.Z2Symmetries.convert_clifford"). +**operator** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")) – Partially tapered operator resulting from a call to [`convert_clifford()`](#qiskit.quantum_info.Z2Symmetries.convert_clifford "qiskit.quantum_info.Z2Symmetries.convert_clifford"). **Returns** diff --git a/docs/api/qiskit/dev/qiskit.result.Counts.md b/docs/api/qiskit/dev/qiskit.result.Counts.md index 2c77bcc75f9..8305598304c 100644 --- a/docs/api/qiskit/dev/qiskit.result.Counts.md +++ b/docs/api/qiskit/dev/qiskit.result.Counts.md @@ -158,7 +158,7 @@ The bit string for the most frequent result `pop(k[, d]) → v, remove specified key and return the corresponding value.` -If key is not found, default is returned if given, otherwise KeyError is raised +If key is not found, d is returned if given, otherwise KeyError is raised ### popitem diff --git a/docs/api/qiskit/dev/qiskit.result.ProbDistribution.md b/docs/api/qiskit/dev/qiskit.result.ProbDistribution.md index f52c88a33fb..30a68da52e1 100644 --- a/docs/api/qiskit/dev/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/dev/qiskit.result.ProbDistribution.md @@ -123,7 +123,7 @@ format `"0x1a"` `pop(k[, d]) → v, remove specified key and return the corresponding value.` -If key is not found, default is returned if given, otherwise KeyError is raised +If key is not found, d is returned if given, otherwise KeyError is raised ### popitem diff --git a/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.md index 433559a3999..eb2a4da06c4 100644 --- a/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.md @@ -161,7 +161,7 @@ Method from Smolin et al., Phys. Rev. Lett. 108, 070502 (2012). `pop(k[, d]) → v, remove specified key and return the corresponding value.` -If key is not found, default is returned if given, otherwise KeyError is raised +If key is not found, d is returned if given, otherwise KeyError is raised ### popitem diff --git a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.md b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.md index 386417c38d5..6524a09935e 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitBasisDecomposer.md @@ -31,7 +31,13 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub `static decomp0(target)` -Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases +Decompose target $~Ud(x, y, z)$ with 0 uses of the basis gate. Result $Ur$ has trace: + +$$ +|Tr(Ur.U_{target}^{\dag})| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)| +$$ + +which is optimal for all targets and bases ### decomp1 @@ -39,11 +45,11 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac `decomp1(target)` -Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: +Decompose target $~Ud(x, y, z)$ with 1 uses of the basis gate $~Ud(a, b, c)$. Result $Ur$ has trace: -```python -|Tr(Ur.Utarget^dag)| = 4|cos(x-a)cos(y-b)cos(z-c) + j sin(x-a)sin(y-b)sin(z-c)| -``` +$$ +|Tr(Ur.U_{target}^{\dag})| = 4|cos(x-a)cos(y-b)cos(z-c) + j sin(x-a)sin(y-b)sin(z-c)| +$$ which is optimal for all targets and bases with z==0 or c==0 @@ -53,15 +59,15 @@ which is optimal for all targets and bases with z==0 or c==0 `decomp2_supercontrolled(target)` -Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. +Decompose target $~Ud(x, y, z)$ with 2 uses of the basis gate. -For supercontrolled basis \~Ud(pi/4, b, 0), all b, result Ur has trace .. math: +For supercontrolled basis $~Ud(\pi/4, b, 0)$, all b, result $Ur$ has trace -```python -|Tr(Ur.Utarget^dag)| = 4cos(z) -``` +$$ +|Tr(Ur.U_{target}^{\dag})| = 4cos(z) +$$ -which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or DCNOT-class `~Ud(pi/4, pi/4, 0)` and any target. May be sub-optimal for b!=0 (e.g. there exists exact decomposition for any target using B `B~Ud(pi/4, pi/8, 0)`, but not this decomposition.) This is an exact decomposition for supercontrolled basis and target `~Ud(x, y, 0)`. No guarantees for non-supercontrolled basis. +which is the optimal approximation for basis of CNOT-class $~Ud(\pi/4, 0, 0)$ or DCNOT-class $~Ud(\pi/4, \pi/4, 0)$ and any target. May be sub-optimal for b!=0 (e.g. there exists exact decomposition for any target using B $B \sim Ud(\pi/4, \pi/8, 0)$, but not this decomposition.) This is an exact decomposition for supercontrolled basis and target $~Ud(x, y, 0)$. No guarantees for non-supercontrolled basis. ### decomp3\_supercontrolled @@ -69,7 +75,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or `decomp3_supercontrolled(target)` -Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. +Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis $~Ud(\pi/4, b, 0)$, all b, and any target. No guarantees for non-supercontrolled basis. ### num\_basis\_gates @@ -85,5 +91,5 @@ Computes the number of basis gates needed in a decomposition of input unitary `traces(target)` -Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. +Give the expected traces $|Tr(U \cdot U_{target}^{\dag})|$ for different number of basis gates. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.md b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.md index cf631d9f947..c0d46153055 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.md +++ b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.md @@ -19,7 +19,7 @@ Two-qubit Weyl decomposition. Decompose two-qubit unitary $$ -U = ({K_1}^l \otimes {K_1}^r) \dot e^{(i a XX + i b YY + i c ZZ)} \dot ({K_2}^l \otimes {K_2}^r) +U = ({K_1}^l \otimes {K_1}^r) e^{(i a XX + i b YY + i c ZZ)} ({K_2}^l \otimes {K_2}^r) $$ where @@ -39,18 +39,14 @@ This is an abstract factory class that instantiates itself as specialized subcla Passing non-None fidelity to specializations is treated as an assertion, raising QiskitError if forcing the specialization is more approximate than asserted. -**Reference:** +**References** 1. Cross, A. W., Bishop, L. S., Sheldon, S., Nation, P. D. & Gambetta, J. M., *Validating quantum computers using randomized model circuits*, [arXiv:1811.12926 \[quant-ph\]](https://arxiv.org/abs/1811.12926) +2. B. Kraus, J. I. Cirac, *Optimal Creation of Entanglement Using a Two-Qubit Gate*, [arXiv:0011050 \[quant-ph\]](https://arxiv.org/abs/quant-ph/0011050) +3. B. Drury, P. J. Love, *Constructive Quantum Shannon Decomposition from Cartan Involutions*, [arXiv:0806.4015 \[quant-ph\]](https://arxiv.org/abs/0806.4015) Perform the Weyl chamber decomposition, and optionally choose a specialized subclass. -The flip into the Weyl Chamber is described in B. Kraus and J. I. Cirac, Phys. Rev. A 63, 062309 (2001). - -FIXME: There’s a cleaner-seeming method based on choosing branch cuts carefully, in Andrew M. Childs, Henry L. Haselgrove, and Michael A. Nielsen, Phys. Rev. A 68, 052311, but I wasn’t able to get that to work. - -The overall decomposition scheme is taken from Drury and Love, arXiv:0806.4015 \[quant-ph]. - ## Attributes @@ -127,7 +123,7 @@ The overall decomposition scheme is taken from Drury and Love, arXiv:0806.4015 \ `actual_fidelity(**kwargs)` -Calculates the actual fidelity of the decomposed circuit to the input unitary +Calculates the actual fidelity of the decomposed circuit to the input unitary. **Return type** @@ -141,8 +137,6 @@ Calculates the actual fidelity of the decomposed circuit to the input unitary Returns Weyl decomposition in circuit form. -simplify, atol arguments are passed to OneQubitEulerDecomposer - **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") @@ -153,11 +147,11 @@ simplify, atol arguments are passed to OneQubitEulerDecomposer `classmethod from_bytes(bytes_in, *, requested_fidelity, **kwargs)` -Decode bytes into TwoQubitWeylDecomposition. Used by \_\_repr\_\_ +Decode bytes into [`TwoQubitWeylDecomposition`](#qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition"). **Return type** -[*TwoQubitWeylDecomposition*](#qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.two_qubit.two_qubit_decompose.TwoQubitWeylDecomposition") +[TwoQubitWeylDecomposition](#qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition") ### specialize @@ -167,5 +161,3 @@ Decode bytes into TwoQubitWeylDecomposition. Used by \_\_repr\_\_ Make changes to the decomposition to comply with any specialization. -Do update a, b, c, k1l, k1r, k2l, k2r, \_is\_flipped\_from\_original to round to the specialization. Do not update the global phase, since this gets done in generic \_\_init\_\_() - diff --git a/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.md index d672b97b949..b1510776152 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.md @@ -46,9 +46,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -56,7 +56,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.md index 8c0fc35e4b4..38e9a7f3e34 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.md @@ -46,9 +46,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -56,7 +56,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.md index be16f37045c..e08e66c4ad2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPSchedule.md @@ -58,9 +58,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -68,7 +68,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index 90970877ba3..d2a4030bea6 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -61,9 +61,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -71,7 +71,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.md index 0b8d786aec3..b6d060213ee 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPSchedule.md @@ -62,9 +62,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -72,7 +72,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index d1fcc8d7188..8a0f8f596aa 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -61,9 +61,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -71,7 +71,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.md index 17b96d66361..bbb1b963973 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.AlignMeasures.md @@ -94,9 +94,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -104,7 +104,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.md index 5f08b0102dd..37d147136d4 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.md @@ -50,9 +50,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -60,7 +60,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 7f750c60e42..439d97b8d97 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -48,9 +48,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.md index 19ccc712ee6..efe5ea224c7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.md @@ -55,9 +55,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -65,7 +65,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.md index c1737607a96..657e87ed495 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.md @@ -101,9 +101,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -111,7 +111,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.md index 9fade7ddeaa..1ae663ec7f9 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.md @@ -63,9 +63,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -73,7 +73,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.md index b0c5c29a242..522c09b5ea4 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CXCancellation.md @@ -46,9 +46,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -56,7 +56,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.md index 350216bc44b..bbd7379373c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.md @@ -53,9 +53,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.md index b6cb5391297..61fdacce800 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.md @@ -55,9 +55,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -65,7 +65,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.md index 106a5d40813..4840f061afc 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.md @@ -46,9 +46,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -56,7 +56,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.md index 374c37759ff..924329c86fe 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.md @@ -46,9 +46,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -56,7 +56,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.md index c6f951fd3fb..617360f7223 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.md @@ -56,9 +56,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -66,7 +66,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.md index 5be507ab471..44b40c6388d 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -56,9 +56,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -66,7 +66,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.md index 25cd909b146..e18b2ea6f51 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -56,9 +56,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -66,7 +66,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### find\_set diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.md index 54fde584d52..6b316e7f078 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.md @@ -48,9 +48,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.md index d930a4dbbaf..6034a58fc27 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.md @@ -59,9 +59,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -69,7 +69,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.md index 3f0e92e9f14..2bf137a8b9f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -51,9 +51,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -61,7 +61,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.md index c81aba323c3..3610af2423e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -108,9 +108,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -118,7 +118,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.md index 6d532cf16ee..586ea5d2aae 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -64,9 +64,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -74,7 +74,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.md index def0cc4c098..ad4dde427c7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -83,9 +83,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -93,7 +93,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.md index 607a6e07b17..7ad2a5c754e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.md @@ -55,9 +55,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -65,7 +65,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 68ae069757c..10307630c1e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -48,9 +48,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.md index fe3dc3181bc..4a21f4779ac 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.md @@ -48,9 +48,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.md index e270eaa1c50..80381013978 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -48,9 +48,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.md index 6bdc5bdf722..bb1bfcf4b73 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.md @@ -48,9 +48,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.md index 326c6b0613e..3c0e5edc30d 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.md @@ -46,9 +46,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -56,7 +56,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.md index e0fae7defe5..b4c382bc5bb 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.md @@ -52,9 +52,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.md index f2df77cebe8..b97d191ff43 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.md @@ -60,9 +60,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -70,7 +70,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.md index c9c6bf60b2f..ed21c74a069 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.md @@ -50,9 +50,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -60,7 +60,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.md index 4c1b2bb006c..7ebfffa5265 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -129,9 +129,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -139,7 +139,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 55a88cc764c..6633e721590 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -55,9 +55,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -65,7 +65,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.md index 579caa49a91..37ea2c8135a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -48,9 +48,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.md index 46f57069719..bb3e9088c68 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.md @@ -73,9 +73,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -83,7 +83,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.md index cbc8052c92e..8450741c5d2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.md @@ -54,9 +54,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -64,7 +64,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.md index 7b525e611df..7c28a5956ad 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -58,9 +58,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -68,7 +68,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.md index c2815878364..60cd78b3a89 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.md @@ -80,9 +80,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -90,7 +90,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.md index 0d31f1a3360..33135bb80c2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.md @@ -53,9 +53,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.md index d64b7031aa3..377a903cffd 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -80,9 +80,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -90,7 +90,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.md index 53904bb29a6..1dfdad6937f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.md @@ -54,9 +54,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -64,7 +64,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.md index 2c819019cb5..082113bf1dc 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -59,9 +59,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -69,7 +69,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.md index 8aa08f464d2..60362b9111e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.md @@ -56,9 +56,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -66,7 +66,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.md index 6dcbd265813..dc00985d58e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.md @@ -55,9 +55,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -65,7 +65,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index c92e52cbfa7..9600bfe9443 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -46,9 +46,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -56,7 +56,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.md index 3a48373bb77..86684259778 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.md @@ -71,9 +71,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -81,7 +81,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.md index a4589195a26..b427e3b68ad 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -83,9 +83,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -93,7 +93,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.md index 04cf3a8916c..854cbad4945 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.md @@ -66,9 +66,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -76,7 +76,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.md index ca01e5895f8..32c064dbde8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.NormalizeRXAngle.md @@ -68,9 +68,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -78,7 +78,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.md index 0f8fb49b42e..5af7faf3e2f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.md @@ -48,9 +48,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.md index 1a429bd73de..6fd3559922a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.md @@ -68,9 +68,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -78,7 +78,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 43d848b630d..d4878e03e81 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -62,9 +62,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -72,7 +72,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index c531cc43a12..f0af77fbd44 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -58,9 +58,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -68,7 +68,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.md index a524de33de8..067901f9333 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.md @@ -61,9 +61,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -71,7 +71,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.md index 7c591080444..dec86df34db 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.md @@ -46,9 +46,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -56,7 +56,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.md index 3e374659cc8..1c7140671fe 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.md @@ -78,9 +78,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -88,7 +88,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 3b62b942fb4..3bbce93e5c8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -136,9 +136,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -146,7 +146,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.md index 78da1e5ad58..531fc3d42fd 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PulseGates.md @@ -65,9 +65,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -75,7 +75,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### get\_calibration diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.md index e950b4cd571..1017e988b8a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RXCalibrationBuilder.md @@ -96,9 +96,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -106,7 +106,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### get\_calibration diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 74a543d7bf0..9b627ac661c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -58,9 +58,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -68,7 +68,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### get\_calibration diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 56e5b9ac9f6..b9d27b0dce3 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -60,9 +60,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -70,7 +70,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### get\_calibration diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.md index 7d00810775a..1218f487218 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.md @@ -65,9 +65,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -75,7 +75,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 255e77c5228..57fa6a38edc 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -48,9 +48,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 8717987be94..34bd2a51364 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -50,9 +50,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -60,7 +60,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.md index c77826d3374..0bd23239bb3 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -46,9 +46,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -56,7 +56,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index 12275bba2ac..956181bfd79 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -48,9 +48,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.md index fb5ed8c539e..5a6b54b1fb3 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.md @@ -140,9 +140,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -150,7 +150,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.md index 74fbbf8dd03..4461d04eea5 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.md @@ -110,9 +110,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -120,7 +120,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.md index 07ac20eddc5..8586cc04fe2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.md @@ -106,9 +106,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -116,7 +116,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.md index 9167499a361..55f37857aa9 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.md @@ -57,9 +57,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -67,7 +67,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.md index daa527ea2d4..9890c34cd17 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.md @@ -59,9 +59,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -69,7 +69,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.md index 11a8f3506dc..5a73d9d60dc 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.md @@ -52,9 +52,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.md index 8e17a97e8a4..ce07dd8ab87 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.md @@ -135,9 +135,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -145,7 +145,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.md index 9b0b9f308b9..80f0a23b9dc 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.StochasticSwap.md @@ -67,9 +67,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -77,7 +77,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.md index ca91b0facec..ba41acf80ec 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.md @@ -53,9 +53,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.md index c78aaac7a71..b51a69f6757 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.md @@ -61,9 +61,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -71,7 +71,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.md index e8cd704d52f..ae2d525828c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -103,9 +103,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -113,7 +113,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.md index d89d5c0a6a1..809b0b85dfa 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.md @@ -62,9 +62,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -72,7 +72,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.md index dd2db82b466..74e5a004975 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.md @@ -68,9 +68,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -78,7 +78,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.md index 4c4f22673fd..fbf0c9679ce 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -53,9 +53,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 88cd56e7cc5..3c30f206d83 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -64,9 +64,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -74,7 +74,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.md index cd01b966493..fdc8e82f6e2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.md @@ -56,9 +56,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -66,7 +66,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.md index 96513a7470e..b3be79c3459 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.md @@ -82,9 +82,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -92,7 +92,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.md index 10a4185028c..7e2207e8d35 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.md @@ -85,9 +85,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -95,7 +95,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md index 20f77ea9da8..d7a33496b40 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ValidatePulseGates.md @@ -61,9 +61,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -71,7 +71,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.md index be7a948bfff..ed6c321ef61 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.md @@ -48,9 +48,9 @@ Execute optimization task for input Qiskit IR. **Parameters** -* **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – 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.12)") *| None*) – A callback function which is caller per execution of optimization task. +* **passmanager\_ir** (*PassManagerIR*) – Qiskit IR to optimize. +* **state** ([*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")) – State associated with workflow execution by the pass manager itself. +* **callback** (*Callable*) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ Optimized Qiskit IR and state of the workflow. **Return type** -[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [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.12)")\[PassManagerIR, [PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/synthesis.md b/docs/api/qiskit/dev/synthesis.md index 2ac0015cb18..29cc21d9fd5 100644 --- a/docs/api/qiskit/dev/synthesis.md +++ b/docs/api/qiskit/dev/synthesis.md @@ -790,3 +790,25 @@ The Approximate Quantum Compiler is available here: [`qiskit.synthesis.unitary.a | [`XXDecomposer`](qiskit.synthesis.XXDecomposer "qiskit.synthesis.XXDecomposer")(\[basis\_fidelity, euler\_basis, ...]) | 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). | | [`TwoQubitWeylDecomposition`](qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition")(unitary\_matrix, \*) | Two-qubit Weyl decomposition. | +### two\_qubit\_cnot\_decompose + + + +`qiskit.synthesis.two_qubit_cnot_decompose(*args, **kwargs)` + +This is an instance of [`TwoQubitBasisDecomposer`](qiskit.synthesis.TwoQubitBasisDecomposer "qiskit.synthesis.TwoQubitBasisDecomposer") that always uses `cx` as the KAK gate for the basis decomposition. You can use this function as a quick access to `cx`-based 2-qubit decompositions. + +**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.12)") *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.12)")) – If `True` approximate if `basis_fidelity` is less than 1.0. + +**Returns** + +The synthesized circuit of the input unitary. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + diff --git a/docs/api/qiskit/dev/transpiler_plugins.md b/docs/api/qiskit/dev/transpiler_plugins.md index 6b3886c19fe..500e9542cda 100644 --- a/docs/api/qiskit/dev/transpiler_plugins.md +++ b/docs/api/qiskit/dev/transpiler_plugins.md @@ -30,14 +30,14 @@ For details on how to instead write plugins for transpiler synthesis methods, se Currently, there are 6 stages in the preset pass managers, all of which actively load external plugins via corresponding entry points. -| Stage Name | Entry Point | Reserved Names | Description and expectations | -| -------------- | -------------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `init` | `qiskit.transpiler.init` | `default` | This stage runs first and is typically used for any initial logical optimization. Because most layout and routing algorithms are only designed to work with 1 and 2 qubit gates, this stage is also used to translate any gates that operate on more than 2 qubits into gates that only operate on 1 or 2 qubits. | -| `layout` | `qiskit.transpiler.layout` | `trivial`, `dense`, `sabre`, `default` | The output from this stage is expected to have the `layout` property set field set with a [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") object. Additionally, the circuit is typically expected to be embedded so that it is expanded to include all qubits and the [`ApplyLayout`](qiskit.transpiler.passes.ApplyLayout "qiskit.transpiler.passes.ApplyLayout") pass is expected to be run to apply the layout. The embedding of the [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") can be generated with [`generate_embed_passmanager()`](transpiler_preset#qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager "qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager"). | -| `routing` | `qiskit.transpiler.routing` | `basic`, `stochastic`, `lookahead`, `sabre`, `toqm` | The output from this stage is expected to have the circuit match the connectivity constraints of the target backend. This does not necessarily need to match the directionality of the edges in the target as a later stage typically will adjust directional gates to match that constraint (but there is no penalty for doing that in the `routing` stage). | -| `translation` | `qiskit.transpiler.translation` | `translator`, `synthesis`, `unroller` | **The output of this stage is expected to have every operation be a native**instruction on the target backend. | -| `optimization` | `qiskit.transpiler.optimization` | `default` | This stage is expected to perform optimization and simplification. The constraints from earlier stages still apply to the output of this stage. After the `optimization` stage is run we expect the circuit to still be executable on the target. | -| `scheduling` | `qiskit.transpiler.scheduling` | `alap`, `asap`, `default` | This is the last stage run and it is expected to output a scheduled circuit such that all idle periods in the circuit are marked by explicit [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay") instructions. | +| Stage Name | Entry Point | Reserved Names | Description and expectations | +| -------------- | -------------------------------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `init` | `qiskit.transpiler.init` | `default` | This stage runs first and is typically used for any initial logical optimization. Because most layout and routing algorithms are only designed to work with 1 and 2 qubit gates, this stage is also used to translate any gates that operate on more than 2 qubits into gates that only operate on 1 or 2 qubits. | +| `layout` | `qiskit.transpiler.layout` | `trivial`, `dense`, `sabre`, `default` | The output from this stage is expected to have the `layout` property set field set with a [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") object. Additionally, the circuit is typically expected to be embedded so that it is expanded to include all qubits and the [`ApplyLayout`](qiskit.transpiler.passes.ApplyLayout "qiskit.transpiler.passes.ApplyLayout") pass is expected to be run to apply the layout. The embedding of the [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") can be generated with [`generate_embed_passmanager()`](transpiler_preset#qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager "qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager"). | +| `routing` | `qiskit.transpiler.routing` | `basic`, `stochastic`, `lookahead`, `sabre` | The output from this stage is expected to have the circuit match the connectivity constraints of the target backend. This does not necessarily need to match the directionality of the edges in the target as a later stage typically will adjust directional gates to match that constraint (but there is no penalty for doing that in the `routing` stage). | +| `translation` | `qiskit.transpiler.translation` | `translator`, `synthesis`, `unroller` | **The output of this stage is expected to have every operation be a native**instruction on the target backend. | +| `optimization` | `qiskit.transpiler.optimization` | `default` | This stage is expected to perform optimization and simplification. The constraints from earlier stages still apply to the output of this stage. After the `optimization` stage is run we expect the circuit to still be executable on the target. | +| `scheduling` | `qiskit.transpiler.scheduling` | `alap`, `asap`, `default` | This is the last stage run and it is expected to output a scheduled circuit such that all idle periods in the circuit are marked by explicit [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay") instructions. | ## Writing Plugins diff --git a/docs/api/qiskit/dev/utils.md b/docs/api/qiskit/dev/utils.md index 4546a32a3a4..ed7fde56b07 100644 --- a/docs/api/qiskit/dev/utils.md +++ b/docs/api/qiskit/dev/utils.md @@ -271,7 +271,7 @@ A helper function for calling a custom function with python [`ProcessPoolExecuto -`qiskit.utils.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/parallel.py "view source code") +`qiskit.utils.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/utils/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: @@ -328,42 +328,42 @@ Qiskit has several features that are enabled only if certain *optional* dependen ##### Qiskit Components -| | | -| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **qiskit.utils.optionals.HAS\_AER** | Qiskit Aer \<[https://qiskit.org/ecosystem/aer/](https://qiskit.org/ecosystem/aer/)> provides high-performance simulators for the quantum circuits constructed within Qiskit. | -| **qiskit.utils.optionals.HAS\_IBMQ** | The `Qiskit IBMQ Provider` is used for accessing IBM Quantum hardware in the IBM cloud. | -| **qiskit.utils.optionals.HAS\_IGNIS** | `Qiskit Ignis` provides tools for quantum hardware verification, noise characterization, and error correction. | -| **qiskit.utils.optionals.HAS\_TOQM** | [Qiskit TOQM](https://github.com/qiskit-toqm/qiskit-toqm) provides transpiler passes for the [Time-optimal Qubit mapping algorithm](https://doi.org/10.1145/3445814.3446706). | +| | | +| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **qiskit.utils.optionals.HAS\_AER** | Qiskit Aer \<[https://qiskit.github.io/qiskit-aer/](https://qiskit.github.io/qiskit-aer/)> provides high-performance simulators for the quantum circuits constructed within Qiskit. | +| **qiskit.utils.optionals.HAS\_IBMQ** | The `Qiskit IBMQ Provider` is used for accessing IBM Quantum hardware in the IBM cloud. | +| **qiskit.utils.optionals.HAS\_IGNIS** | `Qiskit Ignis` provides tools for quantum hardware verification, noise characterization, and error correction. | +| **qiskit.utils.optionals.HAS\_TOQM** | [Qiskit TOQM](https://github.com/qiskit-toqm/qiskit-toqm) provides transpiler passes for the [Time-optimal Qubit mapping algorithm](https://doi.org/10.1145/3445814.3446706). | ##### External Python Libraries -| | | -| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| **qiskit.utils.optionals.HAS\_CONSTRAINT** | python-constraint \<[https://github.com/python-constraint/python-constraint>\_\_](https://github.com/python-constraint/python-constraint>__) is a constraint satisfaction problem solver, used in the :class:\`\~.CSPLayout transpiler pass. | -| **qiskit.utils.optionals.HAS\_CPLEX** | The [IBM CPLEX Optimizer](https://www.ibm.com/analytics/cplex-optimizer) is a high-performance mathematical programming solver for linear, mixed-integer and quadratic programming. This is no longer by Qiskit, but it weas historically and the optional remains for backwards compatibility. | -| **qiskit.utils.optionals.HAS\_CVXPY** | [CVXPY](https://www.cvxpy.org/) is a Python package for solving convex optimization problems. It is required for calculating diamond norms with [`quantum_info.diamond_norm()`](quantum_info#qiskit.quantum_info.diamond_norm "qiskit.quantum_info.diamond_norm"). | -| **qiskit.utils.optionals.HAS\_DOCPLEX** | [IBM Decision Optimization CPLEX Modelling](http://ibmdecisionoptimization.github.io/docplex-doc/) is a library for prescriptive analysis. Like CPLEX, this is no longer by Qiskit, but it weas historically and the optional remains for backwards compatibility. | -| **qiskit.utils.optionals.HAS\_FIXTURES** | The test suite has additional features that are available if the optional [fixtures](https://launchpad.net/python-fixtures) module is installed. This generally also needs [`HAS_TESTTOOLS`](#qiskit.utils.optionals.HAS_TESTTOOLS "qiskit.utils.optionals.HAS_TESTTOOLS") as well. This is generally only needed for Qiskit developers. | -| **qiskit.utils.optionals.HAS\_IPYTHON** | If [the IPython kernel](https://ipython.org/) is available, certain additional visualisations and line magics are made available. | -| **qiskit.utils.optionals.HAS\_IPYWIDGETS** | Monitoring widgets for jobs running on external backends can be provided if [ipywidgets](https://ipywidgets.readthedocs.io/en/latest/) is available. | -| **qiskit.utils.optionals.HAS\_JAX** | Some methods of gradient calculation within `opflow.gradients` require [JAX](https://github.com/google/jax) for autodifferentiation. | -| **qiskit.utils.optionals.HAS\_JUPYTER** | Some of the tests require a complete [Jupyter](https://jupyter.org/) installation to test interactivity features. | -| **qiskit.utils.optionals.HAS\_MATPLOTLIB** | Qiskit provides several visualisation tools in the [`visualization`](visualization#module-qiskit.visualization "qiskit.visualization") module. Almost all of these are built using [Matplotlib](https://matplotlib.org/), which must be installed in order to use them. | -| **qiskit.utils.optionals.HAS\_NETWORKX** | No longer used by Qiskit. Internally, Qiskit now uses the high-performance [rustworkx](https://github.com/Qiskit/rustworkx) library as a core dependency, and during the change-over period, it was sometimes convenient to convert things into the Python-only [NetworkX](https://networkx.org/) format. Some tests of application modules, such as [Qiskit Nature](https://qiskit.org/ecosystem/nature/) still use NetworkX. | -| **qiskit.utils.optionals.HAS\_NLOPT** | [NLopt](https://nlopt.readthedocs.io/en/latest/) is a nonlinear optimization library, used by the global optimizers in the `algorithms.optimizers` module. | -| **qiskit.utils.optionals.HAS\_PIL** | PIL is a Python image-manipulation library. Qiskit actually uses the [pillow](https://pillow.readthedocs.io/en/stable/) fork of PIL if it is available when generating certain visualizations, for example of both [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") and [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") in certain modes. | -| **qiskit.utils.optionals.HAS\_PYDOT** | For some graph visualisations, Qiskit uses [pydot](https://github.com/pydot/pydot) as an interface to GraphViz (see [`HAS_GRAPHVIZ`](#qiskit.utils.optionals.HAS_GRAPHVIZ "qiskit.utils.optionals.HAS_GRAPHVIZ")). | -| **qiskit.utils.optionals.HAS\_PYGMENTS** | Pygments is a code highlighter and formatter used by many environments that involve rich display of code blocks, including Sphinx and Jupyter. Qiskit uses this when producing rich output for these environments. | -| **qiskit.utils.optionals.HAS\_PYLATEX** | Various LaTeX-based visualizations, especially the circuit drawers, need access to the [pylatexenc](https://github.com/phfaist/pylatexenc) project to work correctly. | -| **qiskit.utils.optionals.HAS\_QASM3\_IMPORT** | The functions [`qasm3.load()`](qasm3#qiskit.qasm3.load "qiskit.qasm3.load") and [`qasm3.loads()`](qasm3#qiskit.qasm3.loads "qiskit.qasm3.loads") for importing OpenQASM 3 programs into [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") instances use [an external importer package](https://qiskit.github.io/qiskit-qasm3-import). | -| **qiskit.utils.optionals.HAS\_SEABORN** | Qiskit provides several visualisation tools in the [`visualization`](visualization#module-qiskit.visualization "qiskit.visualization") module. Some of these are built using [Seaborn](https://seaborn.pydata.org/), which must be installed in order to use them. | -| **qiskit.utils.optionals.HAS\_SKLEARN** | Some of the gradient functions in `opflow.gradients` use regularisation methods from [Scikit Learn](https://scikit-learn.org/stable/). | -| **qiskit.utils.optionals.HAS\_SKQUANT** | Some of the optimisers in `algorithms.optimizers` are based on those found in [Scikit Quant](https://github.com/scikit-quant/scikit-quant), which must be installed to use them. | -| **qiskit.utils.optionals.HAS\_SQSNOBFIT** | [SQSnobFit](https://pypi.org/project/SQSnobFit/) is a library for the “stable noisy optimization by branch and fit” algorithm. It is used by the `SNOBFIT` optimizer. | -| **qiskit.utils.optionals.HAS\_SYMENGINE** | [Symengine](https://github.com/symengine/symengine) is a fast C++ backend for the symbolic-manipulation library [Sympy](https://www.sympy.org/en/index.html). Qiskit uses special methods from Symengine to accelerate its handling of [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")s if available. | -| **qiskit.utils.optionals.HAS\_TESTTOOLS** | Qiskit’s test suite has more advanced functionality available if the optional [testtools](https://pypi.org/project/testtools/) library is installed. This is generally only needed for Qiskit developers. | -| **qiskit.utils.optionals.HAS\_TWEEDLEDUM** | [Tweedledum](https://github.com/boschmitt/tweedledum) is an extension library for synthesis and optimization of circuits that may involve classical oracles. Qiskit’s [`PhaseOracle`](qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle") uses this, which is used in turn by amplification algorithms via the `AmplificationProblem`. | -| **qiskit.utils.optionals.HAS\_Z3** | [Z3](https://github.com/Z3Prover/z3) is a theorem prover, used in the `CrosstalkAdaptiveSchedule` and [`HoareOptimizer`](qiskit.transpiler.passes.HoareOptimizer "qiskit.transpiler.passes.HoareOptimizer") transpiler passes. | +| | | +| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **qiskit.utils.optionals.HAS\_CONSTRAINT** | python-constraint \<[https://github.com/python-constraint/python-constraint>\_\_](https://github.com/python-constraint/python-constraint>__) is a constraint satisfaction problem solver, used in the :class:\`\~.CSPLayout transpiler pass. | +| **qiskit.utils.optionals.HAS\_CPLEX** | The [IBM CPLEX Optimizer](https://www.ibm.com/analytics/cplex-optimizer) is a high-performance mathematical programming solver for linear, mixed-integer and quadratic programming. This is no longer by Qiskit, but it weas historically and the optional remains for backwards compatibility. | +| **qiskit.utils.optionals.HAS\_CVXPY** | [CVXPY](https://www.cvxpy.org/) is a Python package for solving convex optimization problems. It is required for calculating diamond norms with [`quantum_info.diamond_norm()`](quantum_info#qiskit.quantum_info.diamond_norm "qiskit.quantum_info.diamond_norm"). | +| **qiskit.utils.optionals.HAS\_DOCPLEX** | [IBM Decision Optimization CPLEX Modelling](http://ibmdecisionoptimization.github.io/docplex-doc/) is a library for prescriptive analysis. Like CPLEX, this is no longer by Qiskit, but it weas historically and the optional remains for backwards compatibility. | +| **qiskit.utils.optionals.HAS\_FIXTURES** | The test suite has additional features that are available if the optional [fixtures](https://launchpad.net/python-fixtures) module is installed. This generally also needs [`HAS_TESTTOOLS`](#qiskit.utils.optionals.HAS_TESTTOOLS "qiskit.utils.optionals.HAS_TESTTOOLS") as well. This is generally only needed for Qiskit developers. | +| **qiskit.utils.optionals.HAS\_IPYTHON** | If [the IPython kernel](https://ipython.org/) is available, certain additional visualisations and line magics are made available. | +| **qiskit.utils.optionals.HAS\_IPYWIDGETS** | Monitoring widgets for jobs running on external backends can be provided if [ipywidgets](https://ipywidgets.readthedocs.io/en/latest/) is available. | +| **qiskit.utils.optionals.HAS\_JAX** | Some methods of gradient calculation within `opflow.gradients` require [JAX](https://github.com/google/jax) for autodifferentiation. | +| **qiskit.utils.optionals.HAS\_JUPYTER** | Some of the tests require a complete [Jupyter](https://jupyter.org/) installation to test interactivity features. | +| **qiskit.utils.optionals.HAS\_MATPLOTLIB** | Qiskit provides several visualisation tools in the [`visualization`](visualization#module-qiskit.visualization "qiskit.visualization") module. Almost all of these are built using [Matplotlib](https://matplotlib.org/), which must be installed in order to use them. | +| **qiskit.utils.optionals.HAS\_NETWORKX** | No longer used by Qiskit. Internally, Qiskit now uses the high-performance [rustworkx](https://github.com/Qiskit/rustworkx) library as a core dependency, and during the change-over period, it was sometimes convenient to convert things into the Python-only [NetworkX](https://networkx.org/) format. Some tests of application modules, such as [Qiskit Nature](https://qiskit-community.github.io/qiskit-nature/) still use NetworkX. | +| **qiskit.utils.optionals.HAS\_NLOPT** | [NLopt](https://nlopt.readthedocs.io/en/latest/) is a nonlinear optimization library, used by the global optimizers in the `algorithms.optimizers` module. | +| **qiskit.utils.optionals.HAS\_PIL** | PIL is a Python image-manipulation library. Qiskit actually uses the [pillow](https://pillow.readthedocs.io/en/stable/) fork of PIL if it is available when generating certain visualizations, for example of both [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") and [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") in certain modes. | +| **qiskit.utils.optionals.HAS\_PYDOT** | For some graph visualisations, Qiskit uses [pydot](https://github.com/pydot/pydot) as an interface to GraphViz (see [`HAS_GRAPHVIZ`](#qiskit.utils.optionals.HAS_GRAPHVIZ "qiskit.utils.optionals.HAS_GRAPHVIZ")). | +| **qiskit.utils.optionals.HAS\_PYGMENTS** | Pygments is a code highlighter and formatter used by many environments that involve rich display of code blocks, including Sphinx and Jupyter. Qiskit uses this when producing rich output for these environments. | +| **qiskit.utils.optionals.HAS\_PYLATEX** | Various LaTeX-based visualizations, especially the circuit drawers, need access to the [pylatexenc](https://github.com/phfaist/pylatexenc) project to work correctly. | +| **qiskit.utils.optionals.HAS\_QASM3\_IMPORT** | The functions [`qasm3.load()`](qasm3#qiskit.qasm3.load "qiskit.qasm3.load") and [`qasm3.loads()`](qasm3#qiskit.qasm3.loads "qiskit.qasm3.loads") for importing OpenQASM 3 programs into [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") instances use [an external importer package](https://qiskit.github.io/qiskit-qasm3-import). | +| **qiskit.utils.optionals.HAS\_SEABORN** | Qiskit provides several visualisation tools in the [`visualization`](visualization#module-qiskit.visualization "qiskit.visualization") module. Some of these are built using [Seaborn](https://seaborn.pydata.org/), which must be installed in order to use them. | +| **qiskit.utils.optionals.HAS\_SKLEARN** | Some of the gradient functions in `opflow.gradients` use regularisation methods from [Scikit Learn](https://scikit-learn.org/stable/). | +| **qiskit.utils.optionals.HAS\_SKQUANT** | Some of the optimisers in `algorithms.optimizers` are based on those found in [Scikit Quant](https://github.com/scikit-quant/scikit-quant), which must be installed to use them. | +| **qiskit.utils.optionals.HAS\_SQSNOBFIT** | [SQSnobFit](https://pypi.org/project/SQSnobFit/) is a library for the “stable noisy optimization by branch and fit” algorithm. It is used by the `SNOBFIT` optimizer. | +| **qiskit.utils.optionals.HAS\_SYMENGINE** | [Symengine](https://github.com/symengine/symengine) is a fast C++ backend for the symbolic-manipulation library [Sympy](https://www.sympy.org/en/index.html). Qiskit uses special methods from Symengine to accelerate its handling of [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")s if available. | +| **qiskit.utils.optionals.HAS\_TESTTOOLS** | Qiskit’s test suite has more advanced functionality available if the optional [testtools](https://pypi.org/project/testtools/) library is installed. This is generally only needed for Qiskit developers. | +| **qiskit.utils.optionals.HAS\_TWEEDLEDUM** | [Tweedledum](https://github.com/boschmitt/tweedledum) is an extension library for synthesis and optimization of circuits that may involve classical oracles. Qiskit’s [`PhaseOracle`](qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle") uses this, which is used in turn by amplification algorithms via the `AmplificationProblem`. | +| **qiskit.utils.optionals.HAS\_Z3** | [Z3](https://github.com/Z3Prover/z3) is a theorem prover, used in the `CrosstalkAdaptiveSchedule` and [`HoareOptimizer`](qiskit.transpiler.passes.HoareOptimizer "qiskit.transpiler.passes.HoareOptimizer") transpiler passes. | ##### External Command-Line Tools diff --git a/public/api/qiskit/dev/objects.inv b/public/api/qiskit/dev/objects.inv index 1914b938347..d78c319b6e8 100644 Binary files a/public/api/qiskit/dev/objects.inv and b/public/api/qiskit/dev/objects.inv differ diff --git a/public/images/api/qiskit/dev/circuit-1.png b/public/images/api/qiskit/dev/circuit-1.png index b31f60b8158..c75b790b80b 100644 Binary files a/public/images/api/qiskit/dev/circuit-1.png and b/public/images/api/qiskit/dev/circuit-1.png differ diff --git a/public/images/api/qiskit/dev/circuit-2.png b/public/images/api/qiskit/dev/circuit-2.png index 8969af61bd9..fd392fbf7c8 100644 Binary files a/public/images/api/qiskit/dev/circuit-2.png and b/public/images/api/qiskit/dev/circuit-2.png differ diff --git a/public/images/api/qiskit/dev/circuit-3.png b/public/images/api/qiskit/dev/circuit-3.png index c4a1a9f83b5..9a716732ff1 100644 Binary files a/public/images/api/qiskit/dev/circuit-3.png and b/public/images/api/qiskit/dev/circuit-3.png differ diff --git a/public/images/api/qiskit/dev/circuit-4.png b/public/images/api/qiskit/dev/circuit-4.png index 6007f0b7783..fbc372f934b 100644 Binary files a/public/images/api/qiskit/dev/circuit-4.png and b/public/images/api/qiskit/dev/circuit-4.png differ diff --git a/public/images/api/qiskit/dev/circuit-5.png b/public/images/api/qiskit/dev/circuit-5.png index 21d06755777..f170c8932d2 100644 Binary files a/public/images/api/qiskit/dev/circuit-5.png and b/public/images/api/qiskit/dev/circuit-5.png differ diff --git a/public/images/api/qiskit/dev/circuit_library-1.png b/public/images/api/qiskit/dev/circuit_library-1.png index 65ffa804742..9fb79cf8bb1 100644 Binary files a/public/images/api/qiskit/dev/circuit_library-1.png and b/public/images/api/qiskit/dev/circuit_library-1.png differ diff --git a/public/images/api/qiskit/dev/converters-1.png b/public/images/api/qiskit/dev/converters-1.png index 13e81255a03..46bdb3cd758 100644 Binary files a/public/images/api/qiskit/dev/converters-1.png and b/public/images/api/qiskit/dev/converters-1.png differ diff --git a/public/images/api/qiskit/dev/providers_fake_provider-1_00.png b/public/images/api/qiskit/dev/providers_fake_provider-1_00.png index 824e5d397e2..7dc1e7b3879 100644 Binary files a/public/images/api/qiskit/dev/providers_fake_provider-1_00.png and b/public/images/api/qiskit/dev/providers_fake_provider-1_00.png differ diff --git a/public/images/api/qiskit/dev/providers_fake_provider-1_01.png b/public/images/api/qiskit/dev/providers_fake_provider-1_01.png index 2ea1f566fc4..4dbbe5f0681 100644 Binary files a/public/images/api/qiskit/dev/providers_fake_provider-1_01.png and b/public/images/api/qiskit/dev/providers_fake_provider-1_01.png differ diff --git a/public/images/api/qiskit/dev/providers_fake_provider-1_02.png b/public/images/api/qiskit/dev/providers_fake_provider-1_02.png index 910b07254fe..aa61942cc71 100644 Binary files a/public/images/api/qiskit/dev/providers_fake_provider-1_02.png and b/public/images/api/qiskit/dev/providers_fake_provider-1_02.png differ diff --git a/public/images/api/qiskit/dev/pulse-1.png b/public/images/api/qiskit/dev/pulse-1.png index 6c33a77d369..499390dfa3a 100644 Binary files a/public/images/api/qiskit/dev/pulse-1.png and b/public/images/api/qiskit/dev/pulse-1.png differ diff --git a/public/images/api/qiskit/dev/pulse-2.png b/public/images/api/qiskit/dev/pulse-2.png index 9617d2b6331..1040d64f26d 100644 Binary files a/public/images/api/qiskit/dev/pulse-2.png and b/public/images/api/qiskit/dev/pulse-2.png differ diff --git a/public/images/api/qiskit/dev/pulse-3.png b/public/images/api/qiskit/dev/pulse-3.png index 428533cd5aa..c8b16114c4c 100644 Binary files a/public/images/api/qiskit/dev/pulse-3.png and b/public/images/api/qiskit/dev/pulse-3.png differ diff --git a/public/images/api/qiskit/dev/pulse-4.png b/public/images/api/qiskit/dev/pulse-4.png index 536c24dbb8b..307493ebd75 100644 Binary files a/public/images/api/qiskit/dev/pulse-4.png and b/public/images/api/qiskit/dev/pulse-4.png differ diff --git a/public/images/api/qiskit/dev/pulse-5.png b/public/images/api/qiskit/dev/pulse-5.png index 3db3ba311b1..f53f009364c 100644 Binary files a/public/images/api/qiskit/dev/pulse-5.png and b/public/images/api/qiskit/dev/pulse-5.png differ diff --git a/public/images/api/qiskit/dev/pulse-6.png b/public/images/api/qiskit/dev/pulse-6.png index cde29e03daa..50fd0ea61af 100644 Binary files a/public/images/api/qiskit/dev/pulse-6.png and b/public/images/api/qiskit/dev/pulse-6.png differ diff --git a/public/images/api/qiskit/dev/pulse-7.png b/public/images/api/qiskit/dev/pulse-7.png index 0e0e889b353..8b2d9f28b63 100644 Binary files a/public/images/api/qiskit/dev/pulse-7.png and b/public/images/api/qiskit/dev/pulse-7.png differ diff --git a/public/images/api/qiskit/dev/qasm3-1.png b/public/images/api/qiskit/dev/qasm3-1.png index d80ef309427..b3b93ef79db 100644 Binary files a/public/images/api/qiskit/dev/qasm3-1.png and b/public/images/api/qiskit/dev/qasm3-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-1.png b/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-1.png index 41d453b9eaf..0a9993be591 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png b/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png index fc1ff17d7e0..5400e72528c 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-InstructionSet-1.png b/public/images/api/qiskit/dev/qiskit-circuit-InstructionSet-1.png index 6ef86b54517..5c1e13a4769 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-InstructionSet-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-InstructionSet-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-Operation-1.png b/public/images/api/qiskit/dev/qiskit-circuit-Operation-1.png index fa8a838827f..7736ef92c71 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-Operation-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-Operation-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.png b/public/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.png index ac09c7c6228..d2e775ef9b9 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.png and b/public/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-Parameter-1_01.png b/public/images/api/qiskit/dev/qiskit-circuit-Parameter-1_01.png index 197a693d14a..c14c78b7678 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-Parameter-1_01.png and b/public/images/api/qiskit/dev/qiskit-circuit-Parameter-1_01.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-1.png b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-1.png index bf3bc612a5b..24b1e71f364 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-2.png b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-2.png index 2877f60447c..33a51cfb72c 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-3_00.png b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-3_00.png index 315cc9ce141..7cdc1d9b0a4 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-3_00.png and b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-3_00.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-3_01.png b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-3_01.png index 060d97da696..9064f838767 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-3_01.png and b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-3_01.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-4_00.png b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-4_00.png index 7a2f66e13f4..da8df1d5faf 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-4_00.png and b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-4_00.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-4_01.png b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-4_01.png index ce1d6a93f9b..cdf4f600623 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-4_01.png and b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-4_01.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-5.png b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-5.png index 4533aa27eeb..45bdf4a80c1 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-5.png and b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-5.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-6.png b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-6.png index 314d3812a06..f5ed5c04794 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-6.png and b/public/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-6.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-AND-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-AND-1.png index 460e4a0c606..621e425bf91 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-AND-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-AND-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-AND-2.png b/public/images/api/qiskit/dev/qiskit-circuit-library-AND-2.png index 6a689868b91..4504ff63484 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-AND-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-AND-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-FourierChecking-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-FourierChecking-1.png index 13228777549..c64d464ed1f 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-FourierChecking-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-FourierChecking-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-GMS-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-GMS-1.png index 182d6d67a45..f217f7ac6e3 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-GMS-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-GMS-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-GR-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-GR-1.png index 21b44d271d8..8a88cf0a2a9 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-GR-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-GR-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-GRX-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-GRX-1.png index 84978c74712..055c4ebcb95 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-GRX-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-GRX-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-GRY-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-GRY-1.png index 21b44d271d8..8a88cf0a2a9 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-GRY-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-GRY-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-GRZ-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-GRZ-1.png index b72cc7a91ec..540898cb666 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-GRZ-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-GRZ-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-GraphState-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-GraphState-1.png index 3745f192118..d932b14a8ea 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-GraphState-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-GraphState-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-HiddenLinearFunction-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-HiddenLinearFunction-1.png index e4b7b39b182..1046697c2c7 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-HiddenLinearFunction-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-HiddenLinearFunction-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-IQP-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-IQP-1.png index ab4aa276528..02a1fa1eb3b 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-IQP-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-IQP-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-IQP-2.png b/public/images/api/qiskit/dev/qiskit-circuit-library-IQP-2.png index 6d2b8bf43dd..27b33e02d60 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-IQP-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-IQP-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-InnerProduct-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-InnerProduct-1.png index ddc4e7b0d42..2ca09d2f51d 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-InnerProduct-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-InnerProduct-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-MCMTVChain-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-MCMTVChain-1.png index 11ca58e7859..62456d9fd3f 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-MCMTVChain-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-MCMTVChain-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-OR-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-OR-1.png index c6bd604feee..682c51140d3 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-OR-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-OR-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-OR-2.png b/public/images/api/qiskit/dev/qiskit-circuit-library-OR-2.png index 9bb8f1f380d..09a387d21f0 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-OR-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-OR-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-PauliTwoDesign-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-PauliTwoDesign-1.png index cf683f2a997..470e14d7aaf 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-PauliTwoDesign-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-PauliTwoDesign-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-Permutation-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-Permutation-1.png index 5a55d908669..b5d151096b8 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-Permutation-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-Permutation-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-Permutation-2.png b/public/images/api/qiskit/dev/qiskit-circuit-library-Permutation-2.png index 1d04af7412d..7e991ea0b41 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-Permutation-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-Permutation-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-1.png index 88b6bff3f9a..5575c6f4389 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png b/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png index 1d7df8c9b6e..6bb29a09c01 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png index 6147fd8108b..7c5e890d742 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshev-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshev-1.png index fdec8a478be..0d58f105fb7 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshev-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshev-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-1.png index fcef93ad228..cd52908ea50 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-2.png b/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-2.png index 2f0984f7a99..51b5e2e26eb 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-3.png b/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-3.png index 85739f4b642..4237d5c5810 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-3.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-QFT-3.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-1.png index a20a3b47654..807d7abc2eb 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-2.png b/public/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-2.png index 6900da4bc50..644ec6d4d69 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-2.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-circuit-library-XOR-1.png b/public/images/api/qiskit/dev/qiskit-circuit-library-XOR-1.png index 71fc51fd37e..e70f7278a80 100644 Binary files a/public/images/api/qiskit/dev/qiskit-circuit-library-XOR-1.png and b/public/images/api/qiskit/dev/qiskit-circuit-library-XOR-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-pulse-library-SymbolicPulse-1.png b/public/images/api/qiskit/dev/qiskit-pulse-library-SymbolicPulse-1.png index 8e467247437..1f953c5f9f6 100644 Binary files a/public/images/api/qiskit/dev/qiskit-pulse-library-SymbolicPulse-1.png and b/public/images/api/qiskit/dev/qiskit-pulse-library-SymbolicPulse-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.png b/public/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.png index eafeedb5d39..81dbadd2ea4 100644 Binary files a/public/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.png and b/public/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png b/public/images/api/qiskit/dev/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png index e70e82bbfdd..3d9d414b77e 100644 Binary files a/public/images/api/qiskit/dev/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png and b/public/images/api/qiskit/dev/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png differ diff --git a/public/images/api/qiskit/dev/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png b/public/images/api/qiskit/dev/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png index a95a101b1ad..dc1041107fb 100644 Binary files a/public/images/api/qiskit/dev/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png and b/public/images/api/qiskit/dev/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png differ diff --git a/public/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.png b/public/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.png index 1571e1681d2..cfac40a39a0 100644 Binary files a/public/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.png and b/public/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png b/public/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png index e70e82bbfdd..3d9d414b77e 100644 Binary files a/public/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png and b/public/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png differ diff --git a/public/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png b/public/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png index a95a101b1ad..dc1041107fb 100644 Binary files a/public/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png and b/public/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png differ diff --git a/public/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.png b/public/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.png index 0671c9835a9..4a1389a8db7 100644 Binary files a/public/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.png and b/public/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.png b/public/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.png index 4533aa27eeb..45bdf4a80c1 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-1.png index abda4e49032..716ad102ca7 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-2.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-2.png index be62559f955..7d1bedbec92 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-2.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-1.png index 524022b1e0b..fd680ae0bd8 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-2.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-2.png index ee6c12d917d..77314955f0f 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-2.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png index 71eeb1bdb26..ccab48f95b9 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_coupling_map-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_coupling_map-1.png index 7b6da4bacff..b1c6fdf5ffb 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_coupling_map-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_coupling_map-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_00.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_00.png index ba5362517af..b0ca4500d14 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_00.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_00.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_01.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_01.png index ed93a52107e..5f519f497f1 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_01.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_01.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_02.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_02.png index d44060eff2a..f1da963f693 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_02.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_02.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png index 979bce6dedf..791d514d7e9 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_gate_map-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_gate_map-1.png index d967bc76fef..b4ef8268036 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_gate_map-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_gate_map-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_00.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_00.png index 6b261ebdafb..0998fae7a04 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_00.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_00.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.png index 376ed78f0a9..4d019a55f88 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_02.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_02.png index db137e1e931..a7150aa1551 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_02.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_02.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_city-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_city-1.png index 60511663e87..08403aa6ceb 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_city-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_city-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_city-2.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_city-2.png index eef292ec9cd..5f4db6f8e94 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_city-2.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_city-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.png index 69d0934339d..94ddac67da5 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-1.png index 7fcff6d7838..fdff63d9c68 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-2.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-2.png index b66e2de759b..b09130cab29 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-2.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-1.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-1.png index f3bf28245b2..5f67078398e 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-2.png b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-2.png index 870778882c8..052be3a4d02 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-2.png and b/public/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png index 0c3ea809202..c51f445ba2b 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png and b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png index 53721c4d9f9..0072848be31 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png and b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.png differ diff --git a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png index 8e4bdff5cc5..14ec5dd1e12 100644 Binary files a/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png and b/public/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.png differ diff --git a/public/images/api/qiskit/dev/transpiler-10.png b/public/images/api/qiskit/dev/transpiler-10.png index f70da85b300..d4a8c308c4d 100644 Binary files a/public/images/api/qiskit/dev/transpiler-10.png and b/public/images/api/qiskit/dev/transpiler-10.png differ diff --git a/public/images/api/qiskit/dev/transpiler-11.png b/public/images/api/qiskit/dev/transpiler-11.png index a6c524d2fc7..711224a5ca6 100644 Binary files a/public/images/api/qiskit/dev/transpiler-11.png and b/public/images/api/qiskit/dev/transpiler-11.png differ diff --git a/public/images/api/qiskit/dev/transpiler-12.png b/public/images/api/qiskit/dev/transpiler-12.png index bea05c03f72..a0895424ee9 100644 Binary files a/public/images/api/qiskit/dev/transpiler-12.png and b/public/images/api/qiskit/dev/transpiler-12.png differ diff --git a/public/images/api/qiskit/dev/transpiler-13.png b/public/images/api/qiskit/dev/transpiler-13.png index a6c524d2fc7..711224a5ca6 100644 Binary files a/public/images/api/qiskit/dev/transpiler-13.png and b/public/images/api/qiskit/dev/transpiler-13.png differ diff --git a/public/images/api/qiskit/dev/transpiler-14.png b/public/images/api/qiskit/dev/transpiler-14.png index 2f9400f180b..acf918b4920 100644 Binary files a/public/images/api/qiskit/dev/transpiler-14.png and b/public/images/api/qiskit/dev/transpiler-14.png differ diff --git a/public/images/api/qiskit/dev/transpiler-15.png b/public/images/api/qiskit/dev/transpiler-15.png index af4b04718d4..30d43e525e9 100644 Binary files a/public/images/api/qiskit/dev/transpiler-15.png and b/public/images/api/qiskit/dev/transpiler-15.png differ diff --git a/public/images/api/qiskit/dev/transpiler-16.png b/public/images/api/qiskit/dev/transpiler-16.png index a55f4b686e9..5e6ab486ef9 100644 Binary files a/public/images/api/qiskit/dev/transpiler-16.png and b/public/images/api/qiskit/dev/transpiler-16.png differ diff --git a/public/images/api/qiskit/dev/transpiler-17.png b/public/images/api/qiskit/dev/transpiler-17.png index 7f663eb1964..0742a68aed0 100644 Binary files a/public/images/api/qiskit/dev/transpiler-17.png and b/public/images/api/qiskit/dev/transpiler-17.png differ diff --git a/public/images/api/qiskit/dev/transpiler-4.png b/public/images/api/qiskit/dev/transpiler-4.png index d834d77bf4a..042ecfc4616 100644 Binary files a/public/images/api/qiskit/dev/transpiler-4.png and b/public/images/api/qiskit/dev/transpiler-4.png differ diff --git a/public/images/api/qiskit/dev/transpiler-5.png b/public/images/api/qiskit/dev/transpiler-5.png index ff610126cf7..52192f0a336 100644 Binary files a/public/images/api/qiskit/dev/transpiler-5.png and b/public/images/api/qiskit/dev/transpiler-5.png differ diff --git a/public/images/api/qiskit/dev/transpiler-6.png b/public/images/api/qiskit/dev/transpiler-6.png index d12c7f6aae1..2156565dcce 100644 Binary files a/public/images/api/qiskit/dev/transpiler-6.png and b/public/images/api/qiskit/dev/transpiler-6.png differ diff --git a/public/images/api/qiskit/dev/transpiler-7.png b/public/images/api/qiskit/dev/transpiler-7.png index 8690bf4a09b..6cab9506a0a 100644 Binary files a/public/images/api/qiskit/dev/transpiler-7.png and b/public/images/api/qiskit/dev/transpiler-7.png differ diff --git a/public/images/api/qiskit/dev/transpiler-8.png b/public/images/api/qiskit/dev/transpiler-8.png index 5cc6740b99f..5878347b984 100644 Binary files a/public/images/api/qiskit/dev/transpiler-8.png and b/public/images/api/qiskit/dev/transpiler-8.png differ diff --git a/public/images/api/qiskit/dev/transpiler-9.png b/public/images/api/qiskit/dev/transpiler-9.png index 0af64541bcd..3206ffa2f71 100644 Binary files a/public/images/api/qiskit/dev/transpiler-9.png and b/public/images/api/qiskit/dev/transpiler-9.png differ diff --git a/public/images/api/qiskit/dev/visualization-1.png b/public/images/api/qiskit/dev/visualization-1.png index 2982c1537ea..186a0243004 100644 Binary files a/public/images/api/qiskit/dev/visualization-1.png and b/public/images/api/qiskit/dev/visualization-1.png differ diff --git a/public/images/api/qiskit/dev/visualization-2.png b/public/images/api/qiskit/dev/visualization-2.png index bce08004218..586026285a8 100644 Binary files a/public/images/api/qiskit/dev/visualization-2.png and b/public/images/api/qiskit/dev/visualization-2.png differ diff --git a/public/images/api/qiskit/dev/visualization-3.png b/public/images/api/qiskit/dev/visualization-3.png index 18734b1cce2..ada907465e1 100644 Binary files a/public/images/api/qiskit/dev/visualization-3.png and b/public/images/api/qiskit/dev/visualization-3.png differ diff --git a/public/images/api/qiskit/dev/visualization-4.png b/public/images/api/qiskit/dev/visualization-4.png index e4c9ad7547f..d8fd4fcad2f 100644 Binary files a/public/images/api/qiskit/dev/visualization-4.png and b/public/images/api/qiskit/dev/visualization-4.png differ diff --git a/public/images/api/qiskit/dev/visualization-5.png b/public/images/api/qiskit/dev/visualization-5.png index 1e03672a927..71bd0e77858 100644 Binary files a/public/images/api/qiskit/dev/visualization-5.png and b/public/images/api/qiskit/dev/visualization-5.png differ diff --git a/public/images/api/qiskit/dev/visualization-6.png b/public/images/api/qiskit/dev/visualization-6.png index 1e03672a927..71bd0e77858 100644 Binary files a/public/images/api/qiskit/dev/visualization-6.png and b/public/images/api/qiskit/dev/visualization-6.png differ