diff --git a/docs/api/qiskit/_package.json b/docs/api/qiskit/_package.json index ca04801d7f..255c7ce4b2 100644 --- a/docs/api/qiskit/_package.json +++ b/docs/api/qiskit/_package.json @@ -1,4 +1,4 @@ { "name": "qiskit", - "version": "0.45.1" + "version": "0.45.0" } diff --git a/docs/api/qiskit/algorithms.md b/docs/api/qiskit/algorithms.md index b2f12fb7cf..8248a9544b 100644 --- a/docs/api/qiskit/algorithms.md +++ b/docs/api/qiskit/algorithms.md @@ -195,7 +195,7 @@ Algorithms that compute the fidelity of pairs of quantum states. -`qiskit.algorithms.AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/exceptions.py "view source code") +`qiskit.algorithms.AlgorithmError(*message)` For Algorithm specific errors. @@ -207,7 +207,7 @@ Utility classes used by algorithms (mainly for type-hinting purposes). | | | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`AlgorithmJob`](qiskit.algorithms.AlgorithmJob "qiskit.algorithms.AlgorithmJob")(function, \*args, \*\*kwargs) | This empty class is introduced for typing purposes. | +| [`AlgorithmJob`](qiskit.algorithms.AlgorithmJob "qiskit.algorithms.AlgorithmJob")(function, \*args, \*\*kwargs) | This empty class is introduced for typing purposes. | ### Utility functions @@ -215,7 +215,7 @@ Utility functions used by algorithms. -`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/aux_ops_evaluator.py "view source code") +`qiskit.algorithms.eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` Deprecated: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. @@ -247,7 +247,7 @@ ListOrDict\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in P -`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/observables_evaluator.py "view source code") +`qiskit.algorithms.estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)` Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/assembler.md b/docs/api/qiskit/assembler.md index 8f177df26c..52b86a718a 100644 --- a/docs/api/qiskit/assembler.md +++ b/docs/api/qiskit/assembler.md @@ -22,7 +22,7 @@ python_api_name: qiskit.assembler -`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/assemble_circuits.py "view source code") +`qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)` Assembles a list of circuits into a qobj that can be run on the backend. @@ -65,7 +65,7 @@ qobj = assemble_circuits(circuits=[qc], -`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/assemble_schedules.py "view source code") +`qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)` Assembles a list of schedules into a qobj that can be run on the backend. @@ -129,7 +129,7 @@ pulseQobj = assemble_schedules(schedules=[schedule], -`qiskit.assembler.disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/disassemble.py "view source code") +`qiskit.assembler.disassemble(qobj)` Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. @@ -176,5 +176,5 @@ circuits, run_config_out, headers = disassemble(qobj) | | | | -------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`RunConfig`](qiskit.assembler.RunConfig "qiskit.assembler.RunConfig")(\[shots, seed\_simulator, memory, ...]) | Class for Run Configuration. | +| [`RunConfig`](qiskit.assembler.RunConfig "qiskit.assembler.RunConfig")(\[shots, seed\_simulator, memory, ...]) | Class for Run Configuration. | diff --git a/docs/api/qiskit/circuit.md b/docs/api/qiskit/circuit.md index e2f0cf6280..13ca74d7ca 100644 --- a/docs/api/qiskit/circuit.md +++ b/docs/api/qiskit/circuit.md @@ -201,40 +201,40 @@ qc.depth() | | | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")(\*regs\[, name, global\_phase, ...]) | Create a new circuit. | -| [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")(\[size, name, bits]) | Implement a quantum register. | -| [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.Qubit")(\[register, index]) | Implement a quantum bit. | -| [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")(\[size, name, bits]) | Implement a classical register. | -| [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit")(\[register, index]) | Implement a classical bit. | -| [`AncillaRegister`](qiskit.circuit.AncillaRegister "qiskit.circuit.AncillaRegister")(\[size, name, bits]) | Implement an ancilla register. | -| [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.circuit.AncillaQubit")(\[register, index]) | A qubit used as ancillary qubit. | -| [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")(operation\[, qubits, clbits]) | A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the `operation` and various operands. | -| [`Register`](qiskit.circuit.Register "qiskit.circuit.Register")(\[size, name, bits]) | Implement a generic register. | -| [`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit")(\[register, index]) | Implement a generic bit. | +| [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")(\*regs\[, name, global\_phase, ...]) | Create a new circuit. | +| [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")(\[size, name, bits]) | Implement a quantum register. | +| [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.Qubit")(\[register, index]) | Implement a quantum bit. | +| [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")(\[size, name, bits]) | Implement a classical register. | +| [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit")(\[register, index]) | Implement a classical bit. | +| [`AncillaRegister`](qiskit.circuit.AncillaRegister "qiskit.circuit.AncillaRegister")(\[size, name, bits]) | Implement an ancilla register. | +| [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.circuit.AncillaQubit")(\[register, index]) | A qubit used as ancillary qubit. | +| [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")(operation\[, qubits, clbits]) | A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the `operation` and various operands. | +| [`Register`](qiskit.circuit.Register "qiskit.circuit.Register")(\[size, name, bits]) | Implement a generic register. | +| [`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit")(\[register, index]) | Implement a generic bit. | ### Gates and Instructions | | | | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate")(name, num\_qubits, params\[, label, ...]) | Unitary gate. | -| [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate")(name, num\_qubits, params\[, ...]) | Controlled unitary gate. | -| [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay")(duration\[, unit]) | Do nothing and just delay/wait/idle for a specified duration. | -| [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction")(name, num\_qubits, num\_clbits, params) | Generic quantum instruction. | -| [`InstructionSet`](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")(\*\[, resource\_requester]) | Instruction collection, and their contexts. | +| [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate")(name, num\_qubits, params\[, label, ...]) | Unitary gate. | +| [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate")(name, num\_qubits, params\[, ...]) | Controlled unitary gate. | +| [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay")(duration\[, unit]) | Do nothing and just delay/wait/idle for a specified duration. | +| [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction")(name, num\_qubits, num\_clbits, params) | Generic quantum instruction. | +| [`InstructionSet`](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")(\*\[, resource\_requester]) | Instruction collection, and their contexts. | | [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation")() | Quantum Operation Interface Class. | -| [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")(\*\[, base]) | A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. | +| [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")(\*\[, base]) | A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. | ### Control Flow Operations | | | | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp")(name, num\_qubits, num\_clbits, ...) | Abstract class to encapsulate all control flow operations. | -| [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp")(condition, true\_body\[, false\_body, ...]) | A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. | -| [`WhileLoopOp`](qiskit.circuit.WhileLoopOp "qiskit.circuit.WhileLoopOp")(condition, body\[, label]) | A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. | -| [`ForLoopOp`](qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp")(indexset, loop\_parameter, body\[, ...]) | A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. | -| [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp")(target, cases, \*\[, label]) | A circuit operation that executes one particular circuit block based on matching a given `target` against an ordered list of `values`. | -| [`BreakLoopOp`](qiskit.circuit.BreakLoopOp "qiskit.circuit.BreakLoopOp")(num\_qubits, num\_clbits\[, label]) | A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. | -| [`ContinueLoopOp`](qiskit.circuit.ContinueLoopOp "qiskit.circuit.ContinueLoopOp")(num\_qubits, num\_clbits\[, label]) | A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. | +| [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.ControlFlowOp")(name, num\_qubits, num\_clbits, ...) | Abstract class to encapsulate all control flow operations. | +| [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp")(condition, true\_body\[, false\_body, ...]) | A circuit operation which executes a program (`true_body`) if a provided condition (`condition`) evaluates to true, and optionally evaluates another program (`false_body`) otherwise. | +| [`WhileLoopOp`](qiskit.circuit.WhileLoopOp "qiskit.circuit.WhileLoopOp")(condition, body\[, label]) | A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False. | +| [`ForLoopOp`](qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp")(indexset, loop\_parameter, body\[, ...]) | A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`. | +| [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp")(target, cases, \*\[, label]) | A circuit operation that executes one particular circuit block based on matching a given `target` against an ordered list of `values`. | +| [`BreakLoopOp`](qiskit.circuit.BreakLoopOp "qiskit.circuit.BreakLoopOp")(num\_qubits, num\_clbits\[, label]) | A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. | +| [`ContinueLoopOp`](qiskit.circuit.ContinueLoopOp "qiskit.circuit.ContinueLoopOp")(num\_qubits, num\_clbits\[, label]) | A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. | The [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") also understands a special value: @@ -278,15 +278,15 @@ with qc.switch(cr) as case: | | | | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")(name, \*\[, uuid]) | Parameter Class for variable parameters. | -| [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector")(name\[, length]) | ParameterVector class to quickly generate lists of parameters. | -| [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")(symbol\_map, expr) | ParameterExpression class to enable creating expressions of Parameters. | +| [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")(name, \*\[, uuid]) | Parameter Class for variable parameters. | +| [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector")(name\[, length]) | ParameterVector class to quickly generate lists of parameters. | +| [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")(symbol\_map, expr) | ParameterExpression class to enable creating expressions of Parameters. | ### Random Circuits -`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/random/utils.py "view source code") +`qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)` Generate random circuit of arbitrary size and form. @@ -333,8 +333,8 @@ constructed circuit | | | | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation")(base\_op, modifiers) | Annotated operation. | -| [`ControlModifier`](qiskit.circuit.ControlModifier "qiskit.circuit.ControlModifier")(\[num\_ctrl\_qubits, ctrl\_state]) | Control modifier: specifies that the operation is controlled by `num_ctrl_qubits` and has control state `ctrl_state`. | +| [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation")(base\_op, modifiers) | Annotated operation. | +| [`ControlModifier`](qiskit.circuit.ControlModifier "qiskit.circuit.ControlModifier")(\[num\_ctrl\_qubits, ctrl\_state]) | Control modifier: specifies that the operation is controlled by `num_ctrl_qubits` and has control state `ctrl_state`. | | [`PowerModifier`](qiskit.circuit.PowerModifier "qiskit.circuit.PowerModifier")(power) | Power modifier: specifies that the operation is raised to the power `power`. | | [`InverseModifier`](qiskit.circuit.InverseModifier "qiskit.circuit.InverseModifier")() | Inverse modifier: specifies that the operation is inverted. | @@ -344,7 +344,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c -`qiskit.circuit.CircuitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/exceptions.py "view source code") +`qiskit.circuit.CircuitError(*message)` Base class for errors raised while processing a circuit. diff --git a/docs/api/qiskit/circuit_classical.md b/docs/api/qiskit/circuit_classical.md index 68887d628f..156e548fa7 100644 --- a/docs/api/qiskit/circuit_classical.md +++ b/docs/api/qiskit/circuit_classical.md @@ -50,7 +50,7 @@ The expression system is based on tree representation. All nodes in the tree are -`qiskit.circuit.classical.expr.Expr`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`qiskit.circuit.classical.expr.Expr` Root base class of all nodes in the expression tree. The base case should never be instantiated directly. @@ -64,7 +64,7 @@ The entry point from general circuit objects to the expression system is by wrap -`final class qiskit.circuit.classical.expr.Var(var, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Var(var, type)` A classical variable. @@ -72,7 +72,7 @@ Similarly, literals used in comparison (such as integers) should be lifted to [` -`final class qiskit.circuit.classical.expr.Value(value, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Value(value, type)` A single scalar value. @@ -80,7 +80,7 @@ The operations traditionally associated with pre-, post- or infix operators in p -`final class qiskit.circuit.classical.expr.Unary(op, operand, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Unary(op, operand, type)` A unary expression. @@ -118,7 +118,7 @@ Logical negation. `!operand`. -`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Binary(op, left, right, type)` A binary expression. @@ -235,7 +235,7 @@ Expressions in this system are defined to act only on certain sets of types. How -`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/expr.py "view source code") +`final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)` A cast from one type to another, implied by the use of an expression in a different context. @@ -249,7 +249,7 @@ The functions and methods described in this section are a more user-friendly way -`qiskit.circuit.classical.expr.lift(value, /, type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift(value, /, type=None)` Lift the given Python `value` to a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.expr.Value") or [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var"). @@ -287,7 +287,7 @@ You can manually specify casts in cases where the cast is allowed in explicit fo -`qiskit.circuit.classical.expr.cast(operand, type, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.cast(operand, type, /)` Create an explicit cast from the given value to the given type. @@ -310,7 +310,7 @@ There are helper constructor functions for each of the unary operations. -`qiskit.circuit.classical.expr.bit_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_not(operand, /)` Create a bitwise ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -331,7 +331,7 @@ Unary(Unary.Op.BIT_NOT, Var(ClassicalRegister(3, 'c'), Uint(3)), Uint(3)) -`qiskit.circuit.classical.expr.logic_not(operand, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_not(operand, /)` Create a logical ‘not’ expression node from the given value, resolving any implicit casts and lifting the value into a [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") node if required. @@ -354,7 +354,7 @@ Similarly, the binary operations and relations have helper functions defined. -`qiskit.circuit.classical.expr.bit_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_and(left, right, /)` Create a bitwise ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -375,7 +375,7 @@ Binary(Binary.Op.BIT_AND, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(7, Uint -`qiskit.circuit.classical.expr.bit_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_or(left, right, /)` Create a bitwise ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -396,7 +396,7 @@ Binary(Binary.Op.BIT_OR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint( -`qiskit.circuit.classical.expr.bit_xor(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.bit_xor(left, right, /)` Create a bitwise ‘exclusive or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -417,7 +417,7 @@ Binary(Binary.Op.BIT_XOR, Var(ClassicalRegister(3, 'c'), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.logic_and(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_and(left, right, /)` Create a logical ‘and’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -438,7 +438,7 @@ Binary(Binary.Op.LOGIC_AND, Var(, Bool()), Var(, Bool()), Bool -`qiskit.circuit.classical.expr.logic_or(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.logic_or(left, right, /)` Create a logical ‘or’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -459,7 +459,7 @@ Binary(Binary.Op.LOGIC_OR, Var(, Bool()), Var(, Bool()), Bool( -`qiskit.circuit.classical.expr.equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.equal(left, right, /)` Create an ‘equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -480,7 +480,7 @@ Binary(Binary.Op.EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Uint(3 -`qiskit.circuit.classical.expr.not_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.not_equal(left, right, /)` Create a ‘not equal’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -501,7 +501,7 @@ Binary(Binary.Op.NOT_EQUAL, Var(ClassicalRegister(3, "c"), Uint(3)), Value(7, Ui -`qiskit.circuit.classical.expr.less(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less(left, right, /)` Create a ‘less than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -522,7 +522,7 @@ Binary(Binary.Op.LESS, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint(3) -`qiskit.circuit.classical.expr.less_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.less_equal(left, right, /)` Create a ‘less than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -543,7 +543,7 @@ Binary(Binary.Op.LESS_EQUAL, Var(ClassicalRegister(3, "a"), Uint(3)), Var(Classi -`qiskit.circuit.classical.expr.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater(left, right, /)` Create a ‘greater than’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -564,7 +564,7 @@ Binary(Binary.Op.GREATER, Var(ClassicalRegister(3, "c"), Uint(3)), Value(5, Uint -`qiskit.circuit.classical.expr.greater_equal(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.greater_equal(left, right, /)` Create a ‘greater than or equal to’ expression node from the given value, resolving any implicit casts and lifting the values into [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes if required. @@ -587,7 +587,7 @@ Qiskit’s legacy method for specifying equality conditions for use in condition -`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/constructors.py "view source code") +`qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)` Lift a legacy two-tuple equality condition into a new-style [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr"). @@ -616,7 +616,7 @@ A typical consumer of the expression tree wants to recursively walk through the -`qiskit.circuit.classical.expr.ExprVisitor`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.ExprVisitor` Base class for visitors to the [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") tree. Subclasses should override whichever of the `visit_*` methods that they are able to handle, and should be organised such that non-existent methods will never be called. @@ -686,7 +686,7 @@ For the convenience of simple visitors that only need to inspect the variables i -`qiskit.circuit.classical.expr.iter_vars(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.iter_vars(node)` Get an iterator over the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") nodes referenced at any level in the given [`Expr`](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.expr.Expr"). @@ -714,7 +714,7 @@ Two expressions can be compared for direct structural equality by using the buil -`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/expr/visitors.py "view source code") +`qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)` Do these two expressions have exactly the same tree structure, up to some key function for the [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.expr.Var") objects? @@ -773,7 +773,7 @@ All types inherit from an abstract base class: -`qiskit.circuit.classical.types.Type`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/types.py "view source code") +`qiskit.circuit.classical.types.Type` Root base class of all nodes in the type tree. The base case should never be instantiated directly. @@ -785,13 +785,13 @@ The two different types available are for Booleans (corresponding to [`Clbit`](q -`final class qiskit.circuit.classical.types.Bool`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Bool` The Boolean type. This has exactly two values: `True` and `False`. -`final class qiskit.circuit.classical.types.Uint(width)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/types.py "view source code") +`final class qiskit.circuit.classical.types.Uint(width)` An unsigned integer of fixed bit width. @@ -805,7 +805,7 @@ The low-level interface to querying the subtyping relationship is the [`order()` -`qiskit.circuit.classical.types.order(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.order(left, right, /)` Get the ordering relationship between the two types as an enumeration value. @@ -834,7 +834,7 @@ The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types. -`qiskit.circuit.classical.types.Ordering(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.Ordering(value)` 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. @@ -844,7 +844,7 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis -`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)` Does the relation $\text{left} \le \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -873,7 +873,7 @@ False -`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)` Does the relation $\text{left} \ge \text{right}$ hold? If there is no ordering relation between the two types, then this returns `False`. If `strict`, then the equality is also forbidden. @@ -902,7 +902,7 @@ False -`qiskit.circuit.classical.types.greater(left, right, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classical/types/ordering.py "view source code") +`qiskit.circuit.classical.types.greater(left, right, /)` Get the greater of the two types, assuming that there is an ordering relation between them. Technically, this is a slightly restricted version of the concept of the ‘meet’ of the two types in that the return value must be one of the inputs. In practice in the type system there is no concept of a ‘sum’ type, so the ‘meet’ exists if and only if there is an ordering between the two types, and is equal to the greater of the two types. diff --git a/docs/api/qiskit/circuit_library.md b/docs/api/qiskit/circuit_library.md index cb14ecadb4..aecffa0f20 100644 --- a/docs/api/qiskit/circuit_library.md +++ b/docs/api/qiskit/circuit_library.md @@ -63,60 +63,60 @@ print(gate.control(1).to_matrix()) # CX (controlled X) gate | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [`C3XGate`](qiskit.circuit.library.C3XGate "qiskit.circuit.library.C3XGate")(\*args\[, \_force\_mutable]) | The X gate controlled on 3 qubits. | -| [`C3SXGate`](qiskit.circuit.library.C3SXGate "qiskit.circuit.library.C3SXGate")(\*args\[, \_force\_mutable]) | The 3-qubit controlled sqrt-X gate. | -| [`C4XGate`](qiskit.circuit.library.C4XGate "qiskit.circuit.library.C4XGate")(\*args\[, \_force\_mutable]) | The 4-qubit controlled X gate. | -| [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate")(\*args\[, \_force\_mutable]) | CCX gate, also known as Toffoli gate. | -| [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate")(\*args\[, \_force\_mutable]) | Double-CNOT gate. | -| [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate")(\*args\[, \_force\_mutable]) | Controlled-Hadamard gate. | -| [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate")(theta\[, label, ctrl\_state, ...]) | Controlled-Phase gate. | -| [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate")(theta\[, label, ctrl\_state, ...]) | Controlled-RX gate. | -| [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate")(theta\[, label, ctrl\_state, ...]) | Controlled-RY gate. | -| [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate")(theta\[, label, ctrl\_state, ...]) | Controlled-RZ gate. | -| [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate")(\*args\[, \_force\_mutable]) | Controlled-S gate. | -| [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate")(\*args\[, \_force\_mutable]) | Controlled-S^dagger gate. | -| [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate")(\*args\[, \_force\_mutable]) | Controlled-SWAP gate, also known as the Fredkin gate. | -| [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate")(\*args\[, \_force\_mutable]) | Controlled-√X gate. | -| [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate")(theta, phi, lam, gamma\[, label, ...]) | Controlled-U gate (4-parameter two-qubit gate). | -| [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate")(theta\[, label, ctrl\_state, ...]) | Controlled-U1 gate. | -| [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate")(theta, phi, lam\[, label, ...]) | Controlled-U3 gate (3-parameter two-qubit gate). | -| [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate")(\*args\[, \_force\_mutable]) | Controlled-X gate. | -| [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate")(\*args\[, \_force\_mutable]) | Controlled-Y gate. | -| [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate")(\*args\[, \_force\_mutable]) | Controlled-Z gate. | -| [`CCZGate`](qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate")(\*args\[, \_force\_mutable]) | CCZ gate. | -| [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate")(\*args\[, \_force\_mutable]) | An echoed cross-resonance gate. | -| [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate")(\*args\[, \_force\_mutable]) | Single-qubit Hadamard gate. | -| [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate")(\*args\[, \_force\_mutable]) | Identity gate. | -| [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate")(num\_qubits, theta\[, label]) | MSGate has been deprecated. | -| [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate")(theta\[, label, duration, unit]) | Single-qubit rotation about the Z axis. | -| [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate")(\*args\[, \_force\_mutable]) | The simplified Toffoli gate, also referred to as Margolus gate. | -| [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate")(\*args\[, \_force\_mutable]) | The simplified 3-controlled Toffoli gate. | -| [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate")(theta, phi\[, label, duration, unit]) | Rotation θ around the cos(φ)x + sin(φ)y axis. | -| [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate")(theta\[, label, duration, unit]) | Single-qubit rotation about the X axis. | -| [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate")(theta\[, label, duration, unit]) | A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). | -| [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate")(theta\[, label, duration, unit]) | Single-qubit rotation about the Y axis. | -| [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate")(theta\[, label, duration, unit]) | A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). | -| [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate")(phi\[, label, duration, unit]) | Single-qubit rotation about the Z axis. | -| [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate")(theta\[, label, duration, unit]) | A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). | -| [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate")(theta\[, label, duration, unit]) | A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). | -| [`XXMinusYYGate`](qiskit.circuit.library.XXMinusYYGate "qiskit.circuit.library.XXMinusYYGate")(theta\[, beta, label, ...]) | XX-YY interaction gate. | -| [`XXPlusYYGate`](qiskit.circuit.library.XXPlusYYGate "qiskit.circuit.library.XXPlusYYGate")(theta\[, beta, label, duration, ...]) | XX+YY interaction gate. | -| [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate")(\*args\[, \_force\_mutable]) | Single qubit S gate (Z\*\*0.5). | -| [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate")(\*args\[, \_force\_mutable]) | Single qubit S-adjoint gate (\~Z\*\*0.5). | -| [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")(\*args\[, \_force\_mutable]) | The SWAP gate. | -| [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate")(\*args\[, \_force\_mutable]) | iSWAP gate. | -| [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate")(\*args\[, \_force\_mutable]) | The single-qubit Sqrt(X) gate ($\sqrt{X}$). | -| [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate")(\*args\[, \_force\_mutable]) | The inverse single-qubit Sqrt(X) gate. | -| [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate")(\*args\[, \_force\_mutable]) | Single qubit T gate (Z\*\*0.25). | -| [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate")(\*args\[, \_force\_mutable]) | Single qubit T-adjoint gate (\~Z\*\*0.25). | -| [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate")(theta, phi, lam\[, label, duration, unit]) | Generic single-qubit rotation gate with 3 Euler angles. | -| [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate")(theta\[, label, duration, unit]) | Single-qubit rotation about the Z axis. | -| [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate")(phi, lam\[, label, duration, unit]) | Single-qubit rotation about the X+Z axis. | -| [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate")(theta, phi, lam\[, label, duration, unit]) | Generic single-qubit rotation gate with 3 Euler angles. | -| [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate")(\*args\[, \_force\_mutable]) | The single-qubit Pauli-X gate ($\sigma_x$). | -| [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate")(\*args\[, \_force\_mutable]) | The single-qubit Pauli-Y gate ($\sigma_y$). | -| [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate")(\*args\[, \_force\_mutable]) | The single-qubit Pauli-Z gate ($\sigma_z$). | -| [`GlobalPhaseGate`](qiskit.circuit.library.GlobalPhaseGate "qiskit.circuit.library.GlobalPhaseGate")(phase\[, label, duration, unit]) | The global phase gate ($e^{i\theta}$). | +| [`C3XGate`](qiskit.circuit.library.C3XGate "qiskit.circuit.library.C3XGate")(\*args\[, \_force\_mutable]) | The X gate controlled on 3 qubits. | +| [`C3SXGate`](qiskit.circuit.library.C3SXGate "qiskit.circuit.library.C3SXGate")(\*args\[, \_force\_mutable]) | The 3-qubit controlled sqrt-X gate. | +| [`C4XGate`](qiskit.circuit.library.C4XGate "qiskit.circuit.library.C4XGate")(\*args\[, \_force\_mutable]) | The 4-qubit controlled X gate. | +| [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate")(\*args\[, \_force\_mutable]) | CCX gate, also known as Toffoli gate. | +| [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate")(\*args\[, \_force\_mutable]) | Double-CNOT gate. | +| [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate")(\*args\[, \_force\_mutable]) | Controlled-Hadamard gate. | +| [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate")(theta\[, label, ctrl\_state, ...]) | Controlled-Phase gate. | +| [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate")(theta\[, label, ctrl\_state, ...]) | Controlled-RX gate. | +| [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate")(theta\[, label, ctrl\_state, ...]) | Controlled-RY gate. | +| [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate")(theta\[, label, ctrl\_state, ...]) | Controlled-RZ gate. | +| [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate")(\*args\[, \_force\_mutable]) | Controlled-S gate. | +| [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate")(\*args\[, \_force\_mutable]) | Controlled-S^dagger gate. | +| [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate")(\*args\[, \_force\_mutable]) | Controlled-SWAP gate, also known as the Fredkin gate. | +| [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate")(\*args\[, \_force\_mutable]) | Controlled-√X gate. | +| [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate")(theta, phi, lam, gamma\[, label, ...]) | Controlled-U gate (4-parameter two-qubit gate). | +| [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate")(theta\[, label, ctrl\_state, ...]) | Controlled-U1 gate. | +| [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate")(theta, phi, lam\[, label, ...]) | Controlled-U3 gate (3-parameter two-qubit gate). | +| [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate")(\*args\[, \_force\_mutable]) | Controlled-X gate. | +| [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate")(\*args\[, \_force\_mutable]) | Controlled-Y gate. | +| [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate")(\*args\[, \_force\_mutable]) | Controlled-Z gate. | +| [`CCZGate`](qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate")(\*args\[, \_force\_mutable]) | CCZ gate. | +| [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate")(\*args\[, \_force\_mutable]) | An echoed cross-resonance gate. | +| [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate")(\*args\[, \_force\_mutable]) | Single-qubit Hadamard gate. | +| [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate")(\*args\[, \_force\_mutable]) | Identity gate. | +| [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate")(num\_qubits, theta\[, label]) | MSGate has been deprecated. | +| [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate")(theta\[, label, duration, unit]) | Single-qubit rotation about the Z axis. | +| [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate")(\*args\[, \_force\_mutable]) | The simplified Toffoli gate, also referred to as Margolus gate. | +| [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate")(\*args\[, \_force\_mutable]) | The simplified 3-controlled Toffoli gate. | +| [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate")(theta, phi\[, label, duration, unit]) | Rotation θ around the cos(φ)x + sin(φ)y axis. | +| [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate")(theta\[, label, duration, unit]) | Single-qubit rotation about the X axis. | +| [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate")(theta\[, label, duration, unit]) | A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). | +| [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate")(theta\[, label, duration, unit]) | Single-qubit rotation about the Y axis. | +| [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate")(theta\[, label, duration, unit]) | A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). | +| [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate")(phi\[, label, duration, unit]) | Single-qubit rotation about the Z axis. | +| [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate")(theta\[, label, duration, unit]) | A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). | +| [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate")(theta\[, label, duration, unit]) | A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). | +| [`XXMinusYYGate`](qiskit.circuit.library.XXMinusYYGate "qiskit.circuit.library.XXMinusYYGate")(theta\[, beta, label, ...]) | XX-YY interaction gate. | +| [`XXPlusYYGate`](qiskit.circuit.library.XXPlusYYGate "qiskit.circuit.library.XXPlusYYGate")(theta\[, beta, label, duration, ...]) | XX+YY interaction gate. | +| [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate")(\*args\[, \_force\_mutable]) | Single qubit S gate (Z\*\*0.5). | +| [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate")(\*args\[, \_force\_mutable]) | Single qubit S-adjoint gate (\~Z\*\*0.5). | +| [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")(\*args\[, \_force\_mutable]) | The SWAP gate. | +| [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate")(\*args\[, \_force\_mutable]) | iSWAP gate. | +| [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate")(\*args\[, \_force\_mutable]) | The single-qubit Sqrt(X) gate ($\sqrt{X}$). | +| [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate")(\*args\[, \_force\_mutable]) | The inverse single-qubit Sqrt(X) gate. | +| [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate")(\*args\[, \_force\_mutable]) | Single qubit T gate (Z\*\*0.25). | +| [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate")(\*args\[, \_force\_mutable]) | Single qubit T-adjoint gate (\~Z\*\*0.25). | +| [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate")(theta, phi, lam\[, label, duration, unit]) | Generic single-qubit rotation gate with 3 Euler angles. | +| [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate")(theta\[, label, duration, unit]) | Single-qubit rotation about the Z axis. | +| [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate")(phi, lam\[, label, duration, unit]) | Single-qubit rotation about the X+Z axis. | +| [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate")(theta, phi, lam\[, label, duration, unit]) | Generic single-qubit rotation gate with 3 Euler angles. | +| [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate")(\*args\[, \_force\_mutable]) | The single-qubit Pauli-X gate ($\sigma_x$). | +| [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate")(\*args\[, \_force\_mutable]) | The single-qubit Pauli-Y gate ($\sigma_y$). | +| [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate")(\*args\[, \_force\_mutable]) | The single-qubit Pauli-Z gate ($\sigma_z$). | +| [`GlobalPhaseGate`](qiskit.circuit.library.GlobalPhaseGate "qiskit.circuit.library.GlobalPhaseGate")(phase\[, label, duration, unit]) | The global phase gate ($e^{i\theta}$). | ## Standard Directives @@ -124,7 +124,7 @@ Directives are operations to the quantum stack that are meant to be interpreted | | | | --------------------------------------------------------------------------------------------------- | -------------------- | -| [`Barrier`](qiskit.circuit.library.Barrier "qiskit.circuit.library.Barrier")(num\_qubits\[, label]) | Barrier instruction. | +| [`Barrier`](qiskit.circuit.library.Barrier "qiskit.circuit.library.Barrier")(num\_qubits\[, label]) | Barrier instruction. | ## Standard Operations @@ -132,8 +132,8 @@ Operations are non-reversible changes in the quantum state of the circuit. | | | | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | -| [`Measure`](qiskit.circuit.library.Measure "qiskit.circuit.library.Measure")(\[label, duration, unit]) | Quantum measurement in the computational basis. | -| [`Reset`](qiskit.circuit.library.Reset "qiskit.circuit.library.Reset")(\[label, duration, unit]) | Qubit reset. | +| [`Measure`](qiskit.circuit.library.Measure "qiskit.circuit.library.Measure")(\[label, duration, unit]) | Quantum measurement in the computational basis. | +| [`Reset`](qiskit.circuit.library.Reset "qiskit.circuit.library.Reset")(\[label, duration, unit]) | Qubit reset. | ## Generalized Gates @@ -158,27 +158,27 @@ print(diagonal.num_qubits) | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | - | ----------------------------------- | | [`Diagonal`](qiskit.circuit.library.Diagonal "qiskit.circuit.library.Diagonal")(diag) | Diagonal circuit. | | | | [`DiagonalGate`](qiskit.circuit.library.DiagonalGate "qiskit.circuit.library.DiagonalGate")(diag) | Gate implementing a diagonal transformation. | | | -| [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT")(gate, num\_ctrl\_qubits, num\_target\_qubits) | The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. | | | -| [`MCMTVChain`](qiskit.circuit.library.MCMTVChain "qiskit.circuit.library.MCMTVChain")(gate, num\_ctrl\_qubits, ...) | The MCMT implementation using the CCX V-chain. | | | -| [`Permutation`](qiskit.circuit.library.Permutation "qiskit.circuit.library.Permutation")(num\_qubits\[, pattern, seed]) | An n\_qubit circuit that permutes qubits. | | | +| [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT")(gate, num\_ctrl\_qubits, num\_target\_qubits) | The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. | | | +| [`MCMTVChain`](qiskit.circuit.library.MCMTVChain "qiskit.circuit.library.MCMTVChain")(gate, num\_ctrl\_qubits, ...) | The MCMT implementation using the CCX V-chain. | | | +| [`Permutation`](qiskit.circuit.library.Permutation "qiskit.circuit.library.Permutation")(num\_qubits\[, pattern, seed]) | An n\_qubit circuit that permutes qubits. | | | | [`PermutationGate`](qiskit.circuit.library.PermutationGate "qiskit.circuit.library.PermutationGate")(pattern) | A gate that permutes qubits. | | | -| [`GMS`](qiskit.circuit.library.GMS "qiskit.circuit.library.GMS")(num\_qubits, theta) | Global Mølmer–Sørensen gate. | | | -| [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.GR")(num\_qubits, theta, phi) | Global R gate. | | | -| [`GRX`](qiskit.circuit.library.GRX "qiskit.circuit.library.GRX")(num\_qubits, theta) | Global RX gate. | | | -| [`GRY`](qiskit.circuit.library.GRY "qiskit.circuit.library.GRY")(num\_qubits, theta) | Global RY gate. | | | -| [`GRZ`](qiskit.circuit.library.GRZ "qiskit.circuit.library.GRZ")(num\_qubits, phi) | Global RZ gate. | | | -| [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate")(lam, num\_ctrl\_qubits\[, label, ...]) | Multi-controlled-Phase gate. | | | -| [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate")(\[num\_ctrl\_qubits, label, ...]) | The general, multi-controlled X gate. | | | -| [`MCXGrayCode`](qiskit.circuit.library.MCXGrayCode "qiskit.circuit.library.MCXGrayCode")(\[num\_ctrl\_qubits, label, ...]) | Implement the multi-controlled X gate using the Gray code. | | | -| [`MCXRecursive`](qiskit.circuit.library.MCXRecursive "qiskit.circuit.library.MCXRecursive")(\[num\_ctrl\_qubits, label, ...]) | Implement the multi-controlled X gate using recursion. | | | -| [`MCXVChain`](qiskit.circuit.library.MCXVChain "qiskit.circuit.library.MCXVChain")(\[num\_ctrl\_qubits, dirty\_ancillas, ...]) | Implement the multi-controlled X gate using a V-chain of CX gates. | | | -| [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate")(v\_x, v\_y, v\_z\[, basis]) | Rotation around arbitrary rotation axis $v$ where \$ | v | \$ is angle of rotation in radians. | +| [`GMS`](qiskit.circuit.library.GMS "qiskit.circuit.library.GMS")(num\_qubits, theta) | Global Mølmer–Sørensen gate. | | | +| [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.GR")(num\_qubits, theta, phi) | Global R gate. | | | +| [`GRX`](qiskit.circuit.library.GRX "qiskit.circuit.library.GRX")(num\_qubits, theta) | Global RX gate. | | | +| [`GRY`](qiskit.circuit.library.GRY "qiskit.circuit.library.GRY")(num\_qubits, theta) | Global RY gate. | | | +| [`GRZ`](qiskit.circuit.library.GRZ "qiskit.circuit.library.GRZ")(num\_qubits, phi) | Global RZ gate. | | | +| [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate")(lam, num\_ctrl\_qubits\[, label, ...]) | Multi-controlled-Phase gate. | | | +| [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate")(\[num\_ctrl\_qubits, label, ...]) | The general, multi-controlled X gate. | | | +| [`MCXGrayCode`](qiskit.circuit.library.MCXGrayCode "qiskit.circuit.library.MCXGrayCode")(\[num\_ctrl\_qubits, label, ...]) | Implement the multi-controlled X gate using the Gray code. | | | +| [`MCXRecursive`](qiskit.circuit.library.MCXRecursive "qiskit.circuit.library.MCXRecursive")(\[num\_ctrl\_qubits, label, ...]) | Implement the multi-controlled X gate using recursion. | | | +| [`MCXVChain`](qiskit.circuit.library.MCXVChain "qiskit.circuit.library.MCXVChain")(\[num\_ctrl\_qubits, dirty\_ancillas, ...]) | Implement the multi-controlled X gate using a V-chain of CX gates. | | | +| [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate")(v\_x, v\_y, v\_z\[, basis]) | Rotation around arbitrary rotation axis $v$ where \$ | v | \$ is angle of rotation in radians. | | [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate")(label) | A multi-qubit Pauli gate. | | | -| [`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")(linear\[, validate\_input]) | A linear reversible circuit on n qubits. | | | -| [`Isometry`](qiskit.circuit.library.Isometry "qiskit.circuit.library.Isometry")(isometry, num\_ancillas\_zero, ...\[, ...]) | Decomposition of arbitrary isometries from $m$ to $n$ qubits. | | | -| [`UnitaryGate`](qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate")(data\[, label, check\_input]) | Class quantum gates specified by a unitary matrix. | | | -| [`UCGate`](qiskit.circuit.library.UCGate "qiskit.circuit.library.UCGate")(gate\_list\[, up\_to\_diagonal]) | Uniformly controlled gate (also called multiplexed gate). | | | -| [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.UCPauliRotGate")(angle\_list, rot\_axis) | Uniformly controlled Pauli rotations. | | | +| [`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")(linear\[, validate\_input]) | A linear reversible circuit on n qubits. | | | +| [`Isometry`](qiskit.circuit.library.Isometry "qiskit.circuit.library.Isometry")(isometry, num\_ancillas\_zero, ...\[, ...]) | Decomposition of arbitrary isometries from $m$ to $n$ qubits. | | | +| [`UnitaryGate`](qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate")(data\[, label, check\_input]) | Class quantum gates specified by a unitary matrix. | | | +| [`UCGate`](qiskit.circuit.library.UCGate "qiskit.circuit.library.UCGate")(gate\_list\[, up\_to\_diagonal]) | Uniformly controlled gate (also called multiplexed gate). | | | +| [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.UCPauliRotGate")(angle\_list, rot\_axis) | Uniformly controlled Pauli rotations. | | | | [`UCRXGate`](qiskit.circuit.library.UCRXGate "qiskit.circuit.library.UCRXGate")(angle\_list) | Uniformly controlled Pauli-X rotations. | | | | [`UCRYGate`](qiskit.circuit.library.UCRYGate "qiskit.circuit.library.UCRYGate")(angle\_list) | Uniformly controlled Pauli-Y rotations. | | | | [`UCRZGate`](qiskit.circuit.library.UCRZGate "qiskit.circuit.library.UCRZGate")(angle\_list) | Uniformly controlled Pauli-Z rotations. | | | @@ -189,9 +189,9 @@ These are [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Quant | | | | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | -| [`AND`](qiskit.circuit.library.AND "qiskit.circuit.library.AND")(num\_variable\_qubits\[, flags, mcx\_mode]) | A circuit implementing the logical AND operation on a number of qubits. | -| [`OR`](qiskit.circuit.library.OR "qiskit.circuit.library.OR")(num\_variable\_qubits\[, flags, mcx\_mode]) | A circuit implementing the logical OR operation on a number of qubits. | -| [`XOR`](qiskit.circuit.library.XOR "qiskit.circuit.library.XOR")(num\_qubits\[, amount, seed]) | An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. | +| [`AND`](qiskit.circuit.library.AND "qiskit.circuit.library.AND")(num\_variable\_qubits\[, flags, mcx\_mode]) | A circuit implementing the logical AND operation on a number of qubits. | +| [`OR`](qiskit.circuit.library.OR "qiskit.circuit.library.OR")(num\_variable\_qubits\[, flags, mcx\_mode]) | A circuit implementing the logical OR operation on a number of qubits. | +| [`XOR`](qiskit.circuit.library.XOR "qiskit.circuit.library.XOR")(num\_qubits\[, amount, seed]) | An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. | | [`InnerProduct`](qiskit.circuit.library.InnerProduct "qiskit.circuit.library.InnerProduct")(num\_qubits) | A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. | ## Basis Change Circuits @@ -200,7 +200,7 @@ These circuits allow basis transformations of the qubit states. For example, in | | | | ------------------------------------------------------------------------------------------------------------ | ---------------------------------- | -| [`QFT`](qiskit.circuit.library.QFT "qiskit.circuit.library.QFT")(\[num\_qubits, approximation\_degree, ...]) | Quantum Fourier Transform Circuit. | +| [`QFT`](qiskit.circuit.library.QFT "qiskit.circuit.library.QFT")(\[num\_qubits, approximation\_degree, ...]) | Quantum Fourier Transform Circuit. | ## Arithmetic Circuits @@ -210,69 +210,69 @@ These [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCi | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| [`LinearAmplitudeFunction`](qiskit.circuit.library.LinearAmplitudeFunction "qiskit.circuit.library.LinearAmplitudeFunction")(num\_state\_qubits, ...) | A circuit implementing a (piecewise) linear function on qubit amplitudes. | +| [`LinearAmplitudeFunction`](qiskit.circuit.library.LinearAmplitudeFunction "qiskit.circuit.library.LinearAmplitudeFunction")(num\_state\_qubits, ...) | A circuit implementing a (piecewise) linear function on qubit amplitudes. | ### Functional Pauli Rotations | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- | -| [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.FunctionalPauliRotations")(\[num\_state\_qubits, ...]) | Base class for functional Pauli rotations. | -| [`LinearPauliRotations`](qiskit.circuit.library.LinearPauliRotations "qiskit.circuit.library.LinearPauliRotations")(\[num\_state\_qubits, ...]) | Linearly-controlled X, Y or Z rotation. | -| [`PolynomialPauliRotations`](qiskit.circuit.library.PolynomialPauliRotations "qiskit.circuit.library.PolynomialPauliRotations")(\[num\_state\_qubits, ...]) | A circuit implementing polynomial Pauli rotations. | +| [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.FunctionalPauliRotations")(\[num\_state\_qubits, ...]) | Base class for functional Pauli rotations. | +| [`LinearPauliRotations`](qiskit.circuit.library.LinearPauliRotations "qiskit.circuit.library.LinearPauliRotations")(\[num\_state\_qubits, ...]) | Linearly-controlled X, Y or Z rotation. | +| [`PolynomialPauliRotations`](qiskit.circuit.library.PolynomialPauliRotations "qiskit.circuit.library.PolynomialPauliRotations")(\[num\_state\_qubits, ...]) | A circuit implementing polynomial Pauli rotations. | | [`PiecewiseLinearPauliRotations`](qiskit.circuit.library.PiecewiseLinearPauliRotations "qiskit.circuit.library.PiecewiseLinearPauliRotations")(\[...]) | Piecewise-linearly-controlled Pauli rotations. | | [`PiecewisePolynomialPauliRotations`](qiskit.circuit.library.PiecewisePolynomialPauliRotations "qiskit.circuit.library.PiecewisePolynomialPauliRotations")(\[...]) | Piecewise-polynomially-controlled Pauli rotations. | -| [`PiecewiseChebyshev`](qiskit.circuit.library.PiecewiseChebyshev "qiskit.circuit.library.PiecewiseChebyshev")(f\_x\[, degree, ...]) | Piecewise Chebyshev approximation to an input function. | +| [`PiecewiseChebyshev`](qiskit.circuit.library.PiecewiseChebyshev "qiskit.circuit.library.PiecewiseChebyshev")(f\_x\[, degree, ...]) | Piecewise Chebyshev approximation to an input function. | ### Adders | | | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`DraperQFTAdder`](qiskit.circuit.library.DraperQFTAdder "qiskit.circuit.library.DraperQFTAdder")(num\_state\_qubits\[, kind, name]) | A circuit that uses QFT to perform in-place addition on two qubit registers. | -| [`CDKMRippleCarryAdder`](qiskit.circuit.library.CDKMRippleCarryAdder "qiskit.circuit.library.CDKMRippleCarryAdder")(num\_state\_qubits\[, ...]) | A ripple-carry circuit to perform in-place addition on two qubit registers. | -| [`VBERippleCarryAdder`](qiskit.circuit.library.VBERippleCarryAdder "qiskit.circuit.library.VBERippleCarryAdder")(num\_state\_qubits\[, ...]) | The VBE ripple carry adder \[1]. | -| [`WeightedAdder`](qiskit.circuit.library.WeightedAdder "qiskit.circuit.library.WeightedAdder")(\[num\_state\_qubits, weights, name]) | A circuit to compute the weighted sum of qubit registers. | +| [`DraperQFTAdder`](qiskit.circuit.library.DraperQFTAdder "qiskit.circuit.library.DraperQFTAdder")(num\_state\_qubits\[, kind, name]) | A circuit that uses QFT to perform in-place addition on two qubit registers. | +| [`CDKMRippleCarryAdder`](qiskit.circuit.library.CDKMRippleCarryAdder "qiskit.circuit.library.CDKMRippleCarryAdder")(num\_state\_qubits\[, ...]) | A ripple-carry circuit to perform in-place addition on two qubit registers. | +| [`VBERippleCarryAdder`](qiskit.circuit.library.VBERippleCarryAdder "qiskit.circuit.library.VBERippleCarryAdder")(num\_state\_qubits\[, ...]) | The VBE ripple carry adder \[1]. | +| [`WeightedAdder`](qiskit.circuit.library.WeightedAdder "qiskit.circuit.library.WeightedAdder")(\[num\_state\_qubits, weights, name]) | A circuit to compute the weighted sum of qubit registers. | ### Multipliers | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| [`HRSCumulativeMultiplier`](qiskit.circuit.library.HRSCumulativeMultiplier "qiskit.circuit.library.HRSCumulativeMultiplier")(num\_state\_qubits\[, ...]) | A multiplication circuit to store product of two input registers out-of-place. | -| [`RGQFTMultiplier`](qiskit.circuit.library.RGQFTMultiplier "qiskit.circuit.library.RGQFTMultiplier")(num\_state\_qubits\[, ...]) | A QFT multiplication circuit to store product of two input registers out-of-place. | +| [`HRSCumulativeMultiplier`](qiskit.circuit.library.HRSCumulativeMultiplier "qiskit.circuit.library.HRSCumulativeMultiplier")(num\_state\_qubits\[, ...]) | A multiplication circuit to store product of two input registers out-of-place. | +| [`RGQFTMultiplier`](qiskit.circuit.library.RGQFTMultiplier "qiskit.circuit.library.RGQFTMultiplier")(num\_state\_qubits\[, ...]) | A QFT multiplication circuit to store product of two input registers out-of-place. | ### Comparators | | | | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | -| [`IntegerComparator`](qiskit.circuit.library.IntegerComparator "qiskit.circuit.library.IntegerComparator")(\[num\_state\_qubits, value, ...]) | Integer Comparator. | +| [`IntegerComparator`](qiskit.circuit.library.IntegerComparator "qiskit.circuit.library.IntegerComparator")(\[num\_state\_qubits, value, ...]) | Integer Comparator. | ### Functions on binary variables | | | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| [`QuadraticForm`](qiskit.circuit.library.QuadraticForm "qiskit.circuit.library.QuadraticForm")(\[num\_result\_qubits, ...]) | Implements a quadratic form on binary variables encoded in qubit registers. | +| [`QuadraticForm`](qiskit.circuit.library.QuadraticForm "qiskit.circuit.library.QuadraticForm")(\[num\_result\_qubits, ...]) | Implements a quadratic form on binary variables encoded in qubit registers. | ### Other arithmetic functions | | | | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -| [`ExactReciprocal`](qiskit.circuit.library.ExactReciprocal "qiskit.circuit.library.ExactReciprocal")(num\_state\_qubits, scaling\[, ...]) | Exact reciprocal | +| [`ExactReciprocal`](qiskit.circuit.library.ExactReciprocal "qiskit.circuit.library.ExactReciprocal")(num\_state\_qubits, scaling\[, ...]) | Exact reciprocal | ## Particular Quantum Circuits | | | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`FourierChecking`](qiskit.circuit.library.FourierChecking "qiskit.circuit.library.FourierChecking")(f, g) | Fourier checking circuit. | +| [`FourierChecking`](qiskit.circuit.library.FourierChecking "qiskit.circuit.library.FourierChecking")(f, g) | Fourier checking circuit. | | [`GraphState`](qiskit.circuit.library.GraphState "qiskit.circuit.library.GraphState")(adjacency\_matrix) | Circuit to prepare a graph state. | | [`HiddenLinearFunction`](qiskit.circuit.library.HiddenLinearFunction "qiskit.circuit.library.HiddenLinearFunction")(adjacency\_matrix) | Circuit to solve the hidden linear function problem. | | [`IQP`](qiskit.circuit.library.IQP "qiskit.circuit.library.IQP")(interactions) | Instantaneous quantum polynomial (IQP) circuit. | -| [`QuantumVolume`](qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume")(num\_qubits\[, depth, seed, ...]) | A quantum volume model circuit. | -| [`PhaseEstimation`](qiskit.circuit.library.PhaseEstimation "qiskit.circuit.library.PhaseEstimation")(num\_evaluation\_qubits, unitary) | Phase Estimation circuit. | -| [`GroverOperator`](qiskit.circuit.library.GroverOperator "qiskit.circuit.library.GroverOperator")(oracle\[, state\_preparation, ...]) | The Grover operator. | -| [`PhaseOracle`](qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle")(expression\[, synthesizer, var\_order]) | Phase Oracle. | -| [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.EvolvedOperatorAnsatz")(\[operators, reps, ...]) | The evolved operator ansatz. | -| [`PauliEvolutionGate`](qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate")(operator\[, time, label, ...]) | Time-evolution of an operator consisting of Paulis. | -| [`HamiltonianGate`](qiskit.circuit.library.HamiltonianGate "qiskit.circuit.library.HamiltonianGate")(data, time\[, label]) | Class for representing evolution by a Hamiltonian operator as a gate. | -| [`UnitaryOverlap`](qiskit.circuit.library.UnitaryOverlap "qiskit.circuit.library.UnitaryOverlap")(unitary1, unitary2\[, ...]) | Circuit that returns the overlap between two unitaries $U_2^{\dag} U_1$. | +| [`QuantumVolume`](qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume")(num\_qubits\[, depth, seed, ...]) | A quantum volume model circuit. | +| [`PhaseEstimation`](qiskit.circuit.library.PhaseEstimation "qiskit.circuit.library.PhaseEstimation")(num\_evaluation\_qubits, unitary) | Phase Estimation circuit. | +| [`GroverOperator`](qiskit.circuit.library.GroverOperator "qiskit.circuit.library.GroverOperator")(oracle\[, state\_preparation, ...]) | The Grover operator. | +| [`PhaseOracle`](qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle")(expression\[, synthesizer, var\_order]) | Phase Oracle. | +| [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.EvolvedOperatorAnsatz")(\[operators, reps, ...]) | The evolved operator ansatz. | +| [`PauliEvolutionGate`](qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate")(operator\[, time, label, ...]) | Time-evolution of an operator consisting of Paulis. | +| [`HamiltonianGate`](qiskit.circuit.library.HamiltonianGate "qiskit.circuit.library.HamiltonianGate")(data, time\[, label]) | Class for representing evolution by a Hamiltonian operator as a gate. | +| [`UnitaryOverlap`](qiskit.circuit.library.UnitaryOverlap "qiskit.circuit.library.UnitaryOverlap")(unitary1, unitary2\[, ...]) | Circuit that returns the overlap between two unitaries $U_2^{\dag} U_1$. | ## N-local circuits @@ -280,13 +280,13 @@ These `BlueprintCircuit` subclasses are used as parameterized models (a.k.a. ans | | | | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.NLocal")(\[num\_qubits, rotation\_blocks, ...]) | The n-local circuit class. | -| [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal")(\[num\_qubits, rotation\_blocks, ...]) | The two-local circuit. | -| [`PauliTwoDesign`](qiskit.circuit.library.PauliTwoDesign "qiskit.circuit.library.PauliTwoDesign")(\[num\_qubits, reps, seed, ...]) | The Pauli Two-Design ansatz. | -| [`RealAmplitudes`](qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes")(\[num\_qubits, entanglement, ...]) | The real-amplitudes 2-local circuit. | -| [`EfficientSU2`](qiskit.circuit.library.EfficientSU2 "qiskit.circuit.library.EfficientSU2")(\[num\_qubits, su2\_gates, ...]) | The hardware efficient SU(2) 2-local circuit. | -| [`ExcitationPreserving`](qiskit.circuit.library.ExcitationPreserving "qiskit.circuit.library.ExcitationPreserving")(\[num\_qubits, mode, ...]) | The heuristic excitation-preserving wave function ansatz. | -| [`QAOAAnsatz`](qiskit.circuit.library.QAOAAnsatz "qiskit.circuit.library.QAOAAnsatz")(\[cost\_operator, reps, ...]) | A generalized QAOA quantum circuit with a support of custom initial states and mixers. | +| [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.NLocal")(\[num\_qubits, rotation\_blocks, ...]) | The n-local circuit class. | +| [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal")(\[num\_qubits, rotation\_blocks, ...]) | The two-local circuit. | +| [`PauliTwoDesign`](qiskit.circuit.library.PauliTwoDesign "qiskit.circuit.library.PauliTwoDesign")(\[num\_qubits, reps, seed, ...]) | The Pauli Two-Design ansatz. | +| [`RealAmplitudes`](qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes")(\[num\_qubits, entanglement, ...]) | The real-amplitudes 2-local circuit. | +| [`EfficientSU2`](qiskit.circuit.library.EfficientSU2 "qiskit.circuit.library.EfficientSU2")(\[num\_qubits, su2\_gates, ...]) | The hardware efficient SU(2) 2-local circuit. | +| [`ExcitationPreserving`](qiskit.circuit.library.ExcitationPreserving "qiskit.circuit.library.ExcitationPreserving")(\[num\_qubits, mode, ...]) | The heuristic excitation-preserving wave function ansatz. | +| [`QAOAAnsatz`](qiskit.circuit.library.QAOAAnsatz "qiskit.circuit.library.QAOAAnsatz")(\[cost\_operator, reps, ...]) | A generalized QAOA quantum circuit with a support of custom initial states and mixers. | ## Data encoding circuits @@ -294,11 +294,11 @@ These `BlueprintCircuit` encode classical data in quantum states and are used as | | | | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap")(\[feature\_dimension, reps, ...]) | The Pauli Expansion circuit. | -| [`ZFeatureMap`](qiskit.circuit.library.ZFeatureMap "qiskit.circuit.library.ZFeatureMap")(feature\_dimension\[, reps, ...]) | The first order Pauli Z-evolution circuit. | -| [`ZZFeatureMap`](qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap")(feature\_dimension\[, reps, ...]) | Second-order Pauli-Z evolution circuit. | -| [`StatePreparation`](qiskit.circuit.library.StatePreparation "qiskit.circuit.library.StatePreparation")(params\[, num\_qubits, ...]) | Complex amplitude state preparation. | -| [`Initialize`](qiskit.circuit.library.Initialize "qiskit.circuit.library.Initialize")(params\[, num\_qubits, normalize]) | Complex amplitude initialization. | +| [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap")(\[feature\_dimension, reps, ...]) | The Pauli Expansion circuit. | +| [`ZFeatureMap`](qiskit.circuit.library.ZFeatureMap "qiskit.circuit.library.ZFeatureMap")(feature\_dimension\[, reps, ...]) | The first order Pauli Z-evolution circuit. | +| [`ZZFeatureMap`](qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap")(feature\_dimension\[, reps, ...]) | Second-order Pauli-Z evolution circuit. | +| [`StatePreparation`](qiskit.circuit.library.StatePreparation "qiskit.circuit.library.StatePreparation")(params\[, num\_qubits, ...]) | Complex amplitude state preparation. | +| [`Initialize`](qiskit.circuit.library.Initialize "qiskit.circuit.library.Initialize")(params\[, num\_qubits, normalize]) | Complex amplitude initialization. | ## Template circuits @@ -326,7 +326,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib -`qiskit.circuit.library.templates.nct.template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_1()` **Returns** @@ -338,7 +338,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_2()` **Returns** @@ -350,7 +350,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_2a_3()` **Returns** @@ -362,7 +362,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_1()` **Returns** @@ -374,7 +374,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_2()` **Returns** @@ -386,7 +386,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4a_3()` **Returns** @@ -398,7 +398,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_1()` **Returns** @@ -410,7 +410,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_4b_2()` **Returns** @@ -422,7 +422,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_1()` **Returns** @@ -434,7 +434,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_2()` **Returns** @@ -446,7 +446,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_3()` **Returns** @@ -458,7 +458,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_5a_4()` **Returns** @@ -470,7 +470,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_1()` **Returns** @@ -482,7 +482,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_2()` **Returns** @@ -494,7 +494,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_3()` **Returns** @@ -506,7 +506,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6a_4()` **Returns** @@ -518,7 +518,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_1()` **Returns** @@ -530,7 +530,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6b_2()` **Returns** @@ -542,7 +542,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_6c_1()` **Returns** @@ -554,7 +554,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7a_1()` **Returns** @@ -566,7 +566,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7b_1()` **Returns** @@ -578,7 +578,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7c_1()` **Returns** @@ -590,7 +590,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7d_1()` **Returns** @@ -602,7 +602,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_7e_1()` **Returns** @@ -614,7 +614,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9a_1()` **Returns** @@ -626,7 +626,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_1()` **Returns** @@ -638,7 +638,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_2()` **Returns** @@ -650,7 +650,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_3()` **Returns** @@ -662,7 +662,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_4()` **Returns** @@ -674,7 +674,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_5()` **Returns** @@ -686,7 +686,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_6()` **Returns** @@ -698,7 +698,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_7()` **Returns** @@ -710,7 +710,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_8()` **Returns** @@ -722,7 +722,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_9()` **Returns** @@ -734,7 +734,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_10()` **Returns** @@ -746,7 +746,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_11()` **Returns** @@ -758,7 +758,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9c_12()` **Returns** @@ -770,7 +770,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_1()` **Returns** @@ -782,7 +782,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_2()` **Returns** @@ -794,7 +794,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_3()` **Returns** @@ -806,7 +806,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_4()` **Returns** @@ -818,7 +818,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_5()` **Returns** @@ -830,7 +830,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_6()` **Returns** @@ -842,7 +842,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_7()` **Returns** @@ -854,7 +854,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_8()` **Returns** @@ -866,7 +866,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_9()` **Returns** @@ -878,7 +878,7 @@ template as a quantum circuit. -`qiskit.circuit.library.templates.nct.template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") +`qiskit.circuit.library.templates.nct.template_nct_9d_10()` **Returns** @@ -894,7 +894,7 @@ Template circuits over Clifford gates. -`qiskit.circuit.library.clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") +`qiskit.circuit.library.clifford_2_1()` **Returns** @@ -906,7 +906,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") +`qiskit.circuit.library.clifford_2_2()` **Returns** @@ -918,7 +918,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") +`qiskit.circuit.library.clifford_2_3()` **Returns** @@ -930,7 +930,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") +`qiskit.circuit.library.clifford_2_4()` **Returns** @@ -942,7 +942,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") +`qiskit.circuit.library.clifford_3_1()` **Returns** @@ -954,7 +954,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") +`qiskit.circuit.library.clifford_4_1()` **Returns** @@ -966,7 +966,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") +`qiskit.circuit.library.clifford_4_2()` **Returns** @@ -978,7 +978,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") +`qiskit.circuit.library.clifford_4_3()` **Returns** @@ -990,7 +990,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") +`qiskit.circuit.library.clifford_4_4()` **Returns** @@ -1002,7 +1002,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") +`qiskit.circuit.library.clifford_5_1()` **Returns** @@ -1014,7 +1014,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") +`qiskit.circuit.library.clifford_6_1()` **Returns** @@ -1026,7 +1026,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") +`qiskit.circuit.library.clifford_6_2()` **Returns** @@ -1038,7 +1038,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") +`qiskit.circuit.library.clifford_6_3()` **Returns** @@ -1050,7 +1050,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") +`qiskit.circuit.library.clifford_6_4()` **Returns** @@ -1062,7 +1062,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") +`qiskit.circuit.library.clifford_6_5()` **Returns** @@ -1074,7 +1074,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") +`qiskit.circuit.library.clifford_8_1()` **Returns** @@ -1086,7 +1086,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") +`qiskit.circuit.library.clifford_8_2()` **Returns** @@ -1098,7 +1098,7 @@ template as a quantum circuit. -`qiskit.circuit.library.clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") +`qiskit.circuit.library.clifford_8_3()` **Returns** @@ -1114,37 +1114,37 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui -`qiskit.circuit.library.rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") +`qiskit.circuit.library.rzx_yz(theta=None)` Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") +`qiskit.circuit.library.rzx_xz(theta=None)` Template for CX - RXGate - CX. -`qiskit.circuit.library.rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") +`qiskit.circuit.library.rzx_cy(theta=None)` Template for CX - RYGate - CX. -`qiskit.circuit.library.rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") +`qiskit.circuit.library.rzx_zz1(theta=None)` Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") +`qiskit.circuit.library.rzx_zz2(theta=None)` Template for CX - RZGate - CX. -`qiskit.circuit.library.rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") +`qiskit.circuit.library.rzx_zz3(theta=None)` Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/circuit_singleton.md b/docs/api/qiskit/circuit_singleton.md index 780729a79d..02211f85f6 100644 --- a/docs/api/qiskit/circuit_singleton.md +++ b/docs/api/qiskit/circuit_singleton.md @@ -46,7 +46,7 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir -`qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)` A base class to use for [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") objects that by default are singleton instances. @@ -56,7 +56,7 @@ The exception to be aware of with this class though are the [`Instruction`](qisk -`qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)` A base class to use for [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") objects that by default are singleton instances. @@ -64,7 +64,7 @@ This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton -`qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/singleton.py "view source code") +`qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)` A base class to use for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects that by default are singleton instances diff --git a/docs/api/qiskit/classicalfunction.md b/docs/api/qiskit/classicalfunction.md index affc59df4f..26ddfab8cb 100644 --- a/docs/api/qiskit/classicalfunction.md +++ b/docs/api/qiskit/classicalfunction.md @@ -71,8 +71,8 @@ Decorator for a classical function that returns a ClassicalFunction object. | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| [`ClassicalFunction`](qiskit.circuit.classicalfunction.ClassicalFunction "qiskit.circuit.classicalfunction.ClassicalFunction")(source\[, name]) | Represent a classical function and its logic network. | -| [`BooleanExpression`](qiskit.circuit.classicalfunction.BooleanExpression "qiskit.circuit.classicalfunction.BooleanExpression")(expression\[, name, var\_order]) | The Boolean Expression gate. | +| [`ClassicalFunction`](qiskit.circuit.classicalfunction.ClassicalFunction "qiskit.circuit.classicalfunction.ClassicalFunction")(source\[, name]) | Represent a classical function and its logic network. | +| [`BooleanExpression`](qiskit.circuit.classicalfunction.BooleanExpression "qiskit.circuit.classicalfunction.BooleanExpression")(expression\[, name, var\_order]) | The Boolean Expression gate. | ### Exceptions diff --git a/docs/api/qiskit/compiler.md b/docs/api/qiskit/compiler.md index dfa14a1472..5efb6640cb 100644 --- a/docs/api/qiskit/compiler.md +++ b/docs/api/qiskit/compiler.md @@ -22,7 +22,7 @@ python_api_name: qiskit.compiler -`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/assembler.py "view source code") +`qiskit.compiler.assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` Assemble a list of circuits or pulse schedules into a `Qobj`. @@ -103,7 +103,7 @@ A `Qobj` that can be run on a backend. Depending on the type of input, this will -`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/scheduler.py "view source code") +`qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in `qiskit.scheduler.schedule_circuit`. @@ -130,7 +130,7 @@ A pulse `Schedule` that implements the input circuit -`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/transpiler.py "view source code") +`qiskit.compiler.transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)` Transpile one or more circuits, according to some desired transpilation targets. @@ -276,7 +276,7 @@ The transpiled circuit(s). -`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/compiler/sequencer.py "view source code") +`qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/converters.md b/docs/api/qiskit/converters.md index 78760aafa7..6251b8fa08 100644 --- a/docs/api/qiskit/converters.md +++ b/docs/api/qiskit/converters.md @@ -20,7 +20,7 @@ python_api_name: qiskit.converters -`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_dag.py "view source code") +`qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)` Build a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -62,7 +62,7 @@ dag = circuit_to_dag(circ) -`qiskit.converters.dag_to_circuit(dag, copy_operations=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dag_to_circuit.py "view source code") +`qiskit.converters.dag_to_circuit(dag, copy_operations=True)` Build a `QuantumCircuit` object from a `DAGCircuit`. @@ -104,7 +104,7 @@ circuit.draw('mpl') -`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_instruction.py "view source code") +`qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -147,7 +147,7 @@ circuit_to_instruction(circ) -`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_gate.py "view source code") +`qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -174,7 +174,7 @@ a Gate equivalent to the action of the input circuit. Upon decomposition, this g -`qiskit.converters.ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/ast_to_dag.py "view source code") +`qiskit.converters.ast_to_dag(ast)` Build a `DAGCircuit` object from an AST `Node` object. @@ -214,7 +214,7 @@ dag = ast_to_dag(ast) -`qiskit.converters.dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dagdependency_to_circuit.py "view source code") +`qiskit.converters.dagdependency_to_circuit(dagdependency)` Build a `QuantumCircuit` object from a `DAGDependency`. @@ -232,7 +232,7 @@ the circuit representing the input dag dependency. -`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/circuit_to_dagdependency.py "view source code") +`qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)` Build a `DAGDependency` object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -251,7 +251,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dag_to_dagdependency.py "view source code") +`qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)` Build a `DAGDependency` object from a `DAGCircuit`. @@ -270,7 +270,7 @@ the DAG representing the input circuit as a dag dependency. -`qiskit.converters.dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/converters/dagdependency_to_dag.py "view source code") +`qiskit.converters.dagdependency_to_dag(dagdependency)` Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/dagcircuit.md b/docs/api/qiskit/dagcircuit.md index 1996e105be..f40250409c 100644 --- a/docs/api/qiskit/dagcircuit.md +++ b/docs/api/qiskit/dagcircuit.md @@ -24,17 +24,17 @@ python_api_name: qiskit.dagcircuit | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")() | Quantum circuit as a directed acyclic graph. | | [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")(\[nid]) | Parent class for DAGOpNode, DAGInNode, and DAGOutNode. | -| [`DAGOpNode`](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")(op\[, qargs, cargs, dag]) | Object to represent an Instruction at a node in the DAGCircuit. | +| [`DAGOpNode`](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")(op\[, qargs, cargs, dag]) | Object to represent an Instruction at a node in the DAGCircuit. | | [`DAGInNode`](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")(wire) | Object to represent an incoming wire node in the DAGCircuit. | | [`DAGOutNode`](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")(wire) | Object to represent an outgoing wire node in the DAGCircuit. | -| [`DAGDepNode`](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")(\[type, op, name, qargs, cargs, ...]) | Object to represent the information at a node in the DAGDependency(). | +| [`DAGDepNode`](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")(\[type, op, name, qargs, cargs, ...]) | Object to represent the information at a node in the DAGDependency(). | | [`DAGDependency`](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency")() | Object to represent a quantum circuit as a Directed Acyclic Graph (DAG) via operation dependencies (i.e. | ## Exceptions -`qiskit.dagcircuit.DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGCircuitError(*msg)` Base class for errors raised by the DAGCircuit object. @@ -42,7 +42,7 @@ Set the error message. -`qiskit.dagcircuit.DAGDependencyError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/exceptions.py "view source code") +`qiskit.dagcircuit.DAGDependencyError(*msg)` Base class for errors raised by the DAGDependency object. diff --git a/docs/api/qiskit/exceptions.md b/docs/api/qiskit/exceptions.md index 785eac2d2d..ccf42e44d4 100644 --- a/docs/api/qiskit/exceptions.md +++ b/docs/api/qiskit/exceptions.md @@ -22,7 +22,7 @@ All Qiskit-related errors raised by Qiskit are subclasses of the base: -`qiskit.exceptions.QiskitError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitError(*message)` Base class for errors raised by Qiskit. @@ -38,7 +38,7 @@ Qiskit has several optional features that depend on other packages that are not -`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") +`qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` Raised when an optional library is missing. @@ -48,7 +48,7 @@ Two more uncommon errors relate to failures in reading user-configuration files, -`qiskit.exceptions.QiskitUserConfigError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") +`qiskit.exceptions.QiskitUserConfigError(*message)` Raised when an error is encountered reading a user config file. @@ -56,7 +56,7 @@ Set the error message. -`qiskit.exceptions.InvalidFileError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/exceptions.py "view source code") +`qiskit.exceptions.InvalidFileError(*message)` Raised when the file provided is not valid for the specific task. diff --git a/docs/api/qiskit/execute.md b/docs/api/qiskit/execute.md index fc79990c06..13f51b368e 100644 --- a/docs/api/qiskit/execute.md +++ b/docs/api/qiskit/execute.md @@ -20,7 +20,7 @@ python_api_name: qiskit.execute_function -`qiskit.execute_function.execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, shots=None, memory=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/execute_function.py "view source code") +`qiskit.execute_function.execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, shots=None, memory=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/extensions.md b/docs/api/qiskit/extensions.md index 6f4fc24cad..3e1cff21e6 100644 --- a/docs/api/qiskit/extensions.md +++ b/docs/api/qiskit/extensions.md @@ -22,13 +22,13 @@ python_api_name: qiskit.extensions | | | | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------- | -| [`SingleQubitUnitary`](qiskit.extensions.SingleQubitUnitary "qiskit.extensions.SingleQubitUnitary")(unitary\_matrix\[, mode, ...]) | Single-qubit unitary. | +| [`SingleQubitUnitary`](qiskit.extensions.SingleQubitUnitary "qiskit.extensions.SingleQubitUnitary")(unitary\_matrix\[, mode, ...]) | Single-qubit unitary. | ## Simulator Extensions | | | | ----------------------------------------------------------------------------------------------------------------- | ------------------------------- | -| [`Snapshot`](qiskit.extensions.Snapshot "qiskit.extensions.Snapshot")(label\[, snapshot\_type, num\_qubits, ...]) | Simulator snapshot instruction. | +| [`Snapshot`](qiskit.extensions.Snapshot "qiskit.extensions.Snapshot")(label\[, snapshot\_type, num\_qubits, ...]) | Simulator snapshot instruction. | ## Exceptions @@ -36,7 +36,7 @@ The additional gates in this module will tend to raise a custom exception when t -`qiskit.extensions.ExtensionError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/extensions/exceptions.py "view source code") +`qiskit.extensions.ExtensionError(*message)` Base class for errors raised by extensions module. diff --git a/docs/api/qiskit/opflow.md b/docs/api/qiskit/opflow.md index a98147ff50..cf018b6945 100644 --- a/docs/api/qiskit/opflow.md +++ b/docs/api/qiskit/opflow.md @@ -97,7 +97,7 @@ The Converter submodules include objects which manipulate Operators, usually rec -`qiskit.opflow.commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.commutator(op_a, op_b)` Deprecated: Compute commutator of op\_a and op\_b. @@ -124,7 +124,7 @@ the commutator -`qiskit.opflow.anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.anti_commutator(op_a, op_b)` Deprecated: Compute anti-commutator of op\_a and op\_b. @@ -151,7 +151,7 @@ the anti-commutator -`qiskit.opflow.double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/utils.py "view source code") +`qiskit.opflow.double_commutator(op_a, op_b, op_c, sign=False)` Deprecated: Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) @@ -167,8 +167,6 @@ If sign is True, it returns $$ \lbrace[A, B], C\rbrace/2 + \lbrace A, [B, C]\rbrace/2 = (2ABC - 2CBA - BAC + CAB - ACB + BCA)/2. - - $$ @@ -194,7 +192,7 @@ the double commutator -`qiskit.opflow.OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/exceptions.py "view source code") +`qiskit.opflow.OpflowError(*message)` Deprecated: For Opflow specific errors. diff --git a/docs/api/qiskit/passmanager.md b/docs/api/qiskit/passmanager.md index 113721adaa..1034abe1c4 100644 --- a/docs/api/qiskit/passmanager.md +++ b/docs/api/qiskit/passmanager.md @@ -138,7 +138,7 @@ With the pass manager framework, a developer can flexibly customize the optimiza | | | | ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| [`BasePassManager`](qiskit.passmanager.BasePassManager "qiskit.passmanager.BasePassManager")(\[tasks, max\_iteration]) | Pass manager base class. | +| [`BasePassManager`](qiskit.passmanager.BasePassManager "qiskit.passmanager.BasePassManager")(\[tasks, max\_iteration]) | Pass manager base class. | | [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.BaseController")(\[options]) | Base class of controller. | | [`GenericPass`](qiskit.passmanager.GenericPass "qiskit.passmanager.GenericPass")() | Base class of a single pass manager task. | @@ -147,23 +147,23 @@ With the pass manager framework, a developer can flexibly customize the optimiza | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | [`FlowController`](qiskit.passmanager.FlowController "qiskit.passmanager.FlowController")(\[options]) | A legacy factory for other flow controllers. | -| [`FlowControllerLinear`](qiskit.passmanager.FlowControllerLinear "qiskit.passmanager.FlowControllerLinear")(\[tasks, options]) | A standard flow controller that runs tasks one after the other. | -| [`ConditionalController`](qiskit.passmanager.ConditionalController "qiskit.passmanager.ConditionalController")(\[tasks, condition, ...]) | A flow controller runs the pipeline once if the condition is true, or does nothing if the condition is false. | -| [`DoWhileController`](qiskit.passmanager.DoWhileController "qiskit.passmanager.DoWhileController")(\[tasks, do\_while, options]) | Run the given tasks in a loop until the `do_while` condition on the property set becomes `False`. | +| [`FlowControllerLinear`](qiskit.passmanager.FlowControllerLinear "qiskit.passmanager.FlowControllerLinear")(\[tasks, options]) | A standard flow controller that runs tasks one after the other. | +| [`ConditionalController`](qiskit.passmanager.ConditionalController "qiskit.passmanager.ConditionalController")(\[tasks, condition, ...]) | A flow controller runs the pipeline once if the condition is true, or does nothing if the condition is false. | +| [`DoWhileController`](qiskit.passmanager.DoWhileController "qiskit.passmanager.DoWhileController")(\[tasks, do\_while, options]) | Run the given tasks in a loop until the `do_while` condition on the property set becomes `False`. | ### Compilation state | | | | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | [`PropertySet`](qiskit.passmanager.PropertySet "qiskit.passmanager.PropertySet") | A default dictionary-like object. | -| [`WorkflowStatus`](qiskit.passmanager.WorkflowStatus "qiskit.passmanager.WorkflowStatus")(\[count, completed\_passes, ...]) | Collection of compilation status of workflow, i.e. pass manager run. | -| [`PassManagerState`](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")(workflow\_status, property\_set) | A portable container object that pass manager tasks communicate through generator. | +| [`WorkflowStatus`](qiskit.passmanager.WorkflowStatus "qiskit.passmanager.WorkflowStatus")(\[count, completed\_passes, ...]) | Collection of compilation status of workflow, i.e. pass manager run. | +| [`PassManagerState`](qiskit.passmanager.PassManagerState "qiskit.passmanager.PassManagerState")(workflow\_status, property\_set) | A portable container object that pass manager tasks communicate through generator. | ### Exceptions -`qiskit.passmanager.PassManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/exceptions.py "view source code") +`qiskit.passmanager.PassManagerError(*message)` Pass manager error. diff --git a/docs/api/qiskit/primitives.md b/docs/api/qiskit/primitives.md index dc91d1f781..4c9293a3fe 100644 --- a/docs/api/qiskit/primitives.md +++ b/docs/api/qiskit/primitives.md @@ -125,22 +125,22 @@ print([q.binary_probabilities() for q in job_result.quasi_dists]) | | | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator")(\*\[, options]) | Estimator base class. | -| [`Estimator`](qiskit.primitives.Estimator "qiskit.primitives.Estimator")(\*\[, options]) | Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"). | -| [`BackendEstimator`](qiskit.primitives.BackendEstimator "qiskit.primitives.BackendEstimator")(backend\[, options, ...]) | Evaluates expectation value using Pauli rotation gates. | +| [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator")(\*\[, options]) | Estimator base class. | +| [`Estimator`](qiskit.primitives.Estimator "qiskit.primitives.Estimator")(\*\[, options]) | Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"). | +| [`BackendEstimator`](qiskit.primitives.BackendEstimator "qiskit.primitives.BackendEstimator")(backend\[, options, ...]) | Evaluates expectation value using Pauli rotation gates. | ## Sampler | | | | ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler")(\*\[, options]) | Sampler base class | -| [`Sampler`](qiskit.primitives.Sampler "qiskit.primitives.Sampler")(\*\[, options]) | Sampler class. | -| [`BackendSampler`](qiskit.primitives.BackendSampler "qiskit.primitives.BackendSampler")(backend\[, options, ...]) | A [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") implementation that provides an interface for leveraging the sampler interface from any backend. | +| [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler")(\*\[, options]) | Sampler base class | +| [`Sampler`](qiskit.primitives.Sampler "qiskit.primitives.Sampler")(\*\[, options]) | Sampler class. | +| [`BackendSampler`](qiskit.primitives.BackendSampler "qiskit.primitives.BackendSampler")(backend\[, options, ...]) | A [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") implementation that provides an interface for leveraging the sampler interface from any backend. | ## Results | | | | ------------------------------------------------------------------------------------------------------------ | -------------------- | -| [`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.EstimatorResult")(values, metadata) | Result of Estimator. | -| [`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.SamplerResult")(quasi\_dists, metadata) | Result of Sampler. | +| [`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.EstimatorResult")(values, metadata) | Result of Estimator. | +| [`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.SamplerResult")(quasi\_dists, metadata) | Result of Sampler. | diff --git a/docs/api/qiskit/providers.md b/docs/api/qiskit/providers.md index b7e55f9a7b..7e4e92b1e2 100644 --- a/docs/api/qiskit/providers.md +++ b/docs/api/qiskit/providers.md @@ -32,7 +32,7 @@ Each minor version release of qiskit-terra **may** increment the version of any To enable providers to have time to adjust to changes in this interface Terra will support multiple versions of each class at once. Given the nature of one version per release the version deprecation policy is a bit more conservative than the standard deprecation policy. Terra will support a provider interface version for a minimum of 3 minor releases or the first release after 6 months from the release that introduced a version, whichever is longer, prior to a potential deprecation. After that the standard deprecation policy will apply to that interface version. This will give providers and users sufficient time to adapt to potential breaking changes in the interface. So for example lets say in 0.19.0 `BackendV2` is introduced and in the 3 months after the release of 0.19.0 we release 0.20.0, 0.21.0, and 0.22.0, then 7 months after 0.19.0 we release 0.23.0. In 0.23.0 we can deprecate BackendV2, and it needs to still be supported and can’t be removed until the deprecation policy completes. -It’s worth pointing out that Terra’s version support policy doesn’t mean providers themselves will have the same support story, they can (and arguably should) update to newer versions as soon as they can, the support window is just for Terra’s supported versions. Part of this lengthy window prior to deprecation is to give providers enough time to do their own deprecation of a potential end user impacting change in a user facing part of the interface prior to bumping their version. For example, let’s say we changed the signature to `Backend.run()` in `BackendV34` in a backwards incompatible way. Before Aer could update its [`AerSimulator`](https://qiskit.org/ecosystem/aer/stubs/qiskit_aer.AerSimulator.html#qiskit_aer.AerSimulator "(in Qiskit Aer v0.13.1)") class to be based on version 34 they’d need to deprecate the old signature prior to switching over. The changeover for Aer is not guaranteed to be lockstep with Terra so we need to ensure there is a sufficient amount of time for Aer to complete its deprecation cycle prior to removing version 33 (ie making version 34 mandatory/the minimum version). +It’s worth pointing out that Terra’s version support policy doesn’t mean providers themselves will have the same support story, they can (and arguably should) update to newer versions as soon as they can, the support window is just for Terra’s supported versions. Part of this lengthy window prior to deprecation is to give providers enough time to do their own deprecation of a potential end user impacting change in a user facing part of the interface prior to bumping their version. For example, let’s say we changed the signature to `Backend.run()` in `BackendV34` in a backwards incompatible way. Before Aer could update its [`AerSimulator`](https://qiskit.org/ecosystem/aer/stubs/qiskit_aer.AerSimulator.html#qiskit_aer.AerSimulator "(in Qiskit Aer v0.13.0)") class to be based on version 34 they’d need to deprecate the old signature prior to switching over. The changeover for Aer is not guaranteed to be lockstep with Terra so we need to ensure there is a sufficient amount of time for Aer to complete its deprecation cycle prior to removing version 33 (ie making version 34 mandatory/the minimum version). ## Abstract Classes @@ -48,11 +48,11 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p | | | | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend")() | Base common type for all versioned Backend abstract classes. | -| [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1")(configuration\[, provider]) | Abstract class for Backends | -| [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2")(\[provider, name, description, ...]) | Abstract class for Backends | -| [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties")(\[t1, t2, frequency]) | A representation of the properties of a qubit on a backend. | -| [`BackendV2Converter`](qiskit.providers.BackendV2Converter "qiskit.providers.BackendV2Converter")(backend\[, name\_mapping, ...]) | A converter class that takes a [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") instance and wraps it in a [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") interface. | -| [`convert_to_target`](qiskit.providers.convert_to_target "qiskit.providers.convert_to_target")(configuration\[, ...]) | Uses configuration, properties and pulse defaults to construct and return Target class. | +| [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1")(configuration\[, provider]) | Abstract class for Backends | +| [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2")(\[provider, name, description, ...]) | Abstract class for Backends | +| [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties")(\[t1, t2, frequency]) | A representation of the properties of a qubit on a backend. | +| [`BackendV2Converter`](qiskit.providers.BackendV2Converter "qiskit.providers.BackendV2Converter")(backend\[, name\_mapping, ...]) | A converter class that takes a [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") instance and wraps it in a [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") interface. | +| [`convert_to_target`](qiskit.providers.convert_to_target "qiskit.providers.convert_to_target")(configuration\[, ...]) | Uses configuration, properties and pulse defaults to construct and return Target class. | ### Options @@ -65,7 +65,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p | | | | ---------------------------------------------------------------------------------------- | -------------------------------------------------------- | | [`Job`](qiskit.providers.Job "qiskit.providers.Job")() | Base common type for all versioned Job abstract classes. | -| [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.JobV1")(backend, job\_id, \*\*kwargs) | Class to handle jobs | +| [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.JobV1")(backend, job\_id, \*\*kwargs) | Class to handle jobs | ### Job Status @@ -77,7 +77,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p -`qiskit.providers.QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.QiskitBackendNotFoundError(*message)` Base class for errors raised while looking for a backend. @@ -85,7 +85,7 @@ Set the error message. -`qiskit.providers.BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendPropertyError(*message)` Base class for errors raised while looking for a backend property. @@ -93,7 +93,7 @@ Set the error message. -`qiskit.providers.JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobError(*message)` Base class for errors raised by Jobs. @@ -101,7 +101,7 @@ Set the error message. -`qiskit.providers.JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.JobTimeoutError(*message)` Base class for timeout errors raised by jobs. @@ -109,7 +109,7 @@ Set the error message. -`qiskit.providers.BackendConfigurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/exceptions.py "view source code") +`qiskit.providers.BackendConfigurationError(*message)` Base class for errors raised by the BackendConfiguration. diff --git a/docs/api/qiskit/providers_basicaer.md b/docs/api/qiskit/providers_basicaer.md index 925e8eb3d9..91baf22d3a 100644 --- a/docs/api/qiskit/providers_basicaer.md +++ b/docs/api/qiskit/providers_basicaer.md @@ -30,9 +30,9 @@ backend = BasicAer.get_backend('qasm_simulator') | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -| [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.QasmSimulatorPy")(\[configuration, provider]) | Python implementation of an OpenQASM 2 simulator. | -| [`StatevectorSimulatorPy`](qiskit.providers.basicaer.StatevectorSimulatorPy "qiskit.providers.basicaer.StatevectorSimulatorPy")(\[configuration, provider]) | Python statevector simulator. | -| [`UnitarySimulatorPy`](qiskit.providers.basicaer.UnitarySimulatorPy "qiskit.providers.basicaer.UnitarySimulatorPy")(\[configuration, provider]) | Python implementation of a unitary simulator. | +| [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.QasmSimulatorPy")(\[configuration, provider]) | Python implementation of an OpenQASM 2 simulator. | +| [`StatevectorSimulatorPy`](qiskit.providers.basicaer.StatevectorSimulatorPy "qiskit.providers.basicaer.StatevectorSimulatorPy")(\[configuration, provider]) | Python statevector simulator. | +| [`UnitarySimulatorPy`](qiskit.providers.basicaer.UnitarySimulatorPy "qiskit.providers.basicaer.UnitarySimulatorPy")(\[configuration, provider]) | Python implementation of a unitary simulator. | ## Provider @@ -44,7 +44,7 @@ backend = BasicAer.get_backend('qasm_simulator') | | | | ------------------------------------------------------------------------------------------------------------------------ | ------------------ | -| [`BasicAerJob`](qiskit.providers.basicaer.BasicAerJob "qiskit.providers.basicaer.BasicAerJob")(backend, job\_id, result) | BasicAerJob class. | +| [`BasicAerJob`](qiskit.providers.basicaer.BasicAerJob "qiskit.providers.basicaer.BasicAerJob")(backend, job\_id, result) | BasicAerJob class. | ## Exceptions diff --git a/docs/api/qiskit/providers_fake_provider.md b/docs/api/qiskit/providers_fake_provider.md index 22f92829ea..e03acd73e6 100644 --- a/docs/api/qiskit/providers_fake_provider.md +++ b/docs/api/qiskit/providers_fake_provider.md @@ -203,7 +203,7 @@ Special fake backends are fake backends that were created for special testing pu | [`FakeBackendV2`](qiskit.providers.fake_provider.FakeBackendV2 "qiskit.providers.fake_provider.FakeBackendV2")() | A mock backend that doesn't implement run() to test compatibility with Terra internals. | | [`FakeBackend5QV2`](qiskit.providers.fake_provider.FakeBackend5QV2 "qiskit.providers.fake_provider.FakeBackend5QV2")(\[bidirectional]) | A mock backend that doesn't implement run() to test compatibility with Terra internals. | | [`FakeMumbaiFractionalCX`](qiskit.providers.fake_provider.FakeMumbaiFractionalCX "qiskit.providers.fake_provider.FakeMumbaiFractionalCX")() | A fake mumbai backend. | -| [`ConfigurableFakeBackend`](qiskit.providers.fake_provider.ConfigurableFakeBackend "qiskit.providers.fake_provider.ConfigurableFakeBackend")(name, n\_qubits\[, ...]) | Configurable backend. | +| [`ConfigurableFakeBackend`](qiskit.providers.fake_provider.ConfigurableFakeBackend "qiskit.providers.fake_provider.ConfigurableFakeBackend")(name, n\_qubits\[, ...]) | Configurable backend. | ## Fake Backend Base Classes @@ -211,7 +211,7 @@ The fake backends based on IBM hardware are based on a set of base classes: -`qiskit.providers.fake_provider.fake_backend.FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend.py "view source code") +`qiskit.providers.fake_provider.fake_backend.FakeBackendV2` A fake backend class for testing and noisy simulation using real backend snapshots. @@ -221,7 +221,7 @@ FakeBackendV2 initializer. -`qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend.py "view source code") +`qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)` This is a dummy backend just for testing purposes. @@ -234,7 +234,7 @@ FakeBackend initializer. -`qiskit.providers.fake_provider.FakeQasmBackend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_qasm_backend.py "view source code") +`qiskit.providers.fake_provider.FakeQasmBackend` A fake OpenQASM backend. @@ -247,7 +247,7 @@ FakeBackend initializer. -`qiskit.providers.fake_provider.FakePulseBackend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_pulse_backend.py "view source code") +`qiskit.providers.fake_provider.FakePulseBackend` A fake pulse backend. diff --git a/docs/api/qiskit/providers_models.md b/docs/api/qiskit/providers_models.md index 0816d35370..300163de1f 100644 --- a/docs/api/qiskit/providers_models.md +++ b/docs/api/qiskit/providers_models.md @@ -24,16 +24,16 @@ Qiskit schema-conformant objects used by the backends and providers. | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`BackendConfiguration`](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")(backend\_name, ...\[, ...]) | Backwards compat shim representing an abstract backend configuration. | -| [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")(backend\_name, ...) | Class representing backend properties | -| [`BackendStatus`](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus")(backend\_name, backend\_version, ...) | Class representing Backend Status. | -| [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.QasmBackendConfiguration")(backend\_name, ...) | Class representing an OpenQASM 2.0 Backend Configuration. | -| [`PulseBackendConfiguration`](qiskit.providers.models.PulseBackendConfiguration "qiskit.providers.models.PulseBackendConfiguration")(backend\_name, ...) | Static configuration state for an OpenPulse enabled backend. | -| [`UchannelLO`](qiskit.providers.models.UchannelLO "qiskit.providers.models.UchannelLO")(q, scale) | Class representing a U Channel LO | -| [`GateConfig`](qiskit.providers.models.GateConfig "qiskit.providers.models.GateConfig")(name, parameters, qasm\_def\[, ...]) | Class representing a Gate Configuration | -| [`PulseDefaults`](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults")(qubit\_freq\_est, meas\_freq\_est, ...) | Description of default settings for Pulse systems. | -| [`Command`](qiskit.providers.models.Command "qiskit.providers.models.Command")(name\[, qubits, sequence]) | Class representing a Command. | -| [`JobStatus`](qiskit.providers.models.JobStatus "qiskit.providers.models.JobStatus")(job\_id, status, status\_msg, \*\*kwargs) | Model for JobStatus. | -| [`GateProperties`](qiskit.providers.models.GateProperties "qiskit.providers.models.GateProperties")(qubits, gate, parameters, ...) | Class representing a gate's properties | -| [`Nduv`](qiskit.providers.models.Nduv "qiskit.providers.models.Nduv")(date, name, unit, value) | Class representing name-date-unit-value | +| [`BackendConfiguration`](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")(backend\_name, ...\[, ...]) | Backwards compat shim representing an abstract backend configuration. | +| [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")(backend\_name, ...) | Class representing backend properties | +| [`BackendStatus`](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus")(backend\_name, backend\_version, ...) | Class representing Backend Status. | +| [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.QasmBackendConfiguration")(backend\_name, ...) | Class representing an OpenQASM 2.0 Backend Configuration. | +| [`PulseBackendConfiguration`](qiskit.providers.models.PulseBackendConfiguration "qiskit.providers.models.PulseBackendConfiguration")(backend\_name, ...) | Static configuration state for an OpenPulse enabled backend. | +| [`UchannelLO`](qiskit.providers.models.UchannelLO "qiskit.providers.models.UchannelLO")(q, scale) | Class representing a U Channel LO | +| [`GateConfig`](qiskit.providers.models.GateConfig "qiskit.providers.models.GateConfig")(name, parameters, qasm\_def\[, ...]) | Class representing a Gate Configuration | +| [`PulseDefaults`](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults")(qubit\_freq\_est, meas\_freq\_est, ...) | Description of default settings for Pulse systems. | +| [`Command`](qiskit.providers.models.Command "qiskit.providers.models.Command")(name\[, qubits, sequence]) | Class representing a Command. | +| [`JobStatus`](qiskit.providers.models.JobStatus "qiskit.providers.models.JobStatus")(job\_id, status, status\_msg, \*\*kwargs) | Model for JobStatus. | +| [`GateProperties`](qiskit.providers.models.GateProperties "qiskit.providers.models.GateProperties")(qubits, gate, parameters, ...) | Class representing a gate's properties | +| [`Nduv`](qiskit.providers.models.Nduv "qiskit.providers.models.Nduv")(date, name, unit, value) | Class representing name-date-unit-value | diff --git a/docs/api/qiskit/pulse.md b/docs/api/qiskit/pulse.md index bb1e51c191..7dda2f3cac 100644 --- a/docs/api/qiskit/pulse.md +++ b/docs/api/qiskit/pulse.md @@ -56,24 +56,24 @@ An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.puls | | | | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, ...]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | -| [`Reference`](qiskit.pulse.instructions.Reference "qiskit.pulse.instructions.Reference")(name, \*extra\_keys) | Pulse compiler directive that refers to a subroutine. | -| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`RelativeBarrier`](qiskit.pulse.instructions.RelativeBarrier "qiskit.pulse.instructions.RelativeBarrier")(\*channels\[, name]) | Pulse `RelativeBarrier` directive. | -| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | -| [`SetPhase`](qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | -| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | -| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | -| [`TimeBlockade`](qiskit.pulse.instructions.TimeBlockade "qiskit.pulse.instructions.TimeBlockade")(duration, channel\[, name]) | Pulse `TimeBlockade` directive. | +| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, ...]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | +| [`Reference`](qiskit.pulse.instructions.Reference "qiskit.pulse.instructions.Reference")(name, \*extra\_keys) | Pulse compiler directive that refers to a subroutine. | +| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`RelativeBarrier`](qiskit.pulse.instructions.RelativeBarrier "qiskit.pulse.instructions.RelativeBarrier")(\*channels\[, name]) | Pulse `RelativeBarrier` directive. | +| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | +| [`SetPhase`](qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | +| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same [`Channel`](#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel"). | +| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| [`TimeBlockade`](qiskit.pulse.instructions.TimeBlockade "qiskit.pulse.instructions.TimeBlockade")(duration, channel\[, name]) | Pulse `TimeBlockade` directive. | These are all instances of the same base class: -`qiskit.pulse.instructions.Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/instruction.py "view source code") +`qiskit.pulse.instructions.Instruction(operands, name=None)` The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -106,9 +106,9 @@ In contrast, the [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pu | | | | ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform")(samples\[, name, epsilon, ...]) | A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. | -| [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.SymbolicPulse")(pulse\_type, duration\[, ...]) | The pulse representation model with parameters and symbolic expressions. | -| [`ParametricPulse`](qiskit.pulse.library.ParametricPulse "qiskit.pulse.library.ParametricPulse")(duration\[, name, ...]) | The abstract superclass for parametric pulses. | +| [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform")(samples\[, name, epsilon, ...]) | A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. | +| [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.SymbolicPulse")(pulse\_type, duration\[, ...]) | The pulse representation model with parameters and symbolic expressions. | +| [`ParametricPulse`](qiskit.pulse.library.ParametricPulse "qiskit.pulse.library.ParametricPulse")(duration\[, name, ...]) | The abstract superclass for parametric pulses. | @@ -116,7 +116,7 @@ In contrast, the [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pu -`qiskit.pulse.library.constant(duration, amp, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.constant(duration, amp, name=None)` Generates constant-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -142,7 +142,7 @@ $$ -`qiskit.pulse.library.zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.zero(duration, name=None)` Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -167,7 +167,7 @@ $$ -`qiskit.pulse.library.square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.square(duration, amp, freq=None, phase=0, name=None)` Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -197,7 +197,7 @@ with the convention $\text{sign}(0) = 1$. -`qiskit.pulse.library.sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sawtooth(duration, amp, freq=None, phase=0, name=None)` Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -244,7 +244,7 @@ plt.show() -`qiskit.pulse.library.triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.triangle(duration, amp, freq=None, phase=0, name=None)` Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -291,7 +291,7 @@ plt.show() -`qiskit.pulse.library.cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.cos(duration, amp, freq=None, phase=0, name=None)` Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -319,7 +319,7 @@ $$ -`qiskit.pulse.library.sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sin(duration, amp, freq=None, phase=0, name=None)` Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -347,7 +347,7 @@ $$ -`qiskit.pulse.library.gaussian(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian(duration, amp, sigma, name=None, zero_ends=True)` Generates unnormalized gaussian [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -387,7 +387,7 @@ Integrated area under the full curve is `amp * np.sqrt(2*np.pi*sigma**2)` -`qiskit.pulse.library.gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian_deriv(duration, amp, sigma, name=None)` Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -417,7 +417,7 @@ i.e. the derivative of the Gaussian function, with center $\mu=$ `duration/2`. -`qiskit.pulse.library.sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sech(duration, amp, sigma, name=None, zero_ends=True)` Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -455,7 +455,7 @@ where $y^*$ is the value of the endpoint samples. This sets the endpoints to $0$ -`qiskit.pulse.library.sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.sech_deriv(duration, amp, sigma, name=None)` Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -463,8 +463,6 @@ For $A=$ `amp`, $\sigma=$ `sigma`, and center $\mu=$ `duration/2`, applies the m $$ f(x) = \frac{d}{dx}\left[A\text{sech}\left(\frac{x-\mu}{\sigma} \right)\right], - - $$ i.e. the derivative of $\text{sech}$. @@ -486,18 +484,18 @@ i.e. the derivative of $\text{sech}$. -`qiskit.pulse.library.gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). For $d=$ `duration`, $A=$ `amp`, $\sigma=$ `sigma`, and $r=$ `risefall`, applies the `midpoint` sampling strategy to generate a discrete pulse sampled from the continuous function: $$ -f(x) = \begin{cases} +\begin{split}f(x) = \begin{cases} g(x - r) ) & x\leq r \\ A & r\leq x\leq d-r \\ g(x - (d - r)) & d-r\leq x - \end{cases} + \end{cases}\end{split} $$ where $g(x)$ is the Gaussian function sampled from in [`gaussian()`](#qiskit.pulse.library.gaussian "qiskit.pulse.library.gaussian") with $A=$ `amp`, $\mu=1$, and $\sigma=$ `sigma`. I.e. $f(x)$ represents a square pulse with smooth Gaussian edges. @@ -528,7 +526,7 @@ If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [` -`qiskit.pulse.library.drag(duration, amp, sigma, beta, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/discrete.py "view source code") +`qiskit.pulse.library.drag(duration, amp, sigma, beta, name=None, zero_ends=True)` Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform") for standard nonlinear oscillator (SNO) \[1]. @@ -569,20 +567,20 @@ If `zero_ends == True`, the samples from $g(x)$ are remapped as in [`gaussian()` | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`Constant`](qiskit.pulse.library.Constant_class.rst#qiskit.pulse.library.Constant "qiskit.pulse.library.Constant")(duration, amp\[, angle, name, ...]) | A simple constant pulse, with an amplitude value and a duration: | -| [`Drag`](qiskit.pulse.library.Drag_class.rst#qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, angle, ...]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. | -| [`Gaussian`](qiskit.pulse.library.Gaussian_class.rst#qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, angle, ...]) | A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | -| [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma\[, ...]) | A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. | -| [`GaussianSquareDrag`](qiskit.pulse.library.GaussianSquareDrag "qiskit.pulse.library.GaussianSquareDrag")(duration, amp, sigma, beta) | A square pulse with a Drag shaped rise and fall | -| [`gaussian_square_echo`](qiskit.pulse.library.gaussian_square_echo "qiskit.pulse.library.gaussian_square_echo")(duration, amp, sigma\[, ...]) | An echoed Gaussian square pulse with an active tone overlaid on it. | -| [`GaussianDeriv`](qiskit.pulse.library.GaussianDeriv "qiskit.pulse.library.GaussianDeriv")(duration, amp, sigma\[, angle, ...]) | An unnormalized Gaussian derivative pulse. | -| [`Sin`](qiskit.pulse.library.Sin_class.rst#qiskit.pulse.library.Sin "qiskit.pulse.library.Sin")(duration, amp, phase\[, freq, angle, ...]) | A sinusoidal pulse. | -| [`Cos`](qiskit.pulse.library.Cos_class.rst#qiskit.pulse.library.Cos "qiskit.pulse.library.Cos")(duration, amp, phase\[, freq, angle, ...]) | A cosine pulse. | -| [`Sawtooth`](qiskit.pulse.library.Sawtooth_class.rst#qiskit.pulse.library.Sawtooth "qiskit.pulse.library.Sawtooth")(duration, amp, phase\[, freq, ...]) | A sawtooth pulse. | -| [`Triangle`](qiskit.pulse.library.Triangle_class.rst#qiskit.pulse.library.Triangle "qiskit.pulse.library.Triangle")(duration, amp, phase\[, freq, ...]) | A triangle wave pulse. | -| [`Square`](qiskit.pulse.library.Square_fun.rst#qiskit.pulse.library.Square "qiskit.pulse.library.Square")(duration, amp, phase\[, freq, angle, ...]) | A square wave pulse. | -| [`Sech`](qiskit.pulse.library.Sech_fun.rst#qiskit.pulse.library.Sech "qiskit.pulse.library.Sech")(duration, amp, sigma\[, angle, name, ...]) | An unnormalized sech pulse. | -| [`SechDeriv`](qiskit.pulse.library.SechDeriv "qiskit.pulse.library.SechDeriv")(duration, amp, sigma\[, angle, ...]) | An unnormalized sech derivative pulse. | +| [`Constant`](qiskit.pulse.library.Constant_class.rst#qiskit.pulse.library.Constant "qiskit.pulse.library.Constant")(duration, amp\[, angle, name, ...]) | A simple constant pulse, with an amplitude value and a duration: | +| [`Drag`](qiskit.pulse.library.Drag_class.rst#qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, angle, ...]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component and lifting applied. | +| [`Gaussian`](qiskit.pulse.library.Gaussian_class.rst#qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, angle, ...]) | A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | +| [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma\[, ...]) | A square pulse with a Gaussian shaped risefall on both sides lifted such that its first sample is zero. | +| [`GaussianSquareDrag`](qiskit.pulse.library.GaussianSquareDrag "qiskit.pulse.library.GaussianSquareDrag")(duration, amp, sigma, beta) | A square pulse with a Drag shaped rise and fall | +| [`gaussian_square_echo`](qiskit.pulse.library.gaussian_square_echo "qiskit.pulse.library.gaussian_square_echo")(duration, amp, sigma\[, ...]) | An echoed Gaussian square pulse with an active tone overlaid on it. | +| [`GaussianDeriv`](qiskit.pulse.library.GaussianDeriv "qiskit.pulse.library.GaussianDeriv")(duration, amp, sigma\[, angle, ...]) | An unnormalized Gaussian derivative pulse. | +| [`Sin`](qiskit.pulse.library.Sin_class.rst#qiskit.pulse.library.Sin "qiskit.pulse.library.Sin")(duration, amp, phase\[, freq, angle, ...]) | A sinusoidal pulse. | +| [`Cos`](qiskit.pulse.library.Cos_class.rst#qiskit.pulse.library.Cos "qiskit.pulse.library.Cos")(duration, amp, phase\[, freq, angle, ...]) | A cosine pulse. | +| [`Sawtooth`](qiskit.pulse.library.Sawtooth_class.rst#qiskit.pulse.library.Sawtooth "qiskit.pulse.library.Sawtooth")(duration, amp, phase\[, freq, ...]) | A sawtooth pulse. | +| [`Triangle`](qiskit.pulse.library.Triangle_class.rst#qiskit.pulse.library.Triangle "qiskit.pulse.library.Triangle")(duration, amp, phase\[, freq, ...]) | A triangle wave pulse. | +| [`Square`](qiskit.pulse.library.Square_fun.rst#qiskit.pulse.library.Square "qiskit.pulse.library.Square")(duration, amp, phase\[, freq, angle, ...]) | A square wave pulse. | +| [`Sech`](qiskit.pulse.library.Sech_fun.rst#qiskit.pulse.library.Sech "qiskit.pulse.library.Sech")(duration, amp, sigma\[, angle, name, ...]) | An unnormalized sech pulse. | +| [`SechDeriv`](qiskit.pulse.library.SechDeriv "qiskit.pulse.library.SechDeriv")(duration, amp, sigma\[, angle, ...]) | An unnormalized sech derivative pulse. | @@ -608,19 +606,19 @@ Novel channel types can often utilize the [`ControlChannel`](qiskit.pulse.channe | | | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`DriveChannel`](qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel")(\*args, \*\*kwargs) | Drive channels transmit signals to qubits which enact gate operations. | -| [`MeasureChannel`](qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel")(\*args, \*\*kwargs) | Measure channels transmit measurement stimulus pulses for readout. | -| [`AcquireChannel`](qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")(\*args, \*\*kwargs) | Acquire channels are used to collect data. | -| [`ControlChannel`](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")(\*args, \*\*kwargs) | Control channels provide supplementary control over the qubit to the drive channel. | -| [`RegisterSlot`](qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")(\*args, \*\*kwargs) | Classical resister slot channels represent classical registers (low-latency classical memory). | -| [`MemorySlot`](qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")(\*args, \*\*kwargs) | Memory slot channels represent classical memory storage. | -| [`SnapshotChannel`](qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel")(\*args, \*\*kwargs) | Snapshot channels are used to specify instructions for simulators. | +| [`DriveChannel`](qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel")(\*args, \*\*kwargs) | Drive channels transmit signals to qubits which enact gate operations. | +| [`MeasureChannel`](qiskit.pulse.channels.MeasureChannel "qiskit.pulse.channels.MeasureChannel")(\*args, \*\*kwargs) | Measure channels transmit measurement stimulus pulses for readout. | +| [`AcquireChannel`](qiskit.pulse.channels.AcquireChannel "qiskit.pulse.channels.AcquireChannel")(\*args, \*\*kwargs) | Acquire channels are used to collect data. | +| [`ControlChannel`](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channels.ControlChannel")(\*args, \*\*kwargs) | Control channels provide supplementary control over the qubit to the drive channel. | +| [`RegisterSlot`](qiskit.pulse.channels.RegisterSlot "qiskit.pulse.channels.RegisterSlot")(\*args, \*\*kwargs) | Classical resister slot channels represent classical registers (low-latency classical memory). | +| [`MemorySlot`](qiskit.pulse.channels.MemorySlot "qiskit.pulse.channels.MemorySlot")(\*args, \*\*kwargs) | Memory slot channels represent classical memory storage. | +| [`SnapshotChannel`](qiskit.pulse.channels.SnapshotChannel "qiskit.pulse.channels.SnapshotChannel")(\*args, \*\*kwargs) | Snapshot channels are used to specify instructions for simulators. | All channels are children of the same abstract base class: -`qiskit.pulse.channels.Channel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.Channel(*args, **kwargs)` 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. @@ -642,8 +640,8 @@ Schedules are Pulse programs. They describe instruction sequences for the contro | | | | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule")(\*schedules\[, name, metadata]) | A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. | -| [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")(\[name, metadata, ...]) | Time-ordered sequence of instructions with alignment context. | +| [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule")(\*schedules\[, name, metadata]) | A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. | +| [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")(\[name, metadata, ...]) | Time-ordered sequence of instructions with alignment context. | @@ -666,7 +664,7 @@ The alignment transforms define alignment policies of instructions in [`Schedule | | | | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | | [`AlignEquispaced`](qiskit.pulse.transforms.AlignEquispaced "qiskit.pulse.transforms.AlignEquispaced")(duration) | Align instructions with equispaced interval within a specified duration. | -| [`AlignFunc`](qiskit.pulse.transforms.AlignFunc "qiskit.pulse.transforms.AlignFunc")(duration, func) | Allocate instructions at position specified by callback function. | +| [`AlignFunc`](qiskit.pulse.transforms.AlignFunc "qiskit.pulse.transforms.AlignFunc")(duration, func) | Allocate instructions at position specified by callback function. | | [`AlignLeft`](qiskit.pulse.transforms.AlignLeft "qiskit.pulse.transforms.AlignLeft")() | Align instructions in as-soon-as-possible manner. | | [`AlignRight`](qiskit.pulse.transforms.AlignRight "qiskit.pulse.transforms.AlignRight")() | Align instructions in as-late-as-possible manner. | | [`AlignSequential`](qiskit.pulse.transforms.AlignSequential "qiskit.pulse.transforms.AlignSequential")() | Align instructions sequentially. | @@ -675,7 +673,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`qiskit.pulse.transforms.AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignmentKind(context_params)` An abstract class for schedule alignment. @@ -689,7 +687,7 @@ The canonicalization transforms convert schedules to a form amenable for executi -`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)` Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. @@ -712,7 +710,7 @@ A `Schedule` with the additional acquisition instructions. -`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` Return new schedules where measurements occur at the same physical time. @@ -779,7 +777,7 @@ The input list of schedules transformed to have their measurements aligned. -`qiskit.pulse.transforms.block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.block_to_schedule(block)` Convert `ScheduleBlock` to `Schedule`. @@ -806,7 +804,7 @@ Scheduled pulse program. -`qiskit.pulse.transforms.compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.compress_pulses(schedules)` Optimization pass to replace identical pulses. @@ -824,7 +822,7 @@ Compressed schedules. -`qiskit.pulse.transforms.flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.flatten(program)` Flatten (inline) any called nodes into a Schedule tree with no nested children. @@ -846,7 +844,7 @@ Flatten pulse program. -`qiskit.pulse.transforms.inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.inline_subroutines(program)` Recursively remove call instructions and inline the respective subroutine instructions. @@ -870,7 +868,7 @@ A schedule without subroutine. -`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)` Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. @@ -896,7 +894,7 @@ The padded schedule. -`qiskit.pulse.transforms.remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_directives(schedule)` Remove directives. @@ -914,7 +912,7 @@ A schedule without directives. -`qiskit.pulse.transforms.remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/canonicalization.py "view source code") +`qiskit.pulse.transforms.remove_trivial_barriers(schedule)` Remove trivial barriers with 0 or 1 channels. @@ -938,7 +936,7 @@ The DAG transforms create DAG representation of input program. This can be used -`qiskit.pulse.transforms.block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/dag.py "view source code") +`qiskit.pulse.transforms.block_to_dag(block)` Convert schedule block instruction into DAG. @@ -996,7 +994,7 @@ A sequence of transformations to generate a target code. -`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/base_transforms.py "view source code") +`qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)` A basic pulse program transformation for OpenPulse API execution. @@ -1207,7 +1205,7 @@ The above is just a small taste of what is possible with the builder. See the re -`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` Create a context manager for launching the imperative pulse builder DSL. @@ -1269,7 +1267,7 @@ DriveChannel(0) -`qiskit.pulse.builder.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire_channel(qubit)` Return `AcquireChannel` for `qubit` on the active builder backend. @@ -1295,7 +1293,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.control_channels(*qubits)` Return `ControlChannel` for `qubit` on the active builder backend. @@ -1330,7 +1328,7 @@ List of control channels associated with the supplied ordered list of qubits. -`qiskit.pulse.builder.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.drive_channel(qubit)` Return `DriveChannel` for `qubit` on the active builder backend. @@ -1356,7 +1354,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_channel(qubit)` Return `MeasureChannel` for `qubit` on the active builder backend. @@ -1415,7 +1413,7 @@ drive_sched.draw() -`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)` Acquire for a `duration` on a `channel` and store the result in a `register`. @@ -1452,7 +1450,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)` Barrier directive for a set of channels and qubits. @@ -1519,7 +1517,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)` Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. @@ -1733,7 +1731,7 @@ ScheduleBlock( -`qiskit.pulse.builder.delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay(duration, channel, name=None)` Delay on a `channel` for a `duration`. @@ -1756,7 +1754,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.play(pulse, channel, name=None)` Play a `pulse` on a `channel`. @@ -1779,7 +1777,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.reference(name, *extra_keys)` Refer to undefined subroutine by string keys. @@ -1804,7 +1802,7 @@ main_prog.assign_references(subroutine_dict={("x_gate", "q0"): subroutine}) -`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_frequency(frequency, channel, name=None)` Set the `frequency` of a pulse `channel`. @@ -1827,7 +1825,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.set_phase(phase, channel, name=None)` Set the `phase` of a pulse `channel`. @@ -1852,7 +1850,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)` Shift the `frequency` of a pulse `channel`. @@ -1875,7 +1873,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.shift_phase(phase, channel, name=None)` Shift the `phase` of a pulse `channel`. @@ -1900,7 +1898,7 @@ with pulse.build() as pulse_prog: -`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')` Simulator snapshot. @@ -1942,7 +1940,7 @@ pulse_prog.draw() -`qiskit.pulse.builder.align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_equispaced(duration)` Equispaced alignment pulse scheduling context. @@ -1988,7 +1986,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_func(duration, func)` Callback defined alignment pulse scheduling context. @@ -2040,7 +2038,7 @@ The scheduling is performed for sub-schedules within the context rather than cha -`qiskit.pulse.builder.align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_left()` Left alignment pulse scheduling context. @@ -2075,7 +2073,7 @@ None -`qiskit.pulse.builder.align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_right()` Right alignment pulse scheduling context. @@ -2110,7 +2108,7 @@ None -`qiskit.pulse.builder.align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.align_sequential()` Sequential alignment pulse scheduling context. @@ -2145,7 +2143,7 @@ None -`qiskit.pulse.builder.circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.circuit_scheduler_settings(**settings)` Set the currently active circuit scheduler settings for this context. @@ -2174,7 +2172,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)` Shift the frequency of inputs channels on entry into context and undo on exit. @@ -2218,7 +2216,7 @@ None -`qiskit.pulse.builder.phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.phase_offset(phase, *channels)` Shift the phase of input channels on entry into context and undo on exit. @@ -2253,7 +2251,7 @@ None -`qiskit.pulse.builder.transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.transpiler_settings(**settings)` Set the currently active transpiler settings for this context. @@ -2301,7 +2299,7 @@ MemorySlot(0) -`qiskit.pulse.builder.measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure(qubits, registers=None)` Measure a qubit within the currently active builder context. @@ -2356,7 +2354,7 @@ The `register` the qubit measurement result will be stored in. -`qiskit.pulse.builder.measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.measure_all()` Measure all qubits within the currently active builder context. @@ -2389,7 +2387,7 @@ The `register`s the qubit measurement results will be stored in. -`qiskit.pulse.builder.delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.delay_qubits(duration, *qubits)` Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. @@ -2437,7 +2435,7 @@ with pulse.build(backend) as u3_sched: -`qiskit.pulse.builder.cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.cx(control, target)` Call a `CXGate` on the input physical qubits. @@ -2459,7 +2457,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.u1(theta, qubit)` Call a `U1Gate` on the input physical qubit. @@ -2483,7 +2481,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.u2(phi, lam, qubit)` Call a `U2Gate` on the input physical qubit. @@ -2507,7 +2505,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.u3(theta, phi, lam, qubit)` Call a `U3Gate` on the input physical qubit. @@ -2531,7 +2529,7 @@ with pulse.build(backend) as pulse_prog: -`qiskit.pulse.builder.x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.x(qubit)` Call a `XGate` on the input physical qubit. @@ -2582,7 +2580,7 @@ There are 1e-06 seconds in 4500 samples. -`qiskit.pulse.builder.active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_backend()` Get the backend of the currently active builder context. @@ -2602,7 +2600,7 @@ builder context. -`qiskit.pulse.builder.active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_transpiler_settings()` Return the current active builder context’s transpiler settings. @@ -2631,7 +2629,7 @@ with pulse.build(backend, -`qiskit.pulse.builder.active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.active_circuit_scheduler_settings()` Return the current active builder context’s circuit scheduler settings. @@ -2661,7 +2659,7 @@ with pulse.build( -`qiskit.pulse.builder.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.num_qubits()` Return number of qubits in the currently active backend. @@ -2691,7 +2689,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.qubit_channels(qubit)` Returns the set of channels associated with a qubit. @@ -2725,7 +2723,7 @@ with pulse.build(backend): -`qiskit.pulse.builder.samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.samples_to_seconds(samples)` Obtain the time in seconds that will elapse for the input number of samples on the active backend. @@ -2743,7 +2741,7 @@ The time that elapses in `samples`. -`qiskit.pulse.builder.seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/builder.py "view source code") +`qiskit.pulse.builder.seconds_to_samples(seconds)` Obtain the number of samples that will elapse in `seconds` on the active backend. @@ -2771,7 +2769,7 @@ The number of samples for the time to elapse -`qiskit.pulse.PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.PulseError(*message)` Errors raised by the pulse module. @@ -2779,7 +2777,7 @@ Set the error message. -`qiskit.pulse.BackendNotSet(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.BackendNotSet(*message)` Raised if the builder context does not have a backend. @@ -2787,7 +2785,7 @@ Set the error message. -`qiskit.pulse.NoActiveBuilder(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.NoActiveBuilder(*message)` Raised if no builder context is active. @@ -2795,7 +2793,7 @@ Set the error message. -`qiskit.pulse.UnassignedDurationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedDurationError(*message)` Raised if instruction duration is unassigned. @@ -2803,7 +2801,7 @@ Set the error message. -`qiskit.pulse.UnassignedReferenceError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/exceptions.py "view source code") +`qiskit.pulse.UnassignedReferenceError(*message)` Raised if subroutine is unassigned. diff --git a/docs/api/qiskit/qasm.md b/docs/api/qiskit/qasm.md index 6f48b00437..782ae0c45d 100644 --- a/docs/api/qiskit/qasm.md +++ b/docs/api/qiskit/qasm.md @@ -22,7 +22,7 @@ python_api_name: qiskit.qasm -`qiskit.qasm.Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/qasm.py "view source code") +`qiskit.qasm.Qasm(filename=None, data=None)` OPENQASM circuit object. @@ -32,19 +32,19 @@ Create an OPENQASM circuit object. -`qiskit.qasm.OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.OpenQASMLexer(*args, **kwds)` A pygments lexer for OpenQasm. -`qiskit.qasm.QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.QasmHTMLStyle` A style for OpenQasm in a HTML env (e.g. Jupyter widget). -`qiskit.qasm.QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm/pygments/lexer.py "view source code") +`qiskit.qasm.QasmTerminalStyle` A style for OpenQasm in a Terminal env (e.g. Jupyter print). diff --git a/docs/api/qiskit/qasm2.md b/docs/api/qiskit/qasm2.md index a14b1a94bc..24f36928b8 100644 --- a/docs/api/qiskit/qasm2.md +++ b/docs/api/qiskit/qasm2.md @@ -32,7 +32,7 @@ This module contains two public functions, both of which create a [`QuantumCircu -`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)` Parse an OpenQASM 2 program from a file into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). The given path should be ASCII or UTF-8 encoded, and contain the OpenQASM 2 program. @@ -55,7 +55,7 @@ A circuit object representing the same OpenQASM 2 program. -`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/__init__.py "view source code") +`qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)` Parse an OpenQASM 2 program from a string into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). @@ -85,7 +85,7 @@ You can extend the quantum components of the OpenQASM 2 language by passing an i -`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/parse.py "view source code") +`qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)` Information about a custom instruction that should be defined during the parse. @@ -123,7 +123,7 @@ Similar to other serialisation modules in Python, this module offers two public -`qiskit.qasm2.dump(circuit, filename_or_stream, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/export.py "view source code") +`qiskit.qasm2.dump(circuit, filename_or_stream, /)` Dump a circuit as an OpenQASM 2 program to a file or stream. @@ -138,7 +138,7 @@ Dump a circuit as an OpenQASM 2 program to a file or stream. -`qiskit.qasm2.dumps(circuit, /)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/export.py "view source code") +`qiskit.qasm2.dumps(circuit, /)` Export a circuit to an OpenQASM 2 program in a string. @@ -164,7 +164,7 @@ This module defines a generic error type that derives from [`QiskitError`](excep -`qiskit.qasm2.QASM2Error(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2Error(*message)` A general error raised by the OpenQASM 2 interoperation layer. @@ -174,7 +174,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the -`qiskit.qasm2.QASM2ParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ParseError(*message)` An error raised because of a failure to parse an OpenQASM 2 file. @@ -184,7 +184,7 @@ When the exporters fail to export a circuit, likely because it has structure tha -`qiskit.qasm2.QASM2ExportError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm2/exceptions.py "view source code") +`qiskit.qasm2.QASM2ExportError(*message)` An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form. diff --git a/docs/api/qiskit/qasm3.md b/docs/api/qiskit/qasm3.md index 8897dc6e3c..ca5ff2721c 100644 --- a/docs/api/qiskit/qasm3.md +++ b/docs/api/qiskit/qasm3.md @@ -26,7 +26,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3. -`qiskit.qasm3.dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dump(circuit, stream, **kwargs)` Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as an OpenQASM 3 stream to file-like object. @@ -38,7 +38,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua -`qiskit.qasm3.dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.dumps(circuit, **kwargs)` Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM 3 string. @@ -59,7 +59,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor -`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/exporter.py "view source code") +`qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent='  ', experimental=ExperimentalFeatures.None)` QASM3 exporter main class. @@ -111,7 +111,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp -`qiskit.qasm3.QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ExporterError(*message)` An error raised during running the OpenQASM 3 exporter. @@ -123,7 +123,7 @@ The OpenQASM 3 language is still evolving as hardware capabilities improve, so t -`qiskit.qasm3.ExperimentalFeatures(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/experimental.py "view source code") +`qiskit.qasm3.ExperimentalFeatures(value)` Flags for experimental features that the OpenQASM 3 exporter supports. @@ -161,7 +161,7 @@ qasm_string = qasm3.dumps(qc, experimental=qasm3.ExperimentalFeatures.SWITCH_CAS ``` - All features enabled by the experimental flags are naturally transient. If it becomes necessary to remove flags, they will be subject to [the standard Qiskit deprecation policy](https://github.com/Qiskit/qiskit/blob/main/DEPRECATION.md). We will leave these experimental flags in place for as long as is reasonable. + All features enabled by the experimental flags are naturally transient. If it becomes necessary to remove flags, they will be subject to [the standard Qiskit deprecation policy](https://qiskit.org/documentation/deprecation_policy.html). We will leave these experimental flags in place for as long as is reasonable. However, we cannot guarantee any support windows for *consumers* of OpenQASM 3 code generated using these experimental flags, if the OpenQASM 3 language specification changes the proposal that the flag is based on. It is possible that any tool you are using to consume OpenQASM 3 code created using these flags may update or remove their support while Qiskit continues to offer the flag. You should not rely on the resultant experimental OpenQASM 3 code for long-term storage of programs. @@ -182,7 +182,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor -`qiskit.qasm3.load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.load(filename)` Load an OpenQASM 3 program from the file `filename`. @@ -204,7 +204,7 @@ a circuit representation of the OpenQASM 3 program. -`qiskit.qasm3.loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/__init__.py "view source code") +`qiskit.qasm3.loads(program)` Load an OpenQASM 3 program from the given string. @@ -228,7 +228,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo -`qiskit.qasm3.QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qasm3/exceptions.py "view source code") +`qiskit.qasm3.QASM3ImporterError(*message)` An error raised during the OpenQASM 3 importer. diff --git a/docs/api/qiskit/qiskit.algorithms.AlgorithmJob.md b/docs/api/qiskit/qiskit.algorithms.AlgorithmJob.md index de4979fcd9..64667888e0 100644 --- a/docs/api/qiskit/qiskit.algorithms.AlgorithmJob.md +++ b/docs/api/qiskit/qiskit.algorithms.AlgorithmJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AlgorithmJob -`qiskit.algorithms.AlgorithmJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/algorithm_job.py "view source code") +`qiskit.algorithms.AlgorithmJob(function, *args, **kwargs)` Bases: `PrimitiveJob` diff --git a/docs/api/qiskit/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/qiskit.algorithms.AmplificationProblem.md index 917231f57c..802cd0410a 100644 --- a/docs/api/qiskit/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/qiskit.algorithms.AmplificationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplificationProblem -`qiskit.algorithms.AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") +`qiskit.algorithms.AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/qiskit.algorithms.AmplitudeAmplifier.md index dc53ceaf23..90389ca685 100644 --- a/docs/api/qiskit/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/qiskit.algorithms.AmplitudeAmplifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeAmplifier -`qiskit.algorithms.AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") +`qiskit.algorithms.AmplitudeAmplifier` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimation.md index b4e20928d5..0ba0292978 100644 --- a/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimation -`qiskit.algorithms.AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`qiskit.algorithms.AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)` Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimationResult.md index edd0e27263..44c192cfa4 100644 --- a/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimationResult -`qiskit.algorithms.AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/ae.py "view source code") +`qiskit.algorithms.AmplitudeEstimationResult` Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimator.md index 4051be0e33..e0b11b6597 100644 --- a/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimator -`qiskit.algorithms.AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`qiskit.algorithms.AmplitudeEstimator` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimatorResult.md index 4d0d6eb321..9f8f3c430e 100644 --- a/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.AmplitudeEstimatorResult -`qiskit.algorithms.AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") +`qiskit.algorithms.AmplitudeEstimatorResult` Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/qiskit.algorithms.Eigensolver.md index a9498e8a8a..dcfce446f1 100644 --- a/docs/api/qiskit/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/qiskit.algorithms.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Eigensolver -`qiskit.algorithms.Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`qiskit.algorithms.Eigensolver` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/qiskit.algorithms.EigensolverResult.md index 9c18a62150..3b667b014a 100644 --- a/docs/api/qiskit/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/qiskit.algorithms.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EigensolverResult -`qiskit.algorithms.EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") +`qiskit.algorithms.EigensolverResult` Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/qiskit.algorithms.EstimationProblem.md index c6164dcfff..bca5afa1b5 100644 --- a/docs/api/qiskit/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/qiskit.algorithms.EstimationProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EstimationProblem -`qiskit.algorithms.EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") +`qiskit.algorithms.EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/qiskit.algorithms.EvolutionProblem.md index 4cb176ff03..3dcdb7093a 100644 --- a/docs/api/qiskit/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/qiskit.algorithms.EvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionProblem -`qiskit.algorithms.EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/evolution_problem.py "view source code") +`qiskit.algorithms.EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/qiskit.algorithms.EvolutionResult.md index 0a5cb85807..6c4d904e69 100644 --- a/docs/api/qiskit/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/qiskit.algorithms.EvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.EvolutionResult -`qiskit.algorithms.EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/evolution_result.py "view source code") +`qiskit.algorithms.EvolutionResult(evolved_state, aux_ops_evaluated=None)` Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/qiskit.algorithms.FasterAmplitudeEstimation.md index 2921afde14..214c012696 100644 --- a/docs/api/qiskit/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimation -`qiskit.algorithms.FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`qiskit.algorithms.FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)` Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 7a7f35d26f..47c972ce6e 100644 --- a/docs/api/qiskit/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult -`qiskit.algorithms.FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/fae.py "view source code") +`qiskit.algorithms.FasterAmplitudeEstimationResult` Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/qiskit.algorithms.Grover.md b/docs/api/qiskit/qiskit.algorithms.Grover.md index 76c8fefcb8..4fd35090c2 100644 --- a/docs/api/qiskit/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/qiskit.algorithms.Grover.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.Grover -`qiskit.algorithms.Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`qiskit.algorithms.Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)` Bases: [`AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") diff --git a/docs/api/qiskit/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/qiskit.algorithms.GroverResult.md index 977d2a9a39..52dbcd44ae 100644 --- a/docs/api/qiskit/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/qiskit.algorithms.GroverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.GroverResult -`qiskit.algorithms.GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") +`qiskit.algorithms.GroverResult` Bases: `AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/qiskit.algorithms.HamiltonianPhaseEstimation.md index 7495769557..a02243cb64 100644 --- a/docs/api/qiskit/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation -`qiskit.algorithms.HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") +`qiskit.algorithms.HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index ece430429e..447e0c0c7a 100644 --- a/docs/api/qiskit/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult -`qiskit.algorithms.HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") +`qiskit.algorithms.HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/qiskit.algorithms.ImaginaryEvolver.md index 72546c03fc..033b9f7233 100644 --- a/docs/api/qiskit/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/qiskit.algorithms.ImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryEvolver -`qiskit.algorithms.ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") +`qiskit.algorithms.ImaginaryEvolver` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.ImaginaryTimeEvolver.md b/docs/api/qiskit/qiskit.algorithms.ImaginaryTimeEvolver.md index e6291e3956..e1ffc4de5f 100644 --- a/docs/api/qiskit/qiskit.algorithms.ImaginaryTimeEvolver.md +++ b/docs/api/qiskit/qiskit.algorithms.ImaginaryTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.ImaginaryTimeEvolver -`qiskit.algorithms.ImaginaryTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") +`qiskit.algorithms.ImaginaryTimeEvolver` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/qiskit.algorithms.IterativeAmplitudeEstimation.md index 70c7dbe6c8..83bfc49e23 100644 --- a/docs/api/qiskit/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation -`qiskit.algorithms.IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`qiskit.algorithms.IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)` Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index b8f98e20d0..52294aaf9e 100644 --- a/docs/api/qiskit/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult -`qiskit.algorithms.IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/iae.py "view source code") +`qiskit.algorithms.IterativeAmplitudeEstimationResult` Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/qiskit.algorithms.IterativePhaseEstimation.md index 1a601c5888..44b3aaf39b 100644 --- a/docs/api/qiskit/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/qiskit.algorithms.IterativePhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.IterativePhaseEstimation -`qiskit.algorithms.IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/ipe.py "view source code") +`qiskit.algorithms.IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)` Bases: `PhaseEstimator` diff --git a/docs/api/qiskit/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 4f71b58c49..d428c982ee 100644 --- a/docs/api/qiskit/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation -`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)` Bases: [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") diff --git a/docs/api/qiskit/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 45df5bbb0c..77612d3493 100644 --- a/docs/api/qiskit/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult -`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") +`qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult` Bases: [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/qiskit.algorithms.MinimumEigensolver.md index 29bb257e00..7abc94bfbb 100644 --- a/docs/api/qiskit/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/qiskit.algorithms.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolver -`qiskit.algorithms.MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`qiskit.algorithms.MinimumEigensolver` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/qiskit.algorithms.MinimumEigensolverResult.md index bdf4d5b8bf..5815494406 100644 --- a/docs/api/qiskit/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/qiskit.algorithms.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.MinimumEigensolverResult -`qiskit.algorithms.MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") +`qiskit.algorithms.MinimumEigensolverResult` Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/qiskit.algorithms.NumPyEigensolver.md index aea3b8f157..574f3ac971 100644 --- a/docs/api/qiskit/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/qiskit.algorithms.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyEigensolver -`qiskit.algorithms.NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") +`qiskit.algorithms.NumPyEigensolver(k=1, filter_criterion=None)` Bases: [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") diff --git a/docs/api/qiskit/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/qiskit.algorithms.NumPyMinimumEigensolver.md index 1727f1dea9..5048fb7d21 100644 --- a/docs/api/qiskit/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.NumPyMinimumEigensolver -`qiskit.algorithms.NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") +`qiskit.algorithms.NumPyMinimumEigensolver(filter_criterion=None)` Bases: [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") diff --git a/docs/api/qiskit/qiskit.algorithms.PVQD.md b/docs/api/qiskit/qiskit.algorithms.PVQD.md index d14c03c1de..6df46a50b1 100644 --- a/docs/api/qiskit/qiskit.algorithms.PVQD.md +++ b/docs/api/qiskit/qiskit.algorithms.PVQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQD -`qiskit.algorithms.PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") +`qiskit.algorithms.PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)` Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/qiskit.algorithms.PVQDResult.md b/docs/api/qiskit/qiskit.algorithms.PVQDResult.md index cf02d72af1..d93c448e22 100644 --- a/docs/api/qiskit/qiskit.algorithms.PVQDResult.md +++ b/docs/api/qiskit/qiskit.algorithms.PVQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PVQDResult -`qiskit.algorithms.PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") +`qiskit.algorithms.PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)` Bases: [`TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") diff --git a/docs/api/qiskit/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/qiskit.algorithms.PhaseEstimation.md index 63b2cd7660..6d0370086a 100644 --- a/docs/api/qiskit/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/qiskit.algorithms.PhaseEstimation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimation -`qiskit.algorithms.PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") +`qiskit.algorithms.PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` Bases: `PhaseEstimator` diff --git a/docs/api/qiskit/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/qiskit.algorithms.PhaseEstimationResult.md index bc306b087e..fa45ebc521 100644 --- a/docs/api/qiskit/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/qiskit.algorithms.PhaseEstimationResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationResult -`qiskit.algorithms.PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") +`qiskit.algorithms.PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` Bases: `PhaseEstimatorResult` diff --git a/docs/api/qiskit/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/qiskit.algorithms.PhaseEstimationScale.md index 486abb9802..945e46e53a 100644 --- a/docs/api/qiskit/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/qiskit.algorithms.PhaseEstimationScale.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.PhaseEstimationScale -`qiskit.algorithms.PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") +`qiskit.algorithms.PhaseEstimationScale(bound)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.QAOA.md b/docs/api/qiskit/qiskit.algorithms.QAOA.md index 5e726cf837..aba8cdad65 100644 --- a/docs/api/qiskit/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/qiskit.algorithms.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.QAOA -`qiskit.algorithms.QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") +`qiskit.algorithms.QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` Bases: [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/qiskit.algorithms.RealEvolver.md index e85bbab6c4..b3a34a59c0 100644 --- a/docs/api/qiskit/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/qiskit.algorithms.RealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealEvolver -`qiskit.algorithms.RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/real_evolver.py "view source code") +`qiskit.algorithms.RealEvolver` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.RealTimeEvolver.md b/docs/api/qiskit/qiskit.algorithms.RealTimeEvolver.md index 8549abdc95..663da96bae 100644 --- a/docs/api/qiskit/qiskit.algorithms.RealTimeEvolver.md +++ b/docs/api/qiskit/qiskit.algorithms.RealTimeEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.RealTimeEvolver -`qiskit.algorithms.RealTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") +`qiskit.algorithms.RealTimeEvolver` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.SciPyImaginaryEvolver.md b/docs/api/qiskit/qiskit.algorithms.SciPyImaginaryEvolver.md index a3253e2dba..6fca4867e1 100644 --- a/docs/api/qiskit/qiskit.algorithms.SciPyImaginaryEvolver.md +++ b/docs/api/qiskit/qiskit.algorithms.SciPyImaginaryEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyImaginaryEvolver -`qiskit.algorithms.SciPyImaginaryEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") +`qiskit.algorithms.SciPyImaginaryEvolver(num_timesteps)` Bases: [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/qiskit.algorithms.SciPyRealEvolver.md b/docs/api/qiskit/qiskit.algorithms.SciPyRealEvolver.md index 7668d8ac2c..353226d342 100644 --- a/docs/api/qiskit/qiskit.algorithms.SciPyRealEvolver.md +++ b/docs/api/qiskit/qiskit.algorithms.SciPyRealEvolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.SciPyRealEvolver -`qiskit.algorithms.SciPyRealEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") +`qiskit.algorithms.SciPyRealEvolver(num_timesteps)` Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/qiskit.algorithms.TimeEvolutionProblem.md b/docs/api/qiskit/qiskit.algorithms.TimeEvolutionProblem.md index d752525d45..5aa0cba5e6 100644 --- a/docs/api/qiskit/qiskit.algorithms.TimeEvolutionProblem.md +++ b/docs/api/qiskit/qiskit.algorithms.TimeEvolutionProblem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionProblem -`qiskit.algorithms.TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") +`qiskit.algorithms.TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.TimeEvolutionResult.md b/docs/api/qiskit/qiskit.algorithms.TimeEvolutionResult.md index 05c79622ae..f206935420 100644 --- a/docs/api/qiskit/qiskit.algorithms.TimeEvolutionResult.md +++ b/docs/api/qiskit/qiskit.algorithms.TimeEvolutionResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TimeEvolutionResult -`qiskit.algorithms.TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") +`qiskit.algorithms.TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)` Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/qiskit.algorithms.TrotterQRTE.md index b640cb7bfc..99d5339eee 100644 --- a/docs/api/qiskit/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/qiskit.algorithms.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.TrotterQRTE -`qiskit.algorithms.TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") +`qiskit.algorithms.TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` Bases: [`RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") diff --git a/docs/api/qiskit/qiskit.algorithms.VQD.md b/docs/api/qiskit/qiskit.algorithms.VQD.md index d01539315f..33c53c4c0b 100644 --- a/docs/api/qiskit/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/qiskit.algorithms.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQD -`qiskit.algorithms.VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`qiskit.algorithms.VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") diff --git a/docs/api/qiskit/qiskit.algorithms.VQDResult.md b/docs/api/qiskit/qiskit.algorithms.VQDResult.md index c03946ee63..368bc3f3ec 100644 --- a/docs/api/qiskit/qiskit.algorithms.VQDResult.md +++ b/docs/api/qiskit/qiskit.algorithms.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQDResult -`qiskit.algorithms.VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigen_solvers/vqd.py "view source code") +`qiskit.algorithms.VQDResult` Bases: `VariationalResult`, [`EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") diff --git a/docs/api/qiskit/qiskit.algorithms.VQE.md b/docs/api/qiskit/qiskit.algorithms.VQE.md index ae44fc557e..177d07a3bd 100644 --- a/docs/api/qiskit/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/qiskit.algorithms.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VQE -`qiskit.algorithms.VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") +`qiskit.algorithms.VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") diff --git a/docs/api/qiskit/qiskit.algorithms.VarQITE.md b/docs/api/qiskit/qiskit.algorithms.VarQITE.md index e9ac9c3692..b8349b440b 100644 --- a/docs/api/qiskit/qiskit.algorithms.VarQITE.md +++ b/docs/api/qiskit/qiskit.algorithms.VarQITE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQITE -`qiskit.algorithms.VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") +`qiskit.algorithms.VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` Bases: `VarQTE`, [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/qiskit.algorithms.VarQRTE.md b/docs/api/qiskit/qiskit.algorithms.VarQRTE.md index 5051acbb1e..dbee210478 100644 --- a/docs/api/qiskit/qiskit.algorithms.VarQRTE.md +++ b/docs/api/qiskit/qiskit.algorithms.VarQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.VarQRTE -`qiskit.algorithms.VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") +`qiskit.algorithms.VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` Bases: `VarQTE`, [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/qiskit.algorithms.eigensolvers.Eigensolver.md b/docs/api/qiskit/qiskit.algorithms.eigensolvers.Eigensolver.md index 25b8ec0448..fceb270f2c 100644 --- a/docs/api/qiskit/qiskit.algorithms.eigensolvers.Eigensolver.md +++ b/docs/api/qiskit/qiskit.algorithms.eigensolvers.Eigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.Eigensolver -`qiskit.algorithms.eigensolvers.Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.Eigensolver` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.eigensolvers.EigensolverResult.md b/docs/api/qiskit/qiskit.algorithms.eigensolvers.EigensolverResult.md index c39d4438a2..9942693c30 100644 --- a/docs/api/qiskit/qiskit.algorithms.eigensolvers.EigensolverResult.md +++ b/docs/api/qiskit/qiskit.algorithms.eigensolvers.EigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult -`qiskit.algorithms.eigensolvers.EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.EigensolverResult` Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/qiskit.algorithms.eigensolvers.NumPyEigensolver.md b/docs/api/qiskit/qiskit.algorithms.eigensolvers.NumPyEigensolver.md index 6d0fcde3f7..bd37bfa844 100644 --- a/docs/api/qiskit/qiskit.algorithms.eigensolvers.NumPyEigensolver.md +++ b/docs/api/qiskit/qiskit.algorithms.eigensolvers.NumPyEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver -`qiskit.algorithms.eigensolvers.NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.NumPyEigensolver(k=1, filter_criterion=None)` Bases: [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") diff --git a/docs/api/qiskit/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md b/docs/api/qiskit/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md index ac2acee428..e47ca7171f 100644 --- a/docs/api/qiskit/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md +++ b/docs/api/qiskit/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult -`qiskit.algorithms.eigensolvers.NumPyEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") +`qiskit.algorithms.eigensolvers.NumPyEigensolverResult` Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/qiskit.algorithms.eigensolvers.VQD.md b/docs/api/qiskit/qiskit.algorithms.eigensolvers.VQD.md index 90336a6eab..c5e295d4b9 100644 --- a/docs/api/qiskit/qiskit.algorithms.eigensolvers.VQD.md +++ b/docs/api/qiskit/qiskit.algorithms.eigensolvers.VQD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQD -`qiskit.algorithms.eigensolvers.VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`qiskit.algorithms.eigensolvers.VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)` Bases: `VariationalAlgorithm`, [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") diff --git a/docs/api/qiskit/qiskit.algorithms.eigensolvers.VQDResult.md b/docs/api/qiskit/qiskit.algorithms.eigensolvers.VQDResult.md index 49757ecb29..581d3e9b6d 100644 --- a/docs/api/qiskit/qiskit.algorithms.eigensolvers.VQDResult.md +++ b/docs/api/qiskit/qiskit.algorithms.eigensolvers.VQDResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.eigensolvers.VQDResult -`qiskit.algorithms.eigensolvers.VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/eigensolvers/vqd.py "view source code") +`qiskit.algorithms.eigensolvers.VQDResult` Bases: [`EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/qiskit.algorithms.eigensolvers.md b/docs/api/qiskit/qiskit.algorithms.eigensolvers.md index a1fac22f05..bedd5d86a5 100644 --- a/docs/api/qiskit/qiskit.algorithms.eigensolvers.md +++ b/docs/api/qiskit/qiskit.algorithms.eigensolvers.md @@ -25,8 +25,8 @@ python_api_name: qiskit.algorithms.eigensolvers | | | | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- | | [`Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.Eigensolver")() | The eigensolver interface. | -| [`NumPyEigensolver`](qiskit.algorithms.eigensolvers.NumPyEigensolver "qiskit.algorithms.eigensolvers.NumPyEigensolver")(\[k, filter\_criterion]) | The NumPy eigensolver algorithm. | -| [`VQD`](qiskit.algorithms.eigensolvers.VQD "qiskit.algorithms.eigensolvers.VQD")(estimator, fidelity, ansatz, optimizer, \*) | The Variational Quantum Deflation algorithm. | +| [`NumPyEigensolver`](qiskit.algorithms.eigensolvers.NumPyEigensolver "qiskit.algorithms.eigensolvers.NumPyEigensolver")(\[k, filter\_criterion]) | The NumPy eigensolver algorithm. | +| [`VQD`](qiskit.algorithms.eigensolvers.VQD "qiskit.algorithms.eigensolvers.VQD")(estimator, fidelity, ansatz, optimizer, \*) | The Variational Quantum Deflation algorithm. | ### Results diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.BaseEstimatorGradient.md b/docs/api/qiskit/qiskit.algorithms.gradients.BaseEstimatorGradient.md index 021186f237..7226ac2030 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.BaseEstimatorGradient.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.BaseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient -`qiskit.algorithms.gradients.BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/base_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.BaseQGT.md b/docs/api/qiskit/qiskit.algorithms.gradients.BaseQGT.md index 347b52b299..9bf820b84f 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.BaseQGT.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.BaseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseQGT -`qiskit.algorithms.gradients.BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/base_qgt.py "view source code") +`qiskit.algorithms.gradients.BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.BaseSamplerGradient.md b/docs/api/qiskit/qiskit.algorithms.gradients.BaseSamplerGradient.md index 627f8d2532..f57682c5b8 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.BaseSamplerGradient.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.BaseSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient -`qiskit.algorithms.gradients.BaseSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/base_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.BaseSamplerGradient(sampler, options=None)` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.EstimatorGradientResult.md b/docs/api/qiskit/qiskit.algorithms.gradients.EstimatorGradientResult.md index e61d975c55..00070b80d1 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.EstimatorGradientResult.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.EstimatorGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult -`qiskit.algorithms.gradients.EstimatorGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/estimator_gradient_result.py "view source code") +`qiskit.algorithms.gradients.EstimatorGradientResult(gradients, metadata, options)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md b/docs/api/qiskit/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md index 54113ee9d2..29f69e9233 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient -`qiskit.algorithms.gradients.FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/finite_diff/finite_diff_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')` Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md b/docs/api/qiskit/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md index cc4d7ab60f..0f936fb03f 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient -`qiskit.algorithms.gradients.FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/finite_diff/finite_diff_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')` Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.LinCombEstimatorGradient.md b/docs/api/qiskit/qiskit.algorithms.gradients.LinCombEstimatorGradient.md index 486e63fce9..1741a15502 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.LinCombEstimatorGradient.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.LinCombEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient -`qiskit.algorithms.gradients.LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/lin_comb/lin_comb_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)` Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.LinCombQGT.md b/docs/api/qiskit/qiskit.algorithms.gradients.LinCombQGT.md index 89d85d0d3b..ae98f5b9a8 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.LinCombQGT.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.LinCombQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombQGT -`qiskit.algorithms.gradients.LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/lin_comb/lin_comb_qgt.py "view source code") +`qiskit.algorithms.gradients.LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.LinCombSamplerGradient.md b/docs/api/qiskit/qiskit.algorithms.gradients.LinCombSamplerGradient.md index b9d4203b5f..0357f05c49 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.LinCombSamplerGradient.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.LinCombSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient -`qiskit.algorithms.gradients.LinCombSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/lin_comb/lin_comb_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.LinCombSamplerGradient(sampler, options=None)` Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md b/docs/api/qiskit/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md index 2863d166d3..c0a0ba8c60 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient -`qiskit.algorithms.gradients.ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/param_shift/param_shift_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md b/docs/api/qiskit/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md index 5ad6e4b81f..6bd3a1a2b4 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient -`qiskit.algorithms.gradients.ParamShiftSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/param_shift/param_shift_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.ParamShiftSamplerGradient(sampler, options=None)` Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.QFI.md b/docs/api/qiskit/qiskit.algorithms.gradients.QFI.md index d6ea8e1efd..5e213e379b 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.QFI.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFI -`qiskit.algorithms.gradients.QFI(qgt, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/qfi.py "view source code") +`qiskit.algorithms.gradients.QFI(qgt, options=None)` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.QFIResult.md b/docs/api/qiskit/qiskit.algorithms.gradients.QFIResult.md index e55a4ebf3d..bceae41c48 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.QFIResult.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.QFIResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QFIResult -`qiskit.algorithms.gradients.QFIResult(qfis, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/qfi_result.py "view source code") +`qiskit.algorithms.gradients.QFIResult(qfis, metadata, options)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.QGTResult.md b/docs/api/qiskit/qiskit.algorithms.gradients.QGTResult.md index 3ff9899271..faa5cafad2 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.QGTResult.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.QGTResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.QGTResult -`qiskit.algorithms.gradients.QGTResult(qgts, derivative_type, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/qgt_result.py "view source code") +`qiskit.algorithms.gradients.QGTResult(qgts, derivative_type, metadata, options)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.ReverseEstimatorGradient.md b/docs/api/qiskit/qiskit.algorithms.gradients.ReverseEstimatorGradient.md index 8f9e0dcd72..603630494f 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.ReverseEstimatorGradient.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.ReverseEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient -`qiskit.algorithms.gradients.ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/reverse/reverse_gradient.py "view source code") +`qiskit.algorithms.gradients.ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)` Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.ReverseQGT.md b/docs/api/qiskit/qiskit.algorithms.gradients.ReverseQGT.md index 96d16f7096..e607538b83 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.ReverseQGT.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.ReverseQGT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.ReverseQGT -`qiskit.algorithms.gradients.ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/reverse/reverse_qgt.py "view source code") +`qiskit.algorithms.gradients.ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)` Bases: [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.SPSAEstimatorGradient.md b/docs/api/qiskit/qiskit.algorithms.gradients.SPSAEstimatorGradient.md index 362c7b0345..35f0cd2973 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.SPSAEstimatorGradient.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.SPSAEstimatorGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient -`qiskit.algorithms.gradients.SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/spsa/spsa_estimator_gradient.py "view source code") +`qiskit.algorithms.gradients.SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)` Bases: [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.SPSASamplerGradient.md b/docs/api/qiskit/qiskit.algorithms.gradients.SPSASamplerGradient.md index 1a9bc1a145..2c5aa2fb32 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.SPSASamplerGradient.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.SPSASamplerGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient -`qiskit.algorithms.gradients.SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/spsa/spsa_sampler_gradient.py "view source code") +`qiskit.algorithms.gradients.SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)` Bases: [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.SamplerGradientResult.md b/docs/api/qiskit/qiskit.algorithms.gradients.SamplerGradientResult.md index dedf1b224b..9665d420eb 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.SamplerGradientResult.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.SamplerGradientResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.gradients.SamplerGradientResult -`qiskit.algorithms.gradients.SamplerGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/gradients/base/sampler_gradient_result.py "view source code") +`qiskit.algorithms.gradients.SamplerGradientResult(gradients, metadata, options)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.gradients.md b/docs/api/qiskit/qiskit.algorithms.gradients.md index d81968d412..02487a2f42 100644 --- a/docs/api/qiskit/qiskit.algorithms.gradients.md +++ b/docs/api/qiskit/qiskit.algorithms.gradients.md @@ -24,53 +24,53 @@ python_api_name: qiskit.algorithms.gradients | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.BaseEstimatorGradient")(estimator\[, options, ...]) | Base class for an `EstimatorGradient` to compute the gradients of the expectation value. | -| [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.BaseQGT")(estimator\[, phase\_fix, ...]) | Base class to computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. | -| [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.BaseSamplerGradient")(sampler\[, options]) | Base class for a `SamplerGradient` to compute the gradients of the sampling probability. | -| [`EstimatorGradientResult`](qiskit.algorithms.gradients.EstimatorGradientResult "qiskit.algorithms.gradients.EstimatorGradientResult")(gradients, metadata, ...) | Result of EstimatorGradient. | -| [`SamplerGradientResult`](qiskit.algorithms.gradients.SamplerGradientResult "qiskit.algorithms.gradients.SamplerGradientResult")(gradients, metadata, ...) | Result of SamplerGradient. | -| [`QGTResult`](qiskit.algorithms.gradients.QGTResult "qiskit.algorithms.gradients.QGTResult")(qgts, derivative\_type, metadata, ...) | Result of QGT. | +| [`BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.BaseEstimatorGradient")(estimator\[, options, ...]) | Base class for an `EstimatorGradient` to compute the gradients of the expectation value. | +| [`BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.BaseQGT")(estimator\[, phase\_fix, ...]) | Base class to computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. | +| [`BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.BaseSamplerGradient")(sampler\[, options]) | Base class for a `SamplerGradient` to compute the gradients of the sampling probability. | +| [`EstimatorGradientResult`](qiskit.algorithms.gradients.EstimatorGradientResult "qiskit.algorithms.gradients.EstimatorGradientResult")(gradients, metadata, ...) | Result of EstimatorGradient. | +| [`SamplerGradientResult`](qiskit.algorithms.gradients.SamplerGradientResult "qiskit.algorithms.gradients.SamplerGradientResult")(gradients, metadata, ...) | Result of SamplerGradient. | +| [`QGTResult`](qiskit.algorithms.gradients.QGTResult "qiskit.algorithms.gradients.QGTResult")(qgts, derivative\_type, metadata, ...) | Result of QGT. | ### Finite Differences | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [`FiniteDiffEstimatorGradient`](qiskit.algorithms.gradients.FiniteDiffEstimatorGradient "qiskit.algorithms.gradients.FiniteDiffEstimatorGradient")(estimator, epsilon) | Compute the gradients of the expectation values by finite difference method \[1]. | -| [`FiniteDiffSamplerGradient`](qiskit.algorithms.gradients.FiniteDiffSamplerGradient "qiskit.algorithms.gradients.FiniteDiffSamplerGradient")(sampler, epsilon) | Compute the gradients of the sampling probability by finite difference method \[1]. | +| [`FiniteDiffEstimatorGradient`](qiskit.algorithms.gradients.FiniteDiffEstimatorGradient "qiskit.algorithms.gradients.FiniteDiffEstimatorGradient")(estimator, epsilon) | Compute the gradients of the expectation values by finite difference method \[1]. | +| [`FiniteDiffSamplerGradient`](qiskit.algorithms.gradients.FiniteDiffSamplerGradient "qiskit.algorithms.gradients.FiniteDiffSamplerGradient")(sampler, epsilon) | Compute the gradients of the sampling probability by finite difference method \[1]. | ### Linear Combination of Unitaries | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| [`LinCombEstimatorGradient`](qiskit.algorithms.gradients.LinCombEstimatorGradient "qiskit.algorithms.gradients.LinCombEstimatorGradient")(estimator\[, ...]) | Compute the gradients of the expectation values. | -| [`LinCombSamplerGradient`](qiskit.algorithms.gradients.LinCombSamplerGradient "qiskit.algorithms.gradients.LinCombSamplerGradient")(sampler\[, options]) | Compute the gradients of the sampling probability. | -| [`LinCombQGT`](qiskit.algorithms.gradients.LinCombQGT "qiskit.algorithms.gradients.LinCombQGT")(estimator\[, phase\_fix, ...]) | Computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. | +| [`LinCombEstimatorGradient`](qiskit.algorithms.gradients.LinCombEstimatorGradient "qiskit.algorithms.gradients.LinCombEstimatorGradient")(estimator\[, ...]) | Compute the gradients of the expectation values. | +| [`LinCombSamplerGradient`](qiskit.algorithms.gradients.LinCombSamplerGradient "qiskit.algorithms.gradients.LinCombSamplerGradient")(sampler\[, options]) | Compute the gradients of the sampling probability. | +| [`LinCombQGT`](qiskit.algorithms.gradients.LinCombQGT "qiskit.algorithms.gradients.LinCombQGT")(estimator\[, phase\_fix, ...]) | Computes the Quantum Geometric Tensor (QGT) given a pure, parameterized quantum state. | ### Parameter Shift Rules | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [`ParamShiftEstimatorGradient`](qiskit.algorithms.gradients.ParamShiftEstimatorGradient "qiskit.algorithms.gradients.ParamShiftEstimatorGradient")(estimator\[, ...]) | Compute the gradients of the expectation values by the parameter shift rule \[1]. | -| [`ParamShiftSamplerGradient`](qiskit.algorithms.gradients.ParamShiftSamplerGradient "qiskit.algorithms.gradients.ParamShiftSamplerGradient")(sampler\[, options]) | Compute the gradients of the sampling probability by the parameter shift rule \[1]. | +| [`ParamShiftEstimatorGradient`](qiskit.algorithms.gradients.ParamShiftEstimatorGradient "qiskit.algorithms.gradients.ParamShiftEstimatorGradient")(estimator\[, ...]) | Compute the gradients of the expectation values by the parameter shift rule \[1]. | +| [`ParamShiftSamplerGradient`](qiskit.algorithms.gradients.ParamShiftSamplerGradient "qiskit.algorithms.gradients.ParamShiftSamplerGradient")(sampler\[, options]) | Compute the gradients of the sampling probability by the parameter shift rule \[1]. | ### Quantum Fisher Information | | | | --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| [`QFIResult`](qiskit.algorithms.gradients.QFIResult "qiskit.algorithms.gradients.QFIResult")(qfis, metadata, options) | Result of QFI. | -| [`QFI`](qiskit.algorithms.gradients.QFI "qiskit.algorithms.gradients.QFI")(qgt\[, options]) | Computes the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. | +| [`QFIResult`](qiskit.algorithms.gradients.QFIResult "qiskit.algorithms.gradients.QFIResult")(qfis, metadata, options) | Result of QFI. | +| [`QFI`](qiskit.algorithms.gradients.QFI "qiskit.algorithms.gradients.QFI")(qgt\[, options]) | Computes the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. | ### Classical Methods | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | [`ReverseEstimatorGradient`](qiskit.algorithms.gradients.ReverseEstimatorGradient "qiskit.algorithms.gradients.ReverseEstimatorGradient")(\[derivative\_type]) | Estimator gradients with the classically efficient reverse mode. | -| [`ReverseQGT`](qiskit.algorithms.gradients.ReverseQGT "qiskit.algorithms.gradients.ReverseQGT")(\[phase\_fix, derivative\_type]) | QGT calculation with the classically efficient reverse mode. | +| [`ReverseQGT`](qiskit.algorithms.gradients.ReverseQGT "qiskit.algorithms.gradients.ReverseQGT")(\[phase\_fix, derivative\_type]) | QGT calculation with the classically efficient reverse mode. | ### Simultaneous Perturbation Stochastic Approximation | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| [`SPSAEstimatorGradient`](qiskit.algorithms.gradients.SPSAEstimatorGradient "qiskit.algorithms.gradients.SPSAEstimatorGradient")(estimator, epsilon\[, ...]) | Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. | -| [`SPSASamplerGradient`](qiskit.algorithms.gradients.SPSASamplerGradient "qiskit.algorithms.gradients.SPSASamplerGradient")(sampler, epsilon\[, ...]) | Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. | +| [`SPSAEstimatorGradient`](qiskit.algorithms.gradients.SPSAEstimatorGradient "qiskit.algorithms.gradients.SPSAEstimatorGradient")(estimator, epsilon\[, ...]) | Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. | +| [`SPSASamplerGradient`](qiskit.algorithms.gradients.SPSASamplerGradient "qiskit.algorithms.gradients.SPSASamplerGradient")(sampler, epsilon\[, ...]) | Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. | diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md index 16bd085efe..58fb9a65ec 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE -`qiskit.algorithms.minimum_eigensolvers.AdaptVQE(solver, *, gradient_threshold=1e-05, eigenvalue_threshold=1e-05, max_iterations=None, threshold=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.AdaptVQE(solver, *, gradient_threshold=1e-05, eigenvalue_threshold=1e-05, max_iterations=None, threshold=None)` Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md index 0337787f8c..65a46ee420 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult -`qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult` Bases: [`VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md index 7bd1550fa2..54bca7698c 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver -`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md index 4ff601282a..6d06207257 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult -`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult` Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md index 45021770db..83d4db40dc 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver -`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver(filter_criterion=None)` Bases: [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md index 09fca631db..96a097584f 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverR -`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult` Bases: [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.QAOA.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.QAOA.md index 4a6ce4971c..9322c88cd3 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.QAOA.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.QAOA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA -`qiskit.algorithms.minimum_eigensolvers.QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)` Bases: [`SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md index 1188443cd5..41aa61bb63 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md index 326bc4e6f3..54ad06621c 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolv -`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult` Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md index 51c33ee3cf..99561607e7 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE -`qiskit.algorithms.minimum_eigensolvers.SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)` Bases: `VariationalAlgorithm`, [`SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md index ca26544e4c..2e5473e90e 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult -`qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult` Bases: `VariationalResult`, [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.VQE.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.VQE.md index 6c9d4b614a..8257585b55 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.VQE.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.VQE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE -`qiskit.algorithms.minimum_eigensolvers.VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)` Bases: `VariationalAlgorithm`, [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.VQEResult.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.VQEResult.md index 2cd37f8883..7ce9e97adf 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.VQEResult.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.VQEResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult -`qiskit.algorithms.minimum_eigensolvers.VQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") +`qiskit.algorithms.minimum_eigensolvers.VQEResult` Bases: `VariationalResult`, [`MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.md b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.md index a3bf30ea50..617953efd7 100644 --- a/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.md +++ b/docs/api/qiskit/qiskit.algorithms.minimum_eigensolvers.md @@ -26,11 +26,11 @@ python_api_name: qiskit.algorithms.minimum_eigensolvers | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | [`MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver")() | The minimum eigensolver interface. | | [`NumPyMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver")(\[filter\_criterion]) | The NumPy minimum eigensolver algorithm. | -| [`VQE`](qiskit.algorithms.minimum_eigensolvers.VQE "qiskit.algorithms.minimum_eigensolvers.VQE")(estimator, ansatz, optimizer, \*\[, ...]) | The variational quantum eigensolver (VQE) algorithm. | -| [`AdaptVQE`](qiskit.algorithms.minimum_eigensolvers.AdaptVQE "qiskit.algorithms.minimum_eigensolvers.AdaptVQE")(solver, \*\[, gradient\_threshold, ...]) | The Adaptive Variational Quantum Eigensolver algorithm. | +| [`VQE`](qiskit.algorithms.minimum_eigensolvers.VQE "qiskit.algorithms.minimum_eigensolvers.VQE")(estimator, ansatz, optimizer, \*\[, ...]) | The variational quantum eigensolver (VQE) algorithm. | +| [`AdaptVQE`](qiskit.algorithms.minimum_eigensolvers.AdaptVQE "qiskit.algorithms.minimum_eigensolvers.AdaptVQE")(solver, \*\[, gradient\_threshold, ...]) | The Adaptive Variational Quantum Eigensolver algorithm. | | [`SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver")() | The Sampling Minimum Eigensolver Interface. | -| [`SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.SamplingVQE")(sampler, ansatz, optimizer, \*\[, ...]) | The Variational Quantum Eigensolver algorithm, optimized for diagonal Hamiltonians. | -| [`QAOA`](qiskit.algorithms.minimum_eigensolvers.QAOA "qiskit.algorithms.minimum_eigensolvers.QAOA")(sampler, optimizer, \*\[, reps, ...]) | The Quantum Approximate Optimization Algorithm (QAOA). | +| [`SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.SamplingVQE")(sampler, ansatz, optimizer, \*\[, ...]) | The Variational Quantum Eigensolver algorithm, optimized for diagonal Hamiltonians. | +| [`QAOA`](qiskit.algorithms.minimum_eigensolvers.QAOA "qiskit.algorithms.minimum_eigensolvers.QAOA")(sampler, optimizer, \*\[, reps, ...]) | The Quantum Approximate Optimization Algorithm (QAOA). | | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/qiskit.algorithms.optimizers.ADAM.md index 566d8827cc..d7ad55bbef 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.ADAM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ADAM -`qiskit.algorithms.optimizers.ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") +`qiskit.algorithms.optimizers.ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/qiskit.algorithms.optimizers.AQGD.md index 4ddcac2f04..4b84548e1c 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.AQGD.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AQGD -`qiskit.algorithms.optimizers.AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/aqgd.py "view source code") +`qiskit.algorithms.optimizers.AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.AskData.md b/docs/api/qiskit/qiskit.algorithms.optimizers.AskData.md index 0f77b251d9..9159d2866c 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.AskData.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.AskData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.AskData -`qiskit.algorithms.optimizers.AskData(x_fun=None, x_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.AskData(x_fun=None, x_jac=None)` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/qiskit.algorithms.optimizers.BOBYQA.md index 361a483071..82777ce659 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.BOBYQA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.BOBYQA -`qiskit.algorithms.optimizers.BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/bobyqa.py "view source code") +`qiskit.algorithms.optimizers.BOBYQA(maxiter=1000)` Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/qiskit.algorithms.optimizers.CG.md index db426a5c85..2678059c48 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.CG.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CG -`qiskit.algorithms.optimizers.CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/cg.py "view source code") +`qiskit.algorithms.optimizers.CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/qiskit.algorithms.optimizers.COBYLA.md index 7543d839cc..72047f9f1f 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.COBYLA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.COBYLA -`qiskit.algorithms.optimizers.COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/cobyla.py "view source code") +`qiskit.algorithms.optimizers.COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/qiskit.algorithms.optimizers.CRS.md index bf00d89e72..cb50ee5766 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.CRS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.CRS -`qiskit.algorithms.optimizers.CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") +`qiskit.algorithms.optimizers.CRS(max_evals=1000)` Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/qiskit.algorithms.optimizers.DIRECT_L.md index b05d7706b7..289cc80b6e 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.DIRECT_L.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L -`qiskit.algorithms.optimizers.DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") +`qiskit.algorithms.optimizers.DIRECT_L(max_evals=1000)` Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index 749c06808a..3b3f8d0398 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND -`qiskit.algorithms.optimizers.DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") +`qiskit.algorithms.optimizers.DIRECT_L_RAND(max_evals=1000)` Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/qiskit.algorithms.optimizers.ESCH.md index 4829502d2b..7d3d4d21de 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.ESCH.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ESCH -`qiskit.algorithms.optimizers.ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") +`qiskit.algorithms.optimizers.ESCH(max_evals=1000)` Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/qiskit.algorithms.optimizers.GSLS.md index b0bd87a923..1fa9eb982f 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.GSLS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GSLS -`qiskit.algorithms.optimizers.GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/gsls.py "view source code") +`qiskit.algorithms.optimizers.GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/qiskit.algorithms.optimizers.GradientDescent.md index 502cce4a33..9cb30b7197 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.GradientDescent.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescent -`qiskit.algorithms.optimizers.GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`qiskit.algorithms.optimizers.GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` Bases: [`SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.GradientDescentState.md b/docs/api/qiskit/qiskit.algorithms.optimizers.GradientDescentState.md index ae38ffb588..3612b26279 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.GradientDescentState.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.GradientDescentState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.GradientDescentState -`qiskit.algorithms.optimizers.GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/gradient_descent.py "view source code") +`qiskit.algorithms.optimizers.GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)` Bases: [`OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/qiskit.algorithms.optimizers.IMFIL.md index 310b791c2b..de9a05520e 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.IMFIL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.IMFIL -`qiskit.algorithms.optimizers.IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/imfil.py "view source code") +`qiskit.algorithms.optimizers.IMFIL(maxiter=1000)` Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/qiskit.algorithms.optimizers.ISRES.md index ff87982268..0cb46d2a9e 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.ISRES.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.ISRES -`qiskit.algorithms.optimizers.ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") +`qiskit.algorithms.optimizers.ISRES(max_evals=1000)` Bases: `NLoptOptimizer` diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/qiskit.algorithms.optimizers.L_BFGS_B.md index 10eae8f72c..da225fe148 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.L_BFGS_B -`qiskit.algorithms.optimizers.L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=-1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") +`qiskit.algorithms.optimizers.L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=-1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/qiskit.algorithms.optimizers.Minimizer.md index e406ed20fb..26c58cf939 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.Minimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Minimizer -`qiskit.algorithms.optimizers.Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.Minimizer(*args, **kwargs)` Bases: [`Protocol`](https://docs.python.org/3/library/typing.html#typing.Protocol "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/qiskit.algorithms.optimizers.NELDER_MEAD.md index 555829e93f..f76494cc85 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD -`qiskit.algorithms.optimizers.NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nelder_mead.py "view source code") +`qiskit.algorithms.optimizers.NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/qiskit.algorithms.optimizers.NFT.md index 37c649e1ca..647910b9c3 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.NFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.NFT -`qiskit.algorithms.optimizers.NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/nft.py "view source code") +`qiskit.algorithms.optimizers.NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/qiskit.algorithms.optimizers.Optimizer.md index 5581ae7988..6205ca5759 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.Optimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.Optimizer -`qiskit.algorithms.optimizers.Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.Optimizer` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerResult.md index 392b99e21a..79f58c21e9 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerResult -`qiskit.algorithms.optimizers.OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerResult` Bases: `AlgorithmResult` diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerState.md b/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerState.md index 67dd4e9dd9..7980bfd3bd 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerState.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerState -`qiskit.algorithms.optimizers.OptimizerState(x, fun, jac, nfev, njev, nit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerState(x, fun, jac, nfev, njev, nit)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index ec8cef4aa8..cb3e156d90 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel -`qiskit.algorithms.optimizers.OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer.py "view source code") +`qiskit.algorithms.optimizers.OptimizerSupportLevel(value)` Bases: [`IntEnum`](https://docs.python.org/3/library/enum.html#enum.IntEnum "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/qiskit.algorithms.optimizers.POWELL.md index 98a326734b..29b0a2fcce 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.POWELL.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.POWELL -`qiskit.algorithms.optimizers.POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/powell.py "view source code") +`qiskit.algorithms.optimizers.POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/qiskit.algorithms.optimizers.P_BFGS.md index 0d0c6306e9..e088eda068 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.P_BFGS.md @@ -12,7 +12,7 @@ python_api_name: qiskit.algorithms.optimizers.P_BFGS -`qiskit.algorithms.optimizers.P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=-1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/p_bfgs.py "view source code") +`qiskit.algorithms.optimizers.P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=-1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/qiskit.algorithms.optimizers.QNSPSA.md index 9cc72e0717..a85c861455 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.QNSPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.QNSPSA -`qiskit.algorithms.optimizers.QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/qnspsa.py "view source code") +`qiskit.algorithms.optimizers.QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` Bases: [`SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/qiskit.algorithms.optimizers.SLSQP.md index 3cbe1d75c6..79761429a0 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.SLSQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SLSQP -`qiskit.algorithms.optimizers.SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/slsqp.py "view source code") +`qiskit.algorithms.optimizers.SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/qiskit.algorithms.optimizers.SNOBFIT.md index 8f3f4d3d0d..6f77265709 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.SNOBFIT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SNOBFIT -`qiskit.algorithms.optimizers.SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/snobfit.py "view source code") +`qiskit.algorithms.optimizers.SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/qiskit.algorithms.optimizers.SPSA.md index 7ba6283d1c..2f7729fb70 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.SPSA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SPSA -`qiskit.algorithms.optimizers.SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/spsa.py "view source code") +`qiskit.algorithms.optimizers.SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/qiskit.algorithms.optimizers.SciPyOptimizer.md index 04441979a3..2951c99109 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer -`qiskit.algorithms.optimizers.SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") +`qiskit.algorithms.optimizers.SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.SteppableOptimizer.md b/docs/api/qiskit/qiskit.algorithms.optimizers.SteppableOptimizer.md index 50e1381270..94a9da8530 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.SteppableOptimizer.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.SteppableOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer -`qiskit.algorithms.optimizers.SteppableOptimizer(maxiter=100)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.SteppableOptimizer(maxiter=100)` Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/qiskit.algorithms.optimizers.TNC.md index ceb54fd70d..c73e665eec 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.TNC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TNC -`qiskit.algorithms.optimizers.TNC(maxiter=100, disp=False, accuracy=0, ftol=-1, xtol=-1, gtol=-1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/tnc.py "view source code") +`qiskit.algorithms.optimizers.TNC(maxiter=100, disp=False, accuracy=0, ftol=-1, xtol=-1, gtol=-1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` Bases: [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.TellData.md b/docs/api/qiskit/qiskit.algorithms.optimizers.TellData.md index e131b1ece7..5b4bc376a7 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.TellData.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.TellData.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.TellData -`qiskit.algorithms.optimizers.TellData(eval_fun=None, eval_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") +`qiskit.algorithms.optimizers.TellData(eval_fun=None, eval_jac=None)` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/qiskit.algorithms.optimizers.UMDA.md index 1342ee704f..700a8277d4 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.UMDA.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.UMDA -`qiskit.algorithms.optimizers.UMDA(maxiter=100, size_gen=20, alpha=0.5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/umda.py "view source code") +`qiskit.algorithms.optimizers.UMDA(maxiter=100, size_gen=20, alpha=0.5, callback=None)` Bases: [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") diff --git a/docs/api/qiskit/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md b/docs/api/qiskit/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md index 4f5a3260b6..5a61723072 100644 --- a/docs/api/qiskit/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md +++ b/docs/api/qiskit/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate -`qiskit.algorithms.optimizers.optimizer_utils.LearningRate(learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") +`qiskit.algorithms.optimizers.optimizer_utils.LearningRate(learning_rate)` Bases: [`Generator`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.state_fidelities.BaseStateFidelity.md b/docs/api/qiskit/qiskit.algorithms.state_fidelities.BaseStateFidelity.md index c42c31301b..ab5a70462f 100644 --- a/docs/api/qiskit/qiskit.algorithms.state_fidelities.BaseStateFidelity.md +++ b/docs/api/qiskit/qiskit.algorithms.state_fidelities.BaseStateFidelity.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity -`qiskit.algorithms.state_fidelities.BaseStateFidelity`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") +`qiskit.algorithms.state_fidelities.BaseStateFidelity` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.state_fidelities.ComputeUncompute.md b/docs/api/qiskit/qiskit.algorithms.state_fidelities.ComputeUncompute.md index e7a031cd07..6ee6e2d73a 100644 --- a/docs/api/qiskit/qiskit.algorithms.state_fidelities.ComputeUncompute.md +++ b/docs/api/qiskit/qiskit.algorithms.state_fidelities.ComputeUncompute.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute -`qiskit.algorithms.state_fidelities.ComputeUncompute(sampler, options=None, local=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") +`qiskit.algorithms.state_fidelities.ComputeUncompute(sampler, options=None, local=False)` Bases: [`BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") diff --git a/docs/api/qiskit/qiskit.algorithms.state_fidelities.StateFidelityResult.md b/docs/api/qiskit/qiskit.algorithms.state_fidelities.StateFidelityResult.md index bfd66bbeb5..103ed96406 100644 --- a/docs/api/qiskit/qiskit.algorithms.state_fidelities.StateFidelityResult.md +++ b/docs/api/qiskit/qiskit.algorithms.state_fidelities.StateFidelityResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult -`qiskit.algorithms.state_fidelities.StateFidelityResult(fidelities, raw_fidelities, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") +`qiskit.algorithms.state_fidelities.StateFidelityResult(fidelities, raw_fidelities, metadata, options)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.state_fidelities.md b/docs/api/qiskit/qiskit.algorithms.state_fidelities.md index 5479b77e6f..65cb0d99c2 100644 --- a/docs/api/qiskit/qiskit.algorithms.state_fidelities.md +++ b/docs/api/qiskit/qiskit.algorithms.state_fidelities.md @@ -25,11 +25,11 @@ python_api_name: qiskit.algorithms.state_fidelities | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.BaseStateFidelity")() | An interface to calculate state fidelities (state overlaps) for pairs of (parametrized) quantum circuits. | -| [`ComputeUncompute`](qiskit.algorithms.state_fidelities.ComputeUncompute "qiskit.algorithms.state_fidelities.ComputeUncompute")(sampler\[, options, local]) | This class leverages the sampler primitive to calculate the state fidelity of two quantum circuits following the compute-uncompute method (see \[1] for further reference). | +| [`ComputeUncompute`](qiskit.algorithms.state_fidelities.ComputeUncompute "qiskit.algorithms.state_fidelities.ComputeUncompute")(sampler\[, options, local]) | This class leverages the sampler primitive to calculate the state fidelity of two quantum circuits following the compute-uncompute method (see \[1] for further reference). | ### Results > | | | > | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -> | [`StateFidelityResult`](qiskit.algorithms.state_fidelities.StateFidelityResult "qiskit.algorithms.state_fidelities.StateFidelityResult")(fidelities, ...) | This class stores the result of StateFidelity computations. | +> | [`StateFidelityResult`](qiskit.algorithms.state_fidelities.StateFidelityResult "qiskit.algorithms.state_fidelities.StateFidelityResult")(fidelities, ...) | This class stores the result of StateFidelity computations. | diff --git a/docs/api/qiskit/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md b/docs/api/qiskit/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md index e952a4c720..440cd8ecba 100644 --- a/docs/api/qiskit/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md +++ b/docs/api/qiskit/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE -`qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE(product_formula=None, estimator=None, num_timesteps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") +`qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE(product_formula=None, estimator=None, num_timesteps=1)` Bases: [`RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md index ee27e90431..5b2b370d96 100644 --- a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md +++ b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver -`qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)` Bases: `OdeSolver` diff --git a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md index 7319880a54..45c58df9db 100644 --- a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md +++ b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanP -`qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)` Bases: [`ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") diff --git a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md index 6fafef56ce..54aa418ff0 100644 --- a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md +++ b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationa -`qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple(qgt, gradient)` Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md index b1c287fe94..f80ff0b157 100644 --- a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md +++ b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinci -`qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple(qgt=None, gradient=None)` Bases: [`RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") diff --git a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md index 78006e6670..cf9f2e23e2 100644 --- a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md +++ b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrin -`qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple(qgt, gradient)` Bases: [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md index 60928096a0..78c8e6e315 100644 --- a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md +++ b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrincipl -`qiskit.algorithms.time_evolvers.variational.VariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") +`qiskit.algorithms.time_evolvers.variational.VariationalPrinciple(qgt, gradient)` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.md b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.md index 2e731126c1..370042ffce 100644 --- a/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.md +++ b/docs/api/qiskit/qiskit.algorithms.time_evolvers.variational.md @@ -62,11 +62,11 @@ They can be divided into two categories: Variational Quantum \_Real\_ Time Evolu | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.VariationalPrinciple")(qgt, gradient) | A Variational Principle class. | -| [`RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple")(qgt, gradient) | Class for a Real Variational Principle. | -| [`ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple")(qgt, gradient) | Abstract class for an Imaginary Variational Principle. | -| [`RealMcLachlanPrinciple`](qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple "qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple")(\[qgt, gradient]) | Class for a Real McLachlan's Variational Principle. | -| [`ImaginaryMcLachlanPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple "qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple")(\[qgt, gradient]) | Class for an Imaginary McLachlan's Variational Principle. | +| [`VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.VariationalPrinciple")(qgt, gradient) | A Variational Principle class. | +| [`RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple")(qgt, gradient) | Class for a Real Variational Principle. | +| [`ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple")(qgt, gradient) | Abstract class for an Imaginary Variational Principle. | +| [`RealMcLachlanPrinciple`](qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple "qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple")(\[qgt, gradient]) | Class for a Real McLachlan's Variational Principle. | +| [`ImaginaryMcLachlanPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple "qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple")(\[qgt, gradient]) | Class for an Imaginary McLachlan's Variational Principle. | ### ODE solvers @@ -74,5 +74,5 @@ ODE solvers that implement the SciPy ODE Solver interface. The Forward Euler Sol | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | -| [`ForwardEulerSolver`](qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver "qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver")(function, t0, y0, t\_bound) | Forward Euler ODE solver. | +| [`ForwardEulerSolver`](qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver "qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver")(function, t0, y0, t\_bound) | Forward Euler ODE solver. | diff --git a/docs/api/qiskit/qiskit.assembler.RunConfig.md b/docs/api/qiskit/qiskit.assembler.RunConfig.md index 1f028d663b..5989d08ed3 100644 --- a/docs/api/qiskit/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/qiskit.assembler.RunConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.assembler.RunConfig -`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/assembler/run_config.py "view source code") +`qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/qiskit.circuit.AncillaQubit.md index a6314e2369..5841d4b918 100644 --- a/docs/api/qiskit/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/qiskit.circuit.AncillaQubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaQubit -`qiskit.circuit.AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaQubit(register=None, index=None)` Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/qiskit.circuit.AncillaRegister.md index 880158d874..5d102f2b4c 100644 --- a/docs/api/qiskit/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/qiskit.circuit.AncillaRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AncillaRegister -`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)` Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.md b/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.md index 357f3dbb6e..c87b44a5a8 100644 --- a/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.md +++ b/docs/api/qiskit/qiskit.circuit.AnnotatedOperation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation -`qiskit.circuit.AnnotatedOperation(base_op, modifiers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.AnnotatedOperation(base_op, modifiers)` Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/qiskit.circuit.Bit.md b/docs/api/qiskit/qiskit.circuit.Bit.md index 9f6d134d4c..fd78f1fca4 100644 --- a/docs/api/qiskit/qiskit.circuit.Bit.md +++ b/docs/api/qiskit/qiskit.circuit.Bit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Bit -`qiskit.circuit.Bit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/bit.py "view source code") +`qiskit.circuit.Bit(register=None, index=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/qiskit.circuit.BreakLoopOp.md index b98a871547..dd508937f8 100644 --- a/docs/api/qiskit/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/qiskit.circuit.BreakLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.BreakLoopOp -`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/break_loop.py "view source code") +`qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)` Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/qiskit.circuit.CircuitInstruction.md index 7162f0d359..aa984ad8f9 100644 --- a/docs/api/qiskit/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/qiskit.circuit.CircuitInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CircuitInstruction -`qiskit.circuit.CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumcircuitdata.py "view source code") +`qiskit.circuit.CircuitInstruction(operation, qubits=(), clbits=())` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/qiskit.circuit.ClassicalRegister.md index 5d967a4e0f..dd128dd164 100644 --- a/docs/api/qiskit/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/qiskit.circuit.ClassicalRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ClassicalRegister -`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)` Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/qiskit.circuit.Clbit.md b/docs/api/qiskit/qiskit.circuit.Clbit.md index 209625521d..fa41bf963d 100644 --- a/docs/api/qiskit/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/qiskit.circuit.Clbit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Clbit -`qiskit.circuit.Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalregister.py "view source code") +`qiskit.circuit.Clbit(register=None, index=None)` Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/qiskit.circuit.CommutationChecker.md b/docs/api/qiskit/qiskit.circuit.CommutationChecker.md index 6b93a77738..c3afd73b1c 100644 --- a/docs/api/qiskit/qiskit.circuit.CommutationChecker.md +++ b/docs/api/qiskit/qiskit.circuit.CommutationChecker.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.CommutationChecker -`qiskit.circuit.CommutationChecker`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/commutation_checker.py "view source code") +`qiskit.circuit.CommutationChecker` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.md index 0eeedf7594..c7a9d8efb0 100644 --- a/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/qiskit.circuit.ContinueLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp -`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/continue_loop.py "view source code") +`qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)` Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/qiskit.circuit.ControlFlowOp.md index a69fda2bc8..7b4f09dbec 100644 --- a/docs/api/qiskit/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/qiskit.circuit.ControlFlowOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlFlowOp -`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/control_flow.py "view source code") +`qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.ControlModifier.md b/docs/api/qiskit/qiskit.circuit.ControlModifier.md index 94b34cf4a6..7fdae42a32 100644 --- a/docs/api/qiskit/qiskit.circuit.ControlModifier.md +++ b/docs/api/qiskit/qiskit.circuit.ControlModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlModifier -`qiskit.circuit.ControlModifier(num_ctrl_qubits=0, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.ControlModifier(num_ctrl_qubits=0, ctrl_state=None)` Bases: `Modifier` diff --git a/docs/api/qiskit/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/qiskit.circuit.ControlledGate.md index 00835a2e0b..14e754df83 100644 --- a/docs/api/qiskit/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/qiskit.circuit.ControlledGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ControlledGate -`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None, duration=None, unit=None, *, _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlledgate.py "view source code") +`qiskit.circuit.ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None, duration=None, unit=None, *, _base_label=None)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.Delay.md b/docs/api/qiskit/qiskit.circuit.Delay.md index 0e3a2be0a0..8a3de5070b 100644 --- a/docs/api/qiskit/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/qiskit.circuit.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Delay -`qiskit.circuit.Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/delay.py "view source code") +`qiskit.circuit.Delay(duration, unit='dt')` Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -139,55 +139,21 @@ Assemble a QasmQobjInstruction `broadcast_arguments(qargs, cargs)` -Validation and handling of the arguments and its relationship. - -For example, `cx([q[0],q[1]], q[2])` means `cx(q[0], q[2]); cx(q[1], q[2])`. This method yields the arguments in the right grouping. In the given example: - -```python -in: [[q[0],q[1]], q[2]],[] -outs: [q[0], q[2]], [] - [q[1], q[2]], [] -``` - -The general broadcasting rules are: - -> * If len(qargs) == 1: -> -> ```python -> [q[0], q[1]] -> [q[0]],[q[1]] -> ``` -> -> * If len(qargs) == 2: -> -> ```python -> [[q[0], q[1]], [r[0], r[1]]] -> [q[0], r[0]], [q[1], r[1]] -> [[q[0]], [r[0], r[1]]] -> [q[0], r[0]], [q[0], r[1]] -> [[q[0], q[1]], [r[0]]] -> [q[0], r[0]], [q[1], r[0]] -> ``` -> -> * If len(qargs) >= 3: -> -> ```python -> [q[0], q[1]], [r[0], r[1]], ...] -> [q[0], r[0], ...], [q[1], r[1], ...] -> ``` +Validation of the arguments. **Parameters** -* **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – List of quantum bit arguments. -* **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – List of classical bit arguments. +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. -**Returns** +**Yields** -A tuple with single arguments. +*Tuple(List, List)* – A tuple with single arguments. **Raises** [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If the input is not valid. For example, the number of arguments does not match the gate expectation. -**Return type** - -[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.12)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]] - ### c\_if diff --git a/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.md index 237124e5bf..932d818dc3 100644 --- a/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/qiskit.circuit.EquivalenceLibrary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary -`qiskit.circuit.EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/equivalence.py "view source code") +`qiskit.circuit.EquivalenceLibrary(*, base=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/qiskit.circuit.ForLoopOp.md index 85f1e80aab..c2e705388f 100644 --- a/docs/api/qiskit/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/qiskit.circuit.ForLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ForLoopOp -`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/for_loop.py "view source code") +`qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)` Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/qiskit.circuit.Gate.md b/docs/api/qiskit/qiskit.circuit.Gate.md index e3c3554d20..bb5aef1a3c 100644 --- a/docs/api/qiskit/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/qiskit.circuit.Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Gate -`qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/gate.py "view source code") +`qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')` Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/qiskit.circuit.IfElseOp.md index 80d997f545..b58e15fabd 100644 --- a/docs/api/qiskit/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/qiskit.circuit.IfElseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.IfElseOp -`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/if_else.py "view source code") +`qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)` Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/qiskit.circuit.Instruction.md b/docs/api/qiskit/qiskit.circuit.Instruction.md index 5c2bb38505..70d5bef525 100644 --- a/docs/api/qiskit/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/qiskit.circuit.Instruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Instruction -`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/instruction.py "view source code") +`qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/qiskit.circuit.InstructionSet.md index b0a72add90..74eef62c19 100644 --- a/docs/api/qiskit/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/qiskit.circuit.InstructionSet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InstructionSet -`qiskit.circuit.InstructionSet(*, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/instructionset.py "view source code") +`qiskit.circuit.InstructionSet(*, resource_requester=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.InverseModifier.md b/docs/api/qiskit/qiskit.circuit.InverseModifier.md index 84b7b5700a..245f26b174 100644 --- a/docs/api/qiskit/qiskit.circuit.InverseModifier.md +++ b/docs/api/qiskit/qiskit.circuit.InverseModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.InverseModifier -`qiskit.circuit.InverseModifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.InverseModifier` Bases: `Modifier` diff --git a/docs/api/qiskit/qiskit.circuit.Operation.md b/docs/api/qiskit/qiskit.circuit.Operation.md index 0c728d1153..fd05ac8c78 100644 --- a/docs/api/qiskit/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/qiskit.circuit.Operation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Operation -`qiskit.circuit.Operation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/operation.py "view source code") +`qiskit.circuit.Operation` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.Parameter.md b/docs/api/qiskit/qiskit.circuit.Parameter.md index bd6a980967..075181f393 100644 --- a/docs/api/qiskit/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/qiskit.circuit.Parameter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Parameter -`qiskit.circuit.Parameter(name, *, uuid=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/parameter.py "view source code") +`qiskit.circuit.Parameter(name, *, uuid=None)` Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") diff --git a/docs/api/qiskit/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/qiskit.circuit.ParameterExpression.md index 5ae48d16a6..d445b43b3d 100644 --- a/docs/api/qiskit/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/qiskit.circuit.ParameterExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterExpression -`qiskit.circuit.ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/parameterexpression.py "view source code") +`qiskit.circuit.ParameterExpression(symbol_map, expr)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/qiskit.circuit.ParameterVector.md index 520f093a3f..5be192193d 100644 --- a/docs/api/qiskit/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/qiskit.circuit.ParameterVector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.ParameterVector -`qiskit.circuit.ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/parametervector.py "view source code") +`qiskit.circuit.ParameterVector(name, length=0)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.PowerModifier.md b/docs/api/qiskit/qiskit.circuit.PowerModifier.md index dbdcdbdbfa..6d22f809d7 100644 --- a/docs/api/qiskit/qiskit.circuit.PowerModifier.md +++ b/docs/api/qiskit/qiskit.circuit.PowerModifier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.PowerModifier -`qiskit.circuit.PowerModifier(power)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/annotated_operation.py "view source code") +`qiskit.circuit.PowerModifier(power)` Bases: `Modifier` diff --git a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md index 8f90cb7d2f..21d79dcccd 100644 --- a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumCircuit -`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumcircuit.py "view source code") +`qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") @@ -1324,7 +1324,7 @@ Draw the quantum circuit. Use the output parameter to choose the drawing format: * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – include idle wires (wires with no circuit elements) in output visualization. Default is True. * **with\_layout** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – include layout information, with labels on the physical layout. Default is True. * **fold** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – sets pagination. It can be disabled using -1. In text, sets the length of the lines. This is useful when the drawing does not fit in the console. If None (default), it will try to guess the console width using `shutil.get_terminal_size()`. However, if running in jupyter, the default line length is set to 80 characters. In mpl, it is the number of (visual) layers before folding. Default is 25. -* **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.8.2)")) – Only used by the mpl backend. 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.8.1)")) – Only used by the mpl backend. 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. * **initial\_state** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Optional. Adds `|0>` in the beginning of the wire. Default is False. * **cregbundle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Optional. If set True, bundle classical registers. Default is True, except for when `output` is set to `"text"`. * **wire\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – Optional. A list of integers used to reorder the display of the bits. The list must have an entry for every bit with the bits in the range 0 to (`num_qubits` + `num_clbits`). @@ -3479,7 +3479,7 @@ A handle to the instructions created. Tensor `self` with `other`. -Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](https://docs.quantum-computing.ibm.com/build/circuit-construction) for more information. +Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also [the docs](qiskit.org/documentation/tutorials/circuits/3_summary_of_quantum_operations) for more information. ```python ┌────────┐ ┌─────┐ ┌─────┐ diff --git a/docs/api/qiskit/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/qiskit.circuit.QuantumRegister.md index 875090d876..b729aaff0a 100644 --- a/docs/api/qiskit/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/qiskit.circuit.QuantumRegister.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.QuantumRegister -`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)` Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register") diff --git a/docs/api/qiskit/qiskit.circuit.Qubit.md b/docs/api/qiskit/qiskit.circuit.Qubit.md index eb99c735f5..b036093912 100644 --- a/docs/api/qiskit/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/qiskit.circuit.Qubit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Qubit -`qiskit.circuit.Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/quantumregister.py "view source code") +`qiskit.circuit.Qubit(register=None, index=None)` Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit") diff --git a/docs/api/qiskit/qiskit.circuit.Register.md b/docs/api/qiskit/qiskit.circuit.Register.md index 1372468dc7..835c3f3049 100644 --- a/docs/api/qiskit/qiskit.circuit.Register.md +++ b/docs/api/qiskit/qiskit.circuit.Register.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.Register -`qiskit.circuit.Register(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/register.py "view source code") +`qiskit.circuit.Register(size=None, name=None, bits=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.md b/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.md index e3576de6fd..aaab18e90f 100644 --- a/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.md +++ b/docs/api/qiskit/qiskit.circuit.SwitchCaseOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp -`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/switch_case.py "view source code") +`qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)` Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/qiskit.circuit.WhileLoopOp.md index 3421f93064..4f3f031042 100644 --- a/docs/api/qiskit/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/qiskit.circuit.WhileLoopOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.WhileLoopOp -`qiskit.circuit.WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/controlflow/while_loop.py "view source code") +`qiskit.circuit.WhileLoopOp(condition, body, label=None)` Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") diff --git a/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.md index 608eee1ffc..7bb6c5955b 100644 --- a/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression -`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") +`qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)` Bases: `ClassicalElement` diff --git a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunction.md index 580a0dc563..358e250ca4 100644 --- a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction -`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)` Bases: `ClassicalElement` diff --git a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 7976aaf358..476cd861d5 100644 --- a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE -`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)` ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index a608a715e0..ffc58538f8 100644 --- a/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/exceptions.py "view source code") +`qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)` ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/qiskit.circuit.library.AND.md b/docs/api/qiskit/qiskit.circuit.library.AND.md index f7452f4800..d1dbabf236 100644 --- a/docs/api/qiskit/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/qiskit.circuit.library.AND.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.AND -`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") +`qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -92,7 +92,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 162` +`= 193` diff --git a/docs/api/qiskit/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/qiskit.circuit.library.Barrier.md index da292d986e..b3a32f9c04 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/qiskit.circuit.library.Barrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Barrier -`qiskit.circuit.library.Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/barrier.py "view source code") +`qiskit.circuit.library.Barrier(num_qubits, label=None)` Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/qiskit.circuit.library.C3SXGate.md index 653c328256..1dc701c6e0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.C3SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3SXGate -`qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/qiskit.circuit.library.C3XGate.md index 1603e258da..6140db0c2d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.C3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C3XGate -`qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/qiskit.circuit.library.C4XGate.md index b33a91b53d..12caf8e691 100644 --- a/docs/api/qiskit/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.C4XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.C4XGate -`qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/qiskit.circuit.library.CCXGate.md index 005d4e7141..ba65008f44 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCXGate -`qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") @@ -32,7 +32,7 @@ q_2: ┤ X ├ **Matrix representation:** $$ -CCX q_0, q_1, q_2 = +\begin{split}CCX q_0, q_1, q_2 = I \otimes I \otimes |0 \rangle \langle 0| + CX \otimes |1 \rangle \langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0\\ @@ -43,7 +43,7 @@ CCX q_0, q_1, q_2 = 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0\\ 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0\\ 0 & 0 & 0 & 1 & 0 & 0 & 0 & 0 - \end{pmatrix} + \end{pmatrix}\end{split} $$ @@ -59,7 +59,7 @@ $$ ``` $$ - CCX\ q_2, q_1, q_0 = + \begin{split}CCX\ q_2, q_1, q_0 = |0 \rangle \langle 0| \otimes I \otimes I + |1 \rangle \langle 1| \otimes CX = \begin{pmatrix} 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0\\ @@ -70,7 +70,7 @@ $$ 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0\\ 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1\\ 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 - \end{pmatrix} + \end{pmatrix}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.CCZGate.md b/docs/api/qiskit/qiskit.circuit.library.CCZGate.md index b66e079c98..90ae08557f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CCZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CCZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CCZGate -`qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") @@ -33,7 +33,7 @@ q_2: ─■─ **Matrix representation:** $$ -CCZ\ q_0, q_1, q_2 = +\begin{split}CCZ\ q_0, q_1, q_2 = I \otimes I \otimes |0\rangle\langle 0| + CZ \otimes |1\rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 & 0 & 0 & 0 & 0 \\ @@ -44,7 +44,7 @@ CCZ\ q_0, q_1, q_2 = 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0 \\ 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 \\ 0 & 0 & 0 & 0 & 0 & 0 & 0 & -1 - \end{pmatrix} + \end{pmatrix}\end{split} $$ In the computational basis, this gate flips the phase of the target qubit if the control qubits are in the $|11\rangle$ state. diff --git a/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.md index e79837ca89..5163554b99 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder -`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` Bases: `Adder` @@ -138,7 +138,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 167` +`= 198` diff --git a/docs/api/qiskit/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/qiskit.circuit.library.CHGate.md index 3fced622d0..f52462c2ae 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CHGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CHGate -`qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") @@ -32,14 +32,14 @@ q_1: ┤ H ├ **Matrix Representation:** $$ -CH\ q_0, q_1 = +\begin{split}CH\ q_0, q_1 = I \otimes |0\rangle\langle 0| + H \otimes |1\rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & \frac{1}{\sqrt{2}} & 0 & \frac{1}{\sqrt{2}} \\ 0 & 0 & 1 & 0 \\ 0 & \frac{1}{\sqrt{2}} & 0 & -\frac{1}{\sqrt{2}} - \end{pmatrix} + \end{pmatrix}\end{split} $$ @@ -53,14 +53,14 @@ $$ ``` $$ - CH\ q_1, q_0 = + \begin{split}CH\ q_1, q_0 = |0\rangle\langle 0| \otimes I + |1\rangle\langle 1| \otimes H = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & \frac{1}{\sqrt{2}} & \frac{1}{\sqrt{2}} \\ 0 & 0 & \frac{1}{\sqrt{2}} & -\frac{1}{\sqrt{2}} - \end{pmatrix} + \end{pmatrix}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.md index 01f6559dd4..76e9f6e0e0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate -`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -31,14 +31,14 @@ q_1: ─■── **Matrix representation:** $$ -CPhase = +\begin{split}CPhase = I \otimes |0\rangle\langle 0| + P \otimes |1\rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & 1 & 0 \\ 0 & 0 & 0 & e^{i\lambda} - \end{pmatrix} + \end{pmatrix}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/qiskit.circuit.library.CRXGate.md index 130afebbe2..4b42d8cf44 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRXGate -`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -30,16 +30,14 @@ q_1: ┤ Rx(ϴ) ├ **Matrix representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -CRX(\theta)\ q_0, q_1 = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}CRX(\theta)\ q_0, q_1 = I \otimes |0\rangle\langle 0| + RX(\theta) \otimes |1\rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ - 0 & \cos\left(\rotationangle\right) & 0 & -i\sin\left(\rotationangle\right) \\ + 0 & \cos\left(\th\right) & 0 & -i\sin\left(\th\right) \\ 0 & 0 & 1 & 0 \\ - 0 & -i\sin\left(\rotationangle\right) & 0 & \cos\left(\rotationangle\right) - \end{pmatrix} + 0 & -i\sin\left(\th\right) & 0 & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ @@ -53,16 +51,14 @@ $$ ``` $$ - \newcommand{\rotationangle}{\frac{\theta}{2}} - - CRX(\theta)\ q_1, q_0 = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}CRX(\theta)\ q_1, q_0 = |0\rangle\langle0| \otimes I + |1\rangle\langle1| \otimes RX(\theta) = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ - 0 & 0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) \\ - 0 & 0 & -i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) - \end{pmatrix} + 0 & 0 & \cos\left(\th\right) & -i\sin\left(\th\right) \\ + 0 & 0 & -i\sin\left(\th\right) & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/qiskit.circuit.library.CRYGate.md index 41ac30da87..9fa2aa57d0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRYGate -`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -30,16 +30,14 @@ q_1: ┤ Ry(ϴ) ├ **Matrix representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -CRY(\theta)\ q_0, q_1 = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}CRY(\theta)\ q_0, q_1 = I \otimes |0\rangle\langle 0| + RY(\theta) \otimes |1\rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ - 0 & \cos\left(\rotationangle\right) & 0 & -\sin\left(\rotationangle\right) \\ + 0 & \cos\left(\th\right) & 0 & -\sin\left(\th\right) \\ 0 & 0 & 1 & 0 \\ - 0 & \sin\left(\rotationangle\right) & 0 & \cos\left(\rotationangle\right) - \end{pmatrix} + 0 & \sin\left(\th\right) & 0 & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ @@ -53,16 +51,14 @@ $$ ``` $$ - \newcommand{\rotationangle}{\frac{\theta}{2}} - - CRY(\theta)\ q_1, q_0 = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}CRY(\theta)\ q_1, q_0 = |0\rangle\langle 0| \otimes I + |1\rangle\langle 1| \otimes RY(\theta) = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ - 0 & 0 & \cos\left(\rotationangle\right) & -\sin\left(\rotationangle\right) \\ - 0 & 0 & \sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) - \end{pmatrix} + 0 & 0 & \cos\left(\th\right) & -\sin\left(\th\right) \\ + 0 & 0 & \sin\left(\th\right) & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/qiskit.circuit.library.CRZGate.md index b6f029642c..1608521448 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CRZGate -`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -32,14 +32,14 @@ q_1: ┤ Rz(λ) ├ **Matrix representation:** $$ -CRZ(\lambda)\ q_0, q_1 = +\begin{split}CRZ(\lambda)\ q_0, q_1 = I \otimes |0\rangle\langle 0| + RZ(\lambda) \otimes |1\rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & e^{-i\frac{\lambda}{2}} & 0 & 0 \\ 0 & 0 & 1 & 0 \\ 0 & 0 & 0 & e^{i\frac{\lambda}{2}} - \end{pmatrix} + \end{pmatrix}\end{split} $$ @@ -53,14 +53,14 @@ $$ ``` $$ - CRZ(\lambda)\ q_1, q_0 = + \begin{split}CRZ(\lambda)\ q_1, q_0 = |0\rangle\langle 0| \otimes I + |1\rangle\langle 1| \otimes RZ(\lambda) = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & e^{-i\frac{\lambda}{2}} & 0 \\ 0 & 0 & 0 & e^{i\frac{\lambda}{2}} - \end{pmatrix} + \end{pmatrix}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.CSGate.md b/docs/api/qiskit/qiskit.circuit.library.CSGate.md index b8db5df3f5..5371ac5d86 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSGate -`qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") @@ -30,14 +30,14 @@ q_1: ┤ S ├ **Matrix representation:** $$ -CS \ q_0, q_1 = +\begin{split}CS \ q_0, q_1 = I \otimes |0 \rangle\langle 0| + S \otimes |1 \rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & 1 & 0 \\ 0 & 0 & 0 & i - \end{pmatrix} + \end{pmatrix}\end{split} $$ Create new CS gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/qiskit.circuit.library.CSXGate.md index 30f8098962..4860c03c1b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CSXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSXGate -`qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") @@ -30,14 +30,14 @@ q_1: ┤ √X ├ **Matrix representation:** $$ -C\sqrt{X} \ q_0, q_1 = +\begin{split}C\sqrt{X} \ q_0, q_1 = I \otimes |0 \rangle\langle 0| + \sqrt{X} \otimes |1 \rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & (1 + i) / 2 & 0 & (1 - i) / 2 \\ 0 & 0 & 1 & 0 \\ 0 & (1 - i) / 2 & 0 & (1 + i) / 2 - \end{pmatrix} + \end{pmatrix}\end{split} $$ @@ -51,14 +51,14 @@ $$ ``` $$ - C\sqrt{X}\ q_1, q_0 = + \begin{split}C\sqrt{X}\ q_1, q_0 = |0 \rangle\langle 0| \otimes I + |1 \rangle\langle 1| \otimes \sqrt{X} = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & (1 + i) / 2 & (1 - i) / 2 \\ 0 & 0 & (1 - i) / 2 & (1 + i) / 2 - \end{pmatrix} + \end{pmatrix}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.CSdgGate.md b/docs/api/qiskit/qiskit.circuit.library.CSdgGate.md index 0c9a79b4e7..7005299fa7 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSdgGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CSdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSdgGate -`qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") @@ -30,14 +30,14 @@ q_1: ┤ Sdg ├ **Matrix representation:** $$ -CS^\dagger \ q_0, q_1 = +\begin{split}CS^\dagger \ q_0, q_1 = I \otimes |0 \rangle\langle 0| + S^\dagger \otimes |1 \rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & 1 & 0 \\ 0 & 0 & 0 & -i - \end{pmatrix} + \end{pmatrix}\end{split} $$ Create new CSdg gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/qiskit.circuit.library.CSwapGate.md index e5fb3e61f3..d1ea8fb4ef 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CSwapGate -`qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") @@ -31,7 +31,7 @@ q_2: ─X─ **Matrix representation:** $$ -CSWAP\ q_0, q_1, q_2 = +\begin{split}CSWAP\ q_0, q_1, q_2 = I \otimes I \otimes |0 \rangle \langle 0| + SWAP \otimes |1 \rangle \langle 1| = \begin{pmatrix} @@ -43,7 +43,7 @@ CSWAP\ q_0, q_1, q_2 = 0 & 0 & 0 & 1 & 0 & 0 & 0 & 0 \\ 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 \\ 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 \\ - \end{pmatrix} + \end{pmatrix}\end{split} $$ @@ -58,7 +58,7 @@ $$ ``` $$ - CSWAP\ q_2, q_1, q_0 = + \begin{split}CSWAP\ q_2, q_1, q_0 = |0 \rangle \langle 0| \otimes I \otimes I + |1 \rangle \langle 1| \otimes SWAP = \begin{pmatrix} @@ -70,7 +70,7 @@ $$ 0 & 0 & 0 & 0 & 0 & 0 & 1 & 0 \\ 0 & 0 & 0 & 0 & 0 & 1 & 0 & 0 \\ 0 & 0 & 0 & 0 & 0 & 0 & 0 & 1 \\ - \end{pmatrix} + \end{pmatrix}\end{split} $$ @@ -79,8 +79,6 @@ In the computational basis, this gate swaps the states of the two target qubits $$ |0, b, c\rangle \rightarrow |0, b, c\rangle |1, b, c\rangle \rightarrow |1, c, b\rangle - - $$ Create new CSWAP gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/qiskit.circuit.library.CU1Gate.md index 8c585ab64c..d61ef6c005 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CU1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU1Gate -`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -29,14 +29,14 @@ q_1: ─■── **Matrix representation:** $$ -CU1(\lambda) = +\begin{split}CU1(\lambda) = I \otimes |0\rangle\langle 0| + U1 \otimes |1\rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & 1 & 0 \\ 0 & 0 & 0 & e^{i\lambda} - \end{pmatrix} + \end{pmatrix}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/qiskit.circuit.library.CU3Gate.md index 9997d14c28..d96c9b93b9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CU3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CU3Gate -`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -30,17 +30,15 @@ q_1: ┤ U3(ϴ,φ,λ) ├ **Matrix representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -CU3(\theta, \phi, \lambda)\ q_0, q_1 = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}CU3(\theta, \phi, \lambda)\ q_0, q_1 = I \otimes |0\rangle\langle 0| + U3(\theta,\phi,\lambda) \otimes |1\rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ - 0 & \cos(\rotationangle) & 0 & -e^{i\lambda}\sin(\rotationangle) \\ + 0 & \cos(\th) & 0 & -e^{i\lambda}\sin(\th) \\ 0 & 0 & 1 & 0 \\ - 0 & e^{i\phi}\sin(\rotationangle) & 0 & e^{i(\phi+\lambda)}\cos(\rotationangle) - \end{pmatrix} + 0 & e^{i\phi}\sin(\th) & 0 & e^{i(\phi+\lambda)}\cos(\th) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ @@ -54,15 +52,15 @@ $$ ``` $$ - CU3(\theta, \phi, \lambda)\ q_1, q_0 = + \begin{split}CU3(\theta, \phi, \lambda)\ q_1, q_0 = |0\rangle\langle 0| \otimes I + |1\rangle\langle 1| \otimes U3(\theta,\phi,\lambda) = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ - 0 & 0 & \cos(\rotationangle) & -e^{i\lambda}\sin(\rotationangle) \\ - 0 & 0 & e^{i\phi}\sin(\rotationangle) & e^{i(\phi+\lambda)}\cos(\rotationangle) - \end{pmatrix} + 0 & 0 & \cos(\th) & -e^{i\lambda}\sin(\th) \\ + 0 & 0 & e^{i\phi}\sin(\th) & e^{i(\phi+\lambda)}\cos(\th) + \end{pmatrix}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/qiskit.circuit.library.CUGate.md index ba548116fc..f45ca6cf2d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CUGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CUGate -`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -32,19 +32,15 @@ q_1: ┤ U(ϴ,φ,λ,γ) ├ **Matrix representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -CU(\theta, \phi, \lambda, \gamma)\ q_0, q_1 = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}CU(\theta, \phi, \lambda, \gamma)\ q_0, q_1 = I \otimes |0\rangle\langle 0| + e^{i\gamma} U(\theta,\phi,\lambda) \otimes |1\rangle\langle 1| = \begin{pmatrix} - 1 & 0 & 0 & 0 \\ - 0 & e^{i\gamma}\cos(\rotationangle) & - 0 & -e^{i(\gamma + \lambda)}\sin(\rotationangle) \\ - 0 & 0 & 1 & 0 \\ - 0 & e^{i(\gamma+\phi)}\sin(\rotationangle) & - 0 & e^{i(\gamma+\phi+\lambda)}\cos(\rotationangle) - \end{pmatrix} + 1 & 0 & 0 & 0 \\ + 0 & e^{i\gamma}\cos(\th) & 0 & -e^{i(\gamma + \lambda)}\sin(\th) \\ + 0 & 0 & 1 & 0 \\ + 0 & e^{i(\gamma+\phi)}\sin(\th) & 0 & e^{i(\gamma+\phi+\lambda)}\cos(\th) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ @@ -58,17 +54,15 @@ $$ ``` $$ - \newcommand{\rotationangle}{\frac{\theta}{2}} - CU(\theta, \phi, \lambda, \gamma)\ q_1, q_0 = - |0\rangle\langle 0| \otimes I + - e^{i\gamma}|1\rangle\langle 1| \otimes U(\theta,\phi,\lambda) = - \begin{pmatrix} - 1 & 0 & 0 & 0 \\ - 0 & 1 & 0 & 0 \\ - 0 & 0 & e^{i\gamma} \cos(\rotationangle) & -e^{i(\gamma + \lambda)}\sin(\rotationangle) \\ - 0 & 0 & - e^{i(\gamma + \phi)}\sin(\rotationangle) & e^{i(\gamma + \phi+\lambda)}\cos(\rotationangle) - \end{pmatrix} + \begin{split}CU(\theta, \phi, \lambda, \gamma)\ q_1, q_0 = + |0\rangle\langle 0| \otimes I + + e^{i\gamma}|1\rangle\langle 1| \otimes U(\theta,\phi,\lambda) = + \begin{pmatrix} + 1 & 0 & 0 & 0 \\ + 0 & 1 & 0 & 0 \\ + 0 & 0 & e^{i\gamma} \cos(\th) & -e^{i(\gamma + \lambda)}\sin(\th) \\ + 0 & 0 & e^{i(\gamma + \phi)}\sin(\th) & e^{i(\gamma + \phi+\lambda)}\cos(\th) + \end{pmatrix}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/qiskit.circuit.library.CXGate.md index 3f18b6ccbe..e64dc71916 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CXGate -`qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") @@ -30,14 +30,14 @@ q_1: ┤ X ├ **Matrix representation:** $$ -CX\ q_0, q_1 = +\begin{split}CX\ q_0, q_1 = I \otimes |0\rangle\langle0| + X \otimes |1\rangle\langle1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 0 & 0 & 1 \\ 0 & 0 & 1 & 0 \\ 0 & 1 & 0 & 0 - \end{pmatrix} + \end{pmatrix}\end{split} $$ @@ -51,14 +51,14 @@ $$ ``` $$ - CX\ q_1, q_0 = + \begin{split}CX\ q_1, q_0 = |0 \rangle\langle 0| \otimes I + |1 \rangle\langle 1| \otimes X = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & 0 & 1 \\ 0 & 0 & 1 & 0 - \end{pmatrix} + \end{pmatrix}\end{split} $$ @@ -66,8 +66,6 @@ In the computational basis, this gate flips the target qubit if the control qubi $$ `|a, b\rangle \rightarrow |a, a \oplus b\rangle` - - $$ Create new CX gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/qiskit.circuit.library.CYGate.md index 591e29927a..dc7116e06a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CYGate -`qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") @@ -30,14 +30,14 @@ q_1: ┤ Y ├ **Matrix representation:** $$ -CY\ q_0, q_1 = +\begin{split}CY\ q_0, q_1 = I \otimes |0 \rangle\langle 0| + Y \otimes |1 \rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 0 & 0 & -i \\ 0 & 0 & 1 & 0 \\ 0 & i & 0 & 0 - \end{pmatrix} + \end{pmatrix}\end{split} $$ @@ -51,14 +51,14 @@ $$ ``` $$ - CY\ q_1, q_0 = + \begin{split}CY\ q_1, q_0 = |0 \rangle\langle 0| \otimes I + |1 \rangle\langle 1| \otimes Y = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & 0 & -i \\ 0 & 0 & i & 0 - \end{pmatrix} + \end{pmatrix}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/qiskit.circuit.library.CZGate.md index b99f5a5f3c..fb0d5eeef2 100644 --- a/docs/api/qiskit/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.CZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.CZGate -`qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate") @@ -31,14 +31,14 @@ q_1: ─■─ **Matrix representation:** $$ -CZ\ q_0, q_1 = +\begin{split}CZ\ q_0, q_1 = I \otimes |0\rangle\langle 0| + Z \otimes |1\rangle\langle 1| = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & 1 & 0 \\ 0 & 0 & 0 & -1 - \end{pmatrix} + \end{pmatrix}\end{split} $$ In the computational basis, this gate flips the phase of the target qubit if the control qubit is in the $|1\rangle$ state. diff --git a/docs/api/qiskit/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/qiskit.circuit.library.DCXGate.md index 59c8f679ef..e7204026fe 100644 --- a/docs/api/qiskit/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.DCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DCXGate -`qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/dcx.py "view source code") +`qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -31,13 +31,13 @@ q_1: ┤ X ├──■── This is a classical logic gate, equivalent to a CNOT-SWAP (CNS) sequence, and locally equivalent to an iSWAP. $$ -DCX\ q_0, q_1 = +\begin{split}DCX\ q_0, q_1 = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 0 & 0 & 1 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & 1 & 0 - \end{pmatrix} + \end{pmatrix}\end{split} $$ Create new DCX gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/qiskit.circuit.library.Diagonal.md index f12cdb6215..1e29ef9c06 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/qiskit.circuit.library.Diagonal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Diagonal -`qiskit.circuit.library.Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`qiskit.circuit.library.Diagonal(diag)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -31,15 +31,13 @@ q_2: ┤2 ├ Matrix form: $$ -\text{DiagonalGate}\ q_0, q_1, .., q_{n-1} = +\begin{split}\text{DiagonalGate}\ q_0, q_1, .., q_{n-1} = \begin{pmatrix} D[0] & 0 & \dots & 0 \\ 0 & D[1] & \dots & 0 \\ \vdots & \vdots & \ddots & 0 \\ 0 & 0 & \dots & D[n-1] - \end{pmatrix} - - + \end{pmatrix}\end{split} $$ Diagonal gates are useful as representations of Boolean functions, as they can map from $\{0,1\}^{2^n}$ to $\{0,1\}^{2^n}$ space. For example a phase oracle can be seen as a diagonal gate with $\{1, -1\}$ on the diagonals. Such an oracle will induce a $+1$ or :math\`-1\` phase on the amplitude of any corresponding basis state. @@ -120,7 +118,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 167` +`= 159` diff --git a/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.md b/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.md index 4166007c66..1b2c612187 100644 --- a/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.DiagonalGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DiagonalGate -`qiskit.circuit.library.DiagonalGate(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") +`qiskit.circuit.library.DiagonalGate(diag)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.md index bb1e77e270..72d0b1c10d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/qiskit.circuit.library.DraperQFTAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder -`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") +`qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` Bases: `Adder` @@ -109,7 +109,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 167` +`= 159` diff --git a/docs/api/qiskit/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/qiskit.circuit.library.ECRGate.md index 1143367b1a..dfccef0662 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.ECRGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ECRGate -`qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ecr.py "view source code") +`qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -33,13 +33,13 @@ q_1: ┤1 ├ q_1: ┤1 ├────────── **Matrix Representation:** $$ -ECR\ q_0, q_1 = \frac{1}{\sqrt{2}} +\begin{split}ECR\ q_0, q_1 = \frac{1}{\sqrt{2}} \begin{pmatrix} 0 & 1 & 0 & i \\ 1 & 0 & -i & 0 \\ 0 & i & 0 & 1 \\ -i & 0 & 1 & 0 - \end{pmatrix} + \end{pmatrix}\end{split} $$ @@ -54,13 +54,13 @@ $$ ``` $$ - ECR\ q_0, q_1 = \frac{1}{\sqrt{2}} + \begin{split}ECR\ q_0, q_1 = \frac{1}{\sqrt{2}} \begin{pmatrix} 0 & 0 & 1 & i \\ 0 & 0 & i & 1 \\ 1 & -i & 0 & 0 \\ -i & 1 & 0 & 0 - \end{pmatrix} + \end{pmatrix}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.md index a1e539338b..13e9b26271 100644 --- a/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/qiskit.circuit.library.EfficientSU2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2 -`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/efficient_su2.py "view source code") +`qiskit.circuit.library.EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2', flatten=None)` Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") @@ -171,7 +171,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 167` +`= 159` diff --git a/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.md index 11f308d319..0bb655f1cc 100644 --- a/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz -`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") +`qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)` Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -135,7 +135,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 167` +`= 159` diff --git a/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.md index 4714ce497d..22805dc7a6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/qiskit.circuit.library.ExactReciprocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal -`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") +`qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -89,7 +89,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 167` +`= 159` diff --git a/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.md index 8997d4f7cf..be9aecbb34 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/qiskit.circuit.library.ExcitationPreserving.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving -`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") +`qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)` Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") @@ -19,14 +19,12 @@ The heuristic excitation-preserving wave function ansatz. The `ExcitationPreserving` circuit preserves the ratio of $|00\rangle$, $|01\rangle + |10\rangle$ and $|11\rangle$ states. To this end, this circuit uses two-qubit interactions of the form $$ -\newcommand{\rotationangle}{\theta/2} - -\begin{pmatrix} + \begin{align}\begin{aligned}\newcommand{\th}{\theta/2}\\\begin{split}\begin{pmatrix} 1 & 0 & 0 & 0 \\ -0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) & 0 \\ -0 & -i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) & 0 \\ +0 & \cos\left(\th\right) & -i\sin\left(\th\right) & 0 \\ +0 & -i\sin\left(\th\right) & \cos\left(\th\right) & 0 \\ 0 & 0 & 0 & e^{-i\phi} -\end{pmatrix} +\end{pmatrix}\end{split}\end{aligned}\end{align} $$ for the mode `'fsim'` or with $e^{-i\phi} = 1$ for the mode `'iswap'`. @@ -87,6 +85,7 @@ q_2: ┤ RZ(θ[2]) ├─░─┤1 ├┤1 ├─■── * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]]*) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A QuantumCircuit object to prepend to the circuit. * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. +* **skip\_unentangled\_qubits** – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If True, a rotation layer is added at the end of the ansatz. If False, no rotation layer is added. Defaults to True. * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – 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.12)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. @@ -190,7 +189,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 167` +`= 159` diff --git a/docs/api/qiskit/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/qiskit.circuit.library.FourierChecking.md index de9b4073a5..b234630df7 100644 --- a/docs/api/qiskit/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/qiskit.circuit.library.FourierChecking.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FourierChecking -`qiskit.circuit.library.FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/fourier_checking.py "view source code") +`qiskit.circuit.library.FourierChecking(f, g)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -103,7 +103,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 175` +`= 167` diff --git a/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.md index 2b347945bc..6ca0ce62dd 100644 --- a/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/qiskit.circuit.library.FunctionalPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations -`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") +`qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` Bases: `BlueprintCircuit`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") @@ -84,7 +84,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 177` +`= 169` diff --git a/docs/api/qiskit/qiskit.circuit.library.GMS.md b/docs/api/qiskit/qiskit.circuit.library.GMS.md index 388ed76392..cd7afc3c41 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/qiskit.circuit.library.GMS.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GMS -`qiskit.circuit.library.GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.GMS(num_qubits, theta)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -112,7 +112,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 178` +`= 170` diff --git a/docs/api/qiskit/qiskit.circuit.library.GR.md b/docs/api/qiskit/qiskit.circuit.library.GR.md index ce076f998f..4f34a8008d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/qiskit.circuit.library.GR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GR -`qiskit.circuit.library.GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GR(num_qubits, theta, phi)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -106,7 +106,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 187` +`= 179` diff --git a/docs/api/qiskit/qiskit.circuit.library.GRX.md b/docs/api/qiskit/qiskit.circuit.library.GRX.md index 2cf4dd9ad0..8788ab905e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/qiskit.circuit.library.GRX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRX -`qiskit.circuit.library.GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRX(num_qubits, theta)` Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") @@ -105,7 +105,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 188` +`= 180` diff --git a/docs/api/qiskit/qiskit.circuit.library.GRY.md b/docs/api/qiskit/qiskit.circuit.library.GRY.md index e09acda16f..3d924b9014 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/qiskit.circuit.library.GRY.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRY -`qiskit.circuit.library.GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRY(num_qubits, theta)` Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") @@ -105,7 +105,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 188` +`= 180` diff --git a/docs/api/qiskit/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/qiskit.circuit.library.GRZ.md index c3249d902f..8864130851 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/qiskit.circuit.library.GRZ.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GRZ -`qiskit.circuit.library.GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gr.py "view source code") +`qiskit.circuit.library.GRZ(num_qubits, phi)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -105,7 +105,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 198` +`= 190` diff --git a/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.md b/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.md index baca94e36a..944c30afa6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.GlobalPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate -`qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/global_phase.py "view source code") +`qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -25,8 +25,6 @@ $$ \begin{pmatrix} e^{i\theta} \end{pmatrix} - - $$ **Parameters** diff --git a/docs/api/qiskit/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/qiskit.circuit.library.GraphState.md index 43c502ffbd..b6411f8306 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/qiskit.circuit.library.GraphState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GraphState -`qiskit.circuit.library.GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/graph_state.py "view source code") +`qiskit.circuit.library.GraphState(adjacency_matrix)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -110,7 +110,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 203` +`= 195` diff --git a/docs/api/qiskit/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/qiskit.circuit.library.GroverOperator.md index 439f078029..ad00a3c9ad 100644 --- a/docs/api/qiskit/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/qiskit.circuit.library.GroverOperator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.GroverOperator -`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/grover_operator.py "view source code") +`qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -20,8 +20,6 @@ Grover’s search algorithm \[1, 2] consists of repeated applications of the so- $$ \mathcal{Q} = \mathcal{A} \mathcal{S}_0 \mathcal{A}^\dagger \mathcal{S}_f - - $$ In the standard Grover search we have $\mathcal{A} = H^{\otimes n}$: @@ -29,8 +27,6 @@ In the standard Grover search we have $\mathcal{A} = H^{\otimes n}$: $$ \mathcal{Q} = H^{\otimes n} \mathcal{S}_0 H^{\otimes n} \mathcal{S}_f = D \mathcal{S_f} - - $$ The operation $D = H^{\otimes n} \mathcal{S}_0 H^{\otimes n}$ is also referred to as diffusion operator. In this formulation we can see that Grover’s operator consists of two steps: first, the phase oracle multiplies the good states by -1 (with $\mathcal{S}_f$) and then the whole state is reflected around the mean (with $D$). @@ -41,8 +37,6 @@ The action of the phase oracle $\mathcal{S}_f$ is defined as $$ \mathcal{S}_f: |x\rangle \mapsto (-1)^{f(x)}|x\rangle - - $$ where $f(x) = 1$ if $x$ is a good state and 0 otherwise. To highlight the fact that this oracle flips the phase of the good states and does not flip the state of a result qubit, we call $\mathcal{S}_f$ a phase oracle. @@ -63,8 +57,6 @@ The zero reflection $\mathcal{S}_0$ is usually defined as $$ \mathcal{S}_0 = 2 |0\rangle^{\otimes n} \langle 0|^{\otimes n} - \mathbb{I}_n - - $$ where $\mathbb{I}_n$ is the identity on $n$ qubits. By default, this class implements the negative version $2 |0\rangle^{\otimes n} \langle 0|^{\otimes n} - \mathbb{I}_n$, since this can simply be implemented with a multi-controlled Z sandwiched by X gates on the target qubit and the introduced global phase does not matter for Grover’s algorithm. @@ -221,7 +213,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 205` +`= 197` diff --git a/docs/api/qiskit/qiskit.circuit.library.HGate.md b/docs/api/qiskit/qiskit.circuit.library.HGate.md index c042e26076..0246d74b0e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.HGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HGate -`qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/h.py "view source code") +`qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -31,11 +31,11 @@ q_0: ┤ H ├ **Matrix Representation:** $$ -H = \frac{1}{\sqrt{2}} +\begin{split}H = \frac{1}{\sqrt{2}} \begin{pmatrix} 1 & 1 \\ 1 & -1 - \end{pmatrix} + \end{pmatrix}\end{split} $$ Create new H gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.md index db01090644..041635c432 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier -`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") +`qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` Bases: `Multiplier` @@ -122,7 +122,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 205` +`= 197` diff --git a/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.md b/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.md index 87942e621a..45f8018157 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.HamiltonianGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate -`qiskit.circuit.library.HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/hamiltonian_gate.py "view source code") +`qiskit.circuit.library.HamiltonianGate(data, time, label=None)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.md index 2f43281a84..b383e365aa 100644 --- a/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/qiskit.circuit.library.HiddenLinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction -`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/hidden_linear_function.py "view source code") +`qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -112,7 +112,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 161` +`= 199` diff --git a/docs/api/qiskit/qiskit.circuit.library.IGate.md b/docs/api/qiskit/qiskit.circuit.library.IGate.md index 2c342ec343..a9ae5ea962 100644 --- a/docs/api/qiskit/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.IGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IGate -`qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/i.py "view source code") +`qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -23,10 +23,10 @@ Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.cir **Matrix Representation:** $$ -I = \begin{pmatrix} +\begin{split}I = \begin{pmatrix} 1 & 0 \\ 0 & 1 - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Circuit symbol:** diff --git a/docs/api/qiskit/qiskit.circuit.library.IQP.md b/docs/api/qiskit/qiskit.circuit.library.IQP.md index fbe96aa990..c8429acfe1 100644 --- a/docs/api/qiskit/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/qiskit.circuit.library.IQP.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IQP -`qiskit.circuit.library.IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/iqp.py "view source code") +`qiskit.circuit.library.IQP(interactions)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -100,7 +100,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 166` +`= 204` diff --git a/docs/api/qiskit/qiskit.circuit.library.Initialize.md b/docs/api/qiskit/qiskit.circuit.library.Initialize.md index 2d217ed549..959e6593a9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Initialize.md +++ b/docs/api/qiskit/qiskit.circuit.library.Initialize.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Initialize -`qiskit.circuit.library.Initialize(params, num_qubits=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/initializer.py "view source code") +`qiskit.circuit.library.Initialize(params, num_qubits=None, normalize=False)` Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/qiskit.circuit.library.InnerProduct.md index eae2e78f3c..93af6fb3ed 100644 --- a/docs/api/qiskit/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/qiskit.circuit.library.InnerProduct.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.InnerProduct -`qiskit.circuit.library.InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") +`qiskit.circuit.library.InnerProduct(num_qubits)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -111,7 +111,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 179` +`= 217` diff --git a/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.md index 6d6bcd695a..c97976435b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/qiskit.circuit.library.IntegerComparator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.IntegerComparator -`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") +`qiskit.circuit.library.IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` Bases: `BlueprintCircuit` @@ -91,7 +91,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 181` +`= 219` diff --git a/docs/api/qiskit/qiskit.circuit.library.Isometry.md b/docs/api/qiskit/qiskit.circuit.library.Isometry.md index ff302fca79..65f2543d99 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Isometry.md +++ b/docs/api/qiskit/qiskit.circuit.library.Isometry.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Isometry -`qiskit.circuit.library.Isometry(isometry, num_ancillas_zero, num_ancillas_dirty, epsilon=1e-10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/isometry.py "view source code") +`qiskit.circuit.library.Isometry(isometry, num_ancillas_zero, num_ancillas_dirty, epsilon=1e-10)` Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.md index 9d0cf8b4b3..63e57119d4 100644 --- a/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearAmplitudeFunction -`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") +`qiskit.circuit.library.LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -126,7 +126,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 181` +`= 219` diff --git a/docs/api/qiskit/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/qiskit.circuit.library.LinearFunction.md index fc910e432a..94a6f356d5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/qiskit.circuit.library.LinearFunction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearFunction -`qiskit.circuit.library.LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") +`qiskit.circuit.library.LinearFunction(linear, validate_input=False)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -35,11 +35,11 @@ q_2: ───── is represented by a 3x3 linear matrix $$ -\begin{pmatrix} +\begin{split}\begin{pmatrix} 1 & 0 & 0 \\ 1 & 1 & 0 \\ 0 & 0 & 1 -\end{pmatrix} +\end{pmatrix}\end{split} $$ **References:** @@ -50,8 +50,8 @@ Create a new linear function. **Parameters** -* **linear** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*] | np.ndarray\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*] |* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*LinearFunction*](#qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction") *|*[*PermutationGate*](qiskit.circuit.library.PermutationGate "qiskit.circuit.library.PermutationGate") *|*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – data from which a linear function can be constructed. It can be either a nxn matrix (describing the linear transformation), a permutation (which is a special case of a linear function), another linear function, a clifford (when it corresponds to a linear function), or a quantum circuit composed of linear gates (CX and SWAP) and other objects described above, including nested subcircuits. -* **validate\_input** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if True, performs more expensive input validation checks, such as checking that a given n x n matrix is invertible. +* **LinearFunction** (*linear (*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*] or ndarray\[*[*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*] or QuantumCircuit or*) – or PermutationGate or Clifford): data from which a linear function can be constructed. It can be either a nxn matrix (describing the linear transformation), a permutation (which is a special case of a linear function), another linear function, a clifford (when it corresponds to a linear function), or a quantum circuit composed of linear gates (CX and SWAP) and other objects described above, including nested subcircuits. +* **validate\_input** – if True, performs more expensive input validation checks, such as checking that a given n x n matrix is invertible. **Raises** diff --git a/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.md index 698c2069af..6f892b2a7a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/qiskit.circuit.library.LinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.LinearPauliRotations -`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -107,7 +107,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 181` +`= 219` diff --git a/docs/api/qiskit/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/qiskit.circuit.library.MCMT.md index 9ec4142d01..27605628af 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCMT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMT -`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMT(gate, num_ctrl_qubits, num_target_qubits)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -104,7 +104,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 181` +`= 219` diff --git a/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.md index 662241f838..9255b89cb4 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCMTVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCMTVChain -`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") +`qiskit.circuit.library.MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` Bases: [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") @@ -128,7 +128,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 182` +`= 220` diff --git a/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.md index b4f6daa56c..56902e6380 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCPhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCPhaseGate -`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.MCPhaseGate(lam, num_ctrl_qubits, label=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/qiskit.circuit.library.MCXGate.md index 7ed72e21f7..180e23708c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGate -`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.md index b7a54907c7..7ca4bbeb39 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCXGrayCode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXGrayCode -`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.md index ebe1c08042..01c64d842d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCXRecursive.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXRecursive -`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/qiskit.circuit.library.MCXVChain.md index 095c07c7a0..0d5b0d3e5b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/qiskit.circuit.library.MCXVChain.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MCXVChain -`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)` Bases: [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/qiskit.circuit.library.MSGate.md index 900219b2cc..3845bd9da0 100644 --- a/docs/api/qiskit/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.MSGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.MSGate -`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/gms.py "view source code") +`qiskit.circuit.library.MSGate(num_qubits, theta, label=None)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.Measure.md b/docs/api/qiskit/qiskit.circuit.library.Measure.md index fdf4c6ec68..7dbaa91a60 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/qiskit.circuit.library.Measure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Measure -`qiskit.circuit.library.Measure(label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/measure.py "view source code") +`qiskit.circuit.library.Measure(label=None, *, duration=None, unit='dt')` Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/qiskit.circuit.library.NLocal.md index 7f8f294a04..c9adcd629c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/qiskit.circuit.library.NLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.NLocal -`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/n_local.py "view source code") +`qiskit.circuit.library.NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal', flatten=None)` Bases: `BlueprintCircuit` @@ -157,7 +157,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 183` +`= 221` diff --git a/docs/api/qiskit/qiskit.circuit.library.OR.md b/docs/api/qiskit/qiskit.circuit.library.OR.md index 6d2faef0af..f71516eb66 100644 --- a/docs/api/qiskit/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/qiskit.circuit.library.OR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.OR -`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") +`qiskit.circuit.library.OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -92,7 +92,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 186` +`= 224` diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.md index b0595276aa..045c7ffcc6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.PauliEvolutionGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliEvolutionGate -`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/pauli_evolution.py "view source code") +`qiskit.circuit.library.PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.md index c2556efc90..445977ce7e 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/qiskit.circuit.library.PauliFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliFeatureMap -`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") +`qiskit.circuit.library.PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -26,10 +26,10 @@ $$ Here, $S$ is a set of qubit indices that describes the connections in the feature map, $\mathcal{I}$ is a set containing all these index sets, and $P_i \in \{I, X, Y, Z\}$. Per default the data-mapping $\phi_S$ is $$ -\phi_S(\vec{x}) = \begin{cases} +\begin{split}\phi_S(\vec{x}) = \begin{cases} x_i \text{ if } S = \{i\} \\ \prod_{j \in S} (\pi - x_j) \text{ if } |S| > 1 - \end{cases}. + \end{cases}.\end{split} $$ The possible connections can be set using the `entanglement` and `paulis` arguments. For example, for single-qubit $Z$ rotations and two-qubit $YY$ interactions between all qubit pairs, we can set: @@ -220,7 +220,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 191` +`= 229` diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/qiskit.circuit.library.PauliGate.md index 0df193f63e..5b24dac70c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.PauliGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliGate -`qiskit.circuit.library.PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/pauli.py "view source code") +`qiskit.circuit.library.PauliGate(label)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.md index 1fd2664c11..8963f83501 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/qiskit.circuit.library.PauliTwoDesign.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PauliTwoDesign -`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") +`qiskit.circuit.library.PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") @@ -56,10 +56,17 @@ circuit.draw('mpl') **Parameters** -* **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The number of qubits of the Pauli Two-Design circuit. +* **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The number of qubits of the two-local circuit. +* **rotation\_blocks** – The gates used in the rotation layer. Can be specified via the name of a gate (e.g. `'ry'`) or the gate type itself (e.g. [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate")). If only one gate is provided, the gate same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. See the Examples section for more detail. +* **entanglement\_blocks** – The gates used in the entanglement layer. Can be specified in the same format as `rotation_blocks`. +* **entanglement** – Specifies the entanglement structure. Can be a string (`'full'`, `'linear'`, `'reverse_linear'`, `'circular'` or `'sca'`), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. Default to `'full'` entanglement. Note that if `entanglement_blocks = 'cx'`, then `'full'` entanglement provides the same unitary as `'reverse_linear'` but the latter option has fewer entangling gates. See the Examples section for more detail. * **reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – 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.12)") *| None*) – The seed for randomly choosing the axes of the Pauli rotations. +* **skip\_unentangled\_qubits** – If `True`, the single qubit gates are only applied to qubits that are entangled with another qubit. If `False`, the single qubit gates are applied to each qubit in the ansatz. Defaults to `False`. +* **skip\_final\_rotation\_layer** – If `False`, a rotation layer is added at the end of the ansatz. If `True`, no rotation layer is added. +* **parameter\_prefix** – The parameterized gates require a parameter to be defined, for which we use instances of [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter"). The name of each parameter will be this specified prefix plus its index. * **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If `True`, barriers are inserted in between each layer. If `False`, no barriers are inserted. Defaults to `False`. +* **initial\_state** – A [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object to prepend to the circuit. +* **flatten** – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. ## Attributes @@ -155,7 +162,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 192` +`= 230` diff --git a/docs/api/qiskit/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/qiskit.circuit.library.Permutation.md index 7a8b49e3ad..4044757e68 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/qiskit.circuit.library.Permutation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Permutation -`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.Permutation(num_qubits, pattern=None, seed=None)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -94,7 +94,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 210` +`= 248` diff --git a/docs/api/qiskit/qiskit.circuit.library.PermutationGate.md b/docs/api/qiskit/qiskit.circuit.library.PermutationGate.md index ae840a2a30..e6e09f7c16 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PermutationGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.PermutationGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PermutationGate -`qiskit.circuit.library.PermutationGate(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/permutation.py "view source code") +`qiskit.circuit.library.PermutationGate(pattern)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.md index dd41f42679..0b073cf887 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/qiskit.circuit.library.PhaseEstimation.md @@ -10,13 +10,13 @@ python_api_name: qiskit.circuit.library.PhaseEstimation -`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/phase_estimation.py "view source code") +`qiskit.circuit.library.PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") Phase Estimation circuit. -In the Quantum Phase Estimation (QPE) algorithm \[1, 2, 3], the Phase Estimation circuit is used to estimate the phase $\phi$ of an eigenvalue $e^{2\pi i\phi}$ of a unitary operator $U$, provided with the corresponding eigenstate $|\psi\rangle$. That is +In the Quantum Phase Estimation (QPE) algorithm \[1, 2, 3], the Phase Estimation circuit is used to estimate the phase $\phi$ of an eigenvalue $e^{2\pi i\phi}$ of a unitary operator $U$, provided with the corresponding eigenstate $|psi\rangle$. That is $$ U|\psi\rangle = e^{2\pi i\phi} |\psi\rangle @@ -36,7 +36,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) **\[3]: Qiskit** -[textbook](https://github.com/Qiskit/textbook/blob/main/notebooks/ch-algorithms/quantum-phase-estimation.ipynb) +[textbook](https://learn.qiskit.org/course/ch-algorithms/quantum-phase-estimation) **Parameters** @@ -111,7 +111,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 264` +`= 302` diff --git a/docs/api/qiskit/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/qiskit.circuit.library.PhaseGate.md index 7ba7ce5a0d..833e226e46 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.PhaseGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseGate -`qiskit.circuit.library.PhaseGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/p.py "view source code") +`qiskit.circuit.library.PhaseGate(theta, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -31,11 +31,11 @@ q_0: ┤ P(λ) ├ **Matrix Representation:** $$ -P(\lambda) = +\begin{split}P(\lambda) = \begin{pmatrix} 1 & 0 \\ 0 & e^{i\lambda} - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Examples:** diff --git a/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.md index fea1809c27..1aa2c17f40 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/qiskit.circuit.library.PhaseOracle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PhaseOracle -`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/phase_oracle.py "view source code") +`qiskit.circuit.library.PhaseOracle(expression, synthesizer=None, var_order=None)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -88,7 +88,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 266` +`= 304` diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.md index 11f3b2c7a9..17cc33201d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewiseChebyshev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseChebyshev -`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") +`qiskit.circuit.library.PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` Bases: `BlueprintCircuit` @@ -133,7 +133,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 268` +`= 306` diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index 2ca0a368dd..01e28a133a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations -`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -19,10 +19,10 @@ Piecewise-linearly-controlled Pauli rotations. For a piecewise linear (not necessarily continuous) function $f(x)$, which is defined through breakpoints, slopes and offsets as follows. Suppose the breakpoints $(x_0, ..., x_J)$ are a subset of $[0, 2^n-1]$, where $n$ is the number of state qubits. Further on, denote the corresponding slopes and offsets by $a_j$ and $b_j$ respectively. Then f(x) is defined as: $$ -f(x) = \begin{cases} +\begin{split}f(x) = \begin{cases} 0, x < x_0 \\ a_j (x - x_j) + b_j, x_j \leq x < x_{j+1} - \end{cases} + \end{cases}\end{split} $$ where we implicitly assume $x_{J+1} = 2^n$. @@ -116,7 +116,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 328` +`= 366` diff --git a/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 6959dccbb8..b4d7887e9b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations -`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -21,10 +21,10 @@ This class implements a piecewise polynomial (not necessarily continuous) functi Then $f(x)$ is defined as: $$ -f(x) = \begin{cases} +\begin{split}f(x) = \begin{cases} 0, x < x_0 \\ \sum_{i=0}^{i=d}a_{j,i}/2 x^i, x_j \leq x < x_{j+1} - \end{cases} + \end{cases}\end{split} $$ where if given the same number of breakpoints as polynomials, we implicitly assume $x_{J+1} = 2^n$. @@ -174,7 +174,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 268` +`= 306` diff --git a/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.md index 9ab40ea798..b34067be9c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/qiskit.circuit.library.PolynomialPauliRotations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.PolynomialPauliRotations -`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") +`qiskit.circuit.library.PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` Bases: [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -134,7 +134,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 271` +`= 309` diff --git a/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.md index 8d3b6a9ea9..c39108ade6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/qiskit.circuit.library.QAOAAnsatz.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QAOAAnsatz -`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") +`qiskit.circuit.library.QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA', flatten=None)` Bases: [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") @@ -149,7 +149,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 328` +`= 366` diff --git a/docs/api/qiskit/qiskit.circuit.library.QFT.md b/docs/api/qiskit/qiskit.circuit.library.QFT.md index d888555ab8..d47c0775cd 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/qiskit.circuit.library.QFT.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QFT -`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/basis_change/qft.py "view source code") +`qiskit.circuit.library.QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` Bases: `BlueprintCircuit` @@ -127,7 +127,7 @@ True, if barriers are inserted, False if not. ### instances -`= 226` +`= 264` diff --git a/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.md index dc0618c675..d4ed4c7a3a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/qiskit.circuit.library.QuadraticForm.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuadraticForm -`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") +`qiskit.circuit.library.QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -113,7 +113,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 340` +`= 378` diff --git a/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.md index 0ebf595064..a00540f4e1 100644 --- a/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/qiskit.circuit.library.QuantumVolume.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.QuantumVolume -`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/quantum_volume.py "view source code") +`qiskit.circuit.library.QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -99,7 +99,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 343` +`= 162` diff --git a/docs/api/qiskit/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/qiskit.circuit.library.RC3XGate.md index 9d953d0374..6cc1625446 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RC3XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RC3XGate -`qiskit.circuit.library.RC3XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RC3XGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/qiskit.circuit.library.RCCXGate.md index 8c56065d43..885f07426b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RCCXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RCCXGate -`qiskit.circuit.library.RCCXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.RCCXGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.md index c1fa5648d3..a00df82778 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/qiskit.circuit.library.RGQFTMultiplier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGQFTMultiplier -`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") +`qiskit.circuit.library.RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` Bases: `Multiplier` @@ -101,7 +101,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 474` +`= 293` diff --git a/docs/api/qiskit/qiskit.circuit.library.RGate.md b/docs/api/qiskit/qiskit.circuit.library.RGate.md index 8a8ccc74a4..68954bfaf3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RGate -`qiskit.circuit.library.RGate(theta, phi, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/r.py "view source code") +`qiskit.circuit.library.RGate(theta, phi, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -29,13 +29,11 @@ q_0: ┤ R(ϴ) ├ **Matrix Representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -R(\theta, \phi) = e^{-i \rotationangle \left(\cos{\phi} x + \sin{\phi} y\right)} = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}R(\theta, \phi) = e^{-i \th \left(\cos{\phi} x + \sin{\phi} y\right)} = \begin{pmatrix} - \cos\left(\rotationangle\right) & -i e^{-i \phi} \sin\left(\rotationangle\right) \\ - -i e^{i \phi} \sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) - \end{pmatrix} + \cos\left(\th\right) & -i e^{-i \phi} \sin\left(\th\right) \\ + -i e^{i \phi} \sin\left(\th\right) & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ Create new r single-qubit gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/qiskit.circuit.library.RVGate.md index ced6c33df2..d4cf72b3b2 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RVGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RVGate -`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/rv.py "view source code") +`qiskit.circuit.library.RVGate(v_x, v_y, v_z, basis='U')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -29,15 +29,15 @@ q_0: ┤ RV(v_x,v_y,v_z) ├ **Matrix Representation:** $$ -\newcommand{\rotationangle}{|\vec{v}|} +\begin{split}\newcommand{\th}{|\vec{v}|} \newcommand{\sinc}{\text{sinc}} R(\vec{v}) = e^{-i \vec{v}\cdot\vec{\sigma}} = \begin{pmatrix} - \cos\left(\rotationangle\right) -i v_z \sinc\left(\rotationangle\right) - & -(i v_x + v_y) \sinc\left(\rotationangle\right) \\ - -(i v_x - v_y) \sinc\left(\rotationangle\right) - & \cos\left(\rotationangle\right) + i v_z \sinc\left(\rotationangle\right) - \end{pmatrix} + \cos\left(\th\right) -i v_z \sinc\left(\th\right) + & -(i v_x + v_y) \sinc\left(\th\right) \\ + -(i v_x - v_y) \sinc\left(\th\right) + & \cos\left(\th\right) + i v_z \sinc\left(\th\right) + \end{pmatrix}\end{split} $$ Create new rv single-qubit gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/qiskit.circuit.library.RXGate.md index f0e5ce0284..64058b9952 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXGate -`qiskit.circuit.library.RXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rx.py "view source code") +`qiskit.circuit.library.RXGate(theta, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -29,13 +29,11 @@ q_0: ┤ Rx(ϴ) ├ **Matrix Representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -RX(\theta) = \exp\left(-i \rotationangle X\right) = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}RX(\theta) = \exp\left(-i \th X\right) = \begin{pmatrix} - \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) \\ - -i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) - \end{pmatrix} + \cos\left(\th\right) & -i\sin\left(\th\right) \\ + -i\sin\left(\th\right) & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ Create new RX gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/qiskit.circuit.library.RXXGate.md index 24061aa495..7eefd92c19 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RXXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RXXGate -`qiskit.circuit.library.RXXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rxx.py "view source code") +`qiskit.circuit.library.RXXGate(theta, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -33,15 +33,13 @@ q_1: ┤0 ├ **Matrix Representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -R_{XX}(\theta) = \exp\left(-i \rotationangle X{\otimes}X\right) = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}R_{XX}(\theta) = \exp\left(-i \th X{\otimes}X\right) = \begin{pmatrix} - \cos\left(\rotationangle\right) & 0 & 0 & -i\sin\left(\rotationangle\right) \\ - 0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) & 0 \\ - 0 & -i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) & 0 \\ - -i\sin\left(\rotationangle\right) & 0 & 0 & \cos\left(\rotationangle\right) - \end{pmatrix} + \cos\left(\th\right) & 0 & 0 & -i\sin\left(\th\right) \\ + 0 & \cos\left(\th\right) & -i\sin\left(\th\right) & 0 \\ + 0 & -i\sin\left(\th\right) & \cos\left(\th\right) & 0 \\ + -i\sin\left(\th\right) & 0 & 0 & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ **Examples:** @@ -55,13 +53,13 @@ $$ > $$ > > $$ -> R_{XX}\left(\theta = \frac{\pi}{2}\right) = \frac{1}{\sqrt{2}} +> \begin{split}R_{XX}\left(\theta = \frac{\pi}{2}\right) = \frac{1}{\sqrt{2}} > \begin{pmatrix} > 1 & 0 & 0 & -i \\ > 0 & 1 & -i & 0 \\ > 0 & -i & 1 & 0 \\ > -i & 0 & 0 & 1 -> \end{pmatrix} +> \end{pmatrix}\end{split} > $$ Create new RXX gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/qiskit.circuit.library.RYGate.md index 3c79f9edb3..9bfaba2a6c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYGate -`qiskit.circuit.library.RYGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ry.py "view source code") +`qiskit.circuit.library.RYGate(theta, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -29,13 +29,11 @@ q_0: ┤ Ry(ϴ) ├ **Matrix Representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -RY(\theta) = \exp\left(-i \rotationangle Y\right) = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}RY(\theta) = \exp\left(-i \th Y\right) = \begin{pmatrix} - \cos\left(\rotationangle\right) & -\sin\left(\rotationangle\right) \\ - \sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) - \end{pmatrix} + \cos\left(\th\right) & -\sin\left(\th\right) \\ + \sin\left(\th\right) & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ Create new RY gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/qiskit.circuit.library.RYYGate.md index 5cf099df23..e375d2d21c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RYYGate -`qiskit.circuit.library.RYYGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/ryy.py "view source code") +`qiskit.circuit.library.RYYGate(theta, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -33,15 +33,13 @@ q_1: ┤0 ├ **Matrix Representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -R_{YY}(\theta) = \exp\left(-i \rotationangle Y{\otimes}Y\right) = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}R_{YY}(\theta) = \exp\left(-i \th Y{\otimes}Y\right) = \begin{pmatrix} - \cos\left(\rotationangle\right) & 0 & 0 & i\sin\left(\rotationangle\right) \\ - 0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) & 0 \\ - 0 & -i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) & 0 \\ - i\sin\left(\rotationangle\right) & 0 & 0 & \cos\left(\rotationangle\right) - \end{pmatrix} + \cos\left(\th\right) & 0 & 0 & i\sin\left(\th\right) \\ + 0 & \cos\left(\th\right) & -i\sin\left(\th\right) & 0 \\ + 0 & -i\sin\left(\th\right) & \cos\left(\th\right) & 0 \\ + i\sin\left(\th\right) & 0 & 0 & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ **Examples:** @@ -55,13 +53,13 @@ $$ > $$ > > $$ -> R_{YY}\left(\theta = \frac{\pi}{2}\right) = \frac{1}{\sqrt{2}} +> \begin{split}R_{YY}\left(\theta = \frac{\pi}{2}\right) = \frac{1}{\sqrt{2}} > \begin{pmatrix} > 1 & 0 & 0 & i \\ > 0 & 1 & -i & 0 \\ > 0 & -i & 1 & 0 \\ > i & 0 & 0 & 1 -> \end{pmatrix} +> \end{pmatrix}\end{split} > $$ Create new RYY gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/qiskit.circuit.library.RZGate.md index 0df7f8ba42..ea936edc54 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZGate -`qiskit.circuit.library.RZGate(phi, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rz.py "view source code") +`qiskit.circuit.library.RZGate(phi, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -31,11 +31,11 @@ q_0: ┤ Rz(λ) ├ **Matrix Representation:** $$ -RZ(\lambda) = \exp\left(-i\frac{\lambda}{2}Z\right) = +\begin{split}RZ(\lambda) = \exp\left(-i\frac{\lambda}{2}Z\right) = \begin{pmatrix} e^{-i\frac{\lambda}{2}} & 0 \\ 0 & e^{i\frac{\lambda}{2}} - \end{pmatrix} + \end{pmatrix}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/qiskit.circuit.library.RZXGate.md index c207023711..d9d00fb269 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RZXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZXGate -`qiskit.circuit.library.RZXGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rzx.py "view source code") +`qiskit.circuit.library.RZXGate(theta, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -35,15 +35,13 @@ q_1: ┤1 ├ **Matrix Representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -R_{ZX}(\theta)\ q_0, q_1 = \exp\left(-i \frac{\theta}{2} X{\otimes}Z\right) = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}R_{ZX}(\theta)\ q_0, q_1 = \exp\left(-i \frac{\theta}{2} X{\otimes}Z\right) = \begin{pmatrix} - \cos\left(\rotationangle\right) & 0 & -i\sin\left(\rotationangle\right) & 0 \\ - 0 & \cos\left(\rotationangle\right) & 0 & i\sin\left(\rotationangle\right) \\ - -i\sin\left(\rotationangle\right) & 0 & \cos\left(\rotationangle\right) & 0 \\ - 0 & i\sin\left(\rotationangle\right) & 0 & \cos\left(\rotationangle\right) - \end{pmatrix} + \cos\left(\th\right) & 0 & -i\sin\left(\th\right) & 0 \\ + 0 & \cos\left(\th\right) & 0 & i\sin\left(\th\right) \\ + -i\sin\left(\th\right) & 0 & \cos\left(\th\right) & 0 \\ + 0 & i\sin\left(\th\right) & 0 & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ @@ -58,25 +56,23 @@ $$ ``` $$ - \newcommand{\rotationangle}{\frac{\theta}{2}} - - R_{ZX}(\theta)\ q_1, q_0 = exp(-i \frac{\theta}{2} Z{\otimes}X) = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}R_{ZX}(\theta)\ q_1, q_0 = exp(-i \frac{\theta}{2} Z{\otimes}X) = \begin{pmatrix} - \cos(\rotationangle) & -i\sin(\rotationangle) & 0 & 0 \\ - -i\sin(\rotationangle) & \cos(\rotationangle) & 0 & 0 \\ - 0 & 0 & \cos(\rotationangle) & i\sin(\rotationangle) \\ - 0 & 0 & i\sin(\rotationangle) & \cos(\rotationangle) - \end{pmatrix} + \cos(\th) & -i\sin(\th) & 0 & 0 \\ + -i\sin(\th) & \cos(\th) & 0 & 0 \\ + 0 & 0 & \cos(\th) & i\sin(\th) \\ + 0 & 0 & i\sin(\th) & \cos(\th) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ This is a direct sum of RX rotations, so this gate is equivalent to a uniformly controlled (multiplexed) RX gate: $$ - R_{ZX}(\theta)\ q_1, q_0 = + \begin{split}R_{ZX}(\theta)\ q_1, q_0 = \begin{pmatrix} RX(\theta) & 0 \\ 0 & RX(-\theta) - \end{pmatrix} + \end{pmatrix}\end{split} $$ @@ -95,13 +91,13 @@ $$ > $$ > > $$ -> RZX(\theta = \frac{\pi}{2}) = \frac{1}{\sqrt{2}} +> \begin{split}RZX(\theta = \frac{\pi}{2}) = \frac{1}{\sqrt{2}} > \begin{pmatrix} > 1 & 0 & -i & 0 \\ > 0 & 1 & 0 & i \\ > -i & 0 & 1 & 0 \\ > 0 & i & 0 & 1 -> \end{pmatrix} +> \end{pmatrix}\end{split} > $$ Create new RZX gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/qiskit.circuit.library.RZZGate.md index 9192cf789b..045220bf01 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.RZZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RZZGate -`qiskit.circuit.library.RZZGate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/rzz.py "view source code") +`qiskit.circuit.library.RZZGate(theta, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -31,25 +31,23 @@ q_1: ───■──── **Matrix Representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -R_{ZZ}(\theta) = \exp\left(-i \rotationangle Z{\otimes}Z\right) = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}R_{ZZ}(\theta) = \exp\left(-i \th Z{\otimes}Z\right) = \begin{pmatrix} - e^{-i \rotationangle} & 0 & 0 & 0 \\ - 0 & e^{i \rotationangle} & 0 & 0 \\ - 0 & 0 & e^{i \rotationangle} & 0 \\ - 0 & 0 & 0 & e^{-i \rotationangle} - \end{pmatrix} + e^{-i \th} & 0 & 0 & 0 \\ + 0 & e^{i \th} & 0 & 0 \\ + 0 & 0 & e^{i \th} & 0 \\ + 0 & 0 & 0 & e^{-i \th} + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ This is a direct sum of RZ rotations, so this gate is equivalent to a uniformly controlled (multiplexed) RZ gate: $$ -R_{ZZ}(\theta) = +\begin{split}R_{ZZ}(\theta) = \begin{pmatrix} RZ(\theta) & 0 \\ 0 & RZ(-\theta) - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Examples:** @@ -67,13 +65,13 @@ $$ > $$ > > $$ -> R_{ZZ}\left(\theta = \frac{\pi}{2}\right) = \frac{1}{\sqrt{2}} +> \begin{split}R_{ZZ}\left(\theta = \frac{\pi}{2}\right) = \frac{1}{\sqrt{2}} > \begin{pmatrix} > 1-i & 0 & 0 & 0 \\ > 0 & 1+i & 0 & 0 \\ > 0 & 0 & 1+i & 0 \\ > 0 & 0 & 0 & 1-i -> \end{pmatrix} +> \end{pmatrix}\end{split} > $$ Create new RZZ gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.md index a3698ff83b..bfc94df0a3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/qiskit.circuit.library.RealAmplitudes.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.RealAmplitudes -`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") +`qiskit.circuit.library.RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes', flatten=None)` Bases: [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") @@ -110,6 +110,7 @@ q_3: ┤ RY(θ[2]) ├┤ X ├┤ RY(θ[5]) ├────────── * **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]]*) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ ‘reverse\_linear, ‘circular’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. Default to ‘reverse\_linear’ entanglement. Note that ‘reverse\_linear’ entanglement provides the same unitary as ‘full’ with fewer entangling gates. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. * **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A QuantumCircuit object to prepend to the circuit. * **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. +* **skip\_unentangled\_qubits** – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. * **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If False, a rotation layer is added at the end of the ansatz. If True, no rotation layer is added. * **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – 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.12)")) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. @@ -209,7 +210,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 159` +`= 293` diff --git a/docs/api/qiskit/qiskit.circuit.library.Reset.md b/docs/api/qiskit/qiskit.circuit.library.Reset.md index 73b4339221..4bee3f2cfd 100644 --- a/docs/api/qiskit/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/qiskit.circuit.library.Reset.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.Reset -`qiskit.circuit.library.Reset(label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/reset.py "view source code") +`qiskit.circuit.library.Reset(label=None, *, duration=None, unit='dt')` Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.circuit.library.SGate.md b/docs/api/qiskit/qiskit.circuit.library.SGate.md index 1aa1ed685e..5ccf6fe6d8 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.SGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SGate -`qiskit.circuit.library.SGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -25,10 +25,10 @@ Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.cir **Matrix Representation:** $$ -S = \begin{pmatrix} +\begin{split}S = \begin{pmatrix} 1 & 0 \\ 0 & i - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Circuit symbol:** diff --git a/docs/api/qiskit/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/qiskit.circuit.library.SXGate.md index 38dc8dbdd1..96a7e37043 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.SXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXGate -`qiskit.circuit.library.SXGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -21,10 +21,10 @@ Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.cir **Matrix Representation:** $$ -\sqrt{X} = \frac{1}{2} \begin{pmatrix} +\begin{split}\sqrt{X} = \frac{1}{2} \begin{pmatrix} 1 + i & 1 - i \\ 1 - i & 1 + i - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Circuit symbol:** @@ -39,11 +39,11 @@ q_0: ┤ √X ├ A global phase difference exists between the definitions of $RX(\pi/2)$ and $\sqrt{X}$. $$ - RX(\pi/2) = \frac{1}{\sqrt{2}} \begin{pmatrix} + \begin{split}RX(\pi/2) = \frac{1}{\sqrt{2}} \begin{pmatrix} 1 & -i \\ -i & 1 \end{pmatrix} - = e^{-i \pi/4} \sqrt{X} + = e^{-i \pi/4} \sqrt{X}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/qiskit.circuit.library.SXdgGate.md index c33cccaa5c..6c2b3d831f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.SXdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SXdgGate -`qiskit.circuit.library.SXdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/sx.py "view source code") +`qiskit.circuit.library.SXdgGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -19,21 +19,21 @@ The inverse single-qubit Sqrt(X) gate. Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") with the [`sxdg()`](qiskit.circuit.QuantumCircuit#sxdg "qiskit.circuit.QuantumCircuit.sxdg") method. $$ -\sqrt{X}^{\dagger} = \frac{1}{2} \begin{pmatrix} +\begin{split}\sqrt{X}^{\dagger} = \frac{1}{2} \begin{pmatrix} 1 - i & 1 + i \\ 1 + i & 1 - i - \end{pmatrix} + \end{pmatrix}\end{split} $$ A global phase difference exists between the definitions of $RX(-\pi/2)$ and $\sqrt{X}^{\dagger}$. $$ - RX(-\pi/2) = \frac{1}{\sqrt{2}} \begin{pmatrix} + \begin{split}RX(-\pi/2) = \frac{1}{\sqrt{2}} \begin{pmatrix} 1 & i \\ i & 1 \end{pmatrix} - = e^{-i \pi/4} \sqrt{X}^{\dagger} + = e^{-i pi/4} \sqrt{X}^{\dagger}\end{split} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/qiskit.circuit.library.SdgGate.md index e50947cbe0..0a0a46cbd6 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.SdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SdgGate -`qiskit.circuit.library.SdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/s.py "view source code") +`qiskit.circuit.library.SdgGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -25,10 +25,10 @@ Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.cir **Matrix Representation:** $$ -Sdg = \begin{pmatrix} +\begin{split}Sdg = \begin{pmatrix} 1 & 0 \\ 0 & -i - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Circuit symbol:** diff --git a/docs/api/qiskit/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/qiskit.circuit.library.StatePreparation.md index 56b3136b37..656f2ff00f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/qiskit.circuit.library.StatePreparation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.StatePreparation -`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") +`qiskit.circuit.library.StatePreparation(params, num_qubits=None, inverse=False, label=None, normalize=False)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/qiskit.circuit.library.SwapGate.md index 11c3413fcb..d3fb8bbd1f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.SwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.SwapGate -`qiskit.circuit.library.SwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/swap.py "view source code") +`qiskit.circuit.library.SwapGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -31,13 +31,13 @@ q_1: ─X─ **Matrix Representation:** $$ -SWAP = +\begin{split}SWAP = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 0 & 1 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & 0 & 1 - \end{pmatrix} + \end{pmatrix}\end{split} $$ The gate is equivalent to a state swap and is a classical logic gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.TGate.md b/docs/api/qiskit/qiskit.circuit.library.TGate.md index c7ac129859..4c41502c6b 100644 --- a/docs/api/qiskit/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.TGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TGate -`qiskit.circuit.library.TGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -25,10 +25,10 @@ Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.cir **Matrix Representation:** $$ -T = \begin{pmatrix} +\begin{split}T = \begin{pmatrix} 1 & 0 \\ 0 & e^{i\pi/4} - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Circuit symbol:** diff --git a/docs/api/qiskit/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/qiskit.circuit.library.TdgGate.md index f790dabf81..c44c868e31 100644 --- a/docs/api/qiskit/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.TdgGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TdgGate -`qiskit.circuit.library.TdgGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/t.py "view source code") +`qiskit.circuit.library.TdgGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -25,10 +25,10 @@ Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.cir **Matrix Representation:** $$ -Tdg = \begin{pmatrix} +\begin{split}Tdg = \begin{pmatrix} 1 & 0 \\ 0 & e^{-i\pi/4} - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Circuit symbol:** diff --git a/docs/api/qiskit/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/qiskit.circuit.library.TwoLocal.md index e292912de3..13ea0de29c 100644 --- a/docs/api/qiskit/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/qiskit.circuit.library.TwoLocal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.TwoLocal -`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/n_local/two_local.py "view source code") +`qiskit.circuit.library.TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal', flatten=None)` Bases: [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -221,7 +221,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 159` +`= 293` diff --git a/docs/api/qiskit/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/qiskit.circuit.library.U1Gate.md index a262c6b894..4a39ed35a3 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/qiskit.circuit.library.U1Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U1Gate -`qiskit.circuit.library.U1Gate(theta, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u1.py "view source code") +`qiskit.circuit.library.U1Gate(theta, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -42,11 +42,11 @@ q_0: ┤ U1(λ) ├ **Matrix Representation:** $$ -U1(\lambda) = +\begin{split}U1(\lambda) = \begin{pmatrix} 1 & 0 \\ 0 & e^{i\lambda} - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Examples:** diff --git a/docs/api/qiskit/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/qiskit.circuit.library.U2Gate.md index 55621ca0a7..0c6726800f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/qiskit.circuit.library.U2Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U2Gate -`qiskit.circuit.library.U2Gate(phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u2.py "view source code") +`qiskit.circuit.library.U2Gate(phi, lam, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -42,11 +42,11 @@ q_0: ┤ U2(φ,λ) ├ **Matrix Representation:** $$ -U2(\phi, \lambda) = \frac{1}{\sqrt{2}} +\begin{split}U2(\phi, \lambda) = \frac{1}{\sqrt{2}} \begin{pmatrix} 1 & -e^{i\lambda} \\ e^{i\phi} & e^{i(\phi+\lambda)} - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Examples:** diff --git a/docs/api/qiskit/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/qiskit.circuit.library.U3Gate.md index c481af14cd..bf6f63e8b5 100644 --- a/docs/api/qiskit/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/qiskit.circuit.library.U3Gate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.U3Gate -`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u3.py "view source code") +`qiskit.circuit.library.U3Gate(theta, phi, lam, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -40,14 +40,11 @@ q_0: ┤ U3(ϴ,φ,λ) ├ **Matrix Representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -U3(\theta, \phi, \lambda) = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}U3(\theta, \phi, \lambda) = \begin{pmatrix} - \cos\left(\rotationangle\right) & -e^{i\lambda}\sin\left(\rotationangle\right) \\ - e^{i\phi}\sin\left(\rotationangle\right) & - e^{i(\phi+\lambda)}\cos\left(\rotationangle\right) - \end{pmatrix} + \cos\left(\th\right) & -e^{i\lambda}\sin\left(\th\right) \\ + e^{i\phi}\sin\left(\th\right) & e^{i(\phi+\lambda)}\cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.UCGate.md b/docs/api/qiskit/qiskit.circuit.library.UCGate.md index d4b07d2606..8a1f9d18e8 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UCGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCGate -`qiskit.circuit.library.UCGate(gate_list, up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/uc.py "view source code") +`qiskit.circuit.library.UCGate(gate_list, up_to_diagonal=False)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -21,12 +21,12 @@ These gates can have several control qubits and a single target qubit. If the k This gate is represented by a block-diagonal matrix, where each block is a $2\times 2$ unitary, that is $$ -\begin{pmatrix} +\begin{split}\begin{pmatrix} U_0 & 0 & \cdots & 0 \\ 0 & U_1 & \cdots & 0 \\ \vdots & & \ddots & \vdots \\ 0 & 0 & \cdots & U_{2^{k-1}} -\end{pmatrix}. +\end{pmatrix}.\end{split} $$ The decomposition is based on Ref. \[1]. diff --git a/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.md b/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.md index 9912c3a825..9e9a891de7 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UCPauliRotGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCPauliRotGate -`qiskit.circuit.library.UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/uc_pauli_rot.py "view source code") +`qiskit.circuit.library.UCPauliRotGate(angle_list, rot_axis)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UCRXGate.md b/docs/api/qiskit/qiskit.circuit.library.UCRXGate.md index c28208b8eb..8448e4ecc9 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCRXGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UCRXGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRXGate -`qiskit.circuit.library.UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/ucrx.py "view source code") +`qiskit.circuit.library.UCRXGate(angle_list)` Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UCRYGate.md b/docs/api/qiskit/qiskit.circuit.library.UCRYGate.md index 4bf04566d1..d9c3a16397 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCRYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UCRYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRYGate -`qiskit.circuit.library.UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/ucry.py "view source code") +`qiskit.circuit.library.UCRYGate(angle_list)` Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UCRZGate.md b/docs/api/qiskit/qiskit.circuit.library.UCRZGate.md index eed0c3e1a6..8736e6f6df 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UCRZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UCRZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UCRZGate -`qiskit.circuit.library.UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/ucrz.py "view source code") +`qiskit.circuit.library.UCRZGate(angle_list)` Bases: [`UCPauliRotGate`](qiskit.circuit.library.UCPauliRotGate "qiskit.circuit.library.generalized_gates.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UGate.md b/docs/api/qiskit/qiskit.circuit.library.UGate.md index fbc072acf5..bc6c179372 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UGate -`qiskit.circuit.library.UGate(theta, phi, lam, label=None, *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/u.py "view source code") +`qiskit.circuit.library.UGate(theta, phi, lam, label=None, *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -29,13 +29,11 @@ q_0: ┤ U(ϴ,φ,λ) ├ **Matrix Representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -U(\theta, \phi, \lambda) = -\begin{pmatrix} - \cos\left(\rotationangle\right) & -e^{i\lambda}\sin\left(\rotationangle\right) \\ - e^{i\phi}\sin\left(\rotationangle\right) & e^{i(\phi+\lambda)}\cos\left(\rotationangle\right) -\end{pmatrix} + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}U(\theta, \phi, \lambda) = + \begin{pmatrix} + \cos\left(\th\right) & -e^{i\lambda}\sin\left(\th\right) \\ + e^{i\phi}\sin\left(\th\right) & e^{i(\phi+\lambda)}\cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.md b/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.md index b4597df2fe..1942a8c8eb 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.UnitaryGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UnitaryGate -`qiskit.circuit.library.UnitaryGate(data, label=None, check_input=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/generalized_gates/unitary.py "view source code") +`qiskit.circuit.library.UnitaryGate(data, label=None, check_input=True)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.md b/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.md index 95bfbf05bd..bd114c1e0d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.md +++ b/docs/api/qiskit/qiskit.circuit.library.UnitaryOverlap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.UnitaryOverlap -`qiskit.circuit.library.UnitaryOverlap(unitary1, unitary2, prefix1='p1', prefix2='p2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/overlap.py "view source code") +`qiskit.circuit.library.UnitaryOverlap(unitary1, unitary2, prefix1='p1', prefix2='p2')` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -121,7 +121,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 159` +`= 293` diff --git a/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.md index e96f665a1d..6a6fcf9e95 100644 --- a/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/qiskit.circuit.library.VBERippleCarryAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.VBERippleCarryAdder -`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") +`qiskit.circuit.library.VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` Bases: `Adder` @@ -110,7 +110,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 159` +`= 293` diff --git a/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.md index c557a0d093..5b889442dd 100644 --- a/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/qiskit.circuit.library.WeightedAdder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.WeightedAdder -`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") +`qiskit.circuit.library.WeightedAdder(num_state_qubits=None, weights=None, name='adder')` Bases: `BlueprintCircuit` @@ -113,7 +113,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 159` +`= 293` diff --git a/docs/api/qiskit/qiskit.circuit.library.XGate.md b/docs/api/qiskit/qiskit.circuit.library.XGate.md index a98a30e203..bfb095490a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.XGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XGate -`qiskit.circuit.library.XGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/x.py "view source code") +`qiskit.circuit.library.XGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -21,10 +21,10 @@ Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.cir **Matrix Representation:** $$ -X = \begin{pmatrix} +\begin{split}X = \begin{pmatrix} 0 & 1 \\ 1 & 0 - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Circuit symbol:** @@ -41,19 +41,19 @@ Equivalent to a $\pi$ radian rotation about the X axis. A global phase difference exists between the definitions of $RX(\pi)$ and $X$. $$ - RX(\pi) = \begin{pmatrix} + \begin{split}RX(\pi) = \begin{pmatrix} 0 & -i \\ -i & 0 \end{pmatrix} - = -i X + = -i X\end{split} $$ The gate is equivalent to a classical bit flip. $$ -|0\rangle \rightarrow |1\rangle \\ -|1\rangle \rightarrow |0\rangle +\begin{split}|0\rangle \rightarrow |1\rangle \\ +|1\rangle \rightarrow |0\rangle\end{split} $$ Create new X gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.XOR.md b/docs/api/qiskit/qiskit.circuit.library.XOR.md index 35d994de65..0062f7e0ca 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/qiskit.circuit.library.XOR.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XOR -`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") +`qiskit.circuit.library.XOR(num_qubits, amount=None, seed=None)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -94,7 +94,7 @@ Return the global phase of the current circuit scope in radians. ### instances -`= 161` +`= 295` diff --git a/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.md index baf31e743e..d4b2aa200f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.XXMinusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXMinusYYGate -`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") +`qiskit.circuit.library.XXMinusYYGate(theta, beta=0, label='(XX-YY)', *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -31,20 +31,18 @@ q_1: ┤1 ├ **Matrix Representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -R_{XX-YY}(\theta, \beta) q_0, q_1 = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}R_{XX-YY}(\theta, \beta) q_0, q_1 = RZ_1(\beta) \cdot \exp\left(-i \frac{\theta}{2} \frac{XX-YY}{2}\right) \cdot RZ_1(-\beta) = \begin{pmatrix} - \cos\left(\rotationangle\right) & 0 & 0 & -i\sin\left(\rotationangle\right)e^{-i\beta} \\ - 0 & 1 & 0 & 0 \\ - 0 & 0 & 1 & 0 \\ - -i\sin\left(\rotationangle\right)e^{i\beta} & 0 & 0 & \cos\left(\rotationangle\right) - \end{pmatrix} + \cos\left(\th\right) & 0 & 0 & -i\sin\left(\th\right)e^{-i\beta} \\ + 0 & 1 & 0 & 0 \\ + 0 & 0 & 1 & 0 \\ + -i\sin\left(\th\right)e^{i\beta} & 0 & 0 & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ - In Qiskit’s convention, higher qubit indices are more significant (little endian convention). In the above example we apply the gate on (q\_0, q\_1) which results in adding the (optional) phase defined by $\beta$ on q\_1. Instead, if we apply it on (q\_1, q\_0), the phase is added on q\_0. If $\beta$ is set to its default value of $0$, the gate is equivalent in big and little endian. + In Qiskit’s convention, higher qubit indices are more significant (little endian convention). In the above example we apply the gate on (q\_0, q\_1) which results in adding the (optional) phase defined by $beta$ on q\_1. Instead, if we apply it on (q\_1, q\_0), the phase is added on q\_0. If $beta$ is set to its default value of $0$, the gate is equivalent in big and little endian. ```python ┌───────────────┐ @@ -55,16 +53,14 @@ $$ ``` $$ - \newcommand{\rotationangle}{\frac{\theta}{2}} - - R_{XX-YY}(\theta, \beta) q_1, q_0 = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}R_{XX-YY}(\theta, \beta) q_1, q_0 = RZ_0(\beta) \cdot \exp\left(-i \frac{\theta}{2} \frac{XX-YY}{2}\right) \cdot RZ_0(-\beta) = - \begin{pmatrix} - \cos\left(\rotationangle\right) & 0 & 0 & -i\sin\left(\rotationangle\right)e^{i\beta} \\ - 0 & 1 & 0 & 0 \\ - 0 & 0 & 1 & 0 \\ - -i\sin\left(\rotationangle\right)e^{-i\beta} & 0 & 0 & \cos\left(\rotationangle\right) - \end{pmatrix} + \begin{pmatrix} + \cos\left(\th\right) & 0 & 0 & -i\sin\left(\th\right)e^{i\beta} \\ + 0 & 1 & 0 & 0 \\ + 0 & 0 & 1 & 0 \\ + -i\sin\left(\th\right)e^{-i\beta} & 0 & 0 & \cos\left(\th\right) + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ diff --git a/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.md index 6d1b6790ea..0da0b0dc0f 100644 --- a/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.XXPlusYYGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.XXPlusYYGate -`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)', *, duration=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") +`qiskit.circuit.library.XXPlusYYGate(theta, beta=0, label='(XX+YY)', *, duration=None, unit='dt')` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -31,20 +31,18 @@ q_1: ┤1 ├ **Matrix Representation:** $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -R_{XX+YY}(\theta, \beta)\ q_0, q_1 = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}R_{XX+YY}(\theta, \beta)\ q_0, q_1 = RZ_0(-\beta) \cdot \exp\left(-i \frac{\theta}{2} \frac{XX+YY}{2}\right) \cdot RZ_0(\beta) = \begin{pmatrix} - 1 & 0 & 0 & 0 \\ - 0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right)e^{-i\beta} & 0 \\ - 0 & -i\sin\left(\rotationangle\right)e^{i\beta} & \cos\left(\rotationangle\right) & 0 \\ - 0 & 0 & 0 & 1 - \end{pmatrix} + 1 & 0 & 0 & 0 \\ + 0 & \cos\left(\th\right) & -i\sin\left(\th\right)e^{-i\beta} & 0 \\ + 0 & -i\sin\left(\th\right)e^{i\beta} & \cos\left(\th\right) & 0 \\ + 0 & 0 & 0 & 1 + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ - In Qiskit’s convention, higher qubit indices are more significant (little endian convention). In the above example we apply the gate on (q\_0, q\_1) which results in adding the (optional) phase defined by $\beta$ on q\_0. Instead, if we apply it on (q\_1, q\_0), the phase is added on q\_1. If $\beta$ is set to its default value of $0$, the gate is equivalent in big and little endian. + In Qiskit’s convention, higher qubit indices are more significant (little endian convention). In the above example we apply the gate on (q\_0, q\_1) which results in adding the (optional) phase defined by $beta$ on q\_0. Instead, if we apply it on (q\_1, q\_0), the phase is added on q\_1. If $beta$ is set to its default value of $0$, the gate is equivalent in big and little endian. ```python ┌───────────────┐ @@ -56,16 +54,14 @@ $$ $$ -\newcommand{\rotationangle}{\frac{\theta}{2}} - -R_{XX+YY}(\theta, \beta)\ q_0, q_1 = + \begin{align}\begin{aligned}\newcommand{\th}{\frac{\theta}{2}}\\\begin{split}R_{XX+YY}(\theta, \beta)\ q_0, q_1 = RZ_1(-\beta) \cdot \exp\left(-i \frac{\theta}{2} \frac{XX+YY}{2}\right) \cdot RZ_1(\beta) = \begin{pmatrix} - 1 & 0 & 0 & 0 \\ - 0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right)e^{i\beta} & 0 \\ - 0 & -i\sin\left(\rotationangle\right)e^{-i\beta} & \cos\left(\rotationangle\right) & 0 \\ - 0 & 0 & 0 & 1 - \end{pmatrix} + 1 & 0 & 0 & 0 \\ + 0 & \cos\left(\th\right) & -i\sin\left(\th\right)e^{i\beta} & 0 \\ + 0 & -i\sin\left(\th\right)e^{-i\beta} & \cos\left(\th\right) & 0 \\ + 0 & 0 & 0 & 1 + \end{pmatrix}\end{split}\end{aligned}\end{align} $$ Create new XX+YY gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.YGate.md b/docs/api/qiskit/qiskit.circuit.library.YGate.md index 43e2817ded..bfa757f430 100644 --- a/docs/api/qiskit/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.YGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.YGate -`qiskit.circuit.library.YGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/y.py "view source code") +`qiskit.circuit.library.YGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -21,10 +21,10 @@ Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.cir **Matrix Representation:** $$ -Y = \begin{pmatrix} +\begin{split}Y = \begin{pmatrix} 0 & -i \\ i & 0 - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Circuit symbol:** @@ -41,19 +41,19 @@ Equivalent to a $\pi$ radian rotation about the Y axis. A global phase difference exists between the definitions of $RY(\pi)$ and $Y$. $$ - RY(\pi) = \begin{pmatrix} + \begin{split}RY(\pi) = \begin{pmatrix} 0 & -1 \\ 1 & 0 \end{pmatrix} - = -i Y + = -i Y\end{split} $$ The gate is equivalent to a bit and phase flip. $$ -|0\rangle \rightarrow i|1\rangle \\ -|1\rangle \rightarrow -i|0\rangle +\begin{split}|0\rangle \rightarrow i|1\rangle \\ +|1\rangle \rightarrow -i|0\rangle\end{split} $$ Create new Y gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.md index 505c9f2188..638381e63d 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/qiskit.circuit.library.ZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZFeatureMap -`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") +`qiskit.circuit.library.ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") @@ -187,7 +187,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 163` +`= 297` diff --git a/docs/api/qiskit/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/qiskit.circuit.library.ZGate.md index 2809871517..a3c6ed6dda 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.ZGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZGate -`qiskit.circuit.library.ZGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/z.py "view source code") +`qiskit.circuit.library.ZGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -21,10 +21,10 @@ Can be applied to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.cir **Matrix Representation:** $$ -Z = \begin{pmatrix} +\begin{split}Z = \begin{pmatrix} 1 & 0 \\ 0 & -1 - \end{pmatrix} + \end{pmatrix}\end{split} $$ **Circuit symbol:** @@ -41,19 +41,19 @@ Equivalent to a $\pi$ radian rotation about the Z axis. A global phase difference exists between the definitions of $RZ(\pi)$ and $Z$. $$ - RZ(\pi) = \begin{pmatrix} + \begin{split}RZ(\pi) = \begin{pmatrix} -i & 0 \\ 0 & i \end{pmatrix} - = -i Z + = -i Z\end{split} $$ The gate is equivalent to a phase flip. $$ -|0\rangle \rightarrow |0\rangle \\ -|1\rangle \rightarrow -|1\rangle +\begin{split}|0\rangle \rightarrow |0\rangle \\ +|1\rangle \rightarrow -|1\rangle\end{split} $$ Create new Z gate. diff --git a/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.md index c10c42a9f8..71cf1a7830 100644 --- a/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/qiskit.circuit.library.ZZFeatureMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.ZZFeatureMap -`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") +`qiskit.circuit.library.ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` Bases: [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") @@ -28,7 +28,7 @@ For 3 qubits and 1 repetition and linear entanglement the circuit is represented └───┘└─────────────────┘ └───┘└──────────────────────┘└───┘ ``` -where $\varphi$ is a classical non-linear function, which defaults to $\varphi(x) = x$ if and $\varphi(x,y) = (\pi - x)(\pi - y)$. +where `φ` is a classical non-linear function, which defaults to `φ(x) = x` if and `φ(x,y) = (pi - x)(pi - y)`. ## Examples @@ -192,7 +192,7 @@ If barriers are inserted in between the layers or not. ### instances -`= 163` +`= 297` diff --git a/docs/api/qiskit/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/qiskit.circuit.library.iSwapGate.md index 89d2f8a087..0c2f63cd3a 100644 --- a/docs/api/qiskit/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/qiskit.circuit.library.iSwapGate.md @@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.library.iSwapGate -`qiskit.circuit.library.iSwapGate(*args, _force_mutable=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/library/standard_gates/iswap.py "view source code") +`qiskit.circuit.library.iSwapGate(*args, _force_mutable=False, **kwargs)` Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate") @@ -41,20 +41,20 @@ q_1: ┤ S ├─────┤ X ├──■──┤ H ├ **Matrix Representation:** $$ -iSWAP = R_{XX+YY}\left(-\frac{\pi}{2}\right) +\begin{split}iSWAP = R_{XX+YY}\left(-\frac{\pi}{2}\right) = \exp\left(i \frac{\pi}{4} \left(X{\otimes}X+Y{\otimes}Y\right)\right) = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 0 & i & 0 \\ 0 & i & 0 & 0 \\ 0 & 0 & 0 & 1 - \end{pmatrix} + \end{pmatrix}\end{split} $$ This gate is equivalent to a SWAP up to a diagonal. $$ -iSWAP = +\begin{split}iSWAP = \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & 0 & 1 & 0 \\ @@ -66,7 +66,7 @@ iSWAP = 0 & i & 0 & 0 \\ 0 & 0 & i & 0 \\ 0 & 0 & 0 & 1 - \end{pmatrix} + \end{pmatrix}\end{split} $$ Create new iSwap gate. diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.md index aa69630a3c..3fa965da39 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGCircuit -`qiskit.dagcircuit.DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagcircuit.py "view source code") +`qiskit.dagcircuit.DAGCircuit` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") @@ -343,7 +343,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. Draws the dag circuit. -This function needs [Graphviz](https://www.graphviz.org/) to be installed. Graphviz is not a python package and can’t be pip installed (the `graphviz` package on PyPI is a Python interface library for Graphviz and does not actually install Graphviz). You can refer to [the Graphviz documentation](https://www.graphviz.org/download/) on how to install it. +This function needs [pydot](https://github.com/erocarrera/pydot), which in turn needs [Graphviz](https://www.graphviz.org/) to be installed. **Parameters** diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.md index edd4f906b8..648842dd6a 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGDepNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDepNode -`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagdepnode.py "view source code") +`qiskit.dagcircuit.DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=-1)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.md index f234be5b4a..25bfc923c7 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGDependency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGDependency -`qiskit.dagcircuit.DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagdependency.py "view source code") +`qiskit.dagcircuit.DAGDependency` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.md index 4c2792f654..942867fbf0 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGInNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGInNode -`qiskit.dagcircuit.DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGInNode(wire)` Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/qiskit.dagcircuit.DAGNode.md index 9017033915..860d7da84a 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGNode -`qiskit.dagcircuit.DAGNode(nid=-1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGNode(nid=-1)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.md index ab0bf7a6ca..186453d702 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGOpNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOpNode -`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=(), dag=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOpNode(op, qargs=(), cargs=(), dag=None)` Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.md index cc844e81bc..9056d0094f 100644 --- a/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/qiskit.dagcircuit.DAGOutNode.md @@ -10,7 +10,7 @@ python_api_name: qiskit.dagcircuit.DAGOutNode -`qiskit.dagcircuit.DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/dagcircuit/dagnode.py "view source code") +`qiskit.dagcircuit.DAGOutNode(wire)` Bases: [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/qiskit.extensions.SingleQubitUnitary.md index 41fdd9e4d3..0dc46acc25 100644 --- a/docs/api/qiskit/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/qiskit.extensions.SingleQubitUnitary.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.SingleQubitUnitary -`qiskit.extensions.SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/extensions/quantum_initializer/squ.py "view source code") +`qiskit.extensions.SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/qiskit.extensions.Snapshot.md b/docs/api/qiskit/qiskit.extensions.Snapshot.md index ef2ed4c36d..6e32d47011 100644 --- a/docs/api/qiskit/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/qiskit.extensions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.extensions.Snapshot -`qiskit.extensions.Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/extensions/simulator/snapshot.py "view source code") +`qiskit.extensions.Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/qiskit.opflow.OperatorBase.md index cb8df8266b..39af8b5928 100644 --- a/docs/api/qiskit/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/qiskit.opflow.OperatorBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.OperatorBase -`qiskit.opflow.OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/operator_base.py "view source code") +`qiskit.opflow.OperatorBase` Bases: `StarAlgebraMixin`, `TensorMixin`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/qiskit.opflow.converters.AbelianGrouper.md index 092b19c954..d79c81c8f2 100644 --- a/docs/api/qiskit/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/qiskit.opflow.converters.AbelianGrouper.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.AbelianGrouper -`qiskit.opflow.converters.AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/abelian_grouper.py "view source code") +`qiskit.opflow.converters.AbelianGrouper(traverse=True)` Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/qiskit.opflow.converters.CircuitSampler.md index 633026a34c..f30e134c64 100644 --- a/docs/api/qiskit/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/qiskit.opflow.converters.CircuitSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.CircuitSampler -`qiskit.opflow.converters.CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/circuit_sampler.py "view source code") +`qiskit.opflow.converters.CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/qiskit.opflow.converters.ConverterBase.md index 8fe872d729..64c8af4f6c 100644 --- a/docs/api/qiskit/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/qiskit.opflow.converters.ConverterBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.ConverterBase -`qiskit.opflow.converters.ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/converter_base.py "view source code") +`qiskit.opflow.converters.ConverterBase` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/qiskit.opflow.converters.DictToCircuitSum.md index 880f85cbce..7d411045db 100644 --- a/docs/api/qiskit/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/qiskit.opflow.converters.DictToCircuitSum.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.DictToCircuitSum -`qiskit.opflow.converters.DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") +`qiskit.opflow.converters.DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/qiskit.opflow.converters.PauliBasisChange.md index 7219e14cd1..eb6ad67967 100644 --- a/docs/api/qiskit/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/qiskit.opflow.converters.PauliBasisChange.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.PauliBasisChange -`qiskit.opflow.converters.PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/pauli_basis_change.py "view source code") +`qiskit.opflow.converters.PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/qiskit.opflow.converters.TwoQubitReduction.md index ba4e63e54d..548ded5373 100644 --- a/docs/api/qiskit/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/qiskit.opflow.converters.TwoQubitReduction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.converters.TwoQubitReduction -`qiskit.opflow.converters.TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/converters/two_qubit_reduction.py "view source code") +`qiskit.opflow.converters.TwoQubitReduction(num_particles)` Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/qiskit.opflow.converters.md b/docs/api/qiskit/qiskit.opflow.converters.md index 1e13476801..3d5bfafa08 100644 --- a/docs/api/qiskit/qiskit.opflow.converters.md +++ b/docs/api/qiskit/qiskit.opflow.converters.md @@ -44,9 +44,9 @@ In addition to the base class, directory holds a few miscellaneous converters wh | | | | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler")(backend\[, statevector, ...]) | Deprecated: The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. | +| [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler")(backend\[, statevector, ...]) | Deprecated: The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. | | [`AbelianGrouper`](qiskit.opflow.converters.AbelianGrouper "qiskit.opflow.converters.AbelianGrouper")(\[traverse]) | Deprecated: The AbelianGrouper converts SummedOps into a sum of Abelian sums. | -| [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, ...]) | Deprecated: Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | -| [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, ...]) | Deprecated: Converter for changing Paulis into other bases. | +| [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, ...]) | Deprecated: Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | +| [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, ...]) | Deprecated: Converter for changing Paulis into other bases. | | [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Deprecated: Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | diff --git a/docs/api/qiskit/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/qiskit.opflow.evolutions.EvolutionBase.md index 681a9756df..2c9087a608 100644 --- a/docs/api/qiskit/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/qiskit.opflow.evolutions.EvolutionBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionBase -`qiskit.opflow.evolutions.EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/evolution_base.py "view source code") +`qiskit.opflow.evolutions.EvolutionBase` Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/qiskit.opflow.evolutions.EvolutionFactory.md index 3956ded6da..cca94308a5 100644 --- a/docs/api/qiskit/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/qiskit.opflow.evolutions.EvolutionFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolutionFactory -`qiskit.opflow.evolutions.EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/evolution_factory.py "view source code") +`qiskit.opflow.evolutions.EvolutionFactory` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/qiskit.opflow.evolutions.EvolvedOp.md index 71ab6f0a88..61a376fdd7 100644 --- a/docs/api/qiskit/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/qiskit.opflow.evolutions.EvolvedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.EvolvedOp -`qiskit.opflow.evolutions.EvolvedOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/evolved_op.py "view source code") +`qiskit.opflow.evolutions.EvolvedOp(*args, **kwargs)` Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/qiskit.opflow.evolutions.MatrixEvolution.md index 1118d4b84b..f1793784de 100644 --- a/docs/api/qiskit/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/qiskit.opflow.evolutions.MatrixEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.MatrixEvolution -`qiskit.opflow.evolutions.MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/matrix_evolution.py "view source code") +`qiskit.opflow.evolutions.MatrixEvolution` Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/qiskit.opflow.evolutions.PauliTrotterEvolution.md index 03e2ca2237..b85b30362f 100644 --- a/docs/api/qiskit/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution -`qiskit.opflow.evolutions.PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") +`qiskit.opflow.evolutions.PauliTrotterEvolution(trotter_mode='trotter', reps=1)` Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/qiskit.opflow.evolutions.QDrift.md index f4f34e7312..13b8a7ae73 100644 --- a/docs/api/qiskit/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/qiskit.opflow.evolutions.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.QDrift -`qiskit.opflow.evolutions.QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") +`qiskit.opflow.evolutions.QDrift(reps=1)` Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") diff --git a/docs/api/qiskit/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/qiskit.opflow.evolutions.Suzuki.md index 0455dfa148..3be066fea0 100644 --- a/docs/api/qiskit/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/qiskit.opflow.evolutions.Suzuki.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Suzuki -`qiskit.opflow.evolutions.Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") +`qiskit.opflow.evolutions.Suzuki(reps=1, order=2)` Bases: [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") diff --git a/docs/api/qiskit/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/qiskit.opflow.evolutions.Trotter.md index 4618854927..cd04a815a6 100644 --- a/docs/api/qiskit/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/qiskit.opflow.evolutions.Trotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.Trotter -`qiskit.opflow.evolutions.Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") +`qiskit.opflow.evolutions.Trotter(reps=1)` Bases: [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/qiskit.opflow.evolutions.TrotterizationBase.md index 3bace41fcd..fca7ec9927 100644 --- a/docs/api/qiskit/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/qiskit.opflow.evolutions.TrotterizationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationBase -`qiskit.opflow.evolutions.TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") +`qiskit.opflow.evolutions.TrotterizationBase(reps=1)` Bases: [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") diff --git a/docs/api/qiskit/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/qiskit.opflow.evolutions.TrotterizationFactory.md index a24e1c42d0..93090fd2f2 100644 --- a/docs/api/qiskit/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.evolutions.TrotterizationFactory -`qiskit.opflow.evolutions.TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") +`qiskit.opflow.evolutions.TrotterizationFactory` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.opflow.evolutions.md b/docs/api/qiskit/qiskit.opflow.evolutions.md index 1e9dc9e774..46cc70e79d 100644 --- a/docs/api/qiskit/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/qiskit.opflow.evolutions.md @@ -45,9 +45,9 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | | | | -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`EvolutionFactory`](qiskit.opflow.evolutions.EvolutionFactory "qiskit.opflow.evolutions.EvolutionFactory")() | Deprecated: A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. | -| [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp")(\*args, \*\*kwargs) | Deprecated: Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. | +| [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp")(\*args, \*\*kwargs) | Deprecated: Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. | | [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution")() | Deprecated: Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. | -| [`PauliTrotterEvolution`](qiskit.opflow.evolutions.PauliTrotterEvolution "qiskit.opflow.evolutions.PauliTrotterEvolution")(\[trotter\_mode, reps]) | Deprecated: An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. | +| [`PauliTrotterEvolution`](qiskit.opflow.evolutions.PauliTrotterEvolution "qiskit.opflow.evolutions.PauliTrotterEvolution")(\[trotter\_mode, reps]) | Deprecated: An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. | ### Trotterizations @@ -56,6 +56,6 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.TrotterizationBase")(\[reps]) | Deprecated: A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. | | [`TrotterizationFactory`](qiskit.opflow.evolutions.TrotterizationFactory "qiskit.opflow.evolutions.TrotterizationFactory")() | Deprecated: A factory for conveniently creating TrotterizationBase instances. | | [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | Deprecated: Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | -| [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Deprecated: Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive "bookends" strategy, repeating the whole composed circuit `reps` times. | +| [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | Deprecated: Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive "bookends" strategy, repeating the whole composed circuit `reps` times. | | [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | Deprecated: The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | diff --git a/docs/api/qiskit/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/qiskit.opflow.expectations.AerPauliExpectation.md index 877e57d23a..d6e1d25fe5 100644 --- a/docs/api/qiskit/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/qiskit.opflow.expectations.AerPauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.AerPauliExpectation -`qiskit.opflow.expectations.AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") +`qiskit.opflow.expectations.AerPauliExpectation` Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/qiskit.opflow.expectations.CVaRExpectation.md index 9aa5799e63..18a762601b 100644 --- a/docs/api/qiskit/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/qiskit.opflow.expectations.CVaRExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.CVaRExpectation -`qiskit.opflow.expectations.CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/cvar_expectation.py "view source code") +`qiskit.opflow.expectations.CVaRExpectation(alpha, expectation=None)` Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/qiskit.opflow.expectations.ExpectationBase.md index 7a64d22643..75e1559183 100644 --- a/docs/api/qiskit/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/qiskit.opflow.expectations.ExpectationBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationBase -`qiskit.opflow.expectations.ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/expectation_base.py "view source code") +`qiskit.opflow.expectations.ExpectationBase` Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/qiskit.opflow.expectations.ExpectationFactory.md index 84b2306810..6663008137 100644 --- a/docs/api/qiskit/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/qiskit.opflow.expectations.ExpectationFactory.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.ExpectationFactory -`qiskit.opflow.expectations.ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/expectation_factory.py "view source code") +`qiskit.opflow.expectations.ExpectationFactory` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/qiskit.opflow.expectations.MatrixExpectation.md index 2c2b22ce63..9f78c3c996 100644 --- a/docs/api/qiskit/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/qiskit.opflow.expectations.MatrixExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.MatrixExpectation -`qiskit.opflow.expectations.MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/matrix_expectation.py "view source code") +`qiskit.opflow.expectations.MatrixExpectation` Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/qiskit.opflow.expectations.PauliExpectation.md index d1ba24ba1f..d6340e5bf3 100644 --- a/docs/api/qiskit/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/qiskit.opflow.expectations.PauliExpectation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.expectations.PauliExpectation -`qiskit.opflow.expectations.PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/expectations/pauli_expectation.py "view source code") +`qiskit.opflow.expectations.PauliExpectation(group_paulis=True)` Bases: [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") diff --git a/docs/api/qiskit/qiskit.opflow.expectations.md b/docs/api/qiskit/qiskit.opflow.expectations.md index 50b011bb43..7ceeb95a21 100644 --- a/docs/api/qiskit/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/qiskit.opflow.expectations.md @@ -42,5 +42,5 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | [`AerPauliExpectation`](qiskit.opflow.expectations.AerPauliExpectation "qiskit.opflow.expectations.AerPauliExpectation")() | An Expectation converter for using Aer's operator snapshot to take expectations of quantum state circuits over Pauli observables. | | [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | | [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | -| [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Deprecated: Compute the Conditional Value at Risk (CVaR) expectation value. | +| [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Deprecated: Compute the Conditional Value at Risk (CVaR) expectation value. | diff --git a/docs/api/qiskit/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/qiskit.opflow.gradients.CircuitGradient.md index e5593c520b..b15d26ce32 100644 --- a/docs/api/qiskit/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/qiskit.opflow.gradients.CircuitGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitGradient -`qiskit.opflow.gradients.CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") +`qiskit.opflow.gradients.CircuitGradient` Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/qiskit.opflow.gradients.CircuitQFI.md index de37ede686..0cf478073d 100644 --- a/docs/api/qiskit/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/qiskit.opflow.gradients.CircuitQFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.CircuitQFI -`qiskit.opflow.gradients.CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") +`qiskit.opflow.gradients.CircuitQFI` Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/qiskit.opflow.gradients.DerivativeBase.md index a6f7ff076f..c40428037c 100644 --- a/docs/api/qiskit/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/qiskit.opflow.gradients.DerivativeBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.DerivativeBase -`qiskit.opflow.gradients.DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/derivative_base.py "view source code") +`qiskit.opflow.gradients.DerivativeBase` Bases: [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") diff --git a/docs/api/qiskit/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/qiskit.opflow.gradients.Gradient.md index 9c950f7243..bf25f83a4a 100644 --- a/docs/api/qiskit/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/qiskit.opflow.gradients.Gradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Gradient -`qiskit.opflow.gradients.Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/gradient.py "view source code") +`qiskit.opflow.gradients.Gradient(grad_method='param_shift', **kwargs)` Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") diff --git a/docs/api/qiskit/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/qiskit.opflow.gradients.GradientBase.md index 2260f64fc6..2ac4c764e0 100644 --- a/docs/api/qiskit/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/qiskit.opflow.gradients.GradientBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.GradientBase -`qiskit.opflow.gradients.GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/gradient_base.py "view source code") +`qiskit.opflow.gradients.GradientBase(grad_method='param_shift', **kwargs)` Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/qiskit.opflow.gradients.Hessian.md index 2704ebe5a3..74047e46ce 100644 --- a/docs/api/qiskit/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/qiskit.opflow.gradients.Hessian.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.Hessian -`qiskit.opflow.gradients.Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/hessian.py "view source code") +`qiskit.opflow.gradients.Hessian(hess_method='param_shift', **kwargs)` Bases: [`HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") diff --git a/docs/api/qiskit/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/qiskit.opflow.gradients.HessianBase.md index 6115711186..014300696a 100644 --- a/docs/api/qiskit/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/qiskit.opflow.gradients.HessianBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.HessianBase -`qiskit.opflow.gradients.HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/hessian_base.py "view source code") +`qiskit.opflow.gradients.HessianBase(hess_method='param_shift', **kwargs)` Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/qiskit.opflow.gradients.NaturalGradient.md index a77f0dbcf9..8ea8c29054 100644 --- a/docs/api/qiskit/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/qiskit.opflow.gradients.NaturalGradient.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.NaturalGradient -`qiskit.opflow.gradients.NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/natural_gradient.py "view source code") +`qiskit.opflow.gradients.NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` Bases: [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") diff --git a/docs/api/qiskit/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/qiskit.opflow.gradients.QFI.md index 434e6bb2c5..ae2e3dcc4c 100644 --- a/docs/api/qiskit/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/qiskit.opflow.gradients.QFI.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFI -`qiskit.opflow.gradients.QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/qfi.py "view source code") +`qiskit.opflow.gradients.QFI(qfi_method='lin_comb_full')` Bases: [`QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") diff --git a/docs/api/qiskit/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/qiskit.opflow.gradients.QFIBase.md index f0af5b6a5a..8e0fedd454 100644 --- a/docs/api/qiskit/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/qiskit.opflow.gradients.QFIBase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.gradients.QFIBase -`qiskit.opflow.gradients.QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/gradients/qfi_base.py "view source code") +`qiskit.opflow.gradients.QFIBase(qfi_method='lin_comb_full')` Bases: [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/qiskit.opflow.gradients.md b/docs/api/qiskit/qiskit.opflow.gradients.md index 982d7fe6c5..8906f76fbf 100644 --- a/docs/api/qiskit/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/qiskit.opflow.gradients.md @@ -127,6 +127,6 @@ The derivative classes come with a gradient\_wrapper() function which returns th | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | [`Gradient`](qiskit.opflow.gradients.Gradient "qiskit.opflow.gradients.Gradient")(\[grad\_method]) | Deprecated: Convert an operator expression to the first-order gradient. | | [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Deprecated: Compute the Hessian of an expected value. | -| [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, ...]) | Deprecated: Convert an operator expression to the first-order gradient. | +| [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, ...]) | Deprecated: Convert an operator expression to the first-order gradient. | | [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Deprecated: Compute the Quantum Fisher Information (QFI). | diff --git a/docs/api/qiskit/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/qiskit.opflow.list_ops.ComposedOp.md index 07dd681fec..bd2b112274 100644 --- a/docs/api/qiskit/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/qiskit.opflow.list_ops.ComposedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ComposedOp -`qiskit.opflow.list_ops.ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/composed_op.py "view source code") +`qiskit.opflow.list_ops.ComposedOp(oplist, coeff=1.0, abelian=False)` Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/qiskit.opflow.list_ops.ListOp.md index 6a65a0d285..6067d217e6 100644 --- a/docs/api/qiskit/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/qiskit.opflow.list_ops.ListOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.ListOp -`qiskit.opflow.list_ops.ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/list_op.py "view source code") +`qiskit.opflow.list_ops.ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/qiskit.opflow.list_ops.SummedOp.md index 4d34fe26cd..151f6d4457 100644 --- a/docs/api/qiskit/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/qiskit.opflow.list_ops.SummedOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.SummedOp -`qiskit.opflow.list_ops.SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/summed_op.py "view source code") +`qiskit.opflow.list_ops.SummedOp(oplist, coeff=1.0, abelian=False)` Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/qiskit.opflow.list_ops.TensoredOp.md index 5f28be96c5..064f051ee8 100644 --- a/docs/api/qiskit/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/qiskit.opflow.list_ops.TensoredOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.list_ops.TensoredOp -`qiskit.opflow.list_ops.TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/list_ops/tensored_op.py "view source code") +`qiskit.opflow.list_ops.TensoredOp(oplist, coeff=1.0, abelian=False)` Bases: [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") diff --git a/docs/api/qiskit/qiskit.opflow.list_ops.md b/docs/api/qiskit/qiskit.opflow.list_ops.md index 2552c2938c..e1487a025b 100644 --- a/docs/api/qiskit/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/qiskit.opflow.list_ops.md @@ -47,8 +47,8 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l | | | | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp")(oplist\[, combo\_fn, coeff, abelian, ...]) | Deprecated: A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp` and `TensoredOp`. | -| [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | Deprecated: A class for lazily representing compositions of Operators. | -| [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | Deprecated: A class for lazily representing sums of Operators. | -| [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | Deprecated: A class for lazily representing tensor products of Operators. | +| [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp")(oplist\[, combo\_fn, coeff, abelian, ...]) | Deprecated: A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp` and `TensoredOp`. | +| [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | Deprecated: A class for lazily representing compositions of Operators. | +| [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | Deprecated: A class for lazily representing sums of Operators. | +| [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | Deprecated: A class for lazily representing tensor products of Operators. | diff --git a/docs/api/qiskit/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/qiskit.opflow.primitive_ops.CircuitOp.md index a518b7092b..7c9c863385 100644 --- a/docs/api/qiskit/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/qiskit.opflow.primitive_ops.CircuitOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.CircuitOp -`qiskit.opflow.primitive_ops.CircuitOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/circuit_op.py "view source code") +`qiskit.opflow.primitive_ops.CircuitOp(*args, **kwargs)` Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/qiskit.opflow.primitive_ops.MatrixOp.md index 5cd3a721f2..cc0986c313 100644 --- a/docs/api/qiskit/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/qiskit.opflow.primitive_ops.MatrixOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.MatrixOp -`qiskit.opflow.primitive_ops.MatrixOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/matrix_op.py "view source code") +`qiskit.opflow.primitive_ops.MatrixOp(*args, **kwargs)` Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/qiskit.opflow.primitive_ops.PauliOp.md index c933213dd0..02db8559c8 100644 --- a/docs/api/qiskit/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/qiskit.opflow.primitive_ops.PauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliOp -`qiskit.opflow.primitive_ops.PauliOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/pauli_op.py "view source code") +`qiskit.opflow.primitive_ops.PauliOp(*args, **kwargs)` Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/qiskit.opflow.primitive_ops.PauliSumOp.md index 0f8e5c2a7f..8fd7fddce7 100644 --- a/docs/api/qiskit/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PauliSumOp -`qiskit.opflow.primitive_ops.PauliSumOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.PauliSumOp(*args, **kwargs)` Bases: [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") diff --git a/docs/api/qiskit/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/qiskit.opflow.primitive_ops.PrimitiveOp.md index 5e81821b8c..7a7a636a40 100644 --- a/docs/api/qiskit/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp -`qiskit.opflow.primitive_ops.PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/primitive_op.py "view source code") +`qiskit.opflow.primitive_ops.PrimitiveOp(primitive, coeff=1.0)` Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index d53a4f7d5d..db56c21e85 100644 --- a/docs/api/qiskit/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp -`qiskit.opflow.primitive_ops.TaperedPauliSumOp(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.TaperedPauliSumOp(*args, **kwargs)` Bases: [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") diff --git a/docs/api/qiskit/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/qiskit.opflow.primitive_ops.Z2Symmetries.md index f5ed7e783d..0bbb9f6475 100644 --- a/docs/api/qiskit/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries -`qiskit.opflow.primitive_ops.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") +`qiskit.opflow.primitive_ops.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/qiskit.opflow.primitive_ops.md index 56d0173135..67e381c5df 100644 --- a/docs/api/qiskit/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/qiskit.opflow.primitive_ops.md @@ -36,16 +36,16 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.PrimitiveOp")(primitive\[, coeff]) | Deprecated: A class for representing basic Operators, backed by Operator primitives from Terra. | -| [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp")(\*args, \*\*kwargs) | Deprecated: Class for Operators backed by Terra's `QuantumCircuit` module. | -| [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")(\*args, \*\*kwargs) | Deprecated: Class for Operators represented by matrices, backed by Terra's `Operator` module. | -| [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")(\*args, \*\*kwargs) | Deprecated: Class for Operators backed by Terra's `Pauli` module. | -| [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")(\*args, \*\*kwargs) | Deprecated: Class for Operators backed by Terra's `SparsePauliOp` class. | -| [`TaperedPauliSumOp`](qiskit.opflow.primitive_ops.TaperedPauliSumOp "qiskit.opflow.primitive_ops.TaperedPauliSumOp")(\*args, \*\*kwargs) | Deprecated: Class for PauliSumOp after tapering | +| [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.PrimitiveOp")(primitive\[, coeff]) | Deprecated: A class for representing basic Operators, backed by Operator primitives from Terra. | +| [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp")(\*args, \*\*kwargs) | Deprecated: Class for Operators backed by Terra's `QuantumCircuit` module. | +| [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")(\*args, \*\*kwargs) | Deprecated: Class for Operators represented by matrices, backed by Terra's `Operator` module. | +| [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")(\*args, \*\*kwargs) | Deprecated: Class for Operators backed by Terra's `Pauli` module. | +| [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")(\*args, \*\*kwargs) | Deprecated: Class for Operators backed by Terra's `SparsePauliOp` class. | +| [`TaperedPauliSumOp`](qiskit.opflow.primitive_ops.TaperedPauliSumOp "qiskit.opflow.primitive_ops.TaperedPauliSumOp")(\*args, \*\*kwargs) | Deprecated: Class for PauliSumOp after tapering | ### Symmetries | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | -| [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Deprecated: Z2 Symmetries | +| [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Deprecated: Z2 Symmetries | diff --git a/docs/api/qiskit/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/qiskit.opflow.state_fns.CVaRMeasurement.md index 3e0b98e707..ee2f98bb5e 100644 --- a/docs/api/qiskit/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CVaRMeasurement -`qiskit.opflow.state_fns.CVaRMeasurement(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/cvar_measurement.py "view source code") +`qiskit.opflow.state_fns.CVaRMeasurement(*args, **kwargs)` Bases: [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") diff --git a/docs/api/qiskit/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/qiskit.opflow.state_fns.CircuitStateFn.md index 25bda7a61c..44a78260bc 100644 --- a/docs/api/qiskit/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/qiskit.opflow.state_fns.CircuitStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.CircuitStateFn -`qiskit.opflow.state_fns.CircuitStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") +`qiskit.opflow.state_fns.CircuitStateFn(*args, **kwargs)` Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/qiskit.opflow.state_fns.DictStateFn.md index 5a8ce82cdf..5a00547d61 100644 --- a/docs/api/qiskit/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/qiskit.opflow.state_fns.DictStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.DictStateFn -`qiskit.opflow.state_fns.DictStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/dict_state_fn.py "view source code") +`qiskit.opflow.state_fns.DictStateFn(*args, **kwargs)` Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/qiskit.opflow.state_fns.OperatorStateFn.md index a6b9e73383..5210a3bd1f 100644 --- a/docs/api/qiskit/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/qiskit.opflow.state_fns.OperatorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.OperatorStateFn -`qiskit.opflow.state_fns.OperatorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/operator_state_fn.py "view source code") +`qiskit.opflow.state_fns.OperatorStateFn(*args, **kwargs)` Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/qiskit.opflow.state_fns.SparseVectorStateFn.md index 5e39db48fc..97dd1a2b30 100644 --- a/docs/api/qiskit/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn -`qiskit.opflow.state_fns.SparseVectorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") +`qiskit.opflow.state_fns.SparseVectorStateFn(*args, **kwargs)` Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/qiskit.opflow.state_fns.StateFn.md index 8e055158a7..41bd93de5f 100644 --- a/docs/api/qiskit/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/qiskit.opflow.state_fns.StateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.StateFn -`qiskit.opflow.state_fns.StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/state_fn.py "view source code") +`qiskit.opflow.state_fns.StateFn(primitive=None, coeff=1.0, is_measurement=False)` Bases: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") diff --git a/docs/api/qiskit/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/qiskit.opflow.state_fns.VectorStateFn.md index 1552f7f4c1..7c425ab2ee 100644 --- a/docs/api/qiskit/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/qiskit.opflow.state_fns.VectorStateFn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.opflow.state_fns.VectorStateFn -`qiskit.opflow.state_fns.VectorStateFn(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/opflow/state_fns/vector_state_fn.py "view source code") +`qiskit.opflow.state_fns.VectorStateFn(*args, **kwargs)` Bases: [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") diff --git a/docs/api/qiskit/qiskit.opflow.state_fns.md b/docs/api/qiskit/qiskit.opflow.state_fns.md index 17a36c8009..25ed768904 100644 --- a/docs/api/qiskit/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/qiskit.opflow.state_fns.md @@ -40,11 +40,11 @@ Measurements are defined to be functionals over StateFns, taking them to real va | | | | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.StateFn")(\[primitive, coeff, is\_measurement]) | Deprecated: A class for representing state functions and measurements. | -| [`CircuitStateFn`](qiskit.opflow.state_fns.CircuitStateFn "qiskit.opflow.state_fns.CircuitStateFn")(\*args, \*\*kwargs) | Deprecated: A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from \|0⟩, and stored using Terra's `QuantumCircuit` class. | -| [`DictStateFn`](qiskit.opflow.state_fns.DictStateFn "qiskit.opflow.state_fns.DictStateFn")(\*args, \*\*kwargs) | Deprecated: A class for state functions and measurements which are defined by a lookup table, stored in a dict. | -| [`VectorStateFn`](qiskit.opflow.state_fns.VectorStateFn "qiskit.opflow.state_fns.VectorStateFn")(\*args, \*\*kwargs) | Deprecated: A class for state functions and measurements which are defined in vector representation, and stored using Terra's `Statevector` class. | -| [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(\*args, \*\*kwargs) | Deprecated: A class for sparse state functions and measurements in vector representation. | -| [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(\*args, \*\*kwargs) | Deprecated: A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | -| [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\*args, \*\*kwargs) | Deprecated: A specialized measurement class to compute CVaR expectation values. | +| [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.StateFn")(\[primitive, coeff, is\_measurement]) | Deprecated: A class for representing state functions and measurements. | +| [`CircuitStateFn`](qiskit.opflow.state_fns.CircuitStateFn "qiskit.opflow.state_fns.CircuitStateFn")(\*args, \*\*kwargs) | Deprecated: A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from \|0⟩, and stored using Terra's `QuantumCircuit` class. | +| [`DictStateFn`](qiskit.opflow.state_fns.DictStateFn "qiskit.opflow.state_fns.DictStateFn")(\*args, \*\*kwargs) | Deprecated: A class for state functions and measurements which are defined by a lookup table, stored in a dict. | +| [`VectorStateFn`](qiskit.opflow.state_fns.VectorStateFn "qiskit.opflow.state_fns.VectorStateFn")(\*args, \*\*kwargs) | Deprecated: A class for state functions and measurements which are defined in vector representation, and stored using Terra's `Statevector` class. | +| [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(\*args, \*\*kwargs) | Deprecated: A class for sparse state functions and measurements in vector representation. | +| [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(\*args, \*\*kwargs) | Deprecated: A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | +| [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\*args, \*\*kwargs) | Deprecated: A specialized measurement class to compute CVaR expectation values. | diff --git a/docs/api/qiskit/qiskit.passmanager.BaseController.md b/docs/api/qiskit/qiskit.passmanager.BaseController.md index 51192d98c3..580f22eecd 100644 --- a/docs/api/qiskit/qiskit.passmanager.BaseController.md +++ b/docs/api/qiskit/qiskit.passmanager.BaseController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.BaseController -`qiskit.passmanager.BaseController(options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/base_tasks.py "view source code") +`qiskit.passmanager.BaseController(options=None)` Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.passmanager.BasePassManager.md b/docs/api/qiskit/qiskit.passmanager.BasePassManager.md index dcfc8e8557..0a86858d3e 100644 --- a/docs/api/qiskit/qiskit.passmanager.BasePassManager.md +++ b/docs/api/qiskit/qiskit.passmanager.BasePassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.BasePassManager -`qiskit.passmanager.BasePassManager(tasks=(), max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/passmanager.py "view source code") +`qiskit.passmanager.BasePassManager(tasks=(), max_iteration=1000)` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.passmanager.ConditionalController.md b/docs/api/qiskit/qiskit.passmanager.ConditionalController.md index fb47a2473f..03cd742cfc 100644 --- a/docs/api/qiskit/qiskit.passmanager.ConditionalController.md +++ b/docs/api/qiskit/qiskit.passmanager.ConditionalController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.ConditionalController -`qiskit.passmanager.ConditionalController(tasks=(), condition=None, *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.ConditionalController(tasks=(), condition=None, *, options=None)` Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/qiskit.passmanager.DoWhileController.md b/docs/api/qiskit/qiskit.passmanager.DoWhileController.md index d49a880b10..4d827729f2 100644 --- a/docs/api/qiskit/qiskit.passmanager.DoWhileController.md +++ b/docs/api/qiskit/qiskit.passmanager.DoWhileController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.DoWhileController -`qiskit.passmanager.DoWhileController(tasks=(), do_while=None, *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.DoWhileController(tasks=(), do_while=None, *, options=None)` Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/qiskit.passmanager.FlowController.md b/docs/api/qiskit/qiskit.passmanager.FlowController.md index 895e03c649..52a1c04e43 100644 --- a/docs/api/qiskit/qiskit.passmanager.FlowController.md +++ b/docs/api/qiskit/qiskit.passmanager.FlowController.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.FlowController -`qiskit.passmanager.FlowController(options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.FlowController(options=None)` Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.md b/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.md index fa9fc62a6f..084a177ccf 100644 --- a/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.md +++ b/docs/api/qiskit/qiskit.passmanager.FlowControllerLinear.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.FlowControllerLinear -`qiskit.passmanager.FlowControllerLinear(tasks=(), *, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/flow_controllers.py "view source code") +`qiskit.passmanager.FlowControllerLinear(tasks=(), *, options=None)` Bases: [`BaseController`](qiskit.passmanager.BaseController "qiskit.passmanager.base_tasks.BaseController") diff --git a/docs/api/qiskit/qiskit.passmanager.GenericPass.md b/docs/api/qiskit/qiskit.passmanager.GenericPass.md index bd69b66f88..11c50f52a7 100644 --- a/docs/api/qiskit/qiskit.passmanager.GenericPass.md +++ b/docs/api/qiskit/qiskit.passmanager.GenericPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.GenericPass -`qiskit.passmanager.GenericPass`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/base_tasks.py "view source code") +`qiskit.passmanager.GenericPass` Bases: `Task`, [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.passmanager.PassManagerState.md b/docs/api/qiskit/qiskit.passmanager.PassManagerState.md index fd43363e51..bcfe42551b 100644 --- a/docs/api/qiskit/qiskit.passmanager.PassManagerState.md +++ b/docs/api/qiskit/qiskit.passmanager.PassManagerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.PassManagerState -`qiskit.passmanager.PassManagerState(workflow_status, property_set)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.PassManagerState(workflow_status, property_set)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.passmanager.PropertySet.md b/docs/api/qiskit/qiskit.passmanager.PropertySet.md index cd1bd99ada..a7c65bc0f7 100644 --- a/docs/api/qiskit/qiskit.passmanager.PropertySet.md +++ b/docs/api/qiskit/qiskit.passmanager.PropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.PropertySet -`qiskit.passmanager.PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.PropertySet` Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.md b/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.md index 986097f024..11524dee57 100644 --- a/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.md +++ b/docs/api/qiskit/qiskit.passmanager.WorkflowStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.passmanager.WorkflowStatus -`qiskit.passmanager.WorkflowStatus(count=0, completed_passes=, previous_run=RunState.FAIL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/passmanager/compilation_status.py "view source code") +`qiskit.passmanager.WorkflowStatus(count=0, completed_passes=, previous_run=RunState.FAIL)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/qiskit.primitives.BackendEstimator.md index 1d01649e1f..89854e58e6 100644 --- a/docs/api/qiskit/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/qiskit.primitives.BackendEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendEstimator -`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/backend_estimator.py "view source code") +`qiskit.primitives.BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/qiskit.primitives.BackendSampler.md index b8817a6b8a..621a86ff0a 100644 --- a/docs/api/qiskit/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/qiskit.primitives.BackendSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BackendSampler -`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/backend_sampler.py "view source code") +`qiskit.primitives.BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/qiskit.primitives.BaseEstimator.md index 8691685cad..3ff4dfdb0a 100644 --- a/docs/api/qiskit/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/qiskit.primitives.BaseEstimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseEstimator -`qiskit.primitives.BaseEstimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/base_estimator.py "view source code") +`qiskit.primitives.BaseEstimator(*, options=None)` Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/qiskit.primitives.BaseSampler.md index baf32b4a1d..d41bc9a079 100644 --- a/docs/api/qiskit/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/qiskit.primitives.BaseSampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.BaseSampler -`qiskit.primitives.BaseSampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/base_sampler.py "view source code") +`qiskit.primitives.BaseSampler(*, options=None)` Bases: `BasePrimitive`, [`Generic`](https://docs.python.org/3/library/typing.html#typing.Generic "(in Python v3.12)")\[`T`] diff --git a/docs/api/qiskit/qiskit.primitives.Estimator.md b/docs/api/qiskit/qiskit.primitives.Estimator.md index cd198c5d9f..e55cbc3652 100644 --- a/docs/api/qiskit/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/qiskit.primitives.Estimator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Estimator -`qiskit.primitives.Estimator(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/estimator.py "view source code") +`qiskit.primitives.Estimator(*, options=None)` Bases: [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator")\[`PrimitiveJob`\[[`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.base.estimator_result.EstimatorResult")]] diff --git a/docs/api/qiskit/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/qiskit.primitives.EstimatorResult.md index 784b435ca2..7235b68a82 100644 --- a/docs/api/qiskit/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/qiskit.primitives.EstimatorResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.EstimatorResult -`qiskit.primitives.EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/estimator_result.py "view source code") +`qiskit.primitives.EstimatorResult(values, metadata)` Bases: `BasePrimitiveResult` diff --git a/docs/api/qiskit/qiskit.primitives.Sampler.md b/docs/api/qiskit/qiskit.primitives.Sampler.md index 3ba25821c9..ce4e69782c 100644 --- a/docs/api/qiskit/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/qiskit.primitives.Sampler.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.Sampler -`qiskit.primitives.Sampler(*, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/sampler.py "view source code") +`qiskit.primitives.Sampler(*, options=None)` Bases: [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler")\[`PrimitiveJob`\[[`SamplerResult`](qiskit.primitives.SamplerResult "qiskit.primitives.base.sampler_result.SamplerResult")]] diff --git a/docs/api/qiskit/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/qiskit.primitives.SamplerResult.md index ac3ff6c983..6896a68653 100644 --- a/docs/api/qiskit/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/qiskit.primitives.SamplerResult.md @@ -10,7 +10,7 @@ python_api_name: qiskit.primitives.SamplerResult -`qiskit.primitives.SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/primitives/base/sampler_result.py "view source code") +`qiskit.primitives.SamplerResult(quasi_dists, metadata)` Bases: `BasePrimitiveResult` diff --git a/docs/api/qiskit/qiskit.providers.Backend.md b/docs/api/qiskit/qiskit.providers.Backend.md index 62359cd80b..dfc9da53cc 100644 --- a/docs/api/qiskit/qiskit.providers.Backend.md +++ b/docs/api/qiskit/qiskit.providers.Backend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Backend -`qiskit.providers.Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") +`qiskit.providers.Backend` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.BackendV1.md b/docs/api/qiskit/qiskit.providers.BackendV1.md index 6b7c239eac..0bf3f8dd12 100644 --- a/docs/api/qiskit/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/qiskit.providers.BackendV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV1 -`qiskit.providers.BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV1(configuration, provider=None, **fields)` Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.BackendV2.md b/docs/api/qiskit/qiskit.providers.BackendV2.md index 458f018067..3bbc40e3a3 100644 --- a/docs/api/qiskit/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/qiskit.providers.BackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2 -`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") +`qiskit.providers.BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` Bases: [`Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/qiskit.providers.BackendV2Converter.md index 45e6db9554..57d294ce1f 100644 --- a/docs/api/qiskit/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/qiskit.providers.BackendV2Converter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.BackendV2Converter -`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=False, filter_faulty=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.BackendV2Converter(backend, name_mapping=None, add_delay=False, filter_faulty=False)` Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/qiskit.providers.Job.md b/docs/api/qiskit/qiskit.providers.Job.md index b5b6378e5c..e354ca1ee0 100644 --- a/docs/api/qiskit/qiskit.providers.Job.md +++ b/docs/api/qiskit/qiskit.providers.Job.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Job -`qiskit.providers.Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/job.py "view source code") +`qiskit.providers.Job` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.JobStatus.md b/docs/api/qiskit/qiskit.providers.JobStatus.md index 7c24556c8e..f033446d61 100644 --- a/docs/api/qiskit/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/qiskit.providers.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobStatus -`qiskit.providers.JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/jobstatus.py "view source code") +`qiskit.providers.JobStatus(value)` Bases: [`Enum`](https://docs.python.org/3/library/enum.html#enum.Enum "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.JobV1.md b/docs/api/qiskit/qiskit.providers.JobV1.md index 1725d2f0fe..1d1c640817 100644 --- a/docs/api/qiskit/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/qiskit.providers.JobV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.JobV1 -`qiskit.providers.JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/job.py "view source code") +`qiskit.providers.JobV1(backend, job_id, **kwargs)` Bases: [`Job`](qiskit.providers.Job "qiskit.providers.job.Job"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.Options.md b/docs/api/qiskit/qiskit.providers.Options.md index 6d2487c564..7dcb07cc8a 100644 --- a/docs/api/qiskit/qiskit.providers.Options.md +++ b/docs/api/qiskit/qiskit.providers.Options.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Options -`qiskit.providers.Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/options.py "view source code") +`qiskit.providers.Options(**kwargs)` Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.Provider.md b/docs/api/qiskit/qiskit.providers.Provider.md index 2032d2ce22..44b2586326 100644 --- a/docs/api/qiskit/qiskit.providers.Provider.md +++ b/docs/api/qiskit/qiskit.providers.Provider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.Provider -`qiskit.providers.Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/provider.py "view source code") +`qiskit.providers.Provider` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.ProviderV1.md b/docs/api/qiskit/qiskit.providers.ProviderV1.md index 3e5b2202af..e44a62ef23 100644 --- a/docs/api/qiskit/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/qiskit.providers.ProviderV1.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.ProviderV1 -`qiskit.providers.ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/provider.py "view source code") +`qiskit.providers.ProviderV1` Bases: [`Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.QubitProperties.md b/docs/api/qiskit/qiskit.providers.QubitProperties.md index cd9d488acb..cb8634f1e9 100644 --- a/docs/api/qiskit/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/qiskit.providers.QubitProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.QubitProperties -`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend.py "view source code") +`qiskit.providers.QubitProperties(t1=None, t2=None, frequency=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/qiskit.providers.basicaer.BasicAerError.md index e0bdd44dad..27aa328b7d 100644 --- a/docs/api/qiskit/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/qiskit.providers.basicaer.BasicAerError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerError -`qiskit.providers.basicaer.BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/exceptions.py "view source code") +`qiskit.providers.basicaer.BasicAerError(*message)` Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/qiskit.providers.basicaer.BasicAerJob.md index 21edef3c74..74a268f7f5 100644 --- a/docs/api/qiskit/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/qiskit.providers.basicaer.BasicAerJob.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerJob -`qiskit.providers.basicaer.BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/basicaerjob.py "view source code") +`qiskit.providers.basicaer.BasicAerJob(backend, job_id, result)` Bases: [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") diff --git a/docs/api/qiskit/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/qiskit.providers.basicaer.BasicAerProvider.md index 32fe7dbc5e..698fa001df 100644 --- a/docs/api/qiskit/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/qiskit.providers.basicaer.BasicAerProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.BasicAerProvider -`qiskit.providers.basicaer.BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/basicaerprovider.py "view source code") +`qiskit.providers.basicaer.BasicAerProvider` Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/qiskit.providers.basicaer.QasmSimulatorPy.md index aa6f214fbb..ef670a728a 100644 --- a/docs/api/qiskit/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.QasmSimulatorPy -`qiskit.providers.basicaer.QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/qasm_simulator.py "view source code") +`qiskit.providers.basicaer.QasmSimulatorPy(configuration=None, provider=None, **fields)` Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -68,7 +68,7 @@ default values set ### MAX\_QUBITS\_MEMORY -`= 29` +`= 28` diff --git a/docs/api/qiskit/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/qiskit.providers.basicaer.StatevectorSimulatorPy.md index aed3309fdc..52b3dd407d 100644 --- a/docs/api/qiskit/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy -`qiskit.providers.basicaer.StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/statevector_simulator.py "view source code") +`qiskit.providers.basicaer.StatevectorSimulatorPy(configuration=None, provider=None, **fields)` Bases: [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") @@ -68,7 +68,7 @@ default values set ### MAX\_QUBITS\_MEMORY -`= 29` +`= 28` diff --git a/docs/api/qiskit/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/qiskit.providers.basicaer.UnitarySimulatorPy.md index 3c1ba1d9bc..9cca511804 100644 --- a/docs/api/qiskit/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy -`qiskit.providers.basicaer.UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/basicaer/unitary_simulator.py "view source code") +`qiskit.providers.basicaer.UnitarySimulatorPy(configuration=None, provider=None, **fields)` Bases: [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") diff --git a/docs/api/qiskit/qiskit.providers.convert_to_target.md b/docs/api/qiskit/qiskit.providers.convert_to_target.md index 10a10f82a9..6adae777af 100644 --- a/docs/api/qiskit/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/qiskit.providers.convert_to_target.md @@ -12,7 +12,7 @@ python_api_name: qiskit.providers.convert_to_target -`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False, filter_faulty=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/backend_compat.py "view source code") +`qiskit.providers.convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False, filter_faulty=False)` Uses configuration, properties and pulse defaults to construct and return Target class. diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index 7feb0cfea3..c8319daee4 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend -`qiskit.providers.fake_provider.ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") +`qiskit.providers.fake_provider.ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/qiskit.providers.fake_provider.Fake1Q.md index d0cb41658f..10764931dd 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.Fake1Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.Fake1Q -`qiskit.providers.fake_provider.Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_1q.py "view source code") +`qiskit.providers.fake_provider.Fake1Q` Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeAlmaden.md index ec5cee5cc6..3c2181c989 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeAlmaden.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmaden -`qiskit.providers.fake_provider.FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`qiskit.providers.fake_provider.FakeAlmaden` Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") @@ -51,7 +51,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/almaden'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/almaden'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeAlmadenV2.md index f0e46d7578..9e5efceb82 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 -`qiskit.providers.fake_provider.FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") +`qiskit.providers.fake_provider.FakeAlmadenV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -58,7 +58,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/almaden'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/almaden'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeArmonk.md index 074541754b..dc41e5a955 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeArmonk.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonk -`qiskit.providers.fake_provider.FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`qiskit.providers.fake_provider.FakeArmonk` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -51,7 +51,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/armonk'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/armonk'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeArmonkV2.md index b72f097d0f..780c5b4e27 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 -`qiskit.providers.fake_provider.FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") +`qiskit.providers.fake_provider.FakeArmonkV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -52,7 +52,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/armonk'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/armonk'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeAthens.md index 051cdf2bca..bd159a2cdb 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeAthens.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthens -`qiskit.providers.fake_provider.FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`qiskit.providers.fake_provider.FakeAthens` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/athens'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/athens'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeAthensV2.md index eb463e89dc..dd5d52f3cd 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeAthensV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAthensV2 -`qiskit.providers.fake_provider.FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") +`qiskit.providers.fake_provider.FakeAthensV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/athens'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/athens'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeAuckland.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeAuckland.md index 09676b0ad7..92dfc174ca 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeAuckland.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeAuckland -`qiskit.providers.fake_provider.FakeAuckland`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") +`qiskit.providers.fake_provider.FakeAuckland` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/auckland'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/auckland'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBackend5QV2.md index 893dca820c..8962981866 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 -`qiskit.providers.fake_provider.FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`qiskit.providers.fake_provider.FakeBackend5QV2(bidirectional=True)` Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBackendV2.md index 68d06ee783..1369301670 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBackendV2 -`qiskit.providers.fake_provider.FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") +`qiskit.providers.fake_provider.FakeBackendV2` Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBelem.md index dca51076a4..88453078cc 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBelem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelem -`qiskit.providers.fake_provider.FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`qiskit.providers.fake_provider.FakeBelem` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/belem'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/belem'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBelemV2.md index 83ae063e28..cd12663bf5 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBelemV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBelemV2 -`qiskit.providers.fake_provider.FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") +`qiskit.providers.fake_provider.FakeBelemV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/belem'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/belem'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBoeblingen.md index 9b285c460e..79d158bef4 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingen -`qiskit.providers.fake_provider.FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`qiskit.providers.fake_provider.FakeBoeblingen` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -57,7 +57,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/boeblingen'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/boeblingen'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBoeblingenV2.md index e9dcb3cd1f..0978edd702 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 -`qiskit.providers.fake_provider.FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") +`qiskit.providers.fake_provider.FakeBoeblingenV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -58,7 +58,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/boeblingen'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/boeblingen'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBogota.md index 5155473994..b221cd5ac4 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBogota.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogota -`qiskit.providers.fake_provider.FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`qiskit.providers.fake_provider.FakeBogota` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/bogota'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/bogota'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBogotaV2.md index 2e55330100..2a2402201a 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 -`qiskit.providers.fake_provider.FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") +`qiskit.providers.fake_provider.FakeBogotaV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/bogota'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/bogota'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBrooklyn.md index 5bca91c7fc..8ae0ec0780 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklyn -`qiskit.providers.fake_provider.FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`qiskit.providers.fake_provider.FakeBrooklyn` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/brooklyn'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/brooklyn'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBrooklynV2.md index fe08f6fe6c..8069a434f2 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 -`qiskit.providers.fake_provider.FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") +`qiskit.providers.fake_provider.FakeBrooklynV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/brooklyn'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/brooklyn'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBurlington.md index ebae3de772..56dd92ebb2 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBurlington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlington -`qiskit.providers.fake_provider.FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`qiskit.providers.fake_provider.FakeBurlington` Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/burlington'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/burlington'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBurlingtonV2.md index d2ac10f8fc..9f0b1af91e 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 -`qiskit.providers.fake_provider.FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") +`qiskit.providers.fake_provider.FakeBurlingtonV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -54,7 +54,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/burlington'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/burlington'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCairo.md index adc0d2a71c..1851d1c539 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCairo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairo -`qiskit.providers.fake_provider.FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`qiskit.providers.fake_provider.FakeCairo` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/cairo'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/cairo'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCairoV2.md index 05dc8b7569..47981f5575 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCairoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCairoV2 -`qiskit.providers.fake_provider.FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") +`qiskit.providers.fake_provider.FakeCairoV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/cairo'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/cairo'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCambridge.md index 8a515e0967..78bceee2e6 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCambridge.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridge -`qiskit.providers.fake_provider.FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`qiskit.providers.fake_provider.FakeCambridge` Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") @@ -53,7 +53,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/cambridge'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/cambridge'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCambridgeV2.md index 051790bf9f..fa70a0568b 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 -`qiskit.providers.fake_provider.FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") +`qiskit.providers.fake_provider.FakeCambridgeV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -60,7 +60,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/cambridge'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/cambridge'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCasablanca.md index 712bd2ec8b..ad7c63b14e 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCasablanca.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablanca -`qiskit.providers.fake_provider.FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`qiskit.providers.fake_provider.FakeCasablanca` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/casablanca'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/casablanca'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCasablancaV2.md index 14c6b460b4..a614e4dd27 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 -`qiskit.providers.fake_provider.FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") +`qiskit.providers.fake_provider.FakeCasablancaV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/casablanca'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/casablanca'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeEssex.md index 91bd0bd011..1b69c9cd4b 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeEssex.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssex -`qiskit.providers.fake_provider.FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`qiskit.providers.fake_provider.FakeEssex` Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") @@ -49,7 +49,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/essex'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/essex'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeEssexV2.md index 6711d7b03f..671930edff 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeEssexV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeEssexV2 -`qiskit.providers.fake_provider.FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") +`qiskit.providers.fake_provider.FakeEssexV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -56,7 +56,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/essex'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/essex'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeGeneva.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeGeneva.md index a4d0b78411..41502989cd 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeGeneva.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGeneva -`qiskit.providers.fake_provider.FakeGeneva`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") +`qiskit.providers.fake_provider.FakeGeneva` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/geneva'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/geneva'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeGuadalupe.md index 93659eb223..de9fd27d7f 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupe -`qiskit.providers.fake_provider.FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`qiskit.providers.fake_provider.FakeGuadalupe` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/guadalupe'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/guadalupe'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeGuadalupeV2.md index a898513599..6439a85ab8 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 -`qiskit.providers.fake_provider.FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") +`qiskit.providers.fake_provider.FakeGuadalupeV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/guadalupe'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/guadalupe'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeHanoi.md index 0cb629277a..2be3d55bfb 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeHanoi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoi -`qiskit.providers.fake_provider.FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`qiskit.providers.fake_provider.FakeHanoi` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/hanoi'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/hanoi'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeHanoiV2.md index ec9b3f8740..e2de9d49fe 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 -`qiskit.providers.fake_provider.FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") +`qiskit.providers.fake_provider.FakeHanoiV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/hanoi'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/hanoi'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeJakarta.md index 498d4ced79..8db6211e1a 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeJakarta.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakarta -`qiskit.providers.fake_provider.FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`qiskit.providers.fake_provider.FakeJakarta` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/jakarta'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/jakarta'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeJakartaV2.md index cf99aac6e1..caa227859a 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 -`qiskit.providers.fake_provider.FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") +`qiskit.providers.fake_provider.FakeJakartaV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/jakarta'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/jakarta'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeJohannesburg.md index 8202576b3d..2504f81bd4 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburg -`qiskit.providers.fake_provider.FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`qiskit.providers.fake_provider.FakeJohannesburg` Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") @@ -51,7 +51,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/johannesburg'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/johannesburg'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeJohannesburgV2.md index c54208c383..dad33fc0a2 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 -`qiskit.providers.fake_provider.FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") +`qiskit.providers.fake_provider.FakeJohannesburgV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -58,7 +58,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/johannesburg'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/johannesburg'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeKolkata.md index 18ae49759a..0eb2f744c7 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeKolkata.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkata -`qiskit.providers.fake_provider.FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`qiskit.providers.fake_provider.FakeKolkata` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/kolkata'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/kolkata'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeKolkataV2.md index 1e17f52653..9000ff37cf 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 -`qiskit.providers.fake_provider.FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") +`qiskit.providers.fake_provider.FakeKolkataV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/kolkata'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/kolkata'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLagos.md index d62cdbc2f2..d1f1c4f2d6 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLagos.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagos -`qiskit.providers.fake_provider.FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`qiskit.providers.fake_provider.FakeLagos` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/lagos'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/lagos'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLagosV2.md index 7cb375a18e..21ed213556 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLagosV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLagosV2 -`qiskit.providers.fake_provider.FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") +`qiskit.providers.fake_provider.FakeLagosV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/lagos'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/lagos'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLima.md index 4219d8cbe1..eaf570f6f5 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLima.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLima -`qiskit.providers.fake_provider.FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`qiskit.providers.fake_provider.FakeLima` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/lima'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/lima'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLimaV2.md index b312abdaa8..ef80b88b4a 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLimaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLimaV2 -`qiskit.providers.fake_provider.FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") +`qiskit.providers.fake_provider.FakeLimaV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/lima'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/lima'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLondon.md index 328e5527fc..df4052cc43 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLondon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondon -`qiskit.providers.fake_provider.FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`qiskit.providers.fake_provider.FakeLondon` Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") @@ -49,7 +49,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/london'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/london'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLondonV2.md index fe84c71198..4deb0881e9 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeLondonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeLondonV2 -`qiskit.providers.fake_provider.FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") +`qiskit.providers.fake_provider.FakeLondonV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -56,7 +56,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/london'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/london'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeManhattan.md index 7423aaf37a..1860add16e 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeManhattan.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattan -`qiskit.providers.fake_provider.FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`qiskit.providers.fake_provider.FakeManhattan` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/manhattan'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/manhattan'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeManhattanV2.md index 946f45565c..5844c2bc3e 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 -`qiskit.providers.fake_provider.FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") +`qiskit.providers.fake_provider.FakeManhattanV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/manhattan'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/manhattan'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeManila.md index dfc950fb0b..287ef3bab3 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeManila.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManila -`qiskit.providers.fake_provider.FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`qiskit.providers.fake_provider.FakeManila` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/manila'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/manila'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeManilaV2.md index de33a91285..eef73d9865 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeManilaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeManilaV2 -`qiskit.providers.fake_provider.FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") +`qiskit.providers.fake_provider.FakeManilaV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/manila'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/manila'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMelbourne.md index 392dc4dc90..1e0e24eacf 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMelbourne.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourne -`qiskit.providers.fake_provider.FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`qiskit.providers.fake_provider.FakeMelbourne` Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMelbourneV2.md index 026997dfdb..24a4615aba 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 -`qiskit.providers.fake_provider.FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") +`qiskit.providers.fake_provider.FakeMelbourneV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/melbourne'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/melbourne'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMontreal.md index 1115654c76..836729a04d 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMontreal.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontreal -`qiskit.providers.fake_provider.FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`qiskit.providers.fake_provider.FakeMontreal` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/montreal'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/montreal'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMontrealV2.md index 571070bb2a..2463ae822a 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 -`qiskit.providers.fake_provider.FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") +`qiskit.providers.fake_provider.FakeMontrealV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/montreal'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/montreal'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbai.md index 608b591d75..26a05b2af4 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbai.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbai -`qiskit.providers.fake_provider.FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`qiskit.providers.fake_provider.FakeMumbai` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/mumbai'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/mumbai'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index 1a3d51c358..be43a99e4a 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX -`qiskit.providers.fake_provider.FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") +`qiskit.providers.fake_provider.FakeMumbaiFractionalCX` Bases: [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbaiV2.md index 083b013be6..fb01227784 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 -`qiskit.providers.fake_provider.FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") +`qiskit.providers.fake_provider.FakeMumbaiV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/mumbai'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/mumbai'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeNairobi.md index db921f147d..f022632aab 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeNairobi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobi -`qiskit.providers.fake_provider.FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`qiskit.providers.fake_provider.FakeNairobi` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/nairobi'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/nairobi'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeNairobiV2.md index 4ddff4406e..347757009c 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 -`qiskit.providers.fake_provider.FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") +`qiskit.providers.fake_provider.FakeNairobiV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/nairobi'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/nairobi'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index 6571307a80..65c556d472 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q -`qiskit.providers.fake_provider.FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse2Q` Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index e42d765685..310d5cfe4f 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q -`qiskit.providers.fake_provider.FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") +`qiskit.providers.fake_provider.FakeOpenPulse3Q` Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOslo.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOslo.md index f85bcef48e..92eb566702 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOslo.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOslo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOslo -`qiskit.providers.fake_provider.FakeOslo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") +`qiskit.providers.fake_provider.FakeOslo` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/oslo'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/oslo'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOurense.md index 441c863962..d3c387495a 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOurense.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurense -`qiskit.providers.fake_provider.FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`qiskit.providers.fake_provider.FakeOurense` Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/ourense'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/ourense'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOurenseV2.md index b7dbcea6c7..bb816854a2 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 -`qiskit.providers.fake_provider.FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") +`qiskit.providers.fake_provider.FakeOurenseV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -54,7 +54,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/ourense'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/ourense'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeParis.md index eb071f4252..5f45d5bf34 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeParis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParis -`qiskit.providers.fake_provider.FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`qiskit.providers.fake_provider.FakeParis` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -59,7 +59,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/paris'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/paris'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeParisV2.md index feaf81d363..2af1317951 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeParisV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeParisV2 -`qiskit.providers.fake_provider.FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") +`qiskit.providers.fake_provider.FakeParisV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -60,7 +60,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/paris'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/paris'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakePerth.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakePerth.md index 7c2afea78b..71cbf46219 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakePerth.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakePerth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePerth -`qiskit.providers.fake_provider.FakePerth`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") +`qiskit.providers.fake_provider.FakePerth` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/perth'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/perth'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakePoughkeepsie.md index 7cc30a04ef..a1c0f8eb61 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie -`qiskit.providers.fake_provider.FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`qiskit.providers.fake_provider.FakePoughkeepsie` Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index 174063cbbd..28d2f25506 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 -`qiskit.providers.fake_provider.FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") +`qiskit.providers.fake_provider.FakePoughkeepsieV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/poughkeepsie'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/poughkeepsie'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakePrague.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakePrague.md index 1a371a50cb..b0ac8c2682 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakePrague.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakePrague.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakePrague -`qiskit.providers.fake_provider.FakePrague`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") +`qiskit.providers.fake_provider.FakePrague` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/prague'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/prague'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeProvider.md index a1036d8e7e..091b0eb463 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeProvider.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProvider -`qiskit.providers.fake_provider.FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_provider.py "view source code") +`qiskit.providers.fake_provider.FakeProvider` Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index faab743e28..58c63ebaa7 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 -`qiskit.providers.fake_provider.FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_provider.py "view source code") +`qiskit.providers.fake_provider.FakeProviderForBackendV2` Bases: [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeQasmSimulator.md index 7d083dc6d6..a8cedead81 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator -`qiskit.providers.fake_provider.FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") +`qiskit.providers.fake_provider.FakeQasmSimulator` Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeQuito.md index 0f3ba5ea4a..5ce2228257 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeQuito.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuito -`qiskit.providers.fake_provider.FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`qiskit.providers.fake_provider.FakeQuito` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/quito'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/quito'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeQuitoV2.md index b580984e88..d4f420072b 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 -`qiskit.providers.fake_provider.FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") +`qiskit.providers.fake_provider.FakeQuitoV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/quito'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/quito'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeRochester.md index e69badac10..1eb44de899 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeRochester.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochester -`qiskit.providers.fake_provider.FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`qiskit.providers.fake_provider.FakeRochester` Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") @@ -41,7 +41,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/rochester'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/rochester'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeRochesterV2.md index a569e6a5cd..d2121233f5 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 -`qiskit.providers.fake_provider.FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") +`qiskit.providers.fake_provider.FakeRochesterV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/rochester'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/rochester'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeRome.md index 1d95443956..6e3bf6f83a 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeRome.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRome -`qiskit.providers.fake_provider.FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`qiskit.providers.fake_provider.FakeRome` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/rome'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/rome'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeRomeV2.md index 1b259e43eb..dd861267fa 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeRomeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRomeV2 -`qiskit.providers.fake_provider.FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") +`qiskit.providers.fake_provider.FakeRomeV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/rome'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/rome'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeRueschlikon.md index 6f8b982a52..8589a562da 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeRueschlikon -`qiskit.providers.fake_provider.FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") +`qiskit.providers.fake_provider.FakeRueschlikon` Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSantiago.md index 78c7b01300..815c68a856 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSantiago.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiago -`qiskit.providers.fake_provider.FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`qiskit.providers.fake_provider.FakeSantiago` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/santiago'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/santiago'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSantiagoV2.md index 6524d234b4..764487f7ce 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 -`qiskit.providers.fake_provider.FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") +`qiskit.providers.fake_provider.FakeSantiagoV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/santiago'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/santiago'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSherbrooke.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSherbrooke.md index 313be6aa2f..3583adb85f 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSherbrooke.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSherbrooke -`qiskit.providers.fake_provider.FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") +`qiskit.providers.fake_provider.FakeSherbrooke` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/sherbrooke'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/sherbrooke'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSingapore.md index 117864edaa..ed2cb017ef 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSingapore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingapore -`qiskit.providers.fake_provider.FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`qiskit.providers.fake_provider.FakeSingapore` Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") @@ -51,7 +51,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/singapore'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/singapore'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSingaporeV2.md index fa5cacb050..776c68d07f 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 -`qiskit.providers.fake_provider.FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") +`qiskit.providers.fake_provider.FakeSingaporeV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -58,7 +58,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/singapore'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/singapore'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSydney.md index a6640f46f9..3f92bb2f46 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSydney.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydney -`qiskit.providers.fake_provider.FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`qiskit.providers.fake_provider.FakeSydney` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/sydney'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/sydney'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSydneyV2.md index 79c7e87e50..a8344ecde8 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 -`qiskit.providers.fake_provider.FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") +`qiskit.providers.fake_provider.FakeSydneyV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/sydney'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/sydney'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeTenerife.md index e5c2e85880..21f20d486e 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeTenerife.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTenerife -`qiskit.providers.fake_provider.FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") +`qiskit.providers.fake_provider.FakeTenerife` Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeTokyo.md index 7ac18b4322..e97fc82673 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeTokyo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTokyo -`qiskit.providers.fake_provider.FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") +`qiskit.providers.fake_provider.FakeTokyo` Bases: [`FakeBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeBackend "qiskit.providers.fake_provider.fake_backend.FakeBackend") diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeToronto.md index 1d5cc449e1..f37571e770 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeToronto.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeToronto -`qiskit.providers.fake_provider.FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`qiskit.providers.fake_provider.FakeToronto` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/toronto'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/toronto'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeTorontoV2.md index d48c23a9f9..ccb0ac3f38 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 -`qiskit.providers.fake_provider.FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") +`qiskit.providers.fake_provider.FakeTorontoV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/toronto'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/toronto'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeValencia.md index 2df03e6f13..6552988ed6 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeValencia.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValencia -`qiskit.providers.fake_provider.FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`qiskit.providers.fake_provider.FakeValencia` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/valencia'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/valencia'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeValenciaV2.md index d36ebf498e..929b78931c 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 -`qiskit.providers.fake_provider.FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") +`qiskit.providers.fake_provider.FakeValenciaV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/valencia'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/valencia'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeVigo.md index 21de4a495d..4d897cee34 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeVigo.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigo -`qiskit.providers.fake_provider.FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`qiskit.providers.fake_provider.FakeVigo` Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/vigo'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/vigo'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeVigoV2.md index 388dfe997d..209b0d21d0 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeVigoV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeVigoV2 -`qiskit.providers.fake_provider.FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") +`qiskit.providers.fake_provider.FakeVigoV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -54,7 +54,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/vigo'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/vigo'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeWashington.md index bbef8f5471..e87954f727 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeWashington.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashington -`qiskit.providers.fake_provider.FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`qiskit.providers.fake_provider.FakeWashington` Bases: [`FakePulseBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakePulseBackend "qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend") @@ -47,7 +47,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/washington'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/washington'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeWashingtonV2.md index 1ca09b3ea8..4ad9f18b72 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 -`qiskit.providers.fake_provider.FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") +`qiskit.providers.fake_provider.FakeWashingtonV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -48,7 +48,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/washington'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/washington'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeYorktown.md index 8974cbb710..b6959048ff 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeYorktown.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktown -`qiskit.providers.fake_provider.FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`qiskit.providers.fake_provider.FakeYorktown` Bases: [`FakeQasmBackend`](providers_fake_provider#qiskit.providers.fake_provider.FakeQasmBackend "qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend") @@ -49,7 +49,7 @@ FakeBackend initializer. ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/yorktown'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/yorktown'` diff --git a/docs/api/qiskit/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/qiskit.providers.fake_provider.FakeYorktownV2.md index 2f5c6d8e91..1c92820177 100644 --- a/docs/api/qiskit/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 -`qiskit.providers.fake_provider.FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") +`qiskit.providers.fake_provider.FakeYorktownV2` Bases: [`FakeBackendV2`](providers_fake_provider#qiskit.providers.fake_provider.fake_backend.FakeBackendV2 "qiskit.providers.fake_provider.fake_backend.FakeBackendV2") @@ -56,7 +56,7 @@ Return the [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.Coup ### dirname -`= '/home/runner/work/qiskit/qiskit/qiskit/providers/fake_provider/backends/yorktown'` +`= '/home/runner/work/qiskit/qiskit/.tox/docs/lib/python3.9/site-packages/qiskit/providers/fake_provider/backends/yorktown'` diff --git a/docs/api/qiskit/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/qiskit.providers.models.BackendConfiguration.md index aee46eb592..b0c552f920 100644 --- a/docs/api/qiskit/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/qiskit.providers.models.BackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendConfiguration -`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/qiskit.providers.models.BackendProperties.md index df444b03bc..78889521e1 100644 --- a/docs/api/qiskit/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/qiskit.providers.models.BackendProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendProperties -`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/qiskit.providers.models.BackendStatus.md index dc14671bc9..16504a4bf1 100644 --- a/docs/api/qiskit/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/qiskit.providers.models.BackendStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.BackendStatus -`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendstatus.py "view source code") +`qiskit.providers.models.BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.Command.md b/docs/api/qiskit/qiskit.providers.models.Command.md index 5f84446be4..ba61b29d4b 100644 --- a/docs/api/qiskit/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/qiskit.providers.models.Command.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Command -`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.Command(name, qubits=None, sequence=None, **kwargs)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/qiskit.providers.models.GateConfig.md index cab9e0b38c..98ba5e0630 100644 --- a/docs/api/qiskit/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/qiskit.providers.models.GateConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateConfig -`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.GateProperties.md b/docs/api/qiskit/qiskit.providers.models.GateProperties.md index 2bab76171f..f2158d4893 100644 --- a/docs/api/qiskit/qiskit.providers.models.GateProperties.md +++ b/docs/api/qiskit/qiskit.providers.models.GateProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.GateProperties -`qiskit.providers.models.GateProperties(qubits, gate, parameters, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.GateProperties(qubits, gate, parameters, **kwargs)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/qiskit.providers.models.JobStatus.md index 8504dd913b..723e71c50a 100644 --- a/docs/api/qiskit/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/qiskit.providers.models.JobStatus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.JobStatus -`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/jobstatus.py "view source code") +`qiskit.providers.models.JobStatus(job_id, status, status_msg, **kwargs)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.Nduv.md b/docs/api/qiskit/qiskit.providers.models.Nduv.md index 854ca69e2c..2da505dc10 100644 --- a/docs/api/qiskit/qiskit.providers.models.Nduv.md +++ b/docs/api/qiskit/qiskit.providers.models.Nduv.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.Nduv -`qiskit.providers.models.Nduv(date, name, unit, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendproperties.py "view source code") +`qiskit.providers.models.Nduv(date, name, unit, value)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.md index 0d1b4d6999..08637b3ddf 100644 --- a/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/qiskit.providers.models.PulseBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseBackendConfiguration -`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` Bases: [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/qiskit.providers.models.PulseDefaults.md index f5107452ef..99e7675bf7 100644 --- a/docs/api/qiskit/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/qiskit.providers.models.PulseDefaults.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.PulseDefaults -`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/pulsedefaults.py "view source code") +`qiskit.providers.models.PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/qiskit.providers.models.QasmBackendConfiguration.md index d97a6cabb3..3b138ea46d 100644 --- a/docs/api/qiskit/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/qiskit.providers.models.QasmBackendConfiguration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.QasmBackendConfiguration -`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/qiskit.providers.models.UchannelLO.md index 31428649f9..b84f60891d 100644 --- a/docs/api/qiskit/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/qiskit.providers.models.UchannelLO.md @@ -10,7 +10,7 @@ python_api_name: qiskit.providers.models.UchannelLO -`qiskit.providers.models.UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/providers/models/backendconfiguration.py "view source code") +`qiskit.providers.models.UchannelLO(q, scale)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.md index 123d06b7f4..1c6b8f5817 100644 --- a/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/qiskit.pulse.InstructionScheduleMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.InstructionScheduleMap -`qiskit.pulse.InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instruction_schedule_map.py "view source code") +`qiskit.pulse.InstructionScheduleMap` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.Schedule.md b/docs/api/qiskit/qiskit.pulse.Schedule.md index d4faac75e7..8d41baea2b 100644 --- a/docs/api/qiskit/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/qiskit.pulse.Schedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.Schedule -`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.Schedule(*schedules, name=None, metadata=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/qiskit.pulse.ScheduleBlock.md index 4e1c191335..d39e892b13 100644 --- a/docs/api/qiskit/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/qiskit.pulse.ScheduleBlock.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.ScheduleBlock -`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/schedule.py "view source code") +`qiskit.pulse.ScheduleBlock(name=None, metadata=None, alignment_context=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/qiskit.pulse.channels.AcquireChannel.md index 294e84a36a..8319ce2706 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/qiskit.pulse.channels.AcquireChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.AcquireChannel -`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.AcquireChannel(*args, **kwargs)` Bases: [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/qiskit.pulse.channels.ControlChannel.md index 8d95ea0e19..8a79239c1a 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/qiskit.pulse.channels.ControlChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.ControlChannel -`qiskit.pulse.channels.ControlChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.ControlChannel(*args, **kwargs)` Bases: `PulseChannel` diff --git a/docs/api/qiskit/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/qiskit.pulse.channels.DriveChannel.md index 920937fe3b..e002c40e45 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/qiskit.pulse.channels.DriveChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.DriveChannel -`qiskit.pulse.channels.DriveChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.DriveChannel(*args, **kwargs)` Bases: `PulseChannel` diff --git a/docs/api/qiskit/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/qiskit.pulse.channels.MeasureChannel.md index 8eb4bb86b7..493704ec5a 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/qiskit.pulse.channels.MeasureChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MeasureChannel -`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MeasureChannel(*args, **kwargs)` Bases: `PulseChannel` diff --git a/docs/api/qiskit/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/qiskit.pulse.channels.MemorySlot.md index c1d32365da..04add67864 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/qiskit.pulse.channels.MemorySlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.MemorySlot -`qiskit.pulse.channels.MemorySlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.MemorySlot(*args, **kwargs)` Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/qiskit.pulse.channels.RegisterSlot.md index 5da418c9ec..0a2ce5b8d8 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/qiskit.pulse.channels.RegisterSlot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.RegisterSlot -`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.RegisterSlot(*args, **kwargs)` Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/qiskit.pulse.channels.SnapshotChannel.md index 86a15e41b6..1ad1ca8969 100644 --- a/docs/api/qiskit/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/qiskit.pulse.channels.SnapshotChannel.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.channels.SnapshotChannel -`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/channels.py "view source code") +`qiskit.pulse.channels.SnapshotChannel(*args, **kwargs)` Bases: `ClassicalIOChannel` diff --git a/docs/api/qiskit/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/qiskit.pulse.instructions.Acquire.md index 91d2280894..3f87b20f4c 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.Acquire.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Acquire -`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/acquire.py "view source code") +`qiskit.pulse.instructions.Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/qiskit.pulse.instructions.Call.md index ddd7662da3..81368d9522 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.Call.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Call -`qiskit.pulse.instructions.Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/call.py "view source code") +`qiskit.pulse.instructions.Call(subroutine, value_dict=None, name=None)` Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/qiskit.pulse.instructions.Delay.md index 0be196930b..c4d927dbe2 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.Delay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Delay -`qiskit.pulse.instructions.Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/delay.py "view source code") +`qiskit.pulse.instructions.Delay(duration, channel, name=None)` Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/qiskit.pulse.instructions.Play.md index 9f4d9865aa..77907b1f96 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.Play.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Play -`qiskit.pulse.instructions.Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/play.py "view source code") +`qiskit.pulse.instructions.Play(pulse, channel, name=None)` Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/qiskit.pulse.instructions.Reference.md index 8d9fa4035f..a674333cfa 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.Reference.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Reference -`qiskit.pulse.instructions.Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/reference.py "view source code") +`qiskit.pulse.instructions.Reference(name, *extra_keys)` Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.RelativeBarrier.md b/docs/api/qiskit/qiskit.pulse.instructions.RelativeBarrier.md index 800675d2a0..a5ef783420 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.RelativeBarrier.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.RelativeBarrier.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.RelativeBarrier -`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.RelativeBarrier(*channels, name=None)` Bases: `Directive` diff --git a/docs/api/qiskit/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/qiskit.pulse.instructions.SetFrequency.md index 9205a3c959..906279ab29 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.SetFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetFrequency -`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.SetFrequency(frequency, channel, name=None)` Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -18,8 +18,6 @@ Set the channel frequency. This instruction operates on `PulseChannel` s. A `Pul $$ Re[\exp(i 2\pi f jdt + \phi) d_j]. - - $$ Here, $f$ is the frequency of the channel. The instruction `SetFrequency` allows the user to set the value of $f$. All pulses that are played on a channel after SetFrequency has been called will have the corresponding frequency. diff --git a/docs/api/qiskit/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/qiskit.pulse.instructions.SetPhase.md index f9a84acf06..3ceda396f3 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.SetPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.SetPhase -`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.SetPhase(phase, channel, name=None)` Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/qiskit.pulse.instructions.ShiftFrequency.md index a3ceeb93f9..366c3b9dfa 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.ShiftFrequency.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftFrequency -`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/frequency.py "view source code") +`qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)` Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/qiskit.pulse.instructions.ShiftPhase.md index d13dbb2a8f..6a6f1513d2 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.ShiftPhase.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.ShiftPhase -`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/phase.py "view source code") +`qiskit.pulse.instructions.ShiftPhase(phase, channel, name=None)` Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -20,8 +20,6 @@ In particular, a PulseChannel creates pulses of the form $$ Re[\exp(i 2\pi f jdt + \phi) d_j]. - - $$ The `ShiftPhase` instruction causes $\phi$ to be increased by the instruction’s `phase` operand. This will affect all pulses following on the same channel. diff --git a/docs/api/qiskit/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/qiskit.pulse.instructions.Snapshot.md index 6beb5f574c..202cbd5541 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.Snapshot.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.Snapshot -`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/snapshot.py "view source code") +`qiskit.pulse.instructions.Snapshot(label, snapshot_type='statevector', name=None)` Bases: [`Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/qiskit.pulse.instructions.TimeBlockade.md b/docs/api/qiskit/qiskit.pulse.instructions.TimeBlockade.md index d2bccabc9b..93bf3478f7 100644 --- a/docs/api/qiskit/qiskit.pulse.instructions.TimeBlockade.md +++ b/docs/api/qiskit/qiskit.pulse.instructions.TimeBlockade.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.instructions.TimeBlockade -`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/instructions/directives.py "view source code") +`qiskit.pulse.instructions.TimeBlockade(duration, channel, name=None)` Bases: `Directive` diff --git a/docs/api/qiskit/qiskit.pulse.library.Constant_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Constant_class.rst.md index ba664f2bfb..a6e4a1f285 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Constant_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Constant_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Constant -`qiskit.pulse.library.Constant(duration, amp, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Constant(duration, amp, angle=None, name=None, limit_amplitude=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.pulse.library.Cos_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Cos_class.rst.md index 393f33676b..bddaf41a23 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Cos_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Cos_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Cos -`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Cos(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` A cosine pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.Drag_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Drag_class.rst.md index 8ceb238d69..19dd489d38 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Drag_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Drag_class.rst.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Drag -`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Drag(duration, amp, sigma, beta, angle=None, name=None, limit_amplitude=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") @@ -19,10 +19,10 @@ The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pul It can be calibrated either to reduce the phase error due to virtual population of the $|2\rangle$ state during the pulse or to reduce the frequency spectrum of a standard Gaussian pulse near the $|1\rangle\leftrightarrow|2\rangle$ transition, reducing the chance of leakage to the $|2\rangle$ state. $$ -g(x) &= \exp\Bigl(-\frac12 \frac{(x - \text{duration}/2)^2}{\text{sigma}^2}\Bigr)\\ +\begin{split}g(x) &= \exp\Bigl(-\frac12 \frac{(x - \text{duration}/2)^2}{\text{sigma}^2}\Bigr)\\ g'(x) &= \text{A}\times\frac{g(x)-g(-1)}{1-g(-1)}\\ f(x) &= g'(x) \times \Bigl(1 + 1j \times \text{beta} \times \Bigl(-\frac{x - \text{duration}/2}{\text{sigma}^2}\Bigr) \Bigr), - \quad 0 \le x < \text{duration} + \quad 0 \le x < \text{duration}\end{split} $$ where $g(x)$ is a standard unlifted Gaussian waveform, $g'(x)$ is the lifted [`Gaussian`](qiskit.pulse.library.Gaussian_class.rst#qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian") waveform, and $\text{A} = \text{amp} \times \exp\left(i\times\text{angle}\right)$. diff --git a/docs/api/qiskit/qiskit.pulse.library.GaussianDeriv.md b/docs/api/qiskit/qiskit.pulse.library.GaussianDeriv.md index aebc1f81da..e7fcf08fec 100644 --- a/docs/api/qiskit/qiskit.pulse.library.GaussianDeriv.md +++ b/docs/api/qiskit/qiskit.pulse.library.GaussianDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianDeriv -`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` An unnormalized Gaussian derivative pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/qiskit.pulse.library.GaussianSquare.md index 621530913c..22f3f87155 100644 --- a/docs/api/qiskit/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/qiskit.pulse.library.GaussianSquare.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.GaussianSquare -`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquare(duration, amp, sigma, width=None, angle=None, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") @@ -21,25 +21,23 @@ Exactly one of the `risefall_sigma_ratio` and `width` parameters has to be speci If `risefall_sigma_ratio` is not None and `width` is None: $$ -\text{risefall} &= \text{risefall_sigma_ratio} \times \text{sigma}\\ -\text{width} &= \text{duration} - 2 \times \text{risefall} +\begin{split}\text{risefall} &= \text{risefall_sigma_ratio} \times \text{sigma}\\ +\text{width} &= \text{duration} - 2 \times \text{risefall}\end{split} $$ If `width` is not None and `risefall_sigma_ratio` is None: $$ \text{risefall} = \frac{\text{duration} - \text{width}}{2} - - $$ In both cases, the lifted gaussian square pulse $f'(x)$ is defined as: $$ -f'(x) &= \begin{cases} \exp\biggl(-\frac12 \frac{(x - \text{risefall})^2}{\text{sigma}^2}\biggr) & x < \text{risefall}\\ +\begin{split}f'(x) &= \begin{cases} \exp\biggl(-\frac12 \frac{(x - \text{risefall})^2}{\text{sigma}^2}\biggr) & x < \text{risefall}\\ 1 & \text{risefall} \le x < \text{risefall} + \text{width}\\ \exp\biggl(-\frac12 \frac{{\bigl(x - (\text{risefall} + \text{width})\bigr)}^2} {\text{sigma}^2} \biggr) & \text{risefall} + \text{width} \le x \end{cases}\\ -f(x) &= \text{A} \times \frac{f'(x) - f'(-1)}{1-f'(-1)}, \quad 0 \le x < \text{duration} +f(x) &= \text{A} \times \frac{f'(x) - f'(-1)}{1-f'(-1)}, \quad 0 \le x < \text{duration}\end{split} $$ where $f'(x)$ is the gaussian square waveform without lifting or amplitude scaling, and $\text{A} = \text{amp} \times \exp\left(i\times\text{angle}\right)$. diff --git a/docs/api/qiskit/qiskit.pulse.library.GaussianSquareDrag.md b/docs/api/qiskit/qiskit.pulse.library.GaussianSquareDrag.md index fe5d584e2d..7203dd37df 100644 --- a/docs/api/qiskit/qiskit.pulse.library.GaussianSquareDrag.md +++ b/docs/api/qiskit/qiskit.pulse.library.GaussianSquareDrag.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.GaussianSquareDrag -`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` A square pulse with a Drag shaped rise and fall @@ -23,23 +23,21 @@ Exactly one of the `risefall_sigma_ratio` and `width` parameters has to be speci If `risefall_sigma_ratio` is not `None` and `width` is `None`: $$ -\text{risefall} &= \text{risefall_sigma_ratio} \times \text{sigma}\\ -\text{width} &= \text{duration} - 2 \times \text{risefall} +\begin{split}\text{risefall} &= \text{risefall_sigma_ratio} \times \text{sigma}\\ +\text{width} &= \text{duration} - 2 \times \text{risefall}\end{split} $$ If `width` is not None and `risefall_sigma_ratio` is None: $$ \text{risefall} = \frac{\text{duration} - \text{width}}{2} - - $$ Gaussian $g(x, c, σ)$ and lifted gaussian $g'(x, c, σ)$ curves can be written as: $$ -g(x, c, σ) &= \exp\Bigl(-\frac12 \frac{(x - c)^2}{σ^2}\Bigr)\\ -g'(x, c, σ) &= \frac{g(x, c, σ)-g(-1, c, σ)}{1-g(-1, c, σ)} +\begin{split}g(x, c, σ) &= \exp\Bigl(-\frac12 \frac{(x - c)^2}{σ^2}\Bigr)\\ +g'(x, c, σ) &= \frac{g(x, c, σ)-g(-1, c, σ)}{1-g(-1, c, σ)}\end{split} $$ From these, the lifted DRAG curve $d'(x, c, σ, β)$ can be written as @@ -51,9 +49,9 @@ $$ The lifted gaussian square drag pulse $f'(x)$ is defined as: $$ -f'(x) &= \begin{cases} \text{A} \times d'(x, \text{risefall}, \text{sigma}, \text{beta}) & x < \text{risefall}\\ +\begin{split}f'(x) &= \begin{cases} \text{A} \times d'(x, \text{risefall}, \text{sigma}, \text{beta}) & x < \text{risefall}\\ \text{A} & \text{risefall} \le x < \text{risefall} + \text{width}\\ - \text{A} \times \times d'( x - (\text{risefall} + \text{width}), \text{risefall}, \text{sigma}, \text{beta} ) & \text{risefall} + \text{width} \le x \end{cases}\\ + \text{A} \times \times d'( x - (\text{risefall} + \text{width}), \text{risefall}, \text{sigma}, \text{beta} ) & \text{risefall} + \text{width} \le x \end{cases}\\\end{split} $$ where $\text{A} = \text{amp} \times \exp\left(i\times\text{angle}\right)$. diff --git a/docs/api/qiskit/qiskit.pulse.library.Gaussian_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Gaussian_class.rst.md index 9b52894a10..63072202d9 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Gaussian_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Gaussian_class.rst.md @@ -10,15 +10,15 @@ python_api_name: qiskit.pulse.library.Gaussian -`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Gaussian(duration, amp, sigma, angle=None, name=None, limit_amplitude=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") A lifted and truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): $$ -f'(x) &= \exp\Bigl( -\frac12 \frac{{(x - \text{duration}/2)}^2}{\text{sigma}^2} \Bigr)\\ -f(x) &= \text{A} \times \frac{f'(x) - f'(-1)}{1-f'(-1)}, \quad 0 \le x < \text{duration} +\begin{split}f'(x) &= \exp\Bigl( -\frac12 \frac{{(x - \text{duration}/2)}^2}{\text{sigma}^2} \Bigr)\\ +f(x) &= \text{A} \times \frac{f'(x) - f'(-1)}{1-f'(-1)}, \quad 0 \le x < \text{duration}\end{split} $$ where $f'(x)$ is the gaussian waveform without lifting or amplitude scaling, and $\text{A} = \text{amp} \times \exp\left(i\times\text{angle}\right)$. diff --git a/docs/api/qiskit/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/qiskit.pulse.library.ParametricPulse.md index 4eed5de5d6..192c9b7251 100644 --- a/docs/api/qiskit/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/qiskit.pulse.library.ParametricPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.ParametricPulse -`qiskit.pulse.library.ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/parametric_pulses.py "view source code") +`qiskit.pulse.library.ParametricPulse(duration, name=None, limit_amplitude=None)` Bases: `Pulse` diff --git a/docs/api/qiskit/qiskit.pulse.library.Sawtooth_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Sawtooth_class.rst.md index 9a0288b769..22fde23cec 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Sawtooth_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Sawtooth_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sawtooth -`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sawtooth(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` A sawtooth pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.SechDeriv.md b/docs/api/qiskit/qiskit.pulse.library.SechDeriv.md index d96ffc46e4..bfe1f36e1c 100644 --- a/docs/api/qiskit/qiskit.pulse.library.SechDeriv.md +++ b/docs/api/qiskit/qiskit.pulse.library.SechDeriv.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.SechDeriv -`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SechDeriv(duration, amp, sigma, angle=0.0, name=None, limit_amplitude=None)` An unnormalized sech derivative pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.Sech_fun.rst.md b/docs/api/qiskit/qiskit.pulse.library.Sech_fun.rst.md index 318eff0d6a..ad3bfb2bdd 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Sech_fun.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Sech_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sech -`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sech(duration, amp, sigma, angle=0.0, name=None, zero_ends=True, limit_amplitude=None)` An unnormalized sech pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.Sin_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Sin_class.rst.md index a51aede9f4..1f1cfc5ec1 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Sin_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Sin_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Sin -`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` A sinusoidal pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.Square_fun.rst.md b/docs/api/qiskit/qiskit.pulse.library.Square_fun.rst.md index deda09d6cb..bc79e9532f 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Square_fun.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Square_fun.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Square -`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Square(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` A square wave pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.md index 857d677910..f0eca157ab 100644 --- a/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/qiskit.pulse.library.SymbolicPulse.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.SymbolicPulse -`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` Bases: `Pulse` diff --git a/docs/api/qiskit/qiskit.pulse.library.Triangle_class.rst.md b/docs/api/qiskit/qiskit.pulse.library.Triangle_class.rst.md index 0f9ec9e423..b121e99305 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Triangle_class.rst.md +++ b/docs/api/qiskit/qiskit.pulse.library.Triangle_class.rst.md @@ -12,7 +12,7 @@ python_api_name: qiskit.pulse.library.Triangle -`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.Triangle(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)` A triangle wave pulse. diff --git a/docs/api/qiskit/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/qiskit.pulse.library.Waveform.md index 2fe1f492cb..8d393aa5b2 100644 --- a/docs/api/qiskit/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/qiskit.pulse.library.Waveform.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.library.Waveform -`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/waveform.py "view source code") +`qiskit.pulse.library.Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` Bases: `Pulse` diff --git a/docs/api/qiskit/qiskit.pulse.library.gaussian_square_echo.md b/docs/api/qiskit/qiskit.pulse.library.gaussian_square_echo.md index 794f569faf..b0e421c2ce 100644 --- a/docs/api/qiskit/qiskit.pulse.library.gaussian_square_echo.md +++ b/docs/api/qiskit/qiskit.pulse.library.gaussian_square_echo.md @@ -12,15 +12,15 @@ python_api_name: qiskit.pulse.library.gaussian_square_echo -`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/library/symbolic_pulses.py "view source code") +`qiskit.pulse.library.gaussian_square_echo(duration, amp, sigma, width=None, angle=0.0, active_amp=0.0, active_angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` An echoed Gaussian square pulse with an active tone overlaid on it. The Gaussian Square Echo pulse is composed of three pulses. First, a Gaussian Square pulse $f_{echo}(x)$ with amplitude `amp` and phase `angle` playing for half duration, followed by a second Gaussian Square pulse $-f_{echo}(x)$ with opposite amplitude and same phase playing for the rest of the duration. Third a Gaussian Square pulse $f_{active}(x)$ with amplitude `active_amp` and phase `active_angle` playing for the entire duration. The Gaussian Square Echo pulse $g_e()$ can be written as: $$ -g_e(x) &= \begin{cases} f_{\text{active}} + f_{\text{echo}}(x) & x < \frac{\text{duration}}{2}\\ - f_{\text{active}} - f_{\text{echo}}(x) & \frac{\text{duration}}{2} < x \end{cases}\\ +\begin{split}g_e(x) &= \begin{cases} f_{\text{active}} + f_{\text{echo}}(x) & x < \frac{\text{duration}}{2}\\ + f_{\text{active}} - f_{\text{echo}}(x) & \frac{\text{duration}}{2} < x \end{cases}\\\end{split} $$ One case where this pulse can be used is when implementing a direct CNOT gate with a cross-resonance superconducting qubit architecture. When applying this pulse to the target qubit, the active portion can be used to cancel IX terms from the cross-resonance drive while the echo portion can reduce the impact of a static ZZ coupling. @@ -30,16 +30,14 @@ Exactly one of the `risefall_sigma_ratio` and `width` parameters has to be speci If `risefall_sigma_ratio` is not `None` and `width` is `None`: $$ -\text{risefall} &= \text{risefall_sigma_ratio} \times \text{sigma}\\ -\text{width} &= \text{duration} - 2 \times \text{risefall} +\begin{split}\text{risefall} &= \text{risefall_sigma_ratio} \times \text{sigma}\\ +\text{width} &= \text{duration} - 2 \times \text{risefall}\end{split} $$ If `width` is not None and `risefall_sigma_ratio` is None: $$ \text{risefall} = \frac{\text{duration} - \text{width}}{2} - - $$ ## References diff --git a/docs/api/qiskit/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/qiskit.pulse.transforms.AlignEquispaced.md index 8d0f30b3fd..491f0aef9c 100644 --- a/docs/api/qiskit/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/qiskit.pulse.transforms.AlignEquispaced.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignEquispaced -`qiskit.pulse.transforms.AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignEquispaced(duration)` Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/qiskit.pulse.transforms.AlignFunc.md index e3d7acfd75..bec8671c3c 100644 --- a/docs/api/qiskit/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/qiskit.pulse.transforms.AlignFunc.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignFunc -`qiskit.pulse.transforms.AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignFunc(duration, func)` Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/qiskit.pulse.transforms.AlignLeft.md index edf9dff570..a6e3988902 100644 --- a/docs/api/qiskit/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/qiskit.pulse.transforms.AlignLeft.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignLeft -`qiskit.pulse.transforms.AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignLeft` Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/qiskit.pulse.transforms.AlignRight.md index dc8344d1e4..7a782c2929 100644 --- a/docs/api/qiskit/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/qiskit.pulse.transforms.AlignRight.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignRight -`qiskit.pulse.transforms.AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignRight` Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/qiskit.pulse.transforms.AlignSequential.md index d52a096918..3dd18a05b0 100644 --- a/docs/api/qiskit/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/qiskit.pulse.transforms.AlignSequential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.pulse.transforms.AlignSequential -`qiskit.pulse.transforms.AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/pulse/transforms/alignments.py "view source code") +`qiskit.pulse.transforms.AlignSequential` Bases: [`AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") diff --git a/docs/api/qiskit/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/qiskit.qobj.GateCalibration.md index e7de138644..428c69c7b1 100644 --- a/docs/api/qiskit/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/qiskit.qobj.GateCalibration.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.GateCalibration -`qiskit.qobj.GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.GateCalibration(name, qubits, params, instructions)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/qiskit.qobj.PulseLibraryItem.md index f47d1dc890..d822b86abd 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/qiskit.qobj.PulseLibraryItem.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseLibraryItem -`qiskit.qobj.PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseLibraryItem(name, samples)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/qiskit.qobj.PulseQobj.md index d7764420ba..eef96647aa 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/qiskit.qobj.PulseQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobj -`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobj(qobj_id, config, experiments, header=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/qiskit.qobj.PulseQobjConfig.md index 904a326e2e..4455717336 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/qiskit.qobj.PulseQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjConfig -`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, seed_simulator=None, memory_slots=None, **kwargs)` Bases: `QobjDictField` diff --git a/docs/api/qiskit/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/qiskit.qobj.PulseQobjExperiment.md index ca9aec4c7d..ee60aab148 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/qiskit.qobj.PulseQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperiment -`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperiment(instructions, config=None, header=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/qiskit.qobj.PulseQobjExperimentConfig.md index ae70efeff8..08ead83601 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/qiskit.qobj.PulseQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjExperimentConfig -`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` Bases: `QobjDictField` diff --git a/docs/api/qiskit/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/qiskit.qobj.PulseQobjInstruction.md index 57f5223e5a..42490b33ab 100644 --- a/docs/api/qiskit/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/qiskit.qobj.PulseQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.PulseQobjInstruction -`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/qiskit.qobj.QasmExperimentCalibrations.md index 5962f3cacb..baba012555 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/qiskit.qobj.QasmExperimentCalibrations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmExperimentCalibrations -`qiskit.qobj.QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmExperimentCalibrations(gates)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/qiskit.qobj.QasmQobj.md index 0292444098..76887fb7fc 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/qiskit.qobj.QasmQobj.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobj -`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/qiskit.qobj.QasmQobjConfig.md index e9d7606215..2ce17e286d 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/qiskit.qobj.QasmQobjConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjConfig -`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` Bases: [`SimpleNamespace`](https://docs.python.org/3/library/types.html#types.SimpleNamespace "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/qiskit.qobj.QasmQobjExperiment.md index fa16a4fb30..349de3fd06 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/qiskit.qobj.QasmQobjExperiment.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperiment -`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperiment(config=None, header=None, instructions=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/qiskit.qobj.QasmQobjExperimentConfig.md index 4479d4a19a..87daa997f4 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/qiskit.qobj.QasmQobjExperimentConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjExperimentConfig -`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` Bases: `QobjDictField` diff --git a/docs/api/qiskit/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/qiskit.qobj.QasmQobjInstruction.md index 53ee432742..d4f396068a 100644 --- a/docs/api/qiskit/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/qiskit.qobj.QasmQobjInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QasmQobjInstruction -`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/qasm_qobj.py "view source code") +`qiskit.qobj.QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/qiskit.qobj.QobjExperimentHeader.md index c6171989fc..7f01bba0de 100644 --- a/docs/api/qiskit/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/qiskit.qobj.QobjExperimentHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjExperimentHeader -`qiskit.qobj.QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjExperimentHeader(**kwargs)` Bases: [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/qiskit.qobj.QobjHeader.md index e239fdf183..8981d85cf6 100644 --- a/docs/api/qiskit/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/qiskit.qobj.QobjHeader.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjHeader -`qiskit.qobj.QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/common.py "view source code") +`qiskit.qobj.QobjHeader(**kwargs)` Bases: `QobjDictField` diff --git a/docs/api/qiskit/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/qiskit.qobj.QobjMeasurementOption.md index a0a8811031..d0e6231e46 100644 --- a/docs/api/qiskit/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/qiskit.qobj.QobjMeasurementOption.md @@ -10,7 +10,7 @@ python_api_name: qiskit.qobj.QobjMeasurementOption -`qiskit.qobj.QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qobj/pulse_qobj.py "view source code") +`qiskit.qobj.QobjMeasurementOption(name, params=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.md index ed14d04adc..b81dc8a1b5 100644 --- a/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/qiskit.quantum_info.CNOTDihedral.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.CNOTDihedral -`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") +`qiskit.quantum_info.CNOTDihedral(data=None, num_qubits=None, validate=True)` Bases: `BaseOperator`, `AdjointMixin` diff --git a/docs/api/qiskit/qiskit.quantum_info.Chi.md b/docs/api/qiskit/qiskit.quantum_info.Chi.md index 3ac3b80e39..41c1d43c3d 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/qiskit.quantum_info.Chi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Chi -`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/chi.py "view source code") +`qiskit.quantum_info.Chi(data, input_dims=None, output_dims=None)` Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.Choi.md b/docs/api/qiskit/qiskit.quantum_info.Choi.md index 12d7bcafef..1850fbf8f5 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/qiskit.quantum_info.Choi.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Choi -`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/choi.py "view source code") +`qiskit.quantum_info.Choi(data, input_dims=None, output_dims=None)` Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/qiskit.quantum_info.Clifford.md index 237643452b..0370547b57 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/qiskit.quantum_info.Clifford.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Clifford -`qiskit.quantum_info.Clifford(data, validate=True, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") +`qiskit.quantum_info.Clifford(data, validate=True, copy=True)` Bases: `BaseOperator`, `AdjointMixin`, [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") diff --git a/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.md index 892da03ebb..6370ab0399 100644 --- a/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/qiskit.quantum_info.DensityMatrix.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.DensityMatrix -`qiskit.quantum_info.DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/densitymatrix.py "view source code") +`qiskit.quantum_info.DensityMatrix(data, dims=None)` Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/qiskit.quantum_info.Kraus.md index 6efb1f5fdc..03823f9f3b 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/qiskit.quantum_info.Kraus.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Kraus -`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/kraus.py "view source code") +`qiskit.quantum_info.Kraus(data, input_dims=None, output_dims=None)` Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/qiskit.quantum_info.OneQubitEulerDecomposer.md index 822a936e21..cf35902eb7 100644 --- a/docs/api/qiskit/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer -`qiskit.quantum_info.OneQubitEulerDecomposer(basis='U3', use_dag=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") +`qiskit.quantum_info.OneQubitEulerDecomposer(basis='U3', use_dag=False)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.quantum_info.Operator.md b/docs/api/qiskit/qiskit.quantum_info.Operator.md index 88ca8e4204..028c08404f 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/qiskit.quantum_info.Operator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Operator -`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/operator.py "view source code") +`qiskit.quantum_info.Operator(data, input_dims=None, output_dims=None)` Bases: `LinearOp` diff --git a/docs/api/qiskit/qiskit.quantum_info.PTM.md b/docs/api/qiskit/qiskit.quantum_info.PTM.md index 10b200b8c4..75fcc2ca5f 100644 --- a/docs/api/qiskit/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/qiskit.quantum_info.PTM.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PTM -`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/ptm.py "view source code") +`qiskit.quantum_info.PTM(data, input_dims=None, output_dims=None)` Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/qiskit.quantum_info.Pauli.md index c551aaa2cc..d8ada13976 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/qiskit.quantum_info.Pauli.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Pauli -`qiskit.quantum_info.Pauli(data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") +`qiskit.quantum_info.Pauli(data=None)` Bases: `BasePauli` @@ -25,10 +25,10 @@ $$ where $q\in \mathbb{Z}_4$ and $P_i \in \{I, X, Y, Z\}$ are single-qubit Pauli matrices: $$ -I = \begin{pmatrix} 1 & 0 \\ 0 & 1 \end{pmatrix}, +\begin{split}I = \begin{pmatrix} 1 & 0 \\ 0 & 1 \end{pmatrix}, X = \begin{pmatrix} 0 & 1 \\ 1 & 0 \end{pmatrix}, Y = \begin{pmatrix} 0 & -i \\ i & 0 \end{pmatrix}, -Z = \begin{pmatrix} 1 & 0 \\ 0 & -1 \end{pmatrix}. +Z = \begin{pmatrix} 1 & 0 \\ 0 & -1 \end{pmatrix}.\end{split} $$ **Initialization** @@ -51,7 +51,7 @@ A Pauli object can be initialized in several ways: An $n$-qubit Pauli may be represented by a string consisting of $n$ characters from `['I', 'X', 'Y', 'Z']`, and optionally phase coefficient in $['', '-i', '-', 'i']$. For example: `XYZ` or `'-iZIZ'`. -In the string representation qubit-0 corresponds to the right-most Pauli character, and qubit-$(n-1)$ to the left-most Pauli character. For example `'XYZ'` represents $X\otimes Y \otimes Z$ with `'Z'` on qubit-0, `'Y'` on qubit-1, and `'X'` on qubit-2. +In the string representation qubit-0 corresponds to the right-most Pauli character, and qubit-$(n-1)$ to the left-most Pauli character. For example `'XYZ'` represents $X\otimes Y \otimes Z$ with `'Z'` on qubit-0, `'Y'` on qubit-1, and `'X'` on qubit-3. The string representation can be converted to a `Pauli` using the class initialization (`Pauli('-iXYZ')`). A `Pauli` object can be converted back to the string representation using the [`to_label()`](#qiskit.quantum_info.Pauli.to_label "qiskit.quantum_info.Pauli.to_label") method or `str(pauli)`. @@ -67,11 +67,11 @@ $$ P = (-i)^{q + z\cdot x} Z^z \cdot X^x. $$ -The $k$-th qubit corresponds to the $k$-th entry in the $z$ and $x$ arrays +The $k`th qubit corresponds to the :math:`k`th entry in the :math:`z$ and $x$ arrays $$ -P &= P_{n-1} \otimes ... \otimes P_{0} \\ -P_k &= (-i)^{z[k] * x[k]} Z^{z[k]}\cdot X^{x[k]} +\begin{split}P &= P_{n-1} \otimes ... \otimes P_{0} \\ +P_k &= (-i)^{z[k] * x[k]} Z^{z[k]}\cdot X^{x[k]}\end{split} $$ where `z[k] = P.z[k]`, `x[k] = P.x[k]` respectively. diff --git a/docs/api/qiskit/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/qiskit.quantum_info.PauliList.md index 963d5440eb..940e2bf1e0 100644 --- a/docs/api/qiskit/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/qiskit.quantum_info.PauliList.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.PauliList -`qiskit.quantum_info.PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") +`qiskit.quantum_info.PauliList(data)` Bases: `BasePauli`, `LinearMixin`, `GroupMixin` diff --git a/docs/api/qiskit/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/qiskit.quantum_info.Quaternion.md index 840477e816..7020f8b4bd 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/qiskit.quantum_info.Quaternion.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Quaternion -`qiskit.quantum_info.Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/quaternion.py "view source code") +`qiskit.quantum_info.Quaternion(data)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/qiskit.quantum_info.ScalarOp.md index c57a2a2e95..098b506d26 100644 --- a/docs/api/qiskit/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/qiskit.quantum_info.ScalarOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.ScalarOp -`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/scalar_op.py "view source code") +`qiskit.quantum_info.ScalarOp(dims=None, coeff=1)` Bases: `LinearOp` diff --git a/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.md index dcfb8abfec..befb6c1e40 100644 --- a/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/qiskit.quantum_info.SparsePauliOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SparsePauliOp -`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") +`qiskit.quantum_info.SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` Bases: `LinearOp` diff --git a/docs/api/qiskit/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/qiskit.quantum_info.StabilizerState.md index 4e99caaf35..3dc4e6471c 100644 --- a/docs/api/qiskit/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/qiskit.quantum_info.StabilizerState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.StabilizerState -`qiskit.quantum_info.StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/stabilizerstate.py "view source code") +`qiskit.quantum_info.StabilizerState(data, validate=True)` Bases: `QuantumState` diff --git a/docs/api/qiskit/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/qiskit.quantum_info.Statevector.md index c7bfbaed81..4693fceeac 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/qiskit.quantum_info.Statevector.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Statevector -`qiskit.quantum_info.Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/statevector.py "view source code") +`qiskit.quantum_info.Statevector(data, dims=None)` Bases: `QuantumState`, `TolerancesMixin` diff --git a/docs/api/qiskit/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/qiskit.quantum_info.Stinespring.md index 2a3b372d9e..4c0c985260 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/qiskit.quantum_info.Stinespring.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Stinespring -`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/stinespring.py "view source code") +`qiskit.quantum_info.Stinespring(data, input_dims=None, output_dims=None)` Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/qiskit.quantum_info.SuperOp.md index dddd03b16c..4fb80fffe3 100644 --- a/docs/api/qiskit/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/qiskit.quantum_info.SuperOp.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.SuperOp -`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/channel/superop.py "view source code") +`qiskit.quantum_info.SuperOp(data, input_dims=None, output_dims=None)` Bases: `QuantumChannel` diff --git a/docs/api/qiskit/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/qiskit.quantum_info.TwoQubitBasisDecomposer.md index 1055f35b98..5a0ee2d034 100644 --- a/docs/api/qiskit/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer -`qiskit.quantum_info.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") +`qiskit.quantum_info.TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis='U', pulse_optimize=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/qiskit.quantum_info.XXDecomposer.md index ca50078df1..af643082cf 100644 --- a/docs/api/qiskit/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/qiskit.quantum_info.XXDecomposer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.XXDecomposer -`qiskit.quantum_info.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") +`qiskit.quantum_info.XXDecomposer(basis_fidelity=1.0, euler_basis='U', embodiments=None, backup_optimizer=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.md b/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.md index 818f357954..7901da18f6 100644 --- a/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.md +++ b/docs/api/qiskit/qiskit.quantum_info.Z2Symmetries.md @@ -10,7 +10,7 @@ python_api_name: qiskit.quantum_info.Z2Symmetries -`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/analysis/z2_symmetries.py "view source code") +`qiskit.quantum_info.Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, *, tol=1e-14)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/qiskit.quantum_info.pauli_basis.md index 37e4b061a6..cfcf6e5301 100644 --- a/docs/api/qiskit/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/qiskit.quantum_info.pauli_basis.md @@ -12,7 +12,7 @@ python_api_name: qiskit.quantum_info.pauli_basis -`qiskit.quantum_info.pauli_basis(num_qubits, weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") +`qiskit.quantum_info.pauli_basis(num_qubits, weight=False)` Return the ordered PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/qiskit.result.BaseReadoutMitigator.md index d4181a2fb6..ea32bad76e 100644 --- a/docs/api/qiskit/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/qiskit.result.BaseReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.BaseReadoutMitigator -`qiskit.result.BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/mitigation/base_readout_mitigator.py "view source code") +`qiskit.result.BaseReadoutMitigator` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/qiskit.result.CorrelatedReadoutMitigator.md index a901c387e7..8ff61178ee 100644 --- a/docs/api/qiskit/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/qiskit.result.CorrelatedReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.CorrelatedReadoutMitigator -`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") +`qiskit.result.CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/qiskit.result.Counts.md b/docs/api/qiskit/qiskit.result.Counts.md index cbee1e5b79..0650a7d24c 100644 --- a/docs/api/qiskit/qiskit.result.Counts.md +++ b/docs/api/qiskit/qiskit.result.Counts.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Counts -`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/counts.py "view source code") +`qiskit.result.Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/qiskit.result.LocalReadoutMitigator.md index 6f302ac6b6..7ad2a4e530 100644 --- a/docs/api/qiskit/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/qiskit.result.LocalReadoutMitigator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.LocalReadoutMitigator -`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/mitigation/local_readout_mitigator.py "view source code") +`qiskit.result.LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` Bases: [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") diff --git a/docs/api/qiskit/qiskit.result.ProbDistribution.md b/docs/api/qiskit/qiskit.result.ProbDistribution.md index 929acfe462..0dec87d2e7 100644 --- a/docs/api/qiskit/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/qiskit.result.ProbDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.ProbDistribution -`qiskit.result.ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/distributions/probability.py "view source code") +`qiskit.result.ProbDistribution(data, shots=None)` Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/qiskit.result.QuasiDistribution.md index 82f33fce58..3550531e43 100644 --- a/docs/api/qiskit/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/qiskit.result.QuasiDistribution.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.QuasiDistribution -`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/distributions/quasi.py "view source code") +`qiskit.result.QuasiDistribution(data, shots=None, stddev_upper_bound=None)` Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.result.Result.md b/docs/api/qiskit/qiskit.result.Result.md index 645faf8b61..8ca2d0f4e2 100644 --- a/docs/api/qiskit/qiskit.result.Result.md +++ b/docs/api/qiskit/qiskit.result.Result.md @@ -10,7 +10,7 @@ python_api_name: qiskit.result.Result -`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/result.py "view source code") +`qiskit.result.Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.result.ResultError.md b/docs/api/qiskit/qiskit.result.ResultError.md index 8b3c6acd33..2ecca733b8 100644 --- a/docs/api/qiskit/qiskit.result.ResultError.md +++ b/docs/api/qiskit/qiskit.result.ResultError.md @@ -12,7 +12,7 @@ python_api_name: qiskit.result.ResultError -`qiskit.result.ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/exceptions.py "view source code") +`qiskit.result.ResultError(error)` Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.md index 16e1272dc3..492e372046 100644 --- a/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/qiskit.synthesis.EvolutionSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.EvolutionSynthesis -`qiskit.synthesis.EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") +`qiskit.synthesis.EvolutionSynthesis` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/qiskit.synthesis.LieTrotter.md index e5f9cd934a..c1d1de4dec 100644 --- a/docs/api/qiskit/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/qiskit.synthesis.LieTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.LieTrotter -`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/lie_trotter.py "view source code") +`qiskit.synthesis.LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/qiskit.synthesis.MatrixExponential.md index 27a627d5a2..6d0a2218c3 100644 --- a/docs/api/qiskit/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/qiskit.synthesis.MatrixExponential.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.MatrixExponential -`qiskit.synthesis.MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") +`qiskit.synthesis.MatrixExponential` Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/qiskit.synthesis.ProductFormula.md index 364747686b..963a5bae35 100644 --- a/docs/api/qiskit/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/qiskit.synthesis.ProductFormula.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.ProductFormula -`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/product_formula.py "view source code") +`qiskit.synthesis.ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` Bases: [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/qiskit.synthesis.QDrift.md b/docs/api/qiskit/qiskit.synthesis.QDrift.md index bad44fe449..0552ab2d11 100644 --- a/docs/api/qiskit/qiskit.synthesis.QDrift.md +++ b/docs/api/qiskit/qiskit.synthesis.QDrift.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.QDrift -`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/qdrift.py "view source code") +`qiskit.synthesis.QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None, seed=None)` Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.md b/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.md index ba3b1b4d75..cdbdabfc99 100644 --- a/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.md +++ b/docs/api/qiskit/qiskit.synthesis.SolovayKitaevDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SolovayKitaevDecomposition -`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") +`qiskit.synthesis.SolovayKitaevDecomposition(basic_approximations=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.md index d284322d7b..fd9c376fba 100644 --- a/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/qiskit.synthesis.SuzukiTrotter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.synthesis.SuzukiTrotter -`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") +`qiskit.synthesis.SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` Bases: [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") diff --git a/docs/api/qiskit/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/qiskit.transpiler.AnalysisPass.md index eadff3bace..727dd02bf8 100644 --- a/docs/api/qiskit/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/qiskit.transpiler.AnalysisPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.AnalysisPass -`qiskit.transpiler.AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.AnalysisPass(*args, **kwargs)` Bases: `BasePass` diff --git a/docs/api/qiskit/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/qiskit.transpiler.CouplingMap.md index 6d44ef192c..2aef0e3267 100644 --- a/docs/api/qiskit/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/qiskit.transpiler.CouplingMap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.CouplingMap -`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/coupling.py "view source code") +`qiskit.transpiler.CouplingMap(couplinglist=None, description=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/qiskit.transpiler.FencedDAGCircuit.md index 3955f48413..a520419511 100644 --- a/docs/api/qiskit/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/qiskit.transpiler.FencedDAGCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedDAGCircuit -`qiskit.transpiler.FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/fencedobjs.py "view source code") +`qiskit.transpiler.FencedDAGCircuit(dag_circuit_instance)` Bases: `FencedObject` diff --git a/docs/api/qiskit/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/qiskit.transpiler.FencedPropertySet.md index 81d6a218bc..eb02993cfa 100644 --- a/docs/api/qiskit/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/qiskit.transpiler.FencedPropertySet.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.FencedPropertySet -`qiskit.transpiler.FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/fencedobjs.py "view source code") +`qiskit.transpiler.FencedPropertySet(property_set_instance)` Bases: `FencedObject` diff --git a/docs/api/qiskit/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/qiskit.transpiler.InstructionDurations.md index f704bc6bac..1b2c6d4b01 100644 --- a/docs/api/qiskit/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/qiskit.transpiler.InstructionDurations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionDurations -`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/instruction_durations.py "view source code") +`qiskit.transpiler.InstructionDurations(instruction_durations=None, dt=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/qiskit.transpiler.InstructionProperties.md index 2510ec84c2..c9585ca418 100644 --- a/docs/api/qiskit/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/qiskit.transpiler.InstructionProperties.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.InstructionProperties -`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.InstructionProperties(duration=None, error=None, calibration=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.Layout.md b/docs/api/qiskit/qiskit.transpiler.Layout.md index dd7a93c9f5..690b56c9ec 100644 --- a/docs/api/qiskit/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/qiskit.transpiler.Layout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Layout -`qiskit.transpiler.Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.Layout(input_dict=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.PassManager.md b/docs/api/qiskit/qiskit.transpiler.PassManager.md index 6b76d1631e..e62333bb02 100644 --- a/docs/api/qiskit/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/qiskit.transpiler.PassManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManager -`qiskit.transpiler.PassManager(passes=(), max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.PassManager(passes=(), max_iteration=1000)` Bases: [`BasePassManager`](qiskit.passmanager.BasePassManager "qiskit.passmanager.passmanager.BasePassManager") diff --git a/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.md index 7ebbf67143..627a3e4df3 100644 --- a/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/qiskit.transpiler.PassManagerConfig.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.PassManagerConfig -`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passmanager_config.py "view source code") +`qiskit.transpiler.PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/qiskit.transpiler.StagedPassManager.md index 01539ef49f..1cf5c45f75 100644 --- a/docs/api/qiskit/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/qiskit.transpiler.StagedPassManager.md @@ -10,22 +10,22 @@ python_api_name: qiskit.transpiler.StagedPassManager -`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passmanager.py "view source code") +`qiskit.transpiler.StagedPassManager(stages=None, **kwargs)` Bases: [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") -A pass manager pipeline built from individual stages. +A Pass manager pipeline built up of individual stages This class enables building a compilation pipeline out of fixed stages. Each `StagedPassManager` defines a list of stages which are executed in a fixed order, and each stage is defined as a standalone [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") instance. There are also `pre_` and `post_` stages for each defined stage. This enables easily composing and replacing different stages and also adding hook points to enable programmatic modifications to a pipeline. When using a staged pass manager you are not able to modify the individual passes and are only able to modify stages. -By default, instances of `StagedPassManager` define a typical full compilation pipeline from an abstract virtual circuit to one that is optimized and capable of running on the specified backend. The default pre-defined stages are: +By default instances of `StagedPassManager` define a typical full compilation pipeline from an abstract virtual circuit to one that is optimized and capable of running on the specified backend. The default pre-defined stages are: -1. `init` - Initial passes to run before embedding the circuit to the backend. -2. `layout` - Maps the virtual qubits in the circuit to the physical qubits on the backend. -3. `routing` - Inserts gates as needed to move the qubit states around until the circuit can be run with the chosen layout on the backend’s coupling map. -4. `translation` - Translates the gates in the circuit to the target backend’s basis gate set. -5. `optimization` - Optimizes the circuit to reduce the cost of executing it. These passes will typically run in a loop until a convergence criteria is met. For example, the convergence criteria might be that the circuit depth does not decrease in successive iterations. -6. `scheduling` - Hardware-aware passes that schedule the operations in the circuit. +1. `init` - any initial passes that are run before we start embedding the circuit to the backend +2. `layout` - This stage runs layout and maps the virtual qubits in the circuit to the physical qubits on a backend +3. `routing` - This stage runs after a layout has been run and will insert any necessary gates to move the qubit states around until it can be run on backend’s coupling map. +4. `translation` - Perform the basis gate translation, in other words translate the gates in the circuit to the target backend’s basis set +5. `optimization` - The main optimization loop, this will typically run in a loop trying to optimize the circuit until a condition (such as fixed depth) is reached. +6. `scheduling` - Any hardware aware scheduling passes For backwards compatibility the relative positioning of these default stages will remain stable moving forward. However, new stages may be added to the default stage list in between current stages. For example, in a future release a new phase, something like `logical_optimization`, could be added immediately after the existing `init` stage in the default stage list. This would preserve compatibility for pre-existing `StagedPassManager` users as the relative positions of the stage are preserved so the behavior will not change between releases. diff --git a/docs/api/qiskit/qiskit.transpiler.Target.md b/docs/api/qiskit/qiskit.transpiler.Target.md index efba322d4e..ec3616764b 100644 --- a/docs/api/qiskit/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/qiskit.transpiler.Target.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.Target -`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/target.py "view source code") +`qiskit.transpiler.Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, acquire_alignment=1, qubit_properties=None, concurrent_measurements=None)` Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping "(in Python v3.12)") @@ -39,7 +39,7 @@ cx_props = { gmap.add_instruction(CXGate(), cx_props) ``` -Each instruction in the `Target` is indexed by a unique string name that uniquely identifies that instance of an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object in the Target. There is a 1:1 mapping between a name and an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instance in the target and each name must be unique. By default, the name is the [`name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") attribute of the instruction, but can be set to anything. This lets a single target have multiple instances of the same instruction class with different parameters. For example, if a backend target has two instances of an [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") one is parameterized over any theta while the other is tuned up for a theta of pi/6 you can add these by doing something like: +Each instruction in the Target is indexed by a unique string name that uniquely identifies that instance of an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object in the Target. There is a 1:1 mapping between a name and an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instance in the target and each name must be unique. By default the name is the [`name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") attribute of the instruction, but can be set to anything. This lets a single target have multiple instances of the same instruction class with different parameters. For example, if a backend target has two instances of an [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") one is parameterized over any theta while the other is tuned up for a theta of pi/6 you can add these by doing something like: ```python import math @@ -70,7 +70,7 @@ Then in the `target` object accessing by `rx_30` will get the fixed angle [`RXGa This class only supports additions of gates, qargs, and qubits. If you need to remove one of these the best option is to iterate over an existing object and create a new subset (or use one of the methods to do this). The object internally caches different views and these would potentially be invalidated by removals. -Create a new `Target` object +Create a new Target object `qiskit.transpiler.target.Target.__init__()`’s argument `aquire_alignment` is deprecated as of qiskit-terra 0.23.0. It will be removed no earlier than 3 months after the release date. Instead, use the argument `acquire_alignment`, which behaves identically. @@ -86,11 +86,10 @@ Create a new `Target` object * **pulse\_alignment** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – An integer value representing a time resolution of gate instruction starting time. Gate instruction should start at time which is a multiple of the alignment value. * **acquire\_alignment** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – An integer value representing a time resolution of measure instruction starting time. Measure instruction should start at time which is a multiple of the alignment value. * **qubit\_properties** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – A list of [`QubitProperties`](qiskit.providers.QubitProperties "qiskit.providers.QubitProperties") objects defining the characteristics of each qubit on the target device. If specified the length of this list must match the number of qubits in the target, where the index in the list matches the qubit number the properties are defined for. If some qubits don’t have properties available you can set that entry to `None` -* **concurrent\_measurements** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – A list of sets of qubits that must be measured together. This must be provided as a nested list like `[[0, 1], [2, 3, 4]]`. - -**Raises** - -[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – If both `num_qubits` and `qubit_properties` are both defined and the value of `num_qubits` differs from the length of `qubit_properties`. +* **concurrent\_measurements** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – A list of sets of qubits that must be measured together. This must be provided as a nested list like \[\[0, 1], \[2, 3, 4]]. +* **ValueError** – If both `num_qubits` and `qubit_properties` are both +* **of** (*defined and the value of num\_qubits differs from the length*) – +* **qubit\_properties.** – ## Attributes @@ -182,7 +181,7 @@ The set of qargs in the target. Add a new instruction to the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") -As `Target` objects are strictly additive this is the primary method for modifying a `Target`. Typically, you will use this to fully populate a `Target` before using it in [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). For example: +As `Target` objects are strictly additive this is the primary method for modifying a `Target`. Typically you will use this to fully populate a `Target` before using it in [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). For example: ```python from qiskit.circuit.library import CXGate @@ -206,9 +205,9 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa **Parameters** -* **instruction** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – The operation object to add to the map. If it’s parameterized any value of the parameter can be set. Optionally for variable width instructions (such as control flow operations such as `ForLoop` or `MCXGate`) you can specify the class. If the class is specified than the `name` argument must be specified. When a class is used the gate is treated as global and not having any properties set. -* **properties** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")) – A dictionary of qarg entries to an [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") object for that instruction implementation on the backend. Properties are optional for any instruction implementation, if there are no [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") available for the backend the value can be None. If there are no constraints on the instruction (as in a noiseless/ideal simulation) this can be set to `{None, None}` which will indicate it runs on all qubits (or all available permutations of qubits for multi-qubit gates). The first `None` indicates it applies to all qubits and the second `None` indicates there are no [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") for the instruction. By default, if properties is not set it is equivalent to passing `{None: None}`. -* **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – An optional name to use for identifying the instruction. If not specified the [`name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") attribute of `gate` will be used. All gates in the `Target` need unique names. Backends can differentiate between different parameterization of a single gate by providing a unique name for each (e.g. “rx30”, “rx60”, \`”rx90”\`\` similar to the example in the documentation for the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") class). +* **instruction** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – The operation object to add to the map. If it’s paramerterized any value of the parameter can be set. Optionally for variable width instructions (such as control flow operations such as `ForLoop` or `MCXGate`) you can specify the class. If the class is specified than the `name` argument must be specified. When a class is used the gate is treated as global and not having any properties set. +* **properties** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")) – A dictionary of qarg entries to an [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") object for that instruction implementation on the backend. Properties are optional for any instruction implementation, if there are no [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") available for the backend the value can be None. If there are no constraints on the instruction (as in a noisless/ideal simulation) this can be set to `{None, None}` which will indicate it runs on all qubits (or all available permutations of qubits for multi-qubit gates). The first `None` indicates it applies to all qubits and the second `None` indicates there are no [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") for the instruction. By default, if properties is not set it is equivalent to passing `{None: None}`. +* **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – An optional name to use for identifying the instruction. If not specified the [`name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") attribute of `gate` will be used. All gates in the `Target` need unique names. Backends can differentiate between different parameterizations of a single gate by providing a unique name for each (e.g. “rx30”, “rx60”, \`”rx90”\`\` similar to the example in the documentation for the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") class). **Raises** @@ -227,8 +226,8 @@ If there is a mix of two qubit operations that have a connectivity constraint an **Parameters** -* **two\_q\_gate** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – An optional gate name for a two qubit gate in the `Target` to generate the coupling map for. If specified the output coupling map will only have edges between qubits where this gate is present. -* **filter\_idle\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If set to `True` the output [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") will remove any qubits that don’t have any operations defined in the target. Note that using this argument will result in an output [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") object which has holes in its indices which might differ from the assumptions of the class. The typical use case of this argument is to be paired with [`CouplingMap.connected_components()`](qiskit.transpiler.CouplingMap#connected_components "qiskit.transpiler.CouplingMap.connected_components") which will handle the holes as expected. +* **two\_q\_gate** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – An optional gate name for a two qubit gate in the Target to generate the coupling map for. If specified the output coupling map will only have edges between qubits where this gate is present. +* **filter\_idle\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If set to `True` the output [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") will remove any qubits that don’t have any operations defined in the target. Note that using this argument will result in an output [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") object which has holes in its indices which might differ from the assumptions of the class. The typical use case of this argument is to be paired with with [`CouplingMap.connected_components()`](qiskit.transpiler.CouplingMap#connected_components "qiskit.transpiler.CouplingMap.connected_components") which will handle the holes as expected. **Returns** @@ -243,7 +242,7 @@ for this target. If there are no connectivity constraints in the target this wil **Raises** * [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – If a non-two qubit gate is passed in for `two_q_gate`. -* [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.12)") – If an Instruction not in the `Target` is passed in for `two_q_gate`. +* [**IndexError**](https://docs.python.org/3/library/exceptions.html#IndexError "(in Python v3.12)") – If an Instruction not in the Target is passed in for `two_q_gate`. ### durations @@ -277,16 +276,16 @@ This constructor will use the input from `basis_gates`, `num_qubits`, and `coupl **Parameters** -* **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*]*) – The list of basis gate names for the backend. For the target to be created these names must either be in the output from `get_standard_gate_name_mapping()` or present in the specified `custom_name_mapping` argument. +* **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*]*) – The list of basis gate names for the backend. For the target to be created these names must either be in the output from :func:\~.get\_standard\_gate\_name\_mapping\` or present in the specified `custom_name_mapping` argument. * **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *| None*) – The number of qubits supported on the backend. * **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") *| None*) – The coupling map representing connectivity constraints on the backend. If specified all gates from `basis_gates` will be supported on all qubits (or pairs of qubits). -* **inst\_map** ([*InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") *| None*) – The instruction schedule map representing the pulse [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") definitions for each instruction. If this is specified `coupling_map` must be specified. The `coupling_map` is used as the source of truth for connectivity and if `inst_map` is used the schedule is looked up based on the instructions from the pair of `basis_gates` and `coupling_map`. If you want to define a custom gate for a particular qubit or qubit pair, you can manually build [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). +* **inst\_map** ([*InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") *| None*) – The instruction schedule map representing the pulse [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") definitions for each instruction. If this is specified `coupling_map` must be specified. The `coupling_map` is used as the source of truth for connectivity and if `inst_map` is used the schedule is looked up based on the instuctions from the pair of `basis_gates` and `coupling_map`. If you want to define a custom gate for a particular qubit or qubit pair, you can manually build [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target"). * **backend\_properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") *| None*) – The [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") object which is used for instruction properties and qubit properties. If specified and instruction properties are intended to be used then the `coupling_map` argument must be specified. This is only used to lookup error rates and durations (unless `instruction_durations` is specified which would take precedence) for instructions specified via `coupling_map` and `basis_gates`. * **instruction\_durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") *| None*) – Optional instruction durations for instructions. If specified it will take priority for setting the `duration` field in the [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties") objects for the instructions in the target. -* **concurrent\_measurements** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – A list of sets of qubits that must be measured together. This must be provided as a nested list like `[[0, 1], [2, 3, 4]]`. +* **concurrent\_measurements** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – A list of sets of qubits that must be measured together. This must be provided as a nested list like \[\[0, 1], \[2, 3, 4]]. * **dt** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)") *| None*) – The system time resolution of input signals in seconds * **timing\_constraints** (*TimingConstraints | None*) – Optional timing constraints to include in the [`Target`](#qiskit.transpiler.Target "qiskit.transpiler.Target") -* **custom\_name\_mapping** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, Any] | None*) – An optional dictionary that maps custom gate/operation names in `basis_gates` to an [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") object representing that gate/operation. By default, most standard gates names are mapped to the standard gate object from [`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library") this only needs to be specified if the input `basis_gates` defines gates in names outside that set. +* **custom\_name\_mapping** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, Any] | None*) – An optional dictionary that maps custom gate/operation names in `basis_gates` to an [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") object representing that gate/operation. By default most standard gates names are mapped to the standard gate object from [`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library") this only needs to be specified if the input `basis_gates` defines gates in names outside that set. **Returns** @@ -341,11 +340,11 @@ Calibrated pulse schedule of corresponding instruction. Return the non-global operation names for the target -The non-global operations are those in the target which don’t apply on all qubits (for single qubit operations) or all multi-qubit qargs (for multi-qubit operations). +The non-global operations are those in the target which don’t apply on all qubits (for single qubit operations) or all multiqubit qargs (for multi-qubit operations). **Parameters** -**strict\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If set to `True` the multi-qubit operations considered as non-global respect the strict direction (or order of qubits in the qargs is significant). For example, if `cx` is defined on `(0, 1)` and `ecr` is defined over `(1, 0)` by default neither would be considered non-global, but if `strict_direction` is set `True` both `cx` and `ecr` would be returned. +**strict\_direction** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – If set to `True` the multi-qubit operations considered as non-global respect the strict direction (or order of qubits in the qargs is signifcant). For example, if `cx` is defined on `(0, 1)` and `ecr` is defined over `(1, 0)` by default neither would be considered non-global, but if `strict_direction` is set `True` both `cx` and `ecr` would be returned. **Returns** @@ -446,7 +445,7 @@ Return whether the instruction (operation + qubits) is supported by the target * **qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – The tuple of qubit indices for the instruction. If this is not specified then this method will return `True` if the specified operation is supported on any qubits. The typical application will always have this set (otherwise it’s the same as just checking if the target contains the operation). Normally you would not set this argument if you wanted to check more generally that the target supports an operation with the `parameters` on any qubits. -* **operation\_class** ([*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]*) – The operation class to check whether the target supports a particular operation by class rather than by name. This lookup is more expensive as it needs to iterate over all operations in the target instead of just a single lookup. If this is specified it will supersede the `operation_name` argument. The typical use case for this operation is to check whether a specific variant of an operation is supported on the backend. For example, if you wanted to check whether a [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") was supported on a specific qubit with a fixed angle. That fixed angle variant will typically have a name different from the object’s [`name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") attribute (`"rx"`) in the target. This can be used to check if any instances of the class are available in such a case. +* **operation\_class** ([*Type*](circuit_classical#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type")*\[*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")*]*) – The operation class to check whether the target supports a particular operation by class rather than by name. This lookup is more expensive as it needs to iterate over all operations in the target instead of just a single lookup. If this is specified it will supersede the `operation_name` argument. The typical use case for this operation is to check whether a specific variant of an operation is supported on the backend. For example, if you wanted to check whether a [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") was supported on a specific qubit with a fixed angle. That fixed angle variant will typically have a name different than the object’s [`name`](qiskit.circuit.Instruction#name "qiskit.circuit.Instruction.name") attribute (`"rx"`) in the target. This can be used to check if any instances of the class are available in such a case. * **parameters** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – @@ -457,7 +456,7 @@ Return whether the instruction (operation + qubits) is supported by the target target.instruction_supported("rx", (0,), parameters=parameters) ``` - will return `True` if an [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") is supported on qubit 0 that will accept any parameter. If you need to check for a fixed numeric value parameter this argument is typically paired with the `operation_class` argument. For example: + will return `True` if an [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") is suporrted on qubit 0 that will accept any parameter. If you need to check for a fixed numeric value parameter this argument is typically paired with the `operation_class` argument. For example: ```python target.instruction_supported("rx", (0,), RXGate, parameters=[pi / 4]) @@ -515,11 +514,11 @@ Get the operation names for a specified qargs tuple **Parameters** -**qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – A `qargs` tuple of the qubits to get the gates that apply to it. For example, `(0,)` will return the set of all instructions that apply to qubit 0. If set to `None` this will return the names for any globally defined operations in the target. +**qargs** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – A qargs tuple of the qubits to get the gates that apply to it. For example, `(0,)` will return the set of all instructions that apply to qubit 0. If set to `None` this will return the names for any globally defined operations in the target. **Returns** -The set of operation names that apply to the specified `qargs`. +The set of operation names that apply to the specified qargs\`. **Return type** @@ -527,7 +526,7 @@ The set of operation names that apply to the specified `qargs`. **Raises** -[**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.12)") – If `qargs` is not in target +[**KeyError**](https://docs.python.org/3/library/exceptions.html#KeyError "(in Python v3.12)") – If qargs is not in target ### operations\_for\_qargs @@ -583,7 +582,7 @@ Get an `TimingConstraints` object from the target **Returns** -The timing constraints represented in the `Target` +The timing constraints represented in the Target **Return type** diff --git a/docs/api/qiskit/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/qiskit.transpiler.TransformationPass.md index c816ce6995..d78c2f7718 100644 --- a/docs/api/qiskit/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/qiskit.transpiler.TransformationPass.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TransformationPass -`qiskit.transpiler.TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/basepasses.py "view source code") +`qiskit.transpiler.TransformationPass(*args, **kwargs)` Bases: `BasePass` diff --git a/docs/api/qiskit/qiskit.transpiler.TranspileLayout.md b/docs/api/qiskit/qiskit.transpiler.TranspileLayout.md index 8bb078b4da..e62c4dfd0b 100644 --- a/docs/api/qiskit/qiskit.transpiler.TranspileLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.TranspileLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.TranspileLayout -`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None, _input_qubit_count=None, _output_qubit_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/layout.py "view source code") +`qiskit.transpiler.TranspileLayout(initial_layout, input_qubit_mapping, final_layout=None, _input_qubit_count=None, _output_qubit_list=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/qiskit.transpiler.passes.ALAPSchedule.md index 98575e60fe..be4d84e9d2 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ALAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPSchedule -`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPSchedule(*args, **kwargs)` Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index 2f3b31ff56..b92235ddd1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis -`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") +`qiskit.transpiler.passes.ALAPScheduleAnalysis(*args, **kwargs)` Bases: `BaseScheduler` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/qiskit.transpiler.passes.ASAPSchedule.md index b348f7fbbb..002ad350fa 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ASAPSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ASAPSchedule -`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPSchedule(*args, **kwargs)` Bases: `BaseSchedulerTransform` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index 6447e0ec5b..e160e4347d 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -10,11 +10,11 @@ python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis -`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") +`qiskit.transpiler.passes.ASAPScheduleAnalysis(*args, **kwargs)` Bases: `BaseScheduler` -ASAP Scheduling pass, which schedules the start time of instructions as early as possible. +ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. See the [Scheduling Stage](transpiler#scheduling-stage) section in the [`qiskit.transpiler`](transpiler#module-qiskit.transpiler "qiskit.transpiler") module documentation for the detailed behavior of the control flow operation, i.e. `c_if`. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/qiskit.transpiler.passes.AlignMeasures.md index dff9bb745c..0bcd7d24c2 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.AlignMeasures.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.AlignMeasures -`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") +`qiskit.transpiler.passes.AlignMeasures(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.md index d320ee6e8b..d01faebc55 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ApplyLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ApplyLayout -`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/apply_layout.py "view source code") +`qiskit.transpiler.passes.ApplyLayout(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -80,7 +80,7 @@ Name of the pass. `run(dag)` -Run the ApplyLayout pass on `dag`. +Run the ApplyLayout pass on dag. **Parameters** @@ -96,7 +96,7 @@ A mapped DAG (with physical qubits). **Raises** -[**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if no layout is found in `property_set` or no full physical qubits. +[**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if no layout is found in property\_set or no full physical qubits. ### update\_status diff --git a/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 22cd1c709f..af0e65c7ca 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements -`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") +`qiskit.transpiler.passes.BarrierBeforeFinalMeasurements(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.md index 67e8e6e068..c69d4fe924 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.BasicSwap.md @@ -10,11 +10,11 @@ python_api_name: qiskit.transpiler.passes.BasicSwap -`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/basic_swap.py "view source code") +`qiskit.transpiler.passes.BasicSwap(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") -Map (with minimum effort) a DAGCircuit onto a `coupling_map` adding swap gates. +Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. The basic mapper is a minimum effort to insert swap gates to map the DAG onto a coupling map. When a cx is not in the coupling map possibilities, it inserts one or more swaps in front to make it compatible. @@ -23,7 +23,7 @@ BasicSwap initializer. **Parameters** * **coupling\_map** (*Union\[*[*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")*,* [*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – Directed graph represented a coupling map. -* **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if true, it will only pretend to do routing, i.e., no swap is effectively added. +* **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if true, it only pretend to do routing, i.e., no swap is effectively added. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.md index 722ded5488..13b8a0386a 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.BasisTranslator.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.BasisTranslator -`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/basis_translator.py "view source code") +`qiskit.transpiler.passes.BasisTranslator(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.md index 063f1891b1..93d6a94fd0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CSPLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CSPLayout -`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/csp_layout.py "view source code") +`qiskit.transpiler.passes.CSPLayout(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/qiskit.transpiler.passes.CXCancellation.md index 0cf88adf3c..50167edd64 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CXCancellation.md @@ -10,11 +10,11 @@ python_api_name: qiskit.transpiler.passes.CXCancellation -`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") +`qiskit.transpiler.passes.CXCancellation(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") -Cancel back-to-back `cx` gates in dag. +Cancel back-to-back cx gates in dag. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.md index 1fbf535abf..d259a0ba17 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CheckGateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CheckGateDirection -`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") +`qiskit.transpiler.passes.CheckGateDirection(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.md index f143891086..4c7c083061 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CheckMap.md @@ -10,13 +10,13 @@ python_api_name: qiskit.transpiler.passes.CheckMap -`qiskit.transpiler.passes.CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/check_map.py "view source code") +`qiskit.transpiler.passes.CheckMap(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a DAG circuit is already mapped to a coupling map. -Check if a DAGCircuit is mapped to `coupling_map` by checking that all 2-qubit interactions are laid out to be on adjacent qubits in the global coupling map of the device, setting the property set field (either specified with `property_set_field` or the default `is_swap_mapped`) to `True` or `False` accordingly. Note this does not validate directionality of the connectivity between qubits. If you need to check gates are implemented in a native direction for a target use the [`CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. +Check if a DAGCircuit is mapped to coupling\_map by checking that all 2-qubit interactions are laid out to be on adjacent qubits in the global coupling map of the device, setting the property set field (either specified with `property_set_field` or the default `is_swap_mapped`) to `True` or `False` accordingly. Note this does not validate directionality of the connectivity between qubits. If you need to check gates are implemented in a native direction for a target use the [`CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. CheckMap initializer. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.md index cf789b0327..c0fa39b995 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Collect1qRuns.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect1qRuns -`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") +`qiskit.transpiler.passes.Collect1qRuns(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.md index efecf531ec..d562674889 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Collect2qBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Collect2qBlocks -`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") +`qiskit.transpiler.passes.Collect2qBlocks(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.md index 0203ca681d..49e7f1eb86 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CollectCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectCliffords -`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") +`qiskit.transpiler.passes.CollectCliffords(*args, **kwargs)` Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.md index 0e700255c1..cb2549b639 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CollectLinearFunctions -`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") +`qiskit.transpiler.passes.CollectLinearFunctions(*args, **kwargs)` Bases: `CollectAndCollapse` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.md index 77d59cc6a6..43f604c8fe 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -10,19 +10,19 @@ python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks -`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") +`qiskit.transpiler.passes.CollectMultiQBlocks(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") -Collect sequences of uninterrupted gates acting on groups of qubits. `max_block_size` specifies the maximum number of qubits that can be acted upon by any single group of gates +Collect sequences of uninterrupted gates acting on groups of qubits. max\_block\_size specifies the maximum number of qubits that can be acted upon by any single group of gates -Traverse the DAG and find blocks of gates that act consecutively on groups of qubits. Write the blocks to `property_set` as a list of blocks of the form: +Traverse the DAG and find blocks of gates that act consecutively on groups of qubits. Write the blocks to propert\_set as a list of blocks of the form: ```python [[g0, g1, g2], [g4, g5]] ``` -Blocks are reported in a valid topological order. Further, the gates within each block are also reported in topological order Some gates may not be present in any block (e.g. if the number of operands is greater than `max_block_size`) +Blocks are reported in a valid topological order. Further, the gates within each block are also reported in topological order Some gates may not be present in any block (e.g. if the number of operands is greater than max\_block\_size) A Disjoint Set Union data structure (DSU) is used to maintain blocks as gates are processed. This data structure points each qubit to a set at all times and the sets correspond to current blocks. These change over time and the data structure allows these changes to be done quickly. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.md index 9578e3592f..cd32112e68 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CommutationAnalysis.md @@ -10,13 +10,13 @@ python_api_name: qiskit.transpiler.passes.CommutationAnalysis -`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") +`qiskit.transpiler.passes.CommutationAnalysis(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Analysis pass to find commutation relations between DAG nodes. -`property_set['commutation_set']` is a dictionary that describes the commutation relations on a given wire, all the gates on a wire are grouped into a set of gates that commute. +Property\_set\[‘commutation\_set’] is a dictionary that describes the commutation relations on a given wire, all the gates on a wire are grouped into a set of gates that commute. ## Attributes @@ -80,7 +80,7 @@ Name of the pass. Run the CommutationAnalysis pass on dag. -Run the pass on the DAG, and write the discovered commutation relations into the `property_set`. +Run the pass on the DAG, and write the discovered commutation relations into the property\_set. ### update\_status diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.md index e191679bc4..716db92374 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeCancellation -`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeCancellation(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -27,7 +27,7 @@ CommutativeCancellation initializer. **Parameters** * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*]*) – Basis gates to consider, e.g. `['u3', 'cx']`. For the effects of this pass, the basis is the set intersection between the `basis_gates` parameter and the gates in the dag. -* **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `basis_gates` and `target` are specified then this argument will take precedence and `basis_gates` will be ignored. +* **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `basis_gates` and this are specified then this argument will take precedence and `basis_gates` will be ignored. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.md index 8691919d93..de6ea512a2 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation -`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.CommutativeInverseCancellation(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.md index e1e4f055e7..fe3954aa0c 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -10,13 +10,13 @@ python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter -`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") +`qiskit.transpiler.passes.Commuting2qGateRouter(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") A class to swap route one or more commuting gates to the coupling map. -This pass routes blocks of commuting two-qubit gates encapsulated as `Commuting2qBlock` instructions. This pass will not apply to other instructions. The mapping to the coupling map is done using swap strategies, see `SwapStrategy`. The swap strategy should suit the problem and the coupling map. This transpiler pass should ideally be executed before the quantum circuit is enlarged with any idle ancilla qubits. Otherwise, we may swap qubits outside the portion of the chip we want to use. Therefore, the swap strategy and its associated coupling map do not represent physical qubits. Instead, they represent an intermediate mapping that corresponds to the physical qubits once the initial layout is applied. The example below shows how to map a four qubit [`PauliEvolutionGate`](qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate") to qubits 0, 1, 3, and 4 of the five qubit device with the coupling map +This pass routes blocks of commuting two-qubit gates encapsulated as `Commuting2qBlock` instructions. This pass will not apply to other instructions. The mapping to the coupling map is done using swap strategies, see `SwapStrategy`. The swap strategy should suit the problem and the coupling map. This transpiler pass should ideally be executed before the quantum circuit is enlarged with any idle ancilla qubits. Otherwise we may swap qubits outside of the portion of the chip we want to use. Therefore, the swap strategy and its associated coupling map do not represent physical qubits. Instead, they represent an intermediate mapping that corresponds to the physical qubits once the initial layout is applied. The example below shows how to map a four qubit [`PauliEvolutionGate`](qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate") to qubits 0, 1, 3, and 4 of the five qubit device with the coupling map ```python 0 -- 1 -- 2 @@ -75,7 +75,7 @@ This pass manager relies on the `current_layout` which corresponds to the qubit **Parameters** -* **swap\_strategy** – An instance of a `SwapStrategy` that holds the swap layers that are used, and the order in which to apply them, to map the instruction to the hardware. If this field is not given, it should be contained in the property set of the pass. This allows other passes to determine the most appropriate swap strategy at run-time. +* **swap\_strategy** – An instance of a `SwapStrategy` that holds the swap layers that are used, and the order in which to apply them, to map the instruction to the hardware. If this field is not given if should be contained in the property set of the pass. This allows other passes to determine the most appropriate swap strategy at run-time. * **edge\_coloring** – An optional edge coloring of the coupling map (I.e. no two edges that share a node have the same color). If the edge coloring is given then the commuting gates that can be simultaneously applied given the current qubit permutation are grouped according to the edge coloring and applied according to this edge coloring. Here, a color is an int which is used as the index to define and access the groups of commuting gates that can be applied simultaneously. If the edge coloring is not given then the sets will be built-up using a greedy algorithm. The edge coloring is useful to position gates such as `RZZGate`s next to swap gates to exploit CX cancellations. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.md index 41517cc73f..eb9a37f887 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConsolidateBlocks -`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") +`qiskit.transpiler.passes.ConsolidateBlocks(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -24,14 +24,14 @@ This pass assumes that the ‘blocks\_list’ property that it reads is given su ConsolidateBlocks initializer. -If `kak_basis_gate` is not `None` it will be used as the basis gate for KAK decomposition. Otherwise, if `basis_gates` is not `None` a basis gate will be chosen from this list. Otherwise, the basis gate will be [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). +If kak\_basis\_gate is not None it will be used as the basis gate for KAK decomposition. Otherwise, if basis\_gates is not None a basis gate will be chosen from this list. Otherwise the basis gate will be CXGate. **Parameters** * **kak\_basis\_gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Basis gate for KAK decomposition. * **force\_consolidate** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Force block consolidation. * **basis\_gates** (*List(*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*)*) – Basis gates from which to choose a KAK gate. -* **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – a float between $\[0.0, 1.0]\$. Lower approximates more. +* **approximation\_degree** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – a float between \[0.0, 1.0]. Lower approximates more. * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The target object for the compilation target backend. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.md index 7d1c9a76e0..115af39def 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConstrainedReschedule -`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") +`qiskit.transpiler.passes.ConstrainedReschedule(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.md index 42af8403f3..38d0d75fb1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ContainsInstruction.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ContainsInstruction -`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") +`qiskit.transpiler.passes.ContainsInstruction(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 4c2957a3a7..90887b9902 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps -`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") +`qiskit.transpiler.passes.ConvertConditionsToIfOps(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/qiskit.transpiler.passes.CountOps.md index 1ce0b210b6..f0bac24c1b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CountOps.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CountOps -`qiskit.transpiler.passes.CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/count_ops.py "view source code") +`qiskit.transpiler.passes.CountOps(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.md index 84faa921af..0f3b8beffe 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -10,11 +10,11 @@ python_api_name: qiskit.transpiler.passes.CountOpsLongestPath -`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") +`qiskit.transpiler.passes.CountOpsLongestPath(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") -Count the operations on the longest path in a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"). +Count the operations on the longest path in a DAGcircuit. The result is saved in `property_set['count_ops_longest_path']` as an integer. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index 9b554814f0..77f343b588 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule -`qiskit.transpiler.passes.CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") +`qiskit.transpiler.passes.CrosstalkAdaptiveSchedule(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ CrosstalkAdaptiveSchedule initializer. * **measured\_qubits** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – a list of qubits that will be measured in a particular circuit. This arg need not be specified for circuits which already include measure gates. The arg is useful when a subsequent module such as state\_tomography\_circuits inserts the measure gates. If CrosstalkAdaptiveSchedule is made aware of those measurements, it is included in the optimization. -* **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend, if both `backend_prop` and `target` are specified then this argument will take precedence and `coupling_map` will be ignored. +* **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – A target representing the target backend, if both `backend_prop` and this are specified then this argument will take precedence and `coupling_map` will be ignored. **Raises** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.md index 4696b1134b..83a27fbdc6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.DAGFixedPoint.md @@ -10,13 +10,13 @@ python_api_name: qiskit.transpiler.passes.DAGFixedPoint -`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") +`qiskit.transpiler.passes.DAGFixedPoint(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if the DAG has reached a fixed point. -A dummy analysis pass that checks if the DAG a fixed point (the DAG is not modified anymore). The result is saved in `property_set['dag_fixed_point']` as a boolean. +A dummy analysis pass that checks if the DAG a fixed point (the DAG is not modified anymore). The results is saved in `property_set['dag_fixed_point']` as a boolean. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.md index 7158d789da..d83edb3cab 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.DAGLongestPath.md @@ -10,11 +10,11 @@ python_api_name: qiskit.transpiler.passes.DAGLongestPath -`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") +`qiskit.transpiler.passes.DAGLongestPath(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") -Return the longest path in a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") as a list of [`DAGOpNode`](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")s, [`DAGInNode`](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")s, and [`DAGOutNode`](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")s. +Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/qiskit.transpiler.passes.Decompose.md index 9534c1c41c..6abb2a880d 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Decompose.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Decompose -`qiskit.transpiler.passes.Decompose(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/decompose.py "view source code") +`qiskit.transpiler.passes.Decompose(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.md index e7331be806..0c7bb01a2f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.DenseLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DenseLayout -`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/dense_layout.py "view source code") +`qiskit.transpiler.passes.DenseLayout(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -19,7 +19,7 @@ Choose a Layout by finding the most connected subset of qubits. This pass associates a physical qubit (int) to each virtual qubit of the circuit (Qubit). - Even though a `'layout'` is not strictly a property of the DAG, in the transpiler architecture it is best passed around between passes by being set in `property_set`. + Even though a ‘layout’ is not strictly a property of the DAG, in the transpiler architecture it is best passed around between passes by being set in property\_set. DenseLayout initializer. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/qiskit.transpiler.passes.Depth.md index 9b4a84f4f9..ac19d17a02 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Depth.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Depth -`qiskit.transpiler.passes.Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/depth.py "view source code") +`qiskit.transpiler.passes.Depth(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/qiskit.transpiler.passes.DynamicalDecoupling.md index c24b2ed8de..6dea18aef9 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.DynamicalDecoupling -`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.DynamicalDecoupling(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 1cf0b315f8..7a3efd94ca 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition -`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") +`qiskit.transpiler.passes.EchoRZXWeylDecomposition(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -23,7 +23,7 @@ EchoRZXWeylDecomposition pass. **Parameters** * **instruction\_schedule\_map** ([*InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")) – the mapping from circuit [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and arguments to [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule")s. -* **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `instruction_schedule_map` and `target` are specified then this argument will take precedence and `instruction_schedule_map` will be ignored. +* **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `instruction_schedule_map` and this are specified then this argument will take precedence and `instruction_schedule_map` will be ignored. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.md index 1e9efa7b3d..f9d91c3476 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla -`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") +`qiskit.transpiler.passes.EnlargeWithAncilla(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -94,7 +94,7 @@ An extended DAG. **Raises** -[**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If there is no layout in the property set or not set at init time. +[**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If there is not layout in the property set or not set at init time. ### update\_status diff --git a/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.md index 45a3a71163..24264d8d0e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.FixedPoint.md @@ -10,13 +10,13 @@ python_api_name: qiskit.transpiler.passes.FixedPoint -`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/fixed_point.py "view source code") +`qiskit.transpiler.passes.FixedPoint(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Check if a property reached a fixed point. -A dummy analysis pass that checks if a property reached a fixed point. The result is saved in `property_set['_fixed_point']` as a boolean. +A dummy analysis pass that checks if a property reached a fixed point. The results is saved in `property_set['_fixed_point']` as a boolean. FixedPoint initializer. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.md index d947e7c32d..fde587689f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.FullAncillaAllocation -`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") +`qiskit.transpiler.passes.FullAncillaAllocation(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -137,5 +137,5 @@ Updated pass manager state. `static validate_layout(layout_qubits, dag_qubits)` -Checks if all the qregs in `layout_qregs` already exist in `dag_qregs`. Otherwise, raise. +Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.md index 6259fd0c60..38c8cd0db0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.GateDirection.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GateDirection -`qiskit.transpiler.passes.GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/gate_direction.py "view source code") +`qiskit.transpiler.passes.GateDirection(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.md index 5851a01a3c..96e6a4f867 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.GatesInBasis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.GatesInBasis -`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/gates_basis.py "view source code") +`qiskit.transpiler.passes.GatesInBasis(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.md index 9c286af8d3..717302041f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HighLevelSynthesis -`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") +`qiskit.transpiler.passes.HighLevelSynthesis(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.md index 3f68357801..c3570f2960 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.HoareOptimizer.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.HoareOptimizer -`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") +`qiskit.transpiler.passes.HoareOptimizer(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.md index af2e2322b0..669b9f5fc5 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InstructionDurationCheck -`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") +`qiskit.transpiler.passes.InstructionDurationCheck(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.md index 49eaebe069..c313c88027 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.InverseCancellation.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.InverseCancellation -`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") +`qiskit.transpiler.passes.InverseCancellation(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -20,11 +20,11 @@ Initialize InverseCancellation pass. **Parameters** -**gates\_to\_cancel** – List describing the gates to cancel. Each element of the list is either a single gate or a pair of gates. If a single gate, then it should be self-inverse. If a pair of gates, then the gates in the pair should be inverses of each other. +**gates\_to\_cancel** – list of gates to cancel **Raises** -[**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – Input is not a self-inverse gate or a pair of inverse gates. +[**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – Initialization raises an error when the input is not a self-inverse gate or a two-tuple of inverse gates. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.md index bfbcaf73e2..9a62e0529b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Layout2qDistance.md @@ -10,13 +10,13 @@ python_api_name: qiskit.transpiler.passes.Layout2qDistance -`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") +`qiskit.transpiler.passes.Layout2qDistance(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Evaluate how good the layout selection was. -Saves in `property_set['layout_score']` (or the property name in property\_name) the sum of distances for each circuit CX. The lower the number, the better the selection. Therefore, 0 is a perfect layout selection. No CX direction is considered. +Saves in property\_set\[‘layout\_score’] (or the property name in property\_name) the sum of distances for each circuit CX. The lower the number, the better the selection. Therefore, 0 is a perfect layout selection. No CX direction is considered. Layout2qDistance initializer. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index f1e7ba92ed..ac741b7bb2 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis -`qiskit.transpiler.passes.LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`qiskit.transpiler.passes.LinearFunctionsSynthesis(*args, **kwargs)` Bases: [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 3e84894e1b..cc91a47853 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations -`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") +`qiskit.transpiler.passes.LinearFunctionsToPermutations(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.md index 0cc44469d2..095e121f36 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.LookaheadSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.LookaheadSwap -`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") +`qiskit.transpiler.passes.LookaheadSwap(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -39,7 +39,7 @@ LookaheadSwap initializer. * **coupling\_map** (*Union\[*[*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")*,* [*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – CouplingMap of the target backend. * **search\_depth** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – lookahead tree depth when ranking best SWAP options. * **search\_width** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – lookahead tree width when ranking best SWAP options. -* **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if true, it will only pretend to do routing, i.e., no swap is effectively added. +* **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if true, it only pretend to do routing, i.e., no swap is effectively added. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.md index 98829bb5d3..435eabb0e9 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers -`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") +`qiskit.transpiler.passes.MergeAdjacentBarriers(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.md b/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.md index e738f2e122..3ddd22c022 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.MinimumPoint.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.MinimumPoint -`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/minimum_point.py "view source code") +`qiskit.transpiler.passes.MinimumPoint(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -22,7 +22,7 @@ This pass will track the state of fields in the property set over its past execu Fields used by this pass in the property set are (all relative to the `prefix` argument): -* `{prefix}_minimum_point_state` - Used to track the state of the minimum point search +* `{prefix}_minimum_point_state` - Used to track the state of the minimpoint search * **`{prefix}_minimum_point` - This value gets set to `True` when either a fixed point** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 1902e31af1..570c00a693 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout -`qiskit.transpiler.passes.NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") +`qiskit.transpiler.passes.NoiseAdaptiveLayout(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.NormalizeRXAngle.md b/docs/api/qiskit/qiskit.transpiler.passes.NormalizeRXAngle.md index a5542c190a..e6779f44ec 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.NormalizeRXAngle.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.NormalizeRXAngle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NormalizeRXAngle -`qiskit.transpiler.passes.NormalizeRXAngle(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/normalize_rx_angle.py "view source code") +`qiskit.transpiler.passes.NormalizeRXAngle(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ NormalizeRXAngle initializer. **Parameters** * **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend. If the target contains SX and X calibrations, this pass will replace the corresponding RX gates with SX and X gates. -* **resolution\_in\_radian** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – Resolution for RX rotation angle quantization. If set to zero, this pass won’t modify the rotation angles in the given DAG. (=Provides arbitrary-angle RX) +* **resolution\_in\_radian** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – Resolution for RX rotation angle quantization. If set to zero, this pass won’t modify the rotation angles in the given DAG. (=Provides aribitary-angle RX) ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.md index 8a387c663a..20c92dd58a 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.NumTensorFactors.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.NumTensorFactors -`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") +`qiskit.transpiler.passes.NumTensorFactors(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.md index 003f8b8da4..870aed1ecc 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGates -`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") +`qiskit.transpiler.passes.Optimize1qGates(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -22,7 +22,7 @@ Optimize1qGates initializer. * **basis** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*]*) – Basis gates to consider, e.g. \[‘u3’, ‘cx’]. For the effects of this pass, the basis is the set intersection between the basis parameter and the set \{‘u1’,’u2’,’u3’, ‘u’, ‘p’}. * **eps** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – EPS to check against -* **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `basis` and `target` are specified then this argument will take precedence and `basis` will be ignored. +* **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `basis` and this are specified then this argument will take precedence and `basis` will be ignored. ## Attributes @@ -114,7 +114,7 @@ the optimized DAG. **Raises** -[**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if `YZY` and `ZYZ` angles do not give same rotation matrix. +[**TranspilerError**](transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if YZY and ZYZ angles do not give same rotation matrix. ### update\_status diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index 6d4e217d45..a792ef8df1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -10,16 +10,16 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition -`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesDecomposition(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Optimize chains of single-qubit gates by combining them into a single gate. -**The decision to replace the original chain with a new re-synthesis depends on:** +**The decision to replace the original chain with a new resynthesis depends on:** * whether the original chain was out of basis: replace -* whether the original chain was in basis but re-synthesis is lower error: replace +* whether the original chain was in basis but resynthesis is lower error: replace * whether the original chain contains a pulse gate: do not replace * whether the original chain amounts to identity: replace with null diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index b4df3c16ca..e234822e65 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -10,13 +10,13 @@ python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation -`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") +`qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") -Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and resynthesizing the results. The commutation rules are stored in `commutation_table`. +Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. The commutation rules are stored in commutation\_table. -**NOTE: In addition to those mentioned in `commutation_table`, this pass has some limitations:** +**NOTE: In addition to those mentioned in commutation\_table, this pass has some limitations:** * Does not handle multiple commutations in a row without intermediate progress. * Can only commute into positions where there are pre-existing runs. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.md index 577cddd0f9..ff33d0d645 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.OptimizeCliffords.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.OptimizeCliffords -`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") +`qiskit.transpiler.passes.OptimizeCliffords(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.md index a174ad9b10..47c8aadbf8 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.PadDelay.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDelay -`qiskit.transpiler.passes.PadDelay(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") +`qiskit.transpiler.passes.PadDelay(*args, **kwargs)` Bases: `BasePadding` @@ -46,7 +46,7 @@ Create new padding delay pass. **Parameters** * **fill\_very\_end** – Set `True` to fill the end of circuit with delay. -* **target** – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend. If it is supplied and does not support delay instruction on a qubit, padding passes do not pad any idle time of the qubit. +* **target** – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend. If it supplied and it does not support delay instruction on a qubit, padding passes do not pad any idle time of the qubit. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.md index defe9a8b1c..e9a31c62ac 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling -`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") +`qiskit.transpiler.passes.PadDynamicalDecoupling(*args, **kwargs)` Bases: `BasePadding` @@ -18,7 +18,7 @@ Dynamical decoupling insertion pass. This pass works on a scheduled, physical circuit. It scans the circuit for idle periods of time (i.e. those containing delay instructions) and inserts a DD sequence of gates in those spots. These gates amount to the identity, so do not alter the logical action of the circuit, but have the effect of mitigating decoherence in those idle periods. -As a special case, the pass allows a length-1 sequence (e.g. `[XGate()]`). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. +As a special case, the pass allows a length-1 sequence (e.g. \[XGate()]). In this case the DD insertion happens only when the gate inverse can be absorbed into a neighboring gate in the circuit (so we would still be replacing Delay with something that is equivalent to the identity). This can be used, for instance, as a Hahn echo. This pass ensures that the inserted sequence preserves the circuit exactly (including global phase). diff --git a/docs/api/qiskit/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/qiskit.transpiler.passes.PulseGates.md index edac44d83e..041512b745 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.PulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.PulseGates -`qiskit.transpiler.passes.PulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") +`qiskit.transpiler.passes.PulseGates(*args, **kwargs)` Bases: `CalibrationBuilder` @@ -33,7 +33,7 @@ Create new pass. **Parameters** * **inst\_map** – Instruction schedule map that user may override. -* **target** – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `inst_map` and `target` are specified then it updates instructions in the `target` with `inst_map`. +* **target** – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `inst_map` and this are specified then it updates instructions in the `target` with `inst_map`. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.md b/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.md index d0b3a48a5f..a8b16c1ad6 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RXCalibrationBuilder -`qiskit.transpiler.passes.RXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/rx_builder.py "view source code") +`qiskit.transpiler.passes.RXCalibrationBuilder(*args, **kwargs)` Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 588f5a341b..3a8edcfe16 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder -`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilder(*args, **kwargs)` Bases: `CalibrationBuilder` diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 7388811512..0c1468cdc1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho -`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") +`qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho(*args, **kwargs)` Bases: [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.md index 175024c1c9..72995fed9f 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveBarriers.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveBarriers -`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") +`qiskit.transpiler.passes.RemoveBarriers(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index b53c796eaa..74dcc83b24 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure -`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") +`qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.md index ada8ca68f8..2e3c99080b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements -`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") +`qiskit.transpiler.passes.RemoveFinalMeasurements(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -18,7 +18,7 @@ Remove final measurements and barriers at the end of a circuit. This pass removes final barriers and final measurements, as well as all unused classical registers and bits they are connected to. Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.) -Classical registers are removed iff they reference at least one bit that has become unused by the circuit as a result of the operation, and all of their other bits are also unused. Separately, classical bits are removed iff they have become unused by the circuit as a result of the operation, or they appear in a removed classical register, but do not appear in a classical register that will remain. +Classical registers are removed iff they reference at least one bit that has become unused by the circuit as a result of the operation, and all of their other bits are also unused. Seperately, classical bits are removed iff they have become unused by the circuit as a result of the operation, or they appear in a removed classical register, but do not appear in a classical register that will remain. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.md index d459270700..a083f10a6d 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState -`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") +`qiskit.transpiler.passes.RemoveResetInZeroState(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index 466d7a5a6c..04ce8bfbb1 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -10,13 +10,13 @@ python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification -`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") +`qiskit.transpiler.passes.ResetAfterMeasureSimplification(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") This pass replaces reset after measure with a conditional X gate. -This optimization is suitable for use on IBM Quantum systems where the reset operation is performed by a measurement followed by a conditional x-gate. It might not be desirable on other backends if reset is implemented differently. +This optimization is suitable for use on IBM Quantum systems where the reset operation is performed by a measurement followed by a conditional x-gate. It might not be desireable on other backends if reset is implemented differently. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.md index 4129bc5434..6169409a78 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SabreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreLayout -`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") +`qiskit.transpiler.passes.SabreLayout(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -20,7 +20,7 @@ Starting with a random initial Layout, the algorithm does a full routing of the This method exploits the reversibility of quantum circuits, and tries to include global circuit information in the choice of initial\_layout. -By default, this pass will run both layout and routing and will transform the circuit so that the layout is applied to the input dag (meaning that the output circuit will have ancilla qubits allocated for unused qubits on the coupling map and the qubits will be reordered to match the mapped physical qubits) and then routing will be applied (inserting `AnalysisPass` objects and just find an initial layout and set that on the property set. This is done because by default the pass will run parallel seed trials with different random seeds for selecting the random initial layout and then selecting the routed output which results in the least number of swap gates needed. +By default this pass will run both layout and routing and will transform the circuit so that the layout is applied to the input dag (meaning that the output circuit will have ancilla qubits allocated for unused qubits on the coupling map and the qubits will be reordered to match the mapped physical qubits) and then routing will be applied (inserting `AnalysisPass` objects and just find an initial layout and set that on the property set. This is done because by default the pass will run parallel seed trials with different random seeds for selecting the random initial layout and then selecting the routed output which results in the least number of swap gates needed. You can use the `routing_pass` argument to have this pass operate as a typical layout pass. When specified this will use the specified routing pass to select an initial layout only and will not run multiple seed trials. @@ -98,7 +98,7 @@ int **param skip\_routing** -If this is set `True` and `routing_pass` is not used then routing will not be applied to the output circuit. Only the layout will be set in the property set. This is a tradeoff to run custom routing with multiple layout trials, as using this option will cause SabreLayout to run the routing stage internally but not use that result. +If this is set `True` and `routing_pass` is not used then routing will not be applied to the output circuit. Only the layout will be returned in the property set. This is a tradeoff to run custom routing with multiple layout trials, as using this option will cause SabreLayout to run the routing stage internally but not use that result. **type skip\_routing** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.md index f3fb11cb26..937252425b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SabrePreLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabrePreLayout -`qiskit.transpiler.passes.SabrePreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/sabre_pre_layout.py "view source code") +`qiskit.transpiler.passes.SabrePreLayout(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.md index 3fd0f38b69..2f9ef6faee 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SabreSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SabreSwap -`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") +`qiskit.transpiler.passes.SabreSwap(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -70,10 +70,10 @@ Additional Information: > This is the same as ‘lookahead’, but the whole cost is multiplied by a decay factor. This increases the cost if the SWAP that generated the trial layout was recently used (i.e. it penalizes increase in depth). > > $$ -> H_{decay} = max(decay(SWAP.q_1), decay(SWAP.q_2)) { +> \begin{split}H_{decay} = max(decay(SWAP.q_1), decay(SWAP.q_2)) { > \frac{1}{\left|{F}\right|} \sum_{gate \in F} D[\pi(gate.q_1)][\pi(gate.q2)]\\ > + W *\frac{1}{\left|{E}\right|} \sum_{gate \in E} D[\pi(gate.q_1)][\pi(gate.q2)] -> } +> }\end{split} > $$ ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.md index 415ce8ec0c..ece16a3ae9 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SetIOLatency.md @@ -10,13 +10,13 @@ python_api_name: qiskit.transpiler.passes.SetIOLatency -`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") +`qiskit.transpiler.passes.SetIOLatency(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") Set IOLatency information to the input circuit. -The `clbit_write_latency` and `conditional_latency` are added to the property set of pass manager. This information can be shared among the passes that perform scheduling on instructions acting on classical registers. +The `clbit_write_latency` and `conditional_latency` are added to the property set of pass manager. These information can be shared among the passes that perform scheduling on instructions acting on classical registers. Once these latencies are added to the property set, this information is also copied to the output circuit object as protected attributes, so that it can be utilized outside the transpilation, for example, the timeline visualization can use latency to accurately show time occupation by instructions on the classical registers. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.md index 8d3e15b2db..94eb76fe42 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SetLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SetLayout -`qiskit.transpiler.passes.SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/set_layout.py "view source code") +`qiskit.transpiler.passes.SetLayout(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/qiskit.transpiler.passes.Size.md index 86de98b655..99898df3de 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Size.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Size -`qiskit.transpiler.passes.Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/size.py "view source code") +`qiskit.transpiler.passes.Size(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.md index 8ae1146a6c..1374ebff8e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaev.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaev -`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.SolovayKitaev(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaevSynthesis.md b/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaevSynthesis.md index 9ecb61a5af..106c80a821 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaevSynthesis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.SolovayKitaevSynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis -`qiskit.transpiler.passes.SolovayKitaevSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") +`qiskit.transpiler.passes.SolovayKitaevSynthesis` Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/qiskit.transpiler.passes.StochasticSwap.md index 1ae519aa74..b05a477e54 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.StochasticSwap.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.StochasticSwap -`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") +`qiskit.transpiler.passes.StochasticSwap(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ If these are not satisfied, the behavior is undefined. * **coupling\_map** (*Union\[*[*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")*,* [*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – Directed graph representing a coupling map. * **trials** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – maximum number of iterations to attempt * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – seed for random number generator -* **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if true, it will only pretend to do routing, i.e., no swap is effectively added. +* **fake\_run** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – if true, it only pretend to do routing, i.e., no swap is effectively added. * **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – starting layout at beginning of pass. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.md index 67de417a75..0a3abb36b0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.TemplateOptimization.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TemplateOptimization -`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") +`qiskit.transpiler.passes.TemplateOptimization(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -19,8 +19,8 @@ Class for the template optimization pass. **Parameters** * **template\_list** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*()]*) – list of the different template circuit to apply. -* **heuristics\_backward\_param** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – \[length, survivor] Those are the parameters for applying heuristics on the backward part of the algorithm. This part of the algorithm creates a tree of matching scenario. This tree grows exponentially. The heuristics evaluate which scenarios have the longest match and keep only those. The length is the interval in the tree for cutting it and survivor is the number of scenarios that are kept. We advise to use l=3 and s=1 to have serious time advantage. We remind that the heuristics implies losing a part of the maximal matches. Check reference for more details. -* **heuristics\_qubits\_param** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – \[length] The heuristics for the qubit choice make guesses from the dag dependency of the circuit in order to limit the number of qubit configurations to explore. The length is the number of successors or not predecessors that will be explored in the dag dependency of the circuit, each qubits of the nodes are added to the set of authorized qubits. We advise to use length=1. Check reference for more details. +* **heuristics\_backward\_param** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – \[length, survivor] Those are the parameters for applying heuristics on the backward part of the algorithm. This part of the algorithm creates a tree of matching scenario. This tree grows exponentially. The heuristics evaluates which scenarios have the longest match and keep only those. The length is the interval in the tree for cutting it and survivor is the number of scenarios that are kept. We advice to use l=3 and s=1 to have serious time advantage. We remind that the heuristics implies losing a part of the maximal matches. Check reference for more details. +* **heuristics\_qubits\_param** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – \[length] The heuristics for the qubit choice make guesses from the dag dependency of the circuit in order to limit the number of qubit configurations to explore. The length is the number of successors or not predecessors that will be explored in the dag dependency of the circuit, each qubits of the nodes are added to the set of authorized qubits. We advice to use length=1. Check reference for more details. * **user\_cost\_dict** (*Dict\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*,* [*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]*) – quantum cost dictionary passed to TemplateSubstitution to configure its behavior. This will override any default values if None is not given. The key is the name of the gate and the value its quantum cost. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.md index 104d94ef30..a894e85874 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.TimeUnitConversion.md @@ -10,26 +10,26 @@ python_api_name: qiskit.transpiler.passes.TimeUnitConversion -`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") +`qiskit.transpiler.passes.TimeUnitConversion(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. -This pass will add a [`Instruction.duration`](qiskit.circuit.Instruction#duration "qiskit.circuit.Instruction.duration") metadata to each op whose duration is known which will be used by subsequent scheduling passes for scheduling. +This pass will add a .duration metadata to each op whose duration is known, which will be used by subsequent scheduling passes for scheduling. -If `dt` (in seconds) is known to transpiler, the unit `'dt'` is chosen. Otherwise, the unit to be selected depends on what units are used in delays and instruction durations: +If dt (dt in seconds) is known to transpiler, the unit ‘dt’ is chosen. Otherwise, the unit to be selected depends on what units are used in delays and instruction durations: -* `'s'`: if they are all in SI units. -* `'dt'`: if they are all in the unit `'dt'`. -* raise error: if they are a mix of SI units and `'dt'`. +* ‘s’: if they are all in SI units. +* ‘dt’: if they are all in the unit ‘dt’. +* raise error: if they are a mix of SI units and ‘dt’. TimeUnitAnalysis initializer. **Parameters** * **inst\_durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – A dictionary of durations of instructions. -* **target** – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `inst_durations` and `target` are specified then this argument will take precedence and `inst_durations` will be ignored. +* **target** – The [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") representing the target backend, if both `inst_durations` and this are specified then this argument will take precedence and `inst_durations` will be ignored. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.md index 39c5384b8f..1567332585 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates -`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") +`qiskit.transpiler.passes.TranslateParameterizedGates(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.md index f21b8537a3..7470d36c4e 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.TrivialLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.TrivialLayout -`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") +`qiskit.transpiler.passes.TrivialLayout(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.md index 70f870c0e1..05861a7d5b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.UnitarySynthesis.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnitarySynthesis -`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") +`qiskit.transpiler.passes.UnitarySynthesis(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.md index 175c4550d0..f454a02c85 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroll3qOrMore -`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") +`qiskit.transpiler.passes.Unroll3qOrMore(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -20,7 +20,7 @@ Initialize the Unroll3qOrMore pass **Parameters** -* **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The target object representing the compilation target. If specified any multi-qubit instructions in the circuit when the pass is run that are supported by the target device will be left in place. If both this and `basis_gates` are specified only the target will be checked. +* **target** ([*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")) – The target object representing the compilation target. If specified any multiqubit instructions in the circuit when the pass is run that are supported by the target device will be left in place. If both this and `basis_gates` are specified only the target will be checked. * **basis\_gates** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – A list of basis gate names that the target device supports. If specified any gate names in the circuit which are present in this list will not be unrolled. If both this and `target` are specified only the target will be used for checking which gates are supported. ## Attributes diff --git a/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 6d66e39858..2193a96bcd 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions -`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") +`qiskit.transpiler.passes.UnrollCustomDefinitions(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -22,7 +22,7 @@ Unrolls instructions with custom definitions. * **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – The equivalence library which will be used by the BasisTranslator pass. (Instructions in this library will not be unrolled by this pass.) -* **basis\_gates** (*Optional\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*]]*) – Target basis names to unroll to, e.g. `['u3', 'cx']`. Ignored if `target` is also specified. +* **basis\_gates** (*Optional\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*]]*) – Target basis names to unroll to, e.g. \[‘u3’, ‘cx’]. Ignored if `target` is also specified. * **target** (*Optional\[*[*Target*](qiskit.transpiler.Target "qiskit.transpiler.Target")*]*) – diff --git a/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.md b/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.md index 50801ebe0c..50de7019e3 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.UnrollForLoops.md @@ -10,13 +10,13 @@ python_api_name: qiskit.transpiler.passes.UnrollForLoops -`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/utils/unroll_forloops.py "view source code") +`qiskit.transpiler.passes.UnrollForLoops(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") `UnrollForLoops` transpilation pass unrolls for-loops when possible. -Things like `for x in {0, 3, 4} {rx(x) qr[1];}` will turn into `rx(0) qr[1]; rx(3) qr[1]; rx(4) qr[1];`. +Things like for x in \{0, 3, 4} \{rx(x) qr\[1];} will turn into rx(0) qr\[1]; rx(3) qr\[1]; rx(4) qr\[1];. The `UnrollForLoops` unrolls only one level of block depth. No inner loop will be considered by `max_target_depth`. @@ -86,7 +86,7 @@ Name of the pass. `run(dag)` -Run the UnrollForLoops pass on `dag`. +Run the UnrollForLoops pass on dag. **Parameters** diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/qiskit.transpiler.passes.Unroller.md index 1aa56be966..6d868e9cc0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Unroller.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Unroller -`qiskit.transpiler.passes.Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/basis/unroller.py "view source code") +`qiskit.transpiler.passes.Unroller(*args, **kwargs)` Bases: [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.md index 0ae039a6e7..13c9db5aae 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.VF2Layout.md @@ -10,11 +10,11 @@ python_api_name: qiskit.transpiler.passes.VF2Layout -`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") +`qiskit.transpiler.passes.VF2Layout(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") -A pass for choosing a Layout of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. +A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. If a solution is found that means there is a “perfect layout” and that no further swap mapping or routing is needed. If a solution is found the layout will be set in the property set as `property_set['layout']`. However, if no solution is found, no `property_set['layout']` is set. The stopping reason is set in `property_set['VF2Layout_stop_reason']` in all the cases and will be one of the values enumerated in `VF2LayoutStopReason` which has the following values: @@ -22,7 +22,7 @@ If a solution is found that means there is a “perfect layout” and that no fu > * `"nonexistent solution"`: If no perfect layout was found. > * `">2q gates in basis"`: If VF2Layout can’t work with basis -By default, this pass will construct a heuristic scoring map based on the error rates in the provided `target` (or `properties` if `target` is not provided). However, analysis passes can be run prior to this pass and set `vf2_avg_error_map` in the property set with a `ErrorMap` instance. If a value is `NaN` that is treated as an ideal edge For example if an error map is created as: +By default this pass will construct a heuristic scoring map based on the the error rates in the provided `target` (or `properties` if `target` is not provided). However, analysis passes can be run prior to this pass and set `vf2_avg_error_map` in the property set with a `ErrorMap` instance. If a value is `NaN` that is treated as an ideal edge For example if an error map is created as: ```python from qiskit.transpiler.passes.layout.vf2_utils import ErrorMap diff --git a/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.md index 293c33c0cb..dac143ce15 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.VF2PostLayout.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.VF2PostLayout -`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") +`qiskit.transpiler.passes.VF2PostLayout(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -24,7 +24,7 @@ If a solution is found that means there is a lower error layout available for th > * `"nonexistent solution"`: If no solution was found. > * `">2q gates in basis"`: If VF2PostLayout can’t work with basis -By default, this pass will construct a heuristic scoring map based on the error rates in the provided `target` (or `properties` if `target` is not provided). However, analysis passes can be run prior to this pass and set `vf2_avg_error_map` in the property set with a `ErrorMap` instance. If a value is `NaN` that is treated as an ideal edge For example if an error map is created as: +By default this pass will construct a heuristic scoring map based on the the error rates in the provided `target` (or `properties` if `target` is not provided). However, analysis passes can be run prior to this pass and set `vf2_avg_error_map` in the property set with a `ErrorMap` instance. If a value is `NaN` that is treated as an ideal edge For example if an error map is created as: ```python from qiskit.transpiler.passes.layout.vf2_utils import ErrorMap diff --git a/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md index 8f239a146a..baa72aacf0 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.ValidatePulseGates.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.ValidatePulseGates -`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") +`qiskit.transpiler.passes.ValidatePulseGates(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -20,7 +20,7 @@ This is a control electronics aware analysis pass. Quantum gates (instructions) are often implemented with shaped analog stimulus signals. These signals may be digitally stored in the waveform memory of the control electronics and converted into analog voltage signals by electronic components known as digital to analog converters (DAC). -In Qiskit SDK, we can define the pulse-level implementation of custom quantum gate instructions, as a [pulse gate](https://docs.quantum-computing.ibm.com/build/pulse), thus user gates should satisfy all waveform memory constraints imposed by the backend. +In Qiskit SDK, we can define the pulse-level implementation of custom quantum gate instructions, as a [pulse gate](https://qiskit.org/documentation/tutorials/circuits_advanced/05_pulse_gates.html), thus user gates should satisfy all waveform memory constraints imposed by the backend. This pass validates all attached calibration entries and raises `TranspilerError` to kill the transpilation process if any invalid calibration entry is found. This pass saves users from waiting until job execution time to get an invalid pulse error from the backend control electronics. diff --git a/docs/api/qiskit/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/qiskit.transpiler.passes.Width.md index ef8d06a9df..37040c9896 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.Width.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.Width -`qiskit.transpiler.passes.Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/analysis/width.py "view source code") +`qiskit.transpiler.passes.Width(*args, **kwargs)` Bases: [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index 32d0beb833..3049c0b82d 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index 4a61d2aeb0..58794b7b80 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlu -`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index d7e59f6c52..f88191d4ba 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index bbbdf419a4..a774ee7b1b 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugi -`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index ab2c85c404..e0d362ddef 100644 --- a/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -12,7 +12,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plu -`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/passes/synthesis/plugin.py "view source code") +`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()` Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index 5d851b2df1..68b2eb49f2 100644 --- a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index da676f4458..c15e891f4c 100644 --- a/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePl -`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.AQC.md index dadcc1891e..d0f1ee8176 100644 --- a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.AQC.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQC -`qiskit.transpiler.synthesis.aqc.AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") +`qiskit.transpiler.synthesis.aqc.AQC(optimizer=None, seed=None)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index 7e56c138be..2f4532fa66 100644 --- a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin -`qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") +`qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin` Bases: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") diff --git a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index 6f46b343ec..7eaa48fb6b 100644 --- a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit -`qiskit.transpiler.synthesis.aqc.ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`qiskit.transpiler.synthesis.aqc.ApproximateCircuit(num_qubits, name=None)` Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index 71ba4c7285..a7d72423f2 100644 --- a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective -`qiskit.transpiler.synthesis.aqc.ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") +`qiskit.transpiler.synthesis.aqc.ApproximatingObjective` Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index 4a14ed1d03..ccb6fd52b9 100644 --- a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit -`qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") +`qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` Bases: [`ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") diff --git a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index ecc72d0969..8e653e584c 100644 --- a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective -`qiskit.transpiler.synthesis.aqc.CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`qiskit.transpiler.synthesis.aqc.CNOTUnitObjective(num_qubits, cnots)` Bases: [`ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index 61decbe1cb..a6d1f0df87 100644 --- a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective -`qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") +`qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective(num_qubits, cnots)` Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md index f035b48f47..0ca58cc79a 100644 --- a/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md +++ b/docs/api/qiskit/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md @@ -10,7 +10,7 @@ python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective -`qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") +`qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective(num_qubits, cnots)` Bases: [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") diff --git a/docs/api/qiskit/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/qiskit.utils.QuantumInstance.md index 6fa86d4b23..b1cad179bf 100644 --- a/docs/api/qiskit/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/qiskit.utils.QuantumInstance.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.QuantumInstance -`qiskit.utils.QuantumInstance(backend, shots=None, seed_simulator=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/quantum_instance.py "view source code") +`qiskit.utils.QuantumInstance(backend, shots=None, seed_simulator=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/qiskit.utils.mitigation.CompleteMeasFitter.md index bef75b9f59..52fb6e71df 100644 --- a/docs/api/qiskit/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.CompleteMeasFitter -`qiskit.utils.mitigation.CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/mitigation/fitters.py "view source code") +`qiskit.utils.mitigation.CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/qiskit.utils.mitigation.TensoredMeasFitter.md index d980868491..8cf3d6cc87 100644 --- a/docs/api/qiskit/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -10,7 +10,7 @@ python_api_name: qiskit.utils.mitigation.TensoredMeasFitter -`qiskit.utils.mitigation.TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/mitigation/fitters.py "view source code") +`qiskit.utils.mitigation.TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/qiskit.visualization.array_to_latex.md index d20b3720d0..5d0d603a9c 100644 --- a/docs/api/qiskit/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/qiskit.visualization.array_to_latex.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.array_to_latex -`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/array.py "view source code") +`qiskit.visualization.array_to_latex(array, precision=10, prefix='', source=False, max_size=8)` Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/qiskit.visualization.circuit_drawer.md index bc36a259ce..e63161b748 100644 --- a/docs/api/qiskit/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/qiskit.visualization.circuit_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.circuit_drawer -`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None, expr_len=30)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/circuit/circuit_visualization.py "view source code") +`qiskit.visualization.circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None, expr_len=30)` Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -43,7 +43,7 @@ Draw the quantum circuit. Use the output parameter to choose the drawing format: * **idle\_wires** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – include idle wires (wires with no circuit elements) in output visualization. Default is True. * **with\_layout** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – include layout information, with labels on the physical layout. Default is True. * **fold** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – sets pagination. It can be disabled using -1. In text, sets the length of the lines. This is useful when the drawing does not fit in the console. If None (default), it will try to guess the console width using `shutil.get_terminal_size()`. However, if running in jupyter, the default line length is set to 80 characters. In mpl, it is the number of (visual) layers before folding. Default is 25. -* **ax** ([*matplotlib.axes.Axes*](https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes "(in Matplotlib v3.8.2)")) – Only used by the mpl backend. 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.8.1)")) – Only used by the mpl backend. 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. * **initial\_state** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Optional. Adds `|0>` in the beginning of the wire. Default is False. * **cregbundle** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Optional. If set True, bundle classical registers into a single wire. Default is true if possible, and false if a block instruction needs to access an individual bit from a register. * **wire\_order** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – Optional. A list of integers used to reorder the display of the bits. The list must have an entry for every bit with the bits in the range 0 to (num\_qubits + num\_clbits). diff --git a/docs/api/qiskit/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/qiskit.visualization.dag_drawer.md index 1aad2eb1a6..43268e536d 100644 --- a/docs/api/qiskit/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/qiskit.visualization.dag_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.dag_drawer -`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/dag_visualization.py "view source code") +`qiskit.visualization.dag_drawer(dag, scale=0.7, filename=None, style='color')` Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.md index 8699659c48..c4652e1bfe 100644 --- a/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/qiskit.visualization.pass_manager_drawer.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.pass_manager_drawer -`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pass_manager_visualization.py "view source code") +`qiskit.visualization.pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` Draws the pass manager. diff --git a/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.md index 39b18bfd40..600d77c3ab 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/qiskit.visualization.plot_bloch_multivector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_multivector -`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_multivector(state, title='', figsize=None, *, reverse_bits=False, filename=None, font_size=None, title_font_size=None, title_pad=1)` Plot a Bloch sphere for each qubit. @@ -34,7 +34,7 @@ A matplotlib figure instance. **Return type** -[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.2)") +[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.1)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.md index d9df3e6165..e15f59140a 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/qiskit.visualization.plot_bloch_vector.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_bloch_vector -`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian', font_size=None)` Plot the Bloch sphere. @@ -22,7 +22,7 @@ Plot a Bloch sphere with the specified coordinates, that can be given in both ca * **bloch** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[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.12)")) – 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.8.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.8.1)")) – An Axes to use for rendering the bloch sphere * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – 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.12)")) – 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.12)")) – Font size. @@ -33,7 +33,7 @@ A matplotlib figure instance if `ax = None`. **Return type** -[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.2)") +[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.1)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.md index 44a87edcb5..3de503f9a3 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/qiskit.visualization.plot_circuit_layout.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_circuit_layout -`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/qiskit.visualization.plot_coupling_map.md index 6de9b2d6b8..a14d3e9d90 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/qiskit.visualization.plot_coupling_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_coupling_map -`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None)` Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/qiskit.visualization.plot_distribution.md index 91ee393a38..b2e2558a04 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/qiskit.visualization.plot_distribution.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_distribution -`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` Plot a distribution from input sampled data. @@ -27,7 +27,7 @@ Plot a distribution from input sampled data. * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – 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.12)")) – Label each bar in histogram with probability value. * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – 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.8.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.8.1)")) – 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.12)")) – file path to save image to. **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/qiskit.visualization.plot_error_map.md index 8a94a2f00e..30f8556473 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/qiskit.visualization.plot_error_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_error_map -`qiskit.visualization.plot_error_map(backend, figsize=(15, 12), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_error_map(backend, figsize=(15, 12), show_title=True, qubit_coordinates=None)` Plots the error map of a given backend. diff --git a/docs/api/qiskit/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/qiskit.visualization.plot_gate_map.md index 55ba1a9f97..c4d5b7e5e2 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/qiskit.visualization.plot_gate_map.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_gate_map -`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/gate_map.py "view source code") +`qiskit.visualization.plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='white', ax=None, filename=None, qubit_coordinates=None)` Plots the gate map of a device. diff --git a/docs/api/qiskit/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/qiskit.visualization.plot_histogram.md index bbc6be5251..f02e42b21a 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/qiskit.visualization.plot_histogram.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_histogram -`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/counts_visualization.py "view source code") +`qiskit.visualization.plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` Plot a histogram of input counts data. @@ -31,7 +31,7 @@ Plot a histogram of input counts data. * **legend** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – 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.12)")) – Label each bar in histogram with counts value. * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – 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.8.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.8.1)")) – 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.12)")) – file path to save image to. **Returns** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/qiskit.visualization.plot_state_city.md index 7571608422..078537375d 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/qiskit.visualization.plot_state_city.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_city -`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, filename=None)` Plot the cityscape of quantum state. @@ -25,8 +25,8 @@ Plot two 3d bar graphs (two dimensional) of the real and imaginary part of the d * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – Figure size in inches. * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – 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.12)")) – 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.8.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.8.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.8.1)")) – 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.8.1)")) – 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** @@ -34,7 +34,7 @@ The matplotlib.Figure of the visualization if the `ax_real` and `ax_imag` kwargs **Return type** -[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.2)") +[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.1)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/qiskit.visualization.plot_state_hinton.md index 3039665a10..362e9bcc79 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/qiskit.visualization.plot_state_hinton.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_hinton -`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, filename=None)` Plot a hinton diagram for the density matrix of a quantum state. @@ -24,8 +24,8 @@ The hinton diagram represents the values of a matrix using squares, whose size i * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – a string that represents the plot title * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – Figure size in inches. * **filename** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – 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.8.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.8.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.8.1)")) – 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.8.1)")) – 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** @@ -33,7 +33,7 @@ The matplotlib.Figure of the visualization if neither ax\_real or ax\_imag is se **Return type** -[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.2)") +[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.1)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.md index 7eeafde31e..13c6e08be7 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/qiskit.visualization.plot_state_paulivec.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_paulivec -`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, filename=None)` Plot the Pauli-vector representation of a quantum state as bar graph. @@ -31,7 +31,7 @@ This function plots the coefficients $\mathrm{Tr}(\sigma\rho)$ as bar graph. * **title** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – a string that represents the plot title * **figsize** ([*tuple*](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")) – Figure size in inches. * **color** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)") *or*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – 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.8.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.8.1)")) – 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** @@ -39,7 +39,7 @@ The matplotlib.Figure of the visualization if the `ax` kwarg is not set **Return type** -[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.2)") +[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.1)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.md index 26faec1518..ec8de18755 100644 --- a/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/qiskit.visualization.plot_state_qsphere.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.plot_state_qsphere -`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/state_visualization.py "view source code") +`qiskit.visualization.plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, filename=None)` Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. @@ -20,7 +20,7 @@ Plot the qsphere representation of a quantum state. Here, the size of the points * **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.12)")) – 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.8.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.8.1)")) – 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.12)")) – 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.12)")) – 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.12)")) – An optional boolean indicating whether to use radians or degrees for the phase values in the plot. @@ -31,7 +31,7 @@ A matplotlib figure instance if the `ax` kwarg is not set **Return type** -[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.2)") +[`matplotlib.figure.Figure`](https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure "(in Matplotlib v3.8.1)") **Raises** diff --git a/docs/api/qiskit/qiskit.visualization.pulse.IQXDebugging.md b/docs/api/qiskit/qiskit.visualization.pulse.IQXDebugging.md index 52703719c9..0fdcc4d919 100644 --- a/docs/api/qiskit/qiskit.visualization.pulse.IQXDebugging.md +++ b/docs/api/qiskit/qiskit.visualization.pulse.IQXDebugging.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXDebugging -`qiskit.visualization.pulse.IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXDebugging(**kwargs)` Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.visualization.pulse.IQXSimple.md b/docs/api/qiskit/qiskit.visualization.pulse.IQXSimple.md index 9dfe01b6c8..151fd049ab 100644 --- a/docs/api/qiskit/qiskit.visualization.pulse.IQXSimple.md +++ b/docs/api/qiskit/qiskit.visualization.pulse.IQXSimple.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXSimple -`qiskit.visualization.pulse.IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXSimple(**kwargs)` Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.visualization.pulse.IQXStandard.md b/docs/api/qiskit/qiskit.visualization.pulse.IQXStandard.md index 44fe10a690..d357ddbcfc 100644 --- a/docs/api/qiskit/qiskit.visualization.pulse.IQXStandard.md +++ b/docs/api/qiskit/qiskit.visualization.pulse.IQXStandard.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.pulse.IQXStandard -`qiskit.visualization.pulse.IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/pulse_v2/stylesheet.py "view source code") +`qiskit.visualization.pulse.IQXStandard(**kwargs)` Bases: [`dict`](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/qiskit.visualization.qcstyle.DefaultStyle.md index e8b1d4b47e..9de6795790 100644 --- a/docs/api/qiskit/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/qiskit.visualization.qcstyle.DefaultStyle.md @@ -10,7 +10,7 @@ python_api_name: qiskit.visualization.qcstyle.DefaultStyle -`qiskit.visualization.qcstyle.DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/circuit/qcstyle.py "view source code") +`qiskit.visualization.qcstyle.DefaultStyle` Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") diff --git a/docs/api/qiskit/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/qiskit.visualization.visualize_transition.md index 4e1d038eac..224f08abca 100644 --- a/docs/api/qiskit/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/qiskit.visualization.visualize_transition.md @@ -12,7 +12,7 @@ python_api_name: qiskit.visualization.visualize_transition -`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/transition_visualization.py "view source code") +`qiskit.visualization.visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/qobj.md b/docs/api/qiskit/qobj.md index 8f12c528eb..cb06897e1a 100644 --- a/docs/api/qiskit/qobj.md +++ b/docs/api/qiskit/qobj.md @@ -29,23 +29,23 @@ python_api_name: qiskit.qobj | | | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj")(\[qobj\_id, config, experiments, header]) | An OpenQASM 2 Qobj. | -| [`QasmQobjInstruction`](qiskit.qobj.QasmQobjInstruction "qiskit.qobj.QasmQobjInstruction")(name\[, params, qubits, ...]) | A class representing a single instruction in an QasmQobj Experiment. | -| [`QasmQobjExperimentConfig`](qiskit.qobj.QasmQobjExperimentConfig "qiskit.qobj.QasmQobjExperimentConfig")(\[calibrations, ...]) | Configuration for a single OpenQASM 2 experiment in the qobj. | -| [`QasmQobjExperiment`](qiskit.qobj.QasmQobjExperiment "qiskit.qobj.QasmQobjExperiment")(\[config, header, ...]) | An OpenQASM 2 Qobj Experiment. | -| [`QasmQobjConfig`](qiskit.qobj.QasmQobjConfig "qiskit.qobj.QasmQobjConfig")(\[shots, seed\_simulator, ...]) | A configuration for an OpenQASM 2 Qobj. | +| [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj")(\[qobj\_id, config, experiments, header]) | An OpenQASM 2 Qobj. | +| [`QasmQobjInstruction`](qiskit.qobj.QasmQobjInstruction "qiskit.qobj.QasmQobjInstruction")(name\[, params, qubits, ...]) | A class representing a single instruction in an QasmQobj Experiment. | +| [`QasmQobjExperimentConfig`](qiskit.qobj.QasmQobjExperimentConfig "qiskit.qobj.QasmQobjExperimentConfig")(\[calibrations, ...]) | Configuration for a single OpenQASM 2 experiment in the qobj. | +| [`QasmQobjExperiment`](qiskit.qobj.QasmQobjExperiment "qiskit.qobj.QasmQobjExperiment")(\[config, header, ...]) | An OpenQASM 2 Qobj Experiment. | +| [`QasmQobjConfig`](qiskit.qobj.QasmQobjConfig "qiskit.qobj.QasmQobjConfig")(\[shots, seed\_simulator, ...]) | A configuration for an OpenQASM 2 Qobj. | | [`QasmExperimentCalibrations`](qiskit.qobj.QasmExperimentCalibrations "qiskit.qobj.QasmExperimentCalibrations")(gates) | A container for any calibrations data. | -| [`GateCalibration`](qiskit.qobj.GateCalibration "qiskit.qobj.GateCalibration")(name, qubits, params, ...) | Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. | +| [`GateCalibration`](qiskit.qobj.GateCalibration "qiskit.qobj.GateCalibration")(name, qubits, params, ...) | Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. | ## Pulse | | | | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`PulseQobj`](qiskit.qobj.PulseQobj "qiskit.qobj.PulseQobj")(qobj\_id, config, experiments\[, header]) | A Pulse Qobj. | -| [`PulseQobjInstruction`](qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction")(name, t0\[, ch, ...]) | A class representing a single instruction in an PulseQobj Experiment. | -| [`PulseQobjExperimentConfig`](qiskit.qobj.PulseQobjExperimentConfig "qiskit.qobj.PulseQobjExperimentConfig")(\[qubit\_lo\_freq, ...]) | A config for a single Pulse experiment in the qobj. | -| [`PulseQobjExperiment`](qiskit.qobj.PulseQobjExperiment "qiskit.qobj.PulseQobjExperiment")(instructions\[, config, ...]) | A Pulse Qobj Experiment. | -| [`PulseQobjConfig`](qiskit.qobj.PulseQobjConfig "qiskit.qobj.PulseQobjConfig")(meas\_level, meas\_return, ...) | A configuration for a Pulse Qobj. | -| [`QobjMeasurementOption`](qiskit.qobj.QobjMeasurementOption "qiskit.qobj.QobjMeasurementOption")(name\[, params]) | An individual measurement option. | -| [`PulseLibraryItem`](qiskit.qobj.PulseLibraryItem "qiskit.qobj.PulseLibraryItem")(name, samples) | An item in a pulse library. | +| [`PulseQobj`](qiskit.qobj.PulseQobj "qiskit.qobj.PulseQobj")(qobj\_id, config, experiments\[, header]) | A Pulse Qobj. | +| [`PulseQobjInstruction`](qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction")(name, t0\[, ch, ...]) | A class representing a single instruction in an PulseQobj Experiment. | +| [`PulseQobjExperimentConfig`](qiskit.qobj.PulseQobjExperimentConfig "qiskit.qobj.PulseQobjExperimentConfig")(\[qubit\_lo\_freq, ...]) | A config for a single Pulse experiment in the qobj. | +| [`PulseQobjExperiment`](qiskit.qobj.PulseQobjExperiment "qiskit.qobj.PulseQobjExperiment")(instructions\[, config, ...]) | A Pulse Qobj Experiment. | +| [`PulseQobjConfig`](qiskit.qobj.PulseQobjConfig "qiskit.qobj.PulseQobjConfig")(meas\_level, meas\_return, ...) | A configuration for a Pulse Qobj. | +| [`QobjMeasurementOption`](qiskit.qobj.QobjMeasurementOption "qiskit.qobj.QobjMeasurementOption")(name\[, params]) | An individual measurement option. | +| [`PulseLibraryItem`](qiskit.qobj.PulseLibraryItem "qiskit.qobj.PulseLibraryItem")(name, samples) | An item in a pulse library. | diff --git a/docs/api/qiskit/qpy.md b/docs/api/qiskit/qpy.md index 5bcb9482ea..b7e14c1bdc 100644 --- a/docs/api/qiskit/qpy.md +++ b/docs/api/qiskit/qpy.md @@ -57,7 +57,7 @@ and then loading that file will return a list with all the circuits -`qiskit.qpy.load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.load(file_obj, metadata_deserializer=None)` Load a QPY binary file @@ -102,7 +102,7 @@ The list of Qiskit programs contained in the QPY data. A list is always returned -`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None, use_symengine=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qpy/interface.py "view source code") +`qiskit.qpy.dump(programs, file_obj, metadata_serializer=None, use_symengine=False)` Write QPY binary data to a file @@ -154,7 +154,7 @@ These functions will raise a custom subclass of [`QiskitError`](exceptions#qiski -`qiskit.qpy.QpyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/qpy/exceptions.py "view source code") +`qiskit.qpy.QpyError(*message)` Errors raised by the qpy module. @@ -439,7 +439,7 @@ The only change compared to [Version 5](#qpy-version-5) is the addition of class Version 5 changes from [Version 4](#qpy-version-4) by adding support for `ScheduleBlock` and changing two payloads the INSTRUCTION metadata payload and the CUSTOM\_INSTRUCTION block. These now have new fields to better account for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects in a circuit. In addition, new payload MAP\_ITEM is defined to implement the [MAPPING](#qpy-mapping) block. -With the support of `ScheduleBlock`, now [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") can be serialized together with [`calibrations`](qiskit.circuit.QuantumCircuit#calibrations "qiskit.circuit.QuantumCircuit.calibrations"), or [Pulse Gates](https://docs.quantum-computing.ibm.com/build/pulse). In QPY version 5 and above, [CIRCUIT\_CALIBRATIONS](#qpy-circuit-calibrations) payload is packed after the [INSTRUCTIONS](#qpy-instructions) block. +With the support of `ScheduleBlock`, now [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") can be serialized together with [`calibrations`](qiskit.circuit.QuantumCircuit#calibrations "qiskit.circuit.QuantumCircuit.calibrations"), or [Pulse Gates](https://qiskit.org/documentation/tutorials/circuits_advanced/05_pulse_gates.html). In QPY version 5 and above, [CIRCUIT\_CALIBRATIONS](#qpy-circuit-calibrations) payload is packed after the [INSTRUCTIONS](#qpy-instructions) block. In QPY version 5 and above, diff --git a/docs/api/qiskit/quantum_info.md b/docs/api/qiskit/quantum_info.md index 68204a153c..2c48c9c406 100644 --- a/docs/api/qiskit/quantum_info.md +++ b/docs/api/qiskit/quantum_info.md @@ -24,14 +24,14 @@ python_api_name: qiskit.quantum_info | | | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")(data\[, input\_dims, output\_dims]) | Matrix operator class | +| [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")(data\[, input\_dims, output\_dims]) | Matrix operator class | | [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")(\[data]) | N-qubit Pauli operator. | -| [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")(data\[, validate, copy]) | An N-qubit unitary operator from the Clifford group. | -| [`ScalarOp`](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")(\[dims, coeff]) | Scalar identity operator class. | -| [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")(data\[, coeffs, ...]) | Sparse N-qubit operator in a Pauli basis representation. | -| [`CNOTDihedral`](qiskit.quantum_info.CNOTDihedral "qiskit.quantum_info.CNOTDihedral")(\[data, num\_qubits, validate]) | An N-qubit operator from the CNOT-Dihedral group. | +| [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")(data\[, validate, copy]) | An N-qubit unitary operator from the Clifford group. | +| [`ScalarOp`](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")(\[dims, coeff]) | Scalar identity operator class. | +| [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")(data\[, coeffs, ...]) | Sparse N-qubit operator in a Pauli basis representation. | +| [`CNOTDihedral`](qiskit.quantum_info.CNOTDihedral "qiskit.quantum_info.CNOTDihedral")(\[data, num\_qubits, validate]) | An N-qubit operator from the CNOT-Dihedral group. | | [`PauliList`](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")(data) | List of N-qubit Pauli operators. | -| [`pauli_basis`](qiskit.quantum_info.pauli_basis "qiskit.quantum_info.pauli_basis")(num\_qubits\[, weight]) | Return the ordered PauliList for the n-qubit Pauli basis. | +| [`pauli_basis`](qiskit.quantum_info.pauli_basis "qiskit.quantum_info.pauli_basis")(num\_qubits\[, weight]) | Return the ordered PauliList for the n-qubit Pauli basis. | @@ -39,38 +39,36 @@ python_api_name: qiskit.quantum_info | | | | ----------------------------------------------------------------------------------------------------------------- | ---------------------- | -| [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")(data\[, dims]) | Statevector class | -| [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")(data\[, dims]) | DensityMatrix class | -| [`StabilizerState`](qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState")(data\[, validate]) | StabilizerState class. | +| [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")(data\[, dims]) | Statevector class | +| [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")(data\[, dims]) | DensityMatrix class | +| [`StabilizerState`](qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState")(data\[, validate]) | StabilizerState class. | ## Channels | | | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| [`Choi`](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi")(data\[, input\_dims, output\_dims]) | Choi-matrix representation of a Quantum Channel. | -| [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp")(data\[, input\_dims, output\_dims]) | Superoperator representation of a quantum channel. | -| [`Kraus`](qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus")(data\[, input\_dims, output\_dims]) | Kraus representation of a quantum channel. | -| [`Stinespring`](qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring")(data\[, input\_dims, output\_dims]) | Stinespring representation of a quantum channel. | -| [`Chi`](qiskit.quantum_info.Chi "qiskit.quantum_info.Chi")(data\[, input\_dims, output\_dims]) | Pauli basis Chi-matrix representation of a quantum channel. | -| [`PTM`](qiskit.quantum_info.PTM "qiskit.quantum_info.PTM")(data\[, input\_dims, output\_dims]) | Pauli Transfer Matrix (PTM) representation of a Quantum Channel. | +| [`Choi`](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi")(data\[, input\_dims, output\_dims]) | Choi-matrix representation of a Quantum Channel. | +| [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp")(data\[, input\_dims, output\_dims]) | Superoperator representation of a quantum channel. | +| [`Kraus`](qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus")(data\[, input\_dims, output\_dims]) | Kraus representation of a quantum channel. | +| [`Stinespring`](qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring")(data\[, input\_dims, output\_dims]) | Stinespring representation of a quantum channel. | +| [`Chi`](qiskit.quantum_info.Chi "qiskit.quantum_info.Chi")(data\[, input\_dims, output\_dims]) | Pauli basis Chi-matrix representation of a quantum channel. | +| [`PTM`](qiskit.quantum_info.PTM "qiskit.quantum_info.PTM")(data\[, input\_dims, output\_dims]) | Pauli Transfer Matrix (PTM) representation of a Quantum Channel. | ## Measures -`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` Return the average gate fidelity of a noisy quantum channel. The average gate fidelity $F_{\text{ave}}$ is given by $$ -F_{\text{ave}}(\mathcal{E}, U) +\begin{split}F_{\text{ave}}(\mathcal{E}, U) &= \int d\psi \langle\psi|U^\dagger \mathcal{E}(|\psi\rangle\!\langle\psi|)U|\psi\rangle \\ - &= \frac{d F_{\text{pro}}(\mathcal{E}, U) + 1}{d + 1} - - + &= \frac{d F_{\text{pro}}(\mathcal{E}, U) + 1}{d + 1}\end{split} $$ where $F_{\text{pro}}(\mathcal{E}, U)$ is the [`process_fidelity()`](#qiskit.quantum_info.process_fidelity "qiskit.quantum_info.process_fidelity") of the input quantum *channel* $\mathcal{E}$ with a *target* unitary $U$, and $d$ is the dimension of the *channel*. @@ -96,7 +94,7 @@ The average gate fidelity $F_{\text{ave}}$. -`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.process_fidelity(channel, target=None, require_cp=True, require_tp=True)` Return the process fidelity of a noisy quantum channel. @@ -105,8 +103,6 @@ The process fidelity $F_{\text{pro}}(\mathcal{E}, \mathcal{F})$ between two quan $$ F_{\text{pro}}(\mathcal{E}, \mathcal{F}) = F(\rho_{\mathcal{E}}, \rho_{\mathcal{F}}) - - $$ where $F$ is the [`state_fidelity()`](#qiskit.quantum_info.state_fidelity "qiskit.quantum_info.state_fidelity"), $\rho_{\mathcal{E}} = \Lambda_{\mathcal{E}} / d$ is the normalized [`Choi`](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") matrix for the channel $\mathcal{E}$, and $d$ is the input dimension of $\mathcal{E}$. @@ -116,8 +112,6 @@ When the target channel is unitary this is equivalent to $$ F_{\text{pro}}(\mathcal{E}, U) = \frac{Tr[S_U^\dagger S_{\mathcal{E}}]}{d^2} - - $$ where $S_{\mathcal{E}}, S_{U}$ are the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") matrices for the *input* quantum channel $\mathcal{E}$ and *target* unitary $U$ respectively, and $d$ is the input dimension of the channel. @@ -143,7 +137,7 @@ The process fidelity $F_{\text{pro}}$. -`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.gate_error(channel, target=None, require_cp=True, require_tp=False)` Return the gate error of a noisy quantum channel. @@ -151,8 +145,6 @@ The gate error $E$ is given by the average gate infidelity $$ E(\mathcal{E}, U) = 1 - F_{\text{ave}}(\mathcal{E}, U) - - $$ where $F_{\text{ave}}(\mathcal{E}, U)$ is the [`average_gate_fidelity()`](#qiskit.quantum_info.average_gate_fidelity "qiskit.quantum_info.average_gate_fidelity") of the input quantum *channel* $\mathcal{E}$ with a *target* unitary $U$. @@ -178,7 +170,7 @@ The average gate error $E$. -`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/measures.py "view source code") +`qiskit.quantum_info.diamond_norm(choi, solver='SCS', **kwargs)` Return the diamond norm of the input quantum channel object. @@ -216,7 +208,7 @@ J. Watrous. “Simpler semidefinite programs for completely bounded norms”, ar -`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.state_fidelity(state1, state2, validate=True)` Return the state fidelity between two quantum states. @@ -224,8 +216,6 @@ The state fidelity $F$ for density matrix input states $\rho_1, \rho_2$ is given $$ F(\rho_1, \rho_2) = Tr[\sqrt{\sqrt{\rho_1}\rho_2\sqrt{\rho_1}}]^2. - - $$ If one of the states is a pure state this simplifies to $F(\rho_1, \rho_2) = \langle\psi_1|\rho_2|\psi_1\rangle$, where $\rho_1 = |\psi_1\rangle\!\langle\psi_1|$. @@ -250,7 +240,7 @@ The state fidelity $F(\rho_1, \rho_2)$. -`qiskit.quantum_info.purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.purity(state, validate=True)` Calculate the purity of a quantum state. @@ -279,7 +269,7 @@ the purity $Tr[\rho^2]$. -`qiskit.quantum_info.concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.concurrence(state)` Calculate the concurrence of a quantum state. @@ -319,7 +309,7 @@ The concurrence. -`qiskit.quantum_info.entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entropy(state, base=2)` Calculate the von-Neumann entropy of a quantum state. @@ -348,7 +338,7 @@ The von-Neumann entropy S(rho). -`qiskit.quantum_info.entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.entanglement_of_formation(state)` Calculate the entanglement of formation of quantum state. @@ -374,7 +364,7 @@ The entanglement of formation. -`qiskit.quantum_info.mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/measures.py "view source code") +`qiskit.quantum_info.mutual_information(state, base=2)` Calculate the mutual information of a bipartite state. @@ -408,7 +398,7 @@ The mutual information $I(\rho_{AB})$. -`qiskit.quantum_info.partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.partial_trace(state, qargs)` Return reduced density matrix by tracing out part of quantum state. @@ -433,7 +423,7 @@ The reduced density matrix. -`qiskit.quantum_info.schmidt_decomposition(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.schmidt_decomposition(state, qargs)` Return the Schmidt Decomposition of a pure quantum state. @@ -442,8 +432,6 @@ For an arbitrary bipartite state: $$ |\psi\rangle_{AB} = \sum_{i,j} c_{ij} |x_i\rangle_A \otimes |y_j\rangle_B, - - $$ its Schmidt Decomposition is given by the single-index sum over k: @@ -451,8 +439,6 @@ its Schmidt Decomposition is given by the single-index sum over k: $$ |\psi\rangle_{AB} = \sum_{k} \lambda_{k} |u_k\rangle_A \otimes |v_k\rangle_B - - $$ where $|u_k\rangle_A$ and $|v_k\rangle_B$ are an orthonormal set of vectors in their respective spaces $A$ and $B$, and the Schmidt coefficients $\lambda_k$ are positive real values. @@ -481,7 +467,7 @@ list of tuples `(s, u, v)`, where `s` (float) are the Schmidt coefficients $\lam -`qiskit.quantum_info.shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/utils.py "view source code") +`qiskit.quantum_info.shannon_entropy(pvec, base=2)` Compute the Shannon entropy of a probability vector. @@ -508,7 +494,7 @@ The Shannon entropy H(pvec). -`qiskit.quantum_info.commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/utils/commutator.py "view source code") +`qiskit.quantum_info.commutator(a, b)` Compute commutator of a and b. @@ -531,7 +517,7 @@ The commutator -`qiskit.quantum_info.anti_commutator(a, b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/utils/anti_commutator.py "view source code") +`qiskit.quantum_info.anti_commutator(a, b)` Compute anti-commutator of a and b. @@ -554,7 +540,7 @@ The anti-commutator -`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/utils/double_commutator.py "view source code") +`qiskit.quantum_info.double_commutator(a, b, c, *, commutator=True)` Compute symmetric double commutator of a, b and c. @@ -572,8 +558,6 @@ If commutator is False, it returns $$ \lbrace[A, B], C\rbrace/2 + \lbrace A, [B, C]\rbrace/2 = (2ABC - 2CBA - BAC + CAB - ACB + BCA)/2. - - $$ **Parameters** @@ -601,7 +585,7 @@ Methods of Molecular Quantum Mechanics. 2nd Edition, Academic Press, 1992. ISBN -`qiskit.quantum_info.random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_statevector(dims, seed=None)` Generator a random Statevector. @@ -626,7 +610,7 @@ K. Zyczkowski and H. Sommers (2001), “Induced measures in the space of mixed q -`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/states/random.py "view source code") +`qiskit.quantum_info.random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` Generator a random DensityMatrix. @@ -651,7 +635,7 @@ the random density matrix. -`qiskit.quantum_info.random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_unitary(dims, seed=None)` Return a random unitary Operator. @@ -672,7 +656,7 @@ a unitary operator. -`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_hermitian(dims, traceless=False, seed=None)` Return a random hermitian Operator. @@ -694,7 +678,7 @@ a Hermitian operator. -`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli(num_qubits, group_phase=False, seed=None)` Return a random Pauli. @@ -714,7 +698,7 @@ a random Pauli -`qiskit.quantum_info.random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_clifford(num_qubits, seed=None)` Return a random Clifford operator. @@ -739,7 +723,7 @@ a random Clifford operator. -`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/random.py "view source code") +`qiskit.quantum_info.random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` Return a random CPTP quantum channel. @@ -766,7 +750,7 @@ a quantum channel operator. -`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/dihedral/random.py "view source code") +`qiskit.quantum_info.random_cnotdihedral(num_qubits, seed=None)` Return a random CNOTDihedral element. @@ -785,7 +769,7 @@ a random CNOTDihedral element. -`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/operators/symplectic/random.py "view source code") +`qiskit.quantum_info.random_pauli_list(num_qubits, size=1, seed=None, phase=True)` Return a random PauliList. @@ -808,7 +792,7 @@ a random PauliList. -`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_distance(dist_p, dist_q)` Computes the Hellinger distance between two counts distributions. @@ -831,7 +815,7 @@ Distance -`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/analysis/distance.py "view source code") +`qiskit.quantum_info.hellinger_fidelity(dist_p, dist_q)` Computes the Hellinger fidelity between two counts distributions. @@ -879,16 +863,16 @@ hellinger_fidelity(res1.get_counts(), res2.get_counts()) | | | | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`Z2Symmetries`](qiskit.quantum_info.Z2Symmetries "qiskit.quantum_info.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | The \$Z\_2\$ symmetry converter identifies symmetries from the problem hamiltonian and uses them to provide a tapered - more efficient - representation of operators as Paulis for this problem. | +| [`Z2Symmetries`](qiskit.quantum_info.Z2Symmetries "qiskit.quantum_info.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | The \$Z\_2\$ symmetry converter identifies symmetries from the problem hamiltonian and uses them to provide a tapered - more efficient - representation of operators as Paulis for this problem. | ## Synthesis | | | | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis, use\_dag]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis, use\_dag]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | | [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[basis\_fidelity, euler\_basis, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | +| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[basis\_fidelity, euler\_basis, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | @@ -900,7 +884,7 @@ hellinger_fidelity(res1.get_counts(), res2.get_counts()) -`qiskit.quantum_info.decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") +`qiskit.quantum_info.decompose_clifford(clifford, method=None)` DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/release-notes/0.45.md b/docs/api/qiskit/release-notes/0.45.md index c6c84f8f01..a3193ed273 100644 --- a/docs/api/qiskit/release-notes/0.45.md +++ b/docs/api/qiskit/release-notes/0.45.md @@ -16,132 +16,60 @@ This page contains the release notes for Qiskit 0.45, the first release after th -## 0.45.1-18 - - - -### Bug Fixes - -* Calling [`copy()`](/api/qiskit/qiskit.circuit.QuantumCircuit#copy "qiskit.circuit.QuantumCircuit.copy") or [`copy_empty_like()`](/api/qiskit/qiskit.circuit.QuantumCircuit#copy_empty_like "qiskit.circuit.QuantumCircuit.copy_empty_like") on a :class:¬.BlueprintCircuit\` will now correctly propagate the [`global_phase`](/api/qiskit/qiskit.circuit.QuantumCircuit#global_phase "qiskit.circuit.QuantumCircuit.global_phase") to the copy. Previously, the global phase would always be zero after the copy. - -* Fixed an issue in the `mpl` circuit drawer where the text would print beyond the end of the box for a [`SwitchCaseOp`](/api/qiskit/qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") if the default case was empty. - -* The qubit-argument broadcasting of [`QuantumCircuit.delay()`](/api/qiskit/qiskit.circuit.QuantumCircuit#delay "qiskit.circuit.QuantumCircuit.delay") now correctly produces individual [`Delay`](/api/qiskit/qiskit.circuit.Delay "qiskit.circuit.Delay") instructions for each qubit, as intended. Previously, when given certain iterables (such as [`set`](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.12)")s), it would instead silently produce an invalid circuit that might fail in unusual locations. - -* Fixed an issue with the [`Optimize1qGatesDecomposition`](/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition") transpiler pass where it would potentially resynthesize a single ideal (meaning the error rate is `0.0`) gate which was present in the [`Target`](/api/qiskit/qiskit.transpiler.Target "qiskit.transpiler.Target"). This is now fixed so the pass [`Optimize1qGatesDecomposition`](/api/qiskit/qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition") will defer to the circuit’s gate if the error rate (which includes number of gates) are the same. Fixed [#10568](https://github.com/Qiskit/qiskit/issues/10568) - -* Fixed an issue with the `OptimizeSwapBeforeMeasure` pass where it would incorrectly optimize circuits involving swap and measure instructions. This commit fixes the bug by changing DAGCircuit.successors to DAGCircuit.descendants. Also, added a couple of extra tests to ensure that the bug is fixed. For example: - - ```python - from qiskit import QuantumCircuit - from qiskit.transpiler.passes import OptimizeSwapBeforeMeasure - pass_ = OptimizeSwapBeforeMeasure() - qc = QuantumCircuit(2, 1) - qc.swap(0, 1) - qc.measure(0, 0) - qc.measure(0, 0) - print(qc.draw()) - print(pass_(qc).draw()) - ``` - - would previously print: - - ```python - ┌─┐┌─┐ - q_0: ─X─┤M├┤M├ - │ └╥┘└╥┘ - q_1: ─X──╫──╫─ - ║ ║ - c: 1/════╩══╩═ - 0 0 - ┌─┐ - q_0: ┤M├─── - └╥┘┌─┐ - q_1: ─╫─┤M├ - ║ └╥┘ - c: 1/═╩══╩═ - 0 0 - ``` - - and now the second ciruit is correctly optimized to: - - ```python - q_0: ────── - ┌─┐┌─┐ - q_1: ┤M├┤M├ - └╥┘└╥┘ - c: 1/═╩══╩═ - 0 0 - ``` - -* Fix a bug in the [`StabilizerState`](/api/qiskit/qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState") string representation. - - - - - -## 0.45.1 +## 0.45.0 - + ### Prelude -Qiskit Terra 0.45.1 is a small patch release, fixing several bugs found in the 0.45 release series. It is also the first release to have official support for Python 3.12. The 0.45.1 release supports Python 3.8, 3.9, 3.10, 3.11, and 3.12. - - +Qiskit 0.45.0 is the last feature release before 1.0. It prepares the ground for the API changes we are planning for our first major version release, including many removals of previously deprecated functionality as well as a series of new deprecations. -### New Features + + If your project depends on Qiskit, it may rely on functionality that will no longer be supported in Qiskit 1.0. For this reason, we recommend that you proactively cap your supported version to `<1.0`. + -* Added support for using Qiskit with Python 3.12. As of this release Qiskit supports running with Python versions 3.8, 3.9, 3.10, 3.11, and 3.12. +Some feature highlights of Qiskit 0.45.0 are: - +* Starting in this release, all unparametrized gates in the Qiskit standard circuit library are now **singletons**. By default, these gates share a single instance in memory, so once a gate of a specific type, let’s say [`XGate`](/api/qiskit/qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"), is instantiated, any subsequent instances of [`XGate`](/api/qiskit/qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") will be a reference to the first one. This results in a reduced memory usage and construction overhead when using multiple gates of the same type in a circuit. To realize this feature, new base classes have been introduced: [`SingletonInstruction`](/api/qiskit/circuit_singleton#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") and [`SingletonGate`](/api/qiskit/circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate"). See feature notes for more details. +* We have added a new **generic pass manager interface** that can be found in the new [`qiskit.passmanager`](/api/qiskit/passmanager#module-qiskit.passmanager "qiskit.passmanager") module. This is a generalization of the pass manager that was used to build the Qiskit transpiler, and it introduces a generic framework to enable users to create new pass managers that use different intermediate representations (IRs). The module includes a generic pass manager base class, flow controllers, and the necessary infrastructure to manage the execution of pass manager tasks. The new interface was used to rebuild the existing pass manager in the [`qiskit.transpiler`](/api/qiskit/transpiler#module-qiskit.transpiler "qiskit.transpiler") module, cleaning up technical debt in the code, and improving usability and performance. See feature and upgrade notes for more details. +* 0.45.0 allows users to better interact with the **layout permutations** performed by the transpiler. The data contained in the [`TranspileLayout`](/api/qiskit/qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") class is now more accessible through a series of new methods and attributes. And a new [`SparsePauliOp.apply_layout()`](/api/qiskit/qiskit.quantum_info.SparsePauliOp#apply_layout "qiskit.quantum_info.SparsePauliOp.apply_layout") method allows to apply a specific layout permutation to a [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") observable that was built for an input circuit to the transpiler. See feature notes for more details. +* Finally, we have introduced **annotated operations** with the new [`AnnotatedOperation`](/api/qiskit/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") class, which allows to formulate complex circuit instructions as a base instruction with a set of modifiers. For example, instead of a specific operation type that implements the controlled inverse of a [`RXGate`](/api/qiskit/qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), we can now use an annotated [`RXGate`](/api/qiskit/qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") with inverse and control attributes. See feature notes for more details. - + ### Bug Fixes -* [`QuantumCircuit.barrier()`](/api/qiskit/qiskit.circuit.QuantumCircuit#barrier "qiskit.circuit.QuantumCircuit.barrier") will now generate correct output when given a [`set`](https://docs.python.org/3/library/stdtypes.html#set "(in Python v3.12)") as one of its inputs. Previously, it would append an invalid operation onto the circuit, though in practice this usually would not cause observable problems. Fixed [#11208](https://github.com/Qiskit/qiskit/issues/11208) - -* The property [`Instruction.condition_bits`](/api/qiskit/qiskit.circuit.Instruction#condition_bits "qiskit.circuit.Instruction.condition_bits") will now correctly handle runtime classical expressions ([`qiskit.circuit.classical`](/api/qiskit/circuit_classical#module-qiskit.circuit.classical "qiskit.circuit.classical")). - -* Fixed the [`hash()`](https://docs.python.org/3/library/functions.html#hash "(in Python v3.12)") of Qiskit Pulse `Channel` objects (such as [`DriveChannel`](/api/qiskit/qiskit.pulse.channels.DriveChannel "qiskit.pulse.channels.DriveChannel")) in cases where the channel was transferred from one Python process to another that used a different hash seed. - -* Conditioned custom gates imported from OpenQASM 2 will now correctly retain their conditions when pickled and deep-copied. Previously, any conditional custom gate (defined by a `gate` statement in an OpenQASM 2 file) would lose its condition when copied or pickled. - -* Fixed QPY deserialization of the [`StatePreparation`](/api/qiskit/qiskit.circuit.library.StatePreparation "qiskit.circuit.library.StatePreparation") and [`Initialize`](/api/qiskit/qiskit.circuit.library.Initialize "qiskit.circuit.library.Initialize") circuit instructions with string and integer parameters (as opposed to an explicit statevector, which was already working). Fixed [#11158](https://github.com/Qiskit/qiskit/issues/11158). - -* Fixed a bug in [`SabreLayout`](/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout") where it would fail to add the register information to the [`Layout`](/api/qiskit/qiskit.transpiler.Layout "qiskit.transpiler.Layout") object used for [`TranspileLayout.initial_layout`](/api/qiskit/qiskit.transpiler.TranspileLayout#initial_layout "qiskit.transpiler.TranspileLayout.initial_layout"). This affected circuit visualization with [`QuantumCircuit.draw()`](/api/qiskit/qiskit.circuit.QuantumCircuit#draw "qiskit.circuit.QuantumCircuit.draw") and [`circuit_drawer()`](/api/qiskit/qiskit.visualization.circuit_drawer "qiskit.visualization.circuit_drawer") after transpilation which would show a virtual qubit label of the form `Qubit[QuantumRegister(6, 'q', 0)]` rather than the expected virtual qubit label using the register name (e.g. `q0`). Fixed [#11038](https://github.com/Qiskit/qiskit/issues/11038) - -* Fixed an issue with [`qpy.dump()`](/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") which would cause the function to potentially ignore the value of `use_symengine` when serializing a [`ScheduleBlock`](/api/qiskit/qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") object. This would result in an invalid QPY payload being generated as it would report it was using symengine for symbolic expressions but actually contain sympy serialized data. +* The use of the (deprecated) `Optimizer` class on [`AQC`](/api/qiskit/qiskit.transpiler.synthesis.aqc.AQC "qiskit.transpiler.synthesis.aqc.AQC") did not have a non-deprecated alternative path, which should have been introduced in Qiskit 0.44. It now accepts a callable that implements the [`Minimizer`](/api/qiskit/qiskit.algorithms.optimizers.Minimizer "qiskit.algorithms.optimizers.Minimizer") protocol, as explicitly stated in the deprecation warning. The callable can look like the following example: -* Fixed a bug which caused [`UnitaryOverlap`](/api/qiskit/qiskit.circuit.library.UnitaryOverlap "qiskit.circuit.library.UnitaryOverlap") to error upon initialization if given an input circuit containing a barrier. + > ```python + > from scipy.optimize import minimize + > from qiskit.transpiler.synthesis.aqc.aqc import AQC + > + > optimizer = partial(minimize, args=(), method="L-BFGS-B", options={"maxiter": 200}) + > aqc = AQC(optimizer=optimizer) + > ``` - +* Fixed an issue with the [`Barrier`](/api/qiskit/qiskit.circuit.library.Barrier "qiskit.circuit.library.Barrier") class. When adding a [`Barrier`](/api/qiskit/qiskit.circuit.library.Barrier "qiskit.circuit.library.Barrier") instance to a [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") with the [`QuantumCircuit.append()`](/api/qiskit/qiskit.circuit.QuantumCircuit#append "qiskit.circuit.QuantumCircuit.append") method previously there was no validation that the size of the barrier matched the qargs specified. - +* The `BlockCollapser` transpiler pass will now correctly handle circuits that contain more than one condition on the same classical register. -## 0.45.0 +* `BlueprintCircuit` subclasses will now behave correctly when the semi-public method `QuantumCircuit._append()` is used with the blueprint in an unbuilt state, *i.e.* the circuit will be built before attempting the append. - +* Adjusted zoom, fontsize, and margins in [`plot_state_city()`](/api/qiskit/qiskit.visualization.plot_state_city "qiskit.visualization.plot_state_city") to fit the plot better for more figure sizes. Corrected the Z-ordering behavior of bars and the zero-amplitude plane, and corrected display of negative real value bars. - + -### Prelude +### Other Notes -Qiskit 0.45.0 is the last feature release before 1.0. It prepares the ground for the API changes we are planning for our first major version release, including many removals of previously deprecated functionality as well as a series of new deprecations. +* Modified the behavior of the [`VF2Layout`](/api/qiskit/qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout") and [`VF2PostLayout`](/api/qiskit/qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout") transpiler passes, which would previously run their internal scoring using multithreading if the input circuits were sufficiently large. The multithreading usage has now been removed from the passes, as it was shown to cause a performance regression instead of an improvement like originally intended. - - If your project depends on Qiskit, it may rely on functionality that will no longer be supported in Qiskit 1.0. For this reason, we recommend that you proactively cap your supported version to `<1.0`. - + -Some feature highlights of Qiskit 0.45.0 are: + -* Starting in this release, all unparametrized gates in the Qiskit standard circuit library are now **singletons**. By default, these gates share a single instance in memory, so once a gate of a specific type, let’s say [`XGate`](/api/qiskit/qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"), is instantiated, any subsequent instances of [`XGate`](/api/qiskit/qiskit.circuit.library.XGate "qiskit.circuit.library.XGate") will be a reference to the first one. This results in a reduced memory usage and construction overhead when using multiple gates of the same type in a circuit. To realize this feature, new base classes have been introduced: [`SingletonInstruction`](/api/qiskit/circuit_singleton#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") and [`SingletonGate`](/api/qiskit/circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate"). See feature notes for more details. -* We have added a new **generic pass manager interface** that can be found in the new [`qiskit.passmanager`](/api/qiskit/passmanager#module-qiskit.passmanager "qiskit.passmanager") module. This is a generalization of the pass manager that was used to build the Qiskit transpiler, and it introduces a generic framework to enable users to create new pass managers that use different intermediate representations (IRs). The module includes a generic pass manager base class, flow controllers, and the necessary infrastructure to manage the execution of pass manager tasks. The new interface was used to rebuild the existing pass manager in the [`qiskit.transpiler`](/api/qiskit/transpiler#module-qiskit.transpiler "qiskit.transpiler") module, cleaning up technical debt in the code, and improving usability and performance. See feature and upgrade notes for more details. -* 0.45.0 allows users to better interact with the **layout permutations** performed by the transpiler. The data contained in the [`TranspileLayout`](/api/qiskit/qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") class is now more accessible through a series of new methods and attributes. And a new [`SparsePauliOp.apply_layout()`](/api/qiskit/qiskit.quantum_info.SparsePauliOp#apply_layout "qiskit.quantum_info.SparsePauliOp.apply_layout") method allows to apply a specific layout permutation to a [`SparsePauliOp`](/api/qiskit/qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") observable that was built for an input circuit to the transpiler. See feature notes for more details. -* Finally, we have introduced **annotated operations** with the new [`AnnotatedOperation`](/api/qiskit/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") class, which allows to formulate complex circuit instructions as a base instruction with a set of modifiers. For example, instead of a specific operation type that implements the controlled inverse of a [`RXGate`](/api/qiskit/qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"), we can now use an annotated [`RXGate`](/api/qiskit/qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate") with inverse and control attributes. See feature notes for more details. +## 0.45.0rc1 - + ### Circuits Features @@ -243,7 +171,7 @@ Some feature highlights of Qiskit 0.45.0 are: * Added the [`UnitaryOverlap`](/api/qiskit/qiskit.circuit.library.UnitaryOverlap "qiskit.circuit.library.UnitaryOverlap") circuit to the Qiskit circuit library. It can be used to compute the fidelity of states generated by unitaries by looking at the probability of the output distribution in the all-zeros state or, equivalently, by computing the expectation value of the projector onto the all-zeros state. This is useful in applications such as machine learning, and computing excited states in quantum chemistry, to name a few. - + ### Pulse Features @@ -263,7 +191,7 @@ Some feature highlights of Qiskit 0.45.0 are: Since [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2") was not supported by the [`schedule()`](/api/qiskit/compiler#qiskit.compiler.schedule "qiskit.compiler.schedule") function, this caused the `schedule()` method to error out when the `backend` argument was supplied with an instance of [`BackendV2`](/api/qiskit/qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). Refer to [#10837](https://github.com/Qiskit/qiskit/issues/10837) for more information. - + ### OpenQASM Features @@ -280,7 +208,7 @@ Some feature highlights of Qiskit 0.45.0 are: The new functions stem from the same code as [`QuantumCircuit.qasm()`](/api/qiskit/qiskit.circuit.QuantumCircuit#qasm "qiskit.circuit.QuantumCircuit.qasm"), which will slowly be phased out and replaced with the new paths, to provide a more coherent interface when compared to the OpenQASM 3 ([`qiskit.qasm3`](/api/qiskit/qasm3#module-qiskit.qasm3 "qiskit.qasm3")) and QPY ([`qiskit.qpy`](/api/qiskit/qpy#module-qiskit.qpy "qiskit.qpy")) modules. This is particularly important since the method name [`qasm()`](/api/qiskit/qiskit.circuit.QuantumCircuit#qasm "qiskit.circuit.QuantumCircuit.qasm") gave no indication of the OpenQASM version, and since it was originally added, Qiskit has gained several serialisation modules that could easily become confused. - + ### QPY Features @@ -307,7 +235,7 @@ Some feature highlights of Qiskit 0.45.0 are: new_qc = qpy.load(fd)[0] ``` - + ### Quantum Information Features @@ -337,14 +265,12 @@ Some feature highlights of Qiskit 0.45.0 are: where an input circuit is transpiled locally before it’s passed to `run`. Transpilation expands the original circuit from 2 to 7 qubits (the size of `backend`) and permutes its layout, which is then applied to `H1` using [`apply_layout()`](/api/qiskit/qiskit.quantum_info.SparsePauliOp#apply_layout "qiskit.quantum_info.SparsePauliOp.apply_layout") to reflect the transformations performed by [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile"). - + ### Transpiler Features * The [`HighLevelSynthesis`](/api/qiskit/qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis") class is extended to synthesize circuits with objects of type [`AnnotatedOperation`](/api/qiskit/qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation"). -* A new [`qiskit.passmanager`](/api/qiskit/passmanager#module-qiskit.passmanager "qiskit.passmanager") module has been added to the Qiskit library. This module implements a generic pass manager and flow controllers, and provides infrastructure to manage execution of pass manager tasks. The module provides base classes for passes ([`GenericPass`](/api/qiskit/qiskit.passmanager.GenericPass "qiskit.passmanager.GenericPass")) and flow controllers ([`BaseController`](/api/qiskit/qiskit.passmanager.BaseController "qiskit.passmanager.BaseController")), as well as a new interface class, `passmanager.Task`, to manage the execution of the pass manager (see the `Task.execute()` method). These new classes follow the composite pattern, as flow controllers are collections of passes, and a controller can be recursively nested into the task pipeline. It must also be noted the base classes are not not aware of the input and output object types, and they must be subclassed for a particular program type to optimize. This unified design reduces the complexity of the conventional pass manager, and no longer requires the use of classes such as the `RunningPassManager` to handle the execution logic dispatch and task structure renormalization. The [`qiskit.transpiler`](/api/qiskit/transpiler#module-qiskit.transpiler "qiskit.transpiler") module has been reorganized to rebuild the existing pass managers based off of the generic pass manager. See upgrade notes for more details. - * Added a new analysis [`SabrePreLayout`](/api/qiskit/qiskit.transpiler.passes.SabrePreLayout "qiskit.transpiler.passes.SabrePreLayout") pass that creates a starting layout for [`SabreLayout`](/api/qiskit/qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout"), writing the layout into the property set value `sabre_starting_layouts`. The pass works by augmenting the coupling map with more and more “extra” edges until [`VF2Layout`](/api/qiskit/qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout") succeeds to find a perfect graph isomorphism. More precisely, the augmented coupling map contains edges between nodes that are within a given distance `d` in the original coupling map, and the value of `d` is increased until an isomorphism is found. The pass also optionally minimizes the number of extra edges involved in the layout until a local minimum is found. This involves removing extra edges and calling [`VF2Layout`](/api/qiskit/qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout") to check if an isomorphism still exists. @@ -479,7 +405,7 @@ Some feature highlights of Qiskit 0.45.0 are: }) ``` - + ### Visualization Features @@ -495,7 +421,7 @@ Some feature highlights of Qiskit 0.45.0 are: ![\_images/release\_notes-1.png](/images/api/qiskit/release_notes-1.png) - + ### Misc. Features @@ -516,7 +442,7 @@ Some feature highlights of Qiskit 0.45.0 are: * [`Parameter`](/api/qiskit/qiskit.circuit.Parameter "qiskit.circuit.Parameter") now has an advanced-usage keyword argument `uuid` in its constructor, which can be used to make the [`Parameter`](/api/qiskit/qiskit.circuit.Parameter "qiskit.circuit.Parameter") compare equal to another of the same name. This should not typically be used by users, and is most useful for custom serialisation and deserialisation. - + ### Circuits Upgrade Notes @@ -572,7 +498,7 @@ Some feature highlights of Qiskit 0.45.0 are: * The definition of [`UnitaryGate`](/api/qiskit/qiskit.circuit.library.UnitaryGate "qiskit.circuit.library.UnitaryGate") for single qubit unitaries is now in terms of [`UGate`](/api/qiskit/qiskit.circuit.library.UGate "qiskit.circuit.library.UGate") instead of the legacy [`U3Gate`](/api/qiskit/qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate") class. - + ### Providers Upgrade Notes @@ -606,7 +532,7 @@ Some feature highlights of Qiskit 0.45.0 are: All these were deprecated since 0.22 (released on October 13, 2022) and now they are removed. - + ### Pulse Upgrade Notes @@ -614,13 +540,13 @@ Some feature highlights of Qiskit 0.45.0 are: * The methods `to_dict` in the classes [`pulse.transforms.AlignmentKind`](/api/qiskit/pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.AlignmentKind"), [`pulse.transforms.AlignEquispaced`](/api/qiskit/qiskit.pulse.transforms.AlignEquispaced "qiskit.pulse.transforms.AlignEquispaced"), and [`pulse.transforms.AlignFunc`](/api/qiskit/qiskit.pulse.transforms.AlignFunc "qiskit.pulse.transforms.AlignFunc") are removed. They were deprecatedin Qiskit 0.37 (with Terra 0.21), released on June 2022. - + ### QPY Upgrade Notes * The use of the keyword `circuits` for the first positional argument in the function [`qiskit.qpy.dump()`](/api/qiskit/qpy#qiskit.qpy.dump "qiskit.qpy.dump") is removed as its usage was deprecated in Qiskit 0.37 (with Terra 0.21), released on June 2022. Instead, use the keyword `programs` can be used instead (or just pass the argument in positionally), which behaves identically. - + ### Quantum Information Upgrade Notes @@ -636,28 +562,16 @@ Some feature highlights of Qiskit 0.45.0 are: * Importing from `qiskit.quantum_info.operators.pauli` is not allowed anymore, as it was deprecated in Qiskit Terra 0.21 (released on June, 2022). Import directly from `qiskit.quantum_info` instead. - + ### Synthesis Upgrade Notes * The parameter `order` in [`synthesis.SuzukiTrotter`](/api/qiskit/qiskit.synthesis.SuzukiTrotter "qiskit.synthesis.SuzukiTrotter") constructor raises an exception instead of deprecation warning when set in an odd number. Suzuki product formulae are symmetric and therefore only defined for even orders. - + ### Transpiler Upgrade Notes -* As a consequence of the pass manager refactoring efforts, existing flow controllers: [`FlowControllerLinear`](/api/qiskit/qiskit.passmanager.FlowControllerLinear "qiskit.passmanager.FlowControllerLinear"), [`ConditionalController`](/api/qiskit/qiskit.passmanager.ConditionalController "qiskit.passmanager.ConditionalController"), and [`DoWhileController`](/api/qiskit/qiskit.passmanager.DoWhileController "qiskit.passmanager.DoWhileController") are now subclasses of the [`BaseController`](/api/qiskit/qiskit.passmanager.BaseController "qiskit.passmanager.BaseController"). Note that these controllers have dropped the implementation of the [`__iter__()`](https://docs.python.org/3/reference/datamodel.html#object.__iter__ "(in Python v3.12)") method. They are now only iterable in the context of a flow-controller execution, which threads the compilation state through after each inner task is executed. - -* The functionalitly of the `RunningPassManager` class has been superseded by the new pass manager framework ([`BasePassManager`](/api/qiskit/qiskit.passmanager.BasePassManager "qiskit.passmanager.BasePassManager") and [`BaseController`](/api/qiskit/qiskit.passmanager.BaseController "qiskit.passmanager.BaseController")). The running pass manager is now a stateless flow controller (essentially, an alias of [`FlowControllerLinear`](/api/qiskit/qiskit.passmanager.FlowControllerLinear "qiskit.passmanager.FlowControllerLinear")), as the pass manager is responsible for the construction of task pipeline, while the controller is responsible for the execution of associated tasks. Subclassing the `RunningPassManager` is no longer recommended, and this class will be completely replaced with the flow controller in future releases. - -* A new class, [`WorkflowStatus`](/api/qiskit/qiskit.passmanager.WorkflowStatus "qiskit.passmanager.WorkflowStatus"), has been introduced to track the status of the pass manager workflow. This portable object is created when the pass manager is run, and handed over to the underlying tasks. Such status was previously managed by the `RunningPassManager` with instance variables. - -* The transpiler-specific [`transpiler.PassManager`](/api/qiskit/qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") (used in [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile")) is now a subclass of [`passmanager.BasePassManager`](/api/qiskit/qiskit.passmanager.BasePassManager "qiskit.passmanager.BasePassManager"). However, this class hierarchy change doesn’t introduce any breaking change to the public-facing API. - -* Exceptions raised during pass-manager execution now inherit from the newly introduced [`PassManagerError`](/api/qiskit/passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.PassManagerError"). A generic failure of the pass-manager machinery will raise [`PassManagerError`](/api/qiskit/passmanager#qiskit.passmanager.PassManagerError "qiskit.passmanager.PassManagerError") for general pass managers, but the transpiler-specific `transpile.PassManager` will currently wrap this in its specific [`TranspilerError`](/api/qiskit/transpiler#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") for backwards compatibility. This wrapping will be removed in the future. - -* The use of `FencedObject` in the pass manager framework has been removed. This wrapper class cannot protect mutable object attributes from modification, and this should not be an issue for properly implemented code. Analysis passes should not modify an input IR, controllers should not update the property set, and so forth. It’s the pass manager developer’s responsibility to ensure that the pass is not modifying object attributes, - * The plugin name `default` is reserved for the [plugin stages](/api/qiskit/transpiler_plugins#stage-table) `init`, `layout`, `optimization`, and `scheduling`. These stages previously did not reserve this plugin name, but the `default` name is now used to represent Qiskit’s built-in default method for these stages. If you were using these names for plugins on these stages these will conflict with Qiskit’s usage and you should rename your plugin. * Disabled the use of the [`RemoveResetInZeroState`](/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState "qiskit.transpiler.passes.RemoveResetInZeroState") class in the preset passmanagers. Previously, when [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") or [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager") was run with `optimization_level` at level 1, 2, or 3, it would run [`RemoveResetInZeroState`](/api/qiskit/qiskit.transpiler.passes.RemoveResetInZeroState "qiskit.transpiler.passes.RemoveResetInZeroState"). However, this pass prohibited the notion of arbitrary initial states unless explicitly set to zeros with resets. If you need to run the pass as part of your compilation pipeline, you can run something like: @@ -682,7 +596,7 @@ Some feature highlights of Qiskit 0.45.0 are: * In [`transpiler.CouplingMap`](/api/qiskit/qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") method `subgraph` is removed as deprecated in 0.20. `reduce()` can be used in place of method `subgraph`. - + ### Visualization Upgrade Notes @@ -692,7 +606,7 @@ Some feature highlights of Qiskit 0.45.0 are: * The visualization functions: [`plot_gate_map()`](/api/qiskit/qiskit.visualization.plot_gate_map "qiskit.visualization.plot_gate_map"), [`plot_coupling_map()`](/api/qiskit/qiskit.visualization.plot_coupling_map "qiskit.visualization.plot_coupling_map"). [`plot_error_map()`](/api/qiskit/qiskit.visualization.plot_error_map "qiskit.visualization.plot_error_map"), and [`plot_circuit_layout()`](/api/qiskit/qiskit.visualization.plot_circuit_layout "qiskit.visualization.plot_circuit_layout") now depend on [graphviz](https://graphviz.org/) being installed to function. This change was necessary to enable visualizing backends with larger numbers of qubits. This additional external requirement is in addition to the existing optional dependencies these functions previously required. You find details on how to install graphviz here: [https://graphviz.org/download/](https://graphviz.org/download/) - + ### Misc. Upgrade Notes @@ -710,13 +624,13 @@ Some feature highlights of Qiskit 0.45.0 are: * Building Qiskit from source now requires a Rust compiler compatible with language version 1.64. This has been increased from the previous minimum supported Rust version of 1.61 for building earlier versions of Qiskit. - + ### Algorithms Deprecations * The algorithm utils in `qiskit.utils.validation` and `qiskit.utils.algorithm_globals` are now deprecated and will be removed in no less than 3 months from the release date. These utils were introduced with the `qiskit.algorithms` module to support legacy and primitive-based algorithm workflows. Now that `qiskit.algorithms` is deprecated and the primitive-based algorithms codebase has been migrated to a standalone [library](https://github.com/qiskit-community/qiskit-algorithms), these utils are no longer used in the context of Qiskit. If your application allows it, we recommend that you migrate your code to use [qiskit\_algorithms](https://github.com/qiskit-community/qiskit-algorithms), where you will be able to import the relevant utilities in `algorithm_globals` and `validation` from `qiskit_algorithms.utils`. Please note that legacy functionality has not been migrated to the new package. - + ### Circuits Deprecations @@ -772,29 +686,10 @@ Some feature highlights of Qiskit 0.45.0 are: * The little-used [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") class data attributes [`header`](/api/qiskit/qiskit.circuit.QuantumCircuit#header "qiskit.circuit.QuantumCircuit.header") and [`extension_lib`](/api/qiskit/qiskit.circuit.QuantumCircuit#extension_lib "qiskit.circuit.QuantumCircuit.extension_lib") are deprecated and scheduled for removal. These respectively held strings of the OpenQASM 2.0 version header statement and `qelib1.inc` include statement. No alternative will be provided; these were mostly intended as internal details. - + ### Transpiler Deprecations -* The flow controller factory method [`FlowController.controller_factory()`](/api/qiskit/qiskit.passmanager.FlowController#controller_factory "qiskit.passmanager.FlowController.controller_factory") is deprecated along with [`FlowController.add_flow_controller()`](/api/qiskit/qiskit.passmanager.FlowController#add_flow_controller "qiskit.passmanager.FlowController.add_flow_controller") and [`FlowController.remove_flow_controller()`](/api/qiskit/qiskit.passmanager.FlowController#remove_flow_controller "qiskit.passmanager.FlowController.remove_flow_controller"). In the future, task construction with keyword arguments in the [`BasePassManager.append()`](/api/qiskit/qiskit.passmanager.BasePassManager#append "qiskit.passmanager.BasePassManager.append") method will also be deprecated. Controllers must be explicitly instantiated and appended to the pass manager. For example, the previously used conventional syntax - - ```python - pm.append([task1, task2], condition=lambda x: x["value1"] > 10) - ``` - - must be replaced with - - ```python - controller = ConditionalController([task1, task2], condition=lambda x: x["value1"] > 10) - pm.append(controller) - ``` - - The latter allows more precise control on the order of controllers especially when multiple keyword arguments are specified together, and allows for the construction of general flow controllers that may have more than one pipeline or do not take a single simple conditional function in their constructors. - -* The [`FlowControllerLinear.append()`](/api/qiskit/qiskit.passmanager.FlowControllerLinear#append "qiskit.passmanager.FlowControllerLinear.append"), [`DoWhileController.append()`](/api/qiskit/qiskit.passmanager.DoWhileController#append "qiskit.passmanager.DoWhileController.append"), and [`ConditionalController.append()`](/api/qiskit/qiskit.passmanager.ConditionalController#append "qiskit.passmanager.ConditionalController.append") methods are all deprecated immediately. The construction of the pass manager task pipeline is now the role of [`BasePassManager`](/api/qiskit/qiskit.passmanager.BasePassManager "qiskit.passmanager.BasePassManager"), and individual flow controllers do not need to this method. For a flow controller, all the passes should be specificed in one go directly to the constructor. - -* The general attribute and variable name `passes` is replaced with `tasks` all over the [`qiskit.passmanager`](/api/qiskit/passmanager#module-qiskit.passmanager "qiskit.passmanager") module. Note that a task must indicate a union of pass and controller, and the singular form pass conflicts with the Python keyword. In this sense, the use of tasks is much preferable. - * The [`Unroller`](/api/qiskit/qiskit.transpiler.passes.Unroller "qiskit.transpiler.passes.Unroller") transpiler pass has been deprecated and will be removed in a future release. The [`Unroller`](/api/qiskit/qiskit.transpiler.passes.Unroller "qiskit.transpiler.passes.Unroller") has been superseded by the [`BasisTranslator`](/api/qiskit/qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") which provides a similar set of functionality but offers it in a more general manner so that you’re able to translate a circuit to any universal basis set. The [`Unroller`](/api/qiskit/qiskit.transpiler.passes.Unroller "qiskit.transpiler.passes.Unroller") class only works in situations where the circuit’s gate definitions are recursively defined in terms of the target basis; for Qiskit’s standard library gates this means [`UGate`](/api/qiskit/qiskit.circuit.library.UGate "qiskit.circuit.library.UGate") and [`CXGate`](/api/qiskit/qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). If you are using the [`Unroller`](/api/qiskit/qiskit.transpiler.passes.Unroller "qiskit.transpiler.passes.Unroller") pass it can be replaced by using a custom pass manager of the form: ```python @@ -813,7 +708,7 @@ Some feature highlights of Qiskit 0.45.0 are: * The use of the value `"unroller"` for the `translation_method` keyword argument on the [`transpile()`](/api/qiskit/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](/api/qiskit/transpiler_preset#qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager") has been deprecated. This translation stage plugin will be removed from Qiskit in a future release as it has been superseded by the default `"translator"` method which will work similarly to the `"unroller"` plugin but support a broader set of target backends. - + ### Visualization Deprecations @@ -846,9 +741,9 @@ Some feature highlights of Qiskit 0.45.0 are: This behaviour was previously intended to be deprecated in Qiskit 0.37, but due to a bug in the warning, it was not displayed to users until now. The behaviour will be removed in Qiskit 1.0. - + - + ### Bug Fixes @@ -907,25 +802,9 @@ Some feature highlights of Qiskit 0.45.0 are: * Added support to allow `SparsePauliOp` default initialization passing an empty iterable to the static methods [`from_list()`](/api/qiskit/qiskit.quantum_info.SparsePauliOp#from_list "qiskit.quantum_info.SparsePauliOp.from_list") and [`from_sparse_list()`](/api/qiskit/qiskit.quantum_info.SparsePauliOp#from_sparse_list "qiskit.quantum_info.SparsePauliOp.from_sparse_list"). Fixed [#10159](https://github.com/Qiskit/qiskit-terra/issues/10159). -* The use of the (deprecated) `Optimizer` class on [`AQC`](/api/qiskit/qiskit.transpiler.synthesis.aqc.AQC "qiskit.transpiler.synthesis.aqc.AQC") did not have a non-deprecated alternative path, which should have been introduced in Qiskit 0.44. It now accepts a callable that implements the [`Minimizer`](/api/qiskit/qiskit.algorithms.optimizers.Minimizer "qiskit.algorithms.optimizers.Minimizer") protocol, as explicitly stated in the deprecation warning. The callable can look like the following example: + - > ```python - > from scipy.optimize import minimize - > from qiskit.transpiler.synthesis.aqc.aqc import AQC - > - > optimizer = partial(minimize, args=(), method="L-BFGS-B", options={"maxiter": 200}) - > aqc = AQC(optimizer=optimizer) - > ``` - -* Fixed an issue with the [`Barrier`](/api/qiskit/qiskit.circuit.library.Barrier "qiskit.circuit.library.Barrier") class. When adding a [`Barrier`](/api/qiskit/qiskit.circuit.library.Barrier "qiskit.circuit.library.Barrier") instance to a [`QuantumCircuit`](/api/qiskit/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") with the [`QuantumCircuit.append()`](/api/qiskit/qiskit.circuit.QuantumCircuit#append "qiskit.circuit.QuantumCircuit.append") method previously there was no validation that the size of the barrier matched the qargs specified. - -* The `BlockCollapser` transpiler pass will now correctly handle circuits that contain more than one condition on the same classical register. - -* `BlueprintCircuit` subclasses will now behave correctly when the semi-public method `QuantumCircuit._append()` is used with the blueprint in an unbuilt state, *i.e.* the circuit will be built before attempting the append. - -* Adjusted zoom, fontsize, and margins in [`plot_state_city()`](/api/qiskit/qiskit.visualization.plot_state_city "qiskit.visualization.plot_state_city") to fit the plot better for more figure sizes. Corrected the Z-ordering behavior of bars and the zero-amplitude plane, and corrected display of negative real value bars. - - + ### Other Notes @@ -933,5 +812,6 @@ Some feature highlights of Qiskit 0.45.0 are: We cannot prevent your package manager from resolving to older versions of Qiskit (which do not have the same pin but are still likely to be incompatible) if you forcibly try to install Qiskit alongside Numpy 2, before we have released a compatible version. -* Modified the behavior of the [`VF2Layout`](/api/qiskit/qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout") and [`VF2PostLayout`](/api/qiskit/qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout") transpiler passes, which would previously run their internal scoring using multithreading if the input circuits were sufficiently large. The multithreading usage has now been removed from the passes, as it was shown to cause a performance regression instead of an improvement like originally intended. + + diff --git a/docs/api/qiskit/result.md b/docs/api/qiskit/result.md index 94e1391410..5584d1838e 100644 --- a/docs/api/qiskit/result.md +++ b/docs/api/qiskit/result.md @@ -20,13 +20,13 @@ python_api_name: qiskit.result | | | | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -| [`Result`](qiskit.result.Result "qiskit.result.Result")(backend\_name, backend\_version, ...\[, ...]) | Model for Results. | +| [`Result`](qiskit.result.Result "qiskit.result.Result")(backend\_name, backend\_version, ...\[, ...]) | Model for Results. | | [`ResultError`](qiskit.result.ResultError "qiskit.result.ResultError")(error) | Exceptions raised due to errors in result output. | -| [`Counts`](qiskit.result.Counts "qiskit.result.Counts")(data\[, time\_taken, creg\_sizes, ...]) | A class to store a counts result from a circuit execution. | +| [`Counts`](qiskit.result.Counts "qiskit.result.Counts")(data\[, time\_taken, creg\_sizes, ...]) | A class to store a counts result from a circuit execution. | -`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` Marginalize counts from an experiment over some indices of interest. @@ -54,7 +54,7 @@ the observed counts, marginalized to only account for frequency of observations -`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_distribution(counts, indices=None, format_marginal=False)` Marginalize counts from an experiment over some indices of interest. @@ -81,7 +81,7 @@ A marginalized dictionary -`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/utils.py "view source code") +`qiskit.result.marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` Marginalize shot memory @@ -112,14 +112,14 @@ marginal\_memory | | | | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| [`ProbDistribution`](qiskit.result.ProbDistribution "qiskit.result.ProbDistribution")(data\[, shots]) | A generic dict-like class for probability distributions. | -| [`QuasiDistribution`](qiskit.result.QuasiDistribution "qiskit.result.QuasiDistribution")(data\[, shots, ...]) | A dict-like class for representing quasi-probabilities. | +| [`ProbDistribution`](qiskit.result.ProbDistribution "qiskit.result.ProbDistribution")(data\[, shots]) | A generic dict-like class for probability distributions. | +| [`QuasiDistribution`](qiskit.result.QuasiDistribution "qiskit.result.QuasiDistribution")(data\[, shots, ...]) | A dict-like class for representing quasi-probabilities. | ## Expectation values -`qiskit.result.sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/result/sampled_expval.py "view source code") +`qiskit.result.sampled_expectation_value(dist, oper)` Computes expectation value from a sampled distribution @@ -148,5 +148,5 @@ The expectation value | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | | [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.BaseReadoutMitigator")() | Base readout error mitigator class. | | [`CorrelatedReadoutMitigator`](qiskit.result.CorrelatedReadoutMitigator "qiskit.result.CorrelatedReadoutMitigator")(assignment\_matrix) | N-qubit readout error mitigator. | -| [`LocalReadoutMitigator`](qiskit.result.LocalReadoutMitigator "qiskit.result.LocalReadoutMitigator")(\[assignment\_matrices, ...]) | 1-qubit tensor product readout error mitigator. | +| [`LocalReadoutMitigator`](qiskit.result.LocalReadoutMitigator "qiskit.result.LocalReadoutMitigator")(\[assignment\_matrices, ...]) | 1-qubit tensor product readout error mitigator. | diff --git a/docs/api/qiskit/scheduler.md b/docs/api/qiskit/scheduler.md index 1ac9729171..2555a40903 100644 --- a/docs/api/qiskit/scheduler.md +++ b/docs/api/qiskit/scheduler.md @@ -22,7 +22,7 @@ A circuit scheduler compiles a circuit program to a pulse program. -`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/config.py "view source code") +`qiskit.scheduler.ScheduleConfig(inst_map, meas_map, dt)` Configuration for pulse scheduling. @@ -36,7 +36,7 @@ Container for information needed to schedule a QuantumCircuit into a pulse Sched -`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/schedule_circuit.py "view source code") +`qiskit.scheduler.schedule_circuit.schedule_circuit(circuit, schedule_config, method=None, backend=None)` Basic scheduling pass from a circuit to a pulse Schedule, using the backend. If no method is specified, then a basic, as late as possible scheduling pass is performed, i.e. pulses are scheduled to occur as late as possible. @@ -70,7 +70,7 @@ Pulse scheduling methods. -`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_soon_as_possible(circuit, schedule_config, backend=None)` Return the pulse Schedule which implements the input circuit using an “as soon as possible” (asap) scheduling policy. @@ -92,7 +92,7 @@ A schedule corresponding to the input `circuit` with pulses occurring as early a -`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/scheduler/methods/basic.py "view source code") +`qiskit.scheduler.methods.as_late_as_possible(circuit, schedule_config, backend=None)` Return the pulse Schedule which implements the input circuit using an “as late as possible” (alap) scheduling policy. diff --git a/docs/api/qiskit/synthesis.md b/docs/api/qiskit/synthesis.md index 16a568d4c7..dfdb47ae25 100644 --- a/docs/api/qiskit/synthesis.md +++ b/docs/api/qiskit/synthesis.md @@ -25,17 +25,17 @@ python_api_name: qiskit.synthesis | | | | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.EvolutionSynthesis")() | Interface for evolution synthesis algorithms. | -| [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.ProductFormula")(order\[, reps, ...]) | Product formula base class for the decomposition of non-commuting operator exponentials. | -| [`LieTrotter`](qiskit.synthesis.LieTrotter "qiskit.synthesis.LieTrotter")(\[reps, insert\_barriers, ...]) | The Lie-Trotter product formula. | -| [`SuzukiTrotter`](qiskit.synthesis.SuzukiTrotter "qiskit.synthesis.SuzukiTrotter")(\[order, reps, ...]) | The (higher order) Suzuki-Trotter product formula. | +| [`ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.ProductFormula")(order\[, reps, ...]) | Product formula base class for the decomposition of non-commuting operator exponentials. | +| [`LieTrotter`](qiskit.synthesis.LieTrotter "qiskit.synthesis.LieTrotter")(\[reps, insert\_barriers, ...]) | The Lie-Trotter product formula. | +| [`SuzukiTrotter`](qiskit.synthesis.SuzukiTrotter "qiskit.synthesis.SuzukiTrotter")(\[order, reps, ...]) | The (higher order) Suzuki-Trotter product formula. | | [`MatrixExponential`](qiskit.synthesis.MatrixExponential "qiskit.synthesis.MatrixExponential")() | Exact operator evolution via matrix exponentiation and unitary synthesis. | -| [`QDrift`](qiskit.synthesis.QDrift "qiskit.synthesis.QDrift")(\[reps, insert\_barriers, ...]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | +| [`QDrift`](qiskit.synthesis.QDrift "qiskit.synthesis.QDrift")(\[reps, insert\_barriers, ...]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | ## Linear Function Synthesis -`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear/cnot_synth.py "view source code") +`qiskit.synthesis.synth_cnot_count_full_pmh(state, section_size=2)` Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. @@ -64,7 +64,7 @@ a CX-only circuit implementing the linear transformation. -`qiskit.synthesis.synth_cnot_depth_line_kms(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cnot_depth_line_kms(mat)` Synthesize linear reversible circuit for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. @@ -94,7 +94,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_cz_depth_line_mr(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear_phase/cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cz_depth_line_mr(mat)` Synthesis of a CZ circuit for linear nearest neighbour (LNN) connectivity, based on Maslov and Roetteler. @@ -118,7 +118,7 @@ a circuit implementation of the CZ circuit of depth 2\*n+2 for LNN connectivity. -`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py "view source code") +`qiskit.synthesis.synth_cx_cz_depth_line_my(mat_x, mat_z)` Joint synthesis of a -CZ-CX- circuit for linear nearest neighbour (LNN) connectivity, with 2-qubit depth at most 5n, based on Maslov and Yang. This method computes the CZ circuit inside the CX circuit via phase gate insertions. @@ -144,7 +144,7 @@ a circuit implementation of a CX circuit following a CZ circuit, denoted as a -C -`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/permutation/permutation_lnn.py "view source code") +`qiskit.synthesis.synth_permutation_depth_lnn_kms(pattern)` Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. @@ -164,7 +164,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_basic(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_basic(pattern)` Synthesize a permutation circuit for a fully-connected architecture using sorting. @@ -184,7 +184,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_permutation_acg(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/permutation/permutation_full.py "view source code") +`qiskit.synthesis.synth_permutation_acg(pattern)` Synthesize a permutation circuit for a fully-connected architecture using the Alon, Chung, Graham method. @@ -208,7 +208,7 @@ the synthesized quantum circuit. -`qiskit.synthesis.synth_clifford_full(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") +`qiskit.synthesis.synth_clifford_full(clifford, method=None)` Decompose a Clifford operator into a QuantumCircuit. @@ -235,7 +235,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_ag(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") +`qiskit.synthesis.synth_clifford_ag(clifford)` Decompose a Clifford operator into a QuantumCircuit based on Aaronson-Gottesman method. @@ -257,7 +257,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_bm(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") +`qiskit.synthesis.synth_clifford_bm(clifford)` Optimal CX-cost decomposition of a Clifford operator on 2-qubits or 3-qubits into a QuantumCircuit based on Bravyi-Maslov method. @@ -283,7 +283,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_greedy(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") +`qiskit.synthesis.synth_clifford_greedy(clifford)` Decompose a Clifford operator into a QuantumCircuit based on the greedy Clifford compiler that is described in Appendix A of Bravyi, Hu, Maslov and Shaydulin. @@ -311,7 +311,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, cz_func_reverse_qubits=False, validate=False)` Synthesis of a Clifford into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of Bravyi and Maslov. @@ -356,7 +356,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_clifford_depth_lnn(cliff)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") +`qiskit.synthesis.synth_clifford_depth_lnn(cliff)` Synthesis of a Clifford into layers for linear-nearest neighbour connectivity. @@ -384,7 +384,7 @@ a circuit implementation of the Clifford. -`qiskit.synthesis.synth_cnotdihedral_full(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_full(elem)` Decompose a CNOTDihedral element into a QuantumCircuit. For N \<= 2 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 2 qubits this is done using the general non-optimal compilation routine from reference \[2]. @@ -407,7 +407,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_two_qubits(elem)` Decompose a CNOTDihedral element on a single qubit and two qubits into a QuantumCircuit. This decomposition has an optimal number of CX gates. @@ -433,7 +433,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_cnotdihedral_general(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") +`qiskit.synthesis.synth_cnotdihedral_general(elem)` Decompose a CNOTDihedral element into a QuantumCircuit. @@ -463,7 +463,7 @@ a circuit implementation of the CNOTDihedral element. -`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_layers(stab, cz_synth_func=, cz_func_reverse_qubits=False, validate=False)` Synthesis of a stabilizer state into layers. @@ -510,7 +510,7 @@ a circuit implementation of the stabilizer state. -`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/stabilizer/stabilizer_decompose.py "view source code") +`qiskit.synthesis.synth_stabilizer_depth_lnn(stab)` Synthesis of an n-qubit stabilizer state for linear-nearest neighbour connectivity, in 2-qubit depth 2\*n+2 and two distinct CX layers, using CX and phase gates (S, Sdg or Z). @@ -539,7 +539,7 @@ a circuit implementation of the stabilizer state. -`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") +`qiskit.synthesis.generate_basic_approximations(basis_gates, depth, filename=None)` Generates a list of `GateSequence``s with the gates in ``basic_gates`. diff --git a/docs/api/qiskit/synthesis_aqc.md b/docs/api/qiskit/synthesis_aqc.md index 2154aa27bc..55090ac6be 100644 --- a/docs/api/qiskit/synthesis_aqc.md +++ b/docs/api/qiskit/synthesis_aqc.md @@ -26,14 +26,14 @@ The main public interface of this module is reached by passing `unitary_synthesi | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| [`AQC`](qiskit.transpiler.synthesis.aqc.AQC "qiskit.transpiler.synthesis.aqc.AQC")(\[optimizer, seed]) | A generic implementation of the Approximate Quantum Compiler. | +| [`AQC`](qiskit.transpiler.synthesis.aqc.AQC "qiskit.transpiler.synthesis.aqc.AQC")(\[optimizer, seed]) | A generic implementation of the Approximate Quantum Compiler. | | [`AQCSynthesisPlugin`](qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin "qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin")() | An AQC-based Qiskit unitary synthesis plugin. | -| [`ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.ApproximateCircuit")(num\_qubits\[, name]) | A base class that represents an approximate circuit. | +| [`ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.ApproximateCircuit")(num\_qubits\[, name]) | A base class that represents an approximate circuit. | | [`ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.ApproximatingObjective")() | A base class for an optimization problem definition. | -| [`CNOTUnitCircuit`](qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit "qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit")(num\_qubits, cnots\[, tol, name]) | A class that represents an approximate circuit based on CNOT unit blocks. | -| [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.CNOTUnitObjective")(num\_qubits, cnots) | A base class for a problem definition based on CNOT unit. | -| [`DefaultCNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective "qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective")(num\_qubits, cnots) | A naive implementation of the objective function based on CNOT units. | -| [`FastCNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective "qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective")(num\_qubits, cnots) | Implementation of objective function and gradient calculator, which is similar to `DefaultCNOTUnitObjective` but several times faster. | +| [`CNOTUnitCircuit`](qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit "qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit")(num\_qubits, cnots\[, tol, name]) | A class that represents an approximate circuit based on CNOT unit blocks. | +| [`CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.CNOTUnitObjective")(num\_qubits, cnots) | A base class for a problem definition based on CNOT unit. | +| [`DefaultCNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective "qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective")(num\_qubits, cnots) | A naive implementation of the objective function based on CNOT units. | +| [`FastCNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective "qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective")(num\_qubits, cnots) | Implementation of objective function and gradient calculator, which is similar to `DefaultCNOTUnitObjective` but several times faster. | ## Mathematical Detail @@ -128,7 +128,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`qiskit.transpiler.synthesis.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") +`qiskit.transpiler.synthesis.aqc.make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/tools.md b/docs/api/qiskit/tools.md index 52a26b29d5..287fb481cd 100644 --- a/docs/api/qiskit/tools.md +++ b/docs/api/qiskit/tools.md @@ -22,7 +22,7 @@ A helper function for calling a custom function with python `ProcessPoolExecutor -`qiskit.tools.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/parallel.py "view source code") +`qiskit.tools.parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` Parallel execution of a mapping of values to the function task. This is functionally equivalent to: @@ -77,7 +77,7 @@ A helper module to get IBM backend information and submitted job status. -`qiskit.tools.job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/monitor/job_monitor.py "view source code") +`qiskit.tools.job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` Monitor the status of a IBMQJob instance. @@ -109,7 +109,7 @@ job_monitor(job_sim) -`qiskit.tools.backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/monitor/overview.py "view source code") +`qiskit.tools.backend_monitor(backend)` Monitor a single IBMQ backend. @@ -128,7 +128,7 @@ Examples: .. code-block:: python -`qiskit.tools.backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/monitor/overview.py "view source code") +`qiskit.tools.backend_overview()` Gives overview information on all the IBMQ backends that are available. @@ -151,7 +151,7 @@ A helper component for publishing and subscribing to events. -`qiskit.tools.events.TextProgressBar(output_handler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/tools/events/progressbar.py "view source code") +`qiskit.tools.events.TextProgressBar(output_handler=None)` A simple text-based progress bar. diff --git a/docs/api/qiskit/transpiler.md b/docs/api/qiskit/transpiler.md index 413c3e2832..b523ec4639 100644 --- a/docs/api/qiskit/transpiler.md +++ b/docs/api/qiskit/transpiler.md @@ -56,35 +56,28 @@ pass_manager = generate_preset_pass_manager(3, backend) which will generate a [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager") object for optimization level 3 targeting the [`FakeLagosV2`](qiskit.providers.fake_provider.FakeLagosV2 "qiskit.providers.fake_provider.FakeLagosV2") backend (equivalent to what is used internally by [`transpile()`](compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") with `backend=FakeLagosV2()` and `optimization_level=3`). You can use this just like you would any other [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager"). However, because it is a [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager") it also makes it easy to compose and/or replace stages of the pipeline. For example, if you wanted to run a custom scheduling stage using dynamical decoupling (via the [`PadDynamicalDecoupling`](qiskit.transpiler.passes.PadDynamicalDecoupling "qiskit.transpiler.passes.PadDynamicalDecoupling") pass) and also add initial logical optimization prior to routing, you would do something like (building off the previous example): ```python -import numpy as np -from qiskit.circuit.library import HGate, PhaseGate, RXGate, TdgGate, TGate, XGate +from qiskit.circuit.library import XGate, HGate, RXGate, PhaseGate, TGate, TdgGate from qiskit.transpiler import PassManager -from qiskit.transpiler.passes import ( - ALAPScheduleAnalysis, - CXCancellation, - InverseCancellation, - PadDynamicalDecoupling, -) +from qiskit.transpiler.passes import ALAPScheduleAnalysis, PadDynamicalDecoupling +from qiskit.transpiler.passes import CXCancellation, InverseCancellation +backend_durations = backend.target.durations() dd_sequence = [XGate(), XGate()] -scheduling_pm = PassManager( - [ - ALAPScheduleAnalysis(target=backend.target), - PadDynamicalDecoupling(target=backend.target, dd_sequence=dd_sequence), - ] -) +scheduling_pm = PassManager([ + ALAPScheduleAnalysis(backend_durations), + PadDynamicalDecoupling(backend_durations, dd_sequence), +]) inverse_gate_list = [ HGate(), (RXGate(np.pi / 4), RXGate(-np.pi / 4)), (PhaseGate(np.pi / 4), PhaseGate(-np.pi / 4)), (TGate(), TdgGate()), -] -logical_opt = PassManager( - [ - CXCancellation(), - InverseCancellation(inverse_gate_list), - ] -) + +]) +logical_opt = PassManager([ + CXCancellation(), + InverseCancellation([HGate(), (RXGate(np.pi / 4), RXGate(-np.pi / 4)) +]) # Add pre-layout stage to run extra logical optimization @@ -93,11 +86,11 @@ pass_manager.pre_layout = logical_opt pass_manager.scheduling = scheduling_pm ``` -Now, when the staged pass manager is run via the [`run()`](qiskit.transpiler.StagedPassManager#run "qiskit.transpiler.StagedPassManager.run") method, the `logical_opt` pass manager will be called before the `layout` stage, and the `scheduling_pm` pass manager will be used for the `scheduling` stage instead of the default. +Then when [`run()`](qiskit.transpiler.StagedPassManager#run "qiskit.transpiler.StagedPassManager.run") is called on `pass_manager` the `logical_opt` [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") will be called prior to the `layout` stage and for the `scheduling` stage our custom [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") `scheduling_pm` will be used. ## Custom Pass Managers -In addition to modifying preset pass managers, it is also possible to construct a pass manager to build an entirely custom pipeline for transforming input circuits. You can use the [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager") class directly to do this. You can define arbitrary stage names and populate them with a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") instance. For example, the following code creates a new [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager") that has 2 stages, `init` and `translation`.: +In addition to modifying preset pass managers, it is also possible to construct a pass manager to build an entirely custom pipeline for transforming input circuits. You can leverage the [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager") class directly to do this. You can define arbitrary stage names and populate them with a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") instance. For example: ```python from qiskit.transpiler.passes import ( @@ -105,7 +98,6 @@ from qiskit.transpiler.passes import ( Collect2qBlocks, ConsolidateBlocks, UnitarySynthesis, - Unroll3qOrMore, ) from qiskit.transpiler import PassManager, StagedPassManager @@ -124,9 +116,9 @@ staged_pm = StagedPassManager( ) ``` -There is no limit on the number of stages you can put in a [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager"). +will create a new [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager") that has 2 stages `init` and `translation`. There is no limit on the number of stages you can put in a custom [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager") instance. -The [Stage Generator Functions](transpiler_preset#stage-generators) may be useful for the construction of custom `generate_embed_passmanager` generates a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") to “embed” a selected initial [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") from a layout pass to the specified target device. +The [Stage Generator Functions](transpiler_preset#stage-generators) functions may be useful for the construction of custom pass managers. They generate stages which provide common functionality used in many pass managers. For example, [`generate_embed_passmanager()`](transpiler_preset#qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager "qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager") can be used to generate a stage to “embed” a selected initial [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") from a layout pass to the specified target device. ## Representing Quantum Computers @@ -897,30 +889,30 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target")(\[description, num\_qubits, dt, ...]) | The intent of the `Target` object is to inform Qiskit's compiler about the constraints of a particular backend so the compiler can compile an input circuit to something that works and is optimized for a device. | -| [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties")(\[duration, error, ...]) | A representation of the properties of a gate implementation. | +| [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target")(\[description, num\_qubits, dt, ...]) | The intent of the `Target` object is to inform Qiskit's compiler about the constraints of a particular backend so the compiler can compile an input circuit to something that works and is optimized for a device. | +| [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties")(\[duration, error, ...]) | A representation of the properties of a gate implementation. | ### Pass Manager Construction | | | | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager")(\[stages]) | A pass manager pipeline built from individual stages. | -| [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager")(\[passes, max\_iteration]) | Manager for a set of Passes and their scheduling during transpilation. | -| [`PassManagerConfig`](qiskit.transpiler.PassManagerConfig "qiskit.transpiler.PassManagerConfig")(\[initial\_layout, ...]) | Pass Manager Configuration. | +| [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager")(\[stages]) | A Pass manager pipeline built up of individual stages | +| [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager")(\[passes, max\_iteration]) | Manager for a set of Passes and their scheduling during transpilation. | +| [`PassManagerConfig`](qiskit.transpiler.PassManagerConfig "qiskit.transpiler.PassManagerConfig")(\[initial\_layout, ...]) | Pass Manager Configuration. | ### Layout and Topology | | | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | | [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout")(\[input\_dict]) | Two-ways dict to represent a Layout. | -| [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")(\[couplinglist, description]) | Directed graph specifying fixed coupling. | -| [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout")(initial\_layout, ...\[, ...]) | Layout attributes from output circuit from transpiler. | +| [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")(\[couplinglist, description]) | Directed graph specifying fixed coupling. | +| [`TranspileLayout`](qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout")(initial\_layout, ...\[, ...]) | Layout attributes from output circuit from transpiler. | ### Scheduling | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")(\[instruction\_durations, dt]) | Helper class to provide durations of instructions for scheduling. | +| [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")(\[instruction\_durations, dt]) | Helper class to provide durations of instructions for scheduling. | ### Fenced Objects @@ -933,14 +925,14 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor | | | | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | -| [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.TransformationPass")(\*args, \*\*kwargs) | A transformation pass: change DAG, not property set. | -| [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.AnalysisPass")(\*args, \*\*kwargs) | An analysis pass: change property set, not DAG. | +| [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.TransformationPass")(\*args, \*\*kwargs) | A transformation pass: change DAG, not property set. | +| [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.AnalysisPass")(\*args, \*\*kwargs) | An analysis pass: change property set, not DAG. | ### Exceptions -`qiskit.transpiler.TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerError(*message)` Exceptions raised during transpilation. @@ -948,7 +940,7 @@ Set the error message. -`qiskit.transpiler.TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.TranspilerAccessError(*message)` DEPRECATED: Exception of access error in the transpiler passes. @@ -956,7 +948,7 @@ Set the error message. -`qiskit.transpiler.CouplingError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.CouplingError(*msg)` Base class for errors raised by the coupling graph object. @@ -964,7 +956,7 @@ Set the error message. -`qiskit.transpiler.LayoutError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/exceptions.py "view source code") +`qiskit.transpiler.LayoutError(*msg)` Errors raised by the layout object. diff --git a/docs/api/qiskit/transpiler_passes.md b/docs/api/qiskit/transpiler_passes.md index 379c86daf3..389f0d1b46 100644 --- a/docs/api/qiskit/transpiler_passes.md +++ b/docs/api/qiskit/transpiler_passes.md @@ -20,142 +20,142 @@ python_api_name: qiskit.transpiler.passes ## Layout Selection (Placement) -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| [`SetLayout`](qiskit.transpiler.passes.SetLayout "qiskit.transpiler.passes.SetLayout")(\*args, \*\*kwargs) | Set the `layout` property to the given layout. | -| [`TrivialLayout`](qiskit.transpiler.passes.TrivialLayout "qiskit.transpiler.passes.TrivialLayout")(\*args, \*\*kwargs) | Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. | -| [`DenseLayout`](qiskit.transpiler.passes.DenseLayout "qiskit.transpiler.passes.DenseLayout")(\*args, \*\*kwargs) | Choose a Layout by finding the most connected subset of qubits. | -| [`NoiseAdaptiveLayout`](qiskit.transpiler.passes.NoiseAdaptiveLayout "qiskit.transpiler.passes.NoiseAdaptiveLayout")(\*args, \*\*kwargs) | Choose a noise-adaptive Layout based on current calibration data for the backend. | -| [`SabreLayout`](qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout")(\*args, \*\*kwargs) | Choose a Layout via iterative bidirectional routing of the input circuit. | -| [`CSPLayout`](qiskit.transpiler.passes.CSPLayout "qiskit.transpiler.passes.CSPLayout")(\*args, \*\*kwargs) | If possible, chooses a Layout as a CSP, using backtracking. | -| [`VF2Layout`](qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout")(\*args, \*\*kwargs) | A pass for choosing a Layout of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. | -| [`ApplyLayout`](qiskit.transpiler.passes.ApplyLayout "qiskit.transpiler.passes.ApplyLayout")(\*args, \*\*kwargs) | Transform a circuit with virtual qubits into a circuit with physical qubits. | -| [`Layout2qDistance`](qiskit.transpiler.passes.Layout2qDistance "qiskit.transpiler.passes.Layout2qDistance")(\*args, \*\*kwargs) | Evaluate how good the layout selection was. | -| [`EnlargeWithAncilla`](qiskit.transpiler.passes.EnlargeWithAncilla "qiskit.transpiler.passes.EnlargeWithAncilla")(\*args, \*\*kwargs) | Extend the dag with virtual qubits that are in layout but not in the circuit yet. | -| [`FullAncillaAllocation`](qiskit.transpiler.passes.FullAncillaAllocation "qiskit.transpiler.passes.FullAncillaAllocation")(\*args, \*\*kwargs) | Allocate all idle nodes from the coupling map or target as ancilla on the layout. | -| [`SabrePreLayout`](qiskit.transpiler.passes.SabrePreLayout "qiskit.transpiler.passes.SabrePreLayout")(\*args, \*\*kwargs) | Choose a starting layout to use for additional Sabre layout trials. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| [`SetLayout`](qiskit.transpiler.passes.SetLayout "qiskit.transpiler.passes.SetLayout")(\*args, \*\*kwargs) | Set the `layout` property to the given layout. | +| [`TrivialLayout`](qiskit.transpiler.passes.TrivialLayout "qiskit.transpiler.passes.TrivialLayout")(\*args, \*\*kwargs) | Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. | +| [`DenseLayout`](qiskit.transpiler.passes.DenseLayout "qiskit.transpiler.passes.DenseLayout")(\*args, \*\*kwargs) | Choose a Layout by finding the most connected subset of qubits. | +| [`NoiseAdaptiveLayout`](qiskit.transpiler.passes.NoiseAdaptiveLayout "qiskit.transpiler.passes.NoiseAdaptiveLayout")(\*args, \*\*kwargs) | Choose a noise-adaptive Layout based on current calibration data for the backend. | +| [`SabreLayout`](qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout")(\*args, \*\*kwargs) | Choose a Layout via iterative bidirectional routing of the input circuit. | +| [`CSPLayout`](qiskit.transpiler.passes.CSPLayout "qiskit.transpiler.passes.CSPLayout")(\*args, \*\*kwargs) | If possible, chooses a Layout as a CSP, using backtracking. | +| [`VF2Layout`](qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout")(\*args, \*\*kwargs) | A pass for choosing a Layout of a circuit onto a Coupling graph, as a a subgraph isomorphism problem, solved by VF2++. | +| [`ApplyLayout`](qiskit.transpiler.passes.ApplyLayout "qiskit.transpiler.passes.ApplyLayout")(\*args, \*\*kwargs) | Transform a circuit with virtual qubits into a circuit with physical qubits. | +| [`Layout2qDistance`](qiskit.transpiler.passes.Layout2qDistance "qiskit.transpiler.passes.Layout2qDistance")(\*args, \*\*kwargs) | Evaluate how good the layout selection was. | +| [`EnlargeWithAncilla`](qiskit.transpiler.passes.EnlargeWithAncilla "qiskit.transpiler.passes.EnlargeWithAncilla")(\*args, \*\*kwargs) | Extend the dag with virtual qubits that are in layout but not in the circuit yet. | +| [`FullAncillaAllocation`](qiskit.transpiler.passes.FullAncillaAllocation "qiskit.transpiler.passes.FullAncillaAllocation")(\*args, \*\*kwargs) | Allocate all idle nodes from the coupling map or target as ancilla on the layout. | +| [`SabrePreLayout`](qiskit.transpiler.passes.SabrePreLayout "qiskit.transpiler.passes.SabrePreLayout")(\*args, \*\*kwargs) | Choose a starting layout to use for additional Sabre layout trials. | ## Routing -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| [`BasicSwap`](qiskit.transpiler.passes.BasicSwap "qiskit.transpiler.passes.BasicSwap")(\*args, \*\*kwargs) | Map (with minimum effort) a DAGCircuit onto a `coupling_map` adding swap gates. | -| [`LookaheadSwap`](qiskit.transpiler.passes.LookaheadSwap "qiskit.transpiler.passes.LookaheadSwap")(\*args, \*\*kwargs) | Map input circuit onto a backend topology via insertion of SWAPs. | -| [`StochasticSwap`](qiskit.transpiler.passes.StochasticSwap "qiskit.transpiler.passes.StochasticSwap")(\*args, \*\*kwargs) | Map a DAGCircuit onto a coupling\_map adding swap gates. | -| [`SabreSwap`](qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap")(\*args, \*\*kwargs) | Map input circuit onto a backend topology via insertion of SWAPs. | -| [`Commuting2qGateRouter`](qiskit.transpiler.passes.Commuting2qGateRouter "qiskit.transpiler.passes.Commuting2qGateRouter")(\*args, \*\*kwargs) | A class to swap route one or more commuting gates to the coupling map. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| [`BasicSwap`](qiskit.transpiler.passes.BasicSwap "qiskit.transpiler.passes.BasicSwap")(\*args, \*\*kwargs) | Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. | +| [`LookaheadSwap`](qiskit.transpiler.passes.LookaheadSwap "qiskit.transpiler.passes.LookaheadSwap")(\*args, \*\*kwargs) | Map input circuit onto a backend topology via insertion of SWAPs. | +| [`StochasticSwap`](qiskit.transpiler.passes.StochasticSwap "qiskit.transpiler.passes.StochasticSwap")(\*args, \*\*kwargs) | Map a DAGCircuit onto a coupling\_map adding swap gates. | +| [`SabreSwap`](qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap")(\*args, \*\*kwargs) | Map input circuit onto a backend topology via insertion of SWAPs. | +| [`Commuting2qGateRouter`](qiskit.transpiler.passes.Commuting2qGateRouter "qiskit.transpiler.passes.Commuting2qGateRouter")(\*args, \*\*kwargs) | A class to swap route one or more commuting gates to the coupling map. | ## Basis Change | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator")(\*args, \*\*kwargs) | Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. | -| [`Decompose`](qiskit.transpiler.passes.Decompose "qiskit.transpiler.passes.Decompose")(\*args, \*\*kwargs) | Expand a gate in a circuit using its decomposition rules. | -| [`TranslateParameterizedGates`](qiskit.transpiler.passes.TranslateParameterizedGates "qiskit.transpiler.passes.TranslateParameterizedGates")(\*args, \*\*kwargs) | Translate parameterized gates to a supported basis set. | -| [`Unroll3qOrMore`](qiskit.transpiler.passes.Unroll3qOrMore "qiskit.transpiler.passes.Unroll3qOrMore")(\*args, \*\*kwargs) | Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. | -| [`UnrollCustomDefinitions`](qiskit.transpiler.passes.UnrollCustomDefinitions "qiskit.transpiler.passes.UnrollCustomDefinitions")(\*args, \*\*kwargs) | Unrolls instructions with custom definitions. | -| [`Unroller`](qiskit.transpiler.passes.Unroller "qiskit.transpiler.passes.Unroller")(\*args, \*\*kwargs) | Unroll a circuit to a given basis. | +| [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator")(\*args, \*\*kwargs) | Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. | +| [`Decompose`](qiskit.transpiler.passes.Decompose "qiskit.transpiler.passes.Decompose")(\*args, \*\*kwargs) | Expand a gate in a circuit using its decomposition rules. | +| [`TranslateParameterizedGates`](qiskit.transpiler.passes.TranslateParameterizedGates "qiskit.transpiler.passes.TranslateParameterizedGates")(\*args, \*\*kwargs) | Translate parameterized gates to a supported basis set. | +| [`Unroll3qOrMore`](qiskit.transpiler.passes.Unroll3qOrMore "qiskit.transpiler.passes.Unroll3qOrMore")(\*args, \*\*kwargs) | Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. | +| [`UnrollCustomDefinitions`](qiskit.transpiler.passes.UnrollCustomDefinitions "qiskit.transpiler.passes.UnrollCustomDefinitions")(\*args, \*\*kwargs) | Unrolls instructions with custom definitions. | +| [`Unroller`](qiskit.transpiler.passes.Unroller "qiskit.transpiler.passes.Unroller")(\*args, \*\*kwargs) | Unroll a circuit to a given basis. | ## Optimizations | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`Optimize1qGates`](qiskit.transpiler.passes.Optimize1qGates "qiskit.transpiler.passes.Optimize1qGates")(\*args, \*\*kwargs) | Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. | -| [`Optimize1qGatesDecomposition`](qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition")(\*args, \*\*kwargs) | Optimize chains of single-qubit gates by combining them into a single gate. | -| [`Collect1qRuns`](qiskit.transpiler.passes.Collect1qRuns "qiskit.transpiler.passes.Collect1qRuns")(\*args, \*\*kwargs) | Collect one-qubit subcircuits. | -| [`Collect2qBlocks`](qiskit.transpiler.passes.Collect2qBlocks "qiskit.transpiler.passes.Collect2qBlocks")(\*args, \*\*kwargs) | Collect two-qubit subcircuits. | -| [`CollectMultiQBlocks`](qiskit.transpiler.passes.CollectMultiQBlocks "qiskit.transpiler.passes.CollectMultiQBlocks")(\*args, \*\*kwargs) | Collect sequences of uninterrupted gates acting on groups of qubits. | -| [`CollectLinearFunctions`](qiskit.transpiler.passes.CollectLinearFunctions "qiskit.transpiler.passes.CollectLinearFunctions")(\*args, \*\*kwargs) | Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). | -| [`CollectCliffords`](qiskit.transpiler.passes.CollectCliffords "qiskit.transpiler.passes.CollectCliffords")(\*args, \*\*kwargs) | Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. | -| [`ConsolidateBlocks`](qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks")(\*args, \*\*kwargs) | Replace each block of consecutive gates by a single Unitary node. | -| [`CXCancellation`](qiskit.transpiler.passes.CXCancellation "qiskit.transpiler.passes.CXCancellation")(\*args, \*\*kwargs) | Cancel back-to-back `cx` gates in dag. | -| [`InverseCancellation`](qiskit.transpiler.passes.InverseCancellation "qiskit.transpiler.passes.InverseCancellation")(\*args, \*\*kwargs) | Cancel specific Gates which are inverses of each other when they occur back-to- back. | -| [`CommutationAnalysis`](qiskit.transpiler.passes.CommutationAnalysis "qiskit.transpiler.passes.CommutationAnalysis")(\*args, \*\*kwargs) | Analysis pass to find commutation relations between DAG nodes. | -| [`CommutativeCancellation`](qiskit.transpiler.passes.CommutativeCancellation "qiskit.transpiler.passes.CommutativeCancellation")(\*args, \*\*kwargs) | Cancel the redundant (self-adjoint) gates through commutation relations. | -| [`CommutativeInverseCancellation`](qiskit.transpiler.passes.CommutativeInverseCancellation "qiskit.transpiler.passes.CommutativeInverseCancellation")(\*args, \*\*kwargs) | Cancel pairs of inverse gates exploiting commutation relations. | -| [`Optimize1qGatesSimpleCommutation`](qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation "qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation")(\*args, \*\*kwargs) | Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and resynthesizing the results. | -| [`RemoveDiagonalGatesBeforeMeasure`](qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure "qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure")(\*args, \*\*kwargs) | Remove diagonal gates (including diagonal 2Q gates) before a measurement. | -| [`RemoveResetInZeroState`](qiskit.transpiler.passes.RemoveResetInZeroState "qiskit.transpiler.passes.RemoveResetInZeroState")(\*args, \*\*kwargs) | Remove reset gate when the qubit is in zero state. | -| [`CrosstalkAdaptiveSchedule`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule")(\*args, \*\*kwargs) | Crosstalk mitigation through adaptive instruction scheduling. | -| [`HoareOptimizer`](qiskit.transpiler.passes.HoareOptimizer "qiskit.transpiler.passes.HoareOptimizer")(\*args, \*\*kwargs) | This is a transpiler pass using Hoare logic circuit optimization. | -| [`TemplateOptimization`](qiskit.transpiler.passes.TemplateOptimization "qiskit.transpiler.passes.TemplateOptimization")(\*args, \*\*kwargs) | Class for the template optimization pass. | -| [`EchoRZXWeylDecomposition`](qiskit.transpiler.passes.EchoRZXWeylDecomposition "qiskit.transpiler.passes.EchoRZXWeylDecomposition")(\*args, \*\*kwargs) | Rewrite two-qubit gates using the Weyl decomposition. | -| [`ResetAfterMeasureSimplification`](qiskit.transpiler.passes.ResetAfterMeasureSimplification "qiskit.transpiler.passes.ResetAfterMeasureSimplification")(\*args, \*\*kwargs) | This pass replaces reset after measure with a conditional X gate. | -| [`OptimizeCliffords`](qiskit.transpiler.passes.OptimizeCliffords "qiskit.transpiler.passes.OptimizeCliffords")(\*args, \*\*kwargs) | Combine consecutive Cliffords over the same qubits. | -| [`NormalizeRXAngle`](qiskit.transpiler.passes.NormalizeRXAngle "qiskit.transpiler.passes.NormalizeRXAngle")(\*args, \*\*kwargs) | Normalize theta parameter of RXGate instruction. | +| [`Optimize1qGates`](qiskit.transpiler.passes.Optimize1qGates "qiskit.transpiler.passes.Optimize1qGates")(\*args, \*\*kwargs) | Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. | +| [`Optimize1qGatesDecomposition`](qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition")(\*args, \*\*kwargs) | Optimize chains of single-qubit gates by combining them into a single gate. | +| [`Collect1qRuns`](qiskit.transpiler.passes.Collect1qRuns "qiskit.transpiler.passes.Collect1qRuns")(\*args, \*\*kwargs) | Collect one-qubit subcircuits. | +| [`Collect2qBlocks`](qiskit.transpiler.passes.Collect2qBlocks "qiskit.transpiler.passes.Collect2qBlocks")(\*args, \*\*kwargs) | Collect two-qubit subcircuits. | +| [`CollectMultiQBlocks`](qiskit.transpiler.passes.CollectMultiQBlocks "qiskit.transpiler.passes.CollectMultiQBlocks")(\*args, \*\*kwargs) | Collect sequences of uninterrupted gates acting on groups of qubits. | +| [`CollectLinearFunctions`](qiskit.transpiler.passes.CollectLinearFunctions "qiskit.transpiler.passes.CollectLinearFunctions")(\*args, \*\*kwargs) | Collect blocks of linear gates ([`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") and [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate") gates) and replaces them by linear functions ([`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.LinearFunction")). | +| [`CollectCliffords`](qiskit.transpiler.passes.CollectCliffords "qiskit.transpiler.passes.CollectCliffords")(\*args, \*\*kwargs) | Collects blocks of Clifford gates and replaces them by a [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") object. | +| [`ConsolidateBlocks`](qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks")(\*args, \*\*kwargs) | Replace each block of consecutive gates by a single Unitary node. | +| [`CXCancellation`](qiskit.transpiler.passes.CXCancellation "qiskit.transpiler.passes.CXCancellation")(\*args, \*\*kwargs) | Cancel back-to-back cx gates in dag. | +| [`InverseCancellation`](qiskit.transpiler.passes.InverseCancellation "qiskit.transpiler.passes.InverseCancellation")(\*args, \*\*kwargs) | Cancel specific Gates which are inverses of each other when they occur back-to- back. | +| [`CommutationAnalysis`](qiskit.transpiler.passes.CommutationAnalysis "qiskit.transpiler.passes.CommutationAnalysis")(\*args, \*\*kwargs) | Analysis pass to find commutation relations between DAG nodes. | +| [`CommutativeCancellation`](qiskit.transpiler.passes.CommutativeCancellation "qiskit.transpiler.passes.CommutativeCancellation")(\*args, \*\*kwargs) | Cancel the redundant (self-adjoint) gates through commutation relations. | +| [`CommutativeInverseCancellation`](qiskit.transpiler.passes.CommutativeInverseCancellation "qiskit.transpiler.passes.CommutativeInverseCancellation")(\*args, \*\*kwargs) | Cancel pairs of inverse gates exploiting commutation relations. | +| [`Optimize1qGatesSimpleCommutation`](qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation "qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation")(\*args, \*\*kwargs) | Optimizes 1Q gate strings interrupted by 2Q gates by commuting the components and re- synthesizing the results. | +| [`RemoveDiagonalGatesBeforeMeasure`](qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure "qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure")(\*args, \*\*kwargs) | Remove diagonal gates (including diagonal 2Q gates) before a measurement. | +| [`RemoveResetInZeroState`](qiskit.transpiler.passes.RemoveResetInZeroState "qiskit.transpiler.passes.RemoveResetInZeroState")(\*args, \*\*kwargs) | Remove reset gate when the qubit is in zero state. | +| [`CrosstalkAdaptiveSchedule`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule")(\*args, \*\*kwargs) | Crosstalk mitigation through adaptive instruction scheduling. | +| [`HoareOptimizer`](qiskit.transpiler.passes.HoareOptimizer "qiskit.transpiler.passes.HoareOptimizer")(\*args, \*\*kwargs) | This is a transpiler pass using Hoare logic circuit optimization. | +| [`TemplateOptimization`](qiskit.transpiler.passes.TemplateOptimization "qiskit.transpiler.passes.TemplateOptimization")(\*args, \*\*kwargs) | Class for the template optimization pass. | +| [`EchoRZXWeylDecomposition`](qiskit.transpiler.passes.EchoRZXWeylDecomposition "qiskit.transpiler.passes.EchoRZXWeylDecomposition")(\*args, \*\*kwargs) | Rewrite two-qubit gates using the Weyl decomposition. | +| [`ResetAfterMeasureSimplification`](qiskit.transpiler.passes.ResetAfterMeasureSimplification "qiskit.transpiler.passes.ResetAfterMeasureSimplification")(\*args, \*\*kwargs) | This pass replaces reset after measure with a conditional X gate. | +| [`OptimizeCliffords`](qiskit.transpiler.passes.OptimizeCliffords "qiskit.transpiler.passes.OptimizeCliffords")(\*args, \*\*kwargs) | Combine consecutive Cliffords over the same qubits. | +| [`NormalizeRXAngle`](qiskit.transpiler.passes.NormalizeRXAngle "qiskit.transpiler.passes.NormalizeRXAngle")(\*args, \*\*kwargs) | Normalize theta parameter of RXGate instruction. | ## Calibration | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | -| [`PulseGates`](qiskit.transpiler.passes.PulseGates "qiskit.transpiler.passes.PulseGates")(\*args, \*\*kwargs) | Pulse gate adding pass. | -| [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.RZXCalibrationBuilder")(\*args, \*\*kwargs) | Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. | -| [`RZXCalibrationBuilderNoEcho`](qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho "qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho")(\*args, \*\*kwargs) | Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. | -| [`RXCalibrationBuilder`](qiskit.transpiler.passes.RXCalibrationBuilder "qiskit.transpiler.passes.RXCalibrationBuilder")(\*args, \*\*kwargs) | Add single-pulse RX calibrations that are bootstrapped from the SX calibration. | +| [`PulseGates`](qiskit.transpiler.passes.PulseGates "qiskit.transpiler.passes.PulseGates")(\*args, \*\*kwargs) | Pulse gate adding pass. | +| [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.RZXCalibrationBuilder")(\*args, \*\*kwargs) | Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. | +| [`RZXCalibrationBuilderNoEcho`](qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho "qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho")(\*args, \*\*kwargs) | Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. | +| [`RXCalibrationBuilder`](qiskit.transpiler.passes.RXCalibrationBuilder "qiskit.transpiler.passes.RXCalibrationBuilder")(\*args, \*\*kwargs) | Add single-pulse RX calibrations that are bootstrapped from the SX calibration. | ## Scheduling | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| [`TimeUnitConversion`](qiskit.transpiler.passes.TimeUnitConversion "qiskit.transpiler.passes.TimeUnitConversion")(\*args, \*\*kwargs) | Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. | -| [`ALAPScheduleAnalysis`](qiskit.transpiler.passes.ALAPScheduleAnalysis "qiskit.transpiler.passes.ALAPScheduleAnalysis")(\*args, \*\*kwargs) | ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. | -| [`ASAPScheduleAnalysis`](qiskit.transpiler.passes.ASAPScheduleAnalysis "qiskit.transpiler.passes.ASAPScheduleAnalysis")(\*args, \*\*kwargs) | ASAP Scheduling pass, which schedules the start time of instructions as early as possible. | -| [`PadDynamicalDecoupling`](qiskit.transpiler.passes.PadDynamicalDecoupling "qiskit.transpiler.passes.PadDynamicalDecoupling")(\*args, \*\*kwargs) | Dynamical decoupling insertion pass. | -| [`PadDelay`](qiskit.transpiler.passes.PadDelay "qiskit.transpiler.passes.PadDelay")(\*args, \*\*kwargs) | Padding idle time with Delay instructions. | -| [`ConstrainedReschedule`](qiskit.transpiler.passes.ConstrainedReschedule "qiskit.transpiler.passes.ConstrainedReschedule")(\*args, \*\*kwargs) | Rescheduler pass that updates node start times to conform to the hardware alignments. | -| [`ValidatePulseGates`](qiskit.transpiler.passes.ValidatePulseGates "qiskit.transpiler.passes.ValidatePulseGates")(\*args, \*\*kwargs) | Check custom gate length. | -| [`InstructionDurationCheck`](qiskit.transpiler.passes.InstructionDurationCheck "qiskit.transpiler.passes.InstructionDurationCheck")(\*args, \*\*kwargs) | Duration validation pass for reschedule. | -| [`SetIOLatency`](qiskit.transpiler.passes.SetIOLatency "qiskit.transpiler.passes.SetIOLatency")(\*args, \*\*kwargs) | Set IOLatency information to the input circuit. | -| [`ALAPSchedule`](qiskit.transpiler.passes.ALAPSchedule "qiskit.transpiler.passes.ALAPSchedule")(\*args, \*\*kwargs) | ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. | -| [`ASAPSchedule`](qiskit.transpiler.passes.ASAPSchedule "qiskit.transpiler.passes.ASAPSchedule")(\*args, \*\*kwargs) | ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. | -| [`DynamicalDecoupling`](qiskit.transpiler.passes.DynamicalDecoupling "qiskit.transpiler.passes.DynamicalDecoupling")(\*args, \*\*kwargs) | Dynamical decoupling insertion pass. | -| [`AlignMeasures`](qiskit.transpiler.passes.AlignMeasures "qiskit.transpiler.passes.AlignMeasures")(\*args, \*\*kwargs) | Measurement alignment. | +| [`TimeUnitConversion`](qiskit.transpiler.passes.TimeUnitConversion "qiskit.transpiler.passes.TimeUnitConversion")(\*args, \*\*kwargs) | Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. | +| [`ALAPScheduleAnalysis`](qiskit.transpiler.passes.ALAPScheduleAnalysis "qiskit.transpiler.passes.ALAPScheduleAnalysis")(\*args, \*\*kwargs) | ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. | +| [`ASAPScheduleAnalysis`](qiskit.transpiler.passes.ASAPScheduleAnalysis "qiskit.transpiler.passes.ASAPScheduleAnalysis")(\*args, \*\*kwargs) | ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. | +| [`PadDynamicalDecoupling`](qiskit.transpiler.passes.PadDynamicalDecoupling "qiskit.transpiler.passes.PadDynamicalDecoupling")(\*args, \*\*kwargs) | Dynamical decoupling insertion pass. | +| [`PadDelay`](qiskit.transpiler.passes.PadDelay "qiskit.transpiler.passes.PadDelay")(\*args, \*\*kwargs) | Padding idle time with Delay instructions. | +| [`ConstrainedReschedule`](qiskit.transpiler.passes.ConstrainedReschedule "qiskit.transpiler.passes.ConstrainedReschedule")(\*args, \*\*kwargs) | Rescheduler pass that updates node start times to conform to the hardware alignments. | +| [`ValidatePulseGates`](qiskit.transpiler.passes.ValidatePulseGates "qiskit.transpiler.passes.ValidatePulseGates")(\*args, \*\*kwargs) | Check custom gate length. | +| [`InstructionDurationCheck`](qiskit.transpiler.passes.InstructionDurationCheck "qiskit.transpiler.passes.InstructionDurationCheck")(\*args, \*\*kwargs) | Duration validation pass for reschedule. | +| [`SetIOLatency`](qiskit.transpiler.passes.SetIOLatency "qiskit.transpiler.passes.SetIOLatency")(\*args, \*\*kwargs) | Set IOLatency information to the input circuit. | +| [`ALAPSchedule`](qiskit.transpiler.passes.ALAPSchedule "qiskit.transpiler.passes.ALAPSchedule")(\*args, \*\*kwargs) | ALAP Scheduling pass, which schedules the **stop** time of instructions as late as possible. | +| [`ASAPSchedule`](qiskit.transpiler.passes.ASAPSchedule "qiskit.transpiler.passes.ASAPSchedule")(\*args, \*\*kwargs) | ASAP Scheduling pass, which schedules the start time of instructions as early as possible.. | +| [`DynamicalDecoupling`](qiskit.transpiler.passes.DynamicalDecoupling "qiskit.transpiler.passes.DynamicalDecoupling")(\*args, \*\*kwargs) | Dynamical decoupling insertion pass. | +| [`AlignMeasures`](qiskit.transpiler.passes.AlignMeasures "qiskit.transpiler.passes.AlignMeasures")(\*args, \*\*kwargs) | Measurement alignment. | ## Circuit Analysis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`Width`](qiskit.transpiler.passes.Width "qiskit.transpiler.passes.Width")(\*args, \*\*kwargs) | Calculate the width of a DAG circuit. | -| [`Depth`](qiskit.transpiler.passes.Depth "qiskit.transpiler.passes.Depth")(\*args, \*\*kwargs) | Calculate the depth of a DAG circuit. | -| [`Size`](qiskit.transpiler.passes.Size "qiskit.transpiler.passes.Size")(\*args, \*\*kwargs) | Calculate the size of a DAG circuit. | -| [`CountOps`](qiskit.transpiler.passes.CountOps "qiskit.transpiler.passes.CountOps")(\*args, \*\*kwargs) | Count the operations in a DAG circuit. | -| [`CountOpsLongestPath`](qiskit.transpiler.passes.CountOpsLongestPath "qiskit.transpiler.passes.CountOpsLongestPath")(\*args, \*\*kwargs) | Count the operations on the longest path in a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"). | -| [`NumTensorFactors`](qiskit.transpiler.passes.NumTensorFactors "qiskit.transpiler.passes.NumTensorFactors")(\*args, \*\*kwargs) | Calculate the number of tensor factors of a DAG circuit. | -| [`DAGLongestPath`](qiskit.transpiler.passes.DAGLongestPath "qiskit.transpiler.passes.DAGLongestPath")(\*args, \*\*kwargs) | Return the longest path in a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") as a list of [`DAGOpNode`](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")s, [`DAGInNode`](qiskit.dagcircuit.DAGInNode "qiskit.dagcircuit.DAGInNode")s, and [`DAGOutNode`](qiskit.dagcircuit.DAGOutNode "qiskit.dagcircuit.DAGOutNode")s. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| [`Width`](qiskit.transpiler.passes.Width "qiskit.transpiler.passes.Width")(\*args, \*\*kwargs) | Calculate the width of a DAG circuit. | +| [`Depth`](qiskit.transpiler.passes.Depth "qiskit.transpiler.passes.Depth")(\*args, \*\*kwargs) | Calculate the depth of a DAG circuit. | +| [`Size`](qiskit.transpiler.passes.Size "qiskit.transpiler.passes.Size")(\*args, \*\*kwargs) | Calculate the size of a DAG circuit. | +| [`CountOps`](qiskit.transpiler.passes.CountOps "qiskit.transpiler.passes.CountOps")(\*args, \*\*kwargs) | Count the operations in a DAG circuit. | +| [`CountOpsLongestPath`](qiskit.transpiler.passes.CountOpsLongestPath "qiskit.transpiler.passes.CountOpsLongestPath")(\*args, \*\*kwargs) | Count the operations on the longest path in a DAGcircuit. | +| [`NumTensorFactors`](qiskit.transpiler.passes.NumTensorFactors "qiskit.transpiler.passes.NumTensorFactors")(\*args, \*\*kwargs) | Calculate the number of tensor factors of a DAG circuit. | +| [`DAGLongestPath`](qiskit.transpiler.passes.DAGLongestPath "qiskit.transpiler.passes.DAGLongestPath")(\*args, \*\*kwargs) | Return the longest path in a DAGcircuit as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. | ## Synthesis | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| [`UnitarySynthesis`](qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis")(\*args, \*\*kwargs) | Synthesize gates according to their basis gates. | -| [`LinearFunctionsSynthesis`](qiskit.transpiler.passes.LinearFunctionsSynthesis "qiskit.transpiler.passes.LinearFunctionsSynthesis")(\*args, \*\*kwargs) | DEPRECATED: Synthesize linear functions. | -| [`LinearFunctionsToPermutations`](qiskit.transpiler.passes.LinearFunctionsToPermutations "qiskit.transpiler.passes.LinearFunctionsToPermutations")(\*args, \*\*kwargs) | Promotes linear functions to permutations when possible. | -| [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis")(\*args, \*\*kwargs) | Synthesize higher-level objects and unroll custom definitions. | -| [`SolovayKitaev`](qiskit.transpiler.passes.SolovayKitaev "qiskit.transpiler.passes.SolovayKitaev")(\*args, \*\*kwargs) | Approximately decompose 1q gates to a discrete basis using the Solovay-Kitaev algorithm. | +| [`UnitarySynthesis`](qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis")(\*args, \*\*kwargs) | Synthesize gates according to their basis gates. | +| [`LinearFunctionsSynthesis`](qiskit.transpiler.passes.LinearFunctionsSynthesis "qiskit.transpiler.passes.LinearFunctionsSynthesis")(\*args, \*\*kwargs) | DEPRECATED: Synthesize linear functions. | +| [`LinearFunctionsToPermutations`](qiskit.transpiler.passes.LinearFunctionsToPermutations "qiskit.transpiler.passes.LinearFunctionsToPermutations")(\*args, \*\*kwargs) | Promotes linear functions to permutations when possible. | +| [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.HighLevelSynthesis")(\*args, \*\*kwargs) | Synthesize higher-level objects and unroll custom definitions. | +| [`SolovayKitaev`](qiskit.transpiler.passes.SolovayKitaev "qiskit.transpiler.passes.SolovayKitaev")(\*args, \*\*kwargs) | Approximately decompose 1q gates to a discrete basis using the Solovay-Kitaev algorithm. | | [`SolovayKitaevSynthesis`](qiskit.transpiler.passes.SolovayKitaevSynthesis "qiskit.transpiler.passes.SolovayKitaevSynthesis")() | A Solovay-Kitaev Qiskit unitary synthesis plugin. | ## Post Layout (Post transpile qubit selection) | | | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| [`VF2PostLayout`](qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout")(\*args, \*\*kwargs) | A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. | +| [`VF2PostLayout`](qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout")(\*args, \*\*kwargs) | A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. | ## Additional Passes | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| [`CheckMap`](qiskit.transpiler.passes.CheckMap "qiskit.transpiler.passes.CheckMap")(\*args, \*\*kwargs) | Check if a DAG circuit is already mapped to a coupling map. | -| [`CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection")(\*args, \*\*kwargs) | Check if the two-qubit gates follow the right direction with respect to the coupling map. | -| [`GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection")(\*args, \*\*kwargs) | Modify asymmetric gates to match the hardware coupling direction. | -| [`MergeAdjacentBarriers`](qiskit.transpiler.passes.MergeAdjacentBarriers "qiskit.transpiler.passes.MergeAdjacentBarriers")(\*args, \*\*kwargs) | Return a circuit with any adjacent barriers merged together. | -| [`RemoveBarriers`](qiskit.transpiler.passes.RemoveBarriers "qiskit.transpiler.passes.RemoveBarriers")(\*args, \*\*kwargs) | Return a circuit with any barrier removed. | -| [`BarrierBeforeFinalMeasurements`](qiskit.transpiler.passes.BarrierBeforeFinalMeasurements "qiskit.transpiler.passes.BarrierBeforeFinalMeasurements")(\*args, \*\*kwargs) | Add a barrier before final measurements. | -| [`RemoveFinalMeasurements`](qiskit.transpiler.passes.RemoveFinalMeasurements "qiskit.transpiler.passes.RemoveFinalMeasurements")(\*args, \*\*kwargs) | Remove final measurements and barriers at the end of a circuit. | -| [`DAGFixedPoint`](qiskit.transpiler.passes.DAGFixedPoint "qiskit.transpiler.passes.DAGFixedPoint")(\*args, \*\*kwargs) | Check if the DAG has reached a fixed point. | -| [`FixedPoint`](qiskit.transpiler.passes.FixedPoint "qiskit.transpiler.passes.FixedPoint")(\*args, \*\*kwargs) | Check if a property reached a fixed point. | -| [`MinimumPoint`](qiskit.transpiler.passes.MinimumPoint "qiskit.transpiler.passes.MinimumPoint")(\*args, \*\*kwargs) | Check if the DAG has reached a relative semi-stable point over previous runs | -| [`ContainsInstruction`](qiskit.transpiler.passes.ContainsInstruction "qiskit.transpiler.passes.ContainsInstruction")(\*args, \*\*kwargs) | An analysis pass to detect if the DAG contains a specific instruction. | -| [`GatesInBasis`](qiskit.transpiler.passes.GatesInBasis "qiskit.transpiler.passes.GatesInBasis")(\*args, \*\*kwargs) | Check if all gates in a DAG are in a given set of gates | -| [`ConvertConditionsToIfOps`](qiskit.transpiler.passes.ConvertConditionsToIfOps "qiskit.transpiler.passes.ConvertConditionsToIfOps")(\*args, \*\*kwargs) | Convert instructions whose `condition` attribute is set to a non-`None` value into the equivalent single-statement `IfElseBlock`. | -| [`UnrollForLoops`](qiskit.transpiler.passes.UnrollForLoops "qiskit.transpiler.passes.UnrollForLoops")(\*args, \*\*kwargs) | `UnrollForLoops` transpilation pass unrolls for-loops when possible. | +| [`CheckMap`](qiskit.transpiler.passes.CheckMap "qiskit.transpiler.passes.CheckMap")(\*args, \*\*kwargs) | Check if a DAG circuit is already mapped to a coupling map. | +| [`CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection")(\*args, \*\*kwargs) | Check if the two-qubit gates follow the right direction with respect to the coupling map. | +| [`GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection")(\*args, \*\*kwargs) | Modify asymmetric gates to match the hardware coupling direction. | +| [`MergeAdjacentBarriers`](qiskit.transpiler.passes.MergeAdjacentBarriers "qiskit.transpiler.passes.MergeAdjacentBarriers")(\*args, \*\*kwargs) | Return a circuit with any adjacent barriers merged together. | +| [`RemoveBarriers`](qiskit.transpiler.passes.RemoveBarriers "qiskit.transpiler.passes.RemoveBarriers")(\*args, \*\*kwargs) | Return a circuit with any barrier removed. | +| [`BarrierBeforeFinalMeasurements`](qiskit.transpiler.passes.BarrierBeforeFinalMeasurements "qiskit.transpiler.passes.BarrierBeforeFinalMeasurements")(\*args, \*\*kwargs) | Add a barrier before final measurements. | +| [`RemoveFinalMeasurements`](qiskit.transpiler.passes.RemoveFinalMeasurements "qiskit.transpiler.passes.RemoveFinalMeasurements")(\*args, \*\*kwargs) | Remove final measurements and barriers at the end of a circuit. | +| [`DAGFixedPoint`](qiskit.transpiler.passes.DAGFixedPoint "qiskit.transpiler.passes.DAGFixedPoint")(\*args, \*\*kwargs) | Check if the DAG has reached a fixed point. | +| [`FixedPoint`](qiskit.transpiler.passes.FixedPoint "qiskit.transpiler.passes.FixedPoint")(\*args, \*\*kwargs) | Check if a property reached a fixed point. | +| [`MinimumPoint`](qiskit.transpiler.passes.MinimumPoint "qiskit.transpiler.passes.MinimumPoint")(\*args, \*\*kwargs) | Check if the DAG has reached a relative semi-stable point over previous runs | +| [`ContainsInstruction`](qiskit.transpiler.passes.ContainsInstruction "qiskit.transpiler.passes.ContainsInstruction")(\*args, \*\*kwargs) | An analysis pass to detect if the DAG contains a specific instruction. | +| [`GatesInBasis`](qiskit.transpiler.passes.GatesInBasis "qiskit.transpiler.passes.GatesInBasis")(\*args, \*\*kwargs) | Check if all gates in a DAG are in a given set of gates | +| [`ConvertConditionsToIfOps`](qiskit.transpiler.passes.ConvertConditionsToIfOps "qiskit.transpiler.passes.ConvertConditionsToIfOps")(\*args, \*\*kwargs) | Convert instructions whose `condition` attribute is set to a non-`None` value into the equivalent single-statement `IfElseBlock`. | +| [`UnrollForLoops`](qiskit.transpiler.passes.UnrollForLoops "qiskit.transpiler.passes.UnrollForLoops")(\*args, \*\*kwargs) | `UnrollForLoops` transpilation pass unrolls for-loops when possible. | diff --git a/docs/api/qiskit/transpiler_plugins.md b/docs/api/qiskit/transpiler_plugins.md index 9ed7aa08d2..291eed59f3 100644 --- a/docs/api/qiskit/transpiler_plugins.md +++ b/docs/api/qiskit/transpiler_plugins.md @@ -99,7 +99,7 @@ Note that the entry point `name = path` is a single string not a Python expressi -`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins(stage_name)` Get a list of installed plugins for a stage. @@ -121,7 +121,7 @@ plugins -`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") +`qiskit.transpiler.preset_passmanagers.plugin.passmanager_stage_plugins(stage)` Return a dict with, for each stage name, the class type of the plugin. diff --git a/docs/api/qiskit/transpiler_preset.md b/docs/api/qiskit/transpiler_preset.md index 87dc4f37f1..86f79011ce 100644 --- a/docs/api/qiskit/transpiler_preset.md +++ b/docs/api/qiskit/transpiler_preset.md @@ -26,7 +26,7 @@ This module contains functions for generating the preset pass managers for the t -`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") +`qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None, *, _skip_target=False)` Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -97,7 +97,7 @@ The preset pass manager for the given options -`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level0.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_0_pass_manager(pass_manager_config)` Level 0 pass manager: no explicit optimization other than mapping to backend. @@ -123,7 +123,7 @@ a level 0 pass manager. -`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level1.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_1_pass_manager(pass_manager_config)` Level 1 pass manager: light optimization by simple adjacent gate collapsing. @@ -147,7 +147,7 @@ a level 1 pass manager. -`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level2.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_2_pass_manager(pass_manager_config)` Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. @@ -173,7 +173,7 @@ a level 2 pass manager. -`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/level3.py "view source code") +`qiskit.transpiler.preset_passmanagers.level_3_pass_manager(pass_manager_config)` Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. @@ -203,7 +203,7 @@ a level 3 pass manager. -`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None, basis_gates=(), target=None)` Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. @@ -217,13 +217,13 @@ a pass manager that populates the `contains_x` properties for each of the contro -`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow(message)` Get a pass manager that always raises an error if control flow is present in a given circuit. -`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` Generate an unroll >3q [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -246,7 +246,7 @@ The unroll 3q or more pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager(coupling_map)` Generate a layout embedding [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -268,7 +268,7 @@ set has been set in earlier stages -`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True, vf2_max_trials=None)` Generate a routing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -294,7 +294,7 @@ The routing pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)` Generate a pre-optimization loop [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -316,7 +316,7 @@ The pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` Generate a basis translation [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") @@ -346,7 +346,7 @@ The basis translation pass manager -`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/transpiler/preset_passmanagers/common.py "view source code") +`qiskit.transpiler.preset_passmanagers.common.generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map, target=None)` Generate a post optimization scheduling [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/utils.md b/docs/api/qiskit/utils.md index 62044afb17..25a7c5bc04 100644 --- a/docs/api/qiskit/utils.md +++ b/docs/api/qiskit/utils.md @@ -20,7 +20,7 @@ python_api_name: qiskit.utils -`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.add_deprecation_to_docstring(func, msg, *, since, pending)` Dynamically insert the deprecation message into `func`’s docstring. @@ -33,7 +33,7 @@ Dynamically insert the deprecation message into `func`’s docstring. -`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arg(name, *, since, additional_msg=None, deprecation_description=None, pending=False, package_name='qiskit', new_alias=None, predicate=None, removal_timeline='no earlier than 3 months after the release date')` Decorator to indicate an argument has been deprecated in some way. @@ -61,7 +61,7 @@ Callable -`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_arguments(kwarg_map, category=, *, since=None)` Deprecated. Instead, use @deprecate\_arg. @@ -81,7 +81,7 @@ Callable -`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_func(*, since, additional_msg=None, pending=False, package_name='qiskit', removal_timeline='no earlier than 3 months after the release date', is_property=False)` Decorator to indicate a function has been deprecated. @@ -108,7 +108,7 @@ Callable -`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/deprecation.py "view source code") +`qiskit.utils.deprecate_function(msg, stacklevel=2, category=, *, since=None)` Deprecated. Instead, use @deprecate\_func. @@ -129,7 +129,7 @@ Callable -`qiskit.utils.local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.local_hardware_info()` Basic hardware information about the local machine. @@ -145,13 +145,13 @@ The hardware information. -`qiskit.utils.is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/multiprocessing.py "view source code") +`qiskit.utils.is_main_process()` Checks whether the current process is the main one -`qiskit.utils.apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/units.py "view source code") +`qiskit.utils.apply_prefix(value, unit)` Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. @@ -182,7 +182,7 @@ Converted value. -`qiskit.utils.detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/units.py "view source code") +`qiskit.utils.detach_prefix(value, decimal=None)` Given a SI unit value, find the most suitable prefix to scale the value. @@ -224,7 +224,7 @@ A tuple of scaled value and prefix. -`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/classtools.py "view source code") +`qiskit.utils.wrap_method(cls, name, *, before=None, after=None)` Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. @@ -247,7 +247,7 @@ If either `before` or `after` are given, they should be callables with a compati -`qiskit.utils.summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/circuit_utils.py "view source code") +`qiskit.utils.summarize_circuits(circuits)` **Summarize circuits based on QuantumCircuit, and five metrics are summarized.** @@ -273,7 +273,7 @@ a formatted string records the summary -`qiskit.utils.get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/entangler_map.py "view source code") +`qiskit.utils.get_entangler_map(map_type, num_qubits, offset=0)` Utility method to get an entangler map among qubits. @@ -297,7 +297,7 @@ A map of qubit index to an array of indexes to which this should be entangled -`qiskit.utils.validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/entangler_map.py "view source code") +`qiskit.utils.validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` Validate a user supplied entangler map and converts entries to ints. @@ -323,7 +323,7 @@ Validated/converted map -`qiskit.utils.has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/backend_utils.py "view source code") +`qiskit.utils.has_ibmq()` Check if IBMQ is installed. @@ -333,7 +333,7 @@ Check if IBMQ is installed. -`qiskit.utils.has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/backend_utils.py "view source code") +`qiskit.utils.has_aer()` Check if Aer is installed. @@ -343,7 +343,7 @@ Check if Aer is installed. -`qiskit.utils.name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/name_unnamed_args.py "view source code") +`qiskit.utils.name_args(mapping, skip=0)` Decorator to convert unnamed arguments to named ones. @@ -416,7 +416,7 @@ Qiskit has several features that are enabled only if certain *optional* dependen | **qiskit.utils.optionals.HAS\_JAX** | Some methods of gradient calculation within [`opflow.gradients`](qiskit.opflow.gradients#module-qiskit.opflow.gradients "qiskit.opflow.gradients") require [JAX](https://github.com/google/jax) for autodifferentiation. | | **qiskit.utils.optionals.HAS\_JUPYTER** | Some of the tests require a complete [Jupyter](https://jupyter.org/) installation to test interactivity features. | | **qiskit.utils.optionals.HAS\_MATPLOTLIB** | Qiskit provides several visualisation tools in the [`visualization`](visualization#module-qiskit.visualization "qiskit.visualization") module. Almost all of these are built using [Matplotlib](https://matplotlib.org/), which must be installed in order to use them. | -| **qiskit.utils.optionals.HAS\_NETWORKX** | No longer used by Qiskit. Internally, Qiskit now uses the high-performance [rustworkx](https://github.com/Qiskit/rustworkx) library as a core dependency, and during the change-over period, it was sometimes convenient to convert things into the Python-only [NetworkX](https://networkx.org/) format. Some tests of application modules, such as [Qiskit Nature](https://qiskit.org/ecosystem/nature/) still use NetworkX. | +| **qiskit.utils.optionals.HAS\_NETWORKX** | No longer used by Qiskit. Internally, Qiskit now uses the high-performance [rustworkx](https://github.com/Qiskit/rustworkx) library as a core dependency, and during the change-over period, it was sometimes convenient to convert things into the Python-only [NetworkX](https://networkx.org/) format. Some tests of application modules, such as [Qiskit Nature](https://qiskit.org/documentation/nature/) still use NetworkX. | | **qiskit.utils.optionals.HAS\_NLOPT** | [NLopt](https://nlopt.readthedocs.io/en/latest/) is a nonlinear optimization library, used by the global optimizers in the [`algorithms.optimizers`](qiskit.algorithms.optimizers#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers") module. | | **qiskit.utils.optionals.HAS\_PIL** | PIL is a Python image-manipulation library. Qiskit actually uses the [pillow](https://pillow.readthedocs.io/en/stable/) fork of PIL if it is available when generating certain visualizations, for example of both [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") and [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") in certain modes. | | **qiskit.utils.optionals.HAS\_PYDOT** | For some graph visualisations, Qiskit uses [pydot](https://github.com/pydot/pydot) as an interface to GraphViz (see [`HAS_GRAPHVIZ`](#qiskit.utils.optionals.HAS_GRAPHVIZ "qiskit.utils.optionals.HAS_GRAPHVIZ")). | @@ -450,7 +450,7 @@ from qiskit.utils import LazyImportTester -`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -579,7 +579,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` 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. @@ -593,7 +593,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/utils/lazy_tester.py "view source code") +`qiskit.utils.LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` 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. diff --git a/docs/api/qiskit/utils_mitigation.md b/docs/api/qiskit/utils_mitigation.md index d8f435a520..2fa30ca8b1 100644 --- a/docs/api/qiskit/utils_mitigation.md +++ b/docs/api/qiskit/utils_mitigation.md @@ -32,6 +32,6 @@ The measurement calibration is used to mitigate measurement errors. The main ide | | | | ----------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`CompleteMeasFitter`](qiskit.utils.mitigation.CompleteMeasFitter "qiskit.utils.mitigation.CompleteMeasFitter")(results, state\_labels\[, ...]) | Deprecated: Measurement correction fitter for a full calibration | -| [`TensoredMeasFitter`](qiskit.utils.mitigation.TensoredMeasFitter "qiskit.utils.mitigation.TensoredMeasFitter")(results, mit\_pattern\[, ...]) | Deprecated: Measurement correction fitter for a tensored calibration. | +| [`CompleteMeasFitter`](qiskit.utils.mitigation.CompleteMeasFitter "qiskit.utils.mitigation.CompleteMeasFitter")(results, state\_labels\[, ...]) | Deprecated: Measurement correction fitter for a full calibration | +| [`TensoredMeasFitter`](qiskit.utils.mitigation.TensoredMeasFitter "qiskit.utils.mitigation.TensoredMeasFitter")(results, mit\_pattern\[, ...]) | Deprecated: Measurement correction fitter for a tensored calibration. | diff --git a/docs/api/qiskit/visualization.md b/docs/api/qiskit/visualization.md index 6eaae07ff2..736a483236 100644 --- a/docs/api/qiskit/visualization.md +++ b/docs/api/qiskit/visualization.md @@ -84,7 +84,7 @@ This section contains functions that visualize measurement outcome counts. | | | | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -| [`plot_histogram`](qiskit.visualization.plot_histogram "qiskit.visualization.plot_histogram")(data\[, figsize, color, ...]) | Plot a histogram of input counts data. | +| [`plot_histogram`](qiskit.visualization.plot_histogram "qiskit.visualization.plot_histogram")(data\[, figsize, color, ...]) | Plot a histogram of input counts data. | ### Example Usage @@ -107,7 +107,7 @@ This section contains functions that visualize sampled distributions. | | | | ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- | -| [`plot_distribution`](qiskit.visualization.plot_distribution "qiskit.visualization.plot_distribution")(data\[, figsize, color, ...]) | Plot a distribution from input sampled data. | +| [`plot_distribution`](qiskit.visualization.plot_distribution "qiskit.visualization.plot_distribution")(data\[, figsize, color, ...]) | Plot a distribution from input sampled data. | ## State Visualizations @@ -115,12 +115,12 @@ This section contains functions that visualize quantum states. | | | | ------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`plot_bloch_vector`](qiskit.visualization.plot_bloch_vector "qiskit.visualization.plot_bloch_vector")(bloch\[, title, ax, ...]) | Plot the Bloch sphere. | -| [`plot_bloch_multivector`](qiskit.visualization.plot_bloch_multivector "qiskit.visualization.plot_bloch_multivector")(state\[, title, ...]) | Plot a Bloch sphere for each qubit. | -| [`plot_state_city`](qiskit.visualization.plot_state_city "qiskit.visualization.plot_state_city")(state\[, title, figsize, ...]) | Plot the cityscape of quantum state. | -| [`plot_state_hinton`](qiskit.visualization.plot_state_hinton "qiskit.visualization.plot_state_hinton")(state\[, title, figsize, ...]) | Plot a hinton diagram for the density matrix of a quantum state. | -| [`plot_state_paulivec`](qiskit.visualization.plot_state_paulivec "qiskit.visualization.plot_state_paulivec")(state\[, title, figsize, ...]) | Plot the Pauli-vector representation of a quantum state as bar graph. | -| [`plot_state_qsphere`](qiskit.visualization.plot_state_qsphere "qiskit.visualization.plot_state_qsphere")(state\[, figsize, ax, ...]) | Plot the qsphere representation of a quantum state. | +| [`plot_bloch_vector`](qiskit.visualization.plot_bloch_vector "qiskit.visualization.plot_bloch_vector")(bloch\[, title, ax, ...]) | Plot the Bloch sphere. | +| [`plot_bloch_multivector`](qiskit.visualization.plot_bloch_multivector "qiskit.visualization.plot_bloch_multivector")(state\[, title, ...]) | Plot a Bloch sphere for each qubit. | +| [`plot_state_city`](qiskit.visualization.plot_state_city "qiskit.visualization.plot_state_city")(state\[, title, figsize, ...]) | Plot the cityscape of quantum state. | +| [`plot_state_hinton`](qiskit.visualization.plot_state_hinton "qiskit.visualization.plot_state_hinton")(state\[, title, figsize, ...]) | Plot a hinton diagram for the density matrix of a quantum state. | +| [`plot_state_paulivec`](qiskit.visualization.plot_state_paulivec "qiskit.visualization.plot_state_paulivec")(state\[, title, figsize, ...]) | Plot the Pauli-vector representation of a quantum state as bar graph. | +| [`plot_state_qsphere`](qiskit.visualization.plot_state_qsphere "qiskit.visualization.plot_state_qsphere")(state\[, figsize, ax, ...]) | Plot the qsphere representation of a quantum state. | @@ -178,35 +178,35 @@ You can find code examples for each visualization functions on the individual fu | | | | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [`plot_gate_map`](qiskit.visualization.plot_gate_map "qiskit.visualization.plot_gate_map")(backend\[, figsize, ...]) | Plots the gate map of a device. | -| [`plot_error_map`](qiskit.visualization.plot_error_map "qiskit.visualization.plot_error_map")(backend\[, figsize, ...]) | Plots the error map of a given backend. | -| [`plot_circuit_layout`](qiskit.visualization.plot_circuit_layout "qiskit.visualization.plot_circuit_layout")(circuit, backend\[, ...]) | Plot the layout of a circuit transpiled for a given target backend. | -| [`plot_coupling_map`](qiskit.visualization.plot_coupling_map "qiskit.visualization.plot_coupling_map")(num\_qubits, ...\[, ...]) | Plots an arbitrary coupling map of qubits (embedded in a plane). | +| [`plot_gate_map`](qiskit.visualization.plot_gate_map "qiskit.visualization.plot_gate_map")(backend\[, figsize, ...]) | Plots the gate map of a device. | +| [`plot_error_map`](qiskit.visualization.plot_error_map "qiskit.visualization.plot_error_map")(backend\[, figsize, ...]) | Plots the error map of a given backend. | +| [`plot_circuit_layout`](qiskit.visualization.plot_circuit_layout "qiskit.visualization.plot_circuit_layout")(circuit, backend\[, ...]) | Plot the layout of a circuit transpiled for a given target backend. | +| [`plot_coupling_map`](qiskit.visualization.plot_coupling_map "qiskit.visualization.plot_coupling_map")(num\_qubits, ...\[, ...]) | Plots an arbitrary coupling map of qubits (embedded in a plane). | ## Circuit Visualizations | | | | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`circuit_drawer`](qiskit.visualization.circuit_drawer "qiskit.visualization.circuit_drawer")(circuit\[, scale, filename, ...]) | Draw the quantum circuit. | +| [`circuit_drawer`](qiskit.visualization.circuit_drawer "qiskit.visualization.circuit_drawer")(circuit\[, scale, filename, ...]) | Draw the quantum circuit. | | [`DefaultStyle`](qiskit.visualization.qcstyle.DefaultStyle "qiskit.visualization.qcstyle.DefaultStyle")() | Creates a Default Style dictionary | ## DAG Visualizations | | | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| [`dag_drawer`](qiskit.visualization.dag_drawer "qiskit.visualization.dag_drawer")(dag\[, scale, filename, style]) | Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. | +| [`dag_drawer`](qiskit.visualization.dag_drawer "qiskit.visualization.dag_drawer")(dag\[, scale, filename, style]) | Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. | ## Pass Manager Visualizations | | | | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -| [`pass_manager_drawer`](qiskit.visualization.pass_manager_drawer "qiskit.visualization.pass_manager_drawer")(pass\_manager\[, ...]) | Draws the pass manager. | +| [`pass_manager_drawer`](qiskit.visualization.pass_manager_drawer "qiskit.visualization.pass_manager_drawer")(pass\_manager\[, ...]) | Draws the pass manager. | ## Pulse Visualizations | | | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------- | -| [`pulse_drawer`](qiskit.visualization.pulse_drawer "qiskit.visualization.pulse_drawer")(program\[, style, backend, ...]) | Generate visualization data for pulse programs. | +| [`pulse_drawer`](qiskit.visualization.pulse_drawer "qiskit.visualization.pulse_drawer")(program\[, style, backend, ...]) | Generate visualization data for pulse programs. | | [`IQXStandard`](qiskit.visualization.pulse.IQXStandard "qiskit.visualization.pulse.IQXStandard")(\*\*kwargs) | Standard pulse stylesheet. | | [`IQXSimple`](qiskit.visualization.pulse.IQXSimple "qiskit.visualization.pulse.IQXSimple")(\*\*kwargs) | Simple pulse stylesheet without channel notation. | | [`IQXDebugging`](qiskit.visualization.pulse.IQXDebugging "qiskit.visualization.pulse.IQXDebugging")(\*\*kwargs) | Pulse stylesheet for pulse programmers. | @@ -215,13 +215,13 @@ You can find code examples for each visualization functions on the individual fu | | | | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | -| [`timeline_drawer`](qiskit.visualization.timeline_drawer "qiskit.visualization.timeline_drawer")(program\[, style, ...]) | Generate visualization data for scheduled circuit programs. | +| [`timeline_drawer`](qiskit.visualization.timeline_drawer "qiskit.visualization.timeline_drawer")(program\[, style, ...]) | Generate visualization data for scheduled circuit programs. | ## Single Qubit State Transition Visualizations | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [`visualize_transition`](qiskit.visualization.visualize_transition "qiskit.visualization.visualize_transition")(circuit\[, trace, ...]) | Creates animation showing transitions between states of a single qubit by applying quantum gates. | +| [`visualize_transition`](qiskit.visualization.visualize_transition "qiskit.visualization.visualize_transition")(circuit\[, trace, ...]) | Creates animation showing transitions between states of a single qubit by applying quantum gates. | @@ -229,13 +229,13 @@ You can find code examples for each visualization functions on the individual fu | | | | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`array_to_latex`](qiskit.visualization.array_to_latex "qiskit.visualization.array_to_latex")(array\[, precision, prefix, ...]) | Latex representation of a complex numpy array (with dimension 1 or 2) | +| [`array_to_latex`](qiskit.visualization.array_to_latex "qiskit.visualization.array_to_latex")(array\[, precision, prefix, ...]) | Latex representation of a complex numpy array (with dimension 1 or 2) | ## Exceptions -`qiskit.visualization.VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/visualization/exceptions.py "view source code") +`qiskit.visualization.VisualizationError(*message)` For visualization specific errors. diff --git a/public/images/api/qiskit/circuit-1.png b/public/images/api/qiskit/circuit-1.png index 1c2f70894d..b987efd67a 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 2184a3d1db..53c9fdbf08 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-3.png b/public/images/api/qiskit/circuit-3.png index 70abaad117..8f0fe114a2 100644 Binary files a/public/images/api/qiskit/circuit-3.png and b/public/images/api/qiskit/circuit-3.png differ diff --git a/public/images/api/qiskit/circuit-4.png b/public/images/api/qiskit/circuit-4.png index d7c78dda55..72d450a640 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-5.png b/public/images/api/qiskit/circuit-5.png index 7aee179357..f6b6a27031 100644 Binary files a/public/images/api/qiskit/circuit-5.png and b/public/images/api/qiskit/circuit-5.png differ diff --git a/public/images/api/qiskit/circuit_library-1.png b/public/images/api/qiskit/circuit_library-1.png index 72bcbd480c..a8369b7059 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 e18ea2cb26..f593d908dc 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 0ed86d0b5e..7a8eec0a4b 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 221ef698c9..c81f63b033 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 67172ed701..1ba366781b 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 3308c5ff27..c0d796ea0e 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 028f7abb74..22d771df52 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 6c33a77d36..7cc9deaac7 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 d994e6f9d7..7cc5047277 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 709fb1d9f8..8b04951b45 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 74bca21ca1..0354962933 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 c0d5a09a57..80b02ee65f 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/pulse-8.png b/public/images/api/qiskit/pulse-8.png index 117643137a..58b876002b 100644 Binary files a/public/images/api/qiskit/pulse-8.png and b/public/images/api/qiskit/pulse-8.png differ diff --git a/public/images/api/qiskit/pulse-9.png b/public/images/api/qiskit/pulse-9.png index 03f919f3a4..b4e033718d 100644 Binary files a/public/images/api/qiskit/pulse-9.png and b/public/images/api/qiskit/pulse-9.png differ diff --git a/public/images/api/qiskit/qasm3-1.png b/public/images/api/qiskit/qasm3-1.png index 6cba6d8d08..40964e7258 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 661a95cdb0..294b507c64 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 efdbb2fb7f..47ea4581c1 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-InstructionSet-1.png b/public/images/api/qiskit/qiskit-circuit-InstructionSet-1.png index 5972fee436..e69818088c 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-InstructionSet-1.png and b/public/images/api/qiskit/qiskit-circuit-InstructionSet-1.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 65197f9471..4fe78fe73e 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 c76fcfa6f4..676f76ce5d 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 6416fa1445..1a7c52b369 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.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1.png index bed92b9fbd..1624e256da 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-1.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2.png index b671b1f223..a3c7e35816 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-2.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3_00.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3_00.png index 964de27b61..8314b22c2d 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3_00.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3_01.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3_01.png index a955f5e132..26b6deeefa 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3_01.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-3_01.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4_00.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4_00.png index 1983f7555f..511a46e934 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4_00.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4_00.png differ diff --git a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4_01.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4_01.png index b4d71abe7d..776a899883 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4_01.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-4_01.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 0ae9bc936c..0a70f8efd9 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-QuantumCircuit-6.png b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-6.png index e4cf276fbe..a37d4c1256 100644 Binary files a/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-6.png and b/public/images/api/qiskit/qiskit-circuit-QuantumCircuit-6.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 e3e6b3a21f..1a5ec90d84 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 6629a96065..4a0a876705 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-FourierChecking-1.png b/public/images/api/qiskit/qiskit-circuit-library-FourierChecking-1.png index c7e797fe94..70fc7e4ad9 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 427ae83fe6..edde3d7853 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 4a2d2383e4..cd39e5c6a4 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 fbc429c73b..1012bfb94d 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 4a2d2383e4..cd39e5c6a4 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 0cfd58528a..0491a60915 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 9f2defd504..2c3ab8da1a 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-HiddenLinearFunction-1.png b/public/images/api/qiskit/qiskit-circuit-library-HiddenLinearFunction-1.png index fb3e85b721..bd6479f022 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 489dea043b..a1b4d59c9f 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 2523d7ae17..5ebd3f9ba9 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 2b2ab94e53..48f4474c64 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-MCMTVChain-1.png b/public/images/api/qiskit/qiskit-circuit-library-MCMTVChain-1.png index 1253fd4c6c..7dc1d75dae 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 f691ead8b5..87dabe174c 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 6fef229c48..80d74dd64c 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-PauliTwoDesign-1.png b/public/images/api/qiskit/qiskit-circuit-library-PauliTwoDesign-1.png index b230d7872f..49bb14beae 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 47ef6b2be4..7b9ec72e44 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 e8ed6f5d10..05b82ffe37 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 77d06791ee..4696cff114 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 0c88f51e8d..f7111faf20 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 b9c0e21f4e..75a1f8d9d5 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 2db3f3a07f..b29616efa3 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 91d531d45f..215655d2eb 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 4be1048636..4dd6c04e22 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 c0ed7e0d04..3914afb916 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 ad1f4c13aa..e9345ea549 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 5f8fadafaa..c8e016db38 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 665698a023..22d813edd4 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-pulse-library-SymbolicPulse-1.png b/public/images/api/qiskit/qiskit-pulse-library-SymbolicPulse-1.png index 8e46724743..1075f5b68d 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 eafeedb5d3..8fbe3c329a 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-passes-DynamicalDecoupling-1_00.png b/public/images/api/qiskit/qiskit-transpiler-passes-DynamicalDecoupling-1_00.png index e70e82bbfd..8d04696ff8 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 a95a101b1a..5842a369e1 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-PadDynamicalDecoupling-1_00.png b/public/images/api/qiskit/qiskit-transpiler-passes-PadDynamicalDecoupling-1_00.png index e70e82bbfd..8d04696ff8 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 a95a101b1a..5842a369e1 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 2bc8782a01..b502dacbe7 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-visualization-circuit_drawer-1.png b/public/images/api/qiskit/qiskit-visualization-circuit_drawer-1.png index 876d54cf34..bee1c619f4 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 abda4e4903..fe0e3066df 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 be62559f95..1f6f2b905f 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 524022b1e0..5000ff0cf3 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 ee6c12d917..dcaf8bcef9 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 09512206ad..8a392d9ef2 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 7b6da4bacf..96888c22d8 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 ba5362517a..25f45fd336 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 ed93a52107..e26d79fce3 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 d44060eff2..873dca7e93 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 26789290ab..731f6caa62 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 c7a958c029..7c14d7fb85 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 6b261ebdaf..b57ad6c858 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 376ed78f0a..b4ae9ed7a4 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 db137e1e93..ae1390787b 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 60511663e8..bc9491db4f 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 eef292ec9c..31e297a351 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 69d0934339..8aa5645312 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 7fcff6d783..69b50863b0 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 b66e2de759..c9ce539d06 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 f3bf28245b..e46fc65ce0 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 870778882c..99f370152c 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-pulse_drawer-1.png b/public/images/api/qiskit/qiskit-visualization-pulse_drawer-1.png index a502bf943f..78f988d6a3 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-pulse_drawer-1.png and b/public/images/api/qiskit/qiskit-visualization-pulse_drawer-1.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-pulse_drawer-2.png b/public/images/api/qiskit/qiskit-visualization-pulse_drawer-2.png index b9da7952a1..f090b7c4f0 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-pulse_drawer-2.png and b/public/images/api/qiskit/qiskit-visualization-pulse_drawer-2.png differ diff --git a/public/images/api/qiskit/qiskit-visualization-pulse_drawer-3.png b/public/images/api/qiskit/qiskit-visualization-pulse_drawer-3.png index 6399d96652..831c2d9f9e 100644 Binary files a/public/images/api/qiskit/qiskit-visualization-pulse_drawer-3.png and b/public/images/api/qiskit/qiskit-visualization-pulse_drawer-3.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 ac358bbca2..e85318c1be 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 338edff9e4..3c7ebe537d 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 af7e8cc271..f6805d7012 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 987f6e15de..875a31dafa 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/transpiler-10.png b/public/images/api/qiskit/transpiler-10.png index c620b1999e..3f66402304 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 75fdf71580..b239341f7e 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 cdb620333e..83433c9ced 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 75fdf71580..b239341f7e 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 d04fd0b015..9858a46a77 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 80558341f9..0b5b13c86c 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 b215be1cbf..d51f5cc8fd 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 4c1cb0ab75..5f36ddaab4 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 d7a21d2707..439fea9d6b 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 3a91123c4b..c666a94ce3 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 22dd235db8..9636f5509a 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 cba1ffeafc..3e9ef52de7 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 9f25599e09..d4c3997074 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 d645f8aea0..138f45edb1 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 2982c1537e..6d3133037e 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 bce0800421..0aee749c22 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 18734b1cce..3b52b018e3 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 e4c9ad7547..98fc2f7d21 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 1e03672a92..b95ad89503 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 1e03672a92..b95ad89503 100644 Binary files a/public/images/api/qiskit/visualization-6.png and b/public/images/api/qiskit/visualization-6.png differ