Regenerate Qiskit 1.0 docs to use precise source code links (#1145)
Part of https://github.com/Qiskit/documentation/issues/517.
This commit is contained in:
Eric Arellano
GitHub
parent
ff55d58f45
commit
2eaf342fe3
|
|
@ -22,7 +22,7 @@ python_api_name: qiskit.assembler
|
|||
|
||||
### assemble\_circuits
|
||||
|
||||
<Function id="qiskit.assembler.assemble_circuits" name="assemble_circuits" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_circuits.py" signature="qiskit.assembler.assemble_circuits(circuits, run_config, qobj_id, qobj_header)">
|
||||
<Function id="qiskit.assembler.assemble_circuits" name="assemble_circuits" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_circuits.py#L302-L408" signature="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.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -65,7 +65,7 @@ python_api_name: qiskit.assembler
|
|||
|
||||
### assemble\_schedules
|
||||
|
||||
<Function id="qiskit.assembler.assemble_schedules" name="assemble_schedules" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_schedules.py" signature="qiskit.assembler.assemble_schedules(schedules, qobj_id, qobj_header, run_config)">
|
||||
<Function id="qiskit.assembler.assemble_schedules" name="assemble_schedules" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/assembler/assemble_schedules.py#L27-L103" signature="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.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -129,7 +129,7 @@ python_api_name: qiskit.assembler
|
|||
|
||||
### disassemble
|
||||
|
||||
<Function id="qiskit.assembler.disassemble" name="disassemble" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/disassemble.py" signature="qiskit.assembler.disassemble(qobj)">
|
||||
<Function id="qiskit.assembler.disassemble" name="disassemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/assembler/disassemble.py#L40-L83" signature="qiskit.assembler.disassemble(qobj)">
|
||||
Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
|
|||
|
|
@ -302,7 +302,7 @@ with qc.switch(cr) as case:
|
|||
|
||||
### random\_circuit
|
||||
|
||||
<Function id="qiskit.circuit.random.random_circuit" name="random_circuit" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/random/utils.py" signature="qiskit.circuit.random.random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)">
|
||||
<Function id="qiskit.circuit.random.random_circuit" name="random_circuit" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/random/utils.py#L23-L209" signature="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.
|
||||
|
||||
This function will generate a random circuit by randomly selecting gates from the set of standard gates in `qiskit.circuit.library.standard_gates`. For example:
|
||||
|
|
@ -345,7 +345,7 @@ Almost all circuit functions and methods will raise a [`CircuitError`](#qiskit.c
|
|||
|
||||
### CircuitError
|
||||
|
||||
<Class id="qiskit.circuit.CircuitError" name="CircuitError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/exceptions.py" signature="qiskit.circuit.CircuitError(*message)">
|
||||
<Class id="qiskit.circuit.CircuitError" name="CircuitError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/exceptions.py#L18-L19" signature="qiskit.circuit.CircuitError(*message)">
|
||||
Base class for errors raised while processing a circuit.
|
||||
|
||||
Set the error message.
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ There are two pathways for constructing expressions. The classes that form [the
|
|||
|
||||
The expression system is based on tree representation. All nodes in the tree are final (uninheritable) instances of the abstract base class:
|
||||
|
||||
<Class id="qiskit.circuit.classical.expr.Expr" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py" signature="qiskit.circuit.classical.expr.Expr">
|
||||
<Class id="qiskit.circuit.classical.expr.Expr" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py#L47-L79" signature="qiskit.circuit.classical.expr.Expr">
|
||||
Root base class of all nodes in the expression tree. The base case should never be instantiated directly.
|
||||
|
||||
This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code.
|
||||
|
|
@ -60,7 +60,7 @@ These objects are mutable and should not be reused in a different location witho
|
|||
|
||||
The entry point from general circuit objects to the expression system is by wrapping the object in a [`Var`](#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node and associating a [`Type`](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.Type") with it.
|
||||
|
||||
<Class id="qiskit.circuit.classical.expr.Var" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py" signature="final class qiskit.circuit.classical.expr.Var(var, type)">
|
||||
<Class id="qiskit.circuit.classical.expr.Var" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py#L109-L168" signature="final class qiskit.circuit.classical.expr.Var(var, type)">
|
||||
A classical variable.
|
||||
|
||||
Variables are immutable after construction, so they can be used as dictionary keys.
|
||||
|
|
@ -68,13 +68,13 @@ The entry point from general circuit objects to the expression system is by wrap
|
|||
|
||||
Similarly, literals used in comparison (such as integers) should be lifted to [`Value`](#qiskit.circuit.classical.expr.Value "qiskit.circuit.classical.expr.Value") nodes with associated types.
|
||||
|
||||
<Class id="qiskit.circuit.classical.expr.Value" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py" signature="final class qiskit.circuit.classical.expr.Value(value, type)">
|
||||
<Class id="qiskit.circuit.classical.expr.Value" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py#L171-L188" signature="final class qiskit.circuit.classical.expr.Value(value, type)">
|
||||
A single scalar value.
|
||||
</Class>
|
||||
|
||||
The operations traditionally associated with pre-, post- or infix operators in programming are represented by the [`Unary`](#qiskit.circuit.classical.expr.Unary "qiskit.circuit.classical.expr.Unary") and [`Binary`](#qiskit.circuit.classical.expr.Binary "qiskit.circuit.classical.expr.Binary") nodes as appropriate. These each take an operation type code, which are exposed as enumerations inside each class as [`Unary.Op`](#qiskit.circuit.classical.expr.Unary.Op "qiskit.circuit.classical.expr.Unary.Op") and [`Binary.Op`](#qiskit.circuit.classical.expr.Binary.Op "qiskit.circuit.classical.expr.Binary.Op") respectively.
|
||||
|
||||
<Class id="qiskit.circuit.classical.expr.Unary" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py" signature="final class qiskit.circuit.classical.expr.Unary(op, operand, type)">
|
||||
<Class id="qiskit.circuit.classical.expr.Unary" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py#L191-L244" signature="final class qiskit.circuit.classical.expr.Unary(op, operand, type)">
|
||||
A unary expression.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -83,7 +83,7 @@ The operations traditionally associated with pre-, post- or infix operators in p
|
|||
* **operand** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – The operand of the operation.
|
||||
* **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – The resolved type of the result.
|
||||
|
||||
<Class id="qiskit.circuit.classical.expr.Unary.Op" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py" signature="Op(value)">
|
||||
<Class id="qiskit.circuit.classical.expr.Unary.Op" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py#L203-L225" signature="Op(value)">
|
||||
Enumeration of the opcodes for unary operations.
|
||||
|
||||
The bitwise negation [`BIT_NOT`](#qiskit.circuit.classical.expr.Unary.Op.BIT_NOT "qiskit.circuit.classical.expr.Unary.Op.BIT_NOT") takes a single bit or an unsigned integer of known width, and returns a value of the same type.
|
||||
|
|
@ -104,7 +104,7 @@ The operations traditionally associated with pre-, post- or infix operators in p
|
|||
</Class>
|
||||
</Class>
|
||||
|
||||
<Class id="qiskit.circuit.classical.expr.Binary" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py" signature="final class qiskit.circuit.classical.expr.Binary(op, left, right, type)">
|
||||
<Class id="qiskit.circuit.classical.expr.Binary" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py#L247-L327" signature="final class qiskit.circuit.classical.expr.Binary(op, left, right, type)">
|
||||
A binary expression.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -114,7 +114,7 @@ The operations traditionally associated with pre-, post- or infix operators in p
|
|||
* **right** ([*Expr*](#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr")) – The right-hand operand.
|
||||
* **type** ([*Type*](#qiskit.circuit.classical.types.Type "qiskit.circuit.classical.types.types.Type")) – The resolved type of the result.
|
||||
|
||||
<Class id="qiskit.circuit.classical.expr.Binary.Op" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py" signature="Op(value)">
|
||||
<Class id="qiskit.circuit.classical.expr.Binary.Op" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py#L260-L306" signature="Op(value)">
|
||||
Enumeration of the opcodes for binary operations.
|
||||
|
||||
The bitwise operations [`BIT_AND`](#qiskit.circuit.classical.expr.Binary.Op.BIT_AND "qiskit.circuit.classical.expr.Binary.Op.BIT_AND"), [`BIT_OR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_OR "qiskit.circuit.classical.expr.Binary.Op.BIT_OR") and [`BIT_XOR`](#qiskit.circuit.classical.expr.Binary.Op.BIT_XOR "qiskit.circuit.classical.expr.Binary.Op.BIT_XOR") apply to two operands of the same type, which must be a single bit or an unsigned integer of fixed width. The resultant type is the same as the two input types.
|
||||
|
|
@ -195,7 +195,7 @@ When constructing expressions, one must ensure that the types are valid for the
|
|||
|
||||
Expressions in this system are defined to act only on certain sets of types. However, values may be cast to a suitable supertype in order to satisfy the typing requirements. In these cases, a node in the expression tree is used to represent the promotion. In all cases where operations note that they “implicitly cast” or “coerce” their arguments, the expression tree must have this node representing the conversion.
|
||||
|
||||
<Class id="qiskit.circuit.classical.expr.Cast" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py" signature="final class qiskit.circuit.classical.expr.Cast(operand, type, implicit=False)">
|
||||
<Class id="qiskit.circuit.classical.expr.Cast" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/expr.py#L82-L106" signature="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.
|
||||
</Class>
|
||||
|
||||
|
|
@ -209,7 +209,7 @@ The functions and methods described in this section are a more user-friendly way
|
|||
|
||||
### lift
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.lift" name="lift" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.lift(value, /, type=None)">
|
||||
<Function id="qiskit.circuit.classical.expr.lift" name="lift" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L94-L147" signature="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").
|
||||
|
||||
If an explicit `type` is given, the typing in the output will reflect that.
|
||||
|
|
@ -247,7 +247,7 @@ You can manually specify casts in cases where the cast is allowed in explicit fo
|
|||
|
||||
### cast
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.cast" name="cast" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.cast(operand, type, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.cast" name="cast" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L150-L165" signature="qiskit.circuit.classical.expr.cast(operand, type, /)">
|
||||
Create an explicit cast from the given value to the given type.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -270,7 +270,7 @@ There are helper constructor functions for each of the unary operations.
|
|||
|
||||
### bit\_not
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.bit_not" name="bit_not" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.bit_not(operand, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.bit_not" name="bit_not" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L168-L183" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -291,7 +291,7 @@ There are helper constructor functions for each of the unary operations.
|
|||
|
||||
### logic\_not
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.logic_not" name="logic_not" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.logic_not(operand, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.logic_not" name="logic_not" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L186-L202" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -314,7 +314,7 @@ Similarly, the binary operations and relations have helper functions defined.
|
|||
|
||||
### bit\_and
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.bit_and" name="bit_and" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.bit_and(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.bit_and" name="bit_and" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L258-L274" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -335,7 +335,7 @@ Similarly, the binary operations and relations have helper functions defined.
|
|||
|
||||
### bit\_or
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.bit_or" name="bit_or" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.bit_or(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.bit_or" name="bit_or" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L277-L293" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -356,7 +356,7 @@ Similarly, the binary operations and relations have helper functions defined.
|
|||
|
||||
### bit\_xor
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.bit_xor" name="bit_xor" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.bit_xor(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.bit_xor" name="bit_xor" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L296-L312" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -377,7 +377,7 @@ Similarly, the binary operations and relations have helper functions defined.
|
|||
|
||||
### logic\_and
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.logic_and" name="logic_and" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.logic_and(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.logic_and" name="logic_and" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L322-L334" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -398,7 +398,7 @@ Similarly, the binary operations and relations have helper functions defined.
|
|||
|
||||
### logic\_or
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.logic_or" name="logic_or" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.logic_or(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.logic_or" name="logic_or" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L337-L349" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -419,7 +419,7 @@ Similarly, the binary operations and relations have helper functions defined.
|
|||
|
||||
### equal
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.equal" name="equal" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.equal(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.equal" name="equal" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L360-L375" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -440,7 +440,7 @@ Similarly, the binary operations and relations have helper functions defined.
|
|||
|
||||
### not\_equal
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.not_equal" name="not_equal" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.not_equal(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.not_equal" name="not_equal" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L378-L393" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -461,7 +461,7 @@ Similarly, the binary operations and relations have helper functions defined.
|
|||
|
||||
### less
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.less" name="less" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.less(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.less" name="less" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L404-L419" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -482,7 +482,7 @@ Similarly, the binary operations and relations have helper functions defined.
|
|||
|
||||
### less\_equal
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.less_equal" name="less_equal" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.less_equal(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.less_equal" name="less_equal" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L422-L437" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -503,7 +503,7 @@ Similarly, the binary operations and relations have helper functions defined.
|
|||
|
||||
### greater
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.greater" name="greater" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.greater(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.greater" name="greater" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L440-L455" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -524,7 +524,7 @@ Similarly, the binary operations and relations have helper functions defined.
|
|||
|
||||
### greater\_equal
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.greater_equal" name="greater_equal" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.greater_equal(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.greater_equal" name="greater_equal" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L458-L473" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -547,7 +547,7 @@ Qiskit’s legacy method for specifying equality conditions for use in condition
|
|||
|
||||
### lift\_legacy\_condition
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.lift_legacy_condition" name="lift_legacy_condition" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py" signature="qiskit.circuit.classical.expr.lift_legacy_condition(condition, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.lift_legacy_condition" name="lift_legacy_condition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/constructors.py#L63-L91" signature="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").
|
||||
|
||||
**Examples**
|
||||
|
|
@ -574,12 +574,12 @@ Qiskit’s legacy method for specifying equality conditions for use in condition
|
|||
|
||||
A typical consumer of the expression tree wants to recursively walk through the tree, potentially statefully, acting on each node differently depending on its type. This is naturally a double-dispatch problem; the logic of ‘what is to be done’ is likely stateful and users should be free to define their own operations, yet each node defines ‘what is being acted on’. We enable this double dispatch by providing a base visitor class for the expression tree.
|
||||
|
||||
<Class id="qiskit.circuit.classical.expr.ExprVisitor" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py" signature="qiskit.circuit.classical.expr.ExprVisitor">
|
||||
<Class id="qiskit.circuit.classical.expr.ExprVisitor" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py#L30-L56" signature="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.
|
||||
|
||||
### visit\_binary
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_binary" name="visit_binary" signature="visit_binary(node, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_binary" name="visit_binary" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py#L52-L53" signature="visit_binary(node, /)">
|
||||
**Return type**
|
||||
|
||||
*\_T\_co*
|
||||
|
|
@ -587,7 +587,7 @@ A typical consumer of the expression tree wants to recursively walk through the
|
|||
|
||||
### visit\_cast
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_cast" name="visit_cast" signature="visit_cast(node, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_cast" name="visit_cast" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py#L55-L56" signature="visit_cast(node, /)">
|
||||
**Return type**
|
||||
|
||||
*\_T\_co*
|
||||
|
|
@ -595,7 +595,7 @@ A typical consumer of the expression tree wants to recursively walk through the
|
|||
|
||||
### visit\_generic
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_generic" name="visit_generic" signature="visit_generic(node, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_generic" name="visit_generic" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py#L40-L41" signature="visit_generic(node, /)">
|
||||
**Return type**
|
||||
|
||||
*\_T\_co*
|
||||
|
|
@ -603,7 +603,7 @@ A typical consumer of the expression tree wants to recursively walk through the
|
|||
|
||||
### visit\_unary
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_unary" name="visit_unary" signature="visit_unary(node, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_unary" name="visit_unary" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py#L49-L50" signature="visit_unary(node, /)">
|
||||
**Return type**
|
||||
|
||||
*\_T\_co*
|
||||
|
|
@ -611,7 +611,7 @@ A typical consumer of the expression tree wants to recursively walk through the
|
|||
|
||||
### visit\_value
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_value" name="visit_value" signature="visit_value(node, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_value" name="visit_value" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py#L46-L47" signature="visit_value(node, /)">
|
||||
**Return type**
|
||||
|
||||
*\_T\_co*
|
||||
|
|
@ -619,7 +619,7 @@ A typical consumer of the expression tree wants to recursively walk through the
|
|||
|
||||
### visit\_var
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_var" name="visit_var" signature="visit_var(node, /)">
|
||||
<Function id="qiskit.circuit.classical.expr.ExprVisitor.visit_var" name="visit_var" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py#L43-L44" signature="visit_var(node, /)">
|
||||
**Return type**
|
||||
|
||||
*\_T\_co*
|
||||
|
|
@ -632,7 +632,7 @@ For the convenience of simple visitors that only need to inspect the variables i
|
|||
|
||||
### iter\_vars
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.iter_vars" name="iter_vars" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py" signature="qiskit.circuit.classical.expr.iter_vars(node)">
|
||||
<Function id="qiskit.circuit.classical.expr.iter_vars" name="iter_vars" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py#L82-L99" signature="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").
|
||||
|
||||
**Examples**
|
||||
|
|
@ -660,7 +660,7 @@ Two expressions can be compared for direct structural equality by using the buil
|
|||
|
||||
### structurally\_equivalent
|
||||
|
||||
<Function id="qiskit.circuit.classical.expr.structurally_equivalent" name="structurally_equivalent" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py" signature="qiskit.circuit.classical.expr.structurally_equivalent(left, right, left_var_key=None, right_var_key=None)">
|
||||
<Function id="qiskit.circuit.classical.expr.structurally_equivalent" name="structurally_equivalent" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/expr/visitors.py#L168-L217" signature="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?
|
||||
|
||||
In other words, are these two expressions the exact same trees, except we compare the `Var.var` fields by calling the appropriate `*_var_key` function on them, and comparing that output for equality. This function does not allow any semantic “equivalences” such as asserting that `a == b` is equivalent to `b == a`; the evaluation order of the operands could, in general, cause such a statement to be false (consider hypothetical `extern` functions that access global state).
|
||||
|
|
@ -721,7 +721,7 @@ The type system of the expression tree is exposed through this module. This is i
|
|||
|
||||
All types inherit from an abstract base class:
|
||||
|
||||
<Class id="qiskit.circuit.classical.types.Type" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py" signature="qiskit.circuit.classical.types.Type">
|
||||
<Class id="qiskit.circuit.classical.types.Type" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py#L49-L80" signature="qiskit.circuit.classical.types.Type">
|
||||
Root base class of all nodes in the type tree. The base case should never be instantiated directly.
|
||||
|
||||
This must not be subclassed by users; subclasses form the internal data of the representation of expressions, and it does not make sense to add more outside of Qiskit library code.
|
||||
|
|
@ -731,11 +731,11 @@ Types should be considered immutable objects, and you must not mutate them. It i
|
|||
|
||||
The two different types available are for Booleans (corresponding to [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") and the literals `True` and `False`), and unsigned integers (corresponding to [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") and Python integers).
|
||||
|
||||
<Class id="qiskit.circuit.classical.types.Bool" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py" signature="final class qiskit.circuit.classical.types.Bool">
|
||||
<Class id="qiskit.circuit.classical.types.Bool" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py#L83-L96" signature="final class qiskit.circuit.classical.types.Bool">
|
||||
The Boolean type. This has exactly two values: `True` and `False`.
|
||||
</Class>
|
||||
|
||||
<Class id="qiskit.circuit.classical.types.Uint" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py" signature="final class qiskit.circuit.classical.types.Uint(width)">
|
||||
<Class id="qiskit.circuit.classical.types.Uint" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/types.py#L99-L117" signature="final class qiskit.circuit.classical.types.Uint(width)">
|
||||
An unsigned integer of fixed bit width.
|
||||
</Class>
|
||||
|
||||
|
|
@ -753,7 +753,7 @@ The low-level interface to querying the subtyping relationship is the [`order()`
|
|||
|
||||
### order
|
||||
|
||||
<Function id="qiskit.circuit.classical.types.order" name="order" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py" signature="qiskit.circuit.classical.types.order(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.types.order" name="order" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py#L76-L93" signature="qiskit.circuit.classical.types.order(left, right, /)">
|
||||
Get the ordering relationship between the two types as an enumeration value.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -780,7 +780,7 @@ The low-level interface to querying the subtyping relationship is the [`order()`
|
|||
|
||||
The return value is an enumeration [`Ordering`](#qiskit.circuit.classical.types.Ordering "qiskit.circuit.classical.types.Ordering") that describes what, if any, subtyping relationship exists between the two types.
|
||||
|
||||
<Class id="qiskit.circuit.classical.types.Ordering" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py" signature="qiskit.circuit.classical.types.Ordering(value)">
|
||||
<Class id="qiskit.circuit.classical.types.Ordering" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py#L38-L55" signature="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.
|
||||
|
||||
Note that the sub-/supertyping relationship is not the same as whether a type can be explicitly cast from one to another.
|
||||
|
|
@ -790,7 +790,7 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis
|
|||
|
||||
### is\_subtype
|
||||
|
||||
<Function id="qiskit.circuit.classical.types.is_subtype" name="is_subtype" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py" signature="qiskit.circuit.classical.types.is_subtype(left, right, /, strict=False)">
|
||||
<Function id="qiskit.circuit.classical.types.is_subtype" name="is_subtype" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py#L96-L116" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -819,7 +819,7 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis
|
|||
|
||||
### is\_supertype
|
||||
|
||||
<Function id="qiskit.circuit.classical.types.is_supertype" name="is_supertype" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py" signature="qiskit.circuit.classical.types.is_supertype(left, right, /, strict=False)">
|
||||
<Function id="qiskit.circuit.classical.types.is_supertype" name="is_supertype" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py#L119-L139" signature="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.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -848,7 +848,7 @@ Some helper methods are then defined in terms of this low-level [`order()`](#qis
|
|||
|
||||
### greater
|
||||
|
||||
<Function id="qiskit.circuit.classical.types.greater" name="greater" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py" signature="qiskit.circuit.classical.types.greater(left, right, /)">
|
||||
<Function id="qiskit.circuit.classical.types.greater" name="greater" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py#L142-L165" signature="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.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -880,7 +880,7 @@ It is common to need to cast values of one type to another type. The casting rul
|
|||
|
||||
### cast\_kind
|
||||
|
||||
<Function id="qiskit.circuit.classical.types.cast_kind" name="cast_kind" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py" signature="qiskit.circuit.classical.types.cast_kind(from_, to_, /)">
|
||||
<Function id="qiskit.circuit.classical.types.cast_kind" name="cast_kind" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py#L203-L222" signature="qiskit.circuit.classical.types.cast_kind(from_, to_, /)">
|
||||
Determine the sort of cast that is required to move from the left type to the right type.
|
||||
|
||||
**Examples**
|
||||
|
|
@ -904,7 +904,7 @@ It is common to need to cast values of one type to another type. The casting rul
|
|||
|
||||
The return values from this function are an enumeration explaining the types of cast that are allowed from the left type to the right type.
|
||||
|
||||
<Class id="qiskit.circuit.classical.types.CastKind" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py" signature="qiskit.circuit.classical.types.CastKind(value)">
|
||||
<Class id="qiskit.circuit.classical.types.CastKind" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classical/types/ordering.py#L168-L184" signature="qiskit.circuit.classical.types.CastKind(value)">
|
||||
A return value indicating the type of cast that can occur from one type to another.
|
||||
</Class>
|
||||
|
||||
|
|
|
|||
|
|
@ -154,34 +154,34 @@ print(diagonal.num_qubits)
|
|||
2
|
||||
```
|
||||
|
||||
| | | | |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | - | ----------------------------------- |
|
||||
| [`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. | | |
|
||||
| [`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. |
|
||||
| [`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. | | |
|
||||
| [`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. | | |
|
||||
| | |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| [`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. |
|
||||
| [`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 $\vec{v}$ where $\|\vec{v}\|_2$ 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. |
|
||||
| [`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. |
|
||||
|
||||
## Boolean Logic Circuits
|
||||
|
||||
|
|
@ -326,7 +326,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_2a\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_2a_1" name="template_nct_2a_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_2a_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_2a_1" name="template_nct_2a_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_1.py#L24-L32" signature="qiskit.circuit.library.templates.nct.template_nct_2a_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -338,7 +338,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_2a\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_2a_2" name="template_nct_2a_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_2.py" signature="qiskit.circuit.library.templates.nct.template_nct_2a_2()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_2a_2" name="template_nct_2a_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_2.py#L25-L33" signature="qiskit.circuit.library.templates.nct.template_nct_2a_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -350,7 +350,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_2a\_3
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_2a_3" name="template_nct_2a_3" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_3.py" signature="qiskit.circuit.library.templates.nct.template_nct_2a_3()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_2a_3" name="template_nct_2a_3" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_2a_3.py#L27-L35" signature="qiskit.circuit.library.templates.nct.template_nct_2a_3()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -362,7 +362,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_4a\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_4a_1" name="template_nct_4a_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_4a_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_4a_1" name="template_nct_4a_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_1.py#L31-L41" signature="qiskit.circuit.library.templates.nct.template_nct_4a_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -374,7 +374,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_4a\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_4a_2" name="template_nct_4a_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_2.py" signature="qiskit.circuit.library.templates.nct.template_nct_4a_2()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_4a_2" name="template_nct_4a_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_2.py#L29-L39" signature="qiskit.circuit.library.templates.nct.template_nct_4a_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -386,7 +386,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_4a\_3
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_4a_3" name="template_nct_4a_3" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_3.py" signature="qiskit.circuit.library.templates.nct.template_nct_4a_3()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_4a_3" name="template_nct_4a_3" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4a_3.py#L27-L37" signature="qiskit.circuit.library.templates.nct.template_nct_4a_3()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -398,7 +398,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_4b\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_4b_1" name="template_nct_4b_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4b_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_4b_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_4b_1" name="template_nct_4b_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4b_1.py#L29-L39" signature="qiskit.circuit.library.templates.nct.template_nct_4b_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -410,7 +410,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_4b\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_4b_2" name="template_nct_4b_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4b_2.py" signature="qiskit.circuit.library.templates.nct.template_nct_4b_2()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_4b_2" name="template_nct_4b_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_4b_2.py#L27-L37" signature="qiskit.circuit.library.templates.nct.template_nct_4b_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -422,7 +422,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_5a\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_5a_1" name="template_nct_5a_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_5a_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_5a_1" name="template_nct_5a_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_1.py#L27-L38" signature="qiskit.circuit.library.templates.nct.template_nct_5a_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -434,7 +434,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_5a\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_5a_2" name="template_nct_5a_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_2.py" signature="qiskit.circuit.library.templates.nct.template_nct_5a_2()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_5a_2" name="template_nct_5a_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_2.py#L27-L38" signature="qiskit.circuit.library.templates.nct.template_nct_5a_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -446,7 +446,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_5a\_3
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_5a_3" name="template_nct_5a_3" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_3.py" signature="qiskit.circuit.library.templates.nct.template_nct_5a_3()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_5a_3" name="template_nct_5a_3" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_3.py#L27-L38" signature="qiskit.circuit.library.templates.nct.template_nct_5a_3()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -458,7 +458,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_5a\_4
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_5a_4" name="template_nct_5a_4" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_4.py" signature="qiskit.circuit.library.templates.nct.template_nct_5a_4()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_5a_4" name="template_nct_5a_4" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_5a_4.py#L26-L37" signature="qiskit.circuit.library.templates.nct.template_nct_5a_4()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -470,7 +470,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_6a\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6a_1" name="template_nct_6a_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_6a_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6a_1" name="template_nct_6a_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_1.py#L26-L38" signature="qiskit.circuit.library.templates.nct.template_nct_6a_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -482,7 +482,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_6a\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6a_2" name="template_nct_6a_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_2.py" signature="qiskit.circuit.library.templates.nct.template_nct_6a_2()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6a_2" name="template_nct_6a_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_2.py#L27-L39" signature="qiskit.circuit.library.templates.nct.template_nct_6a_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -494,7 +494,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_6a\_3
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6a_3" name="template_nct_6a_3" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_3.py" signature="qiskit.circuit.library.templates.nct.template_nct_6a_3()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6a_3" name="template_nct_6a_3" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_3.py#L27-L39" signature="qiskit.circuit.library.templates.nct.template_nct_6a_3()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -506,7 +506,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_6a\_4
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6a_4" name="template_nct_6a_4" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_4.py" signature="qiskit.circuit.library.templates.nct.template_nct_6a_4()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6a_4" name="template_nct_6a_4" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6a_4.py#L27-L39" signature="qiskit.circuit.library.templates.nct.template_nct_6a_4()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -518,7 +518,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_6b\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6b_1" name="template_nct_6b_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6b_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_6b_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6b_1" name="template_nct_6b_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6b_1.py#L27-L39" signature="qiskit.circuit.library.templates.nct.template_nct_6b_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -530,7 +530,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_6b\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6b_2" name="template_nct_6b_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6b_2.py" signature="qiskit.circuit.library.templates.nct.template_nct_6b_2()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6b_2" name="template_nct_6b_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6b_2.py#L27-L39" signature="qiskit.circuit.library.templates.nct.template_nct_6b_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -542,7 +542,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_6c\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6c_1" name="template_nct_6c_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6c_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_6c_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_6c_1" name="template_nct_6c_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_6c_1.py#L27-L39" signature="qiskit.circuit.library.templates.nct.template_nct_6c_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -554,7 +554,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_7a\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_7a_1" name="template_nct_7a_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7a_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_7a_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_7a_1" name="template_nct_7a_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7a_1.py#L28-L41" signature="qiskit.circuit.library.templates.nct.template_nct_7a_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -566,7 +566,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_7b\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_7b_1" name="template_nct_7b_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7b_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_7b_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_7b_1" name="template_nct_7b_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7b_1.py#L28-L41" signature="qiskit.circuit.library.templates.nct.template_nct_7b_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -578,7 +578,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_7c\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_7c_1" name="template_nct_7c_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7c_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_7c_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_7c_1" name="template_nct_7c_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7c_1.py#L28-L41" signature="qiskit.circuit.library.templates.nct.template_nct_7c_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -590,7 +590,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_7d\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_7d_1" name="template_nct_7d_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7d_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_7d_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_7d_1" name="template_nct_7d_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7d_1.py#L28-L41" signature="qiskit.circuit.library.templates.nct.template_nct_7d_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -602,7 +602,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_7e\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_7e_1" name="template_nct_7e_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7e_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_7e_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_7e_1" name="template_nct_7e_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_7e_1.py#L28-L41" signature="qiskit.circuit.library.templates.nct.template_nct_7e_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -614,7 +614,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9a\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9a_1" name="template_nct_9a_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9a_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_9a_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9a_1" name="template_nct_9a_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9a_1.py#L28-L43" signature="qiskit.circuit.library.templates.nct.template_nct_9a_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -626,7 +626,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_1" name="template_nct_9c_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_1" name="template_nct_9c_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_1.py#L26-L41" signature="qiskit.circuit.library.templates.nct.template_nct_9c_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -638,7 +638,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_2" name="template_nct_9c_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_2.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_2()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_2" name="template_nct_9c_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_2.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9c_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -650,7 +650,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_3
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_3" name="template_nct_9c_3" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_3.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_3()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_3" name="template_nct_9c_3" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_3.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9c_3()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -662,7 +662,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_4
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_4" name="template_nct_9c_4" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_4.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_4()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_4" name="template_nct_9c_4" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_4.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9c_4()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -674,7 +674,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_5
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_5" name="template_nct_9c_5" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_5.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_5()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_5" name="template_nct_9c_5" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_5.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9c_5()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -686,7 +686,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_6
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_6" name="template_nct_9c_6" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_6.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_6()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_6" name="template_nct_9c_6" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_6.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9c_6()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -698,7 +698,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_7
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_7" name="template_nct_9c_7" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_7.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_7()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_7" name="template_nct_9c_7" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_7.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9c_7()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -710,7 +710,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_8
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_8" name="template_nct_9c_8" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_8.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_8()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_8" name="template_nct_9c_8" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_8.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9c_8()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -722,7 +722,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_9
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_9" name="template_nct_9c_9" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_9.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_9()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_9" name="template_nct_9c_9" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_9.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9c_9()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -734,7 +734,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_10
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_10" name="template_nct_9c_10" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_10.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_10()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_10" name="template_nct_9c_10" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_10.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9c_10()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -746,7 +746,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_11
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_11" name="template_nct_9c_11" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_11.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_11()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_11" name="template_nct_9c_11" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_11.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9c_11()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -758,7 +758,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9c\_12
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_12" name="template_nct_9c_12" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_12.py" signature="qiskit.circuit.library.templates.nct.template_nct_9c_12()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9c_12" name="template_nct_9c_12" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9c_12.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9c_12()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -770,7 +770,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9d\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_1" name="template_nct_9d_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_1.py" signature="qiskit.circuit.library.templates.nct.template_nct_9d_1()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_1" name="template_nct_9d_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_1.py#L26-L41" signature="qiskit.circuit.library.templates.nct.template_nct_9d_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -782,7 +782,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9d\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_2" name="template_nct_9d_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_2.py" signature="qiskit.circuit.library.templates.nct.template_nct_9d_2()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_2" name="template_nct_9d_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_2.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9d_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -794,7 +794,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9d\_3
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_3" name="template_nct_9d_3" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_3.py" signature="qiskit.circuit.library.templates.nct.template_nct_9d_3()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_3" name="template_nct_9d_3" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_3.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9d_3()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -806,7 +806,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9d\_4
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_4" name="template_nct_9d_4" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_4.py" signature="qiskit.circuit.library.templates.nct.template_nct_9d_4()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_4" name="template_nct_9d_4" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_4.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9d_4()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -818,7 +818,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9d\_5
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_5" name="template_nct_9d_5" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_5.py" signature="qiskit.circuit.library.templates.nct.template_nct_9d_5()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_5" name="template_nct_9d_5" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_5.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9d_5()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -830,7 +830,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9d\_6
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_6" name="template_nct_9d_6" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_6.py" signature="qiskit.circuit.library.templates.nct.template_nct_9d_6()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_6" name="template_nct_9d_6" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_6.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9d_6()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -842,7 +842,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9d\_7
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_7" name="template_nct_9d_7" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_7.py" signature="qiskit.circuit.library.templates.nct.template_nct_9d_7()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_7" name="template_nct_9d_7" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_7.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9d_7()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -854,7 +854,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9d\_8
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_8" name="template_nct_9d_8" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_8.py" signature="qiskit.circuit.library.templates.nct.template_nct_9d_8()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_8" name="template_nct_9d_8" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_8.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9d_8()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -866,7 +866,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9d\_9
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_9" name="template_nct_9d_9" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_9.py" signature="qiskit.circuit.library.templates.nct.template_nct_9d_9()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_9" name="template_nct_9d_9" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_9.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9d_9()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -878,7 +878,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib
|
|||
|
||||
### template\_nct\_9d\_10
|
||||
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_10" name="template_nct_9d_10" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_10.py" signature="qiskit.circuit.library.templates.nct.template_nct_9d_10()">
|
||||
<Function id="qiskit.circuit.library.templates.nct.template_nct_9d_10" name="template_nct_9d_10" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/nct/template_nct_9d_10.py#L27-L42" signature="qiskit.circuit.library.templates.nct.template_nct_9d_10()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -894,7 +894,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_2\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_2_1" name="clifford_2_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_1.py" signature="qiskit.circuit.library.clifford_2_1()">
|
||||
<Function id="qiskit.circuit.library.clifford_2_1" name="clifford_2_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_1.py#L25-L33" signature="qiskit.circuit.library.clifford_2_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -906,7 +906,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_2\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_2_2" name="clifford_2_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_2.py" signature="qiskit.circuit.library.clifford_2_2()">
|
||||
<Function id="qiskit.circuit.library.clifford_2_2" name="clifford_2_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_2.py#L26-L34" signature="qiskit.circuit.library.clifford_2_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -918,7 +918,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_2\_3
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_2_3" name="clifford_2_3" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_3.py" signature="qiskit.circuit.library.clifford_2_3()">
|
||||
<Function id="qiskit.circuit.library.clifford_2_3" name="clifford_2_3" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_3.py#L24-L32" signature="qiskit.circuit.library.clifford_2_3()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -930,7 +930,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_2\_4
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_2_4" name="clifford_2_4" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_4.py" signature="qiskit.circuit.library.clifford_2_4()">
|
||||
<Function id="qiskit.circuit.library.clifford_2_4" name="clifford_2_4" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_2_4.py#L25-L33" signature="qiskit.circuit.library.clifford_2_4()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -942,7 +942,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_3\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_3_1" name="clifford_3_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_3_1.py" signature="qiskit.circuit.library.clifford_3_1()">
|
||||
<Function id="qiskit.circuit.library.clifford_3_1" name="clifford_3_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_3_1.py#L25-L34" signature="qiskit.circuit.library.clifford_3_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -954,7 +954,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_4\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_4_1" name="clifford_4_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_1.py" signature="qiskit.circuit.library.clifford_4_1()">
|
||||
<Function id="qiskit.circuit.library.clifford_4_1" name="clifford_4_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_1.py#L27-L37" signature="qiskit.circuit.library.clifford_4_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -966,7 +966,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_4\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_4_2" name="clifford_4_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_2.py" signature="qiskit.circuit.library.clifford_4_2()">
|
||||
<Function id="qiskit.circuit.library.clifford_4_2" name="clifford_4_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_2.py#L26-L36" signature="qiskit.circuit.library.clifford_4_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -978,7 +978,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_4\_3
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_4_3" name="clifford_4_3" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_3.py" signature="qiskit.circuit.library.clifford_4_3()">
|
||||
<Function id="qiskit.circuit.library.clifford_4_3" name="clifford_4_3" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_3.py#L27-L37" signature="qiskit.circuit.library.clifford_4_3()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -990,7 +990,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_4\_4
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_4_4" name="clifford_4_4" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_4.py" signature="qiskit.circuit.library.clifford_4_4()">
|
||||
<Function id="qiskit.circuit.library.clifford_4_4" name="clifford_4_4" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_4_4.py#L26-L36" signature="qiskit.circuit.library.clifford_4_4()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -1002,7 +1002,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_5\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_5_1" name="clifford_5_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_5_1.py" signature="qiskit.circuit.library.clifford_5_1()">
|
||||
<Function id="qiskit.circuit.library.clifford_5_1" name="clifford_5_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_5_1.py#L28-L39" signature="qiskit.circuit.library.clifford_5_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -1014,7 +1014,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_6\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_6_1" name="clifford_6_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_1.py" signature="qiskit.circuit.library.clifford_6_1()">
|
||||
<Function id="qiskit.circuit.library.clifford_6_1" name="clifford_6_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_1.py#L27-L39" signature="qiskit.circuit.library.clifford_6_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -1026,7 +1026,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_6\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_6_2" name="clifford_6_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_2.py" signature="qiskit.circuit.library.clifford_6_2()">
|
||||
<Function id="qiskit.circuit.library.clifford_6_2" name="clifford_6_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_2.py#L27-L39" signature="qiskit.circuit.library.clifford_6_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -1038,7 +1038,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_6\_3
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_6_3" name="clifford_6_3" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_3.py" signature="qiskit.circuit.library.clifford_6_3()">
|
||||
<Function id="qiskit.circuit.library.clifford_6_3" name="clifford_6_3" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_3.py#L27-L39" signature="qiskit.circuit.library.clifford_6_3()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -1050,7 +1050,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_6\_4
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_6_4" name="clifford_6_4" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_4.py" signature="qiskit.circuit.library.clifford_6_4()">
|
||||
<Function id="qiskit.circuit.library.clifford_6_4" name="clifford_6_4" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_4.py#L25-L37" signature="qiskit.circuit.library.clifford_6_4()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -1062,7 +1062,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_6\_5
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_6_5" name="clifford_6_5" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_5.py" signature="qiskit.circuit.library.clifford_6_5()">
|
||||
<Function id="qiskit.circuit.library.clifford_6_5" name="clifford_6_5" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_6_5.py#L27-L39" signature="qiskit.circuit.library.clifford_6_5()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -1074,7 +1074,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_8\_1
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_8_1" name="clifford_8_1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_1.py" signature="qiskit.circuit.library.clifford_8_1()">
|
||||
<Function id="qiskit.circuit.library.clifford_8_1" name="clifford_8_1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_1.py#L27-L41" signature="qiskit.circuit.library.clifford_8_1()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -1086,7 +1086,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_8\_2
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_8_2" name="clifford_8_2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_2.py" signature="qiskit.circuit.library.clifford_8_2()">
|
||||
<Function id="qiskit.circuit.library.clifford_8_2" name="clifford_8_2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_2.py#L27-L41" signature="qiskit.circuit.library.clifford_8_2()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -1098,7 +1098,7 @@ Template circuits over Clifford gates.
|
|||
|
||||
### clifford\_8\_3
|
||||
|
||||
<Function id="qiskit.circuit.library.clifford_8_3" name="clifford_8_3" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_3.py" signature="qiskit.circuit.library.clifford_8_3()">
|
||||
<Function id="qiskit.circuit.library.clifford_8_3" name="clifford_8_3" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/clifford/clifford_8_3.py#L26-L40" signature="qiskit.circuit.library.clifford_8_3()">
|
||||
**Returns**
|
||||
|
||||
template as a quantum circuit.
|
||||
|
|
@ -1114,37 +1114,37 @@ Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circui
|
|||
|
||||
### rzx\_yz
|
||||
|
||||
<Function id="qiskit.circuit.library.rzx_yz" name="rzx_yz" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_yz.py" signature="qiskit.circuit.library.rzx_yz(theta=None)">
|
||||
<Function id="qiskit.circuit.library.rzx_yz" name="rzx_yz" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_yz.py#L30-L43" signature="qiskit.circuit.library.rzx_yz(theta=None)">
|
||||
Template for CX - RYGate - CX.
|
||||
</Function>
|
||||
|
||||
### rzx\_xz
|
||||
|
||||
<Function id="qiskit.circuit.library.rzx_xz" name="rzx_xz" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_xz.py" signature="qiskit.circuit.library.rzx_xz(theta=None)">
|
||||
<Function id="qiskit.circuit.library.rzx_xz" name="rzx_xz" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_xz.py#L36-L53" signature="qiskit.circuit.library.rzx_xz(theta=None)">
|
||||
Template for CX - RXGate - CX.
|
||||
</Function>
|
||||
|
||||
### rzx\_cy
|
||||
|
||||
<Function id="qiskit.circuit.library.rzx_cy" name="rzx_cy" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_cy.py" signature="qiskit.circuit.library.rzx_cy(theta=None)">
|
||||
<Function id="qiskit.circuit.library.rzx_cy" name="rzx_cy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_cy.py#L31-L46" signature="qiskit.circuit.library.rzx_cy(theta=None)">
|
||||
Template for CX - RYGate - CX.
|
||||
</Function>
|
||||
|
||||
### rzx\_zz1
|
||||
|
||||
<Function id="qiskit.circuit.library.rzx_zz1" name="rzx_zz1" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz1.py" signature="qiskit.circuit.library.rzx_zz1(theta=None)">
|
||||
<Function id="qiskit.circuit.library.rzx_zz1" name="rzx_zz1" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz1.py#L40-L67" signature="qiskit.circuit.library.rzx_zz1(theta=None)">
|
||||
Template for CX - RZGate - CX.
|
||||
</Function>
|
||||
|
||||
### rzx\_zz2
|
||||
|
||||
<Function id="qiskit.circuit.library.rzx_zz2" name="rzx_zz2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz2.py" signature="qiskit.circuit.library.rzx_zz2(theta=None)">
|
||||
<Function id="qiskit.circuit.library.rzx_zz2" name="rzx_zz2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz2.py#L36-L58" signature="qiskit.circuit.library.rzx_zz2(theta=None)">
|
||||
Template for CX - RZGate - CX.
|
||||
</Function>
|
||||
|
||||
### rzx\_zz3
|
||||
|
||||
<Function id="qiskit.circuit.library.rzx_zz3" name="rzx_zz3" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz3.py" signature="qiskit.circuit.library.rzx_zz3(theta=None)">
|
||||
<Function id="qiskit.circuit.library.rzx_zz3" name="rzx_zz3" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/templates/rzx/rzx_zz3.py#L35-L57" signature="qiskit.circuit.library.rzx_zz3(theta=None)">
|
||||
Template for CX - RZGate - CX.
|
||||
</Function>
|
||||
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ assert XGate() is XGate()
|
|||
|
||||
The public classes correspond to the standard classes [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") and [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), respectively, and are subclasses of these.
|
||||
|
||||
<Class id="qiskit.circuit.singleton.SingletonInstruction" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py" signature="qiskit.circuit.singleton.SingletonInstruction(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.singleton.SingletonInstruction" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py#L503-L522" signature="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.
|
||||
|
||||
This class should be used for instruction classes that have fixed definitions and do not contain any unique state. The canonical example of something like this is [`Measure`](qiskit.circuit.library.Measure "qiskit.circuit.library.Measure") which has an immutable definition and any instance of [`Measure`](qiskit.circuit.library.Measure "qiskit.circuit.library.Measure") is the same. Using singleton instructions as a base class for these types of gate classes provides a large advantage in the memory footprint of multiple instructions.
|
||||
|
|
@ -52,13 +52,13 @@ The public classes correspond to the standard classes [`Instruction`](qiskit.cir
|
|||
The exception to be aware of with this class though are the [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") attributes [`label`](qiskit.circuit.Instruction#label "qiskit.circuit.Instruction.label"), [`condition`](qiskit.circuit.Instruction#condition "qiskit.circuit.Instruction.condition"), [`duration`](qiskit.circuit.Instruction#duration "qiskit.circuit.Instruction.duration"), and [`unit`](qiskit.circuit.Instruction#unit "qiskit.circuit.Instruction.unit") which can be set differently for specific instances of gates. For [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction") usage to be sound setting these attributes is not available and they can only be set at creation time, or on an object that has been specifically made mutable using [`to_mutable()`](qiskit.circuit.Instruction#to_mutable "qiskit.circuit.Instruction.to_mutable"). If any of these attributes are used during creation, then instead of using a single shared global instance of the same gate a new separate instance will be created.
|
||||
</Class>
|
||||
|
||||
<Class id="qiskit.circuit.singleton.SingletonGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py" signature="qiskit.circuit.singleton.SingletonGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.singleton.SingletonGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py#L534-L541" signature="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.
|
||||
|
||||
This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") semantics as well. The same caveats around setting attributes in that class apply here as well.
|
||||
</Class>
|
||||
|
||||
<Class id="qiskit.circuit.singleton.SingletonControlledGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py" signature="qiskit.circuit.singleton.SingletonControlledGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.singleton.SingletonControlledGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py#L554-L566" signature="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
|
||||
|
||||
This class is very similar to [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstruction "qiskit.circuit.singleton.SingletonInstruction"), except implies unitary [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") semantics as well. The same caveats around setting attributes in that class apply here as well.
|
||||
|
|
@ -120,7 +120,7 @@ Subclasses of [`SingletonInstruction`](#qiskit.circuit.singleton.SingletonInstru
|
|||
|
||||
### \_singleton\_lookup\_key
|
||||
|
||||
<Function id="qiskit.circuit.singleton.SingletonInstruction._singleton_lookup_key" name="_singleton_lookup_key" signature="static SingletonInstruction._singleton_lookup_key(*_args, **_kwargs)">
|
||||
<Function id="qiskit.circuit.singleton.SingletonInstruction._singleton_lookup_key" name="_singleton_lookup_key" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/singleton.py#L411-L451" signature="static SingletonInstruction._singleton_lookup_key(*_args, **_kwargs)">
|
||||
Given the arguments to the constructor, return a key tuple that identifies the singleton instance to retrieve, or `None` if the arguments imply that a mutable object must be created.
|
||||
|
||||
For performance, as a special case, this method will not be called if the class constructor was given zero arguments (e.g. the construction `XGate()` will not call this method, but `XGate(label=None)` will), and the default singleton will immediately be returned.
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ python_api_name: qiskit.compiler
|
|||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.compiler.assemble" name="assemble" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/assembler.py" signature="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)">
|
||||
<Function id="qiskit.compiler.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/compiler/assembler.py#L42-L220" signature="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`.
|
||||
|
||||
This function serializes the payloads, which could be either circuits or schedules, to create `Qobj` “experiments”. It further annotates the experiment payload with header and configurations.
|
||||
|
|
@ -103,7 +103,7 @@ python_api_name: qiskit.compiler
|
|||
|
||||
### schedule
|
||||
|
||||
<Function id="qiskit.compiler.schedule" name="schedule" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/scheduler.py" signature="qiskit.compiler.schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)">
|
||||
<Function id="qiskit.compiler.schedule" name="schedule" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/compiler/scheduler.py#L38-L107" signature="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`.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -130,7 +130,7 @@ python_api_name: qiskit.compiler
|
|||
|
||||
### transpile
|
||||
|
||||
<Function id="qiskit.compiler.transpile" name="transpile" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/transpiler.py" signature="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, num_processes=None)">
|
||||
<Function id="qiskit.compiler.transpile" name="transpile" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/compiler/transpiler.py#L43-L434" signature="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, num_processes=None)">
|
||||
Transpile one or more circuits, according to some desired transpilation targets.
|
||||
|
||||
Transpilation is potentially done in parallel using multiprocessing when `circuits` is a list with > 1 [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object depending on the local environment and configuration.
|
||||
|
|
@ -278,7 +278,7 @@ python_api_name: qiskit.compiler
|
|||
|
||||
### sequence
|
||||
|
||||
<Function id="qiskit.compiler.sequence" name="sequence" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/compiler/sequencer.py" signature="qiskit.compiler.sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)">
|
||||
<Function id="qiskit.compiler.sequence" name="sequence" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/compiler/sequencer.py#L26-L69" signature="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.
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ python_api_name: qiskit.converters
|
|||
|
||||
### circuit\_to\_dag
|
||||
|
||||
<Function id="qiskit.converters.circuit_to_dag" name="circuit_to_dag" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_dag.py" signature="qiskit.converters.circuit_to_dag(circuit, copy_operations=True, *, qubit_order=None, clbit_order=None)">
|
||||
<Function id="qiskit.converters.circuit_to_dag" name="circuit_to_dag" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_dag.py#L19-L96" signature="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").
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -62,7 +62,7 @@ python_api_name: qiskit.converters
|
|||
|
||||
### dag\_to\_circuit
|
||||
|
||||
<Function id="qiskit.converters.dag_to_circuit" name="dag_to_circuit" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dag_to_circuit.py" signature="qiskit.converters.dag_to_circuit(dag, copy_operations=True)">
|
||||
<Function id="qiskit.converters.dag_to_circuit" name="dag_to_circuit" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/converters/dag_to_circuit.py#L19-L77" signature="qiskit.converters.dag_to_circuit(dag, copy_operations=True)">
|
||||
Build a `QuantumCircuit` object from a `DAGCircuit`.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -104,7 +104,7 @@ python_api_name: qiskit.converters
|
|||
|
||||
### circuit\_to\_instruction
|
||||
|
||||
<Function id="qiskit.converters.circuit_to_instruction" name="circuit_to_instruction" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_instruction.py" signature="qiskit.converters.circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)">
|
||||
<Function id="qiskit.converters.circuit_to_instruction" name="circuit_to_instruction" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_instruction.py#L21-L145" signature="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").
|
||||
|
||||
The instruction is anonymous (not tied to a named quantum register), and so can be inserted into another circuit. The instruction will have the same string name as the circuit.
|
||||
|
|
@ -147,7 +147,7 @@ python_api_name: qiskit.converters
|
|||
|
||||
### circuit\_to\_gate
|
||||
|
||||
<Function id="qiskit.converters.circuit_to_gate" name="circuit_to_gate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_gate.py" signature="qiskit.converters.circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)">
|
||||
<Function id="qiskit.converters.circuit_to_gate" name="circuit_to_gate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_gate.py#L30-L109" signature="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").
|
||||
|
||||
The gate is anonymous (not tied to a named quantum register), and so can be inserted into another circuit. The gate will have the same string name as the circuit.
|
||||
|
|
@ -174,7 +174,7 @@ python_api_name: qiskit.converters
|
|||
|
||||
### dagdependency\_to\_circuit
|
||||
|
||||
<Function id="qiskit.converters.dagdependency_to_circuit" name="dagdependency_to_circuit" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dagdependency_to_circuit.py" signature="qiskit.converters.dagdependency_to_circuit(dagdependency)">
|
||||
<Function id="qiskit.converters.dagdependency_to_circuit" name="dagdependency_to_circuit" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/converters/dagdependency_to_circuit.py#L17-L42" signature="qiskit.converters.dagdependency_to_circuit(dagdependency)">
|
||||
Build a `QuantumCircuit` object from a `DAGDependency`.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -192,7 +192,7 @@ python_api_name: qiskit.converters
|
|||
|
||||
### circuit\_to\_dagdependency
|
||||
|
||||
<Function id="qiskit.converters.circuit_to_dagdependency" name="circuit_to_dagdependency" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_dagdependency.py" signature="qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)">
|
||||
<Function id="qiskit.converters.circuit_to_dagdependency" name="circuit_to_dagdependency" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/converters/circuit_to_dagdependency.py#L18-L51" signature="qiskit.converters.circuit_to_dagdependency(circuit, create_preds_and_succs=True)">
|
||||
Build a `DAGDependency` object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -211,7 +211,7 @@ python_api_name: qiskit.converters
|
|||
|
||||
### dag\_to\_dagdependency
|
||||
|
||||
<Function id="qiskit.converters.dag_to_dagdependency" name="dag_to_dagdependency" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dag_to_dagdependency.py" signature="qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)">
|
||||
<Function id="qiskit.converters.dag_to_dagdependency" name="dag_to_dagdependency" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/converters/dag_to_dagdependency.py#L17-L55" signature="qiskit.converters.dag_to_dagdependency(dag, create_preds_and_succs=True)">
|
||||
Build a `DAGDependency` object from a `DAGCircuit`.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -230,7 +230,7 @@ python_api_name: qiskit.converters
|
|||
|
||||
### dagdependency\_to\_dag
|
||||
|
||||
<Function id="qiskit.converters.dagdependency_to_dag" name="dagdependency_to_dag" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/converters/dagdependency_to_dag.py" signature="qiskit.converters.dagdependency_to_dag(dagdependency)">
|
||||
<Function id="qiskit.converters.dagdependency_to_dag" name="dagdependency_to_dag" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/converters/dagdependency_to_dag.py#L17-L49" signature="qiskit.converters.dagdependency_to_dag(dagdependency)">
|
||||
Build a `DAGCircuit` object from a `DAGDependency`.
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ python_api_name: qiskit.dagcircuit
|
|||
|
||||
### DAGCircuitError
|
||||
|
||||
<Class id="qiskit.dagcircuit.DAGCircuitError" name="DAGCircuitError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/exceptions.py" signature="qiskit.dagcircuit.DAGCircuitError(*msg)">
|
||||
<Class id="qiskit.dagcircuit.DAGCircuitError" name="DAGCircuitError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/exceptions.py#L19-L29" signature="qiskit.dagcircuit.DAGCircuitError(*msg)">
|
||||
Base class for errors raised by the DAGCircuit object.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -42,7 +42,7 @@ python_api_name: qiskit.dagcircuit
|
|||
|
||||
### DAGDependencyError
|
||||
|
||||
<Class id="qiskit.dagcircuit.DAGDependencyError" name="DAGDependencyError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/exceptions.py" signature="qiskit.dagcircuit.DAGDependencyError(*msg)">
|
||||
<Class id="qiskit.dagcircuit.DAGDependencyError" name="DAGDependencyError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/dagcircuit/exceptions.py#L32-L42" signature="qiskit.dagcircuit.DAGDependencyError(*msg)">
|
||||
Base class for errors raised by the DAGDependency object.
|
||||
|
||||
Set the error message.
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ All Qiskit-related exceptions raised by Qiskit are subclasses of the base:
|
|||
|
||||
### QiskitError
|
||||
|
||||
<Class id="qiskit.exceptions.QiskitError" name="QiskitError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py" signature="qiskit.exceptions.QiskitError(*message)">
|
||||
<Class id="qiskit.exceptions.QiskitError" name="QiskitError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py#L92-L102" signature="qiskit.exceptions.QiskitError(*message)">
|
||||
Base class for errors raised by Qiskit.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -40,7 +40,7 @@ Qiskit has several optional features that depend on other packages that are not
|
|||
|
||||
### MissingOptionalLibraryError
|
||||
|
||||
<Class id="qiskit.exceptions.MissingOptionalLibraryError" name="MissingOptionalLibraryError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py" signature="qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)">
|
||||
<Class id="qiskit.exceptions.MissingOptionalLibraryError" name="MissingOptionalLibraryError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py#L111-L135" signature="qiskit.exceptions.MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)">
|
||||
Raised when an optional library is missing.
|
||||
|
||||
Set the error message. :param libname: Name of missing library :param name: Name of class, function, module that uses this library :param pip\_install: pip install command, if any :param msg: Descriptive message, if any
|
||||
|
|
@ -50,7 +50,7 @@ Two more uncommon errors relate to failures in reading user-configuration files,
|
|||
|
||||
### QiskitUserConfigError
|
||||
|
||||
<Class id="qiskit.exceptions.QiskitUserConfigError" name="QiskitUserConfigError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py" signature="qiskit.exceptions.QiskitUserConfigError(*message)">
|
||||
<Class id="qiskit.exceptions.QiskitUserConfigError" name="QiskitUserConfigError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py#L105-L108" signature="qiskit.exceptions.QiskitUserConfigError(*message)">
|
||||
Raised when an error is encountered reading a user config file.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -58,7 +58,7 @@ Two more uncommon errors relate to failures in reading user-configuration files,
|
|||
|
||||
### InvalidFileError
|
||||
|
||||
<Class id="qiskit.exceptions.InvalidFileError" name="InvalidFileError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py" signature="qiskit.exceptions.InvalidFileError(*message)">
|
||||
<Class id="qiskit.exceptions.InvalidFileError" name="InvalidFileError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py#L138-L139" signature="qiskit.exceptions.InvalidFileError(*message)">
|
||||
Raised when the file provided is not valid for the specific task.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -70,7 +70,7 @@ Some particular features of Qiskit may raise custom warnings. In general, Qiskit
|
|||
|
||||
### QiskitWarning
|
||||
|
||||
<Class id="qiskit.exceptions.QiskitWarning" name="QiskitWarning" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py" signature="qiskit.exceptions.QiskitWarning">
|
||||
<Class id="qiskit.exceptions.QiskitWarning" name="QiskitWarning" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py#L142-L143" signature="qiskit.exceptions.QiskitWarning">
|
||||
Common subclass of warnings for Qiskit-specific warnings being raised.
|
||||
</Class>
|
||||
|
||||
|
|
@ -78,7 +78,7 @@ Related to [`MissingOptionalLibraryError`](#qiskit.exceptions.MissingOptionalLib
|
|||
|
||||
### OptionalDependencyImportWarning
|
||||
|
||||
<Class id="qiskit.exceptions.OptionalDependencyImportWarning" name="OptionalDependencyImportWarning" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py" signature="qiskit.exceptions.OptionalDependencyImportWarning">
|
||||
<Class id="qiskit.exceptions.OptionalDependencyImportWarning" name="OptionalDependencyImportWarning" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py#L146-L149" signature="qiskit.exceptions.OptionalDependencyImportWarning">
|
||||
Raised when an optional library raises errors during its import.
|
||||
</Class>
|
||||
|
||||
|
|
@ -90,7 +90,7 @@ When experimental features are being used, Qiskit will raise [`ExperimentalWarni
|
|||
|
||||
### ExperimentalWarning
|
||||
|
||||
<Class id="qiskit.exceptions.ExperimentalWarning" name="ExperimentalWarning" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py" signature="qiskit.exceptions.ExperimentalWarning">
|
||||
<Class id="qiskit.exceptions.ExperimentalWarning" name="ExperimentalWarning" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/exceptions.py#L152-L153" signature="qiskit.exceptions.ExperimentalWarning">
|
||||
Raised when an experimental feature is being used.
|
||||
</Class>
|
||||
|
||||
|
|
|
|||
|
|
@ -162,7 +162,7 @@ With the pass manager framework, a developer can flexibly customize the optimiza
|
|||
|
||||
### PassManagerError
|
||||
|
||||
<Class id="qiskit.passmanager.PassManagerError" name="PassManagerError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/exceptions.py" signature="qiskit.passmanager.PassManagerError(*message)">
|
||||
<Class id="qiskit.passmanager.PassManagerError" name="PassManagerError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/passmanager/exceptions.py#L18-L19" signature="qiskit.passmanager.PassManagerError(*message)">
|
||||
Pass manager error.
|
||||
|
||||
Set the error message.
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ print(f"The primitive-job finished with result {job_result}")
|
|||
|
||||
[`BaseSamplerV2`](qiskit.primitives.BaseSamplerV2 "qiskit.primitives.BaseSamplerV2") is a primitive that samples outputs of quantum circuits.
|
||||
|
||||
Following construction, a sampler is used by calling its [`run()`](qiskit.primitives.BaseSamplerV2#run "qiskit.primitives.BaseSamplerV2.run") method with a list of pubs (Primitive Unified Blocks). Each pub contains values that, together, define a computational unit of work for the sampler to complete:
|
||||
Following construction, a sampler is used by calling its [`run()`](qiskit.primitives.BaseSamplerV2#run "qiskit.primitives.BaseSamplerV2.run") method with a list of pubs (Primitive Unified Blocs). Each pub contains values that, together, define a computational unit of work for the sampler to complete:
|
||||
|
||||
* A single [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), possibly parameterized.
|
||||
* A collection parameter value sets to bind the circuit against if it is parametric.
|
||||
|
|
@ -96,7 +96,7 @@ Running an estimator returns a [`BasePrimitiveJob`](qiskit.primitives.BasePrimit
|
|||
Here is an example of how a sampler is used.
|
||||
|
||||
```python
|
||||
from qiskit.primitives.statevector_sampler import Sampler
|
||||
from qiskit.primitives import StatevectorSampler as Sampler
|
||||
from qiskit import QuantumCircuit
|
||||
from qiskit.circuit.library import RealAmplitudes
|
||||
|
||||
|
|
|
|||
|
|
@ -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.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html#qiskit_aer.AerSimulator "(in Qiskit Aer v0.13.3)") class to be based on version 34 they’d need to deprecate the old signature prior to switching over. The changeover for Aer is not guaranteed to be lockstep with Terra so we need to ensure there is a sufficient amount of time for Aer to complete its deprecation cycle prior to removing version 33 (ie making version 34 mandatory/the minimum version).
|
||||
It’s worth pointing out that Terra’s version support policy doesn’t mean providers themselves will have the same support story, they can (and arguably should) update to newer versions as soon as they can, the support window is just for Terra’s supported versions. Part of this lengthy window prior to deprecation is to give providers enough time to do their own deprecation of a potential end user impacting change in a user facing part of the interface prior to bumping their version. For example, let’s say we changed the signature to `Backend.run()` in `BackendV34` in a backwards incompatible way. Before Aer could update its [`AerSimulator`](https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.AerSimulator.html#qiskit_aer.AerSimulator "(in Qiskit Aer v0.14.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
|
||||
|
||||
|
|
@ -77,7 +77,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p
|
|||
|
||||
### QiskitBackendNotFoundError
|
||||
|
||||
<Class id="qiskit.providers.QiskitBackendNotFoundError" name="QiskitBackendNotFoundError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py" signature="qiskit.providers.QiskitBackendNotFoundError(*message)">
|
||||
<Class id="qiskit.providers.QiskitBackendNotFoundError" name="QiskitBackendNotFoundError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py#L30-L33" signature="qiskit.providers.QiskitBackendNotFoundError(*message)">
|
||||
Base class for errors raised while looking for a backend.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -85,7 +85,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p
|
|||
|
||||
### BackendPropertyError
|
||||
|
||||
<Class id="qiskit.providers.BackendPropertyError" name="BackendPropertyError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py" signature="qiskit.providers.BackendPropertyError(*message)">
|
||||
<Class id="qiskit.providers.BackendPropertyError" name="BackendPropertyError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py#L36-L39" signature="qiskit.providers.BackendPropertyError(*message)">
|
||||
Base class for errors raised while looking for a backend property.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -93,7 +93,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p
|
|||
|
||||
### JobError
|
||||
|
||||
<Class id="qiskit.providers.JobError" name="JobError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py" signature="qiskit.providers.JobError(*message)">
|
||||
<Class id="qiskit.providers.JobError" name="JobError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py#L18-L21" signature="qiskit.providers.JobError(*message)">
|
||||
Base class for errors raised by Jobs.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -101,7 +101,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p
|
|||
|
||||
### JobTimeoutError
|
||||
|
||||
<Class id="qiskit.providers.JobTimeoutError" name="JobTimeoutError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py" signature="qiskit.providers.JobTimeoutError(*message)">
|
||||
<Class id="qiskit.providers.JobTimeoutError" name="JobTimeoutError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py#L24-L27" signature="qiskit.providers.JobTimeoutError(*message)">
|
||||
Base class for timeout errors raised by jobs.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -109,7 +109,7 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p
|
|||
|
||||
### BackendConfigurationError
|
||||
|
||||
<Class id="qiskit.providers.BackendConfigurationError" name="BackendConfigurationError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py" signature="qiskit.providers.BackendConfigurationError(*message)">
|
||||
<Class id="qiskit.providers.BackendConfigurationError" name="BackendConfigurationError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/providers/exceptions.py#L42-L45" signature="qiskit.providers.BackendConfigurationError(*message)">
|
||||
Base class for errors raised by the BackendConfiguration.
|
||||
|
||||
Set the error message.
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ plot_histogram(counts)
|
|||
|
||||
The V1 fake backends are based on a set of base classes:
|
||||
|
||||
<Class id="qiskit.providers.fake_provider.FakeBackend" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_backend.py" signature="qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)">
|
||||
<Class id="qiskit.providers.fake_provider.FakeBackend" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_backend.py#L444-L563" signature="qiskit.providers.fake_provider.FakeBackend(configuration, time_alive=10)">
|
||||
This is a dummy backend just for testing purposes.
|
||||
|
||||
FakeBackend initializer.
|
||||
|
|
@ -92,7 +92,7 @@ The V1 fake backends are based on a set of base classes:
|
|||
* **time\_alive** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – time to wait before returning result
|
||||
</Class>
|
||||
|
||||
<Class id="qiskit.providers.fake_provider.FakeQasmBackend" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_qasm_backend.py" signature="qiskit.providers.fake_provider.FakeQasmBackend">
|
||||
<Class id="qiskit.providers.fake_provider.FakeQasmBackend" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_qasm_backend.py#L30-L72" signature="qiskit.providers.fake_provider.FakeQasmBackend">
|
||||
A fake OpenQASM backend.
|
||||
|
||||
FakeBackend initializer.
|
||||
|
|
@ -103,7 +103,7 @@ The V1 fake backends are based on a set of base classes:
|
|||
* **time\_alive** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – time to wait before returning result
|
||||
</Class>
|
||||
|
||||
<Class id="qiskit.providers.fake_provider.FakePulseBackend" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_pulse_backend.py" signature="qiskit.providers.fake_provider.FakePulseBackend">
|
||||
<Class id="qiskit.providers.fake_provider.FakePulseBackend" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/providers/fake_provider/fake_pulse_backend.py#L24-L43" signature="qiskit.providers.fake_provider.FakePulseBackend">
|
||||
A fake pulse backend.
|
||||
|
||||
FakeBackend initializer.
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.puls
|
|||
|
||||
These are all instances of the same base class:
|
||||
|
||||
<Class id="qiskit.pulse.instructions.Instruction" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/instruction.py" signature="qiskit.pulse.instructions.Instruction(operands, name=None)">
|
||||
<Class id="qiskit.pulse.instructions.Instruction" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/instruction.py#L36-L269" signature="qiskit.pulse.instructions.Instruction(operands, name=None)">
|
||||
The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels.
|
||||
|
||||
Instruction initializer.
|
||||
|
|
@ -161,7 +161,7 @@ Novel channel types can often utilize the [`ControlChannel`](qiskit.pulse.channe
|
|||
|
||||
All channels are children of the same abstract base class:
|
||||
|
||||
<Class id="qiskit.pulse.channels.Channel" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py" signature="qiskit.pulse.channels.Channel(*args, **kwargs)">
|
||||
<Class id="qiskit.pulse.channels.Channel" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/channels.py#L63-L162" signature="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.
|
||||
|
||||
When serialized channels are identified by their serialized name `<prefix><index>`. The type of the channel is interpreted from the prefix, and the index often (but not always) maps to the qubit index. All concrete channel classes must have a `prefix` class attribute (and instances of that class have an index attribute). Base classes which have `prefix` set to `None` are prevented from being instantiated.
|
||||
|
|
@ -214,7 +214,7 @@ The alignment transforms define alignment policies of instructions in [`Schedule
|
|||
|
||||
These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.AlignmentKind").
|
||||
|
||||
<Class id="qiskit.pulse.transforms.AlignmentKind" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py" signature="qiskit.pulse.transforms.AlignmentKind(context_params)">
|
||||
<Class id="qiskit.pulse.transforms.AlignmentKind" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/alignments.py#L25-L87" signature="qiskit.pulse.transforms.AlignmentKind(context_params)">
|
||||
An abstract class for schedule alignment.
|
||||
|
||||
Create new context.
|
||||
|
|
@ -228,7 +228,7 @@ The canonicalization transforms convert schedules to a form amenable for executi
|
|||
|
||||
### add\_implicit\_acquires
|
||||
|
||||
<Function id="qiskit.pulse.transforms.add_implicit_acquires" name="add_implicit_acquires" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py" signature="qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)">
|
||||
<Function id="qiskit.pulse.transforms.add_implicit_acquires" name="add_implicit_acquires" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py#L384-L433" signature="qiskit.pulse.transforms.add_implicit_acquires(schedule, meas_map)">
|
||||
Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones.
|
||||
|
||||
<Admonition title="Warning" type="caution">
|
||||
|
|
@ -251,7 +251,7 @@ The canonicalization transforms convert schedules to a form amenable for executi
|
|||
|
||||
### align\_measures
|
||||
|
||||
<Function id="qiskit.pulse.transforms.align_measures" name="align_measures" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py" signature="qiskit.pulse.transforms.align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)">
|
||||
<Function id="qiskit.pulse.transforms.align_measures" name="align_measures" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py#L227-L381" signature="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.
|
||||
|
||||
This transformation will align the first [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire") on every channel to occur at the same time.
|
||||
|
|
@ -318,7 +318,7 @@ The canonicalization transforms convert schedules to a form amenable for executi
|
|||
|
||||
### block\_to\_schedule
|
||||
|
||||
<Function id="qiskit.pulse.transforms.block_to_schedule" name="block_to_schedule" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py" signature="qiskit.pulse.transforms.block_to_schedule(block)">
|
||||
<Function id="qiskit.pulse.transforms.block_to_schedule" name="block_to_schedule" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py#L34-L82" signature="qiskit.pulse.transforms.block_to_schedule(block)">
|
||||
Convert `ScheduleBlock` to `Schedule`.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -345,7 +345,7 @@ The canonicalization transforms convert schedules to a form amenable for executi
|
|||
|
||||
### compress\_pulses
|
||||
|
||||
<Function id="qiskit.pulse.transforms.compress_pulses" name="compress_pulses" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py" signature="qiskit.pulse.transforms.compress_pulses(schedules)">
|
||||
<Function id="qiskit.pulse.transforms.compress_pulses" name="compress_pulses" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py#L85-L118" signature="qiskit.pulse.transforms.compress_pulses(schedules)">
|
||||
Optimization pass to replace identical pulses.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -363,7 +363,7 @@ The canonicalization transforms convert schedules to a form amenable for executi
|
|||
|
||||
### flatten
|
||||
|
||||
<Function id="qiskit.pulse.transforms.flatten" name="flatten" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py" signature="qiskit.pulse.transforms.flatten(program)">
|
||||
<Function id="qiskit.pulse.transforms.flatten" name="flatten" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py#L121-L139" signature="qiskit.pulse.transforms.flatten(program)">
|
||||
Flatten (inline) any called nodes into a Schedule tree with no nested children.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -385,7 +385,7 @@ The canonicalization transforms convert schedules to a form amenable for executi
|
|||
|
||||
### inline\_subroutines
|
||||
|
||||
<Function id="qiskit.pulse.transforms.inline_subroutines" name="inline_subroutines" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py" signature="qiskit.pulse.transforms.inline_subroutines(program)">
|
||||
<Function id="qiskit.pulse.transforms.inline_subroutines" name="inline_subroutines" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py#L142-L162" signature="qiskit.pulse.transforms.inline_subroutines(program)">
|
||||
Recursively remove call instructions and inline the respective subroutine instructions.
|
||||
|
||||
Assigned parameter values, which are stored in the parameter table, are also applied. The subroutine is copied before the parameter assignment to avoid mutation problem.
|
||||
|
|
@ -409,7 +409,7 @@ The canonicalization transforms convert schedules to a form amenable for executi
|
|||
|
||||
### pad
|
||||
|
||||
<Function id="qiskit.pulse.transforms.pad" name="pad" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py" signature="qiskit.pulse.transforms.pad(schedule, channels=None, until=None, inplace=False, pad_with=None)">
|
||||
<Function id="qiskit.pulse.transforms.pad" name="pad" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py#L436-L498" signature="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`.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -435,7 +435,7 @@ The canonicalization transforms convert schedules to a form amenable for executi
|
|||
|
||||
### remove\_directives
|
||||
|
||||
<Function id="qiskit.pulse.transforms.remove_directives" name="remove_directives" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py" signature="qiskit.pulse.transforms.remove_directives(schedule)">
|
||||
<Function id="qiskit.pulse.transforms.remove_directives" name="remove_directives" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py#L199-L208" signature="qiskit.pulse.transforms.remove_directives(schedule)">
|
||||
Remove directives.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -453,7 +453,7 @@ The canonicalization transforms convert schedules to a form amenable for executi
|
|||
|
||||
### remove\_trivial\_barriers
|
||||
|
||||
<Function id="qiskit.pulse.transforms.remove_trivial_barriers" name="remove_trivial_barriers" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py" signature="qiskit.pulse.transforms.remove_trivial_barriers(schedule)">
|
||||
<Function id="qiskit.pulse.transforms.remove_trivial_barriers" name="remove_trivial_barriers" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/canonicalization.py#L211-L224" signature="qiskit.pulse.transforms.remove_trivial_barriers(schedule)">
|
||||
Remove trivial barriers with 0 or 1 channels.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -477,7 +477,7 @@ The DAG transforms create DAG representation of input program. This can be used
|
|||
|
||||
### block\_to\_dag
|
||||
|
||||
<Function id="qiskit.pulse.transforms.block_to_dag" name="block_to_dag" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/dag.py" signature="qiskit.pulse.transforms.block_to_dag(block)">
|
||||
<Function id="qiskit.pulse.transforms.block_to_dag" name="block_to_dag" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/dag.py#L27-L75" signature="qiskit.pulse.transforms.block_to_dag(block)">
|
||||
Convert schedule block instruction into DAG.
|
||||
|
||||
`ScheduleBlock` can be represented as a DAG as needed. For example, equality of two programs are efficiently checked on DAG representation.
|
||||
|
|
@ -535,7 +535,7 @@ A sequence of transformations to generate a target code.
|
|||
|
||||
### target\_qobj\_transform
|
||||
|
||||
<Function id="qiskit.pulse.transforms.target_qobj_transform" name="target_qobj_transform" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/base_transforms.py" signature="qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)">
|
||||
<Function id="qiskit.pulse.transforms.target_qobj_transform" name="target_qobj_transform" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/transforms/base_transforms.py#L25-L55" signature="qiskit.pulse.transforms.target_qobj_transform(sched, remove_directives=True)">
|
||||
A basic pulse program transformation for OpenPulse API execution.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -752,7 +752,7 @@ The above is just a small taste of what is possible with the builder. See the re
|
|||
|
||||
### build
|
||||
|
||||
<Function id="qiskit.pulse.builder.build" name="build" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left')">
|
||||
<Function id="qiskit.pulse.builder.build" name="build" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L774-L821" signature="qiskit.pulse.builder.build(backend=None, schedule=None, name=None, default_alignment='left')">
|
||||
Create a context manager for launching the imperative pulse builder DSL.
|
||||
|
||||
To enter a building context and starting building a pulse program:
|
||||
|
|
@ -812,7 +812,7 @@ DriveChannel(0)
|
|||
|
||||
### acquire\_channel
|
||||
|
||||
<Function id="qiskit.pulse.builder.acquire_channel" name="acquire_channel" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.acquire_channel(qubit)">
|
||||
<Function id="qiskit.pulse.builder.acquire_channel" name="acquire_channel" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1425-L1445" signature="qiskit.pulse.builder.acquire_channel(qubit)">
|
||||
Return `AcquireChannel` for `qubit` on the active builder backend.
|
||||
|
||||
Examples:
|
||||
|
|
@ -838,7 +838,7 @@ DriveChannel(0)
|
|||
|
||||
### control\_channels
|
||||
|
||||
<Function id="qiskit.pulse.builder.control_channels" name="control_channels" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.control_channels(*qubits)">
|
||||
<Function id="qiskit.pulse.builder.control_channels" name="control_channels" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1448-L1478" signature="qiskit.pulse.builder.control_channels(*qubits)">
|
||||
Return `ControlChannel` for `qubit` on the active builder backend.
|
||||
|
||||
Return the secondary drive channel for the given qubit – typically utilized for controlling multi-qubit interactions.
|
||||
|
|
@ -873,7 +873,7 @@ DriveChannel(0)
|
|||
|
||||
### drive\_channel
|
||||
|
||||
<Function id="qiskit.pulse.builder.drive_channel" name="drive_channel" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.drive_channel(qubit)">
|
||||
<Function id="qiskit.pulse.builder.drive_channel" name="drive_channel" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1379-L1399" signature="qiskit.pulse.builder.drive_channel(qubit)">
|
||||
Return `DriveChannel` for `qubit` on the active builder backend.
|
||||
|
||||
Examples:
|
||||
|
|
@ -899,7 +899,7 @@ DriveChannel(0)
|
|||
|
||||
### measure\_channel
|
||||
|
||||
<Function id="qiskit.pulse.builder.measure_channel" name="measure_channel" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.measure_channel(qubit)">
|
||||
<Function id="qiskit.pulse.builder.measure_channel" name="measure_channel" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1402-L1422" signature="qiskit.pulse.builder.measure_channel(qubit)">
|
||||
Return `MeasureChannel` for `qubit` on the active builder backend.
|
||||
|
||||
Examples:
|
||||
|
|
@ -958,7 +958,7 @@ drive_sched.draw()
|
|||
|
||||
### acquire
|
||||
|
||||
<Function id="qiskit.pulse.builder.acquire" name="acquire" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)">
|
||||
<Function id="qiskit.pulse.builder.acquire" name="acquire" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1537-L1587" signature="qiskit.pulse.builder.acquire(duration, qubit_or_channel, register, **metadata)">
|
||||
Acquire for a `duration` on a `channel` and store the result in a `register`.
|
||||
|
||||
Examples:
|
||||
|
|
@ -995,7 +995,7 @@ drive_sched.draw()
|
|||
|
||||
### barrier
|
||||
|
||||
<Function id="qiskit.pulse.builder.barrier" name="barrier" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)">
|
||||
<Function id="qiskit.pulse.builder.barrier" name="barrier" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1923-L1992" signature="qiskit.pulse.builder.barrier(*channels_or_qubits, name=None)">
|
||||
Barrier directive for a set of channels and qubits.
|
||||
|
||||
This directive prevents the compiler from moving instructions across the barrier. Consider the case where we want to enforce that one pulse happens after another on separate channels, this can be done with:
|
||||
|
|
@ -1062,7 +1062,7 @@ drive_sched.draw()
|
|||
|
||||
### call
|
||||
|
||||
<Function id="qiskit.pulse.builder.call" name="call" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.call(target, name=None, value_dict=None, **kw_params)">
|
||||
<Function id="qiskit.pulse.builder.call" name="call" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1703-L1894" signature="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.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -1231,7 +1231,7 @@ drive_sched.draw()
|
|||
|
||||
### delay
|
||||
|
||||
<Function id="qiskit.pulse.builder.delay" name="delay" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.delay(duration, channel, name=None)">
|
||||
<Function id="qiskit.pulse.builder.delay" name="delay" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1482-L1501" signature="qiskit.pulse.builder.delay(duration, channel, name=None)">
|
||||
Delay on a `channel` for a `duration`.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1254,7 +1254,7 @@ drive_sched.draw()
|
|||
|
||||
### play
|
||||
|
||||
<Function id="qiskit.pulse.builder.play" name="play" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.play(pulse, channel, name=None)">
|
||||
<Function id="qiskit.pulse.builder.play" name="play" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1504-L1526" signature="qiskit.pulse.builder.play(pulse, channel, name=None)">
|
||||
Play a `pulse` on a `channel`.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1277,7 +1277,7 @@ drive_sched.draw()
|
|||
|
||||
### reference
|
||||
|
||||
<Function id="qiskit.pulse.builder.reference" name="reference" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.reference(name, *extra_keys)">
|
||||
<Function id="qiskit.pulse.builder.reference" name="reference" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1897-L1919" signature="qiskit.pulse.builder.reference(name, *extra_keys)">
|
||||
Refer to undefined subroutine by string keys.
|
||||
|
||||
A [`Reference`](qiskit.pulse.instructions.Reference "qiskit.pulse.instructions.Reference") instruction is implicitly created and a schedule can be separately registered to the reference at a later stage.
|
||||
|
|
@ -1302,7 +1302,7 @@ drive_sched.draw()
|
|||
|
||||
### set\_frequency
|
||||
|
||||
<Function id="qiskit.pulse.builder.set_frequency" name="set_frequency" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.set_frequency(frequency, channel, name=None)">
|
||||
<Function id="qiskit.pulse.builder.set_frequency" name="set_frequency" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1590-L1609" signature="qiskit.pulse.builder.set_frequency(frequency, channel, name=None)">
|
||||
Set the `frequency` of a pulse `channel`.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1325,7 +1325,7 @@ drive_sched.draw()
|
|||
|
||||
### set\_phase
|
||||
|
||||
<Function id="qiskit.pulse.builder.set_phase" name="set_phase" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.set_phase(phase, channel, name=None)">
|
||||
<Function id="qiskit.pulse.builder.set_phase" name="set_phase" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1635-L1657" signature="qiskit.pulse.builder.set_phase(phase, channel, name=None)">
|
||||
Set the `phase` of a pulse `channel`.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1350,7 +1350,7 @@ drive_sched.draw()
|
|||
|
||||
### shift\_frequency
|
||||
|
||||
<Function id="qiskit.pulse.builder.shift_frequency" name="shift_frequency" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)">
|
||||
<Function id="qiskit.pulse.builder.shift_frequency" name="shift_frequency" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1612-L1632" signature="qiskit.pulse.builder.shift_frequency(frequency, channel, name=None)">
|
||||
Shift the `frequency` of a pulse `channel`.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1373,7 +1373,7 @@ drive_sched.draw()
|
|||
|
||||
### shift\_phase
|
||||
|
||||
<Function id="qiskit.pulse.builder.shift_phase" name="shift_phase" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.shift_phase(phase, channel, name=None)">
|
||||
<Function id="qiskit.pulse.builder.shift_phase" name="shift_phase" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1660-L1681" signature="qiskit.pulse.builder.shift_phase(phase, channel, name=None)">
|
||||
Shift the `phase` of a pulse `channel`.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1398,7 +1398,7 @@ drive_sched.draw()
|
|||
|
||||
### snapshot
|
||||
|
||||
<Function id="qiskit.pulse.builder.snapshot" name="snapshot" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')">
|
||||
<Function id="qiskit.pulse.builder.snapshot" name="snapshot" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L1684-L1700" signature="qiskit.pulse.builder.snapshot(label, snapshot_type='statevector')">
|
||||
Simulator snapshot.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1440,7 +1440,7 @@ pulse_prog.draw()
|
|||
|
||||
### align\_equispaced
|
||||
|
||||
<Function id="qiskit.pulse.builder.align_equispaced" name="align_equispaced" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.align_equispaced(duration)">
|
||||
<Function id="qiskit.pulse.builder.align_equispaced" name="align_equispaced" signature="qiskit.pulse.builder.align_equispaced(duration)">
|
||||
Equispaced alignment pulse scheduling context.
|
||||
|
||||
Pulse instructions within this context are scheduled with the same interval spacing such that the total length of the context block is `duration`. If the total free `duration` cannot be evenly divided by the number of instructions within the context, the modulo is split and then prepended and appended to the returned schedule. Delay instructions are automatically inserted in between pulses.
|
||||
|
|
@ -1486,7 +1486,7 @@ pulse_prog.draw()
|
|||
|
||||
### align\_func
|
||||
|
||||
<Function id="qiskit.pulse.builder.align_func" name="align_func" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.align_func(duration, func)">
|
||||
<Function id="qiskit.pulse.builder.align_func" name="align_func" signature="qiskit.pulse.builder.align_func(duration, func)">
|
||||
Callback defined alignment pulse scheduling context.
|
||||
|
||||
Pulse instructions within this context are scheduled at the location specified by arbitrary callback function position that takes integer index and returns the associated fractional location within \[0, 1]. Delay instruction is automatically inserted in between pulses.
|
||||
|
|
@ -1538,7 +1538,7 @@ pulse_prog.draw()
|
|||
|
||||
### align\_left
|
||||
|
||||
<Function id="qiskit.pulse.builder.align_left" name="align_left" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.align_left()">
|
||||
<Function id="qiskit.pulse.builder.align_left" name="align_left" signature="qiskit.pulse.builder.align_left()">
|
||||
Left alignment pulse scheduling context.
|
||||
|
||||
Pulse instructions within this context are scheduled as early as possible by shifting them left to the earliest available time.
|
||||
|
|
@ -1573,7 +1573,7 @@ pulse_prog.draw()
|
|||
|
||||
### align\_right
|
||||
|
||||
<Function id="qiskit.pulse.builder.align_right" name="align_right" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.align_right()">
|
||||
<Function id="qiskit.pulse.builder.align_right" name="align_right" signature="qiskit.pulse.builder.align_right()">
|
||||
Right alignment pulse scheduling context.
|
||||
|
||||
Pulse instructions within this context are scheduled as late as possible by shifting them right to the latest available time.
|
||||
|
|
@ -1608,7 +1608,7 @@ pulse_prog.draw()
|
|||
|
||||
### align\_sequential
|
||||
|
||||
<Function id="qiskit.pulse.builder.align_sequential" name="align_sequential" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.align_sequential()">
|
||||
<Function id="qiskit.pulse.builder.align_sequential" name="align_sequential" signature="qiskit.pulse.builder.align_sequential()">
|
||||
Sequential alignment pulse scheduling context.
|
||||
|
||||
Pulse instructions within this context are scheduled sequentially in time such that no two instructions will be played at the same time.
|
||||
|
|
@ -1643,7 +1643,7 @@ pulse_prog.draw()
|
|||
|
||||
### frequency\_offset
|
||||
|
||||
<Function id="qiskit.pulse.builder.frequency_offset" name="frequency_offset" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)">
|
||||
<Function id="qiskit.pulse.builder.frequency_offset" name="frequency_offset" signature="qiskit.pulse.builder.frequency_offset(frequency, *channels, compensate_phase=False)">
|
||||
Shift the frequency of inputs channels on entry into context and undo on exit.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1687,7 +1687,7 @@ pulse_prog.draw()
|
|||
|
||||
### phase\_offset
|
||||
|
||||
<Function id="qiskit.pulse.builder.phase_offset" name="phase_offset" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.phase_offset(phase, *channels)">
|
||||
<Function id="qiskit.pulse.builder.phase_offset" name="phase_offset" signature="qiskit.pulse.builder.phase_offset(phase, *channels)">
|
||||
Shift the phase of input channels on entry into context and undo on exit.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1741,7 +1741,7 @@ MemorySlot(0)
|
|||
|
||||
### measure
|
||||
|
||||
<Function id="qiskit.pulse.builder.measure" name="measure" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.measure(qubits, registers=None)">
|
||||
<Function id="qiskit.pulse.builder.measure" name="measure" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L2052-L2137" signature="qiskit.pulse.builder.measure(qubits, registers=None)">
|
||||
Measure a qubit within the currently active builder context.
|
||||
|
||||
At the pulse level a measurement is composed of both a stimulus pulse and an acquisition instruction which tells the systems measurement unit to acquire data and process it. We provide this measurement macro to automate the process for you, but if desired full control is still available with [`acquire()`](#qiskit.pulse.builder.acquire "qiskit.pulse.builder.acquire") and [`play()`](#qiskit.pulse.builder.play "qiskit.pulse.builder.play").
|
||||
|
|
@ -1796,7 +1796,7 @@ MemorySlot(0)
|
|||
|
||||
### measure\_all
|
||||
|
||||
<Function id="qiskit.pulse.builder.measure_all" name="measure_all" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.measure_all()">
|
||||
<Function id="qiskit.pulse.builder.measure_all" name="measure_all" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L2140-L2180" signature="qiskit.pulse.builder.measure_all()">
|
||||
Measure all qubits within the currently active builder context.
|
||||
|
||||
A simple macro function to measure all of the qubits in the device at the same time. This is useful for handling device `meas_map` and single measurement constraints.
|
||||
|
|
@ -1829,7 +1829,7 @@ MemorySlot(0)
|
|||
|
||||
### delay\_qubits
|
||||
|
||||
<Function id="qiskit.pulse.builder.delay_qubits" name="delay_qubits" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.delay_qubits(duration, *qubits)">
|
||||
<Function id="qiskit.pulse.builder.delay_qubits" name="delay_qubits" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L2183-L2210" signature="qiskit.pulse.builder.delay_qubits(duration, *qubits)">
|
||||
Insert delays on all the `channels.Channel`s that correspond to the input `qubits` at the same time.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1886,7 +1886,7 @@ There are 1e-06 seconds in 4500 samples.
|
|||
|
||||
### active\_backend
|
||||
|
||||
<Function id="qiskit.pulse.builder.active_backend" name="active_backend" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.active_backend()">
|
||||
<Function id="qiskit.pulse.builder.active_backend" name="active_backend" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L847-L862" signature="qiskit.pulse.builder.active_backend()">
|
||||
Get the backend of the currently active builder context.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -1906,7 +1906,7 @@ There are 1e-06 seconds in 4500 samples.
|
|||
|
||||
### num\_qubits
|
||||
|
||||
<Function id="qiskit.pulse.builder.num_qubits" name="num_qubits" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.num_qubits()">
|
||||
<Function id="qiskit.pulse.builder.num_qubits" name="num_qubits" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L897-L920" signature="qiskit.pulse.builder.num_qubits()">
|
||||
Return number of qubits in the currently active backend.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1936,7 +1936,7 @@ There are 1e-06 seconds in 4500 samples.
|
|||
|
||||
### qubit\_channels
|
||||
|
||||
<Function id="qiskit.pulse.builder.qubit_channels" name="qubit_channels" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.qubit_channels(qubit)">
|
||||
<Function id="qiskit.pulse.builder.qubit_channels" name="qubit_channels" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L954-L1004" signature="qiskit.pulse.builder.qubit_channels(qubit)">
|
||||
Returns the set of channels associated with a qubit.
|
||||
|
||||
Examples:
|
||||
|
|
@ -1970,7 +1970,7 @@ There are 1e-06 seconds in 4500 samples.
|
|||
|
||||
### samples\_to\_seconds
|
||||
|
||||
<Function id="qiskit.pulse.builder.samples_to_seconds" name="samples_to_seconds" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.samples_to_seconds(samples)">
|
||||
<Function id="qiskit.pulse.builder.samples_to_seconds" name="samples_to_seconds" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L941-L951" signature="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.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1988,7 +1988,7 @@ There are 1e-06 seconds in 4500 samples.
|
|||
|
||||
### seconds\_to\_samples
|
||||
|
||||
<Function id="qiskit.pulse.builder.seconds_to_samples" name="seconds_to_samples" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py" signature="qiskit.pulse.builder.seconds_to_samples(seconds)">
|
||||
<Function id="qiskit.pulse.builder.seconds_to_samples" name="seconds_to_samples" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/builder.py#L923-L938" signature="qiskit.pulse.builder.seconds_to_samples(seconds)">
|
||||
Obtain the number of samples that will elapse in `seconds` on the active backend.
|
||||
|
||||
Rounds down.
|
||||
|
|
@ -2016,7 +2016,7 @@ There are 1e-06 seconds in 4500 samples.
|
|||
|
||||
### PulseError
|
||||
|
||||
<Class id="qiskit.pulse.PulseError" name="PulseError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py" signature="qiskit.pulse.PulseError(*message)">
|
||||
<Class id="qiskit.pulse.PulseError" name="PulseError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py#L17-L27" signature="qiskit.pulse.PulseError(*message)">
|
||||
Errors raised by the pulse module.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -2024,7 +2024,7 @@ There are 1e-06 seconds in 4500 samples.
|
|||
|
||||
### BackendNotSet
|
||||
|
||||
<Class id="qiskit.pulse.BackendNotSet" name="BackendNotSet" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py" signature="qiskit.pulse.BackendNotSet(*message)">
|
||||
<Class id="qiskit.pulse.BackendNotSet" name="BackendNotSet" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py#L30-L31" signature="qiskit.pulse.BackendNotSet(*message)">
|
||||
Raised if the builder context does not have a backend.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -2032,7 +2032,7 @@ There are 1e-06 seconds in 4500 samples.
|
|||
|
||||
### NoActiveBuilder
|
||||
|
||||
<Class id="qiskit.pulse.NoActiveBuilder" name="NoActiveBuilder" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py" signature="qiskit.pulse.NoActiveBuilder(*message)">
|
||||
<Class id="qiskit.pulse.NoActiveBuilder" name="NoActiveBuilder" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py#L34-L35" signature="qiskit.pulse.NoActiveBuilder(*message)">
|
||||
Raised if no builder context is active.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -2040,7 +2040,7 @@ There are 1e-06 seconds in 4500 samples.
|
|||
|
||||
### UnassignedDurationError
|
||||
|
||||
<Class id="qiskit.pulse.UnassignedDurationError" name="UnassignedDurationError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py" signature="qiskit.pulse.UnassignedDurationError(*message)">
|
||||
<Class id="qiskit.pulse.UnassignedDurationError" name="UnassignedDurationError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py#L38-L39" signature="qiskit.pulse.UnassignedDurationError(*message)">
|
||||
Raised if instruction duration is unassigned.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -2048,7 +2048,7 @@ There are 1e-06 seconds in 4500 samples.
|
|||
|
||||
### UnassignedReferenceError
|
||||
|
||||
<Class id="qiskit.pulse.UnassignedReferenceError" name="UnassignedReferenceError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py" signature="qiskit.pulse.UnassignedReferenceError(*message)">
|
||||
<Class id="qiskit.pulse.UnassignedReferenceError" name="UnassignedReferenceError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/exceptions.py#L42-L43" signature="qiskit.pulse.UnassignedReferenceError(*message)">
|
||||
Raised if subroutine is unassigned.
|
||||
|
||||
Set the error message.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ This module contains two public functions, both of which create a [`QuantumCircu
|
|||
|
||||
### load
|
||||
|
||||
<Function id="qiskit.qasm2.load" name="load" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/__init__.py" signature="qiskit.qasm2.load(filename, *, include_path=('.',), include_input_directory='append', custom_instructions=(), custom_classical=(), strict=False)">
|
||||
<Function id="qiskit.qasm2.load" name="load" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/__init__.py#L606-L658" signature="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.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -55,7 +55,7 @@ This module contains two public functions, both of which create a [`QuantumCircu
|
|||
|
||||
### loads
|
||||
|
||||
<Function id="qiskit.qasm2.loads" name="loads" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/__init__.py" signature="qiskit.qasm2.loads(string, *, include_path=('.',), custom_instructions=(), custom_classical=(), strict=False)">
|
||||
<Function id="qiskit.qasm2.loads" name="loads" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/__init__.py#L567-L603" signature="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").
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -83,7 +83,7 @@ Both of these loading functions also take an argument `include_path`, which is a
|
|||
|
||||
You can extend the quantum components of the OpenQASM 2 language by passing an iterable of information on custom instructions as the argument `custom_instructions`. In files that have compatible definitions for these instructions, the given `constructor` will be used in place of whatever other handling [`qiskit.qasm2`](#module-qiskit.qasm2 "qiskit.qasm2") would have done. These instructions may optionally be marked as `builtin`, which causes them to not require an `opaque` or `gate` declaration, but they will silently ignore a compatible declaration. Either way, it is an error to provide a custom instruction that has a different number of parameters or qubits as a defined instruction in a parsed program. Each element of the argument iterable should be a particular data class:
|
||||
|
||||
<Class id="qiskit.qasm2.CustomInstruction" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/parse.py" signature="qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)">
|
||||
<Class id="qiskit.qasm2.CustomInstruction" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/parse.py#L80-L100" signature="qiskit.qasm2.CustomInstruction(name, num_params, num_qubits, constructor, builtin=False)">
|
||||
Information about a custom instruction that should be defined during the parse.
|
||||
|
||||
The `name`, `num_params` and `num_qubits` fields are self-explanatory. The `constructor` field should be a callable object with signature `*args -> Instruction`, where each of the `num_params` `args` is a floating-point value. Most of the built-in Qiskit gate classes have this form.
|
||||
|
|
@ -119,7 +119,7 @@ Similar to other serialisation modules in Python, this module offers two public
|
|||
|
||||
### dump
|
||||
|
||||
<Function id="qiskit.qasm2.dump" name="dump" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/export.py" signature="qiskit.qasm2.dump(circuit, filename_or_stream, /)">
|
||||
<Function id="qiskit.qasm2.dump" name="dump" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/export.py#L107-L122" signature="qiskit.qasm2.dump(circuit, filename_or_stream, /)">
|
||||
Dump a circuit as an OpenQASM 2 program to a file or stream.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -134,7 +134,7 @@ Similar to other serialisation modules in Python, this module offers two public
|
|||
|
||||
### dumps
|
||||
|
||||
<Function id="qiskit.qasm2.dumps" name="dumps" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/export.py" signature="qiskit.qasm2.dumps(circuit, /)">
|
||||
<Function id="qiskit.qasm2.dumps" name="dumps" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/export.py#L125-L200" signature="qiskit.qasm2.dumps(circuit, /)">
|
||||
Export a circuit to an OpenQASM 2 program in a string.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -160,7 +160,7 @@ This module defines a generic error type that derives from [`QiskitError`](excep
|
|||
|
||||
### QASM2Error
|
||||
|
||||
<Class id="qiskit.qasm2.QASM2Error" name="QASM2Error" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py" signature="qiskit.qasm2.QASM2Error(*message)">
|
||||
<Class id="qiskit.qasm2.QASM2Error" name="QASM2Error" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py#L18-L19" signature="qiskit.qasm2.QASM2Error(*message)">
|
||||
A general error raised by the OpenQASM 2 interoperation layer.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -170,7 +170,7 @@ In cases where the lexer or parser fails due to an invalid OpenQASM 2 file, the
|
|||
|
||||
### QASM2ParseError
|
||||
|
||||
<Class id="qiskit.qasm2.QASM2ParseError" name="QASM2ParseError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py" signature="qiskit.qasm2.QASM2ParseError(*message)">
|
||||
<Class id="qiskit.qasm2.QASM2ParseError" name="QASM2ParseError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py#L22-L23" signature="qiskit.qasm2.QASM2ParseError(*message)">
|
||||
An error raised because of a failure to parse an OpenQASM 2 file.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -180,7 +180,7 @@ When the exporters fail to export a circuit, likely because it has structure tha
|
|||
|
||||
### QASM2ExportError
|
||||
|
||||
<Class id="qiskit.qasm2.QASM2ExportError" name="QASM2ExportError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py" signature="qiskit.qasm2.QASM2ExportError(*message)">
|
||||
<Class id="qiskit.qasm2.QASM2ExportError" name="QASM2ExportError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm2/exceptions.py#L26-L27" signature="qiskit.qasm2.QASM2ExportError(*message)">
|
||||
An error raised because of a failure to convert a Qiskit object to an OpenQASM 2 form.
|
||||
|
||||
Set the error message.
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3.
|
|||
|
||||
### dump
|
||||
|
||||
<Function id="qiskit.qasm3.dump" name="dump" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py" signature="qiskit.qasm3.dump(circuit, stream, **kwargs)">
|
||||
<Function id="qiskit.qasm3.dump" name="dump" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py#L249-L259" signature="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.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -38,7 +38,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3.
|
|||
|
||||
### dumps
|
||||
|
||||
<Function id="qiskit.qasm3.dumps" name="dumps" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py" signature="qiskit.qasm3.dumps(circuit, **kwargs)">
|
||||
<Function id="qiskit.qasm3.dumps" name="dumps" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py#L236-L246" signature="qiskit.qasm3.dumps(circuit, **kwargs)">
|
||||
Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM 3 string.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -57,7 +57,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3.
|
|||
|
||||
Both of these exporter functions are single-use wrappers around the main [`Exporter`](#qiskit.qasm3.Exporter "qiskit.qasm3.Exporter") class. For more complex exporting needs, including dumping multiple circuits in a single session, it may be more convenient or faster to use the complete interface.
|
||||
|
||||
<Class id="qiskit.qasm3.Exporter" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exporter.py" signature="qiskit.qasm3.Exporter(includes=('stdgates.inc', ), basis_gates=('U', ), disable_constants=False, alias_classical_registers=None, allow_aliasing=None, indent=' ', experimental=ExperimentalFeatures.None)">
|
||||
<Class id="qiskit.qasm3.Exporter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exporter.py#L127-L196" signature="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.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -90,13 +90,13 @@ Both of these exporter functions are single-use wrappers around the main [`Expor
|
|||
|
||||
### dump
|
||||
|
||||
<Function id="qiskit.qasm3.Exporter.dump" name="dump" signature="dump(circuit, stream)">
|
||||
<Function id="qiskit.qasm3.Exporter.dump" name="dump" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exporter.py#L184-L196" signature="dump(circuit, stream)">
|
||||
Convert the circuit to OpenQASM 3, dumping the result to a file or text stream.
|
||||
</Function>
|
||||
|
||||
### dumps
|
||||
|
||||
<Function id="qiskit.qasm3.Exporter.dumps" name="dumps" signature="dumps(circuit)">
|
||||
<Function id="qiskit.qasm3.Exporter.dumps" name="dumps" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exporter.py#L178-L182" signature="dumps(circuit)">
|
||||
Convert the circuit to OpenQASM 3, returning the result as a string.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
@ -105,7 +105,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp
|
|||
|
||||
### QASM3ExporterError
|
||||
|
||||
<Class id="qiskit.qasm3.QASM3ExporterError" name="QASM3ExporterError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exceptions.py" signature="qiskit.qasm3.QASM3ExporterError(*message)">
|
||||
<Class id="qiskit.qasm3.QASM3ExporterError" name="QASM3ExporterError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exceptions.py#L22-L23" signature="qiskit.qasm3.QASM3ExporterError(*message)">
|
||||
An error raised during running the OpenQASM 3 exporter.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -115,7 +115,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp
|
|||
|
||||
The OpenQASM 3 language is still evolving as hardware capabilities improve, so there is no final syntax that Qiskit can reliably target. In order to represent the evolving language, we will sometimes release features before formal standardization, which may need to change as the review process in the OpenQASM 3 design committees progresses. By default, the exporters will only support standardised features of the language. To enable these early-release features, use the `experimental` keyword argument of [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3.dump") and [`dumps()`](#qiskit.qasm3.dumps "qiskit.qasm3.dumps"). The available feature flags are:
|
||||
|
||||
<Class id="qiskit.qasm3.ExperimentalFeatures" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/experimental.py" signature="qiskit.qasm3.ExperimentalFeatures(value)">
|
||||
<Class id="qiskit.qasm3.ExperimentalFeatures" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/experimental.py#L21-L70" signature="qiskit.qasm3.ExperimentalFeatures(value)">
|
||||
Flags for experimental features that the OpenQASM 3 exporter supports.
|
||||
|
||||
These are experimental and are more liable to change, because the OpenQASM 3 specification has not formally accepted them yet, so the syntax may not be finalized.
|
||||
|
|
@ -198,18 +198,18 @@ qasm_string = qasm3.dumps(qc, experimental=qasm3.ExperimentalFeatures.SWITCH_CAS
|
|||
Currently only two high-level functions are offered, as Qiskit support for importing from OpenQASM 3 is in its infancy, and the implementation is expected to change significantly. The two functions are [`load()`](#qiskit.qasm3.load "qiskit.qasm3.load") and [`loads()`](#qiskit.qasm3.loads "qiskit.qasm3.loads"), which are direct counterparts of [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3.dump") and [`dumps()`](#qiskit.qasm3.dumps "qiskit.qasm3.dumps"), respectively loading a program indirectly from a named file and directly from a given string.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
While we are still in the exploratory release period, to use either function, the package `qiskit_qasm3_import` must be installed. This can be done by installing Qiskit Terra with the `qasm3-import` extra, such as by:
|
||||
While we are still in the exploratory release period, to use either function, the package `qiskit_qasm3_import` must be installed. This can be done by installing Qiskit with the `qasm3-import` extra, such as by:
|
||||
|
||||
```python
|
||||
pip install qiskit-terra[qasm3-import]
|
||||
pip install qiskit[qasm3-import]
|
||||
```
|
||||
|
||||
We expect that this functionality will eventually be merged into core Terra, and no longer require an optional import, but we do not yet have a timeline for this.
|
||||
We expect that this functionality will eventually be merged into Qiskit, and no longer require an optional import, but we do not yet have a timeline for this.
|
||||
</Admonition>
|
||||
|
||||
### load
|
||||
|
||||
<Function id="qiskit.qasm3.load" name="load" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py" signature="qiskit.qasm3.load(filename)">
|
||||
<Function id="qiskit.qasm3.load" name="load" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/utils/lazy_tester.py#L262-L284" signature="qiskit.qasm3.load(filename)">
|
||||
Load an OpenQASM 3 program from the file `filename`.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -231,7 +231,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor
|
|||
|
||||
### loads
|
||||
|
||||
<Function id="qiskit.qasm3.loads" name="loads" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py" signature="qiskit.qasm3.loads(program)">
|
||||
<Function id="qiskit.qasm3.loads" name="loads" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/utils/lazy_tester.py#L287-L307" signature="qiskit.qasm3.loads(program)">
|
||||
Load an OpenQASM 3 program from the given string.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -255,7 +255,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo
|
|||
|
||||
### QASM3ImporterError
|
||||
|
||||
<Class id="qiskit.qasm3.QASM3ImporterError" name="QASM3ImporterError" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exceptions.py" signature="qiskit.qasm3.QASM3ImporterError(*message)">
|
||||
<Class id="qiskit.qasm3.QASM3ImporterError" name="QASM3ImporterError" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/exceptions.py#L26-L27" signature="qiskit.qasm3.QASM3ImporterError(*message)">
|
||||
An error raised during the OpenQASM 3 importer.
|
||||
|
||||
Set the error message.
|
||||
|
|
@ -322,7 +322,7 @@ You can use the experimental interface immediately, with similar functions to th
|
|||
|
||||
### load\_experimental
|
||||
|
||||
<Function id="qiskit.qasm3.load_experimental" name="load_experimental" signature="qiskit.qasm3.load_experimental(pathlike_or_filelike, /, *, custom_gates=None, include_path=None)">
|
||||
<Function id="qiskit.qasm3.load_experimental" name="load_experimental" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py" signature="qiskit.qasm3.load_experimental(pathlike_or_filelike, /, *, custom_gates=None, include_path=None)">
|
||||
Load an OpenQASM 3 program from a source file into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
|
||||
|
||||
<Admonition title="Warning" type="caution">
|
||||
|
|
@ -350,7 +350,7 @@ You can use the experimental interface immediately, with similar functions to th
|
|||
|
||||
### loads\_experimental
|
||||
|
||||
<Function id="qiskit.qasm3.loads_experimental" name="loads_experimental" signature="qiskit.qasm3.loads_experimental(source, /, *, custom_gates=None, include_path=None)">
|
||||
<Function id="qiskit.qasm3.loads_experimental" name="loads_experimental" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/qasm3/__init__.py" signature="qiskit.qasm3.loads_experimental(source, /, *, custom_gates=None, include_path=None)">
|
||||
Load an OpenQASM 3 program from a string into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
|
||||
|
||||
<Admonition title="Warning" type="caution">
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.assembler.RunConfig
|
|||
|
||||
# RunConfig
|
||||
|
||||
<Class id="qiskit.assembler.RunConfig" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/assembler/run_config.py" signature="qiskit.assembler.RunConfig(shots=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)">
|
||||
<Class id="qiskit.assembler.RunConfig" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/assembler/run_config.py#L18-L77" signature="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)")
|
||||
|
||||
Class for Run Configuration.
|
||||
|
|
@ -67,7 +67,7 @@ python_api_name: qiskit.assembler.RunConfig
|
|||
|
||||
### from\_dict
|
||||
|
||||
<Function id="qiskit.assembler.RunConfig.from_dict" name="from_dict" signature="classmethod from_dict(data)">
|
||||
<Function id="qiskit.assembler.RunConfig.from_dict" name="from_dict" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/assembler/run_config.py#L57-L69" signature="classmethod from_dict(data)">
|
||||
Create a new RunConfig object from a dictionary.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -85,7 +85,7 @@ python_api_name: qiskit.assembler.RunConfig
|
|||
|
||||
### to\_dict
|
||||
|
||||
<Function id="qiskit.assembler.RunConfig.to_dict" name="to_dict" signature="to_dict()">
|
||||
<Function id="qiskit.assembler.RunConfig.to_dict" name="to_dict" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/assembler/run_config.py#L71-L77" signature="to_dict()">
|
||||
Return a dictionary format representation of the RunConfig
|
||||
|
||||
**Returns**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaQubit
|
|||
|
||||
# AncillaQubit
|
||||
|
||||
<Class id="qiskit.circuit.AncillaQubit" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py" signature="qiskit.circuit.AncillaQubit(register=None, index=None)">
|
||||
<Class id="qiskit.circuit.AncillaQubit" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py#L60-L65" signature="qiskit.circuit.AncillaQubit(register=None, index=None)">
|
||||
Bases: [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit")
|
||||
|
||||
A qubit used as ancillary qubit.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AncillaRegister
|
|||
|
||||
# AncillaRegister
|
||||
|
||||
<Class id="qiskit.circuit.AncillaRegister" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py" signature="qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)">
|
||||
<Class id="qiskit.circuit.AncillaRegister" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py#L68-L75" signature="qiskit.circuit.AncillaRegister(size=None, name=None, bits=None)">
|
||||
Bases: [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister")
|
||||
|
||||
Implement an ancilla register.
|
||||
|
|
@ -57,7 +57,7 @@ python_api_name: qiskit.circuit.AncillaRegister
|
|||
|
||||
### index
|
||||
|
||||
<Function id="qiskit.circuit.AncillaRegister.index" name="index" signature="index(bit)">
|
||||
<Function id="qiskit.circuit.AncillaRegister.index" name="index" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/register.py#L183-L191" signature="index(bit)">
|
||||
Find the index of the provided bit within this register.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation
|
|||
|
||||
# AnnotatedOperation
|
||||
|
||||
<Class id="qiskit.circuit.AnnotatedOperation" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py" signature="qiskit.circuit.AnnotatedOperation(base_op, modifiers)">
|
||||
<Class id="qiskit.circuit.AnnotatedOperation" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py#L59-L199" signature="qiskit.circuit.AnnotatedOperation(base_op, modifiers)">
|
||||
Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation")
|
||||
|
||||
Annotated operation.
|
||||
|
|
@ -61,7 +61,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.AnnotatedOperation.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=True)">
|
||||
<Function id="qiskit.circuit.AnnotatedOperation.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py#L155-L182" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=True)">
|
||||
Return the controlled version of itself.
|
||||
|
||||
Implemented as an annotated operation, see [`AnnotatedOperation`](#qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation").
|
||||
|
|
@ -84,7 +84,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.AnnotatedOperation.copy" name="copy" signature="copy()">
|
||||
<Function id="qiskit.circuit.AnnotatedOperation.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py#L130-L132" signature="copy()">
|
||||
Return a copy of the [`AnnotatedOperation`](#qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation").
|
||||
|
||||
**Return type**
|
||||
|
|
@ -94,7 +94,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.AnnotatedOperation.inverse" name="inverse" signature="inverse(annotated=True)">
|
||||
<Function id="qiskit.circuit.AnnotatedOperation.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py#L184-L199" signature="inverse(annotated=True)">
|
||||
Return the inverse version of itself.
|
||||
|
||||
Implemented as an annotated operation, see [`AnnotatedOperation`](#qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation").
|
||||
|
|
@ -110,7 +110,7 @@ python_api_name: qiskit.circuit.AnnotatedOperation
|
|||
|
||||
### to\_matrix
|
||||
|
||||
<Function id="qiskit.circuit.AnnotatedOperation.to_matrix" name="to_matrix" signature="to_matrix()">
|
||||
<Function id="qiskit.circuit.AnnotatedOperation.to_matrix" name="to_matrix" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py#L134-L153" signature="to_matrix()">
|
||||
Return a matrix representation (allowing to construct Operator).
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Bit
|
|||
|
||||
# Bit
|
||||
|
||||
<Class id="qiskit.circuit.Bit" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/bit.py" signature="qiskit.circuit.Bit(register=None, index=None)">
|
||||
<Class id="qiskit.circuit.Bit" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/bit.py#L21-L95" signature="qiskit.circuit.Bit(register=None, index=None)">
|
||||
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
|
||||
|
||||
Implement a generic bit.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.BreakLoopOp
|
|||
|
||||
# BreakLoopOp
|
||||
|
||||
<Class id="qiskit.circuit.BreakLoopOp" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/break_loop.py" signature="qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)">
|
||||
<Class id="qiskit.circuit.BreakLoopOp" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/break_loop.py#L21-L47" signature="qiskit.circuit.BreakLoopOp(num_qubits, num_clbits, label=None)">
|
||||
Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")
|
||||
|
||||
A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop.
|
||||
|
|
@ -145,19 +145,19 @@ python_api_name: qiskit.circuit.BreakLoopOp
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L535-L564" signature="broadcast_arguments(qargs, cargs)">
|
||||
Validation of the arguments.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -176,7 +176,7 @@ python_api_name: qiskit.circuit.BreakLoopOp
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L479-L497" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -186,7 +186,7 @@ python_api_name: qiskit.circuit.BreakLoopOp
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -204,7 +204,7 @@ python_api_name: qiskit.circuit.BreakLoopOp
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477" signature="inverse(annotated=False)">
|
||||
Invert this instruction.
|
||||
|
||||
If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.
|
||||
|
|
@ -228,13 +228,13 @@ python_api_name: qiskit.circuit.BreakLoopOp
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -256,7 +256,7 @@ python_api_name: qiskit.circuit.BreakLoopOp
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -274,7 +274,7 @@ python_api_name: qiskit.circuit.BreakLoopOp
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -292,7 +292,7 @@ python_api_name: qiskit.circuit.BreakLoopOp
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -300,7 +300,7 @@ python_api_name: qiskit.circuit.BreakLoopOp
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.BreakLoopOp.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.BreakLoopOp.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L289-L291" signature="validate_parameter(parameter)">
|
||||
Instruction parameters has no validation or normalization.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ClassicalRegister
|
|||
|
||||
# ClassicalRegister
|
||||
|
||||
<Class id="qiskit.circuit.ClassicalRegister" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalregister.py" signature="qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)">
|
||||
<Class id="qiskit.circuit.ClassicalRegister" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalregister.py#L50-L57" signature="qiskit.circuit.ClassicalRegister(size=None, name=None, bits=None)">
|
||||
Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register")
|
||||
|
||||
Implement a classical register.
|
||||
|
|
@ -57,7 +57,7 @@ python_api_name: qiskit.circuit.ClassicalRegister
|
|||
|
||||
### index
|
||||
|
||||
<Function id="qiskit.circuit.ClassicalRegister.index" name="index" signature="index(bit)">
|
||||
<Function id="qiskit.circuit.ClassicalRegister.index" name="index" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/register.py#L183-L191" signature="index(bit)">
|
||||
Find the index of the provided bit within this register.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Clbit
|
|||
|
||||
# Clbit
|
||||
|
||||
<Class id="qiskit.circuit.Clbit" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalregister.py" signature="qiskit.circuit.Clbit(register=None, index=None)">
|
||||
<Class id="qiskit.circuit.Clbit" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalregister.py#L26-L47" signature="qiskit.circuit.Clbit(register=None, index=None)">
|
||||
Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit")
|
||||
|
||||
Implement a classical bit.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.CommutationChecker
|
|||
|
||||
# CommutationChecker
|
||||
|
||||
<Class id="qiskit.circuit.CommutationChecker" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/commutation_checker.py" signature="qiskit.circuit.CommutationChecker(standard_gate_commutations=None, cache_max_entries=1000000)">
|
||||
<Class id="qiskit.circuit.CommutationChecker" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/commutation_checker.py#L33-L183" signature="qiskit.circuit.CommutationChecker(standard_gate_commutations=None, cache_max_entries=1000000)">
|
||||
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
|
||||
|
||||
This code is essentially copy-pasted from commutative\_analysis.py. This code cleverly hashes commutativity and non-commutativity results between DAG nodes and seems quite efficient for large Clifford circuits. They may be other possible efficiency improvements: using rule-based commutativity analysis, evicting from the cache less useful entries, etc.
|
||||
|
|
@ -17,7 +17,7 @@ python_api_name: qiskit.circuit.CommutationChecker
|
|||
|
||||
### check\_commutation\_entries
|
||||
|
||||
<Function id="qiskit.circuit.CommutationChecker.check_commutation_entries" name="check_commutation_entries" signature="check_commutation_entries(first_op, first_qargs, second_op, second_qargs)">
|
||||
<Function id="qiskit.circuit.CommutationChecker.check_commutation_entries" name="check_commutation_entries" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/commutation_checker.py#L141-L183" signature="check_commutation_entries(first_op, first_qargs, second_op, second_qargs)">
|
||||
Returns stored commutation relation if any
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -38,13 +38,13 @@ python_api_name: qiskit.circuit.CommutationChecker
|
|||
|
||||
### clear\_cached\_commutations
|
||||
|
||||
<Function id="qiskit.circuit.CommutationChecker.clear_cached_commutations" name="clear_cached_commutations" signature="clear_cached_commutations()">
|
||||
<Function id="qiskit.circuit.CommutationChecker.clear_cached_commutations" name="clear_cached_commutations" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/commutation_checker.py#L134-L139" signature="clear_cached_commutations()">
|
||||
Clears the dictionary holding cached commutations
|
||||
</Function>
|
||||
|
||||
### commute
|
||||
|
||||
<Function id="qiskit.circuit.CommutationChecker.commute" name="commute" signature="commute(op1, qargs1, cargs1, op2, qargs2, cargs2, max_num_qubits=3)">
|
||||
<Function id="qiskit.circuit.CommutationChecker.commute" name="commute" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/commutation_checker.py#L56-L128" signature="commute(op1, qargs1, cargs1, op2, qargs2, cargs2, max_num_qubits=3)">
|
||||
Checks if two Operations commute. The return value of True means that the operations truly commute, and the return value of False means that either the operations do not commute or that the commutation check was skipped (for example, when the operations have conditions or have too many qubits).
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -68,7 +68,7 @@ python_api_name: qiskit.circuit.CommutationChecker
|
|||
|
||||
### num\_cached\_entries
|
||||
|
||||
<Function id="qiskit.circuit.CommutationChecker.num_cached_entries" name="num_cached_entries" signature="num_cached_entries()">
|
||||
<Function id="qiskit.circuit.CommutationChecker.num_cached_entries" name="num_cached_entries" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/commutation_checker.py#L130-L132" signature="num_cached_entries()">
|
||||
Returns number of cached entries
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp
|
|||
|
||||
# ContinueLoopOp
|
||||
|
||||
<Class id="qiskit.circuit.ContinueLoopOp" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/continue_loop.py" signature="qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)">
|
||||
<Class id="qiskit.circuit.ContinueLoopOp" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/continue_loop.py#L21-L47" signature="qiskit.circuit.ContinueLoopOp(num_qubits, num_clbits, label=None)">
|
||||
Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")
|
||||
|
||||
A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop.
|
||||
|
|
@ -149,19 +149,19 @@ python_api_name: qiskit.circuit.ContinueLoopOp
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L535-L564" signature="broadcast_arguments(qargs, cargs)">
|
||||
Validation of the arguments.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -180,7 +180,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L479-L497" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -190,7 +190,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -208,7 +208,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477" signature="inverse(annotated=False)">
|
||||
Invert this instruction.
|
||||
|
||||
If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.
|
||||
|
|
@ -232,13 +232,13 @@ python_api_name: qiskit.circuit.ContinueLoopOp
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -260,7 +260,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -278,7 +278,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -296,7 +296,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -304,7 +304,7 @@ python_api_name: qiskit.circuit.ContinueLoopOp
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.ContinueLoopOp.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L289-L291" signature="validate_parameter(parameter)">
|
||||
Instruction parameters has no validation or normalization.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlFlowOp
|
|||
|
||||
# ControlFlowOp
|
||||
|
||||
<Class id="qiskit.circuit.ControlFlowOp" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/control_flow.py" signature="qiskit.circuit.ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)">
|
||||
<Class id="qiskit.circuit.ControlFlowOp" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/control_flow.py#L26-L45" signature="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)")
|
||||
|
||||
Abstract class to encapsulate all control flow operations.
|
||||
|
|
@ -137,19 +137,19 @@ python_api_name: qiskit.circuit.ControlFlowOp
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L535-L564" signature="broadcast_arguments(qargs, cargs)">
|
||||
Validation of the arguments.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -168,7 +168,7 @@ python_api_name: qiskit.circuit.ControlFlowOp
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L479-L497" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -178,7 +178,7 @@ python_api_name: qiskit.circuit.ControlFlowOp
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -196,7 +196,7 @@ python_api_name: qiskit.circuit.ControlFlowOp
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477" signature="inverse(annotated=False)">
|
||||
Invert this instruction.
|
||||
|
||||
If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.
|
||||
|
|
@ -220,13 +220,13 @@ python_api_name: qiskit.circuit.ControlFlowOp
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -248,7 +248,7 @@ python_api_name: qiskit.circuit.ControlFlowOp
|
|||
|
||||
### replace\_blocks
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.replace_blocks" name="replace_blocks" signature="abstract replace_blocks(blocks)">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.replace_blocks" name="replace_blocks" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/control_flow.py#L37-L45" signature="abstract replace_blocks(blocks)">
|
||||
Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -262,7 +262,7 @@ python_api_name: qiskit.circuit.ControlFlowOp
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -280,7 +280,7 @@ python_api_name: qiskit.circuit.ControlFlowOp
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -298,7 +298,7 @@ python_api_name: qiskit.circuit.ControlFlowOp
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -306,7 +306,7 @@ python_api_name: qiskit.circuit.ControlFlowOp
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.ControlFlowOp.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.ControlFlowOp.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L289-L291" signature="validate_parameter(parameter)">
|
||||
Instruction parameters has no validation or normalization.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlModifier
|
|||
|
||||
# ControlModifier
|
||||
|
||||
<Class id="qiskit.circuit.ControlModifier" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py" signature="qiskit.circuit.ControlModifier(num_ctrl_qubits=0, ctrl_state=None)">
|
||||
<Class id="qiskit.circuit.ControlModifier" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py#L39-L49" signature="qiskit.circuit.ControlModifier(num_ctrl_qubits=0, ctrl_state=None)">
|
||||
Bases: `Modifier`
|
||||
|
||||
Control modifier: specifies that the operation is controlled by `num_ctrl_qubits` and has control state `ctrl_state`.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
# ControlledGate
|
||||
|
||||
<Class id="qiskit.circuit.ControlledGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlledgate.py" signature="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)">
|
||||
<Class id="qiskit.circuit.ControlledGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlledgate.py#L28-L274" signature="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")
|
||||
|
||||
Controlled unitary gate.
|
||||
|
|
@ -203,19 +203,19 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.ControlledGate.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.ControlledGate.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.ControlledGate.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L169-L226" signature="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:
|
||||
|
|
@ -268,7 +268,7 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.ControlledGate.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L479-L497" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -278,7 +278,7 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.ControlledGate.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L89-L126" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Return the controlled version of itself.
|
||||
|
||||
Implemented either as a controlled gate (ref. [`ControlledGate`](#qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate")) or as an annotated operation (ref. [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation")).
|
||||
|
|
@ -301,7 +301,7 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.ControlledGate.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -319,7 +319,7 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.ControlledGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlledgate.py#L266-L274" signature="inverse(annotated=False)">
|
||||
Invert this gate by calling inverse on the base gate.
|
||||
|
||||
**Return type**
|
||||
|
|
@ -329,13 +329,13 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.ControlledGate.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### power
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.power" name="power" signature="power(exponent)">
|
||||
<Function id="qiskit.circuit.ControlledGate.power" name="power" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L65-L81" signature="power(exponent)">
|
||||
Creates a unitary gate as gate^exponent.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -357,7 +357,7 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.ControlledGate.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -379,7 +379,7 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.ControlledGate.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -397,7 +397,7 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.ControlledGate.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -415,7 +415,7 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### to\_matrix
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.to_matrix" name="to_matrix" signature="to_matrix()">
|
||||
<Function id="qiskit.circuit.ControlledGate.to_matrix" name="to_matrix" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L51-L63" signature="to_matrix()">
|
||||
Return a Numpy.array for the gate unitary matrix.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -433,7 +433,7 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.ControlledGate.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -441,7 +441,7 @@ python_api_name: qiskit.circuit.ControlledGate
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.ControlledGate.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.ControlledGate.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L228-L242" signature="validate_parameter(parameter)">
|
||||
Gate parameters should be int, float, or ParameterExpression
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Delay
|
|||
|
||||
# Delay
|
||||
|
||||
<Class id="qiskit.circuit.Delay" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/delay.py" signature="qiskit.circuit.Delay(duration, unit='dt')">
|
||||
<Class id="qiskit.circuit.Delay" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/delay.py#L23-L104" signature="qiskit.circuit.Delay(duration, unit='dt')">
|
||||
Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")
|
||||
|
||||
Do nothing and just delay/wait/idle for a specified duration.
|
||||
|
|
@ -116,19 +116,19 @@ python_api_name: qiskit.circuit.Delay
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.Delay.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.Delay.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.Delay.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.Delay.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.Delay.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.Delay.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L169-L226" signature="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:
|
||||
|
|
@ -181,7 +181,7 @@ python_api_name: qiskit.circuit.Delay
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.Delay.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.Delay.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/delay.py#L39-L40" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -191,7 +191,7 @@ python_api_name: qiskit.circuit.Delay
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.Delay.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.Delay.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -209,19 +209,19 @@ python_api_name: qiskit.circuit.Delay
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.Delay.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.Delay.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/delay.py#L35-L37" signature="inverse(annotated=False)">
|
||||
Special case. Return self.
|
||||
</Function>
|
||||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.Delay.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.Delay.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.Delay.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.Delay.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -243,7 +243,7 @@ python_api_name: qiskit.circuit.Delay
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.Delay.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.Delay.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -261,7 +261,7 @@ python_api_name: qiskit.circuit.Delay
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.Delay.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.Delay.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -279,7 +279,7 @@ python_api_name: qiskit.circuit.Delay
|
|||
|
||||
### to\_matrix
|
||||
|
||||
<Function id="qiskit.circuit.Delay.to_matrix" name="to_matrix" signature="to_matrix()">
|
||||
<Function id="qiskit.circuit.Delay.to_matrix" name="to_matrix" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/delay.py#L56-L63" signature="to_matrix()">
|
||||
Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -293,7 +293,7 @@ python_api_name: qiskit.circuit.Delay
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.Delay.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.Delay.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -301,7 +301,7 @@ python_api_name: qiskit.circuit.Delay
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.Delay.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.Delay.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/delay.py#L69-L104" signature="validate_parameter(parameter)">
|
||||
Delay parameter (i.e. duration) must be int, float or ParameterExpression.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary
|
|||
|
||||
# EquivalenceLibrary
|
||||
|
||||
<Class id="qiskit.circuit.EquivalenceLibrary" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/equivalence.py" signature="qiskit.circuit.EquivalenceLibrary(*, base=None)">
|
||||
<Class id="qiskit.circuit.EquivalenceLibrary" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/equivalence.py#L32-L267" signature="qiskit.circuit.EquivalenceLibrary(*, base=None)">
|
||||
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
|
||||
|
||||
A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits.
|
||||
|
|
@ -41,7 +41,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary
|
|||
|
||||
### add\_equivalence
|
||||
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.add_equivalence" name="add_equivalence" signature="add_equivalence(gate, equivalent_circuit)">
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.add_equivalence" name="add_equivalence" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/equivalence.py#L76-L113" signature="add_equivalence(gate, equivalent_circuit)">
|
||||
Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base).
|
||||
|
||||
Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.params) can be marked equivalent to parameterized circuits, provided the parameters match.
|
||||
|
|
@ -54,7 +54,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary
|
|||
|
||||
### draw
|
||||
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.draw" name="draw" signature="draw(filename=None)">
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.draw" name="draw" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/equivalence.py#L199-L224" signature="draw(filename=None)">
|
||||
Draws the equivalence relations available in the library.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -78,7 +78,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary
|
|||
|
||||
### get\_entry
|
||||
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.get_entry" name="get_entry" signature="get_entry(gate)">
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.get_entry" name="get_entry" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/equivalence.py#L156-L178" signature="get_entry(gate)">
|
||||
Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate.
|
||||
|
||||
Parameterized circuits will have their parameters replaced with the corresponding entries from Gate.params.
|
||||
|
|
@ -102,7 +102,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary
|
|||
|
||||
### has\_entry
|
||||
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.has_entry" name="has_entry" signature="has_entry(gate)">
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.has_entry" name="has_entry" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/equivalence.py#L115-L127" signature="has_entry(gate)">
|
||||
Check if a library contains any decompositions for gate.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -122,7 +122,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary
|
|||
|
||||
### keys
|
||||
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.keys" name="keys" signature="keys()">
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.keys" name="keys" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/equivalence.py#L180-L186" signature="keys()">
|
||||
Return list of keys to key to node index map.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -136,7 +136,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary
|
|||
|
||||
### node\_index
|
||||
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.node_index" name="node_index" signature="node_index(key)">
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.node_index" name="node_index" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/equivalence.py#L188-L197" signature="node_index(key)">
|
||||
Return node index for a given key.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.EquivalenceLibrary
|
|||
|
||||
### set\_entry
|
||||
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.set_entry" name="set_entry" signature="set_entry(gate, entry)">
|
||||
<Function id="qiskit.circuit.EquivalenceLibrary.set_entry" name="set_entry" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/equivalence.py#L129-L154" signature="set_entry(gate, entry)">
|
||||
Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided.
|
||||
|
||||
Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.params) can be marked equivalent to parameterized circuits, provided the parameters match.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ForLoopOp
|
|||
|
||||
# ForLoopOp
|
||||
|
||||
<Class id="qiskit.circuit.ForLoopOp" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/for_loop.py" signature="qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)">
|
||||
<Class id="qiskit.circuit.ForLoopOp" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/for_loop.py#L28-L129" signature="qiskit.circuit.ForLoopOp(indexset, loop_parameter, body, label=None)">
|
||||
Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp")
|
||||
|
||||
A circuit operation which repeatedly executes a subcircuit (`body`) parameterized by a parameter `loop_parameter` through the set of integer values provided in `indexset`.
|
||||
|
|
@ -154,19 +154,19 @@ python_api_name: qiskit.circuit.ForLoopOp
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.ForLoopOp.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.ForLoopOp.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.ForLoopOp.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L535-L564" signature="broadcast_arguments(qargs, cargs)">
|
||||
Validation of the arguments.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -185,7 +185,7 @@ python_api_name: qiskit.circuit.ForLoopOp
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.ForLoopOp.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L479-L497" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -195,7 +195,7 @@ python_api_name: qiskit.circuit.ForLoopOp
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.ForLoopOp.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -213,7 +213,7 @@ python_api_name: qiskit.circuit.ForLoopOp
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.ForLoopOp.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477" signature="inverse(annotated=False)">
|
||||
Invert this instruction.
|
||||
|
||||
If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.
|
||||
|
|
@ -237,13 +237,13 @@ python_api_name: qiskit.circuit.ForLoopOp
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.ForLoopOp.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.ForLoopOp.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -265,7 +265,7 @@ python_api_name: qiskit.circuit.ForLoopOp
|
|||
|
||||
### replace\_blocks
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.replace_blocks" name="replace_blocks" signature="replace_blocks(blocks)">
|
||||
<Function id="qiskit.circuit.ForLoopOp.replace_blocks" name="replace_blocks" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/for_loop.py#L127-L129" signature="replace_blocks(blocks)">
|
||||
Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -275,7 +275,7 @@ python_api_name: qiskit.circuit.ForLoopOp
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.ForLoopOp.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -293,7 +293,7 @@ python_api_name: qiskit.circuit.ForLoopOp
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.ForLoopOp.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -311,7 +311,7 @@ python_api_name: qiskit.circuit.ForLoopOp
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.ForLoopOp.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -319,7 +319,7 @@ python_api_name: qiskit.circuit.ForLoopOp
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.ForLoopOp.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.ForLoopOp.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L289-L291" signature="validate_parameter(parameter)">
|
||||
Instruction parameters has no validation or normalization.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
# Gate
|
||||
|
||||
<Class id="qiskit.circuit.Gate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py" signature="qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')">
|
||||
<Class id="qiskit.circuit.Gate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L25-L242" signature="qiskit.circuit.Gate(name, num_qubits, params, label=None, duration=None, unit='dt')">
|
||||
Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")
|
||||
|
||||
Unitary gate.
|
||||
|
|
@ -123,19 +123,19 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.Gate.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.Gate.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.Gate.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.Gate.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.Gate.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.Gate.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L169-L226" signature="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:
|
||||
|
|
@ -188,7 +188,7 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.Gate.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.Gate.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L479-L497" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -198,7 +198,7 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.Gate.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.Gate.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L89-L126" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Return the controlled version of itself.
|
||||
|
||||
Implemented either as a controlled gate (ref. [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate")) or as an annotated operation (ref. [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation")).
|
||||
|
|
@ -221,7 +221,7 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.Gate.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.Gate.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -239,7 +239,7 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.Gate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.Gate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477" signature="inverse(annotated=False)">
|
||||
Invert this instruction.
|
||||
|
||||
If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.
|
||||
|
|
@ -263,13 +263,13 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.Gate.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.Gate.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### power
|
||||
|
||||
<Function id="qiskit.circuit.Gate.power" name="power" signature="power(exponent)">
|
||||
<Function id="qiskit.circuit.Gate.power" name="power" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L65-L81" signature="power(exponent)">
|
||||
Creates a unitary gate as gate^exponent.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -291,7 +291,7 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.Gate.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.Gate.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -313,7 +313,7 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.Gate.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.Gate.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -331,7 +331,7 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.Gate.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.Gate.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -349,7 +349,7 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### to\_matrix
|
||||
|
||||
<Function id="qiskit.circuit.Gate.to_matrix" name="to_matrix" signature="to_matrix()">
|
||||
<Function id="qiskit.circuit.Gate.to_matrix" name="to_matrix" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L51-L63" signature="to_matrix()">
|
||||
Return a Numpy.array for the gate unitary matrix.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -367,7 +367,7 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.Gate.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.Gate.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -375,7 +375,7 @@ python_api_name: qiskit.circuit.Gate
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.Gate.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.Gate.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L228-L242" signature="validate_parameter(parameter)">
|
||||
Gate parameters should be int, float, or ParameterExpression
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.IfElseOp
|
|||
|
||||
# IfElseOp
|
||||
|
||||
<Class id="qiskit.circuit.IfElseOp" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/if_else.py" signature="qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)">
|
||||
<Class id="qiskit.circuit.IfElseOp" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/if_else.py#L42-L175" signature="qiskit.circuit.IfElseOp(condition, true_body, false_body=None, label=None)">
|
||||
Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp")
|
||||
|
||||
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.
|
||||
|
|
@ -158,19 +158,19 @@ python_api_name: qiskit.circuit.IfElseOp
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.IfElseOp.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.IfElseOp.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.IfElseOp.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L535-L564" signature="broadcast_arguments(qargs, cargs)">
|
||||
Validation of the arguments.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -189,7 +189,7 @@ python_api_name: qiskit.circuit.IfElseOp
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.IfElseOp.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/if_else.py#L171-L175" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -199,7 +199,7 @@ python_api_name: qiskit.circuit.IfElseOp
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.IfElseOp.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -217,7 +217,7 @@ python_api_name: qiskit.circuit.IfElseOp
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.IfElseOp.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477" signature="inverse(annotated=False)">
|
||||
Invert this instruction.
|
||||
|
||||
If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.
|
||||
|
|
@ -241,13 +241,13 @@ python_api_name: qiskit.circuit.IfElseOp
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.IfElseOp.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.IfElseOp.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -269,7 +269,7 @@ python_api_name: qiskit.circuit.IfElseOp
|
|||
|
||||
### replace\_blocks
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.replace_blocks" name="replace_blocks" signature="replace_blocks(blocks)">
|
||||
<Function id="qiskit.circuit.IfElseOp.replace_blocks" name="replace_blocks" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/if_else.py#L155-L169" signature="replace_blocks(blocks)">
|
||||
Replace blocks and return new instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -287,7 +287,7 @@ python_api_name: qiskit.circuit.IfElseOp
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.IfElseOp.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -305,7 +305,7 @@ python_api_name: qiskit.circuit.IfElseOp
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.IfElseOp.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -323,7 +323,7 @@ python_api_name: qiskit.circuit.IfElseOp
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.IfElseOp.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -331,7 +331,7 @@ python_api_name: qiskit.circuit.IfElseOp
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.IfElseOp.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.IfElseOp.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L289-L291" signature="validate_parameter(parameter)">
|
||||
Instruction parameters has no validation or normalization.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Instruction
|
|||
|
||||
# Instruction
|
||||
|
||||
<Class id="qiskit.circuit.Instruction" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py" signature="qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)">
|
||||
<Class id="qiskit.circuit.Instruction" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L56-L657" signature="qiskit.circuit.Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)">
|
||||
Bases: [`Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation")
|
||||
|
||||
Generic quantum instruction.
|
||||
|
|
@ -131,19 +131,19 @@ python_api_name: qiskit.circuit.Instruction
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.Instruction.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.Instruction.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.Instruction.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L535-L564" signature="broadcast_arguments(qargs, cargs)">
|
||||
Validation of the arguments.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -162,7 +162,7 @@ python_api_name: qiskit.circuit.Instruction
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.Instruction.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L479-L497" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -172,7 +172,7 @@ python_api_name: qiskit.circuit.Instruction
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.Instruction.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -190,7 +190,7 @@ python_api_name: qiskit.circuit.Instruction
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.Instruction.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477" signature="inverse(annotated=False)">
|
||||
Invert this instruction.
|
||||
|
||||
If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.
|
||||
|
|
@ -214,13 +214,13 @@ python_api_name: qiskit.circuit.Instruction
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.Instruction.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.Instruction.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -242,7 +242,7 @@ python_api_name: qiskit.circuit.Instruction
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.Instruction.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -260,7 +260,7 @@ python_api_name: qiskit.circuit.Instruction
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.Instruction.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -278,7 +278,7 @@ python_api_name: qiskit.circuit.Instruction
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.Instruction.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -286,7 +286,7 @@ python_api_name: qiskit.circuit.Instruction
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.Instruction.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.Instruction.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L289-L291" signature="validate_parameter(parameter)">
|
||||
Instruction parameters has no validation or normalization.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InstructionSet
|
|||
|
||||
# InstructionSet
|
||||
|
||||
<Class id="qiskit.circuit.InstructionSet" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instructionset.py" signature="qiskit.circuit.InstructionSet(*, resource_requester=None)">
|
||||
<Class id="qiskit.circuit.InstructionSet" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instructionset.py#L28-L193" signature="qiskit.circuit.InstructionSet(*, resource_requester=None)">
|
||||
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
|
||||
|
||||
Instruction collection, and their contexts.
|
||||
|
|
@ -51,13 +51,13 @@ python_api_name: qiskit.circuit.InstructionSet
|
|||
|
||||
### add
|
||||
|
||||
<Function id="qiskit.circuit.InstructionSet.add" name="add" signature="add(instruction, qargs=None, cargs=None)">
|
||||
<Function id="qiskit.circuit.InstructionSet.add" name="add" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instructionset.py#L74-L82" signature="add(instruction, qargs=None, cargs=None)">
|
||||
Add an instruction and its context (where it is attached).
|
||||
</Function>
|
||||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.InstructionSet.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.InstructionSet.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instructionset.py#L104-L169" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -106,7 +106,7 @@ python_api_name: qiskit.circuit.InstructionSet
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.InstructionSet.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.InstructionSet.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instructionset.py#L89-L102" signature="inverse(annotated=False)">
|
||||
Invert all instructions.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.InverseModifier
|
|||
|
||||
# InverseModifier
|
||||
|
||||
<Class id="qiskit.circuit.InverseModifier" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py" signature="qiskit.circuit.InverseModifier">
|
||||
<Class id="qiskit.circuit.InverseModifier" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py#L32-L36" signature="qiskit.circuit.InverseModifier">
|
||||
Bases: `Modifier`
|
||||
|
||||
Inverse modifier: specifies that the operation is inverted.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Operation
|
|||
|
||||
# Operation
|
||||
|
||||
<Class id="qiskit.circuit.Operation" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/operation.py" signature="qiskit.circuit.Operation">
|
||||
<Class id="qiskit.circuit.Operation" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/operation.py#L18-L62" signature="qiskit.circuit.Operation">
|
||||
Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.12)")
|
||||
|
||||
Quantum Operation Interface Class. For objects that can be added to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). These objects include [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"), `Reset`, `Barrier`, `Measure`, and operators such as [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). The main purpose is to add an [`Operation`](#qiskit.circuit.Operation "qiskit.circuit.Operation") to a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") without synthesizing it before the transpilation.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter
|
|||
|
||||
# Parameter
|
||||
|
||||
<Class id="qiskit.circuit.Parameter" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameter.py" signature="qiskit.circuit.Parameter(name, *, uuid=None)">
|
||||
<Class id="qiskit.circuit.Parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameter.py#L27-L170" signature="qiskit.circuit.Parameter(name, *, uuid=None)">
|
||||
Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")
|
||||
|
||||
Parameter Class for variable parameters.
|
||||
|
|
@ -73,31 +73,31 @@ python_api_name: qiskit.circuit.Parameter
|
|||
|
||||
### abs
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.abs" name="abs" signature="abs()">
|
||||
<Function id="qiskit.circuit.Parameter.abs" name="abs" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L454-L456" signature="abs()">
|
||||
Absolute of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### arccos
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.arccos" name="arccos" signature="arccos()">
|
||||
<Function id="qiskit.circuit.Parameter.arccos" name="arccos" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L369-L371" signature="arccos()">
|
||||
Arccos of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### arcsin
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.arcsin" name="arcsin" signature="arcsin()">
|
||||
<Function id="qiskit.circuit.Parameter.arcsin" name="arcsin" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L365-L367" signature="arcsin()">
|
||||
Arcsin of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### arctan
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.arctan" name="arctan" signature="arctan()">
|
||||
<Function id="qiskit.circuit.Parameter.arctan" name="arctan" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L373-L375" signature="arctan()">
|
||||
Arctan of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### assign
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.assign" name="assign" signature="assign(parameter, value)">
|
||||
<Function id="qiskit.circuit.Parameter.assign" name="assign" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameter.py#L87-L99" signature="assign(parameter, value)">
|
||||
Assign one parameter to a value, which can either be numeric or another parameter expression.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -112,7 +112,7 @@ python_api_name: qiskit.circuit.Parameter
|
|||
|
||||
### bind
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.bind" name="bind" signature="bind(parameter_values, allow_unknown_parameters=False)">
|
||||
<Function id="qiskit.circuit.Parameter.bind" name="bind" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L93-L146" signature="bind(parameter_values, allow_unknown_parameters=False)">
|
||||
Binds the provided set of parameters to their corresponding values.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -141,7 +141,7 @@ python_api_name: qiskit.circuit.Parameter
|
|||
|
||||
### conjugate
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.conjugate" name="conjugate" signature="conjugate()">
|
||||
<Function id="qiskit.circuit.Parameter.conjugate" name="conjugate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L70-L75" signature="conjugate()">
|
||||
Return the conjugate.
|
||||
|
||||
**Return type**
|
||||
|
|
@ -151,19 +151,19 @@ python_api_name: qiskit.circuit.Parameter
|
|||
|
||||
### cos
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.cos" name="cos" signature="cos()">
|
||||
<Function id="qiskit.circuit.Parameter.cos" name="cos" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L357-L359" signature="cos()">
|
||||
Cosine of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### exp
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.exp" name="exp" signature="exp()">
|
||||
<Function id="qiskit.circuit.Parameter.exp" name="exp" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L377-L379" signature="exp()">
|
||||
Exponential of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### gradient
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.gradient" name="gradient" signature="gradient(param)">
|
||||
<Function id="qiskit.circuit.Parameter.gradient" name="gradient" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L279-L313" signature="gradient(param)">
|
||||
Get the derivative of a parameter expression w\.r.t. a specified parameter expression.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -181,19 +181,19 @@ python_api_name: qiskit.circuit.Parameter
|
|||
|
||||
### is\_real
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.is_real" name="is_real" signature="is_real()">
|
||||
<Function id="qiskit.circuit.Parameter.is_real" name="is_real" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L477-L488" signature="is_real()">
|
||||
Return whether the expression is real
|
||||
</Function>
|
||||
|
||||
### log
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.log" name="log" signature="log()">
|
||||
<Function id="qiskit.circuit.Parameter.log" name="log" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L381-L383" signature="log()">
|
||||
Logarithm of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### numeric
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.numeric" name="numeric" signature="numeric()">
|
||||
<Function id="qiskit.circuit.Parameter.numeric" name="numeric" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L490-L534" signature="numeric()">
|
||||
Return a Python number representing this object, using the most restrictive of [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)"), [`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)") and [`complex`](https://docs.python.org/3/library/functions.html#complex "(in Python v3.12)") that is valid for this object.
|
||||
|
||||
In general, an [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") is only returned if the expression only involved symbolic integers. If floating-point values were used during the evaluation, the return value will be a [`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)") regardless of whether the represented value is an integer. This is because floating-point values “infect” symbolic computations by their inexact nature, and symbolic libraries will use inexact floating-point semantics not exact real-number semantics when they are involved. If you want to assert that all floating-point calculations *were* carried out at infinite precision (i.e. [`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)") could represent every intermediate value exactly), you can use [`float.is_integer()`](https://docs.python.org/3/library/stdtypes.html#float.is_integer "(in Python v3.12)") to check if the return float represents an integer and cast it using [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") if so. This would be an unusual pattern; typically one requires this by only ever using explicitly [`Rational`](https://docs.python.org/3/library/numbers.html#numbers.Rational "(in Python v3.12)") objects while working with symbolic expressions.
|
||||
|
|
@ -215,25 +215,25 @@ python_api_name: qiskit.circuit.Parameter
|
|||
|
||||
### sign
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.sign" name="sign" signature="sign()">
|
||||
<Function id="qiskit.circuit.Parameter.sign" name="sign" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L385-L387" signature="sign()">
|
||||
Sign of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### sin
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.sin" name="sin" signature="sin()">
|
||||
<Function id="qiskit.circuit.Parameter.sin" name="sin" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L353-L355" signature="sin()">
|
||||
Sine of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### subs
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.subs" name="subs" signature="subs(parameter_map, allow_unknown_parameters=False)">
|
||||
<Function id="qiskit.circuit.Parameter.subs" name="subs" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameter.py#L101-L110" signature="subs(parameter_map, allow_unknown_parameters=False)">
|
||||
Substitute self with the corresponding parameter in `parameter_map`.
|
||||
</Function>
|
||||
|
||||
### sympify
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.sympify" name="sympify" signature="sympify()">
|
||||
<Function id="qiskit.circuit.Parameter.sympify" name="sympify" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L536-L548" signature="sympify()">
|
||||
Return symbolic expression as a raw Sympy or Symengine object.
|
||||
|
||||
Symengine is used preferentially; if both are available, the result will always be a `symengine` object. Symengine is a separate library but has integration with Sympy.
|
||||
|
|
@ -245,7 +245,7 @@ python_api_name: qiskit.circuit.Parameter
|
|||
|
||||
### tan
|
||||
|
||||
<Function id="qiskit.circuit.Parameter.tan" name="tan" signature="tan()">
|
||||
<Function id="qiskit.circuit.Parameter.tan" name="tan" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L361-L363" signature="tan()">
|
||||
Tangent of a ParameterExpression
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterExpression
|
|||
|
||||
# ParameterExpression
|
||||
|
||||
<Class id="qiskit.circuit.ParameterExpression" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py" signature="qiskit.circuit.ParameterExpression(symbol_map, expr)">
|
||||
<Class id="qiskit.circuit.ParameterExpression" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L33-L548" signature="qiskit.circuit.ParameterExpression(symbol_map, expr)">
|
||||
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
|
||||
|
||||
ParameterExpression class to enable creating expressions of Parameters.
|
||||
|
|
@ -34,31 +34,31 @@ python_api_name: qiskit.circuit.ParameterExpression
|
|||
|
||||
### abs
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.abs" name="abs" signature="abs()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.abs" name="abs" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L454-L456" signature="abs()">
|
||||
Absolute of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### arccos
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.arccos" name="arccos" signature="arccos()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.arccos" name="arccos" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L369-L371" signature="arccos()">
|
||||
Arccos of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### arcsin
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.arcsin" name="arcsin" signature="arcsin()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.arcsin" name="arcsin" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L365-L367" signature="arcsin()">
|
||||
Arcsin of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### arctan
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.arctan" name="arctan" signature="arctan()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.arctan" name="arctan" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L373-L375" signature="arctan()">
|
||||
Arctan of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### assign
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.assign" name="assign" signature="assign(parameter, value)">
|
||||
<Function id="qiskit.circuit.ParameterExpression.assign" name="assign" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L77-L91" signature="assign(parameter, value)">
|
||||
Assign one parameter to a value, which can either be numeric or another parameter expression.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -77,7 +77,7 @@ python_api_name: qiskit.circuit.ParameterExpression
|
|||
|
||||
### bind
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.bind" name="bind" signature="bind(parameter_values, allow_unknown_parameters=False)">
|
||||
<Function id="qiskit.circuit.ParameterExpression.bind" name="bind" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L93-L146" signature="bind(parameter_values, allow_unknown_parameters=False)">
|
||||
Binds the provided set of parameters to their corresponding values.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -106,7 +106,7 @@ python_api_name: qiskit.circuit.ParameterExpression
|
|||
|
||||
### conjugate
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.conjugate" name="conjugate" signature="conjugate()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.conjugate" name="conjugate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L70-L75" signature="conjugate()">
|
||||
Return the conjugate.
|
||||
|
||||
**Return type**
|
||||
|
|
@ -116,19 +116,19 @@ python_api_name: qiskit.circuit.ParameterExpression
|
|||
|
||||
### cos
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.cos" name="cos" signature="cos()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.cos" name="cos" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L357-L359" signature="cos()">
|
||||
Cosine of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### exp
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.exp" name="exp" signature="exp()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.exp" name="exp" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L377-L379" signature="exp()">
|
||||
Exponential of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### gradient
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.gradient" name="gradient" signature="gradient(param)">
|
||||
<Function id="qiskit.circuit.ParameterExpression.gradient" name="gradient" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L279-L313" signature="gradient(param)">
|
||||
Get the derivative of a parameter expression w\.r.t. a specified parameter expression.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -146,19 +146,19 @@ python_api_name: qiskit.circuit.ParameterExpression
|
|||
|
||||
### is\_real
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.is_real" name="is_real" signature="is_real()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.is_real" name="is_real" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L477-L488" signature="is_real()">
|
||||
Return whether the expression is real
|
||||
</Function>
|
||||
|
||||
### log
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.log" name="log" signature="log()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.log" name="log" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L381-L383" signature="log()">
|
||||
Logarithm of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### numeric
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.numeric" name="numeric" signature="numeric()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.numeric" name="numeric" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L490-L534" signature="numeric()">
|
||||
Return a Python number representing this object, using the most restrictive of [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)"), [`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)") and [`complex`](https://docs.python.org/3/library/functions.html#complex "(in Python v3.12)") that is valid for this object.
|
||||
|
||||
In general, an [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") is only returned if the expression only involved symbolic integers. If floating-point values were used during the evaluation, the return value will be a [`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)") regardless of whether the represented value is an integer. This is because floating-point values “infect” symbolic computations by their inexact nature, and symbolic libraries will use inexact floating-point semantics not exact real-number semantics when they are involved. If you want to assert that all floating-point calculations *were* carried out at infinite precision (i.e. [`float`](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)") could represent every intermediate value exactly), you can use [`float.is_integer()`](https://docs.python.org/3/library/stdtypes.html#float.is_integer "(in Python v3.12)") to check if the return float represents an integer and cast it using [`int`](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") if so. This would be an unusual pattern; typically one requires this by only ever using explicitly [`Rational`](https://docs.python.org/3/library/numbers.html#numbers.Rational "(in Python v3.12)") objects while working with symbolic expressions.
|
||||
|
|
@ -180,19 +180,19 @@ python_api_name: qiskit.circuit.ParameterExpression
|
|||
|
||||
### sign
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.sign" name="sign" signature="sign()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.sign" name="sign" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L385-L387" signature="sign()">
|
||||
Sign of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### sin
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.sin" name="sin" signature="sin()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.sin" name="sin" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L353-L355" signature="sin()">
|
||||
Sine of a ParameterExpression
|
||||
</Function>
|
||||
|
||||
### subs
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.subs" name="subs" signature="subs(parameter_map, allow_unknown_parameters=False)">
|
||||
<Function id="qiskit.circuit.ParameterExpression.subs" name="subs" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L148-L196" signature="subs(parameter_map, allow_unknown_parameters=False)">
|
||||
Returns a new Expression with replacement Parameters.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -217,7 +217,7 @@ python_api_name: qiskit.circuit.ParameterExpression
|
|||
|
||||
### sympify
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.sympify" name="sympify" signature="sympify()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.sympify" name="sympify" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L536-L548" signature="sympify()">
|
||||
Return symbolic expression as a raw Sympy or Symengine object.
|
||||
|
||||
Symengine is used preferentially; if both are available, the result will always be a `symengine` object. Symengine is a separate library but has integration with Sympy.
|
||||
|
|
@ -229,7 +229,7 @@ python_api_name: qiskit.circuit.ParameterExpression
|
|||
|
||||
### tan
|
||||
|
||||
<Function id="qiskit.circuit.ParameterExpression.tan" name="tan" signature="tan()">
|
||||
<Function id="qiskit.circuit.ParameterExpression.tan" name="tan" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parameterexpression.py#L361-L363" signature="tan()">
|
||||
Tangent of a ParameterExpression
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ParameterVector
|
|||
|
||||
# ParameterVector
|
||||
|
||||
<Class id="qiskit.circuit.ParameterVector" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parametervector.py" signature="qiskit.circuit.ParameterVector(name, length=0)">
|
||||
<Class id="qiskit.circuit.ParameterVector" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parametervector.py#L50-L114" signature="qiskit.circuit.ParameterVector(name, length=0)">
|
||||
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
|
||||
|
||||
ParameterVector class to quickly generate lists of parameters.
|
||||
|
|
@ -31,13 +31,13 @@ python_api_name: qiskit.circuit.ParameterVector
|
|||
|
||||
### index
|
||||
|
||||
<Function id="qiskit.circuit.ParameterVector.index" name="index" signature="index(value)">
|
||||
<Function id="qiskit.circuit.ParameterVector.index" name="index" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parametervector.py#L74-L76" signature="index(value)">
|
||||
Returns first index of value.
|
||||
</Function>
|
||||
|
||||
### resize
|
||||
|
||||
<Function id="qiskit.circuit.ParameterVector.resize" name="resize" signature="resize(length)">
|
||||
<Function id="qiskit.circuit.ParameterVector.resize" name="resize" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/parametervector.py#L99-L114" signature="resize(length)">
|
||||
Resize the parameter vector.
|
||||
|
||||
If necessary, new elements are generated. If length is smaller than before, the previous elements are cached and not re-generated if the vector is enlarged again. This is to ensure that the parameter instances do not change.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.PowerModifier
|
|||
|
||||
# PowerModifier
|
||||
|
||||
<Class id="qiskit.circuit.PowerModifier" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py" signature="qiskit.circuit.PowerModifier(power)">
|
||||
<Class id="qiskit.circuit.PowerModifier" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/annotated_operation.py#L52-L56" signature="qiskit.circuit.PowerModifier(power)">
|
||||
Bases: `Modifier`
|
||||
|
||||
Power modifier: specifies that the operation is raised to the power `power`.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
# QuantumCircuit
|
||||
|
||||
<Class id="qiskit.circuit.QuantumCircuit" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py" signature="qiskit.circuit.QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)">
|
||||
<Class id="qiskit.circuit.QuantumCircuit" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L106-L4951" signature="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)")
|
||||
|
||||
Create a new circuit.
|
||||
|
|
@ -274,13 +274,13 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### add\_bits
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.add_bits" name="add_bits" signature="add_bits(bits)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.add_bits" name="add_bits" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1512-L1533" signature="add_bits(bits)">
|
||||
Add Bits to the circuit.
|
||||
</Function>
|
||||
|
||||
### add\_calibration
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.add_calibration" name="add_calibration" signature="add_calibration(gate, qubits, schedule, params=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.add_calibration" name="add_calibration" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4806-L4854" signature="add_calibration(gate, qubits, schedule, params=None)">
|
||||
Register a low-level, custom pulse definition for the given gate.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -297,13 +297,13 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### add\_register
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.add_register" name="add_register" signature="add_register(*regs)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.add_register" name="add_register" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1441-L1510" signature="add_register(*regs)">
|
||||
Add registers.
|
||||
</Function>
|
||||
|
||||
### append
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.append" name="append" signature="append(instruction, qargs=None, cargs=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.append" name="append" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1204-L1285" signature="append(instruction, qargs=None, cargs=None)">
|
||||
Append one or more instructions to the end of the circuit, modifying the circuit in place.
|
||||
|
||||
The `qargs` and `cargs` will be expanded and broadcast according to the rules of the given [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction"), and any non-[`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit") specifiers (such as integer indices) will be resolved into the relevant instances.
|
||||
|
|
@ -331,7 +331,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### assign\_parameters
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.assign_parameters" name="assign_parameters" signature="assign_parameters(parameters: Mapping[Parameter, ParameterExpression | float] | Sequence[ParameterExpression | float], inplace: Literal[False] = False, *, flat_input: bool = False, strict: bool = True) → QuantumCircuit" extraSignatures={["assign_parameters(parameters: Mapping[Parameter, ParameterExpression | float] | Sequence[ParameterExpression | float], inplace: Literal[True] = False, *, flat_input: bool = False, strict: bool = True) → None"]}>
|
||||
<Function id="qiskit.circuit.QuantumCircuit.assign_parameters" name="assign_parameters" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2589-L2804" signature="assign_parameters(parameters: Mapping[Parameter, ParameterExpression | float] | Sequence[ParameterExpression | float], inplace: Literal[False] = False, *, flat_input: bool = False, strict: bool = True) → QuantumCircuit" extraSignatures={["assign_parameters(parameters: Mapping[Parameter, ParameterExpression | float] | Sequence[ParameterExpression | float], inplace: Literal[True] = False, *, flat_input: bool = False, strict: bool = True) → None"]}>
|
||||
Assign parameters to new parameters or values.
|
||||
|
||||
If `parameters` is passed as a dictionary, the keys should be [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances in the current circuit. The values of the dictionary can either be numeric values or new parameter objects.
|
||||
|
|
@ -405,7 +405,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### barrier
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.barrier" name="barrier" signature="barrier(*qargs, label=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.barrier" name="barrier" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2824-L2845" signature="barrier(*qargs, label=None)">
|
||||
Apply [`Barrier`](qiskit.circuit.library.Barrier "qiskit.circuit.library.Barrier"). If `qargs` is empty, applies to all qubits in the circuit.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -424,7 +424,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### break\_loop
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.break_loop" name="break_loop" signature="break_loop()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.break_loop" name="break_loop" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4750-L4775" signature="break_loop()">
|
||||
Apply [`BreakLoopOp`](qiskit.circuit.BreakLoopOp "qiskit.circuit.BreakLoopOp").
|
||||
|
||||
<Admonition title="Warning" type="caution">
|
||||
|
|
@ -446,7 +446,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cast
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cast" name="cast" signature="static cast(value, type_)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cast" name="cast" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1166-L1172" signature="static cast(value, type_)">
|
||||
Best effort to cast value to type. Otherwise, returns the value.
|
||||
|
||||
**Return type**
|
||||
|
|
@ -456,7 +456,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cbit\_argument\_conversion
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cbit_argument_conversion" name="cbit_argument_conversion" signature="cbit_argument_conversion(clbit_representation)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cbit_argument_conversion" name="cbit_argument_conversion" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1189-L1202" signature="cbit_argument_conversion(clbit_representation)">
|
||||
Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -474,7 +474,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### ccx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ccx" name="ccx" signature="ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ccx" name="ccx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3713-L3741" signature="ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)">
|
||||
Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -497,7 +497,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### ccz
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ccz" name="ccz" signature="ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ccz" name="ccz" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3907-L3937" signature="ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CCZGate`](qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -521,7 +521,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### ch
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ch" name="ch" signature="ch(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ch" name="ch" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2888-L2914" signature="ch(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -544,7 +544,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### clear
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.clear" name="clear" signature="clear()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.clear" name="clear" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2144-L2152" signature="clear()">
|
||||
Clear all instructions in self.
|
||||
|
||||
Clearing the circuits will keep the metadata and calibrations.
|
||||
|
|
@ -552,7 +552,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cls\_instances
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cls_instances" name="cls_instances" signature="classmethod cls_instances()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cls_instances" name="cls_instances" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L518-L522" signature="classmethod cls_instances()">
|
||||
Return the current number of instances of this class, useful for auto naming.
|
||||
|
||||
**Return type**
|
||||
|
|
@ -562,7 +562,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cls\_prefix
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cls_prefix" name="cls_prefix" signature="classmethod cls_prefix()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cls_prefix" name="cls_prefix" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L524-L527" signature="classmethod cls_prefix()">
|
||||
Return the prefix to use for auto naming.
|
||||
|
||||
**Return type**
|
||||
|
|
@ -572,7 +572,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### compose
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.compose" name="compose" signature="compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.compose" name="compose" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L826-L1021" signature="compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)">
|
||||
Compose circuit with `other` circuit or instruction, optionally permuting wires.
|
||||
|
||||
`other` can be narrower or of equal width to `self`.
|
||||
|
|
@ -626,7 +626,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### continue\_loop
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.continue_loop" name="continue_loop" signature="continue_loop()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.continue_loop" name="continue_loop" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4777-L4804" signature="continue_loop()">
|
||||
Apply [`ContinueLoopOp`](qiskit.circuit.ContinueLoopOp "qiskit.circuit.ContinueLoopOp").
|
||||
|
||||
<Admonition title="Warning" type="caution">
|
||||
|
|
@ -648,7 +648,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L785-L824" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Control this circuit on `num_ctrl_qubits` qubits.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -673,7 +673,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2067-L2101" signature="copy(name=None)">
|
||||
Copy the circuit.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -691,7 +691,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### copy\_empty\_like
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.copy_empty_like" name="copy_empty_like" signature="copy_empty_like(name=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.copy_empty_like" name="copy_empty_like" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2103-L2142" signature="copy_empty_like(name=None)">
|
||||
Return a copy of self with the same structure but empty.
|
||||
|
||||
**That structure includes:**
|
||||
|
|
@ -715,7 +715,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### count\_ops
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.count_ops" name="count_ops" signature="count_ops()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.count_ops" name="count_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1942-L1951" signature="count_ops()">
|
||||
Count each operation kind in the circuit.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -729,7 +729,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cp
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cp" name="cp" signature="cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cp" name="cp" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2964-L2992" signature="cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -753,7 +753,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### crx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.crx" name="crx" signature="crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.crx" name="crx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3132-L3160" signature="crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -777,7 +777,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cry
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cry" name="cry" signature="cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cry" name="cry" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3200-L3228" signature="cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -801,7 +801,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### crz
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.crz" name="crz" signature="crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.crz" name="crz" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3265-L3293" signature="crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -825,7 +825,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cs
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cs" name="cs" signature="cs(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cs" name="cs" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3378-L3406" signature="cs(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -848,7 +848,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### csdg
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.csdg" name="csdg" signature="csdg(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.csdg" name="csdg" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3408-L3436" signature="csdg(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -871,7 +871,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cswap
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cswap" name="cswap" signature="cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cswap" name="cswap" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3468-L3498" signature="cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)">
|
||||
Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -895,7 +895,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### csx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.csx" name="csx" signature="csx(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.csx" name="csx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3530-L3558" signature="csx(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -918,7 +918,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cu
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cu" name="cu" signature="cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cu" name="cu" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3614-L3650" signature="cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -945,7 +945,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cx" name="cx" signature="cx(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cx" name="cx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3668-L3695" signature="cx(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -968,7 +968,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cy
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cy" name="cy" signature="cy(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cy" name="cy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3836-L3862" signature="cy(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -991,7 +991,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### cz
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cz" name="cz" signature="cz(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.cz" name="cz" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3879-L3905" signature="cz(control_qubit, target_qubit, label=None, ctrl_state=None)">
|
||||
Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -1014,7 +1014,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### dcx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.dcx" name="dcx" signature="dcx(qubit1, qubit2)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.dcx" name="dcx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3697-L3711" signature="dcx(qubit1, qubit2)">
|
||||
Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -1035,7 +1035,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### decompose
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.decompose" name="decompose" signature="decompose(gates_to_decompose=None, reps=1)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.decompose" name="decompose" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1620-L1653" signature="decompose(gates_to_decompose=None, reps=1)">
|
||||
Call a decomposition pass on this circuit, to decompose one level (shallow decompose).
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1054,7 +1054,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### delay
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.delay" name="delay" signature="delay(duration, qarg=None, unit='dt')">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.delay" name="delay" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2847-L2871" signature="delay(duration, qarg=None, unit='dt')">
|
||||
Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is `None`, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1078,7 +1078,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### depth
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.depth" name="depth" signature="depth(filter_function=<function QuantumCircuit.<lambda>>)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.depth" name="depth" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1839-L1913" signature="depth(filter_function=<function QuantumCircuit.<lambda>>)">
|
||||
Return circuit depth (i.e., length of critical path).
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1100,7 +1100,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### draw
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.draw" name="draw" signature="draw(output=None, scale=None, filename=None, style=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)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.draw" name="draw" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1655-L1819" signature="draw(output=None, scale=None, filename=None, style=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:
|
||||
|
||||
**text**: ASCII art TextDrawing that can be printed in the console.
|
||||
|
|
@ -1198,7 +1198,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### ecr
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ecr" name="ecr" signature="ecr(qubit1, qubit2)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ecr" name="ecr" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3333-L3346" signature="ecr(qubit1, qubit2)">
|
||||
Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -1219,7 +1219,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### find\_bit
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.find_bit" name="find_bit" signature="find_bit(bit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.find_bit" name="find_bit" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1535-L1568" signature="find_bit(bit)">
|
||||
Find locations in the circuit which can be used to reference a given [`Bit`](qiskit.circuit.Bit "qiskit.circuit.Bit").
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1252,7 +1252,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### for\_loop
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.for_loop" name="for_loop" signature="for_loop(indexset: Iterable[int], loop_parameter: Parameter | None, body: None, qubits: None, clbits: None, *, label: str | None) → ForLoopContext" extraSignatures={["for_loop(indexset: Iterable[int], loop_parameter: Parameter | None, body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet"]}>
|
||||
<Function id="qiskit.circuit.QuantumCircuit.for_loop" name="for_loop" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4429-L4492" signature="for_loop(indexset: Iterable[int], loop_parameter: Parameter | None, body: None, qubits: None, clbits: None, *, label: str | None) → ForLoopContext" extraSignatures={["for_loop(indexset: Iterable[int], loop_parameter: Parameter | None, body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet"]}>
|
||||
Create a `for` loop on this circuit.
|
||||
|
||||
There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`ForLoopOp`](qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp") with the given `body`. If `body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which, when entered, provides a loop variable (unless one is given, in which case it will be reused) and will automatically build a [`ForLoopOp`](qiskit.circuit.ForLoopOp "qiskit.circuit.ForLoopOp") when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you.
|
||||
|
|
@ -1303,7 +1303,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### from\_instructions
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.from_instructions" name="from_instructions" signature="static from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.from_instructions" name="from_instructions" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L283-L334" signature="static from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)">
|
||||
Construct a circuit from an iterable of CircuitInstructions.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1326,7 +1326,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### from\_qasm\_file
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.from_qasm_file" name="from_qasm_file" signature="static from_qasm_file(path)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.from_qasm_file" name="from_qasm_file" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2404-L2427" signature="static from_qasm_file(path)">
|
||||
Read an OpenQASM 2.0 program from a file and convert to an instance of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1348,7 +1348,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### from\_qasm\_str
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.from_qasm_str" name="from_qasm_str" signature="static from_qasm_str(qasm_str)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.from_qasm_str" name="from_qasm_str" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2429-L2450" signature="static from_qasm_str(qasm_str)">
|
||||
Convert a string containing an OpenQASM 2.0 program to a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1370,7 +1370,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### get\_instructions
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.get_instructions" name="get_instructions" signature="get_instructions(name)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.get_instructions" name="get_instructions" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1966-L1975" signature="get_instructions(name)">
|
||||
Get instructions matching name.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1388,7 +1388,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### get\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.get_parameter" name="get_parameter" signature="get_parameter(name: str, default: T) → Parameter | T" extraSignatures={["get_parameter(name: str, default: ellipsis = Ellipsis) → Parameter"]}>
|
||||
<Function id="qiskit.circuit.QuantumCircuit.get_parameter" name="get_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1380-L1420" signature="get_parameter(name: str, default: T) → Parameter | T" extraSignatures={["get_parameter(name: str, default: ellipsis = Ellipsis) → Parameter"]}>
|
||||
Retrieve a compile-time parameter that is accessible in this circuit scope by name.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1434,7 +1434,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### h
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.h" name="h" signature="h(qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.h" name="h" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2873-L2886" signature="h(qubit)">
|
||||
Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -1454,13 +1454,13 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### has\_calibration\_for
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.has_calibration_for" name="has_calibration_for" signature="has_calibration_for(instruction)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.has_calibration_for" name="has_calibration_for" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L435-L454" signature="has_calibration_for(instruction)">
|
||||
Return True if the circuit has a calibration defined for the instruction context. In this case, the operation does not need to be translated to the device basis.
|
||||
</Function>
|
||||
|
||||
### has\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.has_parameter" name="has_parameter" signature="has_parameter(name_or_param, /)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.has_parameter" name="has_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1422-L1439" signature="has_parameter(name_or_param, /)">
|
||||
Check whether a parameter object exists in this circuit.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1484,7 +1484,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### has\_register
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.has_register" name="has_register" signature="has_register(register)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.has_register" name="has_register" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L538-L553" signature="has_register(register)">
|
||||
Test if this circuit has the register r.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1502,7 +1502,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### id
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.id" name="id" signature="id(qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.id" name="id" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2916-L2929" signature="id(qubit)">
|
||||
Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -1522,7 +1522,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### if\_else
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.if_else" name="if_else" signature="if_else(condition, true_body, false_body, qubits, clbits, label=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.if_else" name="if_else" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4604-L4657" signature="if_else(condition, true_body, false_body, qubits, clbits, label=None)">
|
||||
Apply [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp").
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -1566,7 +1566,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### if\_test
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.if_test" name="if_test" signature="if_test(condition: tuple[ClassicalRegister | Clbit, int], true_body: None, qubits: None, clbits: None, *, label: str | None) → IfContext" extraSignatures={["if_test(condition: tuple[ClassicalRegister | Clbit, int], true_body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None = None) → InstructionSet"]}>
|
||||
<Function id="qiskit.circuit.QuantumCircuit.if_test" name="if_test" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4516-L4602" signature="if_test(condition: tuple[ClassicalRegister | Clbit, int], true_body: None, qubits: None, clbits: None, *, label: str | None) → IfContext" extraSignatures={["if_test(condition: tuple[ClassicalRegister | Clbit, int], true_body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None = None) → InstructionSet"]}>
|
||||
Create an `if` statement on this circuit.
|
||||
|
||||
There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circuit.IfElseOp") with the given `true_body`, and there will be no branch for the `false` condition (see also the [`if_else()`](#qiskit.circuit.QuantumCircuit.if_else "qiskit.circuit.QuantumCircuit.if_else") method). However, if `true_body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which can be used to build `if` statements. The return value of the `with` statement is a chainable context manager, which can be used to create subsequent `else` blocks. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you.
|
||||
|
|
@ -1620,7 +1620,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### initialize
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.initialize" name="initialize" signature="initialize(params, qubits=None, normalize=False)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.initialize" name="initialize" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4069-L4178" signature="initialize(params, qubits=None, normalize=False)">
|
||||
Initialize qubits in a specific state.
|
||||
|
||||
Qubit initialization is done by first resetting the qubits to $|0\rangle$ followed by calling [`StatePreparation`](qiskit.circuit.library.StatePreparation "qiskit.circuit.library.StatePreparation") class to prepare the qubits in a specified state. Both these steps are included in the [`Initialize`](qiskit.circuit.library.Initialize "qiskit.circuit.library.Initialize") instruction.
|
||||
|
|
@ -1709,7 +1709,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L665-L715" signature="inverse(annotated=False)">
|
||||
Invert (take adjoint of) this circuit.
|
||||
|
||||
This is done by recursively inverting all gates.
|
||||
|
|
@ -1755,7 +1755,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### iswap
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.iswap" name="iswap" signature="iswap(qubit1, qubit2)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.iswap" name="iswap" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3453-L3466" signature="iswap(qubit1, qubit2)">
|
||||
Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -1776,7 +1776,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### mcp
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.mcp" name="mcp" signature="mcp(lam, control_qubits, target_qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.mcp" name="mcp" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2994-L3017" signature="mcp(lam, control_qubits, target_qubit)">
|
||||
Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -1798,7 +1798,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### mcrx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.mcrx" name="mcrx" signature="mcrx(theta, q_controls, q_target, use_basis_gates=False)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.mcrx" name="mcrx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/multi_control_rotation_gates.py#L202-L260" signature="mcrx(theta, q_controls, q_target, use_basis_gates=False)">
|
||||
Apply Multiple-Controlled X rotation gate
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1816,7 +1816,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### mcry
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.mcry" name="mcry" signature="mcry(theta, q_controls, q_target, q_ancillae=None, mode=None, use_basis_gates=False)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.mcry" name="mcry" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/multi_control_rotation_gates.py#L263-L337" signature="mcry(theta, q_controls, q_target, q_ancillae=None, mode=None, use_basis_gates=False)">
|
||||
Apply Multiple-Controlled Y rotation gate
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1836,7 +1836,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### mcrz
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.mcrz" name="mcrz" signature="mcrz(lam, q_controls, q_target, use_basis_gates=False)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.mcrz" name="mcrz" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/multi_control_rotation_gates.py#L340-L385" signature="mcrz(lam, q_controls, q_target, use_basis_gates=False)">
|
||||
Apply Multiple-Controlled Z rotation gate
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -1854,7 +1854,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### mcx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.mcx" name="mcx" signature="mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.mcx" name="mcx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3743-L3819" signature="mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')">
|
||||
Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate").
|
||||
|
||||
The multi-cX gate can be implemented using different techniques, which use different numbers of ancilla qubits and have varying circuit depth. These modes are:
|
||||
|
|
@ -1889,7 +1889,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### measure
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.measure" name="measure" signature="measure(qubit, cbit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.measure" name="measure" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2189-L2264" signature="measure(qubit, cbit)">
|
||||
Measure a quantum bit (`qubit`) in the Z basis into a classical bit (`cbit`).
|
||||
|
||||
When a quantum state is measured, a qubit is projected in the computational (Pauli Z) basis to either $\lvert 0 \rangle$ or $\lvert 1 \rangle$. The classical bit `cbit` indicates the result of that projection as a `0` or a `1` respectively. This operation is non-reversible.
|
||||
|
|
@ -1965,7 +1965,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### measure\_active
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.measure_active" name="measure_active" signature="measure_active(inplace=True)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.measure_active" name="measure_active" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2266-L2294" signature="measure_active(inplace=True)">
|
||||
Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured.
|
||||
|
||||
Returns a new circuit with measurements if inplace=False.
|
||||
|
|
@ -1985,7 +1985,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### measure\_all
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.measure_all" name="measure_all" signature="measure_all(inplace=True, add_bits=True)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.measure_all" name="measure_all" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2296-L2339" signature="measure_all(inplace=True, add_bits=True)">
|
||||
Adds measurement to all qubits.
|
||||
|
||||
By default, adds new classical bits in a [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") to store these measurements. If `add_bits=False`, the results of the measurements will instead be stored in the already existing classical bits, with qubit `n` being measured into classical bit `n`.
|
||||
|
|
@ -2012,7 +2012,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### ms
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ms" name="ms" signature="ms(theta, qubits)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ms" name="ms" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2931-L2946" signature="ms(theta, qubits)">
|
||||
Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2033,7 +2033,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### num\_connected\_components
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.num_connected_components" name="num_connected_components" signature="num_connected_components(unitary_only=False)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.num_connected_components" name="num_connected_components" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1977-L2048" signature="num_connected_components(unitary_only=False)">
|
||||
How many non-entangled subcircuits can the circuit be factored to.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -2051,7 +2051,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### num\_nonlocal\_gates
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.num_nonlocal_gates" name="num_nonlocal_gates" signature="num_nonlocal_gates()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.num_nonlocal_gates" name="num_nonlocal_gates" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1953-L1964" signature="num_nonlocal_gates()">
|
||||
Return number of non-local gates (i.e. involving 2+ qubits).
|
||||
|
||||
Conditional nonlocal gates are also included.
|
||||
|
|
@ -2063,7 +2063,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### num\_tensor\_factors
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.num_tensor_factors" name="num_tensor_factors" signature="num_tensor_factors()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.num_tensor_factors" name="num_tensor_factors" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2056-L2065" signature="num_tensor_factors()">
|
||||
Computes the number of tensor factors in the unitary (quantum) part of the circuit only.
|
||||
|
||||
**Notes**
|
||||
|
|
@ -2077,7 +2077,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### num\_unitary\_factors
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.num_unitary_factors" name="num_unitary_factors" signature="num_unitary_factors()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.num_unitary_factors" name="num_unitary_factors" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2050-L2054" signature="num_unitary_factors()">
|
||||
Computes the number of tensor factors in the unitary (quantum) part of the circuit only.
|
||||
|
||||
**Return type**
|
||||
|
|
@ -2087,7 +2087,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### p
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.p" name="p" signature="p(theta, qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.p" name="p" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2948-L2962" signature="p(theta, qubit)">
|
||||
Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2108,7 +2108,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### pauli
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.pauli" name="pauli" signature="pauli(pauli_string, qubits)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.pauli" name="pauli" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3939-L3955" signature="pauli(pauli_string, qubits)">
|
||||
Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate").
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -2127,7 +2127,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### power
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.power" name="power" signature="power(power, matrix_power=False)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.power" name="power" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L742-L783" signature="power(power, matrix_power=False)">
|
||||
Raise this circuit to the power of `power`.
|
||||
|
||||
If `power` is a positive integer and `matrix_power` is `False`, this implementation defaults to calling `repeat`. Otherwise, if the circuit is unitary, the matrix is computed to calculate the matrix power.
|
||||
|
|
@ -2152,7 +2152,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### prepare\_state
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.prepare_state" name="prepare_state" signature="prepare_state(state, qubits=None, label=None, normalize=False)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.prepare_state" name="prepare_state" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3957-L4067" signature="prepare_state(state, qubits=None, label=None, normalize=False)">
|
||||
Prepare qubits in a specific state.
|
||||
|
||||
This class implements a state preparing unitary. Unlike [`initialize()`](#qiskit.circuit.QuantumCircuit.initialize "qiskit.circuit.QuantumCircuit.initialize") it does not reset the qubits first.
|
||||
|
|
@ -2247,7 +2247,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### qbit\_argument\_conversion
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.qbit_argument_conversion" name="qbit_argument_conversion" signature="qbit_argument_conversion(qubit_representation)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.qbit_argument_conversion" name="qbit_argument_conversion" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1174-L1187" signature="qbit_argument_conversion(qubit_representation)">
|
||||
Converts several qubit representations (such as indexes, range, etc.) into a list of qubits.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -2265,7 +2265,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### qubit\_duration
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.qubit_duration" name="qubit_duration" signature="qubit_duration(*qubits)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.qubit_duration" name="qubit_duration" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4857-L4867" signature="qubit_duration(*qubits)">
|
||||
Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -2283,7 +2283,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### qubit\_start\_time
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.qubit_start_time" name="qubit_start_time" signature="qubit_start_time(*qubits)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.qubit_start_time" name="qubit_start_time" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4869-L4909" signature="qubit_start_time(*qubits)">
|
||||
Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`.
|
||||
|
||||
Return 0 if there are no instructions over qubits
|
||||
|
|
@ -2308,7 +2308,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### qubit\_stop\_time
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.qubit_stop_time" name="qubit_stop_time" signature="qubit_stop_time(*qubits)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.qubit_stop_time" name="qubit_stop_time" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4911-L4951" signature="qubit_stop_time(*qubits)">
|
||||
Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`.
|
||||
|
||||
Return 0 if there are no instructions over qubits
|
||||
|
|
@ -2333,7 +2333,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### r
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.r" name="r" signature="r(theta, phi, qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.r" name="r" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3019-L3036" signature="r(theta, phi, qubit)">
|
||||
Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2355,7 +2355,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### rcccx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rcccx" name="rcccx" signature="rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rcccx" name="rcccx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3087-L3111" signature="rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)">
|
||||
Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2378,7 +2378,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### rccx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rccx" name="rccx" signature="rccx(control_qubit1, control_qubit2, target_qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rccx" name="rccx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3065-L3085" signature="rccx(control_qubit1, control_qubit2, target_qubit)">
|
||||
Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2400,7 +2400,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### remove\_final\_measurements
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.remove_final_measurements" name="remove_final_measurements" signature="remove_final_measurements(inplace=True)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.remove_final_measurements" name="remove_final_measurements" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2341-L2402" signature="remove_final_measurements(inplace=True)">
|
||||
Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation.
|
||||
|
||||
Measurements and barriers are considered final if they are followed by no other operations (aside from other measurements or barriers.)
|
||||
|
|
@ -2420,7 +2420,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.repeat" name="repeat" signature="repeat(reps)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L717-L740" signature="repeat(reps)">
|
||||
Repeat this circuit `reps` times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -2438,7 +2438,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### reset
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.reset" name="reset" signature="reset(qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.reset" name="reset" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L2176-L2187" signature="reset(qubit)">
|
||||
Reset the quantum bit(s) to their default state.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -2456,7 +2456,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### reverse\_bits
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.reverse_bits" name="reverse_bits" signature="reverse_bits()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.reverse_bits" name="reverse_bits" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L597-L663" signature="reverse_bits()">
|
||||
Return a circuit with the opposite order of wires.
|
||||
|
||||
The circuit is “vertically” flipped. If a circuit is defined over multiple registers, the resulting circuit will have the same registers but with their order flipped.
|
||||
|
|
@ -2508,7 +2508,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L555-L595" signature="reverse_ops()">
|
||||
Reverse the circuit by reversing the order of instructions.
|
||||
|
||||
This is done by recursively reversing all instructions. It does not invert (adjoint) any gate.
|
||||
|
|
@ -2546,7 +2546,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### rv
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rv" name="rv" signature="rv(vx, vy, vz, qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rv" name="rv" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3038-L3063" signature="rv(vx, vy, vz, qubit)">
|
||||
Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2571,7 +2571,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### rx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rx" name="rx" signature="rx(theta, qubit, label=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rx" name="rx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3113-L3130" signature="rx(theta, qubit, label=None)">
|
||||
Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2593,7 +2593,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### rxx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rxx" name="rxx" signature="rxx(theta, qubit1, qubit2)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rxx" name="rxx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3162-L3179" signature="rxx(theta, qubit1, qubit2)">
|
||||
Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2615,7 +2615,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### ry
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ry" name="ry" signature="ry(theta, qubit, label=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ry" name="ry" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3181-L3198" signature="ry(theta, qubit, label=None)">
|
||||
Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2637,7 +2637,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### ryy
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ryy" name="ryy" signature="ryy(theta, qubit1, qubit2)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.ryy" name="ryy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3230-L3247" signature="ryy(theta, qubit1, qubit2)">
|
||||
Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2659,7 +2659,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### rz
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rz" name="rz" signature="rz(phi, qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rz" name="rz" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3249-L3263" signature="rz(phi, qubit)">
|
||||
Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2680,7 +2680,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### rzx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rzx" name="rzx" signature="rzx(theta, qubit1, qubit2)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rzx" name="rzx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3295-L3312" signature="rzx(theta, qubit1, qubit2)">
|
||||
Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2702,7 +2702,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### rzz
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rzz" name="rzz" signature="rzz(theta, qubit1, qubit2)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.rzz" name="rzz" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3314-L3331" signature="rzz(theta, qubit1, qubit2)">
|
||||
Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2724,7 +2724,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### s
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.s" name="s" signature="s(qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.s" name="s" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3348-L3361" signature="s(qubit)">
|
||||
Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2744,7 +2744,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### sdg
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.sdg" name="sdg" signature="sdg(qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.sdg" name="sdg" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3363-L3376" signature="sdg(qubit)">
|
||||
Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2764,7 +2764,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### size
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.size" name="size" signature="size(filter_function=<function QuantumCircuit.<lambda>>)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.size" name="size" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1821-L1837" signature="size(filter_function=<function QuantumCircuit.<lambda>>)">
|
||||
Returns total number of instructions in circuit.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -2782,7 +2782,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### swap
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.swap" name="swap" signature="swap(qubit1, qubit2)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.swap" name="swap" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3438-L3451" signature="swap(qubit1, qubit2)">
|
||||
Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2803,7 +2803,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### switch
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.switch" name="switch" signature="switch(target: Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int], cases: None, qubits: None, clbits: None, *, label: str | None) → SwitchContext" extraSignatures={["switch(target: Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int], cases: Iterable[Tuple[Any, QuantumCircuit]], qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet"]}>
|
||||
<Function id="qiskit.circuit.QuantumCircuit.switch" name="switch" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4681-L4748" signature="switch(target: Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int], cases: None, qubits: None, clbits: None, *, label: str | None) → SwitchContext" extraSignatures={["switch(target: Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int], cases: Iterable[Tuple[Any, QuantumCircuit]], qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet"]}>
|
||||
Create a `switch`/`case` structure on this circuit.
|
||||
|
||||
There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") with the given case structure. If `cases` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which will automatically build a [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you.
|
||||
|
|
@ -2850,7 +2850,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### sx
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.sx" name="sx" signature="sx(qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.sx" name="sx" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3500-L3513" signature="sx(qubit)">
|
||||
Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2870,7 +2870,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### sxdg
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.sxdg" name="sxdg" signature="sxdg(qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.sxdg" name="sxdg" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3515-L3528" signature="sxdg(qubit)">
|
||||
Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2890,7 +2890,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### t
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.t" name="t" signature="t(qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.t" name="t" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3560-L3573" signature="t(qubit)">
|
||||
Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2910,7 +2910,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### tdg
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.tdg" name="tdg" signature="tdg(qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.tdg" name="tdg" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3575-L3588" signature="tdg(qubit)">
|
||||
Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -2930,7 +2930,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### tensor
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.tensor" name="tensor" signature="tensor(other, inplace=False)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.tensor" name="tensor" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1023-L1111" signature="tensor(other, inplace=False)">
|
||||
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](/build/circuit-construction) for more information.
|
||||
|
|
@ -2977,7 +2977,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### to\_gate
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.to_gate" name="to_gate" signature="to_gate(parameter_map=None, label=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.to_gate" name="to_gate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1598-L1618" signature="to_gate(parameter_map=None, label=None)">
|
||||
Create a Gate out of this circuit.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -2996,7 +2996,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### to\_instruction
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.to_instruction" name="to_instruction" signature="to_instruction(parameter_map=None, label=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.to_instruction" name="to_instruction" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1576-L1596" signature="to_instruction(parameter_map=None, label=None)">
|
||||
Create an Instruction out of this circuit.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -3015,7 +3015,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### u
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.u" name="u" signature="u(theta, phi, lam, qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.u" name="u" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3590-L3612" signature="u(theta, phi, lam, qubit)">
|
||||
Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -3038,7 +3038,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### unitary
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.unitary" name="unitary" signature="unitary(obj, qubits, label=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.unitary" name="unitary" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4180-L4221" signature="unitary(obj, qubits, label=None)">
|
||||
Apply unitary gate specified by `obj` to `qubits`.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -3072,7 +3072,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### while\_loop
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.while_loop" name="while_loop" signature="while_loop(condition: tuple[ClassicalRegister | Clbit, int] | expr.Expr, body: None, qubits: None, clbits: None, *, label: str | None) → WhileLoopContext" extraSignatures={["while_loop(condition: tuple[ClassicalRegister | Clbit, int] | expr.Expr, body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet"]}>
|
||||
<Function id="qiskit.circuit.QuantumCircuit.while_loop" name="while_loop" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L4342-L4403" signature="while_loop(condition: tuple[ClassicalRegister | Clbit, int] | expr.Expr, body: None, qubits: None, clbits: None, *, label: str | None) → WhileLoopContext" extraSignatures={["while_loop(condition: tuple[ClassicalRegister | Clbit, int] | expr.Expr, body: QuantumCircuit, qubits: Sequence[Qubit | QuantumRegister | int | slice | Sequence[Qubit | int]], clbits: Sequence[Clbit | ClassicalRegister | int | slice | Sequence[Clbit | int]], *, label: str | None) → InstructionSet"]}>
|
||||
Create a `while` loop on this circuit.
|
||||
|
||||
There are two forms for calling this function. If called with all its arguments (with the possible exception of `label`), it will create a `WhileLoopOp` with the given `body`. If `body` (and `qubits` and `clbits`) are *not* passed, then this acts as a context manager, which will automatically build a `WhileLoopOp` when the scope finishes. In this form, you do not need to keep track of the qubits or clbits you are using, because the scope will handle it for you.
|
||||
|
|
@ -3113,7 +3113,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### width
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.width" name="width" signature="width()">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.width" name="width" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L1915-L1922" signature="width()">
|
||||
Return number of qubits plus clbits in circuit.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -3127,7 +3127,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### x
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.x" name="x" signature="x(qubit, label=None)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.x" name="x" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3652-L3666" signature="x(qubit, label=None)">
|
||||
Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -3148,7 +3148,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### y
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.y" name="y" signature="y(qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.y" name="y" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3821-L3834" signature="y(qubit)">
|
||||
Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
@ -3168,7 +3168,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
|
|||
|
||||
### z
|
||||
|
||||
<Function id="qiskit.circuit.QuantumCircuit.z" name="z" signature="z(qubit)">
|
||||
<Function id="qiskit.circuit.QuantumCircuit.z" name="z" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumcircuit.py#L3864-L3877" signature="z(qubit)">
|
||||
Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate").
|
||||
|
||||
For the full matrix form of this gate, see the underlying gate documentation.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.QuantumRegister
|
|||
|
||||
# QuantumRegister
|
||||
|
||||
<Class id="qiskit.circuit.QuantumRegister" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py" signature="qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)">
|
||||
<Class id="qiskit.circuit.QuantumRegister" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py#L50-L57" signature="qiskit.circuit.QuantumRegister(size=None, name=None, bits=None)">
|
||||
Bases: [`Register`](qiskit.circuit.Register "qiskit.circuit.register.Register")
|
||||
|
||||
Implement a quantum register.
|
||||
|
|
@ -57,7 +57,7 @@ python_api_name: qiskit.circuit.QuantumRegister
|
|||
|
||||
### index
|
||||
|
||||
<Function id="qiskit.circuit.QuantumRegister.index" name="index" signature="index(bit)">
|
||||
<Function id="qiskit.circuit.QuantumRegister.index" name="index" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/register.py#L183-L191" signature="index(bit)">
|
||||
Find the index of the provided bit within this register.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Qubit
|
|||
|
||||
# Qubit
|
||||
|
||||
<Class id="qiskit.circuit.Qubit" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py" signature="qiskit.circuit.Qubit(register=None, index=None)">
|
||||
<Class id="qiskit.circuit.Qubit" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/quantumregister.py#L26-L47" signature="qiskit.circuit.Qubit(register=None, index=None)">
|
||||
Bases: [`Bit`](qiskit.circuit.Bit "qiskit.circuit.bit.Bit")
|
||||
|
||||
Implement a quantum bit.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Register
|
|||
|
||||
# Register
|
||||
|
||||
<Class id="qiskit.circuit.Register" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/register.py" signature="qiskit.circuit.Register(size=None, name=None, bits=None)">
|
||||
<Class id="qiskit.circuit.Register" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/register.py#L26-L235" signature="qiskit.circuit.Register(size=None, name=None, bits=None)">
|
||||
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
|
||||
|
||||
Implement a generic register.
|
||||
|
|
@ -65,7 +65,7 @@ python_api_name: qiskit.circuit.Register
|
|||
|
||||
### index
|
||||
|
||||
<Function id="qiskit.circuit.Register.index" name="index" signature="index(bit)">
|
||||
<Function id="qiskit.circuit.Register.index" name="index" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/register.py#L183-L191" signature="index(bit)">
|
||||
Find the index of the provided bit within this register.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
# SwitchCaseOp
|
||||
|
||||
<Class id="qiskit.circuit.SwitchCaseOp" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/switch_case.py" signature="qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)">
|
||||
<Class id="qiskit.circuit.SwitchCaseOp" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/switch_case.py#L50-L196" signature="qiskit.circuit.SwitchCaseOp(target, cases, *, label=None)">
|
||||
Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp")
|
||||
|
||||
A circuit operation that executes one particular circuit block based on matching a given `target` against an ordered list of `values`. The special value [`CASE_DEFAULT`](circuit#qiskit.circuit.CASE_DEFAULT "qiskit.circuit.CASE_DEFAULT") can be used to represent a default condition.
|
||||
|
|
@ -142,19 +142,19 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L535-L564" signature="broadcast_arguments(qargs, cargs)">
|
||||
Validation of the arguments.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -173,7 +173,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/switch_case.py#L192-L196" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -183,7 +183,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### cases
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.cases" name="cases" signature="cases()">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.cases" name="cases" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/switch_case.py#L170-L180" signature="cases()">
|
||||
Return a lookup table from case labels to the circuit that would be executed in that case. This object is not generally suitable for creating a new [`SwitchCaseOp`](#qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") because any keys that point to the same object will not be grouped.
|
||||
|
||||
<Admonition title="See also" type="note">
|
||||
|
|
@ -195,7 +195,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### cases\_specifier
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.cases_specifier" name="cases_specifier" signature="cases_specifier()">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.cases_specifier" name="cases_specifier" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/switch_case.py#L156-L168" signature="cases_specifier()">
|
||||
Return an iterable where each element is a 2-tuple whose first element is a tuple of jump values, and whose second is the single circuit block that is associated with those values.
|
||||
|
||||
This is an abstract specification of the jump table suitable for creating new [`SwitchCaseOp`](#qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") instances.
|
||||
|
|
@ -213,7 +213,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -231,7 +231,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477" signature="inverse(annotated=False)">
|
||||
Invert this instruction.
|
||||
|
||||
If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.
|
||||
|
|
@ -255,13 +255,13 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -283,7 +283,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### replace\_blocks
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.replace_blocks" name="replace_blocks" signature="replace_blocks(blocks)">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.replace_blocks" name="replace_blocks" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/switch_case.py#L186-L190" signature="replace_blocks(blocks)">
|
||||
Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -297,7 +297,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -315,7 +315,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -333,7 +333,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -341,7 +341,7 @@ python_api_name: qiskit.circuit.SwitchCaseOp
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.SwitchCaseOp.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L289-L291" signature="validate_parameter(parameter)">
|
||||
Instruction parameters has no validation or normalization.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.WhileLoopOp
|
|||
|
||||
# WhileLoopOp
|
||||
|
||||
<Class id="qiskit.circuit.WhileLoopOp" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/while_loop.py" signature="qiskit.circuit.WhileLoopOp(condition, body, label=None)">
|
||||
<Class id="qiskit.circuit.WhileLoopOp" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/while_loop.py#L29-L111" signature="qiskit.circuit.WhileLoopOp(condition, body, label=None)">
|
||||
Bases: [`ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp")
|
||||
|
||||
A circuit operation which repeatedly executes a subcircuit (`body`) until a condition (`condition`) evaluates as False.
|
||||
|
|
@ -155,19 +155,19 @@ python_api_name: qiskit.circuit.WhileLoopOp
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L535-L564" signature="broadcast_arguments(qargs, cargs)">
|
||||
Validation of the arguments.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -186,7 +186,7 @@ python_api_name: qiskit.circuit.WhileLoopOp
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/while_loop.py#L107-L111" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -196,7 +196,7 @@ python_api_name: qiskit.circuit.WhileLoopOp
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -214,7 +214,7 @@ python_api_name: qiskit.circuit.WhileLoopOp
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477" signature="inverse(annotated=False)">
|
||||
Invert this instruction.
|
||||
|
||||
If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.
|
||||
|
|
@ -238,13 +238,13 @@ python_api_name: qiskit.circuit.WhileLoopOp
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -266,7 +266,7 @@ python_api_name: qiskit.circuit.WhileLoopOp
|
|||
|
||||
### replace\_blocks
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.replace_blocks" name="replace_blocks" signature="replace_blocks(blocks)">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.replace_blocks" name="replace_blocks" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/controlflow/while_loop.py#L103-L105" signature="replace_blocks(blocks)">
|
||||
Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -276,7 +276,7 @@ python_api_name: qiskit.circuit.WhileLoopOp
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -294,7 +294,7 @@ python_api_name: qiskit.circuit.WhileLoopOp
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -312,7 +312,7 @@ python_api_name: qiskit.circuit.WhileLoopOp
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -320,7 +320,7 @@ python_api_name: qiskit.circuit.WhileLoopOp
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.WhileLoopOp.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.WhileLoopOp.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L289-L291" signature="validate_parameter(parameter)">
|
||||
Instruction parameters has no validation or normalization.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
# BooleanExpression
|
||||
|
||||
<Class id="qiskit.circuit.classicalfunction.BooleanExpression" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/boolean_expression.py" signature="qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)">
|
||||
<Class id="qiskit.circuit.classicalfunction.BooleanExpression" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/boolean_expression.py#L23-L129" signature="qiskit.circuit.classicalfunction.BooleanExpression(expression, name=None, var_order=None)">
|
||||
Bases: `ClassicalElement`
|
||||
|
||||
The Boolean Expression gate.
|
||||
|
|
@ -120,19 +120,19 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L169-L226" signature="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:
|
||||
|
|
@ -185,7 +185,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L479-L497" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -195,7 +195,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L89-L126" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Return the controlled version of itself.
|
||||
|
||||
Implemented either as a controlled gate (ref. [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate")) or as an annotated operation (ref. [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation")).
|
||||
|
|
@ -218,7 +218,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### from\_dimacs\_file
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.from_dimacs_file" name="from_dimacs_file" signature="classmethod from_dimacs_file(filename)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.from_dimacs_file" name="from_dimacs_file" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/boolean_expression.py#L101-L129" signature="classmethod from_dimacs_file(filename)">
|
||||
Create a BooleanExpression from the string in the DIMACS format. :param filename: A file in DIMACS format.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -254,7 +254,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477" signature="inverse(annotated=False)">
|
||||
Invert this instruction.
|
||||
|
||||
If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.
|
||||
|
|
@ -278,13 +278,13 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### power
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.power" name="power" signature="power(exponent)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.power" name="power" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L65-L81" signature="power(exponent)">
|
||||
Creates a unitary gate as gate^exponent.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -306,7 +306,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -328,7 +328,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -346,7 +346,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### simulate
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.simulate" name="simulate" signature="simulate(bitstring)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.simulate" name="simulate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/boolean_expression.py#L50-L66" signature="simulate(bitstring)">
|
||||
Evaluate the expression on a bitstring.
|
||||
|
||||
This evaluation is done classically.
|
||||
|
|
@ -366,7 +366,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -384,7 +384,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### synth
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.synth" name="synth" signature="synth(registerless=True, synthesizer=None)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.synth" name="synth" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/boolean_expression.py#L68-L95" signature="synth(registerless=True, synthesizer=None)">
|
||||
Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -403,7 +403,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### to\_matrix
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.to_matrix" name="to_matrix" signature="to_matrix()">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.to_matrix" name="to_matrix" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L51-L63" signature="to_matrix()">
|
||||
Return a Numpy.array for the gate unitary matrix.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -421,7 +421,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -429,7 +429,7 @@ python_api_name: qiskit.circuit.classicalfunction.BooleanExpression
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.classicalfunction.BooleanExpression.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L228-L242" signature="validate_parameter(parameter)">
|
||||
Gate parameters should be int, float, or ParameterExpression
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
# ClassicalFunction
|
||||
|
||||
<Class id="qiskit.circuit.classicalfunction.ClassicalFunction" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/classicalfunction.py" signature="qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)">
|
||||
<Class id="qiskit.circuit.classicalfunction.ClassicalFunction" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/classicalfunction.py#L26-L173" signature="qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)">
|
||||
Bases: `ClassicalElement`
|
||||
|
||||
Represent a classical function and its logic network.
|
||||
|
|
@ -171,19 +171,19 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L169-L226" signature="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:
|
||||
|
|
@ -236,7 +236,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L479-L497" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -246,13 +246,13 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### compile
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.compile" name="compile" signature="compile()">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.compile" name="compile" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/classicalfunction.py#L55-L62" signature="compile()">
|
||||
Parses and creates the logical circuit
|
||||
</Function>
|
||||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L89-L126" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Return the controlled version of itself.
|
||||
|
||||
Implemented either as a controlled gate (ref. [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate")) or as an annotated operation (ref. [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation")).
|
||||
|
|
@ -275,7 +275,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -293,7 +293,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L422-L477" signature="inverse(annotated=False)">
|
||||
Invert this instruction.
|
||||
|
||||
If annotated is False, the inverse instruction is implemented as a fresh instruction with the recursively inverted definition.
|
||||
|
|
@ -317,13 +317,13 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### power
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.power" name="power" signature="power(exponent)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.power" name="power" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L65-L81" signature="power(exponent)">
|
||||
Creates a unitary gate as gate^exponent.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -345,7 +345,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -367,7 +367,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -385,7 +385,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### simulate
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.simulate" name="simulate" signature="simulate(bitstring)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.simulate" name="simulate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/classicalfunction.py#L98-L111" signature="simulate(bitstring)">
|
||||
Evaluate the expression on a bitstring.
|
||||
|
||||
This evaluation is done classically.
|
||||
|
|
@ -405,7 +405,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### simulate\_all
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.simulate_all" name="simulate_all" signature="simulate_all()">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.simulate_all" name="simulate_all" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/classicalfunction.py#L113-L125" signature="simulate_all()">
|
||||
Returns a truth table.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -419,7 +419,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -437,7 +437,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### synth
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.synth" name="synth" signature="synth(registerless=True, synthesizer=None)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.synth" name="synth" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/classicalfunction.py#L136-L161" signature="synth(registerless=True, synthesizer=None)">
|
||||
Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -458,7 +458,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### to\_matrix
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.to_matrix" name="to_matrix" signature="to_matrix()">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.to_matrix" name="to_matrix" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L51-L63" signature="to_matrix()">
|
||||
Return a Numpy.array for the gate unitary matrix.
|
||||
|
||||
**Returns**
|
||||
|
|
@ -476,7 +476,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -484,7 +484,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/gate.py#L228-L242" signature="validate_parameter(parameter)">
|
||||
Gate parameters should be int, float, or ParameterExpression
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeE
|
|||
|
||||
# qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError
|
||||
|
||||
<Class id="qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" name="ClassicalFunctionCompilerTypeError" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/exceptions.py" signature="qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)">
|
||||
<Class id="qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" name="ClassicalFunctionCompilerTypeError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/exceptions.py#L31-L35" signature="qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError(*message)">
|
||||
ClassicalFunction compiler type error. The classicalfunction function fails at type checking time.
|
||||
|
||||
Set the error message.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError
|
|||
|
||||
# qiskit.circuit.classicalfunction.ClassicalFunctionParseError
|
||||
|
||||
<Class id="qiskit.circuit.classicalfunction.ClassicalFunctionParseError" name="ClassicalFunctionParseError" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/exceptions.py" signature="qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)">
|
||||
<Class id="qiskit.circuit.classicalfunction.ClassicalFunctionParseError" name="ClassicalFunctionParseError" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/classicalfunction/exceptions.py#L24-L28" signature="qiskit.circuit.classicalfunction.ClassicalFunctionParseError(*message)">
|
||||
ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time.
|
||||
|
||||
Set the error message.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.AND
|
|||
|
||||
# AND
|
||||
|
||||
<Class id="qiskit.circuit.library.AND" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/boolean_logic/quantum_and.py" signature="qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')">
|
||||
<Class id="qiskit.circuit.library.AND" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/boolean_logic/quantum_and.py#L21-L97" signature="qiskit.circuit.library.AND(num_variable_qubits, flags=None, mcx_mode='noancilla')">
|
||||
Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||||
|
||||
A circuit implementing the logical AND operation on a number of qubits.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Barrier
|
|||
|
||||
# Barrier
|
||||
|
||||
<Class id="qiskit.circuit.library.Barrier" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/barrier.py" signature="qiskit.circuit.library.Barrier(num_qubits, label=None)">
|
||||
<Class id="qiskit.circuit.library.Barrier" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/barrier.py#L23-L51" signature="qiskit.circuit.library.Barrier(num_qubits, label=None)">
|
||||
Bases: [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction")
|
||||
|
||||
Barrier instruction.
|
||||
|
|
@ -127,19 +127,19 @@ python_api_name: qiskit.circuit.library.Barrier
|
|||
|
||||
### add\_decomposition
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.add_decomposition" name="add_decomposition" signature="add_decomposition(decomposition)">
|
||||
<Function id="qiskit.circuit.library.Barrier.add_decomposition" name="add_decomposition" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L327-L332" signature="add_decomposition(decomposition)">
|
||||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||||
</Function>
|
||||
|
||||
### assemble
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.assemble" name="assemble" signature="assemble()">
|
||||
<Function id="qiskit.circuit.library.Barrier.assemble" name="assemble" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L354-L374" signature="assemble()">
|
||||
Assemble a QasmQobjInstruction
|
||||
</Function>
|
||||
|
||||
### broadcast\_arguments
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.broadcast_arguments" name="broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||||
<Function id="qiskit.circuit.library.Barrier.broadcast_arguments" name="broadcast_arguments" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L535-L564" signature="broadcast_arguments(qargs, cargs)">
|
||||
Validation of the arguments.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -158,7 +158,7 @@ python_api_name: qiskit.circuit.library.Barrier
|
|||
|
||||
### c\_if
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.c_if" name="c_if" signature="c_if(classical, val)">
|
||||
<Function id="qiskit.circuit.library.Barrier.c_if" name="c_if" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/barrier.py#L50-L51" signature="c_if(classical, val)">
|
||||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||||
|
||||
<Admonition title="Note" type="note">
|
||||
|
|
@ -168,7 +168,7 @@ python_api_name: qiskit.circuit.library.Barrier
|
|||
|
||||
### copy
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.copy" name="copy" signature="copy(name=None)">
|
||||
<Function id="qiskit.circuit.library.Barrier.copy" name="copy" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L499-L514" signature="copy(name=None)">
|
||||
Copy of the instruction.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -186,19 +186,19 @@ python_api_name: qiskit.circuit.library.Barrier
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.Barrier.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/barrier.py#L46-L48" signature="inverse(annotated=False)">
|
||||
Special case. Return self.
|
||||
</Function>
|
||||
|
||||
### is\_parameterized
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.is_parameterized" name="is_parameterized" signature="is_parameterized()">
|
||||
<Function id="qiskit.circuit.library.Barrier.is_parameterized" name="is_parameterized" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L293-L297" signature="is_parameterized()">
|
||||
Return True .IFF. instruction is parameterized else False
|
||||
</Function>
|
||||
|
||||
### repeat
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.repeat" name="repeat" signature="repeat(n)">
|
||||
<Function id="qiskit.circuit.library.Barrier.repeat" name="repeat" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L574-L608" signature="repeat(n)">
|
||||
Creates an instruction with gate repeated n amount of times.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -220,7 +220,7 @@ python_api_name: qiskit.circuit.library.Barrier
|
|||
|
||||
### reverse\_ops
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.reverse_ops" name="reverse_ops" signature="reverse_ops()">
|
||||
<Function id="qiskit.circuit.library.Barrier.reverse_ops" name="reverse_ops" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L396-L420" signature="reverse_ops()">
|
||||
For a composite instruction, reverse the order of sub-instructions.
|
||||
|
||||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||||
|
|
@ -238,7 +238,7 @@ python_api_name: qiskit.circuit.library.Barrier
|
|||
|
||||
### soft\_compare
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.soft_compare" name="soft_compare" signature="soft_compare(other)">
|
||||
<Function id="qiskit.circuit.library.Barrier.soft_compare" name="soft_compare" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L229-L269" signature="soft_compare(other)">
|
||||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -256,7 +256,7 @@ python_api_name: qiskit.circuit.library.Barrier
|
|||
|
||||
### to\_mutable
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.to_mutable" name="to_mutable" signature="to_mutable()">
|
||||
<Function id="qiskit.circuit.library.Barrier.to_mutable" name="to_mutable" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L151-L159" signature="to_mutable()">
|
||||
Return a mutable copy of this gate.
|
||||
|
||||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||||
|
|
@ -264,7 +264,7 @@ python_api_name: qiskit.circuit.library.Barrier
|
|||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.library.Barrier.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.library.Barrier.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/instruction.py#L289-L291" signature="validate_parameter(parameter)">
|
||||
Instruction parameters has no validation or normalization.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3SXGate
|
|||
|
||||
# C3SXGate
|
||||
|
||||
<Class id="qiskit.circuit.library.C3SXGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py" signature="qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.C3SXGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L565-L668" signature="qiskit.circuit.library.C3SXGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
The 3-qubit controlled sqrt-X gate.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C3XGate
|
|||
|
||||
# C3XGate
|
||||
|
||||
<Class id="qiskit.circuit.library.C3XGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py" signature="qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.C3XGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L671-L828" signature="qiskit.circuit.library.C3XGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
The X gate controlled on 3 qubits.
|
||||
|
|
@ -154,7 +154,7 @@ python_api_name: qiskit.circuit.library.C3XGate
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.library.C3XGate.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.library.C3XGate.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L775-L811" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Controlled version of this gate.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -175,7 +175,7 @@ python_api_name: qiskit.circuit.library.C3XGate
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.C3XGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.C3XGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L813-L825" signature="inverse(annotated=False)">
|
||||
Invert this gate. The C3X is its own inverse.
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.C4XGate
|
|||
|
||||
# C4XGate
|
||||
|
||||
<Class id="qiskit.circuit.library.C4XGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py" signature="qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.C4XGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L930-L1072" signature="qiskit.circuit.library.C4XGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
The 4-qubit controlled X gate.
|
||||
|
|
@ -158,7 +158,7 @@ python_api_name: qiskit.circuit.library.C4XGate
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.library.C4XGate.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.library.C4XGate.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L1019-L1055" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Controlled version of this gate.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -179,7 +179,7 @@ python_api_name: qiskit.circuit.library.C4XGate
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.C4XGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.C4XGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L1057-L1069" signature="inverse(annotated=False)">
|
||||
Invert this gate. The C4X is its own inverse.
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCXGate
|
|||
|
||||
# CCXGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CCXGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py" signature="qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.CCXGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L296-L487" signature="qiskit.circuit.library.CCXGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
CCX gate, also known as Toffoli gate.
|
||||
|
|
@ -210,7 +210,7 @@ $$
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.library.CCXGate.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CCXGate.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L434-L470" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Controlled version of this gate.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -231,7 +231,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CCXGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CCXGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L472-L484" signature="inverse(annotated=False)">
|
||||
Return an inverted CCX gate (also a CCX).
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CCZGate
|
|||
|
||||
# CCZGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CCZGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py" signature="qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.CCZGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py#L245-L342" signature="qiskit.circuit.library.CCZGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
CCZ gate.
|
||||
|
|
@ -185,7 +185,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CCZGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CCZGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py#L327-L339" signature="inverse(annotated=False)">
|
||||
Return inverted CCZ gate (itself).
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder
|
|||
|
||||
# CDKMRippleCarryAdder
|
||||
|
||||
<Class id="qiskit.circuit.library.CDKMRippleCarryAdder" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py" signature="qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')">
|
||||
<Class id="qiskit.circuit.library.CDKMRippleCarryAdder" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py#L20-L159" signature="qiskit.circuit.library.CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')">
|
||||
Bases: `Adder`
|
||||
|
||||
A ripple-carry circuit to perform in-place addition on two qubit registers.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CHGate
|
|||
|
||||
# CHGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CHGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/h.py" signature="qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.CHGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/h.py#L127-L249" signature="qiskit.circuit.library.CHGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
Controlled-Hadamard gate.
|
||||
|
|
@ -200,7 +200,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CHGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CHGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/h.py#L244-L246" signature="inverse(annotated=False)">
|
||||
Return inverted CH gate (itself).
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CPhaseGate
|
|||
|
||||
# CPhaseGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CPhaseGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/p.py" signature="qiskit.circuit.library.CPhaseGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)">
|
||||
<Class id="qiskit.circuit.library.CPhaseGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/p.py#L159-L300" signature="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")
|
||||
|
||||
Controlled-Phase gate.
|
||||
|
|
@ -181,7 +181,7 @@ $$
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.library.CPhaseGate.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CPhaseGate.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/p.py#L247-L277" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Controlled version of this gate.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -202,13 +202,13 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CPhaseGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CPhaseGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/p.py#L279-L281" signature="inverse(annotated=False)">
|
||||
Return inverted CPhase gate ($CPhase(\lambda)^{\dagger} = CPhase(-\lambda)$)
|
||||
</Function>
|
||||
|
||||
### power
|
||||
|
||||
<Function id="qiskit.circuit.library.CPhaseGate.power" name="power" signature="power(exponent)">
|
||||
<Function id="qiskit.circuit.library.CPhaseGate.power" name="power" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/p.py#L292-L295" signature="power(exponent)">
|
||||
Raise gate to a power.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRXGate
|
|||
|
||||
# CRXGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CRXGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rx.py" signature="qiskit.circuit.library.CRXGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)">
|
||||
<Class id="qiskit.circuit.library.CRXGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rx.py#L140-L284" signature="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")
|
||||
|
||||
Controlled-RX gate.
|
||||
|
|
@ -202,7 +202,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CRXGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CRXGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rx.py#L253-L265" signature="inverse(annotated=False)">
|
||||
Return inverse CRX gate (i.e. with the negative rotation angle).
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRYGate
|
|||
|
||||
# CRYGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CRYGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ry.py" signature="qiskit.circuit.library.CRYGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)">
|
||||
<Class id="qiskit.circuit.library.CRYGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ry.py#L139-L279" signature="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")
|
||||
|
||||
Controlled-RY gate.
|
||||
|
|
@ -202,7 +202,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CRYGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CRYGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ry.py#L248-L260" signature="inverse(annotated=False)">
|
||||
Return inverse CRY gate (i.e. with the negative rotation angle)
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CRZGate
|
|||
|
||||
# CRZGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CRZGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rz.py" signature="qiskit.circuit.library.CRZGate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)">
|
||||
<Class id="qiskit.circuit.library.CRZGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rz.py#L151-L299" signature="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")
|
||||
|
||||
Controlled-RZ gate.
|
||||
|
|
@ -204,7 +204,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CRZGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CRZGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/rz.py#L266-L278" signature="inverse(annotated=False)">
|
||||
Return inverse CRZ gate (i.e. with the negative rotation angle).
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSGate
|
|||
|
||||
# CSGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CSGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py" signature="qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.CSGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py#L185-L269" signature="qiskit.circuit.library.CSGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
Controlled-S gate.
|
||||
|
|
@ -176,7 +176,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CSGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CSGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py#L248-L260" signature="inverse(annotated=False)">
|
||||
Return inverse of CSGate (CSdgGate).
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -194,7 +194,7 @@ $$
|
|||
|
||||
### power
|
||||
|
||||
<Function id="qiskit.circuit.library.CSGate.power" name="power" signature="power(exponent)">
|
||||
<Function id="qiskit.circuit.library.CSGate.power" name="power" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py#L262-L266" signature="power(exponent)">
|
||||
Raise gate to a power.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSXGate
|
|||
|
||||
# CSXGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CSXGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/sx.py" signature="qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.CSXGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/sx.py#L207-L305" signature="qiskit.circuit.library.CSXGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
Controlled-√X gate.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSdgGate
|
|||
|
||||
# CSdgGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CSdgGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py" signature="qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.CSdgGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py#L272-L355" signature="qiskit.circuit.library.CSdgGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
Controlled-S^dagger gate.
|
||||
|
|
@ -176,7 +176,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CSdgGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CSdgGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py#L334-L346" signature="inverse(annotated=False)">
|
||||
Return inverse of CSdgGate (CSGate).
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -194,7 +194,7 @@ $$
|
|||
|
||||
### power
|
||||
|
||||
<Function id="qiskit.circuit.library.CSdgGate.power" name="power" signature="power(exponent)">
|
||||
<Function id="qiskit.circuit.library.CSdgGate.power" name="power" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/s.py#L348-L352" signature="power(exponent)">
|
||||
Raise gate to a power.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CSwapGate
|
|||
|
||||
# CSwapGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CSwapGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/swap.py" signature="qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.CSwapGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/swap.py#L138-L281" signature="qiskit.circuit.library.CSwapGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
Controlled-SWAP gate, also known as the Fredkin gate.
|
||||
|
|
@ -219,7 +219,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CSwapGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CSwapGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/swap.py#L266-L278" signature="inverse(annotated=False)">
|
||||
Return inverse CSwap gate (itself).
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU1Gate
|
|||
|
||||
# CU1Gate
|
||||
|
||||
<Class id="qiskit.circuit.library.CU1Gate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u1.py" signature="qiskit.circuit.library.CU1Gate(theta, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)">
|
||||
<Class id="qiskit.circuit.library.CU1Gate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u1.py#L169-L317" signature="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")
|
||||
|
||||
Controlled-U1 gate.
|
||||
|
|
@ -179,7 +179,7 @@ $$
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.library.CU1Gate.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CU1Gate.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u1.py#L260-L290" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Controlled version of this gate.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -200,7 +200,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CU1Gate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CU1Gate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u1.py#L292-L305" signature="inverse(annotated=False)">
|
||||
Return inverted CU1 gate ($CU1(\lambda)^{\dagger} = CU1(-\lambda))$
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CU3Gate
|
|||
|
||||
# CU3Gate
|
||||
|
||||
<Class id="qiskit.circuit.library.CU3Gate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u3.py" signature="qiskit.circuit.library.CU3Gate(theta, phi, lam, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)">
|
||||
<Class id="qiskit.circuit.library.CU3Gate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u3.py#L167-L333" signature="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")
|
||||
|
||||
Controlled-U3 gate (3-parameter two-qubit gate).
|
||||
|
|
@ -204,7 +204,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CU3Gate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CU3Gate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u3.py#L289-L306" signature="inverse(annotated=False)">
|
||||
Return inverted CU3 gate.
|
||||
|
||||
$CU3(\theta,\phi,\lambda)^{\dagger} =CU3(-\theta,-\phi,-\lambda))$
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CUGate
|
|||
|
||||
# CUGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CUGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u.py" signature="qiskit.circuit.library.CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None, *, duration=None, unit='dt', _base_label=None)">
|
||||
<Class id="qiskit.circuit.library.CUGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u.py#L194-L375" signature="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")
|
||||
|
||||
Controlled-U gate (4-parameter two-qubit gate).
|
||||
|
|
@ -194,7 +194,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CUGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CUGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/u.py#L316-L337" signature="inverse(annotated=False)">
|
||||
Return inverted CU gate.
|
||||
|
||||
$CU(\theta,\phi,\lambda,\gamma)^{\dagger} = CU(-\theta,-\phi,-\lambda,-\gamma))$
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CXGate
|
|||
|
||||
# CXGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CXGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py" signature="qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.CXGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L151-L293" signature="qiskit.circuit.library.CXGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
Controlled-X gate.
|
||||
|
|
@ -206,7 +206,7 @@ $$
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.library.CXGate.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CXGate.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L240-L276" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Return a controlled-X gate with more control lines.
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -227,7 +227,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CXGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CXGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/x.py#L278-L290" signature="inverse(annotated=False)">
|
||||
Return inverted CX gate (itself).
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CYGate
|
|||
|
||||
# CYGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CYGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/y.py" signature="qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.CYGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/y.py#L143-L256" signature="qiskit.circuit.library.CYGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
Controlled-Y gate.
|
||||
|
|
@ -198,7 +198,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CYGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CYGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/y.py#L241-L253" signature="inverse(annotated=False)">
|
||||
Return inverted CY gate (itself).
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.CZGate
|
|||
|
||||
# CZGate
|
||||
|
||||
<Class id="qiskit.circuit.library.CZGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py" signature="qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.CZGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py#L151-L242" signature="qiskit.circuit.library.CZGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonControlledGate`](circuit_singleton#qiskit.circuit.singleton.SingletonControlledGate "qiskit.circuit.singleton.SingletonControlledGate")
|
||||
|
||||
Controlled-Z gate.
|
||||
|
|
@ -179,7 +179,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.CZGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.CZGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/z.py#L227-L239" signature="inverse(annotated=False)">
|
||||
Return inverted CZ gate (itself).
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DCXGate
|
|||
|
||||
# DCXGate
|
||||
|
||||
<Class id="qiskit.circuit.library.DCXGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/dcx.py" signature="qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.DCXGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/dcx.py#L20-L74" signature="qiskit.circuit.library.DCXGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate")
|
||||
|
||||
Double-CNOT gate.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.Diagonal
|
|||
|
||||
# Diagonal
|
||||
|
||||
<Class id="qiskit.circuit.library.Diagonal" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/diagonal.py" signature="qiskit.circuit.library.Diagonal(diag)">
|
||||
<Class id="qiskit.circuit.library.Diagonal" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/diagonal.py#L31-L125" signature="qiskit.circuit.library.Diagonal(diag)">
|
||||
Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||||
|
||||
Diagonal circuit.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DiagonalGate
|
|||
|
||||
# DiagonalGate
|
||||
|
||||
<Class id="qiskit.circuit.library.DiagonalGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/diagonal.py" signature="qiskit.circuit.library.DiagonalGate(diag)">
|
||||
<Class id="qiskit.circuit.library.DiagonalGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/diagonal.py#L128-L154" signature="qiskit.circuit.library.DiagonalGate(diag)">
|
||||
Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")
|
||||
|
||||
Gate implementing a diagonal transformation.
|
||||
|
|
@ -118,13 +118,13 @@ python_api_name: qiskit.circuit.library.DiagonalGate
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.DiagonalGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.DiagonalGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/diagonal.py#L152-L154" signature="inverse(annotated=False)">
|
||||
Return the inverse of the diagonal gate.
|
||||
</Function>
|
||||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.library.DiagonalGate.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.library.DiagonalGate.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/diagonal.py#L144-L150" signature="validate_parameter(parameter)">
|
||||
Diagonal Gate parameter should accept complex (in addition to the Gate parameter types) and always return build-in complex.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.DraperQFTAdder
|
|||
|
||||
# DraperQFTAdder
|
||||
|
||||
<Class id="qiskit.circuit.library.DraperQFTAdder" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py" signature="qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')">
|
||||
<Class id="qiskit.circuit.library.DraperQFTAdder" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py#L24-L116" signature="qiskit.circuit.library.DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')">
|
||||
Bases: `Adder`
|
||||
|
||||
A circuit that uses QFT to perform in-place addition on two qubit registers.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ECRGate
|
|||
|
||||
# ECRGate
|
||||
|
||||
<Class id="qiskit.circuit.library.ECRGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ecr.py" signature="qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.ECRGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ecr.py#L24-L127" signature="qiskit.circuit.library.ECRGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate")
|
||||
|
||||
An echoed cross-resonance gate.
|
||||
|
|
@ -164,7 +164,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.ECRGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.ECRGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/ecr.py#L112-L124" signature="inverse(annotated=False)">
|
||||
Return inverse ECR gate (itself).
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EfficientSU2
|
|||
|
||||
# EfficientSU2
|
||||
|
||||
<Class id="qiskit.circuit.library.EfficientSU2" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/efficient_su2.py" signature="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)">
|
||||
<Class id="qiskit.circuit.library.EfficientSU2" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/efficient_su2.py#L29-L164" signature="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")
|
||||
|
||||
The hardware efficient SU(2) 2-local circuit.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz
|
|||
|
||||
# EvolvedOperatorAnsatz
|
||||
|
||||
<Class id="qiskit.circuit.library.EvolvedOperatorAnsatz" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/evolved_operator_ansatz.py" signature="qiskit.circuit.library.EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None, flatten=None)">
|
||||
<Class id="qiskit.circuit.library.EvolvedOperatorAnsatz" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/evolved_operator_ansatz.py#L30-L223" signature="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")
|
||||
|
||||
The evolved operator ansatz.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExactReciprocal
|
|||
|
||||
# ExactReciprocal
|
||||
|
||||
<Class id="qiskit.circuit.library.ExactReciprocal" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/exact_reciprocal.py" signature="qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')">
|
||||
<Class id="qiskit.circuit.library.ExactReciprocal" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/exact_reciprocal.py#L20-L88" signature="qiskit.circuit.library.ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')">
|
||||
Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||||
|
||||
Exact reciprocal
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.ExcitationPreserving
|
|||
|
||||
# ExcitationPreserving
|
||||
|
||||
<Class id="qiskit.circuit.library.ExcitationPreserving" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/excitation_preserving.py" signature="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)">
|
||||
<Class id="qiskit.circuit.library.ExcitationPreserving" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/n_local/excitation_preserving.py#L24-L173" signature="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")
|
||||
|
||||
The heuristic excitation-preserving wave function ansatz.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FourierChecking
|
|||
|
||||
# FourierChecking
|
||||
|
||||
<Class id="qiskit.circuit.library.FourierChecking" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/fourier_checking.py" signature="qiskit.circuit.library.FourierChecking(f, g)">
|
||||
<Class id="qiskit.circuit.library.FourierChecking" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/fourier_checking.py#L24-L97" signature="qiskit.circuit.library.FourierChecking(f, g)">
|
||||
Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||||
|
||||
Fourier checking circuit.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.FunctionalPauliRotations
|
|||
|
||||
# FunctionalPauliRotations
|
||||
|
||||
<Class id="qiskit.circuit.library.FunctionalPauliRotations" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py" signature="qiskit.circuit.library.FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')">
|
||||
<Class id="qiskit.circuit.library.FunctionalPauliRotations" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py#L22-L114" signature="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)")
|
||||
|
||||
Base class for functional Pauli rotations.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GMS
|
|||
|
||||
# GMS
|
||||
|
||||
<Class id="qiskit.circuit.library.GMS" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gms.py" signature="qiskit.circuit.library.GMS(num_qubits, theta)">
|
||||
<Class id="qiskit.circuit.library.GMS" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gms.py#L27-L93" signature="qiskit.circuit.library.GMS(num_qubits, theta)">
|
||||
Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||||
|
||||
Global Mølmer–Sørensen gate.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GR
|
|||
|
||||
# GR
|
||||
|
||||
<Class id="qiskit.circuit.library.GR" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py" signature="qiskit.circuit.library.GR(num_qubits, theta, phi)">
|
||||
<Class id="qiskit.circuit.library.GR" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py#L19-L70" signature="qiskit.circuit.library.GR(num_qubits, theta, phi)">
|
||||
Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||||
|
||||
Global R gate.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRX
|
|||
|
||||
# GRX
|
||||
|
||||
<Class id="qiskit.circuit.library.GRX" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py" signature="qiskit.circuit.library.GRX(num_qubits, theta)">
|
||||
<Class id="qiskit.circuit.library.GRX" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py#L73-L118" signature="qiskit.circuit.library.GRX(num_qubits, theta)">
|
||||
Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR")
|
||||
|
||||
Global RX gate.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRY
|
|||
|
||||
# GRY
|
||||
|
||||
<Class id="qiskit.circuit.library.GRY" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py" signature="qiskit.circuit.library.GRY(num_qubits, theta)">
|
||||
<Class id="qiskit.circuit.library.GRY" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py#L121-L166" signature="qiskit.circuit.library.GRY(num_qubits, theta)">
|
||||
Bases: [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR")
|
||||
|
||||
Global RY gate.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GRZ
|
|||
|
||||
# GRZ
|
||||
|
||||
<Class id="qiskit.circuit.library.GRZ" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py" signature="qiskit.circuit.library.GRZ(num_qubits, phi)">
|
||||
<Class id="qiskit.circuit.library.GRZ" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/generalized_gates/gr.py#L169-L215" signature="qiskit.circuit.library.GRZ(num_qubits, phi)">
|
||||
Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||||
|
||||
Global RZ gate.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GlobalPhaseGate
|
|||
|
||||
# GlobalPhaseGate
|
||||
|
||||
<Class id="qiskit.circuit.library.GlobalPhaseGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/global_phase.py" signature="qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')">
|
||||
<Class id="qiskit.circuit.library.GlobalPhaseGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/global_phase.py#L25-L80" signature="qiskit.circuit.library.GlobalPhaseGate(phase, label=None, *, duration=None, unit='dt')">
|
||||
Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")
|
||||
|
||||
The global phase gate ($e^{i\theta}$).
|
||||
|
|
@ -132,7 +132,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.GlobalPhaseGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.GlobalPhaseGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/global_phase.py#L55-L70" signature="inverse(annotated=False)">
|
||||
Return inverse GlobalPhaseGate gate.
|
||||
|
||||
$\text{GlobalPhaseGate}(\lambda)^{\dagger} = \text{GlobalPhaseGate}(-\lambda)$
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GraphState
|
|||
|
||||
# GraphState
|
||||
|
||||
<Class id="qiskit.circuit.library.GraphState" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/graph_state.py" signature="qiskit.circuit.library.GraphState(adjacency_matrix)">
|
||||
<Class id="qiskit.circuit.library.GraphState" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/graph_state.py#L22-L86" signature="qiskit.circuit.library.GraphState(adjacency_matrix)">
|
||||
Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||||
|
||||
Circuit to prepare a graph state.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.GroverOperator
|
|||
|
||||
# GroverOperator
|
||||
|
||||
<Class id="qiskit.circuit.library.GroverOperator" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/grover_operator.py" signature="qiskit.circuit.library.GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')">
|
||||
<Class id="qiskit.circuit.library.GroverOperator" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/grover_operator.py#L25-L285" signature="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")
|
||||
|
||||
The Grover operator.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HGate
|
|||
|
||||
# HGate
|
||||
|
||||
<Class id="qiskit.circuit.library.HGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/h.py" signature="qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.HGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/h.py#L24-L124" signature="qiskit.circuit.library.HGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate")
|
||||
|
||||
Single-qubit Hadamard gate.
|
||||
|
|
@ -138,7 +138,7 @@ $$
|
|||
|
||||
### control
|
||||
|
||||
<Function id="qiskit.circuit.library.HGate.control" name="control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
<Function id="qiskit.circuit.library.HGate.control" name="control" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/h.py#L76-L107" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None, annotated=False)">
|
||||
Return a (multi-)controlled-H gate.
|
||||
|
||||
One control qubit returns a CH gate.
|
||||
|
|
@ -161,7 +161,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.HGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.HGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/h.py#L109-L121" signature="inverse(annotated=False)">
|
||||
Return inverted H gate (itself).
|
||||
|
||||
**Parameters**
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier
|
|||
|
||||
# HRSCumulativeMultiplier
|
||||
|
||||
<Class id="qiskit.circuit.library.HRSCumulativeMultiplier" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py" signature="qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')">
|
||||
<Class id="qiskit.circuit.library.HRSCumulativeMultiplier" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py#L21-L138" signature="qiskit.circuit.library.HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')">
|
||||
Bases: `Multiplier`
|
||||
|
||||
A multiplication circuit to store product of two input registers out-of-place.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HamiltonianGate
|
|||
|
||||
# HamiltonianGate
|
||||
|
||||
<Class id="qiskit.circuit.library.HamiltonianGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hamiltonian_gate.py" signature="qiskit.circuit.library.HamiltonianGate(data, time, label=None)">
|
||||
<Class id="qiskit.circuit.library.HamiltonianGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hamiltonian_gate.py#L37-L137" signature="qiskit.circuit.library.HamiltonianGate(data, time, label=None)">
|
||||
Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")
|
||||
|
||||
Class for representing evolution by a Hamiltonian operator as a gate.
|
||||
|
|
@ -126,31 +126,31 @@ python_api_name: qiskit.circuit.library.HamiltonianGate
|
|||
|
||||
### adjoint
|
||||
|
||||
<Function id="qiskit.circuit.library.HamiltonianGate.adjoint" name="adjoint" signature="adjoint()">
|
||||
<Function id="qiskit.circuit.library.HamiltonianGate.adjoint" name="adjoint" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hamiltonian_gate.py#L115-L117" signature="adjoint()">
|
||||
Return the adjoint of the unitary.
|
||||
</Function>
|
||||
|
||||
### conjugate
|
||||
|
||||
<Function id="qiskit.circuit.library.HamiltonianGate.conjugate" name="conjugate" signature="conjugate()">
|
||||
<Function id="qiskit.circuit.library.HamiltonianGate.conjugate" name="conjugate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hamiltonian_gate.py#L111-L113" signature="conjugate()">
|
||||
Return the conjugate of the Hamiltonian.
|
||||
</Function>
|
||||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.HamiltonianGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.HamiltonianGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hamiltonian_gate.py#L107-L109" signature="inverse(annotated=False)">
|
||||
Return the adjoint of the unitary.
|
||||
</Function>
|
||||
|
||||
### transpose
|
||||
|
||||
<Function id="qiskit.circuit.library.HamiltonianGate.transpose" name="transpose" signature="transpose()">
|
||||
<Function id="qiskit.circuit.library.HamiltonianGate.transpose" name="transpose" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hamiltonian_gate.py#L119-L121" signature="transpose()">
|
||||
Return the transpose of the Hamiltonian.
|
||||
</Function>
|
||||
|
||||
### validate\_parameter
|
||||
|
||||
<Function id="qiskit.circuit.library.HamiltonianGate.validate_parameter" name="validate_parameter" signature="validate_parameter(parameter)">
|
||||
<Function id="qiskit.circuit.library.HamiltonianGate.validate_parameter" name="validate_parameter" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hamiltonian_gate.py#L130-L137" signature="validate_parameter(parameter)">
|
||||
Hamiltonian parameter has to be an ndarray, operator or float.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.HiddenLinearFunction
|
|||
|
||||
# HiddenLinearFunction
|
||||
|
||||
<Class id="qiskit.circuit.library.HiddenLinearFunction" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hidden_linear_function.py" signature="qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)">
|
||||
<Class id="qiskit.circuit.library.HiddenLinearFunction" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/hidden_linear_function.py#L22-L98" signature="qiskit.circuit.library.HiddenLinearFunction(adjacency_matrix)">
|
||||
Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||||
|
||||
Circuit to solve the hidden linear function problem.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IGate
|
|||
|
||||
# IGate
|
||||
|
||||
<Class id="qiskit.circuit.library.IGate" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/i.py" signature="qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)">
|
||||
<Class id="qiskit.circuit.library.IGate" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/i.py#L20-L73" signature="qiskit.circuit.library.IGate(*args, _force_mutable=False, **kwargs)">
|
||||
Bases: [`SingletonGate`](circuit_singleton#qiskit.circuit.singleton.SingletonGate "qiskit.circuit.singleton.SingletonGate")
|
||||
|
||||
Identity gate.
|
||||
|
|
@ -137,7 +137,7 @@ $$
|
|||
|
||||
### inverse
|
||||
|
||||
<Function id="qiskit.circuit.library.IGate.inverse" name="inverse" signature="inverse(annotated=False)">
|
||||
<Function id="qiskit.circuit.library.IGate.inverse" name="inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/i.py#L54-L66" signature="inverse(annotated=False)">
|
||||
Returne the inverse gate (itself).
|
||||
|
||||
**Parameters**
|
||||
|
|
@ -157,7 +157,7 @@ $$
|
|||
|
||||
### power
|
||||
|
||||
<Function id="qiskit.circuit.library.IGate.power" name="power" signature="power(exponent)">
|
||||
<Function id="qiskit.circuit.library.IGate.power" name="power" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/standard_gates/i.py#L68-L70" signature="power(exponent)">
|
||||
Raise gate to a power.
|
||||
</Function>
|
||||
</Class>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.library.IQP
|
|||
|
||||
# IQP
|
||||
|
||||
<Class id="qiskit.circuit.library.IQP" github="https://github.com/qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/iqp.py" signature="qiskit.circuit.library.IQP(interactions)">
|
||||
<Class id="qiskit.circuit.library.IQP" github="https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/circuit/library/iqp.py#L22-L96" signature="qiskit.circuit.library.IQP(interactions)">
|
||||
Bases: [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")
|
||||
|
||||
Instantaneous quantum polynomial (IQP) circuit.
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue