--- title: ExcitationPreserving (v1.4) description: API reference for qiskit.circuit.library.ExcitationPreserving in qiskit v1.4 source: https://quantum.cloud.ibm.com/docs/en/api/qiskit/1.4/qiskit.circuit.library.ExcitationPreserving --- # ExcitationPreserving *class* `qiskit.circuit.library.ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving', flatten=None)` [GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.4/qiskit/circuit/library/n_local/excitation_preserving.py#L143-L303) Bases: [`TwoLocal`](/docs/api/qiskit/1.4/qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") The heuristic excitation-preserving wave function ansatz. The `ExcitationPreserving` circuit preserves the ratio of $|00\rangle$, $|01\rangle + |10\rangle$ and $|11\rangle$ states. To this end, this circuit uses two-qubit interactions of the form $$ \newcommand{\rotationangle}{\theta/2} \begin{pmatrix} 1 & 0 & 0 & 0 \\ 0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) & 0 \\ 0 & -i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) & 0 \\ 0 & 0 & 0 & e^{-i\phi} \end{pmatrix} $$ for the mode `'fsim'` or with $e^{-i\phi} = 1$ for the mode `'iswap'`. Note that other wave functions, such as UCC-ansatzes, are also excitation preserving. However these can become complex quickly, while this heuristically motivated circuit follows a simpler pattern. This trial wave function consists of layers of $Z$ rotations with 2-qubit entanglements. The entangling is creating using $XX+YY$ rotations and optionally a controlled-phase gate for the mode `'fsim'`. See [`RealAmplitudes`](/docs/api/qiskit/1.4/qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes") for more detail on the possible arguments and options such as skipping unentanglement qubits, which apply here too. The rotations of the ExcitationPreserving ansatz can be written as **Examples** ```python >>> ansatz = ExcitationPreserving(3, reps=1, insert_barriers=True, entanglement='linear') >>> print(ansatz.decompose()) # show the circuit ┌──────────┐ ░ ┌────────────┐┌────────────┐ ░ ┌──────────┐ q_0: ┤ RZ(θ[0]) ├─░─┤0 ├┤0 ├─────────────────────────────░─┤ RZ(θ[5]) ├ ├──────────┤ ░ │ RXX(θ[3]) ││ RYY(θ[3]) │┌────────────┐┌────────────┐ ░ ├──────────┤ q_1: ┤ RZ(θ[1]) ├─░─┤1 ├┤1 ├┤0 ├┤0 ├─░─┤ RZ(θ[6]) ├ ├──────────┤ ░ └────────────┘└────────────┘│ RXX(θ[4]) ││ RYY(θ[4]) │ ░ ├──────────┤ q_2: ┤ RZ(θ[2]) ├─░─────────────────────────────┤1 ├┤1 ├─░─┤ RZ(θ[7]) ├ └──────────┘ ░ └────────────┘└────────────┘ ░ └──────────┘ ``` ```python >>> ansatz = ExcitationPreserving(2, reps=1, flatten=True) >>> qc = QuantumCircuit(2) # create a circuit and append the RY variational form >>> qc.cry(0.2, 0, 1) # do some previous operation >>> qc.compose(ansatz, inplace=True) # add the excitation-preserving >>> qc.draw() ┌──────────┐┌────────────┐┌────────────┐┌──────────┐ q_0: ─────■─────┤ RZ(θ[0]) ├┤0 ├┤0 ├┤ RZ(θ[3]) ├ ┌────┴────┐├──────────┤│ RXX(θ[2]) ││ RYY(θ[2]) │├──────────┤ q_1: ┤ RY(0.2) ├┤ RZ(θ[1]) ├┤1 ├┤1 ├┤ RZ(θ[4]) ├ └─────────┘└──────────┘└────────────┘└────────────┘└──────────┘ ``` ```python >>> ansatz = ExcitationPreserving(3, reps=1, mode='fsim', entanglement=[[0,2]], ... insert_barriers=True, flatten=True) >>> print(ansatz.decompose()) ┌──────────┐ ░ ┌────────────┐┌────────────┐ ░ ┌──────────┐ q_0: ┤ RZ(θ[0]) ├─░─┤0 ├┤0 ├─■──────░─┤ RZ(θ[5]) ├ ├──────────┤ ░ │ ││ │ │ ░ ├──────────┤ q_1: ┤ RZ(θ[1]) ├─░─┤ RXX(θ[3]) ├┤ RYY(θ[3]) ├─┼──────░─┤ RZ(θ[6]) ├ ├──────────┤ ░ │ ││ │ │θ[4] ░ ├──────────┤ q_2: ┤ RZ(θ[2]) ├─░─┤1 ├┤1 ├─■──────░─┤ RZ(θ[7]) ├ └──────────┘ ░ └────────────┘└────────────┘ ░ └──────────┘ ``` > **See also** > > The `excitation_preserving()` function constructs a functionally equivalent circuit, but faster. > **Deprecated since version 1.3\_pending** > > The class `qiskit.circuit.library.n_local.excitation_preserving.ExcitationPreserving` is pending deprecation as of qiskit 1.3. It will be marked deprecated in a future release, and then removed no earlier than 3 months after the release date. Use the function qiskit.circuit.library.excitation\_preserving instead. **Parameters** - **num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int) *| None*) – The number of qubits of the ExcitationPreserving circuit. - **mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – Choose the entangler mode, can be ‘iswap’ or ‘fsim’. - **reps** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. - **entanglement** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]] | Callable\[\[*[*int*](https://docs.python.org/3/library/functions.html#int)*],* [*list*](https://docs.python.org/3/library/stdtypes.html#list)*\[*[*int*](https://docs.python.org/3/library/functions.html#int)*]]*) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. See the Examples section of [`TwoLocal`](/docs/api/qiskit/1.4/qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. - **initial\_state** ([*QuantumCircuit*](/docs/api/qiskit/1.4/qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *| None*) – A QuantumCircuit object to prepend to the circuit. - **skip\_unentangled\_qubits** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. - **skip\_final\_rotation\_layer** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If True, a rotation layer is added at the end of the ansatz. If False, no rotation layer is added. Defaults to True. - **parameter\_prefix** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](/docs/api/qiskit/1.4/qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). - **insert\_barriers** ([*bool*](https://docs.python.org/3/library/functions.html#bool)) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. - **flatten** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – Set this to `True` to output a flat circuit instead of nesting it inside multiple layers of gate objects. By default currently the contents of the output circuit will be wrapped in nested objects for cleaner visualization. However, if you’re using this circuit for anything besides visualization its **strongly** recommended to set this flag to `True` to avoid a large performance overhead for parameter binding. - **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str)) – **Raises** [**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError) – If the selected mode is not supported. ## 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}}` > **Deprecated since version 1.3** > > 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 has been deprecated. 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`](/docs/api/qiskit/1.4/qiskit.circuit.CircuitInstruction "qiskit.circuit.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`](#qiskit.circuit.library.ExcitationPreserving.unit "qiskit.circuit.library.ExcitationPreserving.unit"). > **Deprecated since version 1.3.0** > > 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. ### 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`](/docs/api/qiskit/1.4/qiskit.transpiler.TranspileLayout "qiskit.transpiler.TranspileLayout") object. This is typically set on the output from [`transpile()`](/docs/api/qiskit/1.4/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") or [`PassManager.run()`](/docs/api/qiskit/1.4/qiskit.transpiler.PassManager#run "qiskit.transpiler.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()`](/docs/api/qiskit/1.4/compiler#qiskit.compiler.transpile "qiskit.compiler.transpile") function, an initial layout which permutes the qubits based on the selected physical qubits on the [`Target`](/docs/api/qiskit/1.4/qiskit.transpiler.Target "qiskit.transpiler.Target"), and a final layout which is an output permutation caused by [`SwapGate`](/docs/api/qiskit/1.4/qiskit.circuit.library.SwapGate "qiskit.circuit.library.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`](#qiskit.circuit.library.ExcitationPreserving.num_input_vars "qiskit.circuit.library.ExcitationPreserving.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`](#qiskit.circuit.library.ExcitationPreserving.num_captured_vars "qiskit.circuit.library.ExcitationPreserving.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`](/docs/api/qiskit/1.4/qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. **Returns** The number of parameters originally available in the circuit. > **Note** > > 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**](https://docs.python.org/3/library/exceptions.html#AttributeError) – When circuit is not scheduled. ### ordered\_parameters The parameters used in the underlying circuit. This includes float values and duplicates. **Examples** ```python >>> # 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 Return the parameter bounds. **Returns** The parameter bounds. ### parameters The parameters defined in the circuit. This attribute returns the [`Parameter`](/docs/api/qiskit/1.4/qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit sorted alphabetically. Note that parameters instantiated with a [`ParameterVector`](/docs/api/qiskit/1.4/qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") are still sorted numerically. **Examples** The snippet below shows that insertion order of parameters does not matter. ```python >>> 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. ```python >>> 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`](/docs/api/qiskit/1.4/qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector") can be used. ```python >>> 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`](/docs/api/qiskit/1.4/qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. ### preferred\_init\_points The initial points for the parameters. Can be stored as initial guess in optimization. **Returns** The initial values for the parameters, or None, if none have been set. ### 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`](#qiskit.circuit.library.ExcitationPreserving.duration "qiskit.circuit.library.ExcitationPreserving.duration") is specified in. > **Deprecated since version 1.3.0** > > 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.