diff --git a/docs/api/qiskit/circuit.mdx b/docs/api/qiskit/circuit.mdx index 68a1449b06c..5d842e82324 100644 --- a/docs/api/qiskit/circuit.mdx +++ b/docs/api/qiskit/circuit.mdx @@ -250,6 +250,8 @@ Qubits and classical bits are represented by a shared base [`Bit`](#qiskit.circu #### Bit + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Implement a generic bit. @@ -290,6 +292,8 @@ A collection bits of the same type can be encapsulated in a register of the matc #### Register + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Implement a generic register. @@ -341,6 +345,11 @@ Each of the defined bit subtypes has an associated register, which have the same Bases: [`Register`](#qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a quantum register. + + **Parameters** + + * **size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – #### ClassicalRegister @@ -349,6 +358,11 @@ Each of the defined bit subtypes has an associated register, which have the same Bases: [`Register`](#qiskit.circuit.Register "qiskit.circuit.register.Register") Implement a classical register. + + **Parameters** + + * **size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – #### AncillaRegister @@ -357,6 +371,11 @@ Each of the defined bit subtypes has an associated register, which have the same Bases: [`QuantumRegister`](#qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") Implement an ancilla register. + + **Parameters** + + * **size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – A common way to instantiate several bits at once is to create a register, such as by `QuantumRegister("my_qreg", 5)`. This has the advantage that you can give that collection of bits a name, which will appear during circuit visualizations ([`QuantumCircuit.draw()`](qiskit.circuit.QuantumCircuit#draw "qiskit.circuit.QuantumCircuit.draw")) and exports to interchange languages (see [`qasm2`](qasm2#module-qiskit.qasm2 "qiskit.qasm2") and [`qasm3`](qasm3#module-qiskit.qasm3 "qiskit.qasm3")). You can also pass a name and a list of pre-constructed bits, but this creates an “aliasing register”, which are very poorly supported on hardware. @@ -432,19 +451,34 @@ The available modifiers for [`AnnotatedOperation`](qiskit.circuit.AnnotatedOpera #### InverseModifier + Bases: `Modifier` + Inverse modifier: specifies that the operation is inverted. #### ControlModifier + Bases: `Modifier` + Control modifier: specifies that the operation is controlled by `num_ctrl_qubits` and has control state `ctrl_state`. + + **Parameters** + + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – #### PowerModifier + Bases: `Modifier` + Power modifier: specifies that the operation is raised to the power `power`. + + **Parameters** + + **power** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – 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. @@ -946,6 +980,8 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c ### CircuitError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised while processing a circuit. Set the error message. diff --git a/docs/api/qiskit/circuit_classical.mdx b/docs/api/qiskit/circuit_classical.mdx index 3ca089e0925..54695619967 100644 --- a/docs/api/qiskit/circuit_classical.mdx +++ b/docs/api/qiskit/circuit_classical.mdx @@ -47,6 +47,8 @@ The expression system is based on tree representation. All nodes in the tree are #### Expr + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + Root base class of all nodes in the expression tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -61,12 +63,20 @@ The base for dynamic variables is the [`Var`](#qiskit.circuit.classical.expr.Var #### Var + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + A classical variable. These variables take two forms: a new-style variable that owns its storage location and has an associated name; and an old-style variable that wraps a [`Clbit`](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") or [`ClassicalRegister`](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") instance that is owned by some containing circuit. In general, construction of variables for use in programs should use [`Var.new()`](#qiskit.circuit.classical.expr.Var.new "qiskit.circuit.classical.expr.Var.new") or [`QuantumCircuit.add_var()`](qiskit.circuit.QuantumCircuit#add_var "qiskit.circuit.QuantumCircuit.add_var"). Variables are immutable after construction, so they can be used as dictionary keys. + **Parameters** + + * **var** ([*qiskit.circuit.Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*qiskit.circuit.ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") *|*[*uuid.UUID*](https://docs.python.org/3/library/uuid.html#uuid.UUID "(in Python v3.13)")) – + * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + ##### name @@ -78,6 +88,11 @@ The base for dynamic variables is the [`Var`](#qiskit.circuit.classical.expr.Var Generate a new named variable that owns its own backing storage. + **Parameters** + + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")) – + **Return type** [*Self*](https://docs.python.org/3/library/typing.html#typing.Self "(in Python v3.13)") @@ -95,7 +110,14 @@ Similarly, literals used in expressions (such as integers) should be lifted to [ #### Value + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + A single scalar value. + + **Parameters** + + * **value** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – The operations traditionally associated with pre-, post- or infix operators in programming are represented by the [`Unary`](#qiskit.circuit.classical.expr.Unary "qiskit.circuit.classical.expr.Unary") and [`Binary`](#qiskit.circuit.classical.expr.Binary "qiskit.circuit.classical.expr.Binary") nodes as appropriate. These each take an operation type code, which are exposed as enumerations inside each class as [`Unary.Op`](#qiskit.circuit.classical.expr.Unary.Op "qiskit.circuit.classical.expr.Unary.Op") and [`Binary.Op`](#qiskit.circuit.classical.expr.Binary.Op "qiskit.circuit.classical.expr.Binary.Op") respectively. @@ -103,6 +125,8 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Unary + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + A unary expression. **Parameters** @@ -114,6 +138,8 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Enumeration of the opcodes for unary operations. The bitwise negation [`BIT_NOT`](#qiskit.circuit.classical.expr.Unary.Op.BIT_NOT "qiskit.circuit.classical.expr.Unary.Op.BIT_NOT") takes a single bit or an unsigned integer of known width, and returns a value of the same type. @@ -137,6 +163,8 @@ The operations traditionally associated with pre-, post- or infix operators in p #### Binary + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + A binary expression. **Parameters** @@ -149,6 +177,8 @@ The operations traditionally associated with pre-, post- or infix operators in p ##### Op + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + Enumeration of the opcodes for binary operations. The bitwise operations [`BIT_AND`](#qiskit.circuit.classical.expr.Binary.Op.BIT_AND "qiskit.circuit.classical.expr.Binary.Op.BIT_AND"), [`BIT_OR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_OR "qiskit.circuit.classical.expr.Binary.Op.BIT_OR") and [`BIT_XOR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_XOR "qiskit.circuit.classical.expr.Binary.Op.BIT_XOR") apply to two operands of the same type, which must be a single bit or an unsigned integer of fixed width. The resultant type is the same as the two input types. @@ -244,6 +274,8 @@ Bit-like types (unsigned integers) can be indexed by integer types, represented #### Index + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + An indexing expression. **Parameters** @@ -260,7 +292,15 @@ Expressions in this system are defined to act only on certain sets of types. How #### Cast + Bases: [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") + A cast from one type to another, implied by the use of an expression in a different context. + + **Parameters** + + * **operand** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – + * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **implicit** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – @@ -302,6 +342,11 @@ The functions and methods described in this section are a more user-friendly way Value(5, Uint(4)) ``` + **Parameters** + + * **value** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type") *| None*) – + **Return type** [Expr](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") @@ -327,6 +372,11 @@ You can manually specify casts in cases where the cast is allowed in explicit fo Cast(Value(5, types.Uint(32)), types.Uint(8), implicit=False) ``` + **Parameters** + + * **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -350,6 +400,10 @@ There are helper constructor functions for each of the unary operations. Unary(Unary.Op.BIT_NOT, Var(ClassicalRegister(3, 'c'), Uint(3)), Uint(3)) ``` + **Parameters** + + **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -371,6 +425,10 @@ There are helper constructor functions for each of the unary operations. Unary(Unary.Op.LOGIC_NOT, Cast(Var(ClassicalRegister(3, 'c'), Uint(3)), Bool(), implicit=True), Bool()) ``` + **Parameters** + + **operand** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -394,6 +452,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.BIT_AND, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(7, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -415,6 +478,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.BIT_OR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -436,6 +504,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.BIT_XOR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -457,6 +530,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.LOGIC_AND, Var(, Bool()), Var(, Bool()), Bool()) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -478,6 +556,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.LOGIC_OR, Var(, Bool()), Var(, Bool()), Bool()) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -499,6 +582,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -520,6 +608,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.NOT_EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -541,6 +634,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.LESS, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -562,6 +660,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.LESS_EQUAL, Var(ClassicalRegister(3, "a"), Uint(3)), Var(ClassicalRegister(3, "b"), Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -583,6 +686,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.GREATER, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -604,6 +712,11 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.GREATER_EQUAL, Var(ClassicalRegister(3, "a"), Uint(3)), Var(ClassicalRegister(3, "b"), Uint(3)), Uint(3)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -634,6 +747,12 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.SHIFT_LEFT, Value(3, Uint(16)), Var(, Uint(8), name='a'), Uint(16)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type") *| None*) – + **Return type** [Expr](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") @@ -657,6 +776,12 @@ Similarly, the binary operations and relations have helper functions defined. Binary(Binary.Op.SHIFT_RIGHT, Var(ClassicalRegister(8, "a"), Uint(8)), Value(4, Uint(3)), Uint(8)) ``` + **Parameters** + + * **left** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **right** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **type** ([*types.Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type") *| None*) – + **Return type** [Expr](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") @@ -682,6 +807,11 @@ You can index into unsigned integers and bit-likes using another unsigned intege Index(Var(ClassicalRegister(8, "a"), Uint(8)), Value(3, Uint(2)), Bool()) ``` + **Parameters** + + * **target** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + * **index** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – + **Return type** [*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr") @@ -709,6 +839,10 @@ Qiskit’s legacy method for specifying equality conditions for use in condition lifted = expr.lift_legacy_condition(instr.condition) ``` + **Parameters** + + **condition** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")*\[*[*qiskit.circuit.Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*qiskit.circuit.ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + **Return type** [Expr](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") @@ -721,11 +855,17 @@ A typical consumer of the expression tree wants to recursively walk through the #### ExprVisitor + Bases: [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.13)")\[`_T_co`] + Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organized such that non-existent methods will never be called. ##### visit\_binary + **Parameters** + + **node** ([*Binary*](#qiskit.circuit.classical.expr.Binary "qiskit.circuit.classical.expr.expr.Binary")) – + **Return type** *\_T\_co* @@ -734,6 +874,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_cast + **Parameters** + + **node** ([*Cast*](#qiskit.circuit.classical.expr.Cast "qiskit.circuit.classical.expr.expr.Cast")) – + **Return type** *\_T\_co* @@ -742,6 +886,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_generic + **Parameters** + + **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr")) – + **Return type** *\_T\_co* @@ -750,6 +898,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_index + **Parameters** + + **node** ([*Index*](#qiskit.circuit.classical.expr.Index "qiskit.circuit.classical.expr.expr.Index")) – + **Return type** *\_T\_co* @@ -758,6 +910,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_unary + **Parameters** + + **node** ([*Unary*](#qiskit.circuit.classical.expr.Unary "qiskit.circuit.classical.expr.expr.Unary")) – + **Return type** *\_T\_co* @@ -766,6 +922,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_value + **Parameters** + + **node** ([*Value*](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.expr.Value")) – + **Return type** *\_T\_co* @@ -774,6 +934,10 @@ A typical consumer of the expression tree wants to recursively walk through the ##### visit\_var + **Parameters** + + **node** ([*Var*](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var")) – + **Return type** *\_T\_co* @@ -805,6 +969,10 @@ For the convenience of simple visitors that only need to inspect the variables i print(node.var.name) ``` + **Parameters** + + **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr")) – + **Return type** [*Iterator*](https://docs.python.org/3/library/typing.html#typing.Iterator "(in Python v3.13)")\[[*Var*](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var")] @@ -898,6 +1066,10 @@ Some expressions have associated memory locations, and others may be purely temp False ``` + **Parameters** + + **node** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr")) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -922,6 +1094,8 @@ All types inherit from an abstract base class: #### Type + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Root base class of all nodes in the type tree. The base case should never be instantiated directly. This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code. @@ -934,13 +1108,21 @@ The two different types available are for Booleans (corresponding to [`Clbit`](c #### Bool + Bases: [`Type`](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type") + The Boolean type. This has exactly two values: `True` and `False`. #### Uint + Bases: [`Type`](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type") + An unsigned integer of fixed bit width. + + **Parameters** + + **width** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Note that [`Uint`](#qiskit.circuit.classical.types.Uint "qiskit.circuit.classical.types.Uint") defines a family of types parametrized by their width; it is not one single type, which may be slightly different to the ‘classical’ programming languages you are used to. @@ -977,6 +1159,11 @@ The low-level interface to querying the subtyping relationship is the [`order()` Ordering.NONE ``` + **Parameters** + + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + **Return type** [*Ordering*](#qiskit.circuit.classical.types.Ordering "qiskit.circuit.classical.types.ordering.Ordering") @@ -987,6 +1174,8 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. #### Ordering + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + 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. Note that the sub-/supertyping relationship is not the same as whether a type can be explicitly cast from one to another. @@ -1018,6 +1207,12 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis False ``` + **Parameters** + + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -1047,6 +1242,12 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis False ``` + **Parameters** + + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **strict** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -1065,6 +1266,11 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – if there is no ordering relation between the two types. + **Parameters** + + * **left** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + * **right** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + **Return type** [*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type") @@ -1103,6 +1309,11 @@ 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.circuit.classical.types.types.Type")) – + * **to\_** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – + **Return type** [*CastKind*](#qiskit.circuit.classical.types.CastKind "qiskit.circuit.classical.types.ordering.CastKind") @@ -1113,6 +1324,8 @@ The return values from this function are an enumeration explaining the types of #### CastKind + Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.13)") + A return value indicating the type of cast that can occur from one type to another. diff --git a/docs/api/qiskit/circuit_library.mdx b/docs/api/qiskit/circuit_library.mdx index 54ea51fcb7f..5e934bd12fb 100644 --- a/docs/api/qiskit/circuit_library.mdx +++ b/docs/api/qiskit/circuit_library.mdx @@ -1885,6 +1885,10 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui q_1: ┤ X ├──────────┤ X ├───────────┤1 ├──────────── └───┘ └───┘ └─────────┘ ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – #### rzx\_xz @@ -1904,6 +1908,10 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui «q_1: ───────────────────────────────── « ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – #### rzx\_cy @@ -1918,6 +1926,10 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui q_1: ┤ X ├┤ RY(ϴ) ├┤ X ├┤ RY(-ϴ) ├┤ RZ(-π/2) ├┤ RX(ϴ) ├┤1 ├┤ RZ(π/2) ├ └───┘└───────┘└───┘└────────┘└──────────┘└───────┘└──────────┘└─────────┘ ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – #### rzx\_zz1 @@ -1942,6 +1954,10 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui «q_1: ┤ RZ(π/2) ├ « └─────────┘ ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – #### rzx\_zz2 @@ -1961,6 +1977,10 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui «q_1: ┤1 ├┤ RZ(π/2) ├┤ RX(π/2) ├┤ RZ(π/2) ├ « └──────────┘└─────────┘└─────────┘└─────────┘ ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – #### rzx\_zz3 @@ -1980,5 +2000,9 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui «q_1: ┤1 ├┤ RZ(π/2) ├┤ RX(π/2) ├┤ RZ(π/2) ├ « └──────────┘└─────────┘└─────────┘└─────────┘ ``` + + **Parameters** + + **theta** (*ParameterValueType | None*) – diff --git a/docs/api/qiskit/circuit_singleton.mdx b/docs/api/qiskit/circuit_singleton.mdx index 8707c1b1513..a4e98b02b85 100644 --- a/docs/api/qiskit/circuit_singleton.mdx +++ b/docs/api/qiskit/circuit_singleton.mdx @@ -45,6 +45,8 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonInstruction + Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `_SingletonBase` + A base class to use for [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects that by default are singleton instances. This class should be used for instruction classes that have fixed definitions and do not contain any unique state. The canonical example of something like this is [`Measure`](circuit#qiskit.circuit.Measure "qiskit.circuit.Measure") which has an immutable definition and any instance of [`Measure`](circuit#qiskit.circuit.Measure "qiskit.circuit.Measure") is the same. Using singleton instructions as a base class for these types of gate classes provides a large advantage in the memory footprint of multiple instructions. @@ -55,6 +57,8 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonGate + Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate"), `_SingletonBase` + A base class to use for [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") objects that by default are singleton instances. This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") semantics as well. The same caveats around setting attributes in that class apply here as well. @@ -63,6 +67,8 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir ### SingletonControlledGate + Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate"), `_SingletonBase` + A base class to use for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects that by default are singleton instances This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") semantics as well. The same caveats around setting attributes in that class apply here as well. diff --git a/docs/api/qiskit/dagcircuit.mdx b/docs/api/qiskit/dagcircuit.mdx index facfa647df8..82e41dd8402 100644 --- a/docs/api/qiskit/dagcircuit.mdx +++ b/docs/api/qiskit/dagcircuit.mdx @@ -33,6 +33,8 @@ python_api_name: qiskit.dagcircuit ### DAGCircuitError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by the DAGCircuit object. Set the error message. @@ -41,6 +43,8 @@ python_api_name: qiskit.dagcircuit ### DAGDependencyError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by the DAGDependency object. Set the error message. diff --git a/docs/api/qiskit/exceptions.mdx b/docs/api/qiskit/exceptions.mdx index 34ecf2af62b..9fe9c29ac95 100644 --- a/docs/api/qiskit/exceptions.mdx +++ b/docs/api/qiskit/exceptions.mdx @@ -23,6 +23,8 @@ All Qiskit-related exceptions raised by Qiskit are subclasses of the base: ### QiskitError + Bases: [`Exception`](https://docs.python.org/3/library/exceptions.html#Exception "(in Python v3.13)") + Base class for errors raised by Qiskit. Set the error message. @@ -39,9 +41,22 @@ Qiskit has several optional features that depend on other packages that are not ### MissingOptionalLibraryError + Bases: [`QiskitError`](#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError"), [`ImportError`](https://docs.python.org/3/library/exceptions.html#ImportError "(in Python v3.13)") + Raised when an optional library is missing. Set the error message. :param libname: Name of missing library :param name: Name of class, function, module that uses this library :param pip\_install: pip install command, if any :param msg: Descriptive message, if any + + **Parameters** + + * **libname** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **pip\_install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + + **Return type** + + None Two more uncommon errors relate to failures in reading user-configuration files, or specifying a filename that cannot be used: @@ -49,6 +64,8 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### QiskitUserConfigError + Bases: [`QiskitError`](#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Raised when an error is encountered reading a user config file. Set the error message. @@ -57,6 +74,8 @@ Two more uncommon errors relate to failures in reading user-configuration files, ### InvalidFileError + Bases: [`QiskitError`](#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Raised when the file provided is not valid for the specific task. Set the error message. @@ -69,6 +88,8 @@ Some particular features of Qiskit may raise custom warnings. In general, Qiskit ### QiskitWarning + Bases: [`UserWarning`](https://docs.python.org/3/library/exceptions.html#UserWarning "(in Python v3.13)") + Common subclass of warnings for Qiskit-specific warnings being raised. @@ -77,6 +98,8 @@ Related to [`MissingOptionalLibraryError`](#qiskit.exceptions.MissingOptionalLib ### OptionalDependencyImportWarning + Bases: [`QiskitWarning`](#qiskit.exceptions.QiskitWarning "qiskit.exceptions.QiskitWarning") + Raised when an optional library raises errors during its import. @@ -89,6 +112,8 @@ When experimental features are being used, Qiskit will raise [`ExperimentalWarni ### ExperimentalWarning + Bases: [`QiskitWarning`](#qiskit.exceptions.QiskitWarning "qiskit.exceptions.QiskitWarning") + Raised when an experimental feature is being used. diff --git a/docs/api/qiskit/passmanager.mdx b/docs/api/qiskit/passmanager.mdx index da2cf033c22..acd4c97e0c0 100644 --- a/docs/api/qiskit/passmanager.mdx +++ b/docs/api/qiskit/passmanager.mdx @@ -161,6 +161,8 @@ With the pass manager framework, a developer can flexibly customize the optimiza #### PassManagerError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Pass manager error. Set the error message. diff --git a/docs/api/qiskit/providers.mdx b/docs/api/qiskit/providers.mdx index 9aacd847621..762fc713187 100644 --- a/docs/api/qiskit/providers.mdx +++ b/docs/api/qiskit/providers.mdx @@ -76,6 +76,8 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### QiskitBackendNotFoundError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised while looking for a backend. Set the error message. @@ -84,6 +86,8 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### BackendPropertyError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised while looking for a backend property. Set the error message. @@ -92,6 +96,8 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### JobError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by Jobs. Set the error message. @@ -100,6 +106,8 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### JobTimeoutError + Bases: [`JobError`](#qiskit.providers.JobError "qiskit.providers.exceptions.JobError") + Base class for timeout errors raised by jobs. Set the error message. @@ -108,6 +116,8 @@ It’s worth pointing out that Qiskit’s version support policy doesn’t mean #### BackendConfigurationError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by the BackendConfiguration. Set the error message. diff --git a/docs/api/qiskit/providers_fake_provider.mdx b/docs/api/qiskit/providers_fake_provider.mdx index 442c46615ea..5bf4099ae32 100644 --- a/docs/api/qiskit/providers_fake_provider.mdx +++ b/docs/api/qiskit/providers_fake_provider.mdx @@ -82,6 +82,8 @@ The V1 fake backends are based on a set of base classes: ### FakeBackend + Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") + This is a dummy backend just for testing purposes. FakeBackend initializer. @@ -99,6 +101,8 @@ The V1 fake backends are based on a set of base classes: ### FakeQasmBackend + Bases: [`FakeBackend`](#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") + A fake OpenQASM backend. FakeBackend initializer. @@ -116,6 +120,8 @@ The V1 fake backends are based on a set of base classes: ### FakePulseBackend + Bases: [`FakeQasmBackend`](#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") + A fake pulse backend. FakeBackend initializer. diff --git a/docs/api/qiskit/pulse.mdx b/docs/api/qiskit/pulse.mdx index 84c8b25fda8..72151877a34 100644 --- a/docs/api/qiskit/pulse.mdx +++ b/docs/api/qiskit/pulse.mdx @@ -69,6 +69,8 @@ These are all instances of the same base class: ### Instruction + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. Instruction initializer. @@ -162,6 +164,8 @@ All channels are children of the same abstract base class: ### Channel + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. When serialized channels are identified by their serialized name ``. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated. @@ -219,9 +223,15 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls #### AlignmentKind + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + An abstract class for schedule alignment. Create new context. + + **Parameters** + + **context\_params** (*Tuple\[ParameterValueType, ...]*) – @@ -849,6 +859,10 @@ DriveChannel(0) Requires the active builder context to have a backend set. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*AcquireChannel*](qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") @@ -918,6 +932,10 @@ DriveChannel(0) Requires the active builder context to have a backend set. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*DriveChannel*](qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") @@ -948,6 +966,10 @@ DriveChannel(0) Requires the active builder context to have a backend set. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*MeasureChannel*](qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") @@ -2095,6 +2117,10 @@ There are 1e-06 seconds in 4500 samples. A channel may still be associated with another qubit in this list such as in the case where significant crosstalk exists. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [set](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)")\[[qiskit.pulse.channels.Channel](#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] @@ -2157,6 +2183,8 @@ There are 1e-06 seconds in 4500 samples. ### PulseError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Errors raised by the pulse module. Set the error message. @@ -2169,6 +2197,8 @@ There are 1e-06 seconds in 4500 samples. ### BackendNotSet + Bases: [`PulseError`](#qiskit.pulse.PulseError "qiskit.pulse.exceptions.PulseError") + Raised if the builder context does not have a backend. Set the error message. @@ -2181,6 +2211,8 @@ There are 1e-06 seconds in 4500 samples. ### NoActiveBuilder + Bases: [`PulseError`](#qiskit.pulse.PulseError "qiskit.pulse.exceptions.PulseError") + Raised if no builder context is active. Set the error message. @@ -2193,6 +2225,8 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedDurationError + Bases: [`PulseError`](#qiskit.pulse.PulseError "qiskit.pulse.exceptions.PulseError") + Raised if instruction duration is unassigned. Set the error message. @@ -2205,6 +2239,8 @@ There are 1e-06 seconds in 4500 samples. ### UnassignedReferenceError + Bases: [`PulseError`](#qiskit.pulse.PulseError "qiskit.pulse.exceptions.PulseError") + Raised if subroutine is unassigned. Set the error message. diff --git a/docs/api/qiskit/qasm2.mdx b/docs/api/qiskit/qasm2.mdx index b8167c52ef8..9beb531fa21 100644 --- a/docs/api/qiskit/qasm2.mdx +++ b/docs/api/qiskit/qasm2.mdx @@ -84,6 +84,8 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i #### CustomInstruction + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Information about a custom instruction that should be defined during the parse. The `name`, `num_params` and `num_qubits` fields are self-explanatory. The `constructor` field should be a callable object with signature `*args -> Instruction`, where each of the `num_params` `args` is a floating-point value. Most of the built-in Qiskit gate classes have this form. @@ -118,6 +120,14 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i loaded = qasm2.loads(dumped, custom_instructions=custom) ``` + + **Parameters** + + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **num\_params** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **constructor** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[...],* [*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")*]*) – + * **builtin** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – 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. @@ -131,6 +141,8 @@ Similar to the quantum extensions above, you can also extend the processing done #### CustomClassical + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Information about a custom classical function that should be defined in mathematical expressions. The given callable must be a Python function that takes num\_params floats, and returns a float. The name is the identifier that refers to it in the OpenQASM 2 program. This cannot clash with any defined gates. @@ -192,6 +204,8 @@ This module defines a generic error type that derives from [`QiskitError`](excep ### QASM2Error + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + A general error raised by the OpenQASM 2 interoperation layer. Set the error message. @@ -202,6 +216,8 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the ### QASM2ParseError + Bases: [`QASM2Error`](#qiskit.qasm2.QASM2Error "qiskit.qasm2.exceptions.QASM2Error") + An error raised because of a failure to parse an OpenQASM 2 file. Set the error message. @@ -212,6 +228,8 @@ When the exporters fail to export a circuit, likely because it has structure tha ### QASM2ExportError + Bases: [`QASM2Error`](#qiskit.qasm2.QASM2Error "qiskit.qasm2.exceptions.QASM2Error") + An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. Set the error message. diff --git a/docs/api/qiskit/qasm3.mdx b/docs/api/qiskit/qasm3.mdx index c70feee1bd7..f3350501f38 100644 --- a/docs/api/qiskit/qasm3.mdx +++ b/docs/api/qiskit/qasm3.mdx @@ -32,6 +32,10 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. * **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Circuit to serialize. * **stream** (*TextIOBase*) – stream-like object to dump the OpenQASM 3 serialization * **\*\*kwargs** – Arguments for the [`Exporter`](#qiskit.qasm3.Exporter "qiskit.qasm3.Exporter") constructor. + + **Return type** + + None ### dumps @@ -58,6 +62,8 @@ Both of these exporter functions are single-use wrappers around the main [`Expor ### Exporter + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + QASM3 exporter main class. **Parameters** @@ -112,6 +118,8 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp ### QASM3ExporterError + Bases: `QASM3Error` + An error raised during running the OpenQASM 3 exporter. Set the error message. @@ -124,6 +132,8 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t #### ExperimentalFeatures + Bases: [`Flag`](https://docs.python.org/3/library/enum.html#enum.Flag "(in Python v3.13)") + Flags for experimental features that the OpenQASM 3 exporter supports. These are experimental and are more liable to change, because the OpenQASM 3 specification has not formally accepted them yet, so the syntax may not be finalized. @@ -264,6 +274,8 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo ### QASM3ImporterError + Bases: `QASM3Error` + An error raised during the OpenQASM 3 importer. Set the error message. @@ -398,6 +410,8 @@ These two functions allow for specifying include paths as an iterable of paths, #### CustomGate + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Information received from Python space about how to construct a Python-space object to represent a given gate that might be declared. ##### constructor diff --git a/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.mdx b/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.mdx index 3ed55cb3cd4..0a482c72a48 100644 --- a/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.mdx +++ b/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.mdx @@ -154,6 +154,10 @@ python_api_name: qiskit.circuit.AnnotatedOperation Validate a parameter for the underlying base operation. + **Parameters** + + **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + **Return type** [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") | [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") diff --git a/docs/api/qiskit/qiskit.circuit.CommutationChecker.mdx b/docs/api/qiskit/qiskit.circuit.CommutationChecker.mdx index ac0aa1aca90..d1b4ac2bb18 100644 --- a/docs/api/qiskit/qiskit.circuit.CommutationChecker.mdx +++ b/docs/api/qiskit/qiskit.circuit.CommutationChecker.mdx @@ -15,6 +15,12 @@ python_api_name: qiskit.circuit.CommutationChecker ## Methods + **Parameters** + + * **standard\_gate\_commutations** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – + * **cache\_max\_entries** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **gates** ([*Set*](https://docs.python.org/3/library/typing.html#typing.Set "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – + ### check\_commutation\_entries @@ -71,6 +77,10 @@ python_api_name: qiskit.circuit.CommutationChecker Checks if two DAGOpNodes commute. + **Parameters** + + **max\_num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx index b5be023cf58..9394948b1b3 100644 --- a/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx @@ -346,6 +346,10 @@ python_api_name: qiskit.circuit.ControlledGate Invert this gate by calling inverse on the base gate. + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** ControlledGate’ | ‘AnnotatedOperation diff --git a/docs/api/qiskit/qiskit.circuit.InstructionSet.mdx b/docs/api/qiskit/qiskit.circuit.InstructionSet.mdx index 519ab3d37d3..2e3b260d7a8 100644 --- a/docs/api/qiskit/qiskit.circuit.InstructionSet.mdx +++ b/docs/api/qiskit/qiskit.circuit.InstructionSet.mdx @@ -98,6 +98,10 @@ python_api_name: qiskit.circuit.InstructionSet It is preferable to take the inverse *before* appending the gate(s) to the circuit. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/qiskit.circuit.Parameter.mdx index 58b251e7275..b9bd8960e9d 100644 --- a/docs/api/qiskit/qiskit.circuit.Parameter.mdx +++ b/docs/api/qiskit/qiskit.circuit.Parameter.mdx @@ -229,6 +229,11 @@ python_api_name: qiskit.circuit.Parameter Substitute self with the corresponding parameter in `parameter_map`. + + **Parameters** + + * **parameter\_map** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")) – + * **allow\_unknown\_parameters** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### sympify diff --git a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx index 2897992238e..b179fab1506 100644 --- a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx +++ b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx @@ -13,6 +13,8 @@ python_api_name: qiskit.circuit.QuantumCircuit # [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") class + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Core Qiskit representation of a quantum circuit. @@ -534,6 +536,14 @@ python_api_name: qiskit.circuit.QuantumCircuit Add Bits to the circuit. + + **Parameters** + + **bits** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.bit.Bit")*]*) – + + **Return type** + + None Registers are added to the circuit with [`add_register()`](#qiskit.circuit.QuantumCircuit.add_register "qiskit.circuit.QuantumCircuit.add_register"). In this method, it is not an error if some of the bits are already present in the circuit. In this case, the register will be an “alias” over the bits. This is not generally well-supported by hardware backends; it is probably best to stay away from relying on it. The registers a given bit is in are part of the return of [`find_bit()`](#qiskit.circuit.QuantumCircuit.find_bit "qiskit.circuit.QuantumCircuit.find_bit"). @@ -542,6 +552,14 @@ python_api_name: qiskit.circuit.QuantumCircuit Add registers. + + **Parameters** + + **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – + + **Return type** + + None [Real-time, typed classical data](circuit#circuit-repr-real-time-classical) is represented on the circuit by [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") nodes with a well-defined [`Type`](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type"). It is possible to instantiate these separately to a circuit (see [`Var.new()`](circuit_classical#qiskit.circuit.classical.expr.Var.new "qiskit.circuit.classical.expr.Var.new")), but it is often more convenient to use circuit methods that will automatically manage the types and expression initialization for you. The two most common methods are [`add_var()`](#qiskit.circuit.QuantumCircuit.add_var "qiskit.circuit.QuantumCircuit.add_var") (locally scoped variables) and [`add_input()`](#qiskit.circuit.QuantumCircuit.add_input "qiskit.circuit.QuantumCircuit.add_input") (inputs to the circuit). @@ -1297,6 +1315,11 @@ python_api_name: qiskit.circuit.QuantumCircuit **Return type** [QuantumCircuit](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + **Parameters** + + * **other** ([*QuantumCircuit*](#qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")) – + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – As some rules of thumb: @@ -3308,6 +3331,10 @@ python_api_name: qiskit.circuit.QuantumCircuit A method to produce a new circuit with no instructions and all the same tracking of quantum and classical typed data, but without mutating the original circuit. + + **Return type** + + None #### remove\_final\_measurements @@ -3379,6 +3406,10 @@ python_api_name: qiskit.circuit.QuantumCircuit **Raises** [**Exception**](https://docs.python.org/3/library/exceptions.html#Exception "(in Python v3.13)") – if the gate is of type string and params is None. + + **Return type** + + None #### has\_calibration\_for @@ -3389,6 +3420,10 @@ python_api_name: qiskit.circuit.QuantumCircuit The method `qiskit.circuit.quantumcircuit.QuantumCircuit.has_calibration_for()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.circuit.quantumcircuit.QuantumCircuit.has_calibration_for()` will have no alternative in Qiskit. + + **Parameters** + + **instruction** ([*CircuitInstruction*](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – ## Circuit properties @@ -3655,7 +3690,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **\*qubits** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Qubits within `self` to include. Integers are allowed for qubits, indicating + * **\*qubits** – Qubits within `self` to include. Integers are allowed for qubits, indicating * **self.qubits.** (*indices of*) – **Returns** @@ -3680,7 +3715,7 @@ python_api_name: qiskit.circuit.QuantumCircuit **Parameters** - * **\*qubits** ([*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Qubits within `self` to include. Integers are allowed for qubits, indicating + * **\*qubits** – Qubits within `self` to include. Integers are allowed for qubits, indicating * **self.qubits.** (*indices of*) – **Returns** @@ -4048,6 +4083,11 @@ python_api_name: qiskit.circuit.QuantumCircuit The method `qiskit.circuit.quantumcircuit.QuantumCircuit.cast()` is deprecated as of qiskit 1.2. It will be removed in the 2.0 release. This method is only used as an internal helper and will be removed with no replacement. + **Parameters** + + * **value** (*S*) – + * **type\_** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[...], T]*) – + **Return type** *S* | *T* @@ -4124,5 +4164,15 @@ python_api_name: qiskit.circuit.QuantumCircuit [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")\[[qiskit.circuit.quantumregister.Qubit](circuit#qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit")] + + **Parameters** + + * **regs** ([*Register*](circuit#qiskit.circuit.Register "qiskit.circuit.Register") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Sequence\[*[*Bit*](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit")*]*) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **global\_phase** (*ParameterValueType*) – + * **metadata** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| 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")*]*) – + * **declarations** (*Mapping\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*,* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")*] | Iterable\[Tuple\[*[*expr.Var*](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var")*,* [*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")*]]*) – diff --git a/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.mdx b/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.mdx index 2f49a1bf718..14f6fe60099 100644 --- a/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.mdx +++ b/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.mdx @@ -17,6 +17,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp * **target** ([*Clbit*](circuit#qiskit.circuit.Clbit "qiskit.circuit.Clbit") *|*[*ClassicalRegister*](circuit#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") *|*[*expr.Expr*](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – the real-time value to switch on. * **cases** (*Iterable\[Tuple\[Any,* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]]*) – an ordered iterable of the corresponding value of the `target` and the circuit block that should be executed if this is matched. There is no fall-through between blocks, and the order matters. + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.mdx b/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.mdx index c1883637504..19f3b9696e9 100644 --- a/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.mdx +++ b/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.mdx @@ -274,6 +274,10 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression **Raises** [**FileNotFoundError**](https://docs.python.org/3/library/exceptions.html#FileNotFoundError "(in Python v3.13)") – If filename is not found. + + **Parameters** + + **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ### inverse diff --git a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx index 109a348c0b9..03c3f8efe3d 100644 --- a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx +++ b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.mdx @@ -11,6 +11,8 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE # qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError + Bases: `ClassicalFunctionCompilerError` + ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. Set the error message. diff --git a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx index e17efc34e28..fab80ac6c37 100644 --- a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx +++ b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.mdx @@ -11,6 +11,8 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError # qiskit.circuit.classicalfunction.ClassicalFunctionParseError + Bases: `ClassicalFunctionCompilerError` + ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. Set the error message. diff --git a/docs/api/qiskit/qiskit.circuit.library.CHGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CHGate.mdx index a3660013721..a0fdc2c03d7 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CHGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CHGate.mdx @@ -218,6 +218,10 @@ $$ Return inverted CH gate (itself). + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.mdx index 93773b33a6d..d145aff53c1 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.mdx @@ -46,6 +46,12 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + ### base\_class @@ -220,6 +226,10 @@ $$ Return inverted CPhase gate ($CPhase(\lambda)^{\dagger} = CPhase(-\lambda)$) + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### power diff --git a/docs/api/qiskit/qiskit.circuit.library.CRXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CRXGate.mdx index 3c6a663521e..82083e7fa96 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CRXGate.mdx @@ -67,6 +67,12 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.CRYGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CRYGate.mdx index d9fb4036c7f..922a7c6e43a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRYGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CRYGate.mdx @@ -67,6 +67,12 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.CRZGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CRZGate.mdx index 0182475e76e..4032453095c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRZGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CRZGate.mdx @@ -69,6 +69,12 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.CU1Gate.mdx b/docs/api/qiskit/qiskit.circuit.library.CU1Gate.mdx index 49f0aab3028..5068f2fad1a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CU1Gate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CU1Gate.mdx @@ -57,6 +57,12 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.CU3Gate.mdx b/docs/api/qiskit/qiskit.circuit.library.CU3Gate.mdx index 9c80050eaf5..e36c06f86ff 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CU3Gate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CU3Gate.mdx @@ -83,6 +83,14 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **phi** (*ParameterValueType*) – + * **lam** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.CUGate.mdx b/docs/api/qiskit/qiskit.circuit.library.CUGate.mdx index 79eaf59fb1b..0a19f8ed0d7 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CUGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.CUGate.mdx @@ -73,6 +73,15 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **phi** (*ParameterValueType*) – + * **lam** (*ParameterValueType*) – + * **gamma** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.mdx b/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.mdx index 1d07c4f88b6..1844c25aaa4 100644 --- a/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.mdx @@ -162,6 +162,10 @@ $$ Return the inverse of the diagonal gate. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### validate\_parameter diff --git a/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.mdx b/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.mdx index 1546453166b..0049a93d66d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.mdx @@ -82,6 +82,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.mdx b/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.mdx index 7869601bc46..a92cec64bd0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.mdx @@ -96,6 +96,7 @@ $$ * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.FullAdderGate.mdx b/docs/api/qiskit/qiskit.circuit.library.FullAdderGate.mdx index 8c2d22f4a1f..5a204693df8 100644 --- a/docs/api/qiskit/qiskit.circuit.library.FullAdderGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.FullAdderGate.mdx @@ -36,6 +36,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the registers. * **name** – The name of the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate.mdx b/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate.mdx index 91f5106e5be..edbde3cb3a3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.HalfAdderGate.mdx @@ -35,6 +35,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the registers. * **name** – The name of the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.mdx b/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.mdx index d68855bab63..a49c33fd688 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.mdx @@ -156,6 +156,10 @@ python_api_name: qiskit.circuit.library.HamiltonianGate Return the adjoint of the unitary. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### transpose diff --git a/docs/api/qiskit/qiskit.circuit.library.MCMT.mdx b/docs/api/qiskit/qiskit.circuit.library.MCMT.mdx index 6db2325abff..af1a30d8b26 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCMT.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCMT.mdx @@ -311,6 +311,10 @@ python_api_name: qiskit.circuit.library.MCMT Return the inverse MCMT circuit, which is itself. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/qiskit.circuit.library.MCMTGate.mdx b/docs/api/qiskit/qiskit.circuit.library.MCMTGate.mdx index ef3cd8da601..6b934d8ca4d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCMTGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCMTGate.mdx @@ -199,6 +199,10 @@ python_api_name: qiskit.circuit.library.MCMTGate Return the inverse MCMT circuit. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.mdx b/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.mdx index 9b5bc8d5ce4..f87d97ccac2 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.mdx @@ -60,6 +60,12 @@ python_api_name: qiskit.circuit.library.MCMTVChain ## Attributes + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate") *| Callable\[\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*],* [*circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]*) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + ### ancillas @@ -316,6 +322,10 @@ python_api_name: qiskit.circuit.library.MCMTVChain Return the inverse MCMT circuit, which is itself. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.mdx b/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.mdx index 763a79a471c..0c11af80e21 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.mdx @@ -38,6 +38,13 @@ python_api_name: qiskit.circuit.library.MCPhaseGate ## Attributes + **Parameters** + + * **lam** (*ParameterValueType*) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **ctrl\_state** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + ### base\_class @@ -212,6 +219,10 @@ python_api_name: qiskit.circuit.library.MCPhaseGate Return inverted MCPhase gate ($MCPhase(\lambda)^{\dagger} = MCPhase(-\lambda)$) + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx index 1b6d14bf985..d43ff7c27cd 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXGate.mdx @@ -19,6 +19,12 @@ python_api_name: qiskit.circuit.library.MCXGate ## Attributes + **Parameters** + + * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class @@ -206,6 +212,11 @@ python_api_name: qiskit.circuit.library.MCXGate The method `qiskit.circuit.library.standard_gates.x.MCXGate.get_num_ancilla_qubits()` is pending deprecation as of qiskit 1.3. It will be marked deprecated in a future release, and then removed no earlier than 3 months after the release date. For an MCXGate it is no longer possible to know the number of ancilla qubits that would be eventually used by the transpiler when the gate is created. Instead, it is recommended to use MCXGate and let HighLevelSynthesis choose the best synthesis method depending on the number of ancilla qubits available. However, if a specific synthesis method using a specific number of ancilla qubits is require, one can create a custom gate by calling the corresponding synthesis function directly. + **Parameters** + + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + **Return type** [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx index f80f3eac3a6..ce44c7cd5f0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.mdx @@ -21,6 +21,12 @@ python_api_name: qiskit.circuit.library.MCXGrayCode ## Attributes + **Parameters** + + * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx index d293350014a..e5af374b462 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.mdx @@ -28,6 +28,12 @@ python_api_name: qiskit.circuit.library.MCXRecursive ## Attributes + **Parameters** + + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – + ### base\_class @@ -187,6 +193,11 @@ python_api_name: qiskit.circuit.library.MCXRecursive Get the number of required ancilla qubits. + + **Parameters** + + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ### inverse diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx b/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx index ee6a5bd61d0..0bbdddf58d1 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MCXVChain.mdx @@ -22,6 +22,9 @@ python_api_name: qiskit.circuit.library.MCXVChain * **dirty\_ancillas** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, the method applies an optimized multicontrolled-X gate up to a relative phase using dirty ancillary qubits with the properties of lemmas 7 and 8 from arXiv:1501.06911, with at most 8\*k - 6 CNOT gates. For k within the range \{1, …, ceil(n/2)}. And for n representing the total number of qubits. * **relative\_phase** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, the method applies the optimized multicontrolled-X gate up to a relative phase, in a way that, by lemma 7 of arXiv:1501.06911, the relative phases of the `action part` cancel out with the phases of the `reset part`. * **action\_only** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, the method applies only the action part of lemma 8 from arXiv:1501.06911. + * **num\_ctrl\_qubits** (*Optional\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + * **ctrl\_state** (*Optional\[Union\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]*) – ## Attributes @@ -184,6 +187,11 @@ python_api_name: qiskit.circuit.library.MCXVChain Get the number of required ancilla qubits. + + **Parameters** + + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ### inverse diff --git a/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate.mdx b/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate.mdx index 46e7c994c3d..fc45bc49bdf 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ModularAdderGate.mdx @@ -35,6 +35,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the registers. * **name** – The name of the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.MultiplierGate.mdx b/docs/api/qiskit/qiskit.circuit.library.MultiplierGate.mdx index e3640d8de40..98833b2fb98 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MultiplierGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.MultiplierGate.mdx @@ -38,6 +38,7 @@ $$ * **num\_state\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The number of qubits in each of the input registers. * **num\_result\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The number of result qubits to limit the output to. Default value is `2 * num_state_qubits` to represent any possible result from the multiplication of the two inputs. * **name** – The name of the circuit. + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.NLocal.mdx b/docs/api/qiskit/qiskit.circuit.library.NLocal.mdx index 6c6b1a23f7a..1caf09d39a3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.NLocal.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.NLocal.mdx @@ -497,6 +497,11 @@ python_api_name: qiskit.circuit.library.NLocal [**AttributeError**](https://docs.python.org/3/library/exceptions.html#AttributeError "(in Python v3.13)") – If the parameters are given as list and do not match the number of parameters. + **Parameters** + + * **parameters** (*Mapping\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | Sequence\[*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – + * **inplace** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") | None diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.mdx index 4baa636f918..f847ca5cca5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.mdx @@ -199,6 +199,10 @@ $$ Gate parameters should be int, float, or ParameterExpression + **Parameters** + + **parameter** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + **Return type** [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") | [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.mdx b/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.mdx index a501a269ed7..d47ea0a3be8 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.mdx @@ -112,6 +112,7 @@ $$ * **data\_map\_func** (*Optional\[Callable\[\[np.ndarray],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]]*) – A mapping function for data x which can be supplied to override the default mapping from `self_product()`. * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used if default parameters are generated. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between the evolution instructions and hadamard layers. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PauliGate.mdx index d3e41e92007..7144e0d4690 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PauliGate.mdx @@ -147,6 +147,10 @@ python_api_name: qiskit.circuit.library.PauliGate Return inverted pauli gate (itself). + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### validate\_parameter diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.mdx b/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.mdx index 8c4f37daf2e..11988265595 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.mdx @@ -65,6 +65,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Specifies how often a block consisting of a rotation layer and entanglement layer is repeated. * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – The seed for randomly choosing the axes of the Pauli rotations. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.PermutationGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PermutationGate.mdx index 3c437edb4d2..3c41091db8d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PermutationGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PermutationGate.mdx @@ -157,6 +157,10 @@ python_api_name: qiskit.circuit.library.PermutationGate Returns the inverse of the permutation. + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** [*PermutationGate*](#qiskit.circuit.library.PermutationGate "qiskit.circuit.library.generalized_gates.permutation.PermutationGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.PhaseGate.mdx b/docs/api/qiskit/qiskit.circuit.library.PhaseGate.mdx index c7bde8491b7..7d1e037bfac 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PhaseGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.PhaseGate.mdx @@ -63,6 +63,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.RGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RGate.mdx index ee173dea549..edfd2d6a3d9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RGate.mdx @@ -39,6 +39,12 @@ $$ ## Attributes + **Parameters** + + * **theta** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.RVGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RVGate.mdx index 05e3882181d..a31b7372750 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RVGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RVGate.mdx @@ -166,6 +166,10 @@ $$ Invert this gate. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### to\_matrix diff --git a/docs/api/qiskit/qiskit.circuit.library.RXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RXGate.mdx index 9f476dabc52..840b67b1db9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RXGate.mdx @@ -39,6 +39,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.RXXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RXXGate.mdx index 3eb5f6074d6..adc595b8285 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RXXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RXXGate.mdx @@ -65,6 +65,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.RYGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RYGate.mdx index 4234a6b420b..348ed723238 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RYGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RYGate.mdx @@ -39,6 +39,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.RYYGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RYYGate.mdx index 81eeb8a9797..47ca8f27ad7 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RYYGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RYYGate.mdx @@ -65,6 +65,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.RZGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RZGate.mdx index 981644d869b..8f4b828857d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RZGate.mdx @@ -49,6 +49,11 @@ $$ ## Attributes + **Parameters** + + * **phi** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.RZXGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RZXGate.mdx index 4746c86e247..de1d892bfec 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZXGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RZXGate.mdx @@ -105,6 +105,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.RZZGate.mdx b/docs/api/qiskit/qiskit.circuit.library.RZZGate.mdx index 6752ae4b39c..8255e1cb66c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZZGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RZZGate.mdx @@ -77,6 +77,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.mdx b/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.mdx index cdf682b536b..531729f2678 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.mdx @@ -121,6 +121,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.StatePreparation.mdx b/docs/api/qiskit/qiskit.circuit.library.StatePreparation.mdx index 3cc5c928eb7..9c4fa84644a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.StatePreparation.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.StatePreparation.mdx @@ -210,6 +210,10 @@ python_api_name: qiskit.circuit.library.StatePreparation Return inverted StatePreparation + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### validate\_parameter diff --git a/docs/api/qiskit/qiskit.circuit.library.TwoLocal.mdx b/docs/api/qiskit/qiskit.circuit.library.TwoLocal.mdx index 0269573e4c8..d6280e590ca 100644 --- a/docs/api/qiskit/qiskit.circuit.library.TwoLocal.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.TwoLocal.mdx @@ -128,6 +128,7 @@ python_api_name: qiskit.circuit.library.TwoLocal * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object to prepend to the circuit. * **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes @@ -524,6 +525,12 @@ python_api_name: qiskit.circuit.library.TwoLocal Overloading to handle the special case of 1 qubit where the entanglement are ignored. + **Parameters** + + * **rep\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **block\_num** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **num\_block\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")]] diff --git a/docs/api/qiskit/qiskit.circuit.library.U1Gate.mdx b/docs/api/qiskit/qiskit.circuit.library.U1Gate.mdx index 1098a4b0272..a75ede25f5d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U1Gate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.U1Gate.mdx @@ -76,6 +76,11 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.U2Gate.mdx b/docs/api/qiskit/qiskit.circuit.library.U2Gate.mdx index 0fc732fd5a8..a223349c927 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U2Gate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.U2Gate.mdx @@ -75,6 +75,12 @@ $$ ## Attributes + **Parameters** + + * **phi** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **lam** ([*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") *|*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.U3Gate.mdx b/docs/api/qiskit/qiskit.circuit.library.U3Gate.mdx index a7130d921f4..e1a8b173089 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U3Gate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.U3Gate.mdx @@ -70,6 +70,13 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **phi** (*ParameterValueType*) – + * **lam** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.UCGate.mdx b/docs/api/qiskit/qiskit.circuit.library.UCGate.mdx index 361ab3f6866..ddebcac39a7 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.UCGate.mdx @@ -165,6 +165,10 @@ $$ This does not re-compute the decomposition for the multiplexer with the inverse of the gates but simply inverts the existing decomposition. + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + **Return type** [*Gate*](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UGate.mdx b/docs/api/qiskit/qiskit.circuit.library.UGate.mdx index 86b2f21f8ba..4fa3853f7e4 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.UGate.mdx @@ -53,6 +53,13 @@ $$ ## Attributes + **Parameters** + + * **theta** (*ParameterValueType*) – + * **phi** (*ParameterValueType*) – + * **lam** (*ParameterValueType*) – + * **label** (*Optional\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – + ### base\_class diff --git a/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.mdx b/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.mdx index 53900dfa95d..65eb5f18abb 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.mdx @@ -196,6 +196,10 @@ python_api_name: qiskit.circuit.library.UnitaryGate Return the adjoint of the unitary. + + **Parameters** + + **annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ### transpose diff --git a/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.mdx b/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.mdx index 982dbc8054c..721573c266d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.mdx @@ -81,6 +81,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – A mapping function for data x which can be supplied to override the default mapping from `self_product()`. * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used if default parameters are generated. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between the evolution instructions and hadamard layers. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – ## Attributes diff --git a/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.mdx b/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.mdx index 8176f8012b8..a2766ce6e97 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.mdx @@ -98,6 +98,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap * **data\_map\_func** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")*],* [*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*] | None*) – A mapping function for data x. * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The prefix used if default parameters are generated. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – If True, barriers are inserted in between the evolution instructions and hadamard layers. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.fourier_checking.mdx b/docs/api/qiskit/qiskit.circuit.library.fourier_checking.mdx index f5c147034a7..ebc175e16bb 100644 --- a/docs/api/qiskit/qiskit.circuit.library.fourier_checking.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.fourier_checking.mdx @@ -39,6 +39,11 @@ python_api_name: qiskit.circuit.library.fourier_checking \[2] S. Aaronson, A. Ambainis, Forrelation: a problem that optimally separates quantum from classical computing, 2014. [arXiv:1411.5729](https://arxiv.org/abs/1411.5729) + **Parameters** + + * **f** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **g** ([*Sequence*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + **Return type** [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.pauli_feature_map.mdx b/docs/api/qiskit/qiskit.circuit.library.pauli_feature_map.mdx index 5d749af4274..75db0444f0b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.pauli_feature_map.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.pauli_feature_map.mdx @@ -98,6 +98,18 @@ $$ \[1] Havlicek et al. Supervised learning with quantum enhanced feature spaces, [Nature 567, 209-212 (2019)](https://www.nature.com/articles/s41586-019-0980-2). + **Parameters** + + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Mapping\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Mapping\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]]*) – + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **paulis** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*] | None*) – + * **data\_map\_func** (*Callable\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*] | None*) – + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.quantum_volume.mdx b/docs/api/qiskit/qiskit.circuit.library.quantum_volume.mdx index 397e18d8166..89fbf861369 100644 --- a/docs/api/qiskit/qiskit.circuit.library.quantum_volume.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.quantum_volume.mdx @@ -29,6 +29,12 @@ python_api_name: qiskit.circuit.library.quantum_volume \[1] A. Cross et al. Validating quantum computers using randomized model circuits, Phys. Rev. A 100, 032328 (2019). [arXiv:1811.12926](https://arxiv.org/abs/1811.12926) + **Parameters** + + * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| np.random.Generator | None*) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.z_feature_map.mdx b/docs/api/qiskit/qiskit.circuit.library.z_feature_map.mdx index 567f481fd73..1cac42780f4 100644 --- a/docs/api/qiskit/qiskit.circuit.library.z_feature_map.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.z_feature_map.mdx @@ -70,6 +70,17 @@ python_api_name: qiskit.circuit.library.z_feature_map └───┘└─────────────┘└──────────┘ └──────────┘ ``` + **Parameters** + + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]*) – + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **data\_map\_func** (*Callable\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*] | None*) – + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.circuit.library.zz_feature_map.mdx b/docs/api/qiskit/qiskit.circuit.library.zz_feature_map.mdx index 1099839e6e9..70938e5cc7d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.zz_feature_map.mdx +++ b/docs/api/qiskit/qiskit.circuit.library.zz_feature_map.mdx @@ -66,6 +66,17 @@ python_api_name: qiskit.circuit.library.zz_feature_map ]) ``` + **Parameters** + + * **feature\_dimension** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*],* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| Sequence\[Sequence\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]]]*) – + * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **data\_map\_func** (*Callable\[\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*],* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*] | None*) – + * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.mdx b/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.mdx index 04f503a7744..9315a41ee92 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.mdx +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.mdx @@ -17,6 +17,17 @@ python_api_name: qiskit.dagcircuit.DAGDepNode ## Attributes + **Parameters** + + * **successors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **predecessors** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **matchedwith** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **successorstovisit** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **isblocked** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + * **qindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **cindices** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – + * **nid** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + ### type diff --git a/docs/api/qiskit/qiskit.passmanager.BasePassManager.mdx b/docs/api/qiskit/qiskit.passmanager.BasePassManager.mdx index dd93bc1f363..b1c0fee997f 100644 --- a/docs/api/qiskit/qiskit.passmanager.BasePassManager.mdx +++ b/docs/api/qiskit/qiskit.passmanager.BasePassManager.mdx @@ -34,6 +34,10 @@ python_api_name: qiskit.passmanager.BasePassManager **Raises** [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – When any element of tasks is not a subclass of passmanager Task. + + **Return type** + + None ### remove @@ -48,6 +52,10 @@ python_api_name: qiskit.passmanager.BasePassManager **Raises** [**PassManagerError**](passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.PassManagerError") – If the index is not found. + + **Return type** + + None ### replace @@ -64,6 +72,10 @@ python_api_name: qiskit.passmanager.BasePassManager * [**TypeError**](https://docs.python.org/3/library/exceptions.html#TypeError "(in Python v3.13)") – When any element of tasks is not a subclass of passmanager Task. * [**PassManagerError**](passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.PassManagerError") – If the index is not found. + + **Return type** + + None ### run diff --git a/docs/api/qiskit/qiskit.passmanager.ConditionalController.mdx b/docs/api/qiskit/qiskit.passmanager.ConditionalController.mdx index 5809883bb36..9c07c095a89 100644 --- a/docs/api/qiskit/qiskit.passmanager.ConditionalController.mdx +++ b/docs/api/qiskit/qiskit.passmanager.ConditionalController.mdx @@ -17,7 +17,9 @@ python_api_name: qiskit.passmanager.ConditionalController **Parameters** - **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **tasks** (*Task | Iterable\[Task]*) – + * **condition** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]*) – ## Attributes diff --git a/docs/api/qiskit/qiskit.passmanager.DoWhileController.mdx b/docs/api/qiskit/qiskit.passmanager.DoWhileController.mdx index b106aa43ad4..63150060e6b 100644 --- a/docs/api/qiskit/qiskit.passmanager.DoWhileController.mdx +++ b/docs/api/qiskit/qiskit.passmanager.DoWhileController.mdx @@ -19,7 +19,9 @@ python_api_name: qiskit.passmanager.DoWhileController **Parameters** - **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **tasks** (*Task | Iterable\[Task]*) – + * **do\_while** (*Callable\[\[*[*PropertySet*](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet")*],* [*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*]*) – ## Attributes diff --git a/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.mdx b/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.mdx index 378308b1f5a..2f7c566e278 100644 --- a/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.mdx +++ b/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.mdx @@ -17,7 +17,8 @@ python_api_name: qiskit.passmanager.FlowControllerLinear **Parameters** - **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, Any] | None*) – Option for this flow controller. + * **tasks** (*Task | Iterable\[Task]*) – ## Attributes diff --git a/docs/api/qiskit/qiskit.passmanager.PassManagerState.mdx b/docs/api/qiskit/qiskit.passmanager.PassManagerState.mdx index dc1c3291dcb..2a2e16af0fc 100644 --- a/docs/api/qiskit/qiskit.passmanager.PassManagerState.mdx +++ b/docs/api/qiskit/qiskit.passmanager.PassManagerState.mdx @@ -19,6 +19,11 @@ python_api_name: qiskit.passmanager.PassManagerState ## Attributes + **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 diff --git a/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.mdx b/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.mdx index e76c4e13278..5afa91000df 100644 --- a/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.mdx +++ b/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.mdx @@ -17,6 +17,12 @@ python_api_name: qiskit.passmanager.WorkflowStatus ## Attributes + **Parameters** + + * **count** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **completed\_passes** ([*set*](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.13)")) – + * **previous\_run** (*RunState*) – + ### count diff --git a/docs/api/qiskit/qiskit.primitives.Estimator.mdx b/docs/api/qiskit/qiskit.primitives.Estimator.mdx index 6c8cf1cd525..eb7c6027e6d 100644 --- a/docs/api/qiskit/qiskit.primitives.Estimator.mdx +++ b/docs/api/qiskit/qiskit.primitives.Estimator.mdx @@ -18,6 +18,10 @@ python_api_name: qiskit.primitives.Estimator * **shots** (None or int) – The number of shots. If None, it calculates the expectation values with full state vector simulation. Otherwise, it samples from normal distributions with standard errors as standard deviations using normal distribution approximation. * **seed** (np.random.Generator or int) – Set a fixed seed or generator for the normal distribution. If shots is None, this option is ignored. + **Parameters** + + **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – + The result of this class is exact if the circuit contains only unitary operations. On the other hand, the result could be stochastic if the circuit contains a non-unitary operation such as a reset for a some subsystems. The stochastic result can be made reproducible by setting `seed`, e.g., `Estimator(options={"seed":123})`. diff --git a/docs/api/qiskit/qiskit.primitives.Sampler.mdx b/docs/api/qiskit/qiskit.primitives.Sampler.mdx index 8582e6fc49d..9e57334ef35 100644 --- a/docs/api/qiskit/qiskit.primitives.Sampler.mdx +++ b/docs/api/qiskit/qiskit.primitives.Sampler.mdx @@ -20,6 +20,10 @@ python_api_name: qiskit.primitives.Sampler * **shots** (None or int) – The number of shots. If None, it calculates the probabilities. Otherwise, it samples from multinomial distributions. * **seed** (np.random.Generator or int) – Set a fixed seed or generator for the multinomial distribution. If shots is None, this option is ignored. + **Parameters** + + **options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)") *| None*) – + The class `qiskit.primitives.sampler.Sampler` is deprecated as of qiskit 1.2. It will be removed no earlier than 3 months after the release date. All implementations of the BaseSamplerV1 interface have been deprecated in favor of their V2 counterparts. The V2 alternative for the Sampler class is StatevectorSampler. diff --git a/docs/api/qiskit/qiskit.providers.BackendV2.mdx b/docs/api/qiskit/qiskit.providers.BackendV2.mdx index 89bf308c9ef..322f26f873f 100644 --- a/docs/api/qiskit/qiskit.providers.BackendV2.mdx +++ b/docs/api/qiskit/qiskit.providers.BackendV2.mdx @@ -238,6 +238,10 @@ python_api_name: qiskit.providers.BackendV2 **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### control\_channel @@ -292,6 +296,10 @@ python_api_name: qiskit.providers.BackendV2 **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### measure\_channel @@ -316,6 +324,10 @@ python_api_name: qiskit.providers.BackendV2 **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### qubit\_properties diff --git a/docs/api/qiskit/qiskit.providers.BackendV2Converter.mdx b/docs/api/qiskit/qiskit.providers.BackendV2Converter.mdx index b5f2b20d18e..a67810ffa87 100644 --- a/docs/api/qiskit/qiskit.providers.BackendV2Converter.mdx +++ b/docs/api/qiskit/qiskit.providers.BackendV2Converter.mdx @@ -175,6 +175,10 @@ python_api_name: qiskit.providers.BackendV2Converter The method `qiskit.providers.backend_compat.BackendV2Converter.acquire_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend_compat.BackendV2Converter.acquire_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### control\_channel @@ -183,6 +187,10 @@ python_api_name: qiskit.providers.BackendV2Converter The method `qiskit.providers.backend_compat.BackendV2Converter.control_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend_compat.BackendV2Converter.control_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubits** ([*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – ### drive\_channel @@ -191,6 +199,10 @@ python_api_name: qiskit.providers.BackendV2Converter The method `qiskit.providers.backend_compat.BackendV2Converter.drive_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend_compat.BackendV2Converter.drive_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### measure\_channel @@ -199,6 +211,10 @@ python_api_name: qiskit.providers.BackendV2Converter The method `qiskit.providers.backend_compat.BackendV2Converter.measure_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.backend_compat.BackendV2Converter.measure_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### qubit\_properties diff --git a/docs/api/qiskit/qiskit.providers.JobV1.mdx b/docs/api/qiskit/qiskit.providers.JobV1.mdx index 652fab80ecf..3ea836f4dc6 100644 --- a/docs/api/qiskit/qiskit.providers.JobV1.mdx +++ b/docs/api/qiskit/qiskit.providers.JobV1.mdx @@ -147,6 +147,10 @@ python_api_name: qiskit.providers.JobV1 **Raises** [**JobTimeoutError**](providers#qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not reach a final state before the specified timeout. + + **Return type** + + None diff --git a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.mdx b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.mdx index cfd0b26c05a..11b3ca1927a 100644 --- a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.mdx +++ b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProvider.mdx @@ -34,6 +34,7 @@ python_api_name: qiskit.providers.basic_provider.BasicProvider * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – name of the backend. * **\*\*kwargs** – dict used for filtering. + * **filters** (*Callable | None*) – **Returns** diff --git a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderError.mdx b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderError.mdx index 4dad48f49de..df02fbcc20a 100644 --- a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderError.mdx +++ b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderError.mdx @@ -11,6 +11,8 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderError # qiskit.providers.basic\_provider.BasicProviderError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by the Basic Provider. Set the error message. diff --git a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.mdx b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.mdx index f2105aae119..25d0c9b85ed 100644 --- a/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.mdx +++ b/docs/api/qiskit/qiskit.providers.basic_provider.BasicProviderJob.mdx @@ -153,6 +153,10 @@ python_api_name: qiskit.providers.basic_provider.BasicProviderJob **Raises** [**JobTimeoutError**](providers#qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not reach a final state before the specified timeout. + + **Return type** + + None diff --git a/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.mdx b/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.mdx index 9812145ba95..2f93c9438cb 100644 --- a/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.mdx +++ b/docs/api/qiskit/qiskit.providers.basic_provider.BasicSimulator.mdx @@ -199,6 +199,10 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### configuration @@ -271,6 +275,10 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### measure\_channel @@ -295,6 +303,10 @@ python_api_name: qiskit.providers.basic_provider.BasicSimulator **Raises** [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – if the backend doesn’t support querying the measurement mapping + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### qubit\_properties diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx b/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx index 52f3d0b7461..d4187323311 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx +++ b/docs/api/qiskit/qiskit.providers.fake_provider.GenericBackendV2.mdx @@ -200,6 +200,10 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 The method `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.acquire_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.acquire_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### control\_channel @@ -208,6 +212,10 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 The method `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.control_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.control_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubits** ([*Iterable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – ### drive\_channel @@ -216,6 +224,10 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 The method `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.drive_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.drive_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### measure\_channel @@ -224,6 +236,10 @@ python_api_name: qiskit.providers.fake_provider.GenericBackendV2 The method `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.measure_channel()` is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: [https://github.com/qiskit-community/qiskit-dynamics](https://github.com/qiskit-community/qiskit-dynamics). Note that once removed, `qiskit.providers.fake_provider.generic_backend_v2.GenericBackendV2.measure_channel()` will have no alternative in Qiskit. + + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### qubit\_properties diff --git a/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.mdx b/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.mdx index 87631d58094..b90f7ac30b4 100644 --- a/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.mdx +++ b/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.mdx @@ -98,6 +98,10 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration Qubit measurement acquisition line. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*AcquireChannel*](qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel") @@ -174,6 +178,10 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration Qubit drive channel. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*DriveChannel*](qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel") @@ -210,6 +218,10 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration List of qubits operated on my the given `channel`. + **Parameters** + + **channel** ([*Channel*](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – + **Return type** [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] @@ -228,6 +240,10 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration List of `Channel`s operated on my the given `qubit`. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + **Return type** [*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")\[[*Channel*](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")] @@ -246,6 +262,10 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration Qubit measurement stimulus line. + **Parameters** + + **qubit** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + **Return type** [*MeasureChannel*](qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel") diff --git a/docs/api/qiskit/qiskit.providers.models.PulseDefaults.mdx b/docs/api/qiskit/qiskit.providers.models.PulseDefaults.mdx index 92c15a643e3..3d79c768104 100644 --- a/docs/api/qiskit/qiskit.providers.models.PulseDefaults.mdx +++ b/docs/api/qiskit/qiskit.providers.models.PulseDefaults.mdx @@ -21,6 +21,17 @@ python_api_name: qiskit.providers.models.PulseDefaults ## Attributes + **Parameters** + + * **qubit\_freq\_est** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – + * **meas\_freq\_est** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")*]*) – + * **buffer** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **pulse\_library** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*PulseLibraryItem*](qiskit.qobj.PulseLibraryItem "qiskit.qobj.pulse_qobj.PulseLibraryItem")*]*) – + * **cmd\_def** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*Command*](qiskit.providers.models.Command "qiskit.providers.models.pulsedefaults.Command")*]*) – + * **meas\_kernel** (*MeasurementKernel*) – + * **discriminator** (*Discriminator*) – + * **kwargs** ([*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*]*) – + ### qubit\_freq\_est diff --git a/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.mdx b/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.mdx index fdd0f2c92db..2b04a56b445 100644 --- a/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.mdx +++ b/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.mdx @@ -58,6 +58,10 @@ python_api_name: qiskit.pulse.InstructionScheduleMap **Raises** [**PulseError**](pulse#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the qubits are provided as an empty iterable. + + **Return type** + + None ### assert\_has @@ -73,6 +77,10 @@ python_api_name: qiskit.pulse.InstructionScheduleMap **Raises** [**PulseError**](pulse#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the instruction is not defined on the qubits. + + **Return type** + + None ### get @@ -218,6 +226,10 @@ python_api_name: qiskit.pulse.InstructionScheduleMap * **instruction** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – The name of the instruction to add. * **qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| Iterable\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – The qubits which the instruction applies to. + + **Return type** + + None diff --git a/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.mdx b/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.mdx index 1023c7ce3f9..b4acc3035c7 100644 --- a/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.mdx +++ b/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.mdx @@ -263,6 +263,10 @@ $$ **Raises** [**PulseError**](pulse#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameters passed are not valid. + + **Return type** + + None diff --git a/docs/api/qiskit/qiskit.quantum_info.Chi.mdx b/docs/api/qiskit/qiskit.quantum_info.Chi.mdx index 841e36377a1..9f622246411 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Chi.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Chi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Chi # Chi - + Bases: `QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. @@ -31,9 +31,9 @@ $$ **Parameters** - * **or** (*data (*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Instruction or BaseOperator or matrix): data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the output subsystem dimensions. \[Default: None] + * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. **Raises** @@ -195,6 +195,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -205,6 +210,11 @@ $$ Return True if completely-positive trace-preserving (CPTP). + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -215,6 +225,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -225,6 +240,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/qiskit.quantum_info.Choi.mdx b/docs/api/qiskit/qiskit.quantum_info.Choi.mdx index 3545f7161a8..412554a77bb 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Choi.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Choi.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Choi # Choi - + Bases: `QuantumChannel` Choi-matrix representation of a Quantum Channel. @@ -39,9 +39,9 @@ $$ **Parameters** - * **or** (*data (*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Instruction or BaseOperator or matrix): data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the output subsystem dimensions. \[Default: None] + * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. **Raises** @@ -207,6 +207,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -217,6 +222,11 @@ $$ Return True if completely-positive trace-preserving (CPTP). + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -227,6 +237,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -237,6 +252,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.mdx b/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.mdx index a23942624e2..6420cb9c5f0 100644 --- a/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix # DensityMatrix - + Bases: `QuantumState`, `TolerancesMixin` DensityMatrix class @@ -17,8 +17,8 @@ python_api_name: qiskit.quantum_info.DensityMatrix **Parameters** - * **or** (*data (np.ndarray or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or matrix\_like or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – qiskit.circuit.Instruction): A statevector, quantum instruction or an object with a `to_operator` or `to_matrix` method from which the density matrix can be constructed. If a vector the density matrix is constructed as the projector of that vector. If a quantum instruction, the density matrix is constructed by assuming all qubits are initialized in the zero state. - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – Optional. The subsystem dimension of the state (See additional information). + * **data** (*np.ndarray |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| QuantumState*) – A statevector, quantum instruction or an object with a `to_operator` or `to_matrix` method from which the density matrix can be constructed. If a vector the density matrix is constructed as the projector of that vector. If a quantum instruction, the density matrix is constructed by assuming all qubits are initialized in the zero state. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| None*) – The subsystem dimension of the state (See additional information). **Raises** @@ -69,7 +69,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### conjugate - + Return the conjugate of the density matrix. @@ -87,7 +87,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### draw - + Return a visualization of the Statevector. **repr**: ASCII TextMatrix of the state’s `__repr__`. @@ -120,30 +120,30 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### evolve - + Evolve a quantum state by an operator. **Parameters** - * **QuantumChannel** (*other (Operator or*) – or Instruction or Circuit): The operator to evolve by. - * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – a list of QuantumState subsystem positions to apply the operator on. + * **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *| QuantumChannel |*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The operator to evolve by. + * **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – a list of QuantumState subsystem positions to apply the operator on. **Returns** - the output density matrix. - - **Return type** - - [DensityMatrix](#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") + The output density matrix. **Raises** [**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the operator dimension does not match the specified QuantumState subsystem dimensions. + + **Return type** + + [DensityMatrix](#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") ### expand - + Return the tensor product state other ⊗ self. **Parameters** @@ -184,26 +184,26 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### from\_instruction - + Return the output density matrix of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. **Parameters** - **instruction** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – instruction or circuit + **instruction** ([*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – instruction or circuit **Returns** - the final density matrix. - - **Return type** - - [DensityMatrix](#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") + The final density matrix. **Raises** [**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – if the instruction contains invalid instructions for density matrix simulation. + + **Return type** + + [DensityMatrix](#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") ### from\_int @@ -265,7 +265,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### is\_valid - + Return True if trace 1 and positive semidefinite. @@ -293,7 +293,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### partial\_transpose - + Return partially transposed density matrix. **Parameters** @@ -405,7 +405,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### purity - + Return the purity of the quantum state. @@ -505,7 +505,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### tensor - + Return the tensor product state self ⊗ other. **Parameters** @@ -527,7 +527,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### to\_dict - + Convert the density matrix to dictionary form. This dictionary representation uses a Ket-like notation where the dictionary keys are qudit strings for the subsystem basis vectors. If any subsystem has a dimension greater than 10 comma delimiters are inserted between integers so that subsystems can be distinguished. @@ -603,7 +603,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### to\_operator - + Convert to Operator **Return type** @@ -613,7 +613,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### to\_statevector - + Return a statevector from a pure density matrix. **Parameters** @@ -638,7 +638,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix ### trace - + Return the trace of the density matrix. diff --git a/docs/api/qiskit/qiskit.quantum_info.Kraus.mdx b/docs/api/qiskit/qiskit.quantum_info.Kraus.mdx index dd61b78d57f..31737019646 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Kraus.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Kraus.mdx @@ -199,6 +199,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -215,6 +220,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -225,6 +235,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/qiskit.quantum_info.PTM.mdx b/docs/api/qiskit/qiskit.quantum_info.PTM.mdx index 7605e184846..71e520c7e60 100644 --- a/docs/api/qiskit/qiskit.quantum_info.PTM.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.PTM.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.PTM # PTM - + Bases: `QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. @@ -39,9 +39,9 @@ $$ **Parameters** - * **or** (*data (*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Instruction or BaseOperator or matrix): data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the output subsystem dimensions. \[Default: None] + * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. **Raises** @@ -203,6 +203,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -213,6 +218,11 @@ $$ Return True if completely-positive trace-preserving (CPTP). + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -223,6 +233,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -233,6 +248,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/qiskit.quantum_info.SparseObservable.mdx b/docs/api/qiskit/qiskit.quantum_info.SparseObservable.mdx index f30ae45d0f3..f60d7f10f4a 100644 --- a/docs/api/qiskit/qiskit.quantum_info.SparseObservable.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.SparseObservable.mdx @@ -194,6 +194,8 @@ $$ #### Term + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + A single term from a complete [`SparseObservable`](#qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable"). These are typically created by indexing into or iterating through a [`SparseObservable`](#qiskit.quantum_info.SparseObservable "qiskit.quantum_info.SparseObservable"). diff --git a/docs/api/qiskit/qiskit.quantum_info.StabilizerState.mdx b/docs/api/qiskit/qiskit.quantum_info.StabilizerState.mdx index 47e9aad8dde..e44679a17d1 100644 --- a/docs/api/qiskit/qiskit.quantum_info.StabilizerState.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.StabilizerState.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.StabilizerState # StabilizerState - + Bases: `QuantumState` StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). @@ -56,8 +56,8 @@ python_api_name: qiskit.quantum_info.StabilizerState **Parameters** - * **or** (*data (*[*StabilizerState*](#qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState") *or*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *or*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – qiskit.circuit.Instruction): Data from which the stabilizer state can be constructed. - * **validate** (*boolean*) – validate that the stabilizer state data is a valid Clifford. + * **data** ([*StabilizerState*](#qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState") *|*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *|*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – Data from which the stabilizer state can be constructed. + * **validate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – validate that the stabilizer state data is a valid Clifford. ## Attributes @@ -83,7 +83,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### conjugate - + Return the conjugate of the operator. @@ -101,7 +101,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### equiv - + Return True if the two generating sets generate the same stabilizer group. **Parameters** @@ -119,7 +119,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### evolve - + Evolve a stabilizer state by a Clifford operator. **Parameters** @@ -143,7 +143,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### expand - + Return the tensor product stabilizer state other ⊗ self. **Parameters** @@ -165,7 +165,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### expectation\_value - + Compute the expectation value of a Pauli operator. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### from\_stabilizer\_list - + Create a stabilizer state from the collection of stabilizers. **Parameters** @@ -208,13 +208,13 @@ python_api_name: qiskit.quantum_info.StabilizerState ### is\_valid - + Return True if a valid StabilizerState. ### measure - + Measure subsystems and return outcome and post-measure state. Note that this function uses the QuantumStates internal random number generator for sampling the measurement outcome. The RNG seed can be set using the [`seed()`](#qiskit.quantum_info.StabilizerState.seed "qiskit.quantum_info.StabilizerState.seed") method. @@ -236,7 +236,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### probabilities - + Return the subsystem measurement probability vector. Measurement probabilities are with respect to measurement in the computation (diagonal) basis. @@ -257,7 +257,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### probabilities\_dict - + Return the subsystem measurement probability dictionary. Measurement probabilities are with respect to measurement in the computation (diagonal) basis. @@ -280,7 +280,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### probabilities\_dict\_from\_bitstring - + Return the subsystem measurement probability dictionary utilizing a targeted outcome\_bitstring to perform the measurement for. This will calculate a probability for only a single targeted outcome\_bitstring value, giving a performance boost over calculating all possible outcomes. Measurement probabilities are with respect to measurement in the computation (diagonal) basis. @@ -304,7 +304,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### purity - + Return the purity of the quantum state, which equals to 1, since it is always a pure state. **Returns** @@ -322,7 +322,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### reset - + Reset state or subsystems to the 0-state. **Parameters** @@ -369,7 +369,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### sample\_memory - + Sample a list of qubit measurement outcomes in the computational basis. **Parameters** @@ -400,7 +400,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### tensor - + Return the tensor product stabilizer state self ⊗ other. **Parameters** @@ -422,7 +422,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### to\_operator - + Convert state to matrix operator class **Return type** @@ -432,7 +432,7 @@ python_api_name: qiskit.quantum_info.StabilizerState ### trace - + Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. **Returns** diff --git a/docs/api/qiskit/qiskit.quantum_info.Statevector.mdx b/docs/api/qiskit/qiskit.quantum_info.Statevector.mdx index 7616c4b376b..db253dc2d32 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Statevector.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Statevector.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Statevector # Statevector - + Bases: `QuantumState`, `TolerancesMixin` Statevector class @@ -17,8 +17,8 @@ python_api_name: qiskit.quantum_info.Statevector **Parameters** - * **or** (*data (np.array or* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or*[*Statevector*](#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – qiskit.circuit.Instruction): Data from which the statevector can be constructed. This can be either a complex vector, another statevector, a `Operator` with only one column or a `QuantumCircuit` or `Instruction`. If the data is a circuit or instruction, the statevector is constructed by assuming that all qubits are initialized to the zero state. - * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *or*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *or*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – Optional. The subsystem dimension of the state (See additional information). + * **data** (*np.ndarray |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *|*[*Statevector*](#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *|*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *|*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – Data from which the statevector can be constructed. This can be either a complex vector, another statevector, a `Operator` with only one column or a `QuantumCircuit` or `Instruction`. If the data is a circuit or instruction, the statevector is constructed by assuming that all qubits are initialized to the zero state. + * **dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| None*) – The subsystem dimension of the state (See additional information). **Raises** @@ -69,7 +69,7 @@ python_api_name: qiskit.quantum_info.Statevector ### conjugate - + Return the conjugate of the operator. **Return type** @@ -91,7 +91,7 @@ python_api_name: qiskit.quantum_info.Statevector ### draw - + Return a visualization of the Statevector. **repr**: ASCII TextMatrix of the state’s `__repr__`. @@ -141,7 +141,7 @@ python_api_name: qiskit.quantum_info.Statevector ### equiv - + Return True if other is equivalent as a statevector up to global phase. @@ -165,7 +165,7 @@ python_api_name: qiskit.quantum_info.Statevector ### evolve - + Evolve a quantum state by the operator. **Parameters** @@ -188,7 +188,7 @@ python_api_name: qiskit.quantum_info.Statevector ### expand - + Return the tensor product state other ⊗ self. **Parameters** @@ -210,7 +210,7 @@ python_api_name: qiskit.quantum_info.Statevector ### expectation\_value - + Compute the expectation value of an operator. **Parameters** @@ -229,7 +229,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_instruction - + Return the output statevector of an instruction. The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. @@ -253,7 +253,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_int - + Return a computational basis statevector. **Parameters** @@ -279,7 +279,7 @@ python_api_name: qiskit.quantum_info.Statevector ### from\_label - + Return a tensor product of Pauli X,Y,Z eigenstates. | Label | Statevector | @@ -310,7 +310,7 @@ python_api_name: qiskit.quantum_info.Statevector ### inner - + Return the inner product of self and other as $\langle self| other \rangle$. **Parameters** @@ -332,9 +332,14 @@ python_api_name: qiskit.quantum_info.Statevector ### is\_valid - + Return True if a Statevector has norm 1. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -364,7 +369,7 @@ python_api_name: qiskit.quantum_info.Statevector ### probabilities - + Return the subsystem measurement probability vector. Measurement probabilities are with respect to measurement in the computation (diagonal) basis. @@ -458,7 +463,7 @@ python_api_name: qiskit.quantum_info.Statevector ### purity - + Return the purity of the quantum state. **Return type** @@ -468,7 +473,7 @@ python_api_name: qiskit.quantum_info.Statevector ### reset - + Reset state or subsystems to the 0-state. **Parameters** @@ -490,7 +495,7 @@ python_api_name: qiskit.quantum_info.Statevector ### reverse\_qargs - + Return a Statevector with reversed subsystem ordering. For a tensor product state this is equivalent to reversing the order of tensor product subsystems. For a statevector $|\psi \rangle = |\psi_{n-1} \rangle \otimes ... \otimes |\psi_0 \rangle$ the returned statevector will be $|\psi_{0} \rangle \otimes ... \otimes |\psi_{n-1} \rangle$. @@ -562,7 +567,7 @@ python_api_name: qiskit.quantum_info.Statevector ### tensor - + Return the tensor product state self ⊗ other. **Parameters** @@ -584,7 +589,7 @@ python_api_name: qiskit.quantum_info.Statevector ### to\_dict - + Convert the statevector to dictionary form. This dictionary representation uses a Ket-like notation where the dictionary keys are qudit strings for the subsystem basis vectors. If any subsystem has a dimension greater than 10 comma delimiters are inserted between integers so that subsystems can be distinguished. @@ -653,7 +658,7 @@ python_api_name: qiskit.quantum_info.Statevector ### to\_operator - + Convert state to a rank-1 projector operator **Return type** @@ -663,7 +668,7 @@ python_api_name: qiskit.quantum_info.Statevector ### trace - + Return the trace of the quantum state as a density matrix. **Return type** diff --git a/docs/api/qiskit/qiskit.quantum_info.Stinespring.mdx b/docs/api/qiskit/qiskit.quantum_info.Stinespring.mdx index 84c2a0de373..a4bf74bb39b 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Stinespring.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Stinespring.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.Stinespring # Stinespring - + Bases: `QuantumChannel` Stinespring representation of a quantum channel. @@ -37,9 +37,9 @@ $$ **Parameters** - * **or** (*data (*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Instruction or BaseOperator or matrix): data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the output subsystem dimensions. \[Default: None] + * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. + * **input\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *|*[*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. **Raises** @@ -203,6 +203,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -219,6 +224,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -229,6 +239,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/qiskit.quantum_info.SuperOp.mdx b/docs/api/qiskit/qiskit.quantum_info.SuperOp.mdx index 179aae28cad..658a04e6c4f 100644 --- a/docs/api/qiskit/qiskit.quantum_info.SuperOp.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.SuperOp.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit.quantum_info.SuperOp # SuperOp - + Bases: `QuantumChannel` Superoperator representation of a quantum channel. @@ -31,9 +31,9 @@ $$ **Parameters** - * **or** (*data (*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Instruction or BaseOperator or matrix): data to initialize superoperator. - * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the input subsystem dimensions. \[Default: None] - * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – the output subsystem dimensions. \[Default: None] + * **data** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*circuit.instruction.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") *| BaseOperator | np.ndarray*) – data to initialize superoperator. + * **input\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the input subsystem dimensions. + * **output\_dims** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)") *| None*) – the output subsystem dimensions. **Raises** @@ -87,7 +87,7 @@ $$ ### adjoint - + Return the adjoint quantum channel. @@ -97,7 +97,7 @@ $$ ### compose - + Return the operator composition with another SuperOp. **Parameters** @@ -127,7 +127,7 @@ $$ ### conjugate - + Return the conjugate quantum channel. @@ -166,7 +166,7 @@ $$ ### expand - + Return the reverse-order tensor product with another SuperOp. **Parameters** @@ -195,6 +195,11 @@ $$ Test if Choi-matrix is completely-positive (CP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -205,6 +210,11 @@ $$ Return True if completely-positive trace-preserving (CPTP). + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -215,6 +225,11 @@ $$ Test if a channel is trace-preserving (TP) + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -225,6 +240,11 @@ $$ Return True if QuantumChannel is a unitary channel. + **Parameters** + + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **rtol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") @@ -288,7 +308,7 @@ $$ ### tensor - + Return the tensor product with another SuperOp. **Parameters** @@ -342,7 +362,7 @@ $$ ### transpose - + Return the transpose quantum channel. diff --git a/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.mdx b/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.mdx index 629c0f233c8..c7c71bcffad 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.mdx +++ b/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.mdx @@ -118,6 +118,10 @@ python_api_name: qiskit.quantum_info.Z2Symmetries A `Z2Symmetries` instance. + **Parameters** + + **operator** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.operators.symplectic.sparse_pauli_op.SparsePauliOp")) – + **Return type** [*Z2Symmetries*](#qiskit.quantum_info.Z2Symmetries "qiskit.quantum_info.analysis.z2_symmetries.Z2Symmetries") diff --git a/docs/api/qiskit/qiskit.result.ResultError.mdx b/docs/api/qiskit/qiskit.result.ResultError.mdx index 378eba118dd..4e4df5539b6 100644 --- a/docs/api/qiskit/qiskit.result.ResultError.mdx +++ b/docs/api/qiskit/qiskit.result.ResultError.mdx @@ -11,6 +11,8 @@ python_api_name: qiskit.result.ResultError # qiskit.result.ResultError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Exceptions raised due to errors in result output. It may be better for the Qiskit API to raise this exception. diff --git a/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.mdx b/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.mdx index ddedde76e34..1cc7eb83054 100644 --- a/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.mdx +++ b/docs/api/qiskit/qiskit.synthesis.TwoQubitWeylDecomposition.mdx @@ -42,6 +42,12 @@ $$ ## Attributes + **Parameters** + + * **unitary\_matrix** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")) – + * **fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *| None*) – + * **\_specialization** (*two\_qubit\_decompose.Specialization | None*) – + ### a @@ -103,6 +109,12 @@ $$ Returns Weyl decomposition in circuit form. + **Parameters** + + * **euler\_basis** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **simplify** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + * **atol** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") @@ -113,6 +125,12 @@ $$ Decode bytes into [`TwoQubitWeylDecomposition`](#qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition"). + **Parameters** + + * **bytes\_in** ([*bytes*](https://docs.python.org/3/library/stdtypes.html#bytes "(in Python v3.13)")) – + * **requested\_fidelity** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **\_specialization** (*two\_qubit\_decompose.Specialization | None*) – + **Return type** [TwoQubitWeylDecomposition](#qiskit.synthesis.TwoQubitWeylDecomposition "qiskit.synthesis.TwoQubitWeylDecomposition") diff --git a/docs/api/qiskit/qiskit.synthesis.XXDecomposer.mdx b/docs/api/qiskit/qiskit.synthesis.XXDecomposer.mdx index f9cf1953af4..62f06582e83 100644 --- a/docs/api/qiskit/qiskit.synthesis.XXDecomposer.mdx +++ b/docs/api/qiskit/qiskit.synthesis.XXDecomposer.mdx @@ -55,6 +55,10 @@ python_api_name: qiskit.synthesis.XXDecomposer This method is used by [`ConsolidateBlocks`](qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks"). + + **Parameters** + + **unitary** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *| np.ndarray*) – diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.mdx index c4e8c25ff47..51235b5838c 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.AQC.mdx @@ -36,6 +36,10 @@ python_api_name: qiskit.synthesis.unitary.aqc.AQC * **approximate\_circuit** ([*ApproximateCircuit*](qiskit.synthesis.unitary.aqc.ApproximateCircuit "qiskit.synthesis.unitary.aqc.ApproximateCircuit")) – a template circuit that will be filled with the parameter values obtained in the optimization procedure. * **approximating\_objective** ([*ApproximatingObjective*](qiskit.synthesis.unitary.aqc.ApproximatingObjective "qiskit.synthesis.unitary.aqc.ApproximatingObjective")) – a definition of the optimization problem. * **initial\_point** (*np.ndarray | None*) – initial values of angles/parameters to start optimization from. + + **Return type** + + None diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx index 59972251682..15ec135002d 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.ApproximateCircuit.mdx @@ -286,6 +286,10 @@ python_api_name: qiskit.synthesis.unitary.aqc.ApproximateCircuit **Parameters** **thetas** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")) – a vector of parameters to be set in this circuit. + + **Return type** + + None diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx index 515e5154d61..7480bbb4616 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.CNOTUnitCircuit.mdx @@ -288,6 +288,14 @@ python_api_name: qiskit.synthesis.unitary.aqc.CNOTUnitCircuit **Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a** parameter value is less in absolute value than the specified tolerance then the corresponding rotation gate will be skipped in the circuit. + + **Parameters** + + **thetas** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")) – + + **Return type** + + None diff --git a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx index 5beb6c2f613..0fa19653412 100644 --- a/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx +++ b/docs/api/qiskit/qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective.mdx @@ -45,6 +45,10 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective Computes the gradient of objective function. See description of the base class method. + **Parameters** + + **param\_values** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")) – + **Return type** [*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)") @@ -55,6 +59,10 @@ python_api_name: qiskit.synthesis.unitary.aqc.FastCNOTUnitObjective Computes the objective function and some intermediate data for the subsequent gradient computation. See description of the base class method. + **Parameters** + + **param\_values** ([*ndarray*](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)")) – + **Return type** [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") diff --git a/docs/api/qiskit/qiskit.transpiler.InstructionDurations.mdx b/docs/api/qiskit/qiskit.transpiler.InstructionDurations.mdx index 5641e2ef736..ecce543522d 100644 --- a/docs/api/qiskit/qiskit.transpiler.InstructionDurations.mdx +++ b/docs/api/qiskit/qiskit.transpiler.InstructionDurations.mdx @@ -17,6 +17,11 @@ python_api_name: qiskit.transpiler.InstructionDurations ## Methods + **Parameters** + + * **instruction\_durations** (*'InstructionDurationsType' | None*) – + * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + ### from\_backend diff --git a/docs/api/qiskit/qiskit.transpiler.Layout.mdx b/docs/api/qiskit/qiskit.transpiler.Layout.mdx index 6223b4d9ff1..e2c31d27db6 100644 --- a/docs/api/qiskit/qiskit.transpiler.Layout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.Layout.mdx @@ -280,6 +280,10 @@ python_api_name: qiskit.transpiler.Layout This is possible when the layout is a bijective mapping with the same source and target qubits (for instance, a “final\_layout” corresponds to a permutation of the physical circuit qubits). If this layout is a mapping from qubits to their new positions, the resulting permutation describes which qubits occupy the positions 0, 1, 2, etc. after applying the permutation. For example, suppose that the list of qubits is `[qr_0, qr_1, qr_2]`, and the layout maps `qr_0` to `2`, `qr_1` to `0`, and `qr_2` to `1`. In terms of positions in `qubits`, this maps `0` to `2`, `1` to `0` and `2` to `1`, with the corresponding permutation being `[1, 2, 0]`. + + **Parameters** + + **qubits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit")*]*) – diff --git a/docs/api/qiskit/qiskit.transpiler.PassManager.mdx b/docs/api/qiskit/qiskit.transpiler.PassManager.mdx index b1fd54a554f..ad13b794c75 100644 --- a/docs/api/qiskit/qiskit.transpiler.PassManager.mdx +++ b/docs/api/qiskit/qiskit.transpiler.PassManager.mdx @@ -34,6 +34,10 @@ python_api_name: qiskit.transpiler.PassManager **Raises** [**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if a pass in passes is not a proper pass. + + **Return type** + + None ### draw @@ -74,6 +78,10 @@ python_api_name: qiskit.transpiler.PassManager **Raises** [**PassManagerError**](passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.PassManagerError") – If the index is not found. + + **Return type** + + None ### replace @@ -85,6 +93,10 @@ python_api_name: qiskit.transpiler.PassManager * **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Pass index to replace, based on the position in passes(). * **passes** (*Task |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[Task]*) – A pass set to be added to the pass manager schedule. + + **Return type** + + None ### run diff --git a/docs/api/qiskit/qiskit.transpiler.StagedPassManager.mdx b/docs/api/qiskit/qiskit.transpiler.StagedPassManager.mdx index 4e3aa3168e5..60771c8222d 100644 --- a/docs/api/qiskit/qiskit.transpiler.StagedPassManager.mdx +++ b/docs/api/qiskit/qiskit.transpiler.StagedPassManager.mdx @@ -74,6 +74,10 @@ python_api_name: qiskit.transpiler.StagedPassManager **Raises** [**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if a pass in passes is not a proper pass. + + **Return type** + + None ### draw @@ -94,6 +98,10 @@ python_api_name: qiskit.transpiler.StagedPassManager **Raises** [**PassManagerError**](passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.PassManagerError") – If the index is not found. + + **Return type** + + None ### replace @@ -105,6 +113,10 @@ python_api_name: qiskit.transpiler.StagedPassManager * **index** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – Pass index to replace, based on the position in passes(). * **passes** (*BasePass |* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[BasePass]*) – A pass set to be added to the pass manager schedule. + + **Return type** + + None ### run diff --git a/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx b/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx index 07af8a1ed85..ac62dcce574 100644 --- a/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx +++ b/docs/api/qiskit/qiskit.transpiler.TranspileLayout.mdx @@ -87,6 +87,14 @@ python_api_name: qiskit.transpiler.TranspileLayout ## Attributes + **Parameters** + + * **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – + * **input\_qubit\_mapping** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*\[*[*circuit.Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + * **final\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout") *| None*) – + * **\_input\_qubit\_count** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + * **\_output\_qubit\_list** (*List\[*[*Qubit*](circuit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")*] | None*) – + ### final\_layout diff --git a/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.mdx b/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.mdx index 7d220f1b552..d67b379dfc4 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.FilterOpNodes.mdx @@ -95,6 +95,10 @@ python_api_name: qiskit.transpiler.passes.FilterOpNodes Run the RemoveBarriers pass on dag. + **Parameters** + + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **Return type** [*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx b/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx index 02957696fe9..7e71adbf768 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.mdx @@ -72,6 +72,10 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations Output dag with LinearFunctions synthesized. + **Parameters** + + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **Return type** [*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.mdx b/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.mdx index 937425a5011..4ffc0faa5c6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.mdx @@ -112,6 +112,11 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder Generate RX calibration for the rotation angle specified in node\_op. + **Parameters** + + * **node\_op** ([*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – + **Return type** [*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.schedule.Schedule") | [*ScheduleBlock*](qiskit.pulse.ScheduleBlock "qiskit.pulse.schedule.ScheduleBlock") @@ -150,6 +155,11 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder Check if the calibration for SX gate exists and it’s a single DRAG pulse. + **Parameters** + + * **node\_op** ([*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")) – + * **qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – + **Return type** [bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.mdx b/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.mdx index 2b978712327..ac6f3baec29 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.mdx @@ -87,6 +87,10 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers Run the RemoveBarriers pass on dag. + **Parameters** + + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **Return type** [*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries.mdx b/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries.mdx index a7543a0ced4..317d0f00e21 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.Split2QUnitaries.mdx @@ -74,6 +74,10 @@ python_api_name: qiskit.transpiler.passes.Split2QUnitaries Run the Split2QUnitaries pass on dag. + **Parameters** + + **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit")) – + **Return type** [*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.StarPreRouting.mdx b/docs/api/qiskit/qiskit.transpiler.passes.StarPreRouting.mdx index ad4f003d8d7..d9c27672ecb 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.StarPreRouting.mdx +++ b/docs/api/qiskit/qiskit.transpiler.passes.StarPreRouting.mdx @@ -82,6 +82,11 @@ python_api_name: qiskit.transpiler.passes.StarPreRouting **Return type** List\[StarBlock] + + **Parameters** + + * **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit._accelerate.circuit.DAGCircuit") *|*[*DAGDependency*](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.dagdependency.DAGDependency")) – + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – ### execute diff --git a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx index 8a619ebce4a..ff97a008cc0 100644 --- a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx +++ b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.mdx @@ -20,6 +20,12 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl Get a stage + **Parameters** + + * **stage\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **plugin\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + * **pm\_config** ([*PassManagerConfig*](qiskit.transpiler.PassManagerConfig "qiskit.transpiler.passmanager_config.PassManagerConfig")) – + **Return type** [*PassManager*](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") diff --git a/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx b/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx index 04d99b6c218..7f88c6e3090 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.mdx @@ -31,7 +31,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx b/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx index b1e14569c7f..c0867fcc74d 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.mdx @@ -19,7 +19,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector * **bloch** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[double]*) – array of three elements where \[\, \, \] (Cartesian) or \[\, \, \] (spherical in radians) \ is inclination angle from +z direction \ is azimuth from +x direction * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that represents the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An Axes to use for rendering the bloch sphere + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An Axes to use for rendering the bloch sphere * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. Has no effect is passing `ax`. * **coord\_type** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that specifies coordinate type for bloch (Cartesian or spherical), default is Cartesian * **font\_size** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Font size. @@ -30,7 +30,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx b/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx index 4c3aba4ed7c..f1cb2cc26b0 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_distribution.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.visualization.plot_distribution * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of strings to use for labels of the data. The number of entries must match the length of data (if data is a list or 1 if it’s a dict) * **bar\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Label each bar in histogram with probability value. * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A string to use for the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx b/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx index 75e324649f2..668b0e53f17 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_histogram.mdx @@ -24,7 +24,7 @@ python_api_name: qiskit.visualization.plot_histogram * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of strings to use for labels of the data. The number of entries must match the length of data (if data is a list or 1 if it’s a dict) * **bar\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Label each bar in histogram with counts value. * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – A string to use for the plot title - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx index 8af62e7e876..f58c398a716 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_city.mdx @@ -22,8 +22,8 @@ python_api_name: qiskit.visualization.plot_state_city * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")) – A list of len=2 giving colors for real and imaginary components of matrix elements. * **alpha** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – Transparency value for bars - * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. - * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_real only the imaginary component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_real only the imaginary component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -31,7 +31,7 @@ python_api_name: qiskit.visualization.plot_state_city **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx index 972c8cc6220..91b2296b9a6 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_hinton.mdx @@ -21,8 +21,8 @@ python_api_name: qiskit.visualization.plot_state_hinton * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that represents the plot title * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – file path to save image to. - * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. - * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_real** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax\_imag** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -30,7 +30,7 @@ python_api_name: qiskit.visualization.plot_state_hinton **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx index e9c536a988f..e6435311433 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.mdx @@ -28,7 +28,7 @@ $$ * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – a string that represents the plot title * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Color of the coefficient value bars. - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. **Returns** @@ -36,7 +36,7 @@ $$ **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx b/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx index db0e8d6dc0a..f45cff15163 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx +++ b/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.mdx @@ -17,7 +17,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere * **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")) – Figure size in inches. - * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.2)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. + * **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.9.3)")) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. * **show\_state\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – An optional boolean indicating whether to show labels for each basis state. * **show\_state\_phases** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – An optional boolean indicating whether to show the phase for each basis state. * **use\_degrees** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – An optional boolean indicating whether to use radians or degrees for the phase values in the plot. @@ -28,7 +28,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere **Return type** - [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.2)") + [`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure "(in Matplotlib v3.9.3)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.timeline_drawer.mdx b/docs/api/qiskit/qiskit.visualization.timeline_drawer.mdx index db2069a7f38..10e4d40091c 100644 --- a/docs/api/qiskit/qiskit.visualization.timeline_drawer.mdx +++ b/docs/api/qiskit/qiskit.visualization.timeline_drawer.mdx @@ -262,6 +262,36 @@ 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")) – + + * **style** ([*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")*] | None*) – + + * **time\_range** ([*Tuple*](https://docs.python.org/3/library/typing.html#typing.Tuple "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]*) – + + * **disable\_bits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[Bits]*) – + + * **show\_clbits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + + * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + + * **plot\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + + * **show\_delays** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + + * **show\_labels** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + + * **plotter** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + + * **axis** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)") *| None*) – + + * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + + * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.target.Target") *| None*) – + + * **show\_idle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + + * **show\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)") *| None*) – + **Examples** To visualize a scheduled circuit program, you can call this function with set of control arguments. Most of appearance of the output image can be controlled by the stylesheet. diff --git a/docs/api/qiskit/qpy.mdx b/docs/api/qiskit/qpy.mdx index 33ed0168a10..698fc3307d6 100644 --- a/docs/api/qiskit/qpy.mdx +++ b/docs/api/qiskit/qpy.mdx @@ -173,6 +173,8 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski ### QpyError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Errors raised by the qpy module. Set the error message. @@ -183,6 +185,8 @@ When a lower-than-maximum target QPY version is set for serialization, but the o ### UnsupportedFeatureForVersion + Bases: [`QpyError`](#qiskit.qpy.QpyError "qiskit.qpy.exceptions.QpyError") + QPY error raised when the target dump version is too low for a feature that is present in the object to be serialized. **Parameters** @@ -225,6 +229,8 @@ If a feature being loaded is deprecated in the corresponding qiskit release, QPY ### QPYLoadingDeprecatedFeatureWarning + Bases: [`QiskitWarning`](exceptions#qiskit.exceptions.QiskitWarning "qiskit.exceptions.QiskitWarning") + Visible deprecation warning for QPY loading functions without a stable point in the call stack. diff --git a/docs/api/qiskit/scheduler.mdx b/docs/api/qiskit/scheduler.mdx index f942055e1e1..56777f53ce0 100644 --- a/docs/api/qiskit/scheduler.mdx +++ b/docs/api/qiskit/scheduler.mdx @@ -23,6 +23,8 @@ A circuit scheduler compiles a circuit program to a pulse program. ### ScheduleConfig + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + Configuration for pulse scheduling. Container for information needed to schedule a QuantumCircuit into a pulse Schedule. diff --git a/docs/api/qiskit/synthesis.mdx b/docs/api/qiskit/synthesis.mdx index 9e180539c21..44e73bd3b39 100644 --- a/docs/api/qiskit/synthesis.mdx +++ b/docs/api/qiskit/synthesis.mdx @@ -858,6 +858,13 @@ The Approximate Quantum Compiler is available as the module [`qiskit.synthesis.u └───┘ └───┘ ``` + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – + * **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **num\_target\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + **Return type** [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") diff --git a/docs/api/qiskit/transpiler.mdx b/docs/api/qiskit/transpiler.mdx index b08bb731c19..5e740242826 100644 --- a/docs/api/qiskit/transpiler.mdx +++ b/docs/api/qiskit/transpiler.mdx @@ -944,6 +944,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerError + Bases: [`TranspilerAccessError`](#qiskit.transpiler.TranspilerAccessError "qiskit.transpiler.exceptions.TranspilerAccessError") + Exceptions raised during transpilation. Set the error message. @@ -952,6 +954,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### TranspilerAccessError + Bases: [`PassManagerError`](passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.exceptions.PassManagerError") + DEPRECATED: Exception of access error in the transpiler passes. Set the error message. @@ -960,6 +964,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### CouplingError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Base class for errors raised by the coupling graph object. Set the error message. @@ -968,6 +974,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### LayoutError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + Errors raised by the layout object. Set the error message. @@ -976,6 +984,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### CircuitTooWideForTarget + Bases: [`TranspilerError`](#qiskit.transpiler.TranspilerError "qiskit.transpiler.exceptions.TranspilerError") + Error raised if the circuit is too wide for the target. Set the error message. @@ -984,6 +994,8 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor #### InvalidLayoutError + Bases: [`TranspilerError`](#qiskit.transpiler.TranspilerError "qiskit.transpiler.exceptions.TranspilerError") + Error raised when a user provided layout is invalid. Set the error message. diff --git a/docs/api/qiskit/utils.mdx b/docs/api/qiskit/utils.mdx index 0b5d7fbf0f8..8f93cfbb6d2 100644 --- a/docs/api/qiskit/utils.mdx +++ b/docs/api/qiskit/utils.mdx @@ -29,6 +29,10 @@ python_api_name: qiskit.utils * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – The full deprecation message. * **since** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – The version the deprecation started at. * **pending** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – Is the deprecation still pending? + + **Return type** + + None ### deprecate\_arg @@ -156,6 +160,11 @@ python_api_name: qiskit.utils [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the `units` aren’t recognized. + **Parameters** + + * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") *|*[*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – + * **unit** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – + **Return type** [float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)") | [ParameterExpression](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") @@ -198,6 +207,11 @@ python_api_name: qiskit.utils * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the `value` is out of range. * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.13)") – If the `value` is not real number. + **Parameters** + + * **value** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)")) – + * **decimal** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)") *| None*) – + **Return type** [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.13)"), [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")] @@ -512,6 +526,8 @@ from qiskit.utils import LazyImportTester #### LazyDependencyManager + Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)") + A mananger for some optional features that are expensive to import, or to verify the existence of. These objects can be used as Booleans, such as `if x`, and will evaluate `True` if the dependency they test for is available, and `False` if not. The presence of the dependency will only be tested when the Boolean is evaluated, so it can be used as a runtime test in functions and methods without requiring an import-time test. @@ -619,11 +635,17 @@ from qiskit.utils import LazyImportTester #### LazyImportTester + Bases: [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.lazy_tester.LazyDependencyManager") + A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. **Parameters** - **name\_map\_or\_modules** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]] |* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – if a name map, then a dictionary where the keys are modules or packages, and the values are iterables of names to try and import from that module. It should be valid to write `from import , , ...`. If simply a string or iterable of strings, then it should be valid to write `import ` for each of them. + * **name\_map\_or\_modules** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*,* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]] |* [*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – if a name map, then a dictionary where the keys are modules or packages, and the values are iterables of names to try and import from that module. It should be valid to write `from import , , ...`. If simply a string or iterable of strings, then it should be valid to write `import ` for each of them. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*], None] | None*) – + * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – **Raises** @@ -633,11 +655,17 @@ from qiskit.utils import LazyImportTester #### LazySubprocessTester + Bases: [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.lazy_tester.LazyDependencyManager") + A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. **Parameters** - **command** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – the strings that make up the command to be run. For example, `["pdflatex", "-version"]`. + * **command** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*]*) – the strings that make up the command to be run. For example, `["pdflatex", "-version"]`. + * **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **callback** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.13)")*\[\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*], None] | None*) – + * **install** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – + * **msg** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *| None*) – **Raises** diff --git a/docs/api/qiskit/visualization.mdx b/docs/api/qiskit/visualization.mdx index 8946cd0b8f7..17152a9a8f8 100644 --- a/docs/api/qiskit/visualization.mdx +++ b/docs/api/qiskit/visualization.mdx @@ -224,6 +224,8 @@ You can find code examples for each visualization functions on the individual fu ### VisualizationError + Bases: [`QiskitError`](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") + For visualization specific errors. Set the error message. diff --git a/public/images/api/qiskit/circuit-1.png b/public/images/api/qiskit/circuit-1.png index ee4bc6b1ede..d95062fc736 100644 Binary files a/public/images/api/qiskit/circuit-1.png and b/public/images/api/qiskit/circuit-1.png differ diff --git a/public/images/api/qiskit/circuit-2.png b/public/images/api/qiskit/circuit-2.png index 7869690de7e..de410a5a89f 100644 Binary files a/public/images/api/qiskit/circuit-2.png and b/public/images/api/qiskit/circuit-2.png differ diff --git a/public/images/api/qiskit/circuit-4.png b/public/images/api/qiskit/circuit-4.png index 79dcc86f914..8c50f1454fd 100644 Binary files a/public/images/api/qiskit/circuit-4.png and b/public/images/api/qiskit/circuit-4.png differ diff --git a/public/images/api/qiskit/circuit_library-1.png b/public/images/api/qiskit/circuit_library-1.png index 0997251b2c6..5fc838e6514 100644 Binary files a/public/images/api/qiskit/circuit_library-1.png and b/public/images/api/qiskit/circuit_library-1.png differ diff --git a/public/images/api/qiskit/converters-1.png b/public/images/api/qiskit/converters-1.png index 0904cef0a72..6ffc58e98d5 100644 Binary files a/public/images/api/qiskit/converters-1.png and b/public/images/api/qiskit/converters-1.png differ diff --git a/public/images/api/qiskit/providers_fake_provider-1_00.png b/public/images/api/qiskit/providers_fake_provider-1_00.png index 525727b96c4..9c55978b565 100644 Binary files a/public/images/api/qiskit/providers_fake_provider-1_00.png and b/public/images/api/qiskit/providers_fake_provider-1_00.png differ diff --git a/public/images/api/qiskit/providers_fake_provider-1_01.png b/public/images/api/qiskit/providers_fake_provider-1_01.png index 25c8eab3bfe..bc15eddd4f7 100644 Binary files a/public/images/api/qiskit/providers_fake_provider-1_01.png and b/public/images/api/qiskit/providers_fake_provider-1_01.png differ diff --git a/public/images/api/qiskit/providers_fake_provider-1_02.png b/public/images/api/qiskit/providers_fake_provider-1_02.png index 00883d1461c..4edcb6d4a97 100644 Binary files a/public/images/api/qiskit/providers_fake_provider-1_02.png and b/public/images/api/qiskit/providers_fake_provider-1_02.png differ diff --git a/public/images/api/qiskit/pulse-1.png b/public/images/api/qiskit/pulse-1.png index acfbe1cae5e..85b2662c8ca 100644 Binary files a/public/images/api/qiskit/pulse-1.png and b/public/images/api/qiskit/pulse-1.png differ diff --git a/public/images/api/qiskit/pulse-2.png b/public/images/api/qiskit/pulse-2.png index 950a983a4df..a6af01c18a2 100644 Binary files a/public/images/api/qiskit/pulse-2.png and b/public/images/api/qiskit/pulse-2.png differ diff --git a/public/images/api/qiskit/pulse-3.png b/public/images/api/qiskit/pulse-3.png index 9d68dc4fdef..4a258e1bd7c 100644 Binary files a/public/images/api/qiskit/pulse-3.png and b/public/images/api/qiskit/pulse-3.png differ diff --git a/public/images/api/qiskit/pulse-4.png b/public/images/api/qiskit/pulse-4.png index ae7bdef763a..667e47dabfe 100644 Binary files a/public/images/api/qiskit/pulse-4.png and b/public/images/api/qiskit/pulse-4.png differ diff --git a/public/images/api/qiskit/pulse-5.png b/public/images/api/qiskit/pulse-5.png index 1b2813ea200..5ee85eaf2d4 100644 Binary files a/public/images/api/qiskit/pulse-5.png and b/public/images/api/qiskit/pulse-5.png differ diff --git a/public/images/api/qiskit/pulse-6.png b/public/images/api/qiskit/pulse-6.png index cbcb6c4bc35..f13e93fe8e4 100644 Binary files a/public/images/api/qiskit/pulse-6.png and b/public/images/api/qiskit/pulse-6.png differ diff --git a/public/images/api/qiskit/pulse-7.png b/public/images/api/qiskit/pulse-7.png index de8ba444f13..10e01a08991 100644 Binary files a/public/images/api/qiskit/pulse-7.png and b/public/images/api/qiskit/pulse-7.png differ diff --git a/public/images/api/qiskit/qasm3-1.png b/public/images/api/qiskit/qasm3-1.png index 64ddf230e32..fe78c9df525 100644 Binary files a/public/images/api/qiskit/qasm3-1.png and b/public/images/api/qiskit/qasm3-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-ControlledGate-1.png b/public/images/api/qiskit/qiskit-circuit-ControlledGate-1.png index 0d65481fbc4..d3730fe8a53 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-ControlledGate-1.png and b/public/images/api/qiskit/qiskit-circuit-ControlledGate-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-ControlledGate-2.png b/public/images/api/qiskit/qiskit-circuit-ControlledGate-2.png index b65161862a7..4562f01f5eb 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-ControlledGate-2.png and b/public/images/api/qiskit/qiskit-circuit-ControlledGate-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-Operation-1.png b/public/images/api/qiskit/qiskit-circuit-Operation-1.png index 2fb23776c61..b5b22e624c5 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-Operation-1.png and b/public/images/api/qiskit/qiskit-circuit-Operation-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-Parameter-1_00.png b/public/images/api/qiskit/qiskit-circuit-Parameter-1_00.png index 988cd5f5586..7f176bcdabd 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-Parameter-1_00.png and b/public/images/api/qiskit/qiskit-circuit-Parameter-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-Parameter-1_01.png b/public/images/api/qiskit/qiskit-circuit-Parameter-1_01.png index 9cd8b258321..cd02a82ffe5 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-Parameter-1_01.png and b/public/images/api/qiskit/qiskit-circuit-Parameter-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_00.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_00.png index 262071e9568..4040fef878f 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_00.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_01.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_01.png index de8b1426485..1bab4b4be8d 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_01.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_00.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_00.png index fd29d4d2a3b..507450a0aa4 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_00.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_01.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_01.png index 571ee490162..8a4a8ce88bb 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_01.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3.png index 552fc9a16ea..bb7e445111c 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4.png index b3366e83d64..257e65f761a 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-5.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-5.png index 978283163d2..a863d358c2a 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-5.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-5.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-AND-1.png b/public/images/api/qiskit/qiskit-circuit-library-AND-1.png index 459e443a455..384d689fc1d 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-AND-1.png and b/public/images/api/qiskit/qiskit-circuit-library-AND-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-AND-2.png b/public/images/api/qiskit/qiskit-circuit-library-AND-2.png index 207ae6e4b45..61324615472 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-AND-2.png and b/public/images/api/qiskit/qiskit-circuit-library-AND-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-AndGate-1.png b/public/images/api/qiskit/qiskit-circuit-library-AndGate-1.png index 0a09a35c11e..10f74e61cad 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-AndGate-1.png and b/public/images/api/qiskit/qiskit-circuit-library-AndGate-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-AndGate-2.png b/public/images/api/qiskit/qiskit-circuit-library-AndGate-2.png index d13c041fc42..4a8faad432e 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-AndGate-2.png and b/public/images/api/qiskit/qiskit-circuit-library-AndGate-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-BitwiseXorGate-1.png b/public/images/api/qiskit/qiskit-circuit-library-BitwiseXorGate-1.png index e948bfc8962..1a709dcdbf9 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-BitwiseXorGate-1.png and b/public/images/api/qiskit/qiskit-circuit-library-BitwiseXorGate-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-FourierChecking-1.png b/public/images/api/qiskit/qiskit-circuit-library-FourierChecking-1.png index b0109dcea32..42a14f41a32 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-FourierChecking-1.png and b/public/images/api/qiskit/qiskit-circuit-library-FourierChecking-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GMS-1.png b/public/images/api/qiskit/qiskit-circuit-library-GMS-1.png index 8bf0c84a04b..c868315d3c7 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GMS-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GMS-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GR-1.png b/public/images/api/qiskit/qiskit-circuit-library-GR-1.png index 23fc157512c..29b016798bd 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GR-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GR-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GRX-1.png b/public/images/api/qiskit/qiskit-circuit-library-GRX-1.png index 2b7f803aae9..ed3187d07a5 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GRX-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GRX-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GRY-1.png b/public/images/api/qiskit/qiskit-circuit-library-GRY-1.png index 23fc157512c..29b016798bd 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GRY-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GRY-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GRZ-1.png b/public/images/api/qiskit/qiskit-circuit-library-GRZ-1.png index 498bcbe70f4..e692d0e3c8e 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GRZ-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GRZ-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GraphState-1.png b/public/images/api/qiskit/qiskit-circuit-library-GraphState-1.png index a756a24d72b..9d9b7b4567d 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GraphState-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GraphState-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-GraphStateGate-1.png b/public/images/api/qiskit/qiskit-circuit-library-GraphStateGate-1.png index b51ca953e34..1a9c539d69f 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-GraphStateGate-1.png and b/public/images/api/qiskit/qiskit-circuit-library-GraphStateGate-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-HiddenLinearFunction-1.png b/public/images/api/qiskit/qiskit-circuit-library-HiddenLinearFunction-1.png index 1dc8e1f4895..8a44f1f56cc 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-HiddenLinearFunction-1.png and b/public/images/api/qiskit/qiskit-circuit-library-HiddenLinearFunction-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-IQP-1.png b/public/images/api/qiskit/qiskit-circuit-library-IQP-1.png index 16b302b8415..c60b967fe16 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-IQP-1.png and b/public/images/api/qiskit/qiskit-circuit-library-IQP-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-IQP-2.png b/public/images/api/qiskit/qiskit-circuit-library-IQP-2.png index 7fddb6d79c5..d0d73d406ae 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-IQP-2.png and b/public/images/api/qiskit/qiskit-circuit-library-IQP-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-InnerProduct-1.png b/public/images/api/qiskit/qiskit-circuit-library-InnerProduct-1.png index 4572ba0b186..c4e1dd4e324 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-InnerProduct-1.png and b/public/images/api/qiskit/qiskit-circuit-library-InnerProduct-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-InnerProductGate-1.png b/public/images/api/qiskit/qiskit-circuit-library-InnerProductGate-1.png index 77c9926821e..3a7485e3a92 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-InnerProductGate-1.png and b/public/images/api/qiskit/qiskit-circuit-library-InnerProductGate-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-MCMTVChain-1.png b/public/images/api/qiskit/qiskit-circuit-library-MCMTVChain-1.png index cfd9ba3d3ce..d81bdfe54c7 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-MCMTVChain-1.png and b/public/images/api/qiskit/qiskit-circuit-library-MCMTVChain-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-OR-1.png b/public/images/api/qiskit/qiskit-circuit-library-OR-1.png index da1c53ead95..bd9cc385f51 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-OR-1.png and b/public/images/api/qiskit/qiskit-circuit-library-OR-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-OR-2.png b/public/images/api/qiskit/qiskit-circuit-library-OR-2.png index 7940415ff5d..9d648a5ee75 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-OR-2.png and b/public/images/api/qiskit/qiskit-circuit-library-OR-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-OrGate-1.png b/public/images/api/qiskit/qiskit-circuit-library-OrGate-1.png index 165cb5c5352..8374de1a565 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-OrGate-1.png and b/public/images/api/qiskit/qiskit-circuit-library-OrGate-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-OrGate-2.png b/public/images/api/qiskit/qiskit-circuit-library-OrGate-2.png index 6a69469eded..a8e11d27ff3 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-OrGate-2.png and b/public/images/api/qiskit/qiskit-circuit-library-OrGate-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-PauliTwoDesign-1.png b/public/images/api/qiskit/qiskit-circuit-library-PauliTwoDesign-1.png index ee05a8eb8b8..463f887a9f9 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-PauliTwoDesign-1.png and b/public/images/api/qiskit/qiskit-circuit-library-PauliTwoDesign-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-Permutation-1.png b/public/images/api/qiskit/qiskit-circuit-library-Permutation-1.png index f822ec220ad..bab4eae5ec8 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-Permutation-1.png and b/public/images/api/qiskit/qiskit-circuit-library-Permutation-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-Permutation-2.png b/public/images/api/qiskit/qiskit-circuit-library-Permutation-2.png index eff804375a7..ab104bee18c 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-Permutation-2.png and b/public/images/api/qiskit/qiskit-circuit-library-Permutation-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-1.png b/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-1.png index 4791aef598e..33c82de4fdf 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-1.png and b/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.png b/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.png index c379fd4b826..b647891fd62 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.png and b/public/images/api/qiskit/qiskit-circuit-library-PermutationGate-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.png b/public/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.png index 51e327c2722..6f97c782e55 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.png and b/public/images/api/qiskit/qiskit-circuit-library-PhaseEstimation-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-PiecewiseChebyshev-1.png b/public/images/api/qiskit/qiskit-circuit-library-PiecewiseChebyshev-1.png index f829f0f160d..3ba7dbc9d9f 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-PiecewiseChebyshev-1.png and b/public/images/api/qiskit/qiskit-circuit-library-PiecewiseChebyshev-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-QFT-1.png b/public/images/api/qiskit/qiskit-circuit-library-QFT-1.png index dd52d798655..a356ab35ad6 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-QFT-1.png and b/public/images/api/qiskit/qiskit-circuit-library-QFT-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-QFT-2.png b/public/images/api/qiskit/qiskit-circuit-library-QFT-2.png index cf07ade2799..424914d631a 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-QFT-2.png and b/public/images/api/qiskit/qiskit-circuit-library-QFT-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-QFT-3.png b/public/images/api/qiskit/qiskit-circuit-library-QFT-3.png index 739f401ca6e..39437991793 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-QFT-3.png and b/public/images/api/qiskit/qiskit-circuit-library-QFT-3.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-1.png b/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-1.png index d107605a5fa..64d7766d081 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-1.png and b/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-2.png b/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-2.png index 1c4badeb8b5..10f838b23f4 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-2.png and b/public/images/api/qiskit/qiskit-circuit-library-QuantumVolume-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-XOR-1.png b/public/images/api/qiskit/qiskit-circuit-library-XOR-1.png index 2198fcfa39c..8e7fbcc12cd 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-XOR-1.png and b/public/images/api/qiskit/qiskit-circuit-library-XOR-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-1.png b/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-1.png index 6edcecde925..80893eaf75e 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-1.png and b/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-2_00.png b/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-2_00.png index 6edcecde925..80893eaf75e 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-2_00.png and b/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-2_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-2_01.png b/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-2_01.png index e5f32424d3a..6e90622eb4f 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-2_01.png and b/public/images/api/qiskit/qiskit-circuit-library-efficient_su2-2_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-evolved_operator_ansatz-1.png b/public/images/api/qiskit/qiskit-circuit-library-evolved_operator_ansatz-1.png index dbb00bec2e9..b12f11a52a9 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-evolved_operator_ansatz-1.png and b/public/images/api/qiskit/qiskit-circuit-library-evolved_operator_ansatz-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-1.png b/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-1.png index 55aca80d3b4..143b0048680 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-1.png and b/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-2_00.png b/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-2_00.png index 55aca80d3b4..143b0048680 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-2_00.png and b/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-2_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-2_01.png b/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-2_01.png index 2498c423b83..b1c7438d7f8 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-2_01.png and b/public/images/api/qiskit/qiskit-circuit-library-excitation_preserving-2_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-fourier_checking-1.png b/public/images/api/qiskit/qiskit-circuit-library-fourier_checking-1.png index e502994f1b5..4295cb1f69d 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-fourier_checking-1.png and b/public/images/api/qiskit/qiskit-circuit-library-fourier_checking-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-1.png b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-1.png index c04464ccdf1..960b65d85f3 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-1.png and b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-2_00.png b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-2_00.png index c04464ccdf1..960b65d85f3 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-2_00.png and b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-2_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-2_01.png b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-2_01.png index 68fe139ed4a..731151d34e6 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-2_01.png and b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-2_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_00.png b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_00.png index c04464ccdf1..960b65d85f3 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_00.png and b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_01.png b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_01.png index 68fe139ed4a..731151d34e6 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_01.png and b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_02.png b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_02.png index 16ed81bea5f..a4440829c98 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_02.png and b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_02.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_00.png b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_00.png index c04464ccdf1..960b65d85f3 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_00.png and b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_01.png b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_01.png index 68fe139ed4a..731151d34e6 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_01.png and b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_02.png b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_02.png index 16ed81bea5f..a4440829c98 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_02.png and b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_02.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_03.png b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_03.png index 928ad6f2d7f..141d6953175 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_03.png and b/public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_03.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-hamiltonian_variational_ansatz-1.png b/public/images/api/qiskit/qiskit-circuit-library-hamiltonian_variational_ansatz-1.png index 3559a7a8b10..ff31ae9106e 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-hamiltonian_variational_ansatz-1.png and b/public/images/api/qiskit/qiskit-circuit-library-hamiltonian_variational_ansatz-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-hamiltonian_variational_ansatz-2.png b/public/images/api/qiskit/qiskit-circuit-library-hamiltonian_variational_ansatz-2.png index 796eb86b445..b82a9206b48 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-hamiltonian_variational_ansatz-2.png and b/public/images/api/qiskit/qiskit-circuit-library-hamiltonian_variational_ansatz-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-hidden_linear_function-1.png b/public/images/api/qiskit/qiskit-circuit-library-hidden_linear_function-1.png index ba1269885c2..7e7271853ac 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-hidden_linear_function-1.png and b/public/images/api/qiskit/qiskit-circuit-library-hidden_linear_function-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-iqp_function-1.png b/public/images/api/qiskit/qiskit-circuit-library-iqp_function-1.png index 5928e2ff79f..1744741868c 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-iqp_function-1.png and b/public/images/api/qiskit/qiskit-circuit-library-iqp_function-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-iqp_function-2.png b/public/images/api/qiskit/qiskit-circuit-library-iqp_function-2.png index 7fddb6d79c5..d0d73d406ae 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-iqp_function-2.png and b/public/images/api/qiskit/qiskit-circuit-library-iqp_function-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-n_local-1.png b/public/images/api/qiskit/qiskit-circuit-library-n_local-1.png index ede29e21a00..5878f8b7255 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-n_local-1.png and b/public/images/api/qiskit/qiskit-circuit-library-n_local-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-n_local-2_00.png b/public/images/api/qiskit/qiskit-circuit-library-n_local-2_00.png index ede29e21a00..5878f8b7255 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-n_local-2_00.png and b/public/images/api/qiskit/qiskit-circuit-library-n_local-2_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-n_local-2_01.png b/public/images/api/qiskit/qiskit-circuit-library-n_local-2_01.png index 8149476d36f..62e271848b2 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-n_local-2_01.png and b/public/images/api/qiskit/qiskit-circuit-library-n_local-2_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-n_local-3_00.png b/public/images/api/qiskit/qiskit-circuit-library-n_local-3_00.png index ede29e21a00..5878f8b7255 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-n_local-3_00.png and b/public/images/api/qiskit/qiskit-circuit-library-n_local-3_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-n_local-3_01.png b/public/images/api/qiskit/qiskit-circuit-library-n_local-3_01.png index 8149476d36f..62e271848b2 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-n_local-3_01.png and b/public/images/api/qiskit/qiskit-circuit-library-n_local-3_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-n_local-3_02.png b/public/images/api/qiskit/qiskit-circuit-library-n_local-3_02.png index 7d7fb9f92cf..ec8130dbbc8 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-n_local-3_02.png and b/public/images/api/qiskit/qiskit-circuit-library-n_local-3_02.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-n_local-4_00.png b/public/images/api/qiskit/qiskit-circuit-library-n_local-4_00.png index ede29e21a00..5878f8b7255 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-n_local-4_00.png and b/public/images/api/qiskit/qiskit-circuit-library-n_local-4_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-n_local-4_01.png b/public/images/api/qiskit/qiskit-circuit-library-n_local-4_01.png index 8149476d36f..62e271848b2 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-n_local-4_01.png and b/public/images/api/qiskit/qiskit-circuit-library-n_local-4_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-n_local-4_02.png b/public/images/api/qiskit/qiskit-circuit-library-n_local-4_02.png index 7d7fb9f92cf..ec8130dbbc8 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-n_local-4_02.png and b/public/images/api/qiskit/qiskit-circuit-library-n_local-4_02.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-n_local-4_03.png b/public/images/api/qiskit/qiskit-circuit-library-n_local-4_03.png index 6637f94471c..7d9e2a34105 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-n_local-4_03.png and b/public/images/api/qiskit/qiskit-circuit-library-n_local-4_03.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-pauli_two_design-1.png b/public/images/api/qiskit/qiskit-circuit-library-pauli_two_design-1.png index 7e201df3279..6f474dfc09e 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-pauli_two_design-1.png and b/public/images/api/qiskit/qiskit-circuit-library-pauli_two_design-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-phase_estimation-1.png b/public/images/api/qiskit/qiskit-circuit-library-phase_estimation-1.png index 777f2930ff7..3fb4fdd7387 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-phase_estimation-1.png and b/public/images/api/qiskit/qiskit-circuit-library-phase_estimation-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-qaoa_ansatz-1.png b/public/images/api/qiskit/qiskit-circuit-library-qaoa_ansatz-1.png index f98cd971abd..fd87e190944 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-qaoa_ansatz-1.png and b/public/images/api/qiskit/qiskit-circuit-library-qaoa_ansatz-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-quantum_volume-1.png b/public/images/api/qiskit/qiskit-circuit-library-quantum_volume-1.png index 14c11e5c862..38354dfb579 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-quantum_volume-1.png and b/public/images/api/qiskit/qiskit-circuit-library-quantum_volume-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-random_iqp-1.png b/public/images/api/qiskit/qiskit-circuit-library-random_iqp-1.png index 80c70a35fbd..98d24aecf32 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-random_iqp-1.png and b/public/images/api/qiskit/qiskit-circuit-library-random_iqp-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-1.png b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-1.png index 828d97b2daf..081270da874 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-1.png and b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-2_00.png b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-2_00.png index 828d97b2daf..081270da874 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-2_00.png and b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-2_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-2_01.png b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-2_01.png index d678e0ee1fc..4fcd6365942 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-2_01.png and b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-2_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_00.png b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_00.png index 828d97b2daf..081270da874 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_00.png and b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_01.png b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_01.png index d678e0ee1fc..4fcd6365942 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_01.png and b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_02.png b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_02.png index ede29e21a00..5878f8b7255 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_02.png and b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_02.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_00.png b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_00.png index 828d97b2daf..081270da874 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_00.png and b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_01.png b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_01.png index d678e0ee1fc..4fcd6365942 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_01.png and b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_02.png b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_02.png index ede29e21a00..5878f8b7255 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_02.png and b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_02.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_03.png b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_03.png index c85f18d913a..ef45dd0d591 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_03.png and b/public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_03.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-library-unitary_overlap-1.png b/public/images/api/qiskit/qiskit-circuit-library-unitary_overlap-1.png index 41cb84e437e..d107ca34bb6 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-library-unitary_overlap-1.png and b/public/images/api/qiskit/qiskit-circuit-library-unitary_overlap-1.png differ diff --git a/public/images/api/qiskit/qiskit-primitives-StatevectorEstimator-1.png b/public/images/api/qiskit/qiskit-primitives-StatevectorEstimator-1.png index 44a5a75a862..8277c3df4fd 100644 Binary files a/public/images/api/qiskit/qiskit-primitives-StatevectorEstimator-1.png and b/public/images/api/qiskit/qiskit-primitives-StatevectorEstimator-1.png differ diff --git a/public/images/api/qiskit/qiskit-pulse-library-SymbolicPulse-1.png b/public/images/api/qiskit/qiskit-pulse-library-SymbolicPulse-1.png index 9c15b98fead..bdd6d34486a 100644 Binary files a/public/images/api/qiskit/qiskit-pulse-library-SymbolicPulse-1.png and b/public/images/api/qiskit/qiskit-pulse-library-SymbolicPulse-1.png differ diff --git a/public/images/api/qiskit/qiskit-quantum_info-Statevector-1.png b/public/images/api/qiskit/qiskit-quantum_info-Statevector-1.png index e37eb0be7ae..9ea2ecbcb76 100644 Binary files a/public/images/api/qiskit/qiskit-quantum_info-Statevector-1.png and b/public/images/api/qiskit/qiskit-quantum_info-Statevector-1.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-1.png b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-1.png index b6c22f78740..2e548ff6f7a 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-1.png and b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-1.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-2.png b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-2.png index 0874811b4dd..f6fb3d6094b 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-2.png and b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-2.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-3.png b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-3.png index 4e9c8b49d99..11f1ef8c754 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-3.png and b/public/images/api/qiskit/qiskit-transpiler-TranspileLayout-3.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png b/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png index bf3ce9be810..9ae85a41f36 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png and b/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png b/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png index 4d99bae86a2..539a197613f 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png and b/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-FilterOpNodes-1.png b/public/images/api/qiskit/qiskit-transpiler-passes-FilterOpNodes-1.png index bcb7e2febb9..d1484afda98 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-FilterOpNodes-1.png and b/public/images/api/qiskit/qiskit-transpiler-passes-FilterOpNodes-1.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png b/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png index bf3ce9be810..9ae85a41f36 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png and b/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png b/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png index 4d99bae86a2..539a197613f 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png and b/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-RemoveBarriers-1.png b/public/images/api/qiskit/qiskit-transpiler-passes-RemoveBarriers-1.png index 12c8176374f..03ee33e80ca 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-RemoveBarriers-1.png and b/public/images/api/qiskit/qiskit-transpiler-passes-RemoveBarriers-1.png differ diff --git a/public/images/api/qiskit/qiskit-transpiler-passes-StarPreRouting-1.png b/public/images/api/qiskit/qiskit-transpiler-passes-StarPreRouting-1.png index d8e9f9dd5a4..fddbc094828 100644 Binary files a/public/images/api/qiskit/qiskit-transpiler-passes-StarPreRouting-1.png and b/public/images/api/qiskit/qiskit-transpiler-passes-StarPreRouting-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-circuit_drawer-1.png b/public/images/api/qiskit/qiskit-visualization-circuit_drawer-1.png index 978283163d2..a863d358c2a 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-circuit_drawer-1.png and b/public/images/api/qiskit/qiskit-visualization-circuit_drawer-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-1.png b/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-1.png index 2d163cc3044..676482215f2 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-2.png b/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-2.png index 09ffc095ee4..a64a5b9b0a5 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-2.png and b/public/images/api/qiskit/qiskit-visualization-plot_bloch_multivector-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-1.png b/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-1.png index ccd169acc85..5e037cd54e4 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-2.png b/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-2.png index db23788523a..e85102553e7 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-2.png and b/public/images/api/qiskit/qiskit-visualization-plot_bloch_vector-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.png b/public/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.png index 8b00bed94c2..7b09d04e8bd 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_circuit_layout-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_coupling_map-1.png b/public/images/api/qiskit/qiskit-visualization-plot_coupling_map-1.png index 77c6913b5ec..d1833d6efb9 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_coupling_map-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_coupling_map-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_00.png b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_00.png index 7b403d0ef34..df9a64e71c9 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_00.png and b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_01.png b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_01.png index 4949e663e46..ba0c9d4b89c 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_01.png and b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_02.png b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_02.png index f747e13c043..c273c9b405a 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_02.png and b/public/images/api/qiskit/qiskit-visualization-plot_distribution-1_02.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_error_map-1.png b/public/images/api/qiskit/qiskit-visualization-plot_error_map-1.png index 1a937e88107..ffb11d7d1bc 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_error_map-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_error_map-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_gate_map-1.png b/public/images/api/qiskit/qiskit-visualization-plot_gate_map-1.png index eb4d98dcae0..d1d5a4f9d8d 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_gate_map-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_gate_map-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_00.png b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_00.png index 47caedbd60e..2b574560fa0 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_00.png and b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_00.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_01.png b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_01.png index 6787217d477..0f6452d5902 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_01.png and b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_01.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_02.png b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_02.png index ab3a950e38e..d0042284a8b 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_02.png and b/public/images/api/qiskit/qiskit-visualization-plot_histogram-1_02.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_city-1.png b/public/images/api/qiskit/qiskit-visualization-plot_state_city-1.png index 7d42a800dd8..e5c59ed05c1 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_city-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_city-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_city-2.png b/public/images/api/qiskit/qiskit-visualization-plot_state_city-2.png index 7b8b54d5d8b..e118106a1b4 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_city-2.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_city-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_hinton-1.png b/public/images/api/qiskit/qiskit-visualization-plot_state_hinton-1.png index f04f6154da3..7c852c83c53 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_hinton-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_hinton-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-1.png b/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-1.png index b90cdd3e785..af55d436977 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-2.png b/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-2.png index 4212d560592..095c51a380a 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-2.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_paulivec-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-1.png b/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-1.png index 1ce3de8351b..bb940719fa4 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-1.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-2.png b/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-2.png index e48ee2929f0..702f4c05b58 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-2.png and b/public/images/api/qiskit/qiskit-visualization-plot_state_qsphere-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-1.png b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-1.png index c325125743c..06e4d80cb47 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-1.png and b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-2.png b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-2.png index 3139fa6735d..2ecee5958dd 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-2.png and b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-3.png b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-3.png index ad96e56f6ed..675fdd2b660 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-timeline_drawer-3.png and b/public/images/api/qiskit/qiskit-visualization-timeline_drawer-3.png differ diff --git a/public/images/api/qiskit/release_notes-1.png b/public/images/api/qiskit/release_notes-1.png index 0fcb5d4fa44..a8920199fa4 100644 Binary files a/public/images/api/qiskit/release_notes-1.png and b/public/images/api/qiskit/release_notes-1.png differ diff --git a/public/images/api/qiskit/release_notes-2.png b/public/images/api/qiskit/release_notes-2.png index c04464ccdf1..960b65d85f3 100644 Binary files a/public/images/api/qiskit/release_notes-2.png and b/public/images/api/qiskit/release_notes-2.png differ diff --git a/public/images/api/qiskit/release_notes-3.png b/public/images/api/qiskit/release_notes-3.png index 9dcd1b85dca..9b2119d8c98 100644 Binary files a/public/images/api/qiskit/release_notes-3.png and b/public/images/api/qiskit/release_notes-3.png differ diff --git a/public/images/api/qiskit/release_notes-4.png b/public/images/api/qiskit/release_notes-4.png index e70a74975ac..61511242784 100644 Binary files a/public/images/api/qiskit/release_notes-4.png and b/public/images/api/qiskit/release_notes-4.png differ diff --git a/public/images/api/qiskit/release_notes-5.png b/public/images/api/qiskit/release_notes-5.png index b6b1b00b421..06ac59d6d82 100644 Binary files a/public/images/api/qiskit/release_notes-5.png and b/public/images/api/qiskit/release_notes-5.png differ diff --git a/public/images/api/qiskit/release_notes-6.png b/public/images/api/qiskit/release_notes-6.png index 40b05acd531..2ed1d24baeb 100644 Binary files a/public/images/api/qiskit/release_notes-6.png and b/public/images/api/qiskit/release_notes-6.png differ diff --git a/public/images/api/qiskit/release_notes-7.png b/public/images/api/qiskit/release_notes-7.png index ddf2ec46f72..eb0c2091178 100644 Binary files a/public/images/api/qiskit/release_notes-7.png and b/public/images/api/qiskit/release_notes-7.png differ diff --git a/public/images/api/qiskit/release_notes-8.png b/public/images/api/qiskit/release_notes-8.png index 538867ce5e9..43bb0a51185 100644 Binary files a/public/images/api/qiskit/release_notes-8.png and b/public/images/api/qiskit/release_notes-8.png differ diff --git a/public/images/api/qiskit/synthesis-1.png b/public/images/api/qiskit/synthesis-1.png index 0ebc56ae42b..8039d5b8e8a 100644 Binary files a/public/images/api/qiskit/synthesis-1.png and b/public/images/api/qiskit/synthesis-1.png differ diff --git a/public/images/api/qiskit/synthesis-2.png b/public/images/api/qiskit/synthesis-2.png index 8be7aeff02b..95997efac61 100644 Binary files a/public/images/api/qiskit/synthesis-2.png and b/public/images/api/qiskit/synthesis-2.png differ diff --git a/public/images/api/qiskit/transpiler-10.png b/public/images/api/qiskit/transpiler-10.png index 2cc073a1264..255fae400c8 100644 Binary files a/public/images/api/qiskit/transpiler-10.png and b/public/images/api/qiskit/transpiler-10.png differ diff --git a/public/images/api/qiskit/transpiler-11.png b/public/images/api/qiskit/transpiler-11.png index 0185ad21c3c..689fd9100df 100644 Binary files a/public/images/api/qiskit/transpiler-11.png and b/public/images/api/qiskit/transpiler-11.png differ diff --git a/public/images/api/qiskit/transpiler-12.png b/public/images/api/qiskit/transpiler-12.png index 34938fa4e14..ba8690475e4 100644 Binary files a/public/images/api/qiskit/transpiler-12.png and b/public/images/api/qiskit/transpiler-12.png differ diff --git a/public/images/api/qiskit/transpiler-13.png b/public/images/api/qiskit/transpiler-13.png index 0185ad21c3c..689fd9100df 100644 Binary files a/public/images/api/qiskit/transpiler-13.png and b/public/images/api/qiskit/transpiler-13.png differ diff --git a/public/images/api/qiskit/transpiler-14.png b/public/images/api/qiskit/transpiler-14.png index 689925333cd..48e04e7d2cd 100644 Binary files a/public/images/api/qiskit/transpiler-14.png and b/public/images/api/qiskit/transpiler-14.png differ diff --git a/public/images/api/qiskit/transpiler-15.png b/public/images/api/qiskit/transpiler-15.png index c048df2f654..2cca0b5fd7a 100644 Binary files a/public/images/api/qiskit/transpiler-15.png and b/public/images/api/qiskit/transpiler-15.png differ diff --git a/public/images/api/qiskit/transpiler-16.png b/public/images/api/qiskit/transpiler-16.png index d7ca88fd3b1..4ede03b7c1f 100644 Binary files a/public/images/api/qiskit/transpiler-16.png and b/public/images/api/qiskit/transpiler-16.png differ diff --git a/public/images/api/qiskit/transpiler-17.png b/public/images/api/qiskit/transpiler-17.png index 1c00f60aed3..397280fa23a 100644 Binary files a/public/images/api/qiskit/transpiler-17.png and b/public/images/api/qiskit/transpiler-17.png differ diff --git a/public/images/api/qiskit/transpiler-4.png b/public/images/api/qiskit/transpiler-4.png index 6651b2277a8..a2d768506e1 100644 Binary files a/public/images/api/qiskit/transpiler-4.png and b/public/images/api/qiskit/transpiler-4.png differ diff --git a/public/images/api/qiskit/transpiler-5.png b/public/images/api/qiskit/transpiler-5.png index 27205cf7dd3..e47473bfa97 100644 Binary files a/public/images/api/qiskit/transpiler-5.png and b/public/images/api/qiskit/transpiler-5.png differ diff --git a/public/images/api/qiskit/transpiler-6.png b/public/images/api/qiskit/transpiler-6.png index 36a478ff8a7..8a97a4f2087 100644 Binary files a/public/images/api/qiskit/transpiler-6.png and b/public/images/api/qiskit/transpiler-6.png differ diff --git a/public/images/api/qiskit/transpiler-7.png b/public/images/api/qiskit/transpiler-7.png index 5279e791f90..66359f5df45 100644 Binary files a/public/images/api/qiskit/transpiler-7.png and b/public/images/api/qiskit/transpiler-7.png differ diff --git a/public/images/api/qiskit/transpiler-8.png b/public/images/api/qiskit/transpiler-8.png index 899c1c177c1..14e475f8934 100644 Binary files a/public/images/api/qiskit/transpiler-8.png and b/public/images/api/qiskit/transpiler-8.png differ diff --git a/public/images/api/qiskit/transpiler-9.png b/public/images/api/qiskit/transpiler-9.png index 8ba5f9228f8..f62e7de52de 100644 Binary files a/public/images/api/qiskit/transpiler-9.png and b/public/images/api/qiskit/transpiler-9.png differ diff --git a/public/images/api/qiskit/visualization-1.png b/public/images/api/qiskit/visualization-1.png index b4b729b18c5..cb7042851c6 100644 Binary files a/public/images/api/qiskit/visualization-1.png and b/public/images/api/qiskit/visualization-1.png differ diff --git a/public/images/api/qiskit/visualization-2.png b/public/images/api/qiskit/visualization-2.png index 130f364ef33..bfc8c615e07 100644 Binary files a/public/images/api/qiskit/visualization-2.png and b/public/images/api/qiskit/visualization-2.png differ diff --git a/public/images/api/qiskit/visualization-3.png b/public/images/api/qiskit/visualization-3.png index 93b1a2bcf9a..d4d993f990a 100644 Binary files a/public/images/api/qiskit/visualization-3.png and b/public/images/api/qiskit/visualization-3.png differ diff --git a/public/images/api/qiskit/visualization-4.png b/public/images/api/qiskit/visualization-4.png index b1d76f6bc09..06461a30898 100644 Binary files a/public/images/api/qiskit/visualization-4.png and b/public/images/api/qiskit/visualization-4.png differ diff --git a/public/images/api/qiskit/visualization-5.png b/public/images/api/qiskit/visualization-5.png index e6cfa85ff5c..e364d31f43b 100644 Binary files a/public/images/api/qiskit/visualization-5.png and b/public/images/api/qiskit/visualization-5.png differ diff --git a/public/images/api/qiskit/visualization-6.png b/public/images/api/qiskit/visualization-6.png index e6cfa85ff5c..e364d31f43b 100644 Binary files a/public/images/api/qiskit/visualization-6.png and b/public/images/api/qiskit/visualization-6.png differ