diff --git a/docs/api/qiskit/dev/circuit.mdx b/docs/api/qiskit/dev/circuit.mdx index a9f8ba616dc..f10c6c6745e 100644 --- a/docs/api/qiskit/dev/circuit.mdx +++ b/docs/api/qiskit/dev/circuit.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.circuit --- + + - - # Quantum circuit model `qiskit.circuit` @@ -418,8 +418,8 @@ The available modifiers for [`AnnotatedOperation`](qiskit.circuit.AnnotatedOpera **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) #### PowerModifier @@ -431,7 +431,7 @@ The available modifiers for [`AnnotatedOperation`](qiskit.circuit.AnnotatedOpera **Parameters** - **power** ([*float*](https://docs.python.org/3/library/functions.html#float)) – + **power** ([*float*](https://docs.python.org/3/library/functions.html#float)) For information on how to create custom gates and instructions, including how to build one-off objects, and re-usable parametric gates via subclassing, see [Creating custom instructions](#circuit-custom-gates) below. The Qiskit circuit library in [`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library") contains many predefined gates and circuits for you to use. diff --git a/docs/api/qiskit/dev/circuit_annotation.mdx b/docs/api/qiskit/dev/circuit_annotation.mdx index 0014da9f9ac..2ebfbc66326 100644 --- a/docs/api/qiskit/dev/circuit_annotation.mdx +++ b/docs/api/qiskit/dev/circuit_annotation.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.circuit.annotation --- + + - - # Circuit annotations `qiskit.circuit.annotation` @@ -56,7 +56,7 @@ A stand-alone function allows iterating through namespaces and parent namespaces **Parameters** - **namespace** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + **namespace** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) **Return type** diff --git a/docs/api/qiskit/dev/circuit_classical.mdx b/docs/api/qiskit/dev/circuit_classical.mdx index a16b85fcf0e..fe52f07ee25 100644 --- a/docs/api/qiskit/dev/circuit_classical.mdx +++ b/docs/api/qiskit/dev/circuit_classical.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.circuit.classical --- + + - - # Classical expressions `qiskit.circuit.classical` @@ -26,10 +26,10 @@ Currently, only simple expressions on bits and registers that result in a Boolea The type system and expression tree will be expanded over time, and it is possible that the allowed types of some operations may need to change between versions of Qiskit as the classical processing capabilities develop. - - + + ## Expressions `qiskit.circuit.classical.expr` @@ -81,7 +81,7 @@ The base for dynamic variables is the [`Var`](#qiskit.circuit.classical.expr.Var ##### new - + Generate a new named variable that owns its own backing storage. @@ -121,7 +121,7 @@ Stretch variables for use in duration expressions are represented by the [`Stret ##### new - + Generate a new named stretch variable. @@ -149,7 +149,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum) Enumeration of the opcodes for unary operations. @@ -176,7 +176,7 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op - + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum) Enumeration of the opcodes for binary operations. @@ -262,8 +262,8 @@ The functions and methods described in this section are a more user-friendly way **Parameters** - * **value** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type") *| None*) – + * **value** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type") *| None*) **Return type** @@ -292,8 +292,8 @@ You can manually specify casts in cases where the cast is allowed in explicit fo **Parameters** - * **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – + * **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) **Return type** @@ -320,7 +320,7 @@ There are helper constructor functions for each of the unary operations. **Parameters** - **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -345,7 +345,7 @@ There are helper constructor functions for each of the unary operations. **Parameters** - **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -372,8 +372,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -398,8 +398,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -424,8 +424,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -450,8 +450,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -476,8 +476,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -502,8 +502,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -528,8 +528,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -554,8 +554,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -580,8 +580,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -606,8 +606,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -632,8 +632,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -667,9 +667,9 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type") *| None*) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type") *| None*) **Return type** @@ -696,9 +696,9 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type") *| None*) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type") *| None*) **Return type** @@ -731,8 +731,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -765,8 +765,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -801,8 +801,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -846,8 +846,8 @@ Similarly, the binary operations and relations have helper functions defined. **Parameters** - * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -876,8 +876,8 @@ You can index into unsigned integers and bit-likes using another unsigned intege **Parameters** - * **target** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – - * **index** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – + * **target** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) + * **index** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) **Return type** @@ -893,7 +893,7 @@ Qiskit’s legacy method for specifying equality conditions for use in condition **Parameters** - **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*qiskit.circuit.Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*qiskit.circuit.ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int)*]*) – + **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*qiskit.circuit.Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*qiskit.circuit.ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int)*]*) **Return type** @@ -916,7 +916,7 @@ A typical consumer of the expression tree wants to recursively walk through the **Parameters** - **node** ([*Binary*](#qiskit.circuit.classical.expr.Binary "qiskit._accelerate.circuit.classical.expr.Binary")) – + **node** ([*Binary*](#qiskit.circuit.classical.expr.Binary "qiskit._accelerate.circuit.classical.expr.Binary")) **Return type** @@ -928,7 +928,7 @@ A typical consumer of the expression tree wants to recursively walk through the **Parameters** - **node** ([*Cast*](#qiskit.circuit.classical.expr.Cast "qiskit._accelerate.circuit.classical.expr.Cast")) – + **node** ([*Cast*](#qiskit.circuit.classical.expr.Cast "qiskit._accelerate.circuit.classical.expr.Cast")) **Return type** @@ -940,7 +940,7 @@ A typical consumer of the expression tree wants to recursively walk through the **Parameters** - **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit._accelerate.circuit.classical.expr.Expr")) – + **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit._accelerate.circuit.classical.expr.Expr")) **Return type** @@ -952,7 +952,7 @@ A typical consumer of the expression tree wants to recursively walk through the **Parameters** - **node** ([*Index*](#qiskit.circuit.classical.expr.Index "qiskit._accelerate.circuit.classical.expr.Index")) – + **node** ([*Index*](#qiskit.circuit.classical.expr.Index "qiskit._accelerate.circuit.classical.expr.Index")) **Return type** @@ -964,7 +964,7 @@ A typical consumer of the expression tree wants to recursively walk through the **Parameters** - **node** ([*Stretch*](#qiskit.circuit.classical.expr.Stretch "qiskit._accelerate.circuit.classical.expr.Stretch")) – + **node** ([*Stretch*](#qiskit.circuit.classical.expr.Stretch "qiskit._accelerate.circuit.classical.expr.Stretch")) **Return type** @@ -976,7 +976,7 @@ A typical consumer of the expression tree wants to recursively walk through the **Parameters** - **node** ([*Unary*](#qiskit.circuit.classical.expr.Unary "qiskit._accelerate.circuit.classical.expr.Unary")) – + **node** ([*Unary*](#qiskit.circuit.classical.expr.Unary "qiskit._accelerate.circuit.classical.expr.Unary")) **Return type** @@ -988,7 +988,7 @@ A typical consumer of the expression tree wants to recursively walk through the **Parameters** - **node** ([*Value*](#qiskit.circuit.classical.expr.Value "qiskit._accelerate.circuit.classical.expr.Value")) – + **node** ([*Value*](#qiskit.circuit.classical.expr.Value "qiskit._accelerate.circuit.classical.expr.Value")) **Return type** @@ -1000,7 +1000,7 @@ A typical consumer of the expression tree wants to recursively walk through the **Parameters** - **node** ([*Var*](#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")) – + **node** ([*Var*](#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")) **Return type** @@ -1041,7 +1041,7 @@ For the convenience of simple visitors that only need to inspect the variables i **Parameters** - **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit._accelerate.circuit.classical.expr.Expr")) – + **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit._accelerate.circuit.classical.expr.Expr")) **Return type** @@ -1079,7 +1079,7 @@ To iterator over all variables including stretch variables, the iterator method **Parameters** - **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit._accelerate.circuit.classical.expr.Expr")) – + **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit._accelerate.circuit.classical.expr.Expr")) **Return type** @@ -1178,17 +1178,17 @@ Some expressions have associated memory locations, and others may be purely temp **Parameters** - **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit._accelerate.circuit.classical.expr.Expr")) – + **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit._accelerate.circuit.classical.expr.Expr")) **Return type** [bool](https://docs.python.org/3/library/functions.html#bool) - - + + ## Typing `qiskit.circuit.classical.types` @@ -1283,8 +1283,8 @@ The low-level interface to querying the subtyping relationship is the [`order()` **Parameters** - * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – - * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) **Return type** @@ -1295,7 +1295,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. #### Ordering - + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum) Enumeration listing the possible relations between two types. Types only have a partial ordering, so it’s possible for two types to have no sub-typing relationship. @@ -1331,9 +1331,9 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis **Parameters** - * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – - * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – - * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) + * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) **Return type** @@ -1366,9 +1366,9 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis **Parameters** - * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – - * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – - * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) + * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) **Return type** @@ -1390,8 +1390,8 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis **Parameters** - * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – - * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) **Return type** @@ -1433,8 +1433,8 @@ It is common to need to cast values of one type to another type. The casting rul **Parameters** - * **from\_** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – - * **to\_** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) – + * **from\_** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) + * **to\_** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type")) **Return type** @@ -1447,7 +1447,7 @@ Note that casts between [`Float`](#qiskit.circuit.classical.types.Float "qiskit. #### CastKind - + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum) A return value indicating the type of cast that can occur from one type to another. diff --git a/docs/api/qiskit/dev/circuit_library.mdx b/docs/api/qiskit/dev/circuit_library.mdx index d26772103b8..615a05dcd4c 100644 --- a/docs/api/qiskit/dev/circuit_library.mdx +++ b/docs/api/qiskit/dev/circuit_library.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.circuit.library --- + + - - # Circuit Library `qiskit.circuit.library` @@ -2154,7 +2154,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui **Parameters** - **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) #### rzx\_xz @@ -2177,7 +2177,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui **Parameters** - **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) #### rzx\_cy @@ -2195,7 +2195,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui **Parameters** - **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) #### rzx\_zz1 @@ -2223,7 +2223,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui **Parameters** - **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) #### rzx\_zz2 @@ -2246,7 +2246,7 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui **Parameters** - **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) #### rzx\_zz3 @@ -2269,6 +2269,6 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui **Parameters** - **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) diff --git a/docs/api/qiskit/dev/circuit_random.mdx b/docs/api/qiskit/dev/circuit_random.mdx index d4c6c9400a6..4294b6f1afc 100644 --- a/docs/api/qiskit/dev/circuit_random.mdx +++ b/docs/api/qiskit/dev/circuit_random.mdx @@ -6,10 +6,10 @@ python_api_type: module python_api_name: qiskit.circuit.random --- - - + + # Random Circuits `qiskit.circuit.random` diff --git a/docs/api/qiskit/dev/circuit_singleton.mdx b/docs/api/qiskit/dev/circuit_singleton.mdx index 4b48f70ee36..7d420490de3 100644 --- a/docs/api/qiskit/dev/circuit_singleton.mdx +++ b/docs/api/qiskit/dev/circuit_singleton.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.circuit.singleton --- + + - - # Singleton instructions `qiskit.circuit.singleton` diff --git a/docs/api/qiskit/dev/compiler.mdx b/docs/api/qiskit/dev/compiler.mdx index 919ba08f20c..777fc048b23 100644 --- a/docs/api/qiskit/dev/compiler.mdx +++ b/docs/api/qiskit/dev/compiler.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.compiler --- + + - - # Compilation Routines `qiskit.compiler` diff --git a/docs/api/qiskit/dev/converters.mdx b/docs/api/qiskit/dev/converters.mdx index 37be064ac62..6228b4ab4a8 100644 --- a/docs/api/qiskit/dev/converters.mdx +++ b/docs/api/qiskit/dev/converters.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.converters --- + + - - # Circuit Converters `qiskit.converters` diff --git a/docs/api/qiskit/dev/dagcircuit.mdx b/docs/api/qiskit/dev/dagcircuit.mdx index df8ae457248..6c26df608e3 100644 --- a/docs/api/qiskit/dev/dagcircuit.mdx +++ b/docs/api/qiskit/dev/dagcircuit.mdx @@ -6,27 +6,27 @@ python_api_type: module python_api_name: qiskit.dagcircuit --- + + - - # DAG Circuits `qiskit.dagcircuit` ## Circuits as Directed Acyclic Graphs -| | | -| ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")() | Quantum circuit as a directed acyclic graph. | -| [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")(\[nid]) | Parent class for DAGOpNode, DAGInNode, and DAGOutNode. | -| [`DAGOpNode`](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")(op\[, qargs, cargs]) | Object to represent an Instruction at a node in the DAGCircuit. | -| [`DAGInNode`](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")(wire) | Object to represent an incoming wire node in the DAGCircuit. | -| [`DAGOutNode`](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")(wire) | Object to represent an outgoing wire node in the DAGCircuit. | -| [`DAGDepNode`](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")(\[type, op, name, qargs, cargs, ...]) | Object to represent the information at a node in the DAGDependency(). | -| [`DAGDependency`](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency")() | Object to represent a quantum circuit as a Directed Acyclic Graph (DAG) via operation dependencies (i.e. | +| | | +| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | +| [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")() | Quantum circuit as a directed acyclic graph. | +| [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")(\[nid]) | Parent class for DAGOpNode, DAGInNode, and DAGOutNode. | +| [`DAGOpNode`](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")(op\[, qargs, cargs]) | Object to represent an Instruction at a node in the DAGCircuit. | +| [`DAGInNode`](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")(wire) | Object to represent an incoming wire node in the DAGCircuit. | +| [`DAGOutNode`](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")(wire) | Object to represent an outgoing wire node in the DAGCircuit. | +| [`DAGDepNode`](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")(\[type, op, name, qargs, cargs, ...]) | Object to represent the information at a node in the DAGDependency(). | +| [`DAGDependency`](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency")() | Object to represent a quantum circuit as a Directed Acyclic Graph (DAG) via operation dependencies (i.e. lack of commutation). | ## Exceptions diff --git a/docs/api/qiskit/dev/exceptions.mdx b/docs/api/qiskit/dev/exceptions.mdx index 586384d2e51..1c89dfbcce5 100644 --- a/docs/api/qiskit/dev/exceptions.mdx +++ b/docs/api/qiskit/dev/exceptions.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.exceptions --- + + - - # Top-level exceptions `qiskit.exceptions` @@ -49,10 +49,10 @@ Qiskit has several optional features that depend on other packages that are not **Parameters** - * **libname** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – - * **pip\_install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **libname** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) + * **pip\_install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) **Return type** diff --git a/docs/api/qiskit/dev/index.mdx b/docs/api/qiskit/dev/index.mdx index ecbe59abad6..a093b7f5f63 100644 --- a/docs/api/qiskit/dev/index.mdx +++ b/docs/api/qiskit/dev/index.mdx @@ -56,5 +56,6 @@ Other: * [Compilation Routines (`qiskit.compiler`)](compiler) * [Top-level exceptions (`qiskit.exceptions`)](exceptions) +* [Root namespace (`qiskit`)](root) * [Utilities (`qiskit.utils`)](utils) diff --git a/docs/api/qiskit/dev/passmanager.mdx b/docs/api/qiskit/dev/passmanager.mdx index 332bafdd1d9..091ffe5f793 100644 --- a/docs/api/qiskit/dev/passmanager.mdx +++ b/docs/api/qiskit/dev/passmanager.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.passmanager --- + + - - # Passmanager `qiskit.passmanager` diff --git a/docs/api/qiskit/dev/primitives.mdx b/docs/api/qiskit/dev/primitives.mdx index 1139edc7f2b..4abde0b658f 100644 --- a/docs/api/qiskit/dev/primitives.mdx +++ b/docs/api/qiskit/dev/primitives.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.primitives --- + + - - # Primitives `qiskit.primitives` @@ -312,10 +312,10 @@ The formal distinction between the Primitives V1 and V2 APIs are the base classe ### Parameters V2 -| | | -| ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`ParameterLike`](qiskit.primitives.ParameterLike "qiskit.primitives.ParameterLike") | alias of [`Union`](https://docs.python.org/3/library/typing.html#typing.Union)\[[`Parameter`](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter"), [`str`](https://docs.python.org/3/library/stdtypes.html#str)] | -| [`BindingsArray`](qiskit.primitives.BindingsArray "qiskit.primitives.BindingsArray")(\[data, shape]) | Stores parameter binding value sets for a `qiskit.QuantumCircuit`. | +| | | +| ---------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | +| [`ParameterLike`](qiskit.primitives.ParameterLike "qiskit.primitives.ParameterLike") | | +| [`BindingsArray`](qiskit.primitives.BindingsArray "qiskit.primitives.BindingsArray")(\[data, shape]) | Stores parameter binding value sets for a `qiskit.QuantumCircuit`. | | | | | ------------------- | ------------------------------------------------------------------------- | @@ -323,14 +323,14 @@ The formal distinction between the Primitives V1 and V2 APIs are the base classe ### Estimator V2 -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2")() | Base class for `EstimatorV2` implementations. | -| [`StatevectorEstimator`](qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator")(\*\[, default\_precision, ...]) | Simple implementation of [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2") with full state vector simulation. | -| [`BackendEstimatorV2`](qiskit.primitives.BackendEstimatorV2 "qiskit.primitives.BackendEstimatorV2")(\*, backend\[, options]) | Evaluates expectation values for provided quantum circuit and observable combinations. | -| [`EstimatorPub`](qiskit.primitives.EstimatorPub "qiskit.primitives.EstimatorPub")(circuit, observables\[, ...]) | Primitive Unified Bloc for any Estimator primitive. | -| [`ObservablesArray`](qiskit.primitives.ObservablesArray "qiskit.primitives.ObservablesArray")(observables\[, num\_qubits, ...]) | An ND-array of Hermitian observables for an `Estimator` primitive. | -| [`ObservableLike`](qiskit.primitives.ObservableLike "qiskit.primitives.ObservableLike") | alias of [`Union`](https://docs.python.org/3/library/typing.html#typing.Union)\[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli"), [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp"), [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable"), [`Mapping`](https://docs.python.org/3/library/typing.html#typing.Mapping)\[[`Union`](https://docs.python.org/3/library/typing.html#typing.Union)\[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli")], [`float`](https://docs.python.org/3/library/functions.html#float)]] | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2")() | Base class for `EstimatorV2` implementations. | +| [`StatevectorEstimator`](qiskit.primitives.StatevectorEstimator "qiskit.primitives.StatevectorEstimator")(\*\[, default\_precision, ...]) | Simple implementation of [`BaseEstimatorV2`](qiskit.primitives.BaseEstimatorV2 "qiskit.primitives.BaseEstimatorV2") with full state vector simulation. | +| [`BackendEstimatorV2`](qiskit.primitives.BackendEstimatorV2 "qiskit.primitives.BackendEstimatorV2")(\*, backend\[, options]) | Evaluates expectation values for provided quantum circuit and observable combinations. | +| [`EstimatorPub`](qiskit.primitives.EstimatorPub "qiskit.primitives.EstimatorPub")(circuit, observables\[, ...]) | Primitive Unified Bloc for any Estimator primitive. | +| [`ObservablesArray`](qiskit.primitives.ObservablesArray "qiskit.primitives.ObservablesArray")(observables\[, num\_qubits, ...]) | An ND-array of Hermitian observables for an `Estimator` primitive. | +| [`ObservableLike`](qiskit.primitives.ObservableLike "qiskit.primitives.ObservableLike") | | | | | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/api/qiskit/dev/providers.mdx b/docs/api/qiskit/dev/providers.mdx index 240b65eab92..fc20c5200e6 100644 --- a/docs/api/qiskit/dev/providers.mdx +++ b/docs/api/qiskit/dev/providers.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.providers --- + + - - # Providers Interface `qiskit.providers` @@ -57,9 +57,9 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean ### Job Status -| | | -| ----------------------------------------------------------------------------- | ------------------------------------- | -| [`JobStatus`](qiskit.providers.JobStatus "qiskit.providers.JobStatus")(value) | Class for job status enumerated type. | +| | | +| -------------------------------------------------------------------------------- | ------------------------------------- | +| [`JobStatus`](qiskit.providers.JobStatus "qiskit.providers.JobStatus")(\*values) | Class for job status enumerated type. | ### Exceptions diff --git a/docs/api/qiskit/dev/providers_basic_provider.mdx b/docs/api/qiskit/dev/providers_basic_provider.mdx index 957b8f849d8..67d271053ad 100644 --- a/docs/api/qiskit/dev/providers_basic_provider.mdx +++ b/docs/api/qiskit/dev/providers_basic_provider.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.providers.basic_provider --- + + - - # BasicProvider: Python-based Simulators `qiskit.providers.basic_provider` diff --git a/docs/api/qiskit/dev/providers_fake_provider.mdx b/docs/api/qiskit/dev/providers_fake_provider.mdx index a8e5cf45110..80cf4fe28bf 100644 --- a/docs/api/qiskit/dev/providers_fake_provider.mdx +++ b/docs/api/qiskit/dev/providers_fake_provider.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.providers.fake_provider --- + + - - # Fake Provider `qiskit.providers.fake_provider` diff --git a/docs/api/qiskit/dev/qasm2.mdx b/docs/api/qiskit/dev/qasm2.mdx index 84170181d28..877a2aefe00 100644 --- a/docs/api/qiskit/dev/qasm2.mdx +++ b/docs/api/qiskit/dev/qasm2.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.qasm2 --- + + - - # OpenQASM 2 `qiskit.qasm2` @@ -123,11 +123,11 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i **Parameters** - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – - * **num\_params** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **constructor** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[Unpack],* [*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")*]*) – - * **builtin** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) + * **num\_params** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **constructor** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*Unpack*](https://docs.python.org/3/library/typing.html#typing.Unpack)*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*float*](https://docs.python.org/3/library/functions.html#float)*, ...]]],* [*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")*]*) + * **builtin** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) This can be particularly useful when trying to resolve ambiguities in the global-phase conventions of an OpenQASM 2 program. See [OpenQASM 2 Phase Conventions](#qasm2-phase-conventions) for more details. diff --git a/docs/api/qiskit/dev/qasm3.mdx b/docs/api/qiskit/dev/qasm3.mdx index f372e18a137..8014db31795 100644 --- a/docs/api/qiskit/dev/qasm3.mdx +++ b/docs/api/qiskit/dev/qasm3.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.qasm3 --- + + - - # OpenQASM 3 `qiskit.qasm3` @@ -61,7 +61,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object) QASM3 exporter main class. @@ -94,7 +94,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor If `True`, then bits may be contained in more than one register. If so, the registers will be emitted using “alias” definitions, which might not be well supported by consumers of OpenQASM 3. Defaults to `False` or the value of `alias_classical_registers`. - + * **indent** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – the indentation string to use for each level within an indented block. Can be set to the empty string to disable indentation. @@ -135,7 +135,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t #### ExperimentalFeatures - + Bases: [`Flag`](https://docs.python.org/3/library/enum.html#enum.Flag) Flags for experimental features that the OpenQASM 3 exporter supports. @@ -252,7 +252,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor [**QASM3ImporterError**](#qiskit.qasm3.QASM3ImporterError "qiskit.qasm3.QASM3ImporterError") – if the OpenQASM 3 file is invalid, or cannot be represented by a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). - + The `annotation_handlers` argument. This requires `qiskit_qasm3_import>=0.6.0`. @@ -301,7 +301,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor * [**QASM3ImporterError**](#qiskit.qasm3.QASM3ImporterError "qiskit.qasm3.QASM3ImporterError") – if the OpenQASM 3 file is invalid, or cannot be represented by a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError) – if number of qubits in qasm3\_ckt is more than num\_qubits. - + The `annotation_handlers` argument. This requires `qiskit_qasm3_import>=0.6.0`. diff --git a/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx b/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx index ca322f0bc4b..0f1b6b6c799 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.AnnotatedOperation.mdx @@ -156,7 +156,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation **Parameters** - **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)) – + **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.CircuitInstruction.mdx b/docs/api/qiskit/dev/qiskit.circuit.CircuitInstruction.mdx index f0c63ee295b..8a3e210b369 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.CircuitInstruction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.CircuitInstruction.mdx @@ -18,7 +18,7 @@ python_api_name: qiskit.circuit.CircuitInstruction Historically, [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") came first, and originally contained the qubits it operated on and any parameters, so it was a true “instruction”. Over time, [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") became responsible for tracking qubits and clbits, and the class became better described as an “operation”. Changing the name of such a core object would be a very unpleasant API break for users, and so we have stuck with it. - This class was created to provide a formal “instruction” context object in `QuantumCircuit.data`, which had long been made of ad-hoc tuples. With this, and the advent of the [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") interface for adding more complex objects to circuits, we took the opportunity to correct the historical naming. For the time being, this leads to an awkward case where [`CircuitInstruction.operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") is often an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instance ([`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") implements the [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") interface), but as the [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") interface gains more use, this confusion will hopefully abate. + This class was created to provide a formal “instruction” context object in [`QuantumCircuit.data`](qiskit.circuit.QuantumCircuit#data "qiskit.circuit.QuantumCircuit.data"), which had long been made of ad-hoc tuples. With this, and the advent of the [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") interface for adding more complex objects to circuits, we took the opportunity to correct the historical naming. For the time being, this leads to an awkward case where [`CircuitInstruction.operation`](#qiskit.circuit.CircuitInstruction.operation "qiskit.circuit.CircuitInstruction.operation") is often an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instance ([`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") implements the [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") interface), but as the [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") interface gains more use, this confusion will hopefully abate. diff --git a/docs/api/qiskit/dev/qiskit.circuit.CommutationChecker.mdx b/docs/api/qiskit/dev/qiskit.circuit.CommutationChecker.mdx index bbb7d86e91b..dfd25d49863 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.CommutationChecker.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.CommutationChecker.mdx @@ -33,9 +33,9 @@ $$ **Parameters** - * **standard\_gate\_commutations** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)) – - * **cache\_max\_entries** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **gates** (*Optional\[Set\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*]]*) – + * **standard\_gate\_commutations** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)) + * **cache\_max\_entries** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **gates** (*Optional\[Set\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*]]*) ### check\_commutation\_entries @@ -97,8 +97,8 @@ $$ **Parameters** - * **max\_num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float)) – + * **max\_num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx index 0ba18c9f697..3af99122798 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ControlFlowOp.mdx @@ -230,7 +230,7 @@ python_api_name: qiskit.circuit.ControlFlowOp ### replace\_blocks - + Return a new version of this control-flow operations with the [`blocks`](#qiskit.circuit.ControlFlowOp.blocks "qiskit.circuit.ControlFlowOp.blocks") mapped to the given new ones. Typically this is used in a workflow such as: diff --git a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx index 1edb6fab68d..8faafa33e91 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.ControlledGate.mdx @@ -288,7 +288,7 @@ python_api_name: qiskit.circuit.ControlledGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx index 087b381f644..83c2e8764d2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.InstructionSet.mdx @@ -66,7 +66,7 @@ python_api_name: qiskit.circuit.InstructionSet **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) diff --git a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx index 4c85d39d80a..c561d8c0c03 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.QuantumCircuit.mdx @@ -683,7 +683,7 @@ python_api_name: qiskit.circuit.QuantumCircuit * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Name for the copied circuit. If None, then the name stays the same. - * **vars\_mode** (*Literal\['alike', 'captures', 'drop']*) – + * **vars\_mode** ([*Literal*](https://docs.python.org/3/library/typing.html#typing.Literal)*\['alike', 'captures', 'drop']*) – The mode to handle realtime variables in. @@ -810,7 +810,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **bits** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable)*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – + **bits** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable)*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) **Return type** @@ -830,7 +830,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int) *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence)*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – + **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int) *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence)*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) **Return type** @@ -916,8 +916,9 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **name\_or\_var** – either a string name, or an existing [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node to use as the input variable. + * **name\_or\_var** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var")) – either a string name, or an existing [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node to use as the input variable. * **type** – if the name is given as a string, then this must be a [`Type`](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type") to use for the variable. If the variable is given as an existing [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var"), then this must not be given, and will instead be read from the object itself. + * **type\_** ([*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit._accelerate.circuit.classical.types.Type") *| None*) **Returns** @@ -926,6 +927,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if the variable cannot be created due to shadowing an existing variable. + + **Return type** + + [*Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit._accelerate.circuit.classical.expr.Var") #### add\_stretch @@ -1114,10 +1119,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **parameters** – Either a dictionary or iterable specifying the new parameter values. - * **inplace** – If False, a copy of the circuit with the bound parameters is returned. If True the circuit instance itself is modified. - * **flat\_input** – If `True` and `parameters` is a mapping type, it is assumed to be exactly a mapping of `{parameter: value}`. By default (`False`), the mapping may also contain [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") keys that point to a corresponding sequence of values, and these will be unrolled during the mapping, or string keys, which will be converted to [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances using [`get_parameter()`](#qiskit.circuit.QuantumCircuit.get_parameter "qiskit.circuit.QuantumCircuit.get_parameter"). - * **strict** – If `False`, any parameters given in the mapping that are not used in the circuit will be ignored. If `True` (the default), an error will be raised indicating a logic error. + * **parameters** ([*Mapping*](https://docs.python.org/3/library/typing.html#typing.Mapping)*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)*] |* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable)*\[*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)*]*) – Either a dictionary or iterable specifying the new parameter values. + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If False, a copy of the circuit with the bound parameters is returned. If True the circuit instance itself is modified. + * **flat\_input** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If `True` and `parameters` is a mapping type, it is assumed to be exactly a mapping of `{parameter: value}`. By default (`False`), the mapping may also contain [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") keys that point to a corresponding sequence of values, and these will be unrolled during the mapping, or string keys, which will be converted to [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances using [`get_parameter()`](#qiskit.circuit.QuantumCircuit.get_parameter "qiskit.circuit.QuantumCircuit.get_parameter"). + * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If `False`, any parameters given in the mapping that are not used in the circuit will be ignored. If `True` (the default), an error will be raised indicating a logic error. **Raises** @@ -1128,6 +1133,10 @@ python_api_name: qiskit.circuit.QuantumCircuit A copy of the circuit with bound parameters if `inplace` is False, otherwise None. + **Return type** + + [*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") | None + **Examples** Create a parameterized circuit and assign the parameters in-place. @@ -1206,8 +1215,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **name** – the name of the parameter to retrieve. - * **default** – if given, this value will be returned if the parameter is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError) is raised instead. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – the name of the parameter to retrieve. + * **default** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – if given, this value will be returned if the parameter is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError) is raised instead. **Returns** @@ -1217,6 +1226,10 @@ python_api_name: qiskit.circuit.QuantumCircuit [**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError) – if no default is given, but the parameter does not exist in the circuit. + **Return type** + + [*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter") + **Examples** Retrieve a parameter by name from a circuit: @@ -1278,8 +1291,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **name** – the name of the variable to retrieve. - * **default** – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError) is raised instead. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – the name of the variable to retrieve. + * **default** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError) is raised instead. **Returns** @@ -1328,8 +1341,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **name** – the name of the stretch to retrieve. - * **default** – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError) is raised instead. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – the name of the stretch to retrieve. + * **default** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError) is raised instead. **Returns** @@ -1374,8 +1387,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **name** – the name of the identifier to retrieve. - * **default** – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError) is raised instead. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – the name of the identifier to retrieve. + * **default** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – if given, this value will be returned if the variable is not present. If it is not given, a [`KeyError`](https://docs.python.org/3/library/exceptions.html#KeyError) is raised instead. **Returns** @@ -1657,6 +1670,8 @@ python_api_name: qiskit.circuit.QuantumCircuit * **cargs** – Legacy argument for clbits to attach the bare [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") to. Ignored if the first argument is in the preferential [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") form. + * **\_standard\_gate** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) + **Returns** a handle to the instruction that was just added. @@ -1800,8 +1815,8 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **other** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + * **other** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) As some rules of thumb: @@ -3589,7 +3604,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*qiskit.circuit.ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int)*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*qiskit.circuit.Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*int*](https://docs.python.org/3/library/functions.html#int)*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*qiskit.circuit.Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*bool*](https://docs.python.org/3/library/functions.html#bool)*]*) – A condition to be evaluated in real time at circuit execution, which, if true, will trigger the evaluation of `true_body`. Can be specified as either a tuple of a `ClassicalRegister` to be tested for equality with a given `int`, or as a tuple of a `Clbit` to be compared to either a `bool` or an `int`. + * **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int)*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*int*](https://docs.python.org/3/library/functions.html#int)*] |* [*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")*,* [*bool*](https://docs.python.org/3/library/functions.html#bool)*]*) – A condition to be evaluated in real time at circuit execution, which, if true, will trigger the evaluation of `true_body`. Can be specified as either a tuple of a `ClassicalRegister` to be tested for equality with a given `int`, or as a tuple of a `Clbit` to be compared to either a `bool` or an `int`. * **true\_body** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – The circuit body to be run if `condition` is true. * **false\_body** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – The circuit to be run if `condition` is false. * **qubits** ([*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence)*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*QuantumRegister*](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *|*[*int*](https://docs.python.org/3/library/functions.html#int) *|*[*slice*](https://docs.python.org/3/library/functions.html#slice) *|*[*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence)*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int)*]]*) – The circuit qubits over which the if/else should be run. @@ -3611,7 +3626,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### if\_test - + Create an `if` statement on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") with the given `true_body`, and there will be no branch for the `false` condition (see also the [`if_else()`](#qiskit.circuit.QuantumCircuit.if_else "qiskit.circuit.QuantumCircuit.if_else") method). However, if `true_body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which can be used to build `if` statements. The return value of the `with` statement is a chainable context manager, which can be used to create subsequent `else` blocks. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3712,7 +3727,7 @@ python_api_name: qiskit.circuit.QuantumCircuit #### while\_loop - + Create a `while` loop on this circuit. There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a `WhileLoopOp` with the given `body`. If `body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which will automatically build a `WhileLoopOp` when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you. @@ -3810,7 +3825,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*qiskit.\_accelerate.circuit.Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*,* [*Union*](https://docs.python.org/3/library/typing.html#typing.Union)*\[*[*qiskit.\_accelerate.circuit.ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression")*,* [*float*](https://docs.python.org/3/library/functions.html#float)*]] | None*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the instruction. If None, existing circuit parameters will also parameterize the instruction. + * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)*] | None*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the instruction. If None, existing circuit parameters will also parameterize the instruction. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. **Returns** @@ -3837,7 +3852,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*qiskit.\_accelerate.circuit.Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*,* [*Union*](https://docs.python.org/3/library/typing.html#typing.Union)*\[*[*qiskit.\_accelerate.circuit.ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression")*,* [*float*](https://docs.python.org/3/library/functions.html#float)*]] | None*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the gate. If `None`, existing circuit parameters will also parameterize the gate. + * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)*] | None*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the gate. If `None`, existing circuit parameters will also parameterize the gate. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. **Returns** @@ -4266,7 +4281,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **\*qubits** – Qubits within `self` to include. Integers are allowed for qubits, indicating - * **self.qubits.** (*indices of*) – + * **self.qubits.** (*indices of*) **Returns** @@ -4291,7 +4306,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** * **\*qubits** – Qubits within `self` to include. Integers are allowed for qubits, indicating - * **self.qubits.** (*indices of*) – + * **self.qubits.** (*indices of*) **Returns** @@ -4631,7 +4646,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **gates\_to\_decompose** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*] | Sequence\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]] | None*) – Optional subset of gates to decompose. Can be a gate type, such as `HGate`, or a gate name, such as “h”, or a gate label, such as “My H Gate”, or a list of any combination of these. If a gate name is entered, it will decompose all gates with that name, whether the gates have labels or not. Defaults to all gates in the circuit. + * **gates\_to\_decompose** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Type*](https://docs.python.org/3/library/typing.html#typing.Type)*\[*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")*] |* [*Sequence*](https://docs.python.org/3/library/typing.html#typing.Sequence)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Type*](https://docs.python.org/3/library/typing.html#typing.Type)*\[*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")*]] | None*) – Optional subset of gates to decompose. Can be a gate type, such as `HGate`, or a gate name, such as “h”, or a gate label, such as “My H Gate”, or a list of any combination of these. If a gate name is entered, it will decompose all gates with that name, whether the gates have labels or not. Defaults to all gates in the circuit. * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Optional number of times the circuit should be decomposed. For instance, `reps=2` equals calling `circuit.decompose().decompose()`. **Returns** @@ -4697,12 +4712,12 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **global\_phase** (*ParameterValueType*) – - * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict) *| None*) – - * **inputs** (*Iterable\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*]*) – - * **captures** (*Iterable\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") *|*[*expr.Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")*]*) – - * **declarations** (*Mapping\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*,* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")*] | Iterable\[Tuple\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*,* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")*]]*) – + * **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **global\_phase** (*ParameterValueType*) + * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict) *| None*) + * **inputs** (*Iterable\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*]*) + * **captures** (*Iterable\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") *|*[*expr.Stretch*](circuit_classical#qiskit.circuit.classical.expr.Stretch "qiskit.circuit.classical.expr.Stretch")*]*) + * **declarations** (*Mapping\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*,* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")*] | Iterable\[Tuple\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*,* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")*]]*) diff --git a/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx b/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx index 4c64d80584a..427bb87a327 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.SwitchCaseOp.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp * **target** ([*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") *|*[*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – the real-time value to switch on. * **cases** (*Iterable\[Tuple\[Any,* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]]*) – an ordered iterable of the corresponding value of the `target` and the circuit block that should be executed if this is matched. There is no fall-through between blocks, and the order matters. - * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*]*) ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx index 5bf97897193..18f44b63d02 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.AND.mdx @@ -37,7 +37,7 @@ python_api_name: qiskit.circuit.library.AND ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx index fbc95b40472..a4a2dd8143c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.C3SXGate.mdx @@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.library.C3SXGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx index a0feb864f6a..1ee68ac9af2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CDKMRippleCarryAdder.mdx @@ -97,7 +97,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx index 94279011ccc..d1a8e233b38 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CHGate.mdx @@ -285,7 +285,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### is\_parameterized diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx index 638ead883d0..46ca56c2218 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CPhaseGate.mdx @@ -48,9 +48,9 @@ $$ **Parameters** - * **theta** (*ParameterValueType*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – + * **theta** (*ParameterValueType*) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) ### base\_class @@ -231,7 +231,7 @@ $$ * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Ignored. **Returns** @@ -264,7 +264,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### is\_parameterized diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx index 7e9c3dd72d9..db8094714d9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRXGate.mdx @@ -69,9 +69,9 @@ $$ **Parameters** - * **theta** (*ParameterValueType*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **theta** (*ParameterValueType*) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx index 2424305e8ca..dc3e8999bcd 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRYGate.mdx @@ -69,9 +69,9 @@ $$ **Parameters** - * **theta** (*ParameterValueType*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **theta** (*ParameterValueType*) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx index d7198f7edc7..a9b725838cb 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CRZGate.mdx @@ -71,9 +71,9 @@ $$ **Parameters** - * **theta** (*ParameterValueType*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **theta** (*ParameterValueType*) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx index 1b5927b914c..921bafd6216 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CSXGate.mdx @@ -283,7 +283,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx index 381803f86f9..65d3fdf1bd5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU1Gate.mdx @@ -59,9 +59,9 @@ $$ **Parameters** - * **theta** (*ParameterValueType*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – + * **theta** (*ParameterValueType*) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) ### base\_class @@ -242,7 +242,7 @@ $$ * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Ignored. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx index 1791dc651b4..052049e1119 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CU3Gate.mdx @@ -85,11 +85,11 @@ $$ **Parameters** - * **theta** (*ParameterValueType*) – - * **phi** (*ParameterValueType*) – - * **lam** (*ParameterValueType*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **theta** (*ParameterValueType*) + * **phi** (*ParameterValueType*) + * **lam** (*ParameterValueType*) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx index f3aa657dbad..e1601eca822 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.CUGate.mdx @@ -75,12 +75,12 @@ $$ **Parameters** - * **theta** (*ParameterValueType*) – - * **phi** (*ParameterValueType*) – - * **lam** (*ParameterValueType*) – - * **gamma** (*ParameterValueType*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **theta** (*ParameterValueType*) + * **phi** (*ParameterValueType*) + * **lam** (*ParameterValueType*) + * **gamma** (*ParameterValueType*) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ### base\_class diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx index 40d61e6dc43..cc170e90a13 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Diagonal.mdx @@ -29,7 +29,7 @@ python_api_name: qiskit.circuit.library.Diagonal ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx index b495167d1f8..47a4d1fc82a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DiagonalGate.mdx @@ -229,7 +229,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### is\_parameterized diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx index c1264d885d9..20d30b9b755 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.DraperQFTAdder.mdx @@ -64,7 +64,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx index 52a92e44632..ffb9b7abe60 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.EfficientSU2.mdx @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The number of qubits of the EfficientSU2 circuit. * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. - * **su2\_gates** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](https://docs.python.org/3/library/functions.html#type) *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](https://docs.python.org/3/library/functions.html#type) *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The SU(2) single qubit gates to apply in single qubit gate layers. If only one gate is provided, the same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. + * **su2\_gates** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](qiskit.dagcircuit.DAGDepNode#type "qiskit.dagcircuit.DAGDepNode.type") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](qiskit.dagcircuit.DAGDepNode#type "qiskit.dagcircuit.DAGDepNode.type") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The SU(2) single qubit gates to apply in single qubit gate layers. If only one gate is provided, the same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int)*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]*) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’, ‘reverse\_linear’, ‘pairwise’, ‘circular’, or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. Defaults to ‘reverse\_linear’ entanglement. Note that ‘reverse\_linear’ entanglement provides the same unitary as ‘full’ with fewer entangling gates. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A QuantumCircuit object to prepend to the circuit. * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. @@ -82,7 +82,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) ## Attributes @@ -98,7 +98,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx index 3321a7f5f31..62f1f1193f1 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.EvolvedOperatorAnsatz.mdx @@ -72,7 +72,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx index 66964cf05d2..8b71f762f8b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ExactReciprocal.mdx @@ -36,7 +36,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx index eda70696150..a00aa0b9fae 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ExcitationPreserving.mdx @@ -96,7 +96,7 @@ $$ * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) **Raises** @@ -116,7 +116,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx index 06c56e0588d..8100907e8c3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FourierChecking.mdx @@ -50,7 +50,7 @@ python_api_name: qiskit.circuit.library.FourierChecking ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FullAdderGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.FullAdderGate.mdx index 906abe64bc9..2cef5ec1a28 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FullAdderGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FullAdderGate.mdx @@ -36,7 +36,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – The number of qubits in each of the registers. * **name** – The name of the circuit. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx index 72e5d4cb45c..253bf69785e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.FunctionalPauliRotations.mdx @@ -55,7 +55,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx index ac64eba8cc0..a204e1a9cdb 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GMS.mdx @@ -57,7 +57,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx index 68a579f8db3..53ed2044fbc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GR.mdx @@ -47,7 +47,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx index eb1046149ed..23a4855531d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRX.mdx @@ -48,7 +48,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx index a7ea0fe8c57..5119e834eeb 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRY.mdx @@ -48,7 +48,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx index 33b69549389..5be1719a3f7 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GRZ.mdx @@ -48,7 +48,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx index 0fc3220c903..f40659b843e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GraphState.mdx @@ -57,7 +57,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx index 24a0bfdb77b..0ef23276db5 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.GroverOperator.mdx @@ -190,7 +190,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx index aed0cad7e63..b14e8b024b4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HRSCumulativeMultiplier.mdx @@ -69,7 +69,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HalfAdderGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HalfAdderGate.mdx index 5ed0aca51af..3418ef65ac6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HalfAdderGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HalfAdderGate.mdx @@ -35,7 +35,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – The number of qubits in each of the registers. * **name** – The name of the circuit. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx index d78f65f15e0..7abf672c20e 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HamiltonianGate.mdx @@ -223,7 +223,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### is\_parameterized diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx index ebda3604aa7..9f18702bdcc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.HiddenLinearFunction.mdx @@ -59,7 +59,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx index dd47af06cf6..52a2376816c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IQP.mdx @@ -47,7 +47,7 @@ python_api_name: qiskit.circuit.library.IQP ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx index 32132ec5c4c..d29da33d352 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.InnerProduct.mdx @@ -56,7 +56,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx index 825ef5cb447..277493840a2 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.IntegerComparator.mdx @@ -62,7 +62,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx index 3cdea4fbde3..26ded6bd1fe 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearAmplitudeFunction.mdx @@ -69,7 +69,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx index 2d9936b5c4e..c8f55b3867c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.LinearPauliRotations.mdx @@ -70,7 +70,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx index 2afcc05bff1..68a236d05b8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMT.mdx @@ -57,7 +57,7 @@ python_api_name: qiskit.circuit.library.MCMT ### name - + A human-readable name for the circuit. **Example** @@ -89,7 +89,7 @@ python_api_name: qiskit.circuit.library.MCMT **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTGate.mdx index c14e2bf0a94..64a23bccf87 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTGate.mdx @@ -219,7 +219,7 @@ python_api_name: qiskit.circuit.library.MCMTGate * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Ignored. **Returns** @@ -252,7 +252,7 @@ python_api_name: qiskit.circuit.library.MCMTGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### is\_parameterized diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx index ecfa4edccf5..454f3e78386 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCMTVChain.mdx @@ -62,9 +62,9 @@ python_api_name: qiskit.circuit.library.MCMTVChain **Parameters** - * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*],* [*circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]*) – - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*],* [*circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]*) + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) ### num\_ancilla\_qubits @@ -74,7 +74,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain ### name - + A human-readable name for the circuit. **Example** @@ -100,7 +100,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx index 97411dac62f..8ede4f38092 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCPhaseGate.mdx @@ -40,10 +40,10 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Parameters** - * **lam** (*ParameterValueType*) – - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – + * **lam** (*ParameterValueType*) + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) ### base\_class @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Ignored. **Returns** @@ -257,7 +257,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### is\_parameterized diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx index a22a444ec2f..1d84d8b4a0b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGate.mdx @@ -21,9 +21,9 @@ python_api_name: qiskit.circuit.library.MCXGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ### base\_class @@ -249,8 +249,8 @@ python_api_name: qiskit.circuit.library.MCXGate **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx index 552436ad7a3..14183deef4d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXGrayCode.mdx @@ -21,9 +21,9 @@ python_api_name: qiskit.circuit.library.MCXGrayCode **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ### inverse diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx index e083549164e..95b98607dec 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXRecursive.mdx @@ -28,9 +28,9 @@ python_api_name: qiskit.circuit.library.MCXRecursive **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ### get\_num\_ancilla\_qubits @@ -39,8 +39,8 @@ python_api_name: qiskit.circuit.library.MCXRecursive **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) ### inverse diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx index 0d1ee01552b..7b083b18ec4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MCXVChain.mdx @@ -18,9 +18,9 @@ python_api_name: qiskit.circuit.library.MCXVChain * **dirty\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – when set to `True`, the method applies an optimized multicontrolled-X gate up to a relative phase using dirty ancillary qubits with the properties of lemmas 7 and 8 from arXiv:1501.06911, with at most 8\*k - 6 CNOT gates. For k within the range \{1, …, ceil(n/2)}. And for n representing the total number of qubits. * **relative\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – when set to `True`, the method applies the optimized multicontrolled-X gate up to a relative phase, in a way that, by lemma 7 of arXiv:1501.06911, the relative phases of the `action part` cancel out with the phases of the `reset part`. * **action\_only** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – when set to `True`, the method applies only the action part of lemma 8 from arXiv:1501.06911. - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ## Methods @@ -31,8 +31,8 @@ python_api_name: qiskit.circuit.library.MCXVChain **Parameters** - * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) ### inverse diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ModularAdderGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ModularAdderGate.mdx index c99abe17ecb..82378cacd01 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ModularAdderGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ModularAdderGate.mdx @@ -35,7 +35,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – The number of qubits in each of the registers. * **name** – The name of the circuit. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.MultiplierGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.MultiplierGate.mdx index dd237b365f2..8b720d25b7b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.MultiplierGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.MultiplierGate.mdx @@ -38,7 +38,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – The number of qubits in each of the input registers. * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The number of result qubits to limit the output to. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. * **name** – The name of the circuit. - * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) **Raises** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx index 87d597309a5..f1e0ecb28ab 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.NLocal.mdx @@ -220,7 +220,7 @@ python_api_name: qiskit.circuit.library.NLocal ### name - + A human-readable name for the circuit. **Example** @@ -280,8 +280,8 @@ python_api_name: qiskit.circuit.library.NLocal **Parameters** - * **parameters** ([*Mapping*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping)*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)*] |* [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)*]*) – - * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + * **parameters** ([*Mapping*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping)*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)*] |* [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)*]*) + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx index 48bd432696d..306b6cf8c33 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.OR.mdx @@ -37,7 +37,7 @@ python_api_name: qiskit.circuit.library.OR ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx index ef26e72a5b3..f639be4e833 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -271,7 +271,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### is\_parameterized @@ -392,7 +392,7 @@ $$ **Parameters** - **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)) – + **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx index e41f048209c..cb033e52c32 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliFeatureMap.mdx @@ -110,7 +110,7 @@ $$ * **data\_map\_func** (*Optional\[Callable\[\[np.ndarray],* [*float*](https://docs.python.org/3/library/functions.html#float)*]]*) – A mapping function for data x which can be supplied to override the default mapping from `self_product()`. * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – The prefix used if default parameters are generated. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If True, barriers are inserted in between the evolution instructions and Hadamard layers. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) ## Attributes @@ -162,7 +162,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx index 23e239b913b..ff6ea293a23 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliGate.mdx @@ -212,7 +212,7 @@ python_api_name: qiskit.circuit.library.PauliGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### is\_parameterized diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx index d4d4e17aebc..eb0607b3575 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PauliTwoDesign.mdx @@ -65,7 +65,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Specifies how often a block consisting of a rotation layer and entanglement layer is repeated. * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The seed for randomly choosing the axes of the Pauli rotations. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) ## Attributes @@ -81,7 +81,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx index e600062f4b6..7c17ac8b17d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.Permutation.mdx @@ -39,7 +39,7 @@ python_api_name: qiskit.circuit.library.Permutation ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx index 2b845d51cb6..f16c0c0b1a9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PermutationGate.mdx @@ -223,7 +223,7 @@ python_api_name: qiskit.circuit.library.PermutationGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx index 4591514febe..37d78612feb 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseEstimation.mdx @@ -52,7 +52,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx index 7f1c1772b03..00d038d99c4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseGate.mdx @@ -209,7 +209,7 @@ $$ * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`. - * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Ignored. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx index 7586bc6272e..bfd30811c51 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PhaseOracle.mdx @@ -38,7 +38,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx index de6b61ddab0..406ecb1a3e8 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseChebyshev.mdx @@ -106,7 +106,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx index 9cd777e058b..aa4c213c46c 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewiseLinearPauliRotations.mdx @@ -91,7 +91,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx index 9b971d4bf83..f74cbbb330a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PiecewisePolynomialPauliRotations.mdx @@ -123,7 +123,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx index 4201d1e6a27..4867adafc21 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.PolynomialPauliRotations.mdx @@ -73,7 +73,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx index bccd2f0b59a..8b47c47ff6b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QAOAAnsatz.mdx @@ -100,7 +100,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx index 362ef777830..e606628b448 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QFT.mdx @@ -92,7 +92,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx index 4630c50212f..b25df42a079 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticForm.mdx @@ -58,7 +58,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticFormGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticFormGate.mdx index d1bc8f2e6de..e81f520e05a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticFormGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuadraticFormGate.mdx @@ -43,10 +43,10 @@ $$ * **num\_qubits** – The number of qubits the gate acts on. * **params** – A list of parameters. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – An optional label for the gate. - * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – - * **quadratic** (*Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float)*]] | None*) – - * **linear** (*Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float)*]] | None*) – - * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) + * **quadratic** (*Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float)*]] | None*) + * **linear** (*Sequence\[Sequence\[*[*float*](https://docs.python.org/3/library/functions.html#float)*]] | None*) + * **offset** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx index 6a13555ea72..8878781afd0 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.QuantumVolume.mdx @@ -45,7 +45,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx index 1575904f85a..995659641c3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RGQFTMultiplier.mdx @@ -48,7 +48,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx index cfab47461d1..4a9c39958c9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RVGate.mdx @@ -233,7 +233,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### is\_parameterized diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx index 37e6ec58d2f..6752d3789ed 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RZGate.mdx @@ -49,7 +49,7 @@ $$ * **theta** – The rotation angle. * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*]*) – An optional label for the gate. - * **phi** (*ParameterValueType*) – + * **phi** (*ParameterValueType*) ## Attributes diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx index 675b78b774f..2c2c49fd8f4 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.RealAmplitudes.mdx @@ -121,7 +121,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) ## Attributes @@ -137,7 +137,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx index bd7fe7d7b33..ff8afc0e564 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SGate.mdx @@ -189,7 +189,7 @@ $$ * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`. Ignored if the controlled gate is implemented as an annotated operation. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`. * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Indicates whether the controlled gate should be implemented as a controlled gate or as an annotated operation. If `None`, treated as `False`. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx index b7eb5729276..727fa51aee3 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.SdgGate.mdx @@ -189,7 +189,7 @@ $$ * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`. Ignored if the controlled gate is implemented as an annotated operation. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`. * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Indicates whether the controlled gate should be implemented as a controlled gate or as an annotated operation. If `None`, treated as `False`. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx index 4a5caf660e9..a208230d623 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.StatePreparation.mdx @@ -224,7 +224,7 @@ python_api_name: qiskit.circuit.library.StatePreparation **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### is\_parameterized diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx index 8866132edbe..22f9fc3a9e9 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.TwoLocal.mdx @@ -118,8 +118,8 @@ python_api_name: qiskit.circuit.library.TwoLocal **Parameters** * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The number of qubits of the two-local circuit. - * **rotation\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](https://docs.python.org/3/library/functions.html#type) *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](https://docs.python.org/3/library/functions.html#type) *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The gates used in the rotation layer. Can be specified via the name of a gate (e.g. `'ry'`) or the gate type itself (e.g. [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate")). If only one gate is provided, the gate same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. See the Examples section for more detail. - * **entanglement\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](https://docs.python.org/3/library/functions.html#type) *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](https://docs.python.org/3/library/functions.html#type) *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The gates used in the entanglement layer. Can be specified in the same format as `rotation_blocks`. + * **rotation\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](qiskit.dagcircuit.DAGDepNode#type "qiskit.dagcircuit.DAGDepNode.type") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](qiskit.dagcircuit.DAGDepNode#type "qiskit.dagcircuit.DAGDepNode.type") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The gates used in the rotation layer. Can be specified via the name of a gate (e.g. `'ry'`) or the gate type itself (e.g. [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate")). If only one gate is provided, the gate same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. See the Examples section for more detail. + * **entanglement\_blocks** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](qiskit.dagcircuit.DAGDepNode#type "qiskit.dagcircuit.DAGDepNode.type") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*type*](qiskit.dagcircuit.DAGDepNode#type "qiskit.dagcircuit.DAGDepNode.type") *|*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] | None*) – The gates used in the entanglement layer. Can be specified in the same format as `rotation_blocks`. * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int)*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]*) – Specifies the entanglement structure. Can be a string (`'full'`, `'linear'`, `'reverse_linear'`, `'circular'` or `'sca'`), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. Default to `'full'` entanglement. Note that if `entanglement_blocks = 'cx'`, then `'full'` entanglement provides the same unitary as `'reverse_linear'` but the latter option has fewer entangling gates. See the Examples section for more detail. * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Specifies how often a block consisting of a rotation layer and entanglement layer is repeated. * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If `True`, the single qubit gates are only applied to qubits that are entangled with another qubit. If `False`, the single qubit gates are applied to each qubit in the ansatz. Defaults to `False`. @@ -128,13 +128,13 @@ python_api_name: qiskit.circuit.library.TwoLocal * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object to prepend to the circuit. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) ## Attributes ### name - + A human-readable name for the circuit. **Example** @@ -160,9 +160,9 @@ python_api_name: qiskit.circuit.library.TwoLocal **Parameters** - * **rep\_num** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **block\_num** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **num\_block\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – + * **rep\_num** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **block\_num** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **num\_block\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx index 15708dc239a..d1376e49588 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UCGate.mdx @@ -234,7 +234,7 @@ $$ **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx index 7d3bb812dff..8e4eb79873b 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryGate.mdx @@ -199,7 +199,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`. Ignored if the controlled gate is implemented as an annotated operation. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`. + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1`. * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Indicates whether the controlled gate should be implemented as a controlled gate or as an annotated operation. If `None`, treated as `False`. **Returns** @@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate **Parameters** - **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### is\_parameterized diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx index cb2b95f5d5e..0f178415d88 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.UnitaryOverlap.mdx @@ -67,7 +67,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx index 2436ff5d79b..c0002ef6fd6 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.VBERippleCarryAdder.mdx @@ -69,7 +69,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx index ef8cfd627a6..46941de9daf 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.WeightedAdder.mdx @@ -118,7 +118,7 @@ $$ ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx index 5900f075983..4210ad5aefc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XGate.mdx @@ -202,7 +202,7 @@ $$ * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Number of controls to add. Defauls to `1`. * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Optional gate label. Defaults to `None`. - * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – The control state of the gate, specified either as an integer or a bitstring (e.g. `"110"`). If `None`, defaults to the all-ones state `2**num_ctrl_qubits - 1` * **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Ignored. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx index 38733d5257a..0507a8d642a 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.XOR.mdx @@ -39,7 +39,7 @@ python_api_name: qiskit.circuit.library.XOR ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx index 230f62a5665..2e61a80eccc 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZFeatureMap.mdx @@ -79,13 +79,13 @@ python_api_name: qiskit.circuit.library.ZFeatureMap * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)*],* [*float*](https://docs.python.org/3/library/functions.html#float)*] | None*) – A mapping function for data x which can be supplied to override the default mapping from `self_product()`. * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – The prefix used if default parameters are generated. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If True, barriers are inserted in between the evolution instructions and hadamard layers. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) ## Attributes ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx index ac0d42f9a86..13477b0700d 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.ZZFeatureMap.mdx @@ -96,7 +96,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)*],* [*float*](https://docs.python.org/3/library/functions.html#float)*] | None*) – A mapping function for data x. * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – The prefix used if default parameters are generated. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If True, barriers are inserted in between the evolution instructions and hadamard layers. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) **Raises** @@ -106,7 +106,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap ### name - + A human-readable name for the circuit. **Example** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.fourier_checking.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.fourier_checking.mdx index b0eeb9088d1..77df68f3563 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.fourier_checking.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.fourier_checking.mdx @@ -39,8 +39,8 @@ python_api_name: qiskit.circuit.library.fourier_checking **Parameters** - * **f** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]*) – - * **g** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]*) – + * **f** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]*) + * **g** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]*) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.pauli_feature_map.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.pauli_feature_map.mdx index e9db0487bc0..9780fcab442 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.pauli_feature_map.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.pauli_feature_map.mdx @@ -98,15 +98,15 @@ $$ **Parameters** - * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Mapping*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*,* [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]] |* [*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*int*](https://docs.python.org/3/library/functions.html#int)*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Mapping*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*,* [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]]]*) – - * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float)) – - * **paulis** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*] | None*) – - * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression")*] | None*) – - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Mapping*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*,* [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]] |* [*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*int*](https://docs.python.org/3/library/functions.html#int)*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Mapping*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*,* [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]]]*) + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float)) + * **paulis** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*] | None*) + * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression")*] | None*) + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.z_feature_map.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.z_feature_map.mdx index f5373e139bc..0e9ca2dc78f 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.z_feature_map.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.z_feature_map.mdx @@ -72,14 +72,14 @@ python_api_name: qiskit.circuit.library.z_feature_map **Parameters** - * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]] |* [*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*int*](https://docs.python.org/3/library/functions.html#int)*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]]*) – - * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float)) – - * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression")*] | None*) – - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]] |* [*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*int*](https://docs.python.org/3/library/functions.html#int)*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]]*) + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float)) + * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression")*] | None*) + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.circuit.library.zz_feature_map.mdx b/docs/api/qiskit/dev/qiskit.circuit.library.zz_feature_map.mdx index d9e78831f72..cb9ae05bf75 100644 --- a/docs/api/qiskit/dev/qiskit.circuit.library.zz_feature_map.mdx +++ b/docs/api/qiskit/dev/qiskit.circuit.library.zz_feature_map.mdx @@ -66,14 +66,14 @@ python_api_name: qiskit.circuit.library.zz_feature_map **Parameters** - * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]] |* [*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*int*](https://docs.python.org/3/library/functions.html#int)*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]]*) – - * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float)) – - * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression")*] | None*) – - * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – - * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]] |* [*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*int*](https://docs.python.org/3/library/functions.html#int)*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]]*) + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float)) + * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit._accelerate.circuit.ParameterExpression")*] | None*) + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.BlockCollector.mdx b/docs/api/qiskit/dev/qiskit.dagcircuit.BlockCollector.mdx index 2df0990d5b4..b682a0dc108 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.BlockCollector.mdx +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.BlockCollector.mdx @@ -46,12 +46,12 @@ python_api_name: qiskit.dagcircuit.BlockCollector **Parameters** - * **filter\_fn** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – - * **max\_block\_width** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – + * **filter\_fn** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) + * **max\_block\_width** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list)\[[qiskit.\_accelerate.circuit.DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit._accelerate.circuit.DAGOpNode") | [qiskit.dagcircuit.dagdepnode.DAGDepNode](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.dagdepnode.DAGDepNode")] + [list](https://docs.python.org/3/library/stdtypes.html#list)\[[*DAGOpNode*](qiskit.dagcircuit.DAGOpNode "qiskit._accelerate.circuit.DAGOpNode") | [*DAGDepNode*](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.dagdepnode.DAGDepNode")] diff --git a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx index 6a924fad25d..9eece55428a 100644 --- a/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/dev/qiskit.dagcircuit.DAGDepNode.mdx @@ -19,14 +19,14 @@ python_api_name: qiskit.dagcircuit.DAGDepNode **Parameters** - * **successors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) – - * **predecessors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) – - * **matchedwith** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) – - * **successorstovisit** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) – - * **isblocked** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – - * **qindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) – - * **cindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) – - * **nid** ([*int*](https://docs.python.org/3/library/functions.html#int)) – + * **successors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) + * **predecessors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) + * **matchedwith** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) + * **successorstovisit** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) + * **isblocked** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) + * **qindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) + * **cindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*] | None*) + * **nid** ([*int*](https://docs.python.org/3/library/functions.html#int)) ### type diff --git a/docs/api/qiskit/dev/qiskit.passmanager.BaseController.mdx b/docs/api/qiskit/dev/qiskit.passmanager.BaseController.mdx index 3b11fb2d98e..60a68b99ecf 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.BaseController.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.BaseController.mdx @@ -32,7 +32,7 @@ python_api_name: qiskit.passmanager.BaseController * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,12 +40,12 @@ python_api_name: qiskit.passmanager.BaseController **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### iter\_tasks - + A custom logic to choose a next task to run. Controller subclass can consume the state to build a proper task pipeline. The updated state after a task execution will be fed back in as the “return” value of any `yield` statements. This indicates the order of task execution is only determined at running time. This method is not allowed to mutate the given state object. diff --git a/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx b/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx index ba951ae98be..4e6b71bc3d6 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.BasePassManager.mdx @@ -29,7 +29,7 @@ python_api_name: qiskit.passmanager.BasePassManager **Parameters** - **tasks** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[qiskit.passmanager.base\_tasks.Task]*) – A set of pass manager tasks to be added to schedule. + **tasks** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[Task]*) – A set of pass manager tasks to be added to schedule. **Raises** @@ -66,7 +66,7 @@ python_api_name: qiskit.passmanager.BasePassManager **Parameters** * **index** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Task index to replace, based on the position in `tasks()` - * **tasks** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[qiskit.passmanager.base\_tasks.Task]*) – A set of pass manager tasks to be added to schedule. + * **tasks** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[Task]*) – A set of pass manager tasks to be added to schedule. **Raises** @@ -87,7 +87,7 @@ python_api_name: qiskit.passmanager.BasePassManager * **in\_programs** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any) *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any)*]*) – Input programs to transform via all the registered passes. A single input object cannot be a Python builtin list object. A list object is considered as multiple input objects to optimize. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable) *| None*) – + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function that will be called after each pass execution. The function will be called with 4 keyword arguments: @@ -113,7 +113,7 @@ python_api_name: qiskit.passmanager.BasePassManager ... ``` - * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The maximum number of parallel processes to launch if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. + * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int)) – The maximum number of parallel processes to launch if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. * **property\_set** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*,* [*object*](https://docs.python.org/3/library/functions.html#object)*] | None*) – If given, the initial value to use as the [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") for the pass manager pipeline. This can be used to persist analysis from one run to another, in cases where you know the analysis is safe to share. Beware that some analysis will be specific to the input circuit and the particular [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target"), so you should take a lot of care when using this argument. diff --git a/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx b/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx index 84177b34387..21a734123f0 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.ConditionalController.mdx @@ -18,8 +18,8 @@ python_api_name: qiskit.passmanager.ConditionalController **Parameters** * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*, Any] | None*) – Option for this flow controller. - * **tasks** (*Task | Iterable\[Task]*) – - * **condition** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool)*]*) – + * **tasks** (*Task | Iterable\[Task]*) + * **condition** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool)*]*) ## Attributes @@ -40,7 +40,7 @@ python_api_name: qiskit.passmanager.ConditionalController * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -48,7 +48,7 @@ python_api_name: qiskit.passmanager.ConditionalController **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### iter\_tasks diff --git a/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx b/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx index 606150fba36..73b5307c452 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.DoWhileController.mdx @@ -20,8 +20,8 @@ python_api_name: qiskit.passmanager.DoWhileController **Parameters** * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*, Any] | None*) – Option for this flow controller. - * **tasks** (*Task | Iterable\[Task]*) – - * **do\_while** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool)*]*) – + * **tasks** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[Task]*) + * **do\_while** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool)*]*) ## Attributes @@ -42,7 +42,7 @@ python_api_name: qiskit.passmanager.DoWhileController * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.passmanager.DoWhileController **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### iter\_tasks diff --git a/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx b/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx index 4431c0973fb..374e1eb7011 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.FlowControllerLinear.mdx @@ -18,7 +18,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear **Parameters** * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*, Any] | None*) – Option for this flow controller. - * **tasks** (*Task | Iterable\[Task]*) – + * **tasks** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[Task]*) ## Attributes @@ -39,7 +39,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -47,7 +47,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### iter\_tasks diff --git a/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.mdx b/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.mdx index bba6f29f5db..0cca0d20400 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.GenericPass.mdx @@ -26,7 +26,7 @@ python_api_name: qiskit.passmanager.GenericPass * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -34,7 +34,7 @@ python_api_name: qiskit.passmanager.GenericPass **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -49,7 +49,7 @@ python_api_name: qiskit.passmanager.GenericPass ### run - + Run optimization task. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx b/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx index 579bbd102a1..175b660aa3c 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.PassManagerState.mdx @@ -21,8 +21,8 @@ python_api_name: qiskit.passmanager.PassManagerState **Parameters** - * **workflow\_status** ([*WorkflowStatus*](qiskit.passmanager.WorkflowStatus "qiskit.passmanager.compilation_status.WorkflowStatus")) – - * **property\_set** ([*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.compilation_status.PropertySet")) – + * **workflow\_status** ([*WorkflowStatus*](qiskit.passmanager.WorkflowStatus "qiskit.passmanager.compilation_status.WorkflowStatus")) + * **property\_set** ([*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.compilation_status.PropertySet")) ### workflow\_status diff --git a/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.mdx b/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.mdx index 9e679ce9951..fc26ebcf920 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.PropertySet.mdx @@ -17,15 +17,19 @@ python_api_name: qiskit.passmanager.PropertySet ### clear - + + Remove all items from the dict. + ### copy - + + Return a shallow copy of the dict. + ### fromkeys - + Create a new dictionary with keys from iterable and values set to value. @@ -37,11 +41,15 @@ python_api_name: qiskit.passmanager.PropertySet ### items - + + Return a set-like object providing a view on the dict’s items. + ### keys - + + Return a set-like object providing a view on the dict’s keys. + ### pop @@ -67,12 +75,14 @@ python_api_name: qiskit.passmanager.PropertySet ### update - - If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] + + If E is present and has a .keys() method, then does: for k in E.keys(): D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] ### values - + + Return an object providing a view on the dict’s values. + diff --git a/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx b/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx index a45e01d2193..cf492c79ce0 100644 --- a/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx +++ b/docs/api/qiskit/dev/qiskit.passmanager.WorkflowStatus.mdx @@ -19,9 +19,9 @@ python_api_name: qiskit.passmanager.WorkflowStatus **Parameters** - * **count** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **completed\_passes** ([*set*](https://docs.python.org/3/library/stdtypes.html#set)) – - * **previous\_run** (*RunState*) – + * **count** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **completed\_passes** ([*set*](https://docs.python.org/3/library/stdtypes.html#set)) + * **previous\_run** (*RunState*) ### count diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimatorV2.mdx b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimatorV2.mdx index b110231f3d0..a8634090f76 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendEstimatorV2.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendEstimatorV2.mdx @@ -63,7 +63,7 @@ $$ **Parameters** - * **pubs** ([*Iterable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable)*\[EstimatorPubLike]*) – An iterable of pub-like objects, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`. + * **pubs** ([*Iterable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable)*\[TypeAliasForwardRef('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) *| None*) – The target precision for expectation value estimates of each run Estimator Pub that does not specify its own precision. If None the estimator’s default precision value will be used. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BackendSamplerV2.mdx b/docs/api/qiskit/dev/qiskit.primitives.BackendSamplerV2.mdx index 0e87454326f..6753c40bf95 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BackendSamplerV2.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BackendSamplerV2.mdx @@ -57,7 +57,7 @@ python_api_name: qiskit.primitives.BackendSamplerV2 **Parameters** - * **pubs** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable)*\[SamplerPubLike]*) – An iterable of pub-like objects. For example, a list of circuits or tuples `(circuit, parameter_values)`. + * **pubs** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable)*\[TypeAliasForwardRef('SamplerPubLike')]*) – An iterable of pub-like objects. For example, a list of circuits or tuples `(circuit, parameter_values)`. * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The total number of shots to sample for each sampler pub that does not specify its own shots. If `None`, the primitive’s default shots value will be used, which can vary by implementation. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx index e4d83064eff..176038dca85 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseEstimatorV2.mdx @@ -40,7 +40,7 @@ python_api_name: qiskit.primitives.BaseEstimatorV2 ### run - + Estimate expectation values for each provided pub (Primitive Unified Bloc). **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BasePrimitiveJob.mdx b/docs/api/qiskit/dev/qiskit.primitives.BasePrimitiveJob.mdx index 8228a7402ea..3335044040f 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BasePrimitiveJob.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BasePrimitiveJob.mdx @@ -45,13 +45,13 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### cancel - + Attempt to cancel the job. ### cancelled - + Return whether the job has been cancelled. **Return type** @@ -61,7 +61,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### done - + Return whether the job has successfully run. **Return type** @@ -71,7 +71,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### in\_final\_state - + Return whether the job is in a final job state such as `DONE` or `ERROR`. **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### result - + Return the results of the job. **Return type** @@ -101,7 +101,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### running - + Return whether the job is actively running. **Return type** @@ -111,7 +111,7 @@ python_api_name: qiskit.primitives.BasePrimitiveJob ### status - + Return the status of the job. **Return type** @@ -121,6 +121,6 @@ python_api_name: qiskit.primitives.BasePrimitiveJob **Parameters** - **job\_id** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + **job\_id** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) diff --git a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx index c7bc91c3bad..84463685492 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BaseSamplerV2.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.primitives.BaseSamplerV2 ### run - + Run and collect samples from each pub. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BindingsArray.mdx b/docs/api/qiskit/dev/qiskit.primitives.BindingsArray.mdx index f465f0561a3..61505484dfc 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BindingsArray.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BindingsArray.mdx @@ -152,7 +152,7 @@ python_api_name: qiskit.primitives.BindingsArray **Parameters** - **bindings\_array** ([*Mapping*](https://docs.python.org/3/library/typing.html#typing.Mapping)*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Tuple*](https://docs.python.org/3/library/typing.html#typing.Tuple)*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*, ...], \_SupportsArray\[*[*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any)*]] | \_NestedSequence\[\_SupportsArray\[*[*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any)*]]] |* [*bool*](https://docs.python.org/3/library/functions.html#bool) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *|*[*float*](https://docs.python.org/3/library/functions.html#float) *|*[*complex*](https://docs.python.org/3/library/functions.html#complex) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes) *| \_NestedSequence\[*[*bool*](https://docs.python.org/3/library/functions.html#bool) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *|*[*float*](https://docs.python.org/3/library/functions.html#float) *|*[*complex*](https://docs.python.org/3/library/functions.html#complex) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes)*]]*) – An object to be bindings array. + **bindings\_array** ([*Mapping*](https://docs.python.org/3/library/typing.html#typing.Mapping)*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Tuple*](https://docs.python.org/3/library/typing.html#typing.Tuple)*\[*[*Parameter*](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*, ...], ArrayLike]*) – An object to be bindings array. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.primitives.BitArray.mdx b/docs/api/qiskit/dev/qiskit.primitives.BitArray.mdx index 5ec3dd1d869..5e2bed9cb17 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.BitArray.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.BitArray.mdx @@ -15,7 +15,7 @@ python_api_name: qiskit.primitives.BitArray This object contains a single, contiguous block of data that represents an array of bitstrings. The last axis is over packed bits, the second last axis is over shots, and the preceding axes correspond to the shape of the pub that was executed to sample these bits. - You typically get this object back as one part of a [`DataBin`](qiskit.primitives.DataBin "qiskit.primitives.DataBin") accessed through a single `PubResult.data`. Users do not typically create this class themselves, however if you have bitstring-like data in an alternate form that you would like to convert to a [`BitArray`](#qiskit.primitives.BitArray "qiskit.primitives.BitArray"), you can use one of [`from_bool_array()`](#qiskit.primitives.BitArray.from_bool_array "qiskit.primitives.BitArray.from_bool_array"), [`from_counts()`](#qiskit.primitives.BitArray.from_counts "qiskit.primitives.BitArray.from_counts") or [`from_samples()`](#qiskit.primitives.BitArray.from_samples "qiskit.primitives.BitArray.from_samples"). + You typically get this object back as one part of a [`DataBin`](qiskit.primitives.DataBin "qiskit.primitives.DataBin") accessed through a single [`PubResult.data`](qiskit.primitives.PubResult#data "qiskit.primitives.PubResult.data"). Users do not typically create this class themselves, however if you have bitstring-like data in an alternate form that you would like to convert to a [`BitArray`](#qiskit.primitives.BitArray "qiskit.primitives.BitArray"), you can use one of [`from_bool_array()`](#qiskit.primitives.BitArray.from_bool_array "qiskit.primitives.BitArray.from_bool_array"), [`from_counts()`](#qiskit.primitives.BitArray.from_counts "qiskit.primitives.BitArray.from_counts") or [`from_samples()`](#qiskit.primitives.BitArray.from_samples "qiskit.primitives.BitArray.from_samples"). You can “unpack” the bitstrings into expanded array of [`bool`](https://docs.python.org/3/library/functions.html#bool) by using the [`to_bool_array()`](#qiskit.primitives.BitArray.to_bool_array "qiskit.primitives.BitArray.to_bool_array") method. @@ -82,7 +82,7 @@ python_api_name: qiskit.primitives.BitArray **Return type** - [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)\[*uint64*]] + [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), …], [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)\[*uint64*]] ### concatenate @@ -174,7 +174,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - **observables** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp") *|*[*SparseObservable*](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") *|*[*Mapping*](https://docs.python.org/3/library/typing.html#typing.Mapping)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli")*,* [*float*](https://docs.python.org/3/library/functions.html#float)*] | \_SupportsArray\[*[*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any)*]] | \_NestedSequence\[\_SupportsArray\[*[*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any)*]]] |* [*bool*](https://docs.python.org/3/library/functions.html#bool) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *|*[*float*](https://docs.python.org/3/library/functions.html#float) *|*[*complex*](https://docs.python.org/3/library/functions.html#complex) *|*[*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes) *| \_NestedSequence\[*[*bool*](https://docs.python.org/3/library/functions.html#bool) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *|*[*float*](https://docs.python.org/3/library/functions.html#float) *|*[*complex*](https://docs.python.org/3/library/functions.html#complex) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes)*]*) – The observable(s) to take the expectation value of. Must have a shape broadcastable with with this bit array and the same number of qubits as the number of bits of this bit array. The observables must be diagonal (I, Z, 0 or 1) too. + **observables** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp") *|*[*SparseObservable*](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") *|*[*Mapping*](https://docs.python.org/3/library/typing.html#typing.Mapping)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli")*,* [*float*](https://docs.python.org/3/library/functions.html#float)*] | ArrayLike*) – The observable(s) to take the expectation value of. Must have a shape broadcastable with with this bit array and the same number of qubits as the number of bits of this bit array. The observables must be diagonal (I, Z, 0 or 1) too. **Returns** @@ -188,7 +188,7 @@ python_api_name: qiskit.primitives.BitArray **Return type** - [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)\[*float64*]] + [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), …], [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)\[*float64*]] ### from\_bool\_array @@ -198,7 +198,7 @@ python_api_name: qiskit.primitives.BitArray **Parameters** - * **array** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any)*,* [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)*\[bool\_]]*) – The array to convert, with “bitstrings” along the last axis. + * **array** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)*\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any)*, ...],* [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)*\[*[*bool*](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool)*]]*) – The array to convert, with “bitstrings” along the last axis. * **order** ([*Literal*](https://docs.python.org/3/library/typing.html#typing.Literal)*\['big', 'little']*) – One of `"big"` or `"little"`, indicating whether `array[..., 0]` correspond to the most significant bits or the least significant bits of each bitstring, respectively. **Returns** @@ -439,7 +439,7 @@ python_api_name: qiskit.primitives.BitArray **Return type** - [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)\[*bool\_*]] + [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), …], [*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)\[[*bool*](https://numpy.org/doc/stable/reference/arrays.scalars.html#numpy.bool)]] ### transpose diff --git a/docs/api/qiskit/dev/qiskit.primitives.ObservableLike.mdx b/docs/api/qiskit/dev/qiskit.primitives.ObservableLike.mdx index c134dfc9e5c..71cbeb35224 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.ObservableLike.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.ObservableLike.mdx @@ -11,6 +11,6 @@ python_api_name: qiskit.primitives.ObservableLike # ObservableLike - alias of [`Union`](https://docs.python.org/3/library/typing.html#typing.Union)\[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli"), [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp"), [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable"), [`Mapping`](https://docs.python.org/3/library/typing.html#typing.Mapping)\[[`Union`](https://docs.python.org/3/library/typing.html#typing.Union)\[[`str`](https://docs.python.org/3/library/stdtypes.html#str), [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli")], [`float`](https://docs.python.org/3/library/functions.html#float)]] + alias of [`str`](https://docs.python.org/3/library/stdtypes.html#str) | [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli") | [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp") | [`SparseObservable`](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") | [`Mapping`](https://docs.python.org/3/library/typing.html#typing.Mapping)\[[`str`](https://docs.python.org/3/library/stdtypes.html#str) | [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli"), [`float`](https://docs.python.org/3/library/functions.html#float)] diff --git a/docs/api/qiskit/dev/qiskit.primitives.ObservablesArray.mdx b/docs/api/qiskit/dev/qiskit.primitives.ObservablesArray.mdx index 73d03204ef7..0f8b77cb401 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.ObservablesArray.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.ObservablesArray.mdx @@ -80,7 +80,7 @@ python_api_name: qiskit.primitives.ObservablesArray **Parameters** - **observables** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp") *|*[*SparseObservable*](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") *|*[*Mapping*](https://docs.python.org/3/library/typing.html#typing.Mapping)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli")*,* [*float*](https://docs.python.org/3/library/functions.html#float)*] | \_SupportsArray\[*[*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any)*]] | \_NestedSequence\[\_SupportsArray\[*[*dtype*](https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype)*\[*[*Any*](https://docs.python.org/3/library/typing.html#typing.Any)*]]] |* [*bool*](https://docs.python.org/3/library/functions.html#bool) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *|*[*float*](https://docs.python.org/3/library/functions.html#float) *|*[*complex*](https://docs.python.org/3/library/functions.html#complex) *|*[*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes) *| \_NestedSequence\[*[*bool*](https://docs.python.org/3/library/functions.html#bool) *|*[*int*](https://docs.python.org/3/library/functions.html#int) *|*[*float*](https://docs.python.org/3/library/functions.html#float) *|*[*complex*](https://docs.python.org/3/library/functions.html#complex) *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes)*]*) – an object to be observables array. + **observables** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp") *|*[*SparseObservable*](qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable") *|*[*Mapping*](https://docs.python.org/3/library/typing.html#typing.Mapping)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli")*,* [*float*](https://docs.python.org/3/library/functions.html#float)*] | ArrayLike*) – an object to be observables array. **Returns** @@ -177,7 +177,7 @@ python_api_name: qiskit.primitives.ObservablesArray ### slice - + Take a slice of the observables in this array. diff --git a/docs/api/qiskit/dev/qiskit.primitives.ParameterLike.mdx b/docs/api/qiskit/dev/qiskit.primitives.ParameterLike.mdx index 3a0395b853a..8027ab4f8cc 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.ParameterLike.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.ParameterLike.mdx @@ -11,6 +11,6 @@ python_api_name: qiskit.primitives.ParameterLike # ParameterLike - alias of [`Union`](https://docs.python.org/3/library/typing.html#typing.Union)\[[`Parameter`](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter"), [`str`](https://docs.python.org/3/library/stdtypes.html#str)] + alias of [`Parameter`](qiskit.circuit.Parameter "qiskit._accelerate.circuit.Parameter") | [`str`](https://docs.python.org/3/library/stdtypes.html#str) diff --git a/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.mdx b/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.mdx index 390117129d0..21491a9d613 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.SamplerResult.mdx @@ -28,7 +28,7 @@ python_api_name: qiskit.primitives.SamplerResult ### quasi\_dists - + ### metadata diff --git a/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.mdx b/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.mdx index 8fe3ab51cf0..2f71b11c3b1 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.StatevectorEstimator.mdx @@ -110,7 +110,7 @@ python_api_name: qiskit.primitives.StatevectorEstimator **Parameters** - * **pubs** ([*Iterable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable)*\[EstimatorPubLike]*) – An iterable of pub-like objects, such as tuples `(circuit, observables)` or `(circuit, observables, parameter_values)`. + * **pubs** ([*Iterable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable)*\[TypeAliasForwardRef('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) *| None*) – The target precision for expectation value estimates of each run Estimator Pub that does not specify its own precision. If None the estimator’s default precision value will be used. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx b/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx index 22b4dcd464d..380c99ffd5f 100644 --- a/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx +++ b/docs/api/qiskit/dev/qiskit.primitives.StatevectorSampler.mdx @@ -113,7 +113,7 @@ python_api_name: qiskit.primitives.StatevectorSampler **Parameters** - * **pubs** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable)*\[SamplerPubLike]*) – An iterable of pub-like objects. For example, a list of circuits or tuples `(circuit, parameter_values)`. + * **pubs** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable)*\[TypeAliasForwardRef('SamplerPubLike')]*) – An iterable of pub-like objects. For example, a list of circuits or tuples `(circuit, parameter_values)`. * **shots** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The total number of shots to sample for each sampler pub that does not specify its own shots. If `None`, the primitive’s default shots value will be used, which can vary by implementation. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx index 28a2df7a13d..214d6b7e52e 100644 --- a/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.BackendV2.mdx @@ -23,7 +23,7 @@ python_api_name: qiskit.providers.BackendV2 ### \_default\_options - + Return the default options This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. @@ -161,7 +161,7 @@ python_api_name: qiskit.providers.BackendV2 **Return type** - provider + [provider](#qiskit.providers.BackendV2.provider "qiskit.providers.BackendV2.provider") ### target @@ -230,7 +230,7 @@ python_api_name: qiskit.providers.BackendV2 ### run - + Run on the backend. This method returns a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that runs circuits. Depending on the backend this may be either an async or sync call. It is at the discretion of the provider to decide whether running should block until the execution is finished or not: the Job class can handle either situation. diff --git a/docs/api/qiskit/dev/qiskit.providers.JobStatus.mdx b/docs/api/qiskit/dev/qiskit.providers.JobStatus.mdx index 4b792f4762b..bf4ef6c48ce 100644 --- a/docs/api/qiskit/dev/qiskit.providers.JobStatus.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.JobStatus.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.providers.JobStatus # JobStatus - + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum) Class for job status enumerated type. diff --git a/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx b/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx index 3dca0b3633d..5ac46b73b5e 100644 --- a/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.JobV1.mdx @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.JobV1 ### result - + Return the results of the job. **Return type** @@ -109,7 +109,7 @@ python_api_name: qiskit.providers.JobV1 ### status - + Return the status of the job, among the values of `JobStatus`. **Return type** @@ -119,7 +119,7 @@ python_api_name: qiskit.providers.JobV1 ### submit - + Submit the job to the backend for execution. diff --git a/docs/api/qiskit/dev/qiskit.providers.Options.mdx b/docs/api/qiskit/dev/qiskit.providers.Options.mdx index 49cbc0da8f1..369eb181c25 100644 --- a/docs/api/qiskit/dev/qiskit.providers.Options.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.Options.mdx @@ -47,7 +47,7 @@ python_api_name: qiskit.providers.Options >>> options["opt1"] = 4 >>> options["opt1"] 4 - >>> options["opt1"] = 10 + >>> options["opt1"] = 10 Traceback (most recent call last): ... ValueError: ... @@ -89,7 +89,7 @@ python_api_name: qiskit.providers.Options **Parameters** * **field** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – The field name to set the validator on - * **validator\_value** ([*list*](https://docs.python.org/3/library/stdtypes.html#list) *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple) *or*[*type*](https://docs.python.org/3/library/functions.html#type)) – The value to use for the validator depending on the type indicates on how the value for a field is enforced. If a tuple is passed in it must have a length of two and will enforce the min and max value (inclusive) for an integer or float value option. If it’s a list it will list the valid values for a field. If it’s a `type` the validator will just enforce the value is of a certain type. + * **validator\_value** ([*list*](https://docs.python.org/3/library/stdtypes.html#list) *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple) *or*[*type*](qiskit.dagcircuit.DAGDepNode#type "qiskit.dagcircuit.DAGDepNode.type")) – The value to use for the validator depending on the type indicates on how the value for a field is enforced. If a tuple is passed in it must have a length of two and will enforce the min and max value (inclusive) for an integer or float value option. If it’s a list it will list the valid values for a field. If it’s a `type` the validator will just enforce the value is of a certain type. **Raises** diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx index 3c0b8c398ac..1796b2fc1b7 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicProvider.mdx @@ -32,8 +32,8 @@ python_api_name: qiskit.providers.basic_provider.BasicProvider **Parameters** - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **filters** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable) *| None*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **filters** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable) *| None*) ### get\_backend diff --git a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx index 0b4b1cd85b9..c7ef1072e55 100644 --- a/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.basic_provider.BasicSimulator.mdx @@ -136,7 +136,7 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Return type** - provider + [provider](#qiskit.providers.basic_provider.BasicSimulator.provider "qiskit.providers.basic_provider.BasicSimulator.provider") ### target diff --git a/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx b/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx index 1d6b9f46a96..deef3d38ca4 100644 --- a/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx +++ b/docs/api/qiskit/dev/qiskit.providers.fake_provider.GenericBackendV2.mdx @@ -121,7 +121,7 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 **Return type** - provider + [provider](#qiskit.providers.fake_provider.GenericBackendV2.provider "qiskit.providers.fake_provider.GenericBackendV2.provider") ### target diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx index 03cce014e96..ab0f7b32f3b 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Chi.mdx @@ -197,8 +197,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -212,8 +212,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -227,8 +227,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -242,8 +242,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx index e8d9a0258db..2a25bb81906 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Choi.mdx @@ -104,7 +104,7 @@ $$ **Return type** - *Self* + [*Self*](https://docs.python.org/3/library/typing.html#typing.Self) ### compose @@ -209,8 +209,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -224,8 +224,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -239,8 +239,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -254,8 +254,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx index bb98d4db1f5..3dadb22313c 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Clifford.mdx @@ -583,7 +583,7 @@ python_api_name: qiskit.quantum_info.Clifford **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list) or array + [list](https://docs.python.org/3/library/stdtypes.html#list) or [array](qiskit.primitives.BitArray#array "qiskit.primitives.BitArray.array") **Raises** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx index 7ee9da8e1e1..477bd4d9d20 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Kraus.mdx @@ -201,8 +201,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -222,8 +222,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -237,8 +237,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx index b9a338e758f..419d2745c17 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Operator.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Operator # Operator - + Bases: `LinearOp` Matrix operator class @@ -54,9 +54,9 @@ $$ **Parameters** - * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation") *or BaseOperator or matrix*) – data to initialize operator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)) – the output subsystem dimensions. \[Default: None] + * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*Operation*](qiskit.circuit.Operation "qiskit.circuit.Operation") *| BaseOperator | np.ndarray*) – data to initialize operator. + * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple) *| None*) – the input subsystem dimensions. + * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple) *| None*) – the output subsystem dimensions. **Raises** @@ -115,12 +115,12 @@ $$ **Return type** - *Self* + [*Self*](https://docs.python.org/3/library/typing.html#typing.Self) ### apply\_permutation - + Modifies operator’s data by composing it with a permutation. **Parameters** @@ -143,7 +143,7 @@ $$ ### compose - + Return the operator composition with another Operator. **Parameters** @@ -173,7 +173,7 @@ $$ ### conjugate - + Return the conjugate of the Operator. @@ -208,7 +208,7 @@ $$ ### draw - + Return a visualization of the Operator. **repr**: String of the state’s `__repr__`. @@ -240,7 +240,7 @@ $$ ### equiv - + Return True if operators are equivalent up to global phase. **Parameters** @@ -260,7 +260,7 @@ $$ ### expand - + Return the reverse-order tensor product with another Operator. **Parameters** @@ -280,7 +280,7 @@ $$ ### from\_circuit - + Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") While a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object can passed directly as `data` to the class constructor this provides no options on how the circuit is used to create an [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator"). This constructor method lets you control how the [`Operator`](#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") is created so it can be adjusted for a particular use case. @@ -305,7 +305,7 @@ $$ ### from\_label - + Return a tensor product of single-qubit operators. **Parameters** @@ -337,7 +337,7 @@ $$ ### is\_unitary - + Return True if operator is a unitary matrix. @@ -349,7 +349,7 @@ $$ ### power - + Return the matrix power of the operator. Non-integer powers of operators with an eigenvalue whose complex phase is $\pi$ have a branch cut in the complex plane, which makes the calculation of the principal root around this cut subject to precision / differences in BLAS implementation. For example, the square root of Pauli Y can return the $\pi/2$ or $-\pi/2$ Y rotation depending on whether the -1 eigenvalue is found as `complex(-1, tiny)` or `complex(-1, -tiny)`. Such eigenvalues are really common in quantum information, so this function first phase-rotates the input matrix to shift the branch cut to a far less common point. The underlying numerical precision issues around the branch-cut point remain, if an operator has an eigenvalue close to this phase. The magnitude of this rotation can be controlled with the `branch_cut_rotation` parameter. @@ -414,7 +414,7 @@ $$ ### reverse\_qargs - + Return an Operator with reversed subsystem ordering. For a tensor product operator this is equivalent to reversing the order of tensor product subsystems. For an operator $A = A_{n-1} \otimes ... \otimes A_0$ the returned operator will be $A_0 \otimes ... \otimes A_{n-1}$. @@ -430,7 +430,7 @@ $$ ### tensor - + Return the tensor product with another Operator. **Parameters** @@ -454,19 +454,19 @@ $$ ### to\_instruction - + Convert to a UnitaryGate instruction. ### to\_matrix - + Convert operator to NumPy matrix. ### to\_operator - + Convert operator to matrix operator class **Return type** @@ -476,7 +476,7 @@ $$ ### transpose - + Return the transpose of the Operator. diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx index e06d4ce361d..1808caca4a1 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.PTM.mdx @@ -205,8 +205,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -220,8 +220,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -235,8 +235,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -250,8 +250,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx index 61437030406..2f92486d0ec 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Pauli.mdx @@ -549,7 +549,7 @@ $$ **Return type** - array + [array](qiskit.primitives.BitArray#array "qiskit.primitives.BitArray.array") ### transpose diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.PauliLindbladMap.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.PauliLindbladMap.mdx index 16f6e422c67..39777ff90b8 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.PauliLindbladMap.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.PauliLindbladMap.mdx @@ -431,6 +431,22 @@ $$ Calculate the $\gamma$ for the map. + ### generators + + + Get the generators of the map. + + This is an alias for [`get_qubit_sparse_pauli_list_copy()`](#qiskit.quantum_info.PauliLindbladMap.get_qubit_sparse_pauli_list_copy "qiskit.quantum_info.PauliLindbladMap.get_qubit_sparse_pauli_list_copy"), providing a more convenient name that aligns with the naming conventions used in Aer and Runtime for similar classes. + + **Returns** + + A copy of the map’s generator terms. + + **Return type** + + [QubitSparsePauliList](qiskit.quantum_info.QubitSparsePauliList "qiskit.quantum_info.QubitSparsePauliList") + + ### get\_qubit\_sparse\_pauli\_list\_copy diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx index 2c4b1492eef..668b5e97e57 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.PauliList.mdx @@ -201,7 +201,7 @@ python_api_name: qiskit.quantum_info.PauliList **Return type** - array + [array](qiskit.primitives.BitArray#array "qiskit.primitives.BitArray.array") ### argsort @@ -222,7 +222,7 @@ python_api_name: qiskit.quantum_info.PauliList **Return type** - array + [array](qiskit.primitives.BitArray#array "qiskit.primitives.BitArray.array") ### commutes @@ -261,7 +261,7 @@ python_api_name: qiskit.quantum_info.PauliList **Return type** - array + [array](qiskit.primitives.BitArray#array "qiskit.primitives.BitArray.array") ### compose @@ -740,7 +740,7 @@ python_api_name: qiskit.quantum_info.PauliList **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list) or array + [list](https://docs.python.org/3/library/stdtypes.html#list) or [array](qiskit.primitives.BitArray#array "qiskit.primitives.BitArray.array") ### to\_matrix diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.mdx index 0bea81b1016..a766087973a 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.ScalarOp.mdx @@ -69,7 +69,7 @@ python_api_name: qiskit.quantum_info.ScalarOp **Return type** - *Self* + [*Self*](https://docs.python.org/3/library/typing.html#typing.Self) ### compose diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx index 76d2ad74eaf..8168248a9a5 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.SparsePauliOp.mdx @@ -208,8 +208,8 @@ python_api_name: qiskit.quantum_info.SparsePauliOp **Parameters** * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – optionally sort by weight if True (Default: False). - * **sorted** (*By using the weight kwarg the output can additionally be*) – - * **Pauli.** (*by the number of non-identity terms in the*) – + * **sorted** (*By using the weight kwarg the output can additionally be*) + * **Pauli.** (*by the number of non-identity terms in the*) **Returns** @@ -217,7 +217,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp **Return type** - array + [array](qiskit.primitives.BitArray#array "qiskit.primitives.BitArray.array") ### assign\_parameters @@ -392,7 +392,7 @@ $$ **Parameters** * **obj** (*Iterable\[Tuple\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*,* [*complex*](https://docs.python.org/3/library/functions.html#complex)*]]*) – The list of 2-tuples specifying the Pauli terms. - * **dtype** ([*type*](https://docs.python.org/3/library/functions.html#type) *| None*) – Data type for the coefficients. If `None` (default), the dtype is automatically inferred. + * **dtype** ([*type*](qiskit.dagcircuit.DAGDepNode#type "qiskit.dagcircuit.DAGDepNode.type") *| None*) – Data type for the coefficients. If `None` (default), the dtype is automatically inferred. * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – The number of qubits of the operator (Default: None). **Returns** @@ -467,7 +467,7 @@ $$ * **obj** (*Iterable\[*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*,* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*],* [*complex*](https://docs.python.org/3/library/functions.html#complex)*]]*) – The list 3-tuples specifying the Paulis. * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int)) – The number of qubits of the operator. * **do\_checks** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – Whether to perform validity checks on the input indices. - * **dtype** ([*type*](https://docs.python.org/3/library/functions.html#type) *| None*) – Data type for the coefficients. If `None` (default), the dtype is automatically inferred. + * **dtype** ([*type*](qiskit.dagcircuit.DAGDepNode#type "qiskit.dagcircuit.DAGDepNode.type") *| None*) – Data type for the coefficients. If `None` (default), the dtype is automatically inferred. **Returns** @@ -754,8 +754,8 @@ $$ **Parameters** * **weight** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – optionally sort by weight if True (Default: False). - * **sorted** (*By using the weight kwarg the output can additionally be*) – - * **Pauli.** (*by the number of non-identity terms in the*) – + * **sorted** (*By using the weight kwarg the output can additionally be*) + * **Pauli.** (*by the number of non-identity terms in the*) **Returns** @@ -833,7 +833,7 @@ $$ **Return type** - [list](https://docs.python.org/3/library/stdtypes.html#list) or array + [list](https://docs.python.org/3/library/stdtypes.html#list) or [array](qiskit.primitives.BitArray#array "qiskit.primitives.BitArray.array") ### to\_matrix @@ -852,7 +852,7 @@ $$ **Return type** - array + [array](qiskit.primitives.BitArray#array "qiskit.primitives.BitArray.array") ### to\_operator diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx index 083689ada33..69700ac9c22 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.StabilizerState.mdx @@ -171,7 +171,7 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** * **oper** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.operators.symplectic.pauli.Pauli") *|*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp")) – A Pauli or SparsePauliOp operator to evaluate the expectation value. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list) *| None*) – Subsystems to apply the operator on. + * **qargs** (*None |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)) – Subsystems to apply the operator on. **Returns** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx index 89a47fa5201..0921c69fee3 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Statevector.mdx @@ -382,8 +382,8 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx index cfdfb34a898..b441a27b180 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Stinespring.mdx @@ -100,7 +100,7 @@ $$ **Return type** - *Self* + [*Self*](https://docs.python.org/3/library/typing.html#typing.Self) ### compose @@ -205,8 +205,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -226,8 +226,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -241,8 +241,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx index d5a36230ad7..cd317aaa50d 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.SuperOp.mdx @@ -197,8 +197,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -212,8 +212,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -227,8 +227,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** @@ -242,8 +242,8 @@ $$ **Parameters** - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx b/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx index d51ac72174b..c07b41bf684 100644 --- a/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx +++ b/docs/api/qiskit/dev/qiskit.quantum_info.Z2Symmetries.mdx @@ -120,7 +120,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries **Parameters** - **operator** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp")) – + **operator** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp")) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.result.Counts.mdx b/docs/api/qiskit/dev/qiskit.result.Counts.mdx index 4ab85f8dfef..80dd1653441 100644 --- a/docs/api/qiskit/dev/qiskit.result.Counts.mdx +++ b/docs/api/qiskit/dev/qiskit.result.Counts.mdx @@ -48,15 +48,19 @@ python_api_name: qiskit.result.Counts ### clear - + + Remove all items from the dict. + ### copy - + + Return a shallow copy of the dict. + ### fromkeys - + Create a new dictionary with keys from iterable and values set to value. @@ -106,11 +110,15 @@ python_api_name: qiskit.result.Counts ### items - + + Return a set-like object providing a view on the dict’s items. + ### keys - + + Return a set-like object providing a view on the dict’s keys. + ### most\_frequent @@ -160,12 +168,14 @@ python_api_name: qiskit.result.Counts ### update - - If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] + + If E is present and has a .keys() method, then does: for k in E.keys(): D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] ### values - + + Return an object providing a view on the dict’s values. + diff --git a/docs/api/qiskit/dev/qiskit.result.ProbDistribution.mdx b/docs/api/qiskit/dev/qiskit.result.ProbDistribution.mdx index ffd63202f13..634f02c4c92 100644 --- a/docs/api/qiskit/dev/qiskit.result.ProbDistribution.mdx +++ b/docs/api/qiskit/dev/qiskit.result.ProbDistribution.mdx @@ -56,15 +56,19 @@ python_api_name: qiskit.result.ProbDistribution ### clear - + + Remove all items from the dict. + ### copy - + + Return a shallow copy of the dict. + ### fromkeys - + Create a new dictionary with keys from iterable and values set to value. @@ -92,11 +96,15 @@ python_api_name: qiskit.result.ProbDistribution ### items - + + Return a set-like object providing a view on the dict’s items. + ### keys - + + Return a set-like object providing a view on the dict’s keys. + ### pop @@ -122,12 +130,14 @@ python_api_name: qiskit.result.ProbDistribution ### update - - If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] + + If E is present and has a .keys() method, then does: for k in E.keys(): D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] ### values - + + Return an object providing a view on the dict’s values. + diff --git a/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.mdx b/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.mdx index 822fd8b0455..1d6cb81b44c 100644 --- a/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.mdx +++ b/docs/api/qiskit/dev/qiskit.result.QuasiDistribution.mdx @@ -70,15 +70,19 @@ python_api_name: qiskit.result.QuasiDistribution ### clear - + + Remove all items from the dict. + ### copy - + + Return a shallow copy of the dict. + ### fromkeys - + Create a new dictionary with keys from iterable and values set to value. @@ -106,11 +110,15 @@ python_api_name: qiskit.result.QuasiDistribution ### items - + + Return a set-like object providing a view on the dict’s items. + ### keys - + + Return a set-like object providing a view on the dict’s keys. + ### nearest\_probability\_distribution @@ -158,12 +166,14 @@ python_api_name: qiskit.result.QuasiDistribution ### update - - If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] + + If E is present and has a .keys() method, then does: for k in E.keys(): D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] ### values - + + Return an object providing a view on the dict’s values. + diff --git a/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.mdx b/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.mdx index ec180f29502..f5097e830c4 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.EvolutionSynthesis.mdx @@ -33,7 +33,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis ### synthesize - + Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.mdx b/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.mdx index 59c4ec315c4..153c6f09f8f 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.SolovayKitaevDecomposition.mdx @@ -112,7 +112,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition **Parameters** - **gate** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray) *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")) – + **gate** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray) *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx index 74792d7c412..f324de302dc 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.TwoQubitWeylDecomposition.mdx @@ -44,9 +44,9 @@ $$ **Parameters** - * **unitary\_matrix** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) – - * **fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **\_specialization** (*two\_qubit\_decompose.Specialization | None*) – + * **unitary\_matrix** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) + * **fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **\_specialization** (*two\_qubit\_decompose.Specialization | None*) ### a @@ -111,9 +111,9 @@ $$ **Parameters** - * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **simplify** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – - * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float)) – + * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **simplify** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float)) **Return type** @@ -127,9 +127,9 @@ $$ **Parameters** - * **bytes\_in** ([*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes)) – - * **requested\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float)) – - * **\_specialization** (*Specialization | None*) – + * **bytes\_in** ([*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes)) + * **requested\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float)) + * **\_specialization** (*Specialization | None*) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx b/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx index a12b2cd63a0..a85351fedce 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.XXDecomposer.mdx @@ -58,7 +58,7 @@ python_api_name: qiskit.synthesis.XXDecomposer **Parameters** - **unitary** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.operators.operator.Operator") *|*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) – + **unitary** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.operators.operator.Operator") *|*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx index 15b8dcff443..3682b594175 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx @@ -32,7 +32,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit ### name - + A human-readable name for the circuit. **Example** @@ -53,7 +53,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit ### build - + **Constructs this circuit out of the parameters(thetas). Parameter values must be set before** constructing the circuit. diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx index bae93c91058..da190b5721c 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.ApproximatingObjective.mdx @@ -31,7 +31,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective ### gradient - + Computes a gradient with respect to parameters given a vector of parameter values. **Parameters** @@ -49,7 +49,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximatingObjective ### objective - + Computes a value of the objective function given a vector of parameter values. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx index 87669d482c9..44bb1eb811b 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx @@ -38,7 +38,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit ### name - + A human-readable name for the circuit. **Example** @@ -66,7 +66,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit **Parameters** - **thetas** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) – + **thetas** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx index 1d73b8f0908..63ea08fe7d8 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx @@ -27,7 +27,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective **Parameters** - **param\_values** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) – + **param\_values** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) **Return type** @@ -41,7 +41,7 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective **Parameters** - **param\_values** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) – + **param\_values** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.mdx b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.mdx index 90611949c01..815d3e8b511 100644 --- a/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.mdx +++ b/docs/api/qiskit/dev/qiskit.synthesis.unitary.aqc.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.synthesis.unitary.aqc --- + + - - # Approximate Quantum Compiler `qiskit.synthesis.unitary.aqc` diff --git a/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.mdx b/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.mdx index 38390e93549..7d4f95ede0d 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.AnalysisPass.mdx @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.AnalysisPass * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.AnalysisPass **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.AnalysisPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx index b9491c267fe..5c9b9c781bb 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.InstructionDurations.mdx @@ -19,8 +19,8 @@ python_api_name: qiskit.transpiler.InstructionDurations **Parameters** - * **instruction\_durations** (*'InstructionDurationsType' | None*) – - * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float)) – + * **instruction\_durations** (*'InstructionDurationsType' | None*) + * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float)) ### from\_backend diff --git a/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx index 03965c1ea70..6d28ebbc8bd 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.Layout.mdx @@ -283,7 +283,7 @@ python_api_name: qiskit.transpiler.Layout **Parameters** - **qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List)*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – + **qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List)*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) diff --git a/docs/api/qiskit/dev/qiskit.transpiler.OptimizationMetric.mdx b/docs/api/qiskit/dev/qiskit.transpiler.OptimizationMetric.mdx index 5d0edfac4e0..a2a7fc24440 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.OptimizationMetric.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.OptimizationMetric.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.OptimizationMetric # OptimizationMetric - + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum) Optimization metric considered during transpilation. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx index 2a4eccb89d0..e1a423c7ba1 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.PassManager.mdx @@ -29,7 +29,7 @@ python_api_name: qiskit.transpiler.PassManager **Parameters** - **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[qiskit.passmanager.base\_tasks.Task]*) – A set of transpiler passes to be added to schedule. + **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[Task]*) – A set of transpiler passes to be added to schedule. **Raises** @@ -92,7 +92,7 @@ python_api_name: qiskit.transpiler.PassManager **Parameters** * **index** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Pass index to replace, based on the position in passes(). - * **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[qiskit.passmanager.base\_tasks.Task]*) – A pass set to be added to the pass manager schedule. + * **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[Task]*) – A pass set to be added to the pass manager schedule. **Return type** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx index 3a7dc55688a..fbaaffcf8d2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.StagedPassManager.mdx @@ -69,7 +69,7 @@ python_api_name: qiskit.transpiler.StagedPassManager **Parameters** - **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[qiskit.passmanager.base\_tasks.Task]*) – A set of transpiler passes to be added to schedule. + **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[Task]*) – A set of transpiler passes to be added to schedule. **Raises** @@ -112,7 +112,7 @@ python_api_name: qiskit.transpiler.StagedPassManager **Parameters** * **index** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Pass index to replace, based on the position in passes(). - * **passes** (*BasePass |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[qiskit.transpiler.basepasses.BasePass]*) – A pass set to be added to the pass manager schedule. + * **passes** (*BasePass |* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[BasePass]*) – A pass set to be added to the pass manager schedule. **Return type** @@ -164,7 +164,7 @@ python_api_name: qiskit.transpiler.StagedPassManager When running transpilation with multi-processing, the callback function is invoked within the context of each sub-process, independently of the parent process. - * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The maximum number of parallel processes to launch if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. + * **num\_processes** ([*int*](https://docs.python.org/3/library/functions.html#int)) – The maximum number of parallel processes to launch if parallel execution is enabled. This argument overrides `num_processes` in the user configuration file, and the `QISKIT_NUM_PROCS` environment variable. If set to `None` the system default or local user configuration will be used. * **property\_set** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*,* [*object*](https://docs.python.org/3/library/functions.html#object)*] | None*) – If given, the initial value to use as the [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") for the pass manager pipeline. This can be used to persist analysis from one run to another, in cases where you know the analysis is safe to share. Beware that some analysis will be specific to the input circuit and the particular [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target"), so you should take a lot of care when using this argument. diff --git a/docs/api/qiskit/dev/qiskit.transpiler.Target.mdx b/docs/api/qiskit/dev/qiskit.transpiler.Target.mdx index a5eeee84ad8..7ba61732d61 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.Target.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.Target.mdx @@ -679,14 +679,14 @@ python_api_name: qiskit.transpiler.Target **Parameters** - * **description** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – - * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – - * **granularity** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **min\_length** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **pulse\_alignment** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **acquire\_alignment** ([*int*](https://docs.python.org/3/library/functions.html#int)) – - * **qubit\_properties** ([*list*](https://docs.python.org/3/library/stdtypes.html#list) *| None*) – - * **concurrent\_measurements** ([*list*](https://docs.python.org/3/library/stdtypes.html#list) *| None*) – + * **description** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) + * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float) *| None*) + * **granularity** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **min\_length** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **pulse\_alignment** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **acquire\_alignment** ([*int*](https://docs.python.org/3/library/functions.html#int)) + * **qubit\_properties** ([*list*](https://docs.python.org/3/library/stdtypes.html#list) *| None*) + * **concurrent\_measurements** ([*list*](https://docs.python.org/3/library/stdtypes.html#list) *| None*) diff --git a/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.mdx b/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.mdx index 47595a51806..c65e6360ff9 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.TransformationPass.mdx @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.TransformationPass * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.TransformationPass **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.TransformationPass ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx index a340abf7568..956472d1af6 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.TranspileLayout.mdx @@ -81,19 +81,19 @@ python_api_name: qiskit.transpiler.TranspileLayout There are three public attributes associated with the class, however these are mostly provided for backwards compatibility and represent the internal state from the transpiler. They are defined as: - > * [`initial_layout`](#qiskit.transpiler.TranspileLayout.initial_layout "qiskit.transpiler.TranspileLayout.initial_layout") - This attribute is used to model the permutation caused by the [Layout stage](transpiler#transpiler-preset-stage-layout). It is a [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") object that maps the input [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")s [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") objects to the position in the output `QuantumCircuit.qubits` list. + > * [`initial_layout`](#qiskit.transpiler.TranspileLayout.initial_layout "qiskit.transpiler.TranspileLayout.initial_layout") - This attribute is used to model the permutation caused by the [Layout stage](transpiler#transpiler-preset-stage-layout). It is a [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") object that maps the input [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")s [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") objects to the position in the output [`QuantumCircuit.qubits`](qiskit.circuit.QuantumCircuit#qubits "qiskit.circuit.QuantumCircuit.qubits") list. > * [`input_qubit_mapping`](#qiskit.transpiler.TranspileLayout.input_qubit_mapping "qiskit.transpiler.TranspileLayout.input_qubit_mapping") - This attribute is used to retain input ordering of the original [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object. It maps the virtual [`Qubit`](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit") object from the original circuit (and [`initial_layout`](#qiskit.transpiler.TranspileLayout.initial_layout "qiskit.transpiler.TranspileLayout.initial_layout")) to its corresponding position in [`QuantumCircuit.qubits`](qiskit.circuit.QuantumCircuit#qubits "qiskit.circuit.QuantumCircuit.qubits") in the original circuit. This is needed when computing the permutation of the `Operator` of the circuit (and used by [`Operator.from_circuit()`](qiskit.quantum_info.Operator#from_circuit "qiskit.quantum_info.Operator.from_circuit")). - > * [`final_layout`](#qiskit.transpiler.TranspileLayout.final_layout "qiskit.transpiler.TranspileLayout.final_layout") - This attribute is used to model the permutation caused by the [Routing stage](transpiler#transpiler-preset-stage-routing). It is a [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") object that maps the output circuit’s qubits from `QuantumCircuit.qubits` in the output circuit to their final positions after routing. Importantly, this only represents the permutation caused by inserting [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")s into the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") during the [Routing stage](transpiler#transpiler-preset-stage-routing). It is **not** a mapping from the original input circuit’s position to the final position at the end of the transpiled circuit. If you need this, you can use the [`final_index_layout()`](#qiskit.transpiler.TranspileLayout.final_index_layout "qiskit.transpiler.TranspileLayout.final_index_layout") to generate this. If [`final_layout`](#qiskit.transpiler.TranspileLayout.final_layout "qiskit.transpiler.TranspileLayout.final_layout") is set to `None`, this indicates that routing was not run, and can be considered equivalent to a trivial layout with the qubits from the output circuit’s [`qubits`](qiskit.circuit.QuantumCircuit#qubits "qiskit.circuit.QuantumCircuit.qubits") list. + > * [`final_layout`](#qiskit.transpiler.TranspileLayout.final_layout "qiskit.transpiler.TranspileLayout.final_layout") - This attribute is used to model the permutation caused by the [Routing stage](transpiler#transpiler-preset-stage-routing). It is a [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") object that maps the output circuit’s qubits from [`QuantumCircuit.qubits`](qiskit.circuit.QuantumCircuit#qubits "qiskit.circuit.QuantumCircuit.qubits") in the output circuit to their final positions after routing. Importantly, this only represents the permutation caused by inserting [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")s into the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") during the [Routing stage](transpiler#transpiler-preset-stage-routing). It is **not** a mapping from the original input circuit’s position to the final position at the end of the transpiled circuit. If you need this, you can use the [`final_index_layout()`](#qiskit.transpiler.TranspileLayout.final_index_layout "qiskit.transpiler.TranspileLayout.final_index_layout") to generate this. If [`final_layout`](#qiskit.transpiler.TranspileLayout.final_layout "qiskit.transpiler.TranspileLayout.final_layout") is set to `None`, this indicates that routing was not run, and can be considered equivalent to a trivial layout with the qubits from the output circuit’s [`qubits`](qiskit.circuit.QuantumCircuit#qubits "qiskit.circuit.QuantumCircuit.qubits") list. ## Attributes **Parameters** - * **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.layout.Layout")) – - * **input\_qubit\_mapping** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*qiskit.circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*int*](https://docs.python.org/3/library/functions.html#int)*]*) – - * **final\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.layout.Layout") *| None*) – - * **\_input\_qubit\_count** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – - * **\_output\_qubit\_list** ([*List*](https://docs.python.org/3/library/typing.html#typing.List)*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*] | None*) – + * **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.layout.Layout")) + * **input\_qubit\_mapping** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict)*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*int*](https://docs.python.org/3/library/functions.html#int)*]*) + * **final\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.layout.Layout") *| None*) + * **\_input\_qubit\_count** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) + * **\_output\_qubit\_list** ([*List*](https://docs.python.org/3/library/typing.html#typing.List)*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*] | None*) ### final\_layout @@ -105,7 +105,7 @@ python_api_name: qiskit.transpiler.TranspileLayout ### input\_qubit\_mapping - + ## Methods diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx index 19ab8095fe1..43fbcc3e3b5 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ALAPScheduleAnalysis.mdx @@ -55,7 +55,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx index 00dbabf9e5a..7d0562855cb 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ASAPScheduleAnalysis.mdx @@ -55,7 +55,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.mdx index 59bfedf91a6..539b6be1061 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ApplyLayout.mdx @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx index 16d97fd7832..0d2de3c8f4c 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.mdx index 118272de042..2b8033085bd 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasicSwap.mdx @@ -51,7 +51,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.BasicSwap **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx index a046d27fda7..15d4f4e8bcd 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.BasisTranslator.mdx @@ -97,7 +97,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -105,7 +105,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.mdx index f2de19ca007..1e99d727c8f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CSPLayout.mdx @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.mdx index e65a4dea5ef..16a98ac6c7b 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckGateDirection.mdx @@ -49,7 +49,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.mdx index c3d9021bc63..2da7c7ac709 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CheckMap.mdx @@ -51,7 +51,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.CheckMap **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.mdx index 3f53135f9f8..40f7e782b7a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect1qRuns.mdx @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.mdx index 9a7ea5db239..084588118b6 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Collect2qBlocks.mdx @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectAndCollapse.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectAndCollapse.mdx index c6c372fc6c1..2d1c3754165 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectAndCollapse.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectAndCollapse.mdx @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.CollectAndCollapse **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx index fcaaa00e834..f5a559b8bb9 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectCliffords.mdx @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.mdx index cead90e89c9..881184ee63f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectLinearFunctions.mdx @@ -53,7 +53,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.mdx index b7b0b6dee0e..1b36d5e927f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CollectMultiQBlocks.mdx @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### find\_set diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.mdx index 256e1a534ee..bd7bfabd0cc 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutationAnalysis.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.mdx index 4bdf0461092..11359b39256 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeCancellation.mdx @@ -55,7 +55,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx index 11fb2b0a7fa..891491c5004 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeInverseCancellation.mdx @@ -47,7 +47,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -55,7 +55,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeOptimization.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeOptimization.mdx index 4c723c61a18..ba73e7c5abd 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeOptimization.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CommutativeOptimization.mdx @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeOptimization * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeOptimization **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx index a419d3d7525..b3736ba99a1 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Commuting2qGateRouter.mdx @@ -104,7 +104,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -112,7 +112,7 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.mdx index e6586824510..fe4f3a824b6 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConsolidateBlocks.mdx @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -70,7 +70,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.mdx index e2d4781b068..17e68365272 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ConstrainedReschedule.mdx @@ -80,7 +80,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -88,7 +88,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.mdx index 7e1ff7e934c..b10c312954f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContainsInstruction.mdx @@ -51,7 +51,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContextAwareDynamicalDecoupling.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContextAwareDynamicalDecoupling.mdx index 603da9bf7b3..8339d2dec6d 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContextAwareDynamicalDecoupling.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContextAwareDynamicalDecoupling.mdx @@ -105,7 +105,7 @@ python_api_name: qiskit.transpiler.passes.ContextAwareDynamicalDecoupling * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.passes.ContextAwareDynamicalDecoupling **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### get\_orthogonal\_sequence @@ -123,11 +123,11 @@ python_api_name: qiskit.transpiler.passes.ContextAwareDynamicalDecoupling **Parameters** - **order** ([*int*](https://docs.python.org/3/library/functions.html#int)) – + **order** ([*int*](https://docs.python.org/3/library/functions.html#int)) **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[list](https://docs.python.org/3/library/stdtypes.html#list)\[[float](https://docs.python.org/3/library/functions.html#float)], [list](https://docs.python.org/3/library/stdtypes.html#list)\[[qiskit.circuit.gate.Gate](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")]] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[list](https://docs.python.org/3/library/stdtypes.html#list)\[[float](https://docs.python.org/3/library/functions.html#float)], [list](https://docs.python.org/3/library/stdtypes.html#list)\[[*Gate*](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")]] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContractIdleWiresInControlFlow.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContractIdleWiresInControlFlow.mdx index 3f0143944f1..0bca7931ebd 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ContractIdleWiresInControlFlow.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ContractIdleWiresInControlFlow.mdx @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.ContractIdleWiresInControlFlow * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.ContractIdleWiresInControlFlow **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.mdx index aed5674edd3..9ba03eae9ae 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOps.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CountOps * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CountOps **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.mdx index 057b80e8d26..64f6a8ee7c4 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.CountOpsLongestPath.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.mdx index 5e13f8b0671..30aad7c0466 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGFixedPoint.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.mdx index b0d3bd3a532..1942f1c8402 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DAGLongestPath.mdx @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.mdx index 733dd635752..e9f7074bcc7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Decompose.mdx @@ -47,7 +47,7 @@ python_api_name: qiskit.transpiler.passes.Decompose * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -55,7 +55,7 @@ python_api_name: qiskit.transpiler.passes.Decompose **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.mdx index 2cff8434aaa..eb7b47109b1 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.DenseLayout.mdx @@ -55,7 +55,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.mdx index c87db0959da..463d7332a9f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Depth.mdx @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.Depth * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Depth **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ElidePermutations.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ElidePermutations.mdx index 942b941cfe1..089ea140c40 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ElidePermutations.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ElidePermutations.mdx @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.ElidePermutations * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.ElidePermutations **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.mdx index c2f05b65697..ebf6a694350 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.EnlargeWithAncilla.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Error.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Error.mdx index 7d85263f2ee..09c17b3faa5 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Error.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Error.mdx @@ -53,7 +53,7 @@ python_api_name: qiskit.transpiler.passes.Error * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.Error **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx index 7caa02a4314..ebcb1af0e82 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FilterOpNodes.mdx @@ -69,7 +69,7 @@ python_api_name: qiskit.transpiler.passes.FilterOpNodes * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -77,7 +77,7 @@ python_api_name: qiskit.transpiler.passes.FilterOpNodes **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -97,7 +97,7 @@ python_api_name: qiskit.transpiler.passes.FilterOpNodes **Parameters** - **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.mdx index 9516299ef6f..39a78fdb952 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FixedPoint.mdx @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.FixedPoint **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.mdx index c9ff64d9eaa..6eb75580f5b 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.FullAncillaAllocation.mdx @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.mdx index fa9ce580f4e..e672f5e76fe 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.GateDirection.mdx @@ -81,7 +81,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -89,7 +89,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx index ddd3d7a92be..b8230eab6ec 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.GatesInBasis.mdx @@ -49,7 +49,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.mdx index 9b8ee8304e2..29168304187 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.HighLevelSynthesis.mdx @@ -84,7 +84,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -92,7 +92,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.mdx index df655e0f3b8..74706242340 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.HoareOptimizer.mdx @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.mdx index f520ac73beb..96836703680 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.InstructionDurationCheck.mdx @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.mdx index afe458ed285..8890907d3d7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.InverseCancellation.mdx @@ -79,7 +79,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -87,7 +87,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.mdx index c9d95455cff..ed1f9f74688 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Layout2qDistance.mdx @@ -51,7 +51,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LayoutTransformation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.LayoutTransformation.mdx index ec95f904e45..71ac1409375 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LayoutTransformation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LayoutTransformation.mdx @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.LayoutTransformation * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.LayoutTransformation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LightCone.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.LightCone.mdx index 6dfb0f2cd22..d73d0055352 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LightCone.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LightCone.mdx @@ -49,7 +49,7 @@ python_api_name: qiskit.transpiler.passes.LightCone * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.LightCone **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index 834f7238269..0c323d841b1 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -74,7 +74,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations **Parameters** - **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LitinskiTransformation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.LitinskiTransformation.mdx index 4c31250e99c..a0b9331cf7b 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LitinskiTransformation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LitinskiTransformation.mdx @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.LitinskiTransformation * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -70,7 +70,7 @@ python_api_name: qiskit.transpiler.passes.LitinskiTransformation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.mdx index 6c509aa8eac..b0705f0a050 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.LookaheadSwap.mdx @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -75,7 +75,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx index 62ae189c011..5be9a9ddcf2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.MergeAdjacentBarriers.mdx @@ -79,7 +79,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -87,7 +87,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.mdx index e23547d7b32..53dc75f0843 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.MinimumPoint.mdx @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -70,7 +70,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.mdx index 1be2f857afa..253d0e244cf 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.NumTensorFactors.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.mdx index 4b6b6d8f0b9..5ccddde1ee8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGates.mdx @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -70,7 +70,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx index 913aade65e7..c026699c11d 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesDecomposition.mdx @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx index cadf50aa6de..d5f2c2dcd77 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.mdx @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -62,7 +62,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.mdx index 5e31def086a..f3dad248486 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeAnnotated.mdx @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeAnnotated * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -67,7 +67,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeAnnotated **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffordT.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffordT.mdx index e05f26e4400..5d45709cdfb 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffordT.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffordT.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffordT * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffordT **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.mdx index 796d1207f45..475e613e571 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeCliffords.mdx @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeSwapBeforeMeasure.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeSwapBeforeMeasure.mdx index e0f83c53e71..05e635a9b50 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeSwapBeforeMeasure.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.OptimizeSwapBeforeMeasure.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeSwapBeforeMeasure * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeSwapBeforeMeasure **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx index f07648513bb..566bfd83497 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDelay.mdx @@ -77,7 +77,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -85,7 +85,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### get\_duration diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx index e7cf1007324..dcbdaeb7812 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.PadDynamicalDecoupling.mdx @@ -141,7 +141,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -149,7 +149,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### get\_duration diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx index c8a7018c7c5..c2242fed303 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -69,7 +69,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -89,7 +89,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers **Parameters** - **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx index 3fd88c6281f..83b791a4149 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx index aa462fe2ebe..47d31a06012 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalMeasurements.mdx @@ -46,7 +46,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -54,7 +54,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalReset.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalReset.mdx index 9c7f4f60036..d27ed34234f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalReset.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveFinalReset.mdx @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalReset * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalReset **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveIdentityEquivalent.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveIdentityEquivalent.mdx index 59c0a4e8684..3a1e7457178 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveIdentityEquivalent.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveIdentityEquivalent.mdx @@ -61,7 +61,7 @@ $$ * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -69,7 +69,7 @@ $$ **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.mdx index 41dde27fe58..11a72be09b8 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.RemoveResetInZeroState.mdx @@ -42,7 +42,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -50,7 +50,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx index 44bacfd8911..b6ce3fb0777 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ResetAfterMeasureSimplification.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.ResourceEstimation.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.ResourceEstimation.mdx index 88471f7835c..f73f595d63d 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.ResourceEstimation.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.ResourceEstimation.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.ResourceEstimation * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.ResourceEstimation **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.mdx index f3ff4fd9518..3b4f9b1ff34 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreLayout.mdx @@ -140,7 +140,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -148,7 +148,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.mdx index 73b815de18e..f45f241a8d5 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabrePreLayout.mdx @@ -110,7 +110,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -118,7 +118,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.mdx index 650c4dcda63..73500220893 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SabreSwap.mdx @@ -110,7 +110,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -118,7 +118,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.mdx index 69420f60b70..3812ddf501f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetIOLatency.mdx @@ -53,7 +53,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -61,7 +61,7 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.mdx index e4443788923..b579a0d19bb 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SetLayout.mdx @@ -55,7 +55,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -63,7 +63,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.mdx index 01525f20a0e..df4cccd591f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Size.mdx @@ -48,7 +48,7 @@ python_api_name: qiskit.transpiler.passes.Size * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -56,7 +56,7 @@ python_api_name: qiskit.transpiler.passes.Size **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx index 08f672fe567..55c659059c7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SolovayKitaev.mdx @@ -145,7 +145,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -153,7 +153,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Split2QUnitaries.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Split2QUnitaries.mdx index a9dd8f39f20..2f9ec77034e 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Split2QUnitaries.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Split2QUnitaries.mdx @@ -51,7 +51,7 @@ python_api_name: qiskit.transpiler.passes.Split2QUnitaries * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -59,7 +59,7 @@ python_api_name: qiskit.transpiler.passes.Split2QUnitaries **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name @@ -79,7 +79,7 @@ python_api_name: qiskit.transpiler.passes.Split2QUnitaries **Parameters** - **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx index ad545b26d67..59e78bfbac9 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.StarPreRouting.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting # StarPreRouting - + Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Run star to linear pre-routing @@ -85,8 +85,8 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting **Parameters** - * **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") *|*[*DAGDependency*](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.dagdependency.DAGDependency")) – - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int)) – + * **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") *|*[*DAGDependency*](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.dagdependency.DAGDependency")) + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int)) ### execute @@ -98,7 +98,7 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -106,7 +106,7 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.SubstitutePi4Rotations.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.SubstitutePi4Rotations.mdx index 14365467fd8..8a13bb861e2 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.SubstitutePi4Rotations.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.SubstitutePi4Rotations.mdx @@ -77,7 +77,7 @@ python_api_name: qiskit.transpiler.passes.SubstitutePi4Rotations * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -85,7 +85,7 @@ python_api_name: qiskit.transpiler.passes.SubstitutePi4Rotations **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.mdx index c02da022e4f..f30e6f8621a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TemplateOptimization.mdx @@ -49,7 +49,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.mdx index 613122056f3..68451d4b066 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TimeUnitConversion.mdx @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -65,7 +65,7 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.mdx index a4a3878e61f..ab69dfbf811 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TranslateParameterizedGates.mdx @@ -99,7 +99,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -107,7 +107,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.mdx index 7de33433e07..eba535b2c11 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.TrivialLayout.mdx @@ -58,7 +58,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -66,7 +66,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx index 1ff5b18e498..7a17d737459 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnitarySynthesis.mdx @@ -64,7 +64,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -72,7 +72,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.mdx index faa731295a7..74fa635b01b 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Unroll3qOrMore.mdx @@ -49,7 +49,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -57,7 +57,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx index 12c91047efa..2c19e51977a 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollCustomDefinitions.mdx @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -68,7 +68,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.mdx index 3e4526f2c5c..792bfb21bb7 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.UnrollForLoops.mdx @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -60,7 +60,7 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.mdx index bd544c05a3b..fdb4dc3583f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2Layout.mdx @@ -77,7 +77,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -85,7 +85,7 @@ python_api_name: qiskit.transpiler.passes.VF2Layout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.mdx index 31ef8b6cc91..633d37ca48f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.VF2PostLayout.mdx @@ -79,7 +79,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -87,7 +87,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.mdx index a20956a40f5..f86a266fc58 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.Width.mdx @@ -44,7 +44,7 @@ python_api_name: qiskit.transpiler.passes.Width * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -52,7 +52,7 @@ python_api_name: qiskit.transpiler.passes.Width **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.WrapAngles.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.WrapAngles.mdx index 03e29f0803f..8b04e4946fe 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.WrapAngles.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.WrapAngles.mdx @@ -105,7 +105,7 @@ python_api_name: qiskit.transpiler.passes.WrapAngles * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any)) – 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) *| None*) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable)) – A callback function which is caller per execution of optimization task. **Returns** @@ -113,7 +113,7 @@ python_api_name: qiskit.transpiler.passes.WrapAngles **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [qiskit.passmanager.compilation\_status.PassManagerState](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any), [*PassManagerState*](qiskit.passmanager.PassManagerState "qiskit.passmanager.compilation_status.PassManagerState")] ### name diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx index 292496e5ed3..1d6af73f881 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu ### run - + Run synthesis for the given Operation. **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx index 58cdf196ce5..b2298289f17 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.mdx @@ -176,7 +176,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi ### run - + Run synthesis for the given unitary matrix **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx index bf9f8efb2b3..a936580dfd9 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl ### pass\_manager - + This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements **Parameters** diff --git a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 9e0702320c8..61ce871cc3f 100644 --- a/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/dev/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -22,9 +22,9 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl **Parameters** - * **stage\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – - * **plugin\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – - * **pm\_config** ([*PassManagerConfig*](qiskit.transpiler.PassManagerConfig "qiskit.transpiler.passmanager_config.PassManagerConfig")) – + * **stage\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) + * **plugin\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) + * **pm\_config** ([*PassManagerConfig*](qiskit.transpiler.PassManagerConfig "qiskit.transpiler.passmanager_config.PassManagerConfig")) **Return type** diff --git a/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.mdx b/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.mdx index e2c1cab8fcb..edbf2879a94 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.plot_bloch_multivector.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector * **font\_size** ([*float*](https://docs.python.org/3/library/functions.html#float)) – Font size for the Bloch ball figures. * **title\_font\_size** ([*float*](https://docs.python.org/3/library/functions.html#float)) – Font size for the title. * **title\_pad** ([*float*](https://docs.python.org/3/library/functions.html#float)) – Padding for the title (suptitle `y` position is `0.98` - * **title\_pad/100**\*\*)\*\*\*\*.\*\* (*and the image height will be extended by 1 +*) – + * **title\_pad/100**\*\*)\*\*\*\*.\*\* (*and the image height will be extended by 1 +*) **Returns** diff --git a/docs/api/qiskit/dev/qiskit.visualization.timeline_drawer.mdx b/docs/api/qiskit/dev/qiskit.visualization.timeline_drawer.mdx index cb6ba0a1a1d..888a31dba9e 100644 --- a/docs/api/qiskit/dev/qiskit.visualization.timeline_drawer.mdx +++ b/docs/api/qiskit/dev/qiskit.visualization.timeline_drawer.mdx @@ -266,35 +266,35 @@ python_api_name: qiskit.visualization.timeline_drawer * **layout.time\_axis\_map** – Callback function that determines the layout of horizontal axis labels. See `layouts` for more details. No default layout is set. (default None). - * **program** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – + * **program** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) - * **style** ([*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*,* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any)*] | None*) – + * **style** ([*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*,* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any)*] | None*) - * **time\_range** ([*Tuple*](https://docs.python.org/3/library/typing.html#typing.Tuple)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*,* [*int*](https://docs.python.org/3/library/functions.html#int)*]*) – + * **time\_range** ([*Tuple*](https://docs.python.org/3/library/typing.html#typing.Tuple)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*,* [*int*](https://docs.python.org/3/library/functions.html#int)*]*) - * **disable\_bits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List)*\[Bits]*) – + * **disable\_bits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List)*\[Bits]*) - * **show\_clbits** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – + * **show\_clbits** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) - * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – + * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) - * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – + * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) - * **show\_delays** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – + * **show\_delays** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) - * **show\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + * **show\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) - * **plotter** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **plotter** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) - * **axis** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any) *| None*) – + * **axis** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any) *| None*) - * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) - * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.target.Target") *| None*) – + * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.target.Target") *| None*) - * **show\_idle** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – + * **show\_idle** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) - * **show\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – + * **show\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) **Examples** diff --git a/docs/api/qiskit/dev/qpy.mdx b/docs/api/qiskit/dev/qpy.mdx index 34ecc966953..71e229ec991 100644 --- a/docs/api/qiskit/dev/qpy.mdx +++ b/docs/api/qiskit/dev/qpy.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.qpy --- + + - - # QPY serialization `qiskit.qpy` diff --git a/docs/api/qiskit/dev/quantum_info.mdx b/docs/api/qiskit/dev/quantum_info.mdx index 91a11d1713b..7eed218fbf7 100644 --- a/docs/api/qiskit/dev/quantum_info.mdx +++ b/docs/api/qiskit/dev/quantum_info.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.quantum_info --- + + - - # Quantum Information `qiskit.quantum_info` diff --git a/docs/api/qiskit/dev/result.mdx b/docs/api/qiskit/dev/result.mdx index 6cd43f60096..49f710ef920 100644 --- a/docs/api/qiskit/dev/result.mdx +++ b/docs/api/qiskit/dev/result.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.result --- + + - - # Experiment Results `qiskit.result` diff --git a/docs/api/qiskit/dev/root.mdx b/docs/api/qiskit/dev/root.mdx new file mode 100644 index 00000000000..4ef5cdce0a0 --- /dev/null +++ b/docs/api/qiskit/dev/root.mdx @@ -0,0 +1,37 @@ + + + + +# Root namespace ([`qiskit`](index#module-qiskit "qiskit")) + +Most Qiskit functionality is accessed through specific submodules. You can consult the top-level documentation of [`qiskit`](index#module-qiskit "qiskit") to find the list of modules, such as [`qiskit.circuit`](circuit#module-qiskit.circuit "qiskit.circuit") or [`qiskit.transpiler.passes`](transpiler_passes#module-qiskit.transpiler.passes "qiskit.transpiler.passes"). + +Several names are re-exported from the repository root, whose canonical public locations are in submodules. The re-exports in the root namespace are part of Qiskit’s public API. + +Names re-exported from [`qiskit.circuit`](circuit#module-qiskit.circuit "qiskit.circuit"): + +| | | +| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | +| [`AncillaRegister`](circuit#qiskit.circuit.AncillaRegister "qiskit.circuit.AncillaRegister")(\[size, name, bits]) | Implement an ancilla register. | +| [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")(\[size, name, bits]) | Implement a register. | +| [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")(\*regs\[, name, global\_phase, ...]) | Core Qiskit representation of a quantum circuit. | +| [`QuantumRegister`](circuit#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")(\[size, name, bits]) | Implement a register. | + +Names re-exported from [`qiskit.compiler`](compiler#module-qiskit.compiler "qiskit.compiler"): + +| | | +| ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| [`transpile`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile")(circuits\[, backend, basis\_gates, ...]) | Transpile one or more circuits, according to some desired transpilation targets. | + +Names re-exported from [`qiskit.exceptions`](exceptions#module-qiskit.exceptions "qiskit.exceptions"): + +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| [`MissingOptionalLibraryError`](exceptions#qiskit.exceptions.MissingOptionalLibraryError "qiskit.exceptions.MissingOptionalLibraryError")(libname, name\[, ...]) | Raised when an optional library is missing. | +| [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError")(\*message) | Base class for errors raised by Qiskit. | + +Names re-exported from [`qiskit.transpiler`](transpiler#module-qiskit.transpiler "qiskit.transpiler"): + +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | +| [`generate_preset_pass_manager`](qiskit.transpiler.generate_preset_pass_manager "qiskit.transpiler.generate_preset_pass_manager")(\[...]) | Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") | diff --git a/docs/api/qiskit/dev/synthesis.mdx b/docs/api/qiskit/dev/synthesis.mdx index ca7cc8e016a..45ff69b4417 100644 --- a/docs/api/qiskit/dev/synthesis.mdx +++ b/docs/api/qiskit/dev/synthesis.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.synthesis --- + + - - # Circuit Synthesis `qiskit.synthesis` @@ -718,7 +718,7 @@ python_api_name: qiskit.synthesis **Parameters** - * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*qiskit.circuit.gate.Gate*](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")*]*) – The gates from which to create the sequences of gates. + * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")*]*) – The gates from which to create the sequences of gates. * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int)) – The maximum depth of the approximations. * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – If provided, the basic approximations are stored in this file. @@ -1584,7 +1584,7 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u **Parameters** - **weighted\_sum** ([*WeightedSumGate*](qiskit.circuit.library.WeightedSumGate "qiskit.circuit.library.WeightedSumGate")) – + **weighted\_sum** ([*WeightedSumGate*](qiskit.circuit.library.WeightedSumGate "qiskit.circuit.library.WeightedSumGate")) **Return type** diff --git a/docs/api/qiskit/dev/transpiler.mdx b/docs/api/qiskit/dev/transpiler.mdx index cd18e251ef2..98b8fe7ce3e 100644 --- a/docs/api/qiskit/dev/transpiler.mdx +++ b/docs/api/qiskit/dev/transpiler.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.transpiler --- + + - - # Transpiler `qiskit.transpiler` @@ -209,7 +209,7 @@ When writing [stage plugins](transpiler_plugins#transpiler-preset-stage-plugins) #### Built-in `default` plugin -At optimization level 0, no abstract optimization is done. The default plugin simply “unrolls” operations with more than three qubits by accessing their hierarchical `definition` fields. +At optimization level 0, no abstract optimization is done. The default plugin simply “unrolls” operations with more than three qubits by accessing their hierarchical [`definition`](qiskit.circuit.Instruction#definition "qiskit.circuit.Instruction.definition") fields. At optimization levels 1 and above, the default plugin also does simple cancellation of adjacent inverse gates, such as two back-to-back `cx` gates. @@ -1070,7 +1070,7 @@ The scheduling of a circuit involves two parts: analysis and constraint mapping, ### Optimization metric -| | | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | -| [`OptimizationMetric`](qiskit.transpiler.OptimizationMetric "qiskit.transpiler.OptimizationMetric")(value) | Optimization metric considered during transpilation. | +| | | +| ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| [`OptimizationMetric`](qiskit.transpiler.OptimizationMetric "qiskit.transpiler.OptimizationMetric")(\*values) | Optimization metric considered during transpilation. | diff --git a/docs/api/qiskit/dev/transpiler_passes.mdx b/docs/api/qiskit/dev/transpiler_passes.mdx index 532bd2277eb..2838435fa8e 100644 --- a/docs/api/qiskit/dev/transpiler_passes.mdx +++ b/docs/api/qiskit/dev/transpiler_passes.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.transpiler.passes --- + + - - # Transpiler Passes `qiskit.transpiler.passes` @@ -41,7 +41,7 @@ python_api_name: qiskit.transpiler.passes | [`LayoutTransformation`](qiskit.transpiler.passes.LayoutTransformation "qiskit.transpiler.passes.LayoutTransformation")(\*args, \*\*kwargs) | Adds a Swap circuit for a given (partial) permutation to the circuit. | | [`LookaheadSwap`](qiskit.transpiler.passes.LookaheadSwap "qiskit.transpiler.passes.LookaheadSwap")(\*args, \*\*kwargs) | Map input circuit onto a backend topology via insertion of SWAPs. | | [`SabreSwap`](qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap")(\*args, \*\*kwargs) | Map input circuit onto a backend topology via insertion of SWAPs. | -| [`StarPreRouting`](qiskit.transpiler.passes.StarPreRouting "qiskit.transpiler.passes.StarPreRouting")(\*args, \*\*kwargs) | Run star to linear pre-routing | +| [`StarPreRouting`](qiskit.transpiler.passes.StarPreRouting "qiskit.transpiler.passes.StarPreRouting")() | Run star to linear pre-routing | ## Basis Change diff --git a/docs/api/qiskit/dev/transpiler_plugins.mdx b/docs/api/qiskit/dev/transpiler_plugins.mdx index 7dfaa25770f..3302afcb797 100644 --- a/docs/api/qiskit/dev/transpiler_plugins.mdx +++ b/docs/api/qiskit/dev/transpiler_plugins.mdx @@ -6,14 +6,14 @@ python_api_type: module python_api_name: qiskit.transpiler.preset_passmanagers.plugin --- - - - - + + + + # Transpiler Stage Plugin Interface `qiskit.transpiler.preset_passmanagers.plugin` diff --git a/docs/api/qiskit/dev/transpiler_preset.mdx b/docs/api/qiskit/dev/transpiler_preset.mdx index 710d881df93..78b9d613820 100644 --- a/docs/api/qiskit/dev/transpiler_preset.mdx +++ b/docs/api/qiskit/dev/transpiler_preset.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.transpiler.preset_passmanagers --- + + - - # Preset Passmanagers `qiskit.transpiler.preset_passmanagers` diff --git a/docs/api/qiskit/dev/transpiler_synthesis_plugins.mdx b/docs/api/qiskit/dev/transpiler_synthesis_plugins.mdx index bd02687a02e..a89a5aa93b3 100644 --- a/docs/api/qiskit/dev/transpiler_synthesis_plugins.mdx +++ b/docs/api/qiskit/dev/transpiler_synthesis_plugins.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.transpiler.passes.synthesis.plugin --- + + - - # Synthesis Plugins `qiskit.transpiler.passes.synthesis.plugin` diff --git a/docs/api/qiskit/dev/utils.mdx b/docs/api/qiskit/dev/utils.mdx index be4f1839ed9..e9f7864b5c6 100644 --- a/docs/api/qiskit/dev/utils.mdx +++ b/docs/api/qiskit/dev/utils.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.utils --- + + - - # Utilities `qiskit.utils` @@ -121,8 +121,8 @@ python_api_name: qiskit.utils **Parameters** - * **value** ([*float*](https://docs.python.org/3/library/functions.html#float) *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – - * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – + * **value** ([*float*](https://docs.python.org/3/library/functions.html#float) *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) + * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) **Return type** @@ -168,8 +168,8 @@ python_api_name: qiskit.utils **Parameters** - * **value** ([*float*](https://docs.python.org/3/library/functions.html#float)) – - * **decimal** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – + * **value** ([*float*](https://docs.python.org/3/library/functions.html#float)) + * **decimal** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) **Return type** @@ -191,8 +191,8 @@ python_api_name: qiskit.utils * **cls** ([*Type*](https://docs.python.org/3/library/typing.html#typing.Type)) – the class to modify. * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – the name of the method on the class to wrap. - * **before** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable) *| None*) – a callable that should be called before the method that is being wrapped. - * **after** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable) *| None*) – a callable that should be called after the method that is being wrapped. + * **before** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)) – a callable that should be called before the method that is being wrapped. + * **after** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)) – a callable that should be called after the method that is being wrapped. **Raises** @@ -275,7 +275,7 @@ python_api_name: qiskit.utils **Parameters** - **value** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – + **value** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) ### ignore\_user\_settings @@ -611,7 +611,7 @@ from qiskit.utils import LazyImportTester ##### \_is\_available - + Subclasses of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") should override this method to implement the actual test of availability. This method should return a Boolean, where `True` indicates that the dependency was available. This method will only ever be called once. **Return type** @@ -686,10 +686,10 @@ from qiskit.utils import LazyImportTester **Parameters** * **name\_map\_or\_modules** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*,* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*]] |* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*]*) – if a name map, then a dictionary where the keys are modules or packages, and the values are iterables of names to try and import from that module. It should be valid to write `from import , , ...`. If simply a string or iterable of strings, then it should be valid to write `import ` for each of them. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool)*], None] | None*) – - * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool)*], None] | None*) + * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) **Raises** @@ -706,10 +706,10 @@ from qiskit.utils import LazyImportTester **Parameters** * **command** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable)*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str)*]*) – the strings that make up the command to be run. For example, `["pdflatex", "-version"]`. - * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool)*], None] | None*) – - * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – - * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable)*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool)*], None] | None*) + * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) **Raises** diff --git a/docs/api/qiskit/dev/visualization.mdx b/docs/api/qiskit/dev/visualization.mdx index 46d904252a0..21d7751e4c6 100644 --- a/docs/api/qiskit/dev/visualization.mdx +++ b/docs/api/qiskit/dev/visualization.mdx @@ -6,12 +6,12 @@ python_api_type: module python_api_name: qiskit.visualization --- + + - - # Visualizations `qiskit.visualization` diff --git a/public/docs/api/qiskit/dev/objects.inv b/public/docs/api/qiskit/dev/objects.inv index 64df4b32d57..7c1ffd62ae1 100644 Binary files a/public/docs/api/qiskit/dev/objects.inv and b/public/docs/api/qiskit/dev/objects.inv differ diff --git a/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-2.avif b/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-2.avif index f3c96c46644..3700ebb2efd 100644 Binary files a/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-2.avif and b/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-2.avif differ diff --git a/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif b/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif index 9218e47a048..efa2b35992a 100644 Binary files a/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif and b/public/docs/images/api/qiskit-ibm-runtime/dev/fake_provider-3.avif differ diff --git a/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif b/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif index e53873b04eb..af73b473324 100644 Binary files a/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif and b/public/docs/images/api/qiskit-ibm-runtime/dev/twirling_strategy_options.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit-1.avif b/public/docs/images/api/qiskit/dev/circuit-1.avif index 56d6878645e..9176102ae2f 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit-1.avif and b/public/docs/images/api/qiskit/dev/circuit-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit-4.avif b/public/docs/images/api/qiskit/dev/circuit-4.avif index 67a23271751..987b3bb62fc 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit-4.avif and b/public/docs/images/api/qiskit/dev/circuit-4.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit_library-1.avif b/public/docs/images/api/qiskit/dev/circuit_library-1.avif index 28e0e8cb53e..9f567b8554f 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit_library-1.avif and b/public/docs/images/api/qiskit/dev/circuit_library-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit_library-2.avif b/public/docs/images/api/qiskit/dev/circuit_library-2.avif index aa63bfb921a..34c59c0fc0a 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit_library-2.avif and b/public/docs/images/api/qiskit/dev/circuit_library-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit_library-3.avif b/public/docs/images/api/qiskit/dev/circuit_library-3.avif index b76cc689d48..a8fedcab853 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit_library-3.avif and b/public/docs/images/api/qiskit/dev/circuit_library-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit_library-5.avif b/public/docs/images/api/qiskit/dev/circuit_library-5.avif index 6397f511198..cfd23aad9ac 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit_library-5.avif and b/public/docs/images/api/qiskit/dev/circuit_library-5.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit_library-6_00.avif b/public/docs/images/api/qiskit/dev/circuit_library-6_00.avif index 6397f511198..cfd23aad9ac 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit_library-6_00.avif and b/public/docs/images/api/qiskit/dev/circuit_library-6_00.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit_library-6_01.avif b/public/docs/images/api/qiskit/dev/circuit_library-6_01.avif index 845a33b6007..48a599338be 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit_library-6_01.avif and b/public/docs/images/api/qiskit/dev/circuit_library-6_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit_random-1.avif b/public/docs/images/api/qiskit/dev/circuit_random-1.avif index afd162924c1..44307829600 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit_random-1.avif and b/public/docs/images/api/qiskit/dev/circuit_random-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit_random-2.avif b/public/docs/images/api/qiskit/dev/circuit_random-2.avif index e8935b23d64..302fa75cac2 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit_random-2.avif and b/public/docs/images/api/qiskit/dev/circuit_random-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/circuit_random-3.avif b/public/docs/images/api/qiskit/dev/circuit_random-3.avif index 74b9bd572f1..a59f5f8e465 100644 Binary files a/public/docs/images/api/qiskit/dev/circuit_random-3.avif and b/public/docs/images/api/qiskit/dev/circuit_random-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/converters-3.avif b/public/docs/images/api/qiskit/dev/converters-3.avif index af1af31d9bd..c9d1d7987c6 100644 Binary files a/public/docs/images/api/qiskit/dev/converters-3.avif and b/public/docs/images/api/qiskit/dev/converters-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/mapping.avif b/public/docs/images/api/qiskit/dev/mapping.avif index 99de6b6cf46..404191e1233 100644 Binary files a/public/docs/images/api/qiskit/dev/mapping.avif and b/public/docs/images/api/qiskit/dev/mapping.avif differ diff --git a/public/docs/images/api/qiskit/dev/providers_fake_provider-1_00.avif b/public/docs/images/api/qiskit/dev/providers_fake_provider-1_00.avif index f2585e37267..aba725dd64f 100644 Binary files a/public/docs/images/api/qiskit/dev/providers_fake_provider-1_00.avif and b/public/docs/images/api/qiskit/dev/providers_fake_provider-1_00.avif differ diff --git a/public/docs/images/api/qiskit/dev/providers_fake_provider-1_01.avif b/public/docs/images/api/qiskit/dev/providers_fake_provider-1_01.avif index c423ab10858..7ace35846f7 100644 Binary files a/public/docs/images/api/qiskit/dev/providers_fake_provider-1_01.avif and b/public/docs/images/api/qiskit/dev/providers_fake_provider-1_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/providers_fake_provider-1_02.avif b/public/docs/images/api/qiskit/dev/providers_fake_provider-1_02.avif index 4875d6a7d0d..464dd923d17 100644 Binary files a/public/docs/images/api/qiskit/dev/providers_fake_provider-1_02.avif and b/public/docs/images/api/qiskit/dev/providers_fake_provider-1_02.avif differ diff --git a/public/docs/images/api/qiskit/dev/qasm3-3.avif b/public/docs/images/api/qiskit/dev/qasm3-3.avif index 95795a12307..39102727176 100644 Binary files a/public/docs/images/api/qiskit/dev/qasm3-3.avif and b/public/docs/images/api/qiskit/dev/qasm3-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-1.avif index b2a15e4a9cb..a497d97e789 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.avif index 28bff5572da..3a9bacce2cf 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-ControlledGate-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-Operation-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-Operation-1.avif index b450722f0e6..079a65aa3ea 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-Operation-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-Operation-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif index f9d6510f12a..57fdb7f8a57 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_00.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_01.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_01.avif index 59496c4c799..2e564d5bfe9 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_01.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-Parameter-1_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-15_00.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-15_00.avif index 09aadefe067..505f8f0a113 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-15_00.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-15_00.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-15_01.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-15_01.avif index 3d1516fd4fa..76fed09bd39 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-15_01.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-15_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-16_00.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-16_00.avif index 110c246fdd8..23fdc154748 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-16_00.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-16_00.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-16_01.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-16_01.avif index 2e26f799ba3..af1c3b6714f 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-16_01.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-16_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-17.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-17.avif index ce31624f113..03cbb361357 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-17.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-17.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-30.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-30.avif index 18370601390..baeb6796b2f 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-30.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-30.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif index 4ab760cd15a..bc11d2982aa 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-QuantumCircuit-31.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AND-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AND-1.avif index 39da805545e..0f1726292a2 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AND-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AND-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AND-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AND-2.avif index 812251a7f25..785e1988c5a 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AND-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AND-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-1.avif index 868b8c3b741..74249ad5838 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-2.avif index 986d34cbde1..e88e2a2129c 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-AndGate-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-BitwiseXorGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-BitwiseXorGate-1.avif index 4c2e74916ad..4d680d5a7b7 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-BitwiseXorGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-BitwiseXorGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-FourierChecking-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-FourierChecking-1.avif index 03044f8114d..111842c3fb9 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-FourierChecking-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-FourierChecking-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GMS-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GMS-1.avif index 18204851ac4..06e30594cc4 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GMS-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GMS-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GR-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GR-1.avif index 85783ea7731..12e7c30d1e7 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GR-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GR-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRX-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRX-1.avif index 5df3ab8a97c..93ec6621ada 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRX-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRX-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRY-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRY-1.avif index 85783ea7731..12e7c30d1e7 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRY-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRY-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRZ-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRZ-1.avif index 0de984e3246..f2290ef1ac6 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRZ-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GRZ-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GraphState-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GraphState-1.avif index 7514ae7ac6f..c591d6ba4c9 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GraphState-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GraphState-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GraphStateGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GraphStateGate-1.avif index 506f57a7c72..fa3543f6b00 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GraphStateGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-GraphStateGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-HiddenLinearFunction-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-HiddenLinearFunction-1.avif index ccddf185ac3..fc43d16fff0 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-HiddenLinearFunction-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-HiddenLinearFunction-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-IQP-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-IQP-1.avif index 62fab8af44c..6d0a3358831 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-IQP-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-IQP-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-IQP-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-IQP-2.avif index a326302c04c..1d47d1f1508 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-IQP-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-IQP-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProduct-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProduct-1.avif index 9a063231479..c930510d49c 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProduct-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProduct-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProductGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProductGate-1.avif index ee43c5299de..c38410692c4 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProductGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-InnerProductGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-MCMTVChain-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-MCMTVChain-1.avif index 6e7405dd518..8c09ac89253 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-MCMTVChain-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-MCMTVChain-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OR-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OR-1.avif index 42dbf9dc025..cf89fb1339c 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OR-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OR-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OR-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OR-2.avif index 30b2f4794f9..71699895c63 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OR-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OR-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-1.avif index 1c25af97f83..df7b7e5286e 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-2.avif index e9872da8531..af5d36542cf 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-OrGate-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PauliTwoDesign-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PauliTwoDesign-1.avif index 2b20f049fc0..2d3ac232796 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PauliTwoDesign-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PauliTwoDesign-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-Permutation-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-Permutation-1.avif index ecfefbc95ef..c1b2f624b91 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-Permutation-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-Permutation-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-Permutation-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-Permutation-2.avif index ecb856e387d..3ec0cccae7c 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-Permutation-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-Permutation-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-1.avif index 16225987b1e..e3472c496ef 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.avif index bb7a2ff177e..081a875fd18 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PermutationGate-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.avif index 336ab71cd69..aafa821849e 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PhaseEstimation-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshev-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshev-1.avif index 1261c5db72b..119907a440f 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshev-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshev-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshevGate-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshevGate-1.avif index 3f29187246c..9af0df714bc 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshevGate-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-PiecewiseChebyshevGate-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-1.avif index a2b788933d6..7d88f8191b4 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-2.avif index 49d59a9a08f..ab5b9da19a3 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-3.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-3.avif index e597808b262..6564ea5703b 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-3.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QFT-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-1.avif index ce6f576317a..c8e425b47cc 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-2.avif index c1bc3195451..74fc4b496b2 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-QuantumVolume-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-XOR-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-XOR-1.avif index 3c4c2572669..00d79eed471 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-XOR-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-XOR-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-efficient_su2-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-efficient_su2-1.avif index 0e58e78b377..0e83f6ca681 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-efficient_su2-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-efficient_su2-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-efficient_su2-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-efficient_su2-2.avif index 86891b85ed4..7bd127f4f50 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-efficient_su2-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-efficient_su2-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-evolved_operator_ansatz-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-evolved_operator_ansatz-1.avif index 075b603be42..a7d1c6995a8 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-evolved_operator_ansatz-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-evolved_operator_ansatz-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-1.avif index 28a45ce7cd0..caf0c4cd455 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-2_00.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-2_00.avif index 28a45ce7cd0..caf0c4cd455 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-2_00.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-2_00.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-2_01.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-2_01.avif index a59a3f433dc..608014a8adb 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-2_01.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-excitation_preserving-2_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-fourier_checking-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-fourier_checking-1.avif index 71447098b0f..50d2c4b7c73 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-fourier_checking-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-fourier_checking-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-1.avif index c68a8c6e5a8..b3f4eb35302 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-2.avif index 83f4f1cee4a..fc056535fb2 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-3.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-3.avif index d6510c9570c..490222aa852 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-3.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-4.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-4.avif index 9c6938c8f1b..9a1c7fa6bde 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-4.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-grover_operator-4.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hamiltonian_variational_ansatz-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hamiltonian_variational_ansatz-1.avif index 96e83fe015e..7934c149b37 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hamiltonian_variational_ansatz-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hamiltonian_variational_ansatz-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hamiltonian_variational_ansatz-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hamiltonian_variational_ansatz-2.avif index bef5063524c..bb13dfdbe65 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hamiltonian_variational_ansatz-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hamiltonian_variational_ansatz-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hidden_linear_function-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hidden_linear_function-1.avif index 7ec7a1f0c8d..6654a2a675f 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hidden_linear_function-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-hidden_linear_function-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-iqp_function-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-iqp_function-1.avif index b513cd7c83b..3de4b62d03e 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-iqp_function-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-iqp_function-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-iqp_function-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-iqp_function-2.avif index a326302c04c..1d47d1f1508 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-iqp_function-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-iqp_function-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-1.avif index e45f8ba8db3..fe6c29a5b81 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-2.avif index c5cb1c18992..40a59088985 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-3.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-3.avif index 67db1134e11..85c28eabcbb 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-3.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-4.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-4.avif index 4298e962fb7..ff3212b20e2 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-4.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-4.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-5.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-5.avif index 7308c8edc0c..747d57d5036 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-5.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-n_local-5.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-pauli_two_design-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-pauli_two_design-1.avif index 542d9ecc4dd..145b712d605 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-pauli_two_design-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-pauli_two_design-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-phase_estimation-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-phase_estimation-1.avif index cb95ddf0662..727f29a9be4 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-phase_estimation-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-phase_estimation-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-qaoa_ansatz-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-qaoa_ansatz-1.avif index d957d008ded..51472773c31 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-qaoa_ansatz-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-qaoa_ansatz-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-quantum_volume-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-quantum_volume-1.avif index 90f7c00c0d9..a667404d2b7 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-quantum_volume-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-quantum_volume-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-random_iqp-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-random_iqp-1.avif index e6c5250c874..d8f121ba566 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-random_iqp-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-random_iqp-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-1.avif index 737c0b468b5..de7c5b1bff6 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-2.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-2.avif index 08a9077b9fd..1ea836873c2 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-3.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-3.avif index e45f8ba8db3..fe6c29a5b81 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-3.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-4.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-4.avif index 3a5fe439678..d66279e60db 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-4.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-real_amplitudes-4.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-unitary_overlap-1.avif b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-unitary_overlap-1.avif index 185c345c298..da7d38a1116 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-circuit-library-unitary_overlap-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-circuit-library-unitary_overlap-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-primitives-StatevectorEstimator-1.avif b/public/docs/images/api/qiskit/dev/qiskit-primitives-StatevectorEstimator-1.avif index 60e4f4f88a0..d300f1597fd 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-primitives-StatevectorEstimator-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-primitives-StatevectorEstimator-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif b/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif index 74cd2fbba0b..ead0dcbc122 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-quantum_info-Statevector-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-1.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-1.avif index 5165af00773..fc2ce432ddf 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-2.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-2.avif index 1c0fabfd048..35757617fd5 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-3.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-3.avif index 8fe23daeb85..e9eeb2fb703 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-3.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-TranspileLayout-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif index d6a792e8ce5..7c0b63961e5 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-FilterOpNodes-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.avif index 726d484664b..f3f471ddf99 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.avif index 49ba49d4bfd..702d050348c 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif index 50ebc393f33..f631a979e45 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-RemoveBarriers-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-StarPreRouting-1.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-StarPreRouting-1.avif index daea50ed68f..db9fe643d13 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-StarPreRouting-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-StarPreRouting-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-WrapAngles-1.avif b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-WrapAngles-1.avif index b1d0f033f12..91128befd61 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-WrapAngles-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-transpiler-passes-WrapAngles-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif index 37e82ed978e..bc11d2982aa 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-circuit_drawer-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-1.avif index 1d4e7c10d5a..fb0e524d1ed 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-2.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-2.avif index 22f31773ffc..6f8f7e0c281 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_multivector-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-1.avif index 4b6535eb944..65925a9d173 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-2.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-2.avif index 06b122e81ce..b044c11d30e 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_bloch_vector-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.avif index d1d560fd0a4..254ef3a4b4b 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_circuit_layout-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_coupling_map-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_coupling_map-1.avif index 918a663df17..b5ee1b1dc49 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_coupling_map-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_coupling_map-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_00.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_00.avif index d03d90d6d93..b210bd007d9 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_00.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_00.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_01.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_01.avif index c2fa7db83f3..d5dbc869be9 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_01.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_02.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_02.avif index 3b587abf5e0..d96e9394d3a 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_02.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_distribution-1_02.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.avif index 4c05b26bd81..57958b2c1cd 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_error_map-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_gate_map-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_gate_map-1.avif index a2cf4d4d3cd..503e8ae1e17 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_gate_map-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_gate_map-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_00.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_00.avif index 382a503bcc5..f26295e162b 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_00.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_00.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif index e4f6e2b1925..37da4a4faa6 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_01.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_02.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_02.avif index d4a5c6fcd88..cd4b64c3505 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_02.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_histogram-1_02.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_city-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_city-1.avif index d1ee75a6e57..44829252c88 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_city-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_city-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_city-2.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_city-2.avif index 2e16bca4eff..4fdbd06c63f 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_city-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_city-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif index 1f728ae42e9..1f76c9aa89f 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_hinton-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-1.avif index a50f094acef..b31a3d0f98a 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-2.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-2.avif index d2a17e4744e..59e129d1ad1 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_paulivec-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-1.avif index 398d6f274d6..9fd3e0fcd67 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-2.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-2.avif index f8581e0059b..cc266f47d8c 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-plot_state_qsphere-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.avif index 5b575718ad7..441206ea5ff 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.avif index 84027da0577..0938b072c12 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.avif b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.avif index aa1e216c639..803a9a0b03b 100644 Binary files a/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.avif and b/public/docs/images/api/qiskit/dev/qiskit-visualization-timeline_drawer-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/synthesis-1.avif b/public/docs/images/api/qiskit/dev/synthesis-1.avif index 9ae7ec37ff3..827db36db3a 100644 Binary files a/public/docs/images/api/qiskit/dev/synthesis-1.avif and b/public/docs/images/api/qiskit/dev/synthesis-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/synthesis-2.avif b/public/docs/images/api/qiskit/dev/synthesis-2.avif index 6f5da62e0fe..c1573928322 100644 Binary files a/public/docs/images/api/qiskit/dev/synthesis-2.avif and b/public/docs/images/api/qiskit/dev/synthesis-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/transpiler-10.avif b/public/docs/images/api/qiskit/dev/transpiler-10.avif index cf0da3c8b7d..7e52b0dd425 100644 Binary files a/public/docs/images/api/qiskit/dev/transpiler-10.avif and b/public/docs/images/api/qiskit/dev/transpiler-10.avif differ diff --git a/public/docs/images/api/qiskit/dev/transpiler-8.avif b/public/docs/images/api/qiskit/dev/transpiler-8.avif index e670c53e749..44cb245c99c 100644 Binary files a/public/docs/images/api/qiskit/dev/transpiler-8.avif and b/public/docs/images/api/qiskit/dev/transpiler-8.avif differ diff --git a/public/docs/images/api/qiskit/dev/transpiler-9.avif b/public/docs/images/api/qiskit/dev/transpiler-9.avif index 79cf8edc35d..88c7a6279fb 100644 Binary files a/public/docs/images/api/qiskit/dev/transpiler-9.avif and b/public/docs/images/api/qiskit/dev/transpiler-9.avif differ diff --git a/public/docs/images/api/qiskit/dev/transpiling_core_steps.avif b/public/docs/images/api/qiskit/dev/transpiling_core_steps.avif index fd99d6db43c..9afadc5293f 100644 Binary files a/public/docs/images/api/qiskit/dev/transpiling_core_steps.avif and b/public/docs/images/api/qiskit/dev/transpiling_core_steps.avif differ diff --git a/public/docs/images/api/qiskit/dev/visualization-1.avif b/public/docs/images/api/qiskit/dev/visualization-1.avif index 94a6053a76f..b43730ad987 100644 Binary files a/public/docs/images/api/qiskit/dev/visualization-1.avif and b/public/docs/images/api/qiskit/dev/visualization-1.avif differ diff --git a/public/docs/images/api/qiskit/dev/visualization-2.avif b/public/docs/images/api/qiskit/dev/visualization-2.avif index 8c64466b4ed..9a54f7acd1e 100644 Binary files a/public/docs/images/api/qiskit/dev/visualization-2.avif and b/public/docs/images/api/qiskit/dev/visualization-2.avif differ diff --git a/public/docs/images/api/qiskit/dev/visualization-3.avif b/public/docs/images/api/qiskit/dev/visualization-3.avif index ed025593a9c..7ee6edef6de 100644 Binary files a/public/docs/images/api/qiskit/dev/visualization-3.avif and b/public/docs/images/api/qiskit/dev/visualization-3.avif differ diff --git a/public/docs/images/api/qiskit/dev/visualization-4.avif b/public/docs/images/api/qiskit/dev/visualization-4.avif index 293fa230a15..67d987386cb 100644 Binary files a/public/docs/images/api/qiskit/dev/visualization-4.avif and b/public/docs/images/api/qiskit/dev/visualization-4.avif differ diff --git a/public/docs/images/api/qiskit/dev/visualization-5.avif b/public/docs/images/api/qiskit/dev/visualization-5.avif index 48506ed4348..89c9836776d 100644 Binary files a/public/docs/images/api/qiskit/dev/visualization-5.avif and b/public/docs/images/api/qiskit/dev/visualization-5.avif differ diff --git a/public/docs/images/api/qiskit/dev/visualization-6.avif b/public/docs/images/api/qiskit/dev/visualization-6.avif index 48506ed4348..89c9836776d 100644 Binary files a/public/docs/images/api/qiskit/dev/visualization-6.avif and b/public/docs/images/api/qiskit/dev/visualization-6.avif differ diff --git a/scripts/config/api-html-artifacts.json b/scripts/config/api-html-artifacts.json index fb511f38399..472e40e8244 100644 --- a/scripts/config/api-html-artifacts.json +++ b/scripts/config/api-html-artifacts.json @@ -1,6 +1,6 @@ { "qiskit": { - "dev": "https://api.github.com/repos/Qiskit/qiskit/actions/artifacts/5218013247/zip", + "dev": "https://api.github.com/repos/Qiskit/qiskit/actions/artifacts/5285603325/zip", "2.3": "https://ibm.box.com/shared/static/hu6gvj4857vb5sew5k98rr9yd7pxasqy.zip", "2.2": "https://ibm.box.com/shared/static/c1lktwwwo9zu4z5wxqg1xs9fj57oeoco.zip", "2.1": "https://ibm.box.com/shared/static/mplc0lvu7mi2xwri9z3y0u0lr6z9ivwv.zip", @@ -35,7 +35,7 @@ "0.19": "https://ibm.box.com/shared/static/wjoea4x5tnxd0l4lgo2v3kxnx6btxvvl.zip" }, "qiskit-ibm-runtime": { - "dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/5208052291/zip", + "dev": "https://api.github.com/repos/Qiskit/qiskit-ibm-runtime/actions/artifacts/5230621787/zip", "0.45": "https://ibm.box.com/shared/static/5o5rt86cc2ehvxmslleecat3iyob8igu.zip", "0.44": "https://ibm.box.com/shared/static/o00e7wxcslox4vq3z0rz35093y40sfko.zip", "0.43": "https://ibm.box.com/shared/static/nlpyvweh4n0xhuvl08p8zpykkkchgi2a.zip", diff --git a/scripts/config/historical-pages-to-latest.json b/scripts/config/historical-pages-to-latest.json index a5d8dec86d9..7585dca0020 100644 --- a/scripts/config/historical-pages-to-latest.json +++ b/scripts/config/historical-pages-to-latest.json @@ -1125,7 +1125,8 @@ "qiskit.primitives.ObservableLike": "/", "qiskit.primitives.ObservablesArray": "/", "qiskit.primitives.ParameterLike": "/", - "qiskit.primitives.SamplerPub": "/" + "qiskit.primitives.SamplerPub": "/", + "root": "/" } }, "qiskit-ibm-runtime": { diff --git a/scripts/js/lib/api/generateApiComponents.ts b/scripts/js/lib/api/generateApiComponents.ts index 52f5291b021..ce7619eb7c2 100644 --- a/scripts/js/lib/api/generateApiComponents.ts +++ b/scripts/js/lib/api/generateApiComponents.ts @@ -256,10 +256,20 @@ function prepareAttributeOrPropertyProps( // between an attribute and property. However, we preserve the full string if it's `abstract property`. // // Meanwhile, we preserve the non-modifier `em.property` elements to be processed below. - const rawModifiers = $child + let rawModifiers = $child .find("em.property") .filter((i, el) => $(el).text().includes("property")); - const modifiersText = rawModifiers.text().trim(); + let modifiersText = rawModifiers.text().trim(); + + // Temporary workaround: Sphinx 9 uses `span` instead of + // `em` to define the modifiers + if (!modifiersText) { + rawModifiers = $child + .find("span.property") + .filter((i, el) => $(el).text().includes("property")); + modifiersText = rawModifiers.text().trim(); + } + const filteredModifiers = modifiersText === "property" ? undefined : modifiersText; rawModifiers.remove(); @@ -432,8 +442,16 @@ export function findByText( } function getAndRemoveModifiers($child: Cheerio): string { - const rawModifiers = $child.find("em.property"); - const modifiers = rawModifiers.text().trim(); + let rawModifiers = $child.find("em.property"); + let modifiers = rawModifiers.text().trim(); + + // Temporary workaround: Sphinx 9 uses `span` instead of + // `em` to define the modifiers + if (!modifiers) { + rawModifiers = $child.find("span.property"); + modifiers = rawModifiers.text().trim(); + } + rawModifiers.remove(); return modifiers; }