z i SrSSKJrJr SSKJr SSKJr SSKJr SSK J r "SS\5r S r SS \S \S \ S \ S\S\4 Sjjrg)zUnitary overlap circuit.)QuantumCircuitGate)ParameterVector) CircuitError)Barrier)deprecate_funcc d^\rSrSrSr\"SSSS9SS\S\S \S \S \4 U4S jjj5r S r U=r $)UnitaryOverlapaXCircuit that returns the overlap between two unitaries :math:`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 :class:`.ParameterVector`\s 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: .. math:: \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 :math:`|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 compute 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 = UnitaryOverlap(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) z2.1z3Use qiskit.circuit.library.unitary_overlap instead.z in Qiskit 3.0)sinceadditional_msgremoval_timelineunitary1unitary2prefix1prefix2insert_barrierc>[XX4U5n[TU]"URSUR06 UR X`R SS9 g)a\ Args: unitary1: Unitary acting on the ket vector. unitary2: 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"``. insert_barrier: Whether to insert a barrier between the two unitaries. Raises: CircuitError: Number of qubits in ``unitary1`` and ``unitary2`` does not match. CircuitError: Inputs contain measurements and/or resets. nameT)qubitsinplaceN)unitary_overlapsuper__init__qregsrcomposer)selfrrrrrcircuit __class__s X/home/james-whalen/.local/lib/python3.13/site-packages/qiskit/circuit/library/overlap.pyrUnitaryOverlap.__init__>sA6"(gW '--;gll; W[[$ ?p1p2F) __name__ __module__ __qualname____firstlineno____doc__rrstrboolr__static_attributes__ __classcell__)rs@r r r sm%NL($ @ @!@ @  @  @  @r"r cURHKn[UR[[45(aM*[ SURR S35e g)zNCheck a circuit is unitary by checking if all operations are of type ``Gate``.z9One or more instructions cannot be converted to a gate. "z" is not a gate instructionN)data isinstance operationrrrr)r instructions r _check_unitaryr5^sV|| +//$AA(227788SU $r"rrrrrreturnc$URUR:wa&[SURSURS35eX/nUHn[U5 M [X#/5HFupxXWRS:dM[ XUR5n XWR U 5XW'MH [USRSS9n U RUSSS9 U(aU R5 U RUS R5SS9 U $) a*Circuit that returns the overlap between two unitaries :math:`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 :class:`.ParameterVector`\s 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: .. math:: \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 :math:`|0\rangle\langle 0|`. Reference Circuit: .. plot:: :alt: Circuit diagram output by the previous code. :include-source: import numpy as np from qiskit.circuit.library import efficient_su2, unitary_overlap # get two circuit to prepare states of which we compute the overlap circuit = efficient_su2(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 = unitary_overlap(unitary1, unitary2) overlap.draw('mpl') Args: unitary1: Unitary acting on the ket vector. unitary2: 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"``. insert_barrier: Whether to insert a barrier between the two unitaries. Raises: CircuitError: Number of qubits in ``unitary1`` and ``unitary2`` does not match. CircuitError: Inputs contain measurements and/or resets. z.Number of qubits in unitaries does not match: z != .rr )rT)r) num_qubitsrr5 enumeratenum_parametersrassign_parametersrrbarrierinverse) rrrrr unitariesunitaryiprefix new_paramsrs r rrisnh111"--.d83F3F2Gq J  $Iw 12  < & & *(11L1LMJ$<99*EIL3 Yq\44;KLG OOIaL$O/ OOIaL((*DO9 Nr"Nr$)r+qiskit.circuitrrqiskit.circuit.parametervectorrqiskit.circuit.exceptionsrrqiskit.utils.deprecationrr r5r,r-rr#r"r rIs~/:2"3E@^E@P NNNN N  N  Nr"