# UnitaryOverlap

class qiskit.circuit.library.UnitaryOverlap(unitary1, unitary2, prefix1='p1', prefix2='p2')

GitHub(opens in a new tab)

Bases: QuantumCircuit

Circuit that returns the overlap between two unitaries $U_2^{\dag} U_1$.

The input quantum circuits must represent unitary operations, since they must be invertible. If the inputs will have parameters, they are replaced by ParameterVectors with names “p1” (for circuit unitary1) and “p2” (for circuit unitary_2) in the output circuit.

This circuit is usually employed in computing the fidelity:

$\left|\langle 0| U_2^{\dag} U_1|0\rangle\right|^{2}$

by computing the probability of being in the all-zeros bit-string, or equivalently, the expectation value of projector $|0\rangle\langle 0|$.

Example:

import numpy as np
from qiskit.circuit.library import EfficientSU2, UnitaryOverlap
from qiskit.primitives import Sampler

# get two circuit to prepare states of which we comput the overlap
circuit = EfficientSU2(2, reps=1)
unitary1 = circuit.assign_parameters(np.random.random(circuit.num_parameters))
unitary2 = circuit.assign_parameters(np.random.random(circuit.num_parameters))

# create the overlap circuit
overlap = UnitaryOverap(unitary1, unitary2)

# sample from the overlap
sampler = Sampler(options={"shots": 100})
result = sampler.run(overlap).result()

# the fidelity is the probability to measure 0
fidelity = result.quasi_dists[0].get(0, 0)

Parameters

• unitary1 (QuantumCircuit) – Unitary acting on the ket vector.
• unitary2 (QuantumCircuit) – Unitary whose inverse operates on the bra vector.
• prefix1 – The name of the parameter vector associated to unitary1, if it is parameterized. Defaults to "p1".
• prefix2 – The name of the parameter vector associated to unitary2, if it is parameterized. Defaults to "p2".

Raises

• CircuitError – Number of qubits in unitary1 and unitary2 does not match.
• CircuitError – Inputs contain measurements and/or resets.

## Attributes

### ancillas

A list of AncillaQubits 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}}

### clbits

A list of Clbits 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 CircuitInstructions for each instruction.

Return type

QuantumCircuitData

### global_phase

The global phase of the current circuit scope in radians.

### instances

Default value: 186

### 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 SwapGates inserted during routing.

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_parameters

The number of parameter objects in the circuit.

### num_qubits

Return 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(opens in a new tab) – When circuit is not scheduled.

### 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.

### prefix

Default value: 'circuit'

### qubits

A list of Qubits in the order that they were added. You should not mutate this.

### name

Type: str

A human-readable name for the circuit.

### qregs

Type: list[QuantumRegister]

A list of the QuantumRegisters in this circuit. You should not mutate this.

### cregs

Type: list[ClassicalRegister]

A list of the ClassicalRegisters in this circuit. You should not mutate this.

### duration

Type: int | float | None

The total duration of the circuit, set by a scheduling transpiler pass. Its unit is specified by unit.

### unit

The unit that duration is specified in.