EvolvedOperatorAnsatz
class 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
The evolved operator ansatz.
Parameters
- operators (BaseOperator | QuantumCircuit |list | None) – The operators to evolve. If a circuit is passed, we assume it implements an already evolved operator and thus the circuit is not evolved again. Can be a single operator (circuit) or a list of operators (and circuits).
- reps (int) – The number of times to repeat the evolved operators.
- evolution (EvolutionBase | EvolutionSynthesis | None) – A specification of which evolution synthesis to use for the
PauliEvolutionGate
. Defaults to first order Trotterization. - insert_barriers (bool) – Whether to insert barriers in between each evolution.
- name (str) – The name of the circuit.
- parameter_prefix (str | Sequence[str]) – Set the names of the circuit parameters. If a string, the same prefix will be used for each parameters. Can also be a list to specify a prefix per operator.
- initial_state (QuantumCircuit | None) – A
QuantumCircuit
object to prepend to the circuit. - flatten (bool | None) – Set this to
True
to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its strongly recommended to set this flag toTrue
to avoid a large performance overhead for parameter binding.
Attributes
ancillas
A list of AncillaQubit
s in the order that they were added. You should not mutate this.
calibrations
Return calibration dictionary.
The custom pulse definition of a given gate is of the form {'gate_name': {(qubits, params): schedule}}
The property qiskit.circuit.quantumcircuit.QuantumCircuit.calibrations
is deprecated as of Qiskit 1.3. It will be removed in Qiskit 2.0. The entire Qiskit Pulse package is being deprecated and will be moved to the Qiskit Dynamics repository: https://github.com/qiskit-community/qiskit-dynamics. Note that once removed, qiskit.circuit.quantumcircuit.QuantumCircuit.calibrations
will have no alternative in Qiskit.
clbits
A list of Clbit
s in the order that they were added. You should not mutate this.
data
The circuit data (instructions and context).
Returns
a list-like object containing the CircuitInstruction
s for each instruction.
Return type
QuantumCircuitData
duration
The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by unit
.
The property qiskit.circuit.quantumcircuit.QuantumCircuit.duration
is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0.
entanglement
Get the entanglement strategy.
Returns
The entanglement strategy, see get_entangler_map()
for more detail on how the format is interpreted.
entanglement_blocks
The blocks in the entanglement layers.
Returns
The blocks in the entanglement layers.
evolution
The evolution converter used to compute the evolution.
Returns
The evolution converter used to compute the evolution.
Return type
flatten
Returns whether the circuit is wrapped in nested gates/instructions or flattened.
global_phase
The global phase of the current circuit scope in radians.
initial_state
Return the initial state that is added in front of the n-local circuit.
Returns
The initial state.
insert_barriers
If barriers are inserted in between the layers or not.
Returns
True
, if barriers are inserted in between the layers, False
if not.
instances
Default value: 157
layout
Return any associated layout information about the circuit
This attribute contains an optional TranspileLayout
object. This is typically set on the output from transpile()
or PassManager.run()
to retain information about the permutations caused on the input circuit by transpilation.
There are two types of permutations caused by the transpile()
function, an initial layout which permutes the qubits based on the selected physical qubits on the Target
, and a final layout which is an output permutation caused by SwapGate
s inserted during routing.
metadata
Arbitrary user-defined metadata for the circuit.
Qiskit will not examine the content of this mapping, but it will pass it through the transpiler and reattach it to the output, so you can track your own metadata.
num_ancillas
Return the number of ancilla qubits.
num_captured_vars
The number of real-time classical variables in the circuit marked as captured from an enclosing scope.
This is the length of the iter_captured_vars()
iterable. If this is non-zero, num_input_vars
must be zero.
num_clbits
Return number of classical bits.
num_declared_vars
The number of real-time classical variables in the circuit that are declared by this circuit scope, excluding inputs or captures.
This is the length of the iter_declared_vars()
iterable.
num_input_vars
The number of real-time classical variables in the circuit marked as circuit inputs.
This is the length of the iter_input_vars()
iterable. If this is non-zero, num_captured_vars
must be zero.
num_layers
Return the number of layers in the n-local circuit.
Returns
The number of layers in the circuit.
num_parameters
The number of parameter objects in the circuit.
num_parameters_settable
The number of total parameters that can be set to distinct values.
This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from num_parameters
which counts the number of unique Parameter
objects currently in the circuit.
Returns
The number of parameters originally available in the circuit.
This quantity does not require the circuit to be built yet.
num_qubits
Returns the number of qubits in this circuit.
Returns
The number of qubits.
num_vars
The number of real-time classical variables in the circuit.
This is the length of the iter_vars()
iterable.
op_start_times
Return a list of operation start times.
This attribute is enabled once one of scheduling analysis passes runs on the quantum circuit.
Returns
List of integers representing instruction start times. The index corresponds to the index of instruction in QuantumCircuit.data
.
Raises
AttributeError – When circuit is not scheduled.
operators
The operators that are evolved in this circuit.
Returns
The operators to be evolved (and circuits) contained in this ansatz.
Return type
ordered_parameters
The parameters used in the underlying circuit.
This includes float values and duplicates.
Examples
>>> # prepare circuit ...
>>> print(nlocal)
┌───────┐┌──────────┐┌──────────┐┌──────────┐
q_0: ┤ Ry(1) ├┤ Ry(θ[1]) ├┤ Ry(θ[1]) ├┤ Ry(θ[3]) ├
└───────┘└──────────┘└──────────┘└──────────┘
>>> nlocal.parameters
{Parameter(θ[1]), Parameter(θ[3])}
>>> nlocal.ordered_parameters
[1, Parameter(θ[1]), Parameter(θ[1]), Parameter(θ[3])]
Returns
The parameters objects used in the circuit.
parameter_bounds
The parameter bounds for the unbound parameters in the circuit.
Returns
A list of pairs indicating the bounds, as (lower, upper). None indicates an unbounded parameter in the corresponding direction. If None
is returned, problem is fully unbounded.
parameters
The parameters defined in the circuit.
This attribute returns the Parameter
objects in the circuit sorted alphabetically. Note that parameters instantiated with a ParameterVector
are still sorted numerically.
Examples
The snippet below shows that insertion order of parameters does not matter.
>>> from qiskit.circuit import QuantumCircuit, Parameter
>>> a, b, elephant = Parameter("a"), Parameter("b"), Parameter("elephant")
>>> circuit = QuantumCircuit(1)
>>> circuit.rx(b, 0)
>>> circuit.rz(elephant, 0)
>>> circuit.ry(a, 0)
>>> circuit.parameters # sorted alphabetically!
ParameterView([Parameter(a), Parameter(b), Parameter(elephant)])
Bear in mind that alphabetical sorting might be unintuitive when it comes to numbers. The literal “10” comes before “2” in strict alphabetical sorting.
>>> from qiskit.circuit import QuantumCircuit, Parameter
>>> angles = [Parameter("angle_1"), Parameter("angle_2"), Parameter("angle_10")]
>>> circuit = QuantumCircuit(1)
>>> circuit.u(*angles, 0)
>>> circuit.draw()
┌─────────────────────────────┐
q: ┤ U(angle_1,angle_2,angle_10) ├
└─────────────────────────────┘
>>> circuit.parameters
ParameterView([Parameter(angle_1), Parameter(angle_10), Parameter(angle_2)])
To respect numerical sorting, a ParameterVector
can be used.
>>> from qiskit.circuit import QuantumCircuit, Parameter, ParameterVector
>>> x = ParameterVector("x", 12)
>>> circuit = QuantumCircuit(1)
>>> for x_i in x:
... circuit.rx(x_i, 0)
>>> circuit.parameters
ParameterView([
ParameterVectorElement(x[0]), ParameterVectorElement(x[1]),
ParameterVectorElement(x[2]), ParameterVectorElement(x[3]),
..., ParameterVectorElement(x[11])
])
Returns
The sorted Parameter
objects in the circuit.
preferred_init_points
Getter of preferred initial points based on the given initial state.
prefix
Default value: 'circuit'
qregs
Type: list[QuantumRegister]
A list of the QuantumRegister
s in this circuit. You should not mutate this.
qubits
A list of Qubit
s in the order that they were added. You should not mutate this.
reps
The number of times rotation and entanglement block are repeated.
Returns
The number of repetitions.
rotation_blocks
The blocks in the rotation layers.
Returns
The blocks in the rotation layers.
unit
The unit that duration
is specified in.
The property qiskit.circuit.quantumcircuit.QuantumCircuit.unit
is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0.
name
Type: str
A human-readable name for the circuit.
cregs
Type: list[ClassicalRegister]
A list of the ClassicalRegister
s in this circuit. You should not mutate this.