gndZddlmZddlmZddlmZddlmZddl m Z m Z ddl m Z ddlmZGd d ZeGd d Zd S)z A two-ways dict to represent a layout. Layout is the relation between virtual (qu)bits and physical (qu)bits. Virtual (qu)bits are tuples, e.g. `(QuantumRegister(3, 'qr'), 2)` or simply `qr[2]`. Physical (qu)bits are integers. ) annotations)List) dataclass)circuit)QubitQuantumRegister) LayoutError isinstanceintceZdZdZdZd%dZdZdZedZ dZ d Z d Z d Z d Zd ZdZdZd%dZdZdZdZdZdZdZd&dZedZedZedZd'd Zd(d#Zd)d$ZdS)*Layoutz$Two-ways dict to represent a Layout.)_regs_p2v_v2pNcg|_i|_i|_|;t|tst d||dSdS)zaconstruct a Layout from a bijective dictionary, mapping virtual qubits to physical qubitsNzLayout constructor takes a dict)rrr isinstancedictr from_dict)self input_dicts N/granary/edev/quantum/lib/python3.11/site-packages/qiskit/transpiler/layout.py__init__zLayout.__init__#sa    !j$// E!"CDDD NN: & & & & & " !cg}|jD] \}}||d|d!|r|ddd|d<dd|zdzS)zRepresentation of a Layoutz: ,Nz Layout({  z }))ritemsappendjoin)rstr_listkeyvals r__repr__zLayout.__repr__.s )) . .HC OOs,,c,,, - - - -  -#B<,HRLdii111F::rc|D]:\}}t||\}}||j|<|0||j|<;dS)aPopulates a Layout from a dictionary. The dictionary must be a bijective mapping between virtual qubits (tuple) and physical qubits (int). Args: input_dict (dict): e.g.:: {(QuantumRegister(3, 'qr'), 0): 0, (QuantumRegister(3, 'qr'), 1): 1, (QuantumRegister(3, 'qr'), 2): 2} Can be written more concisely as follows: * virtual to physical:: {qr[0]: 0, qr[1]: 1, qr[2]: 2} * physical to virtual:: {0: qr[0], 1: qr[1], 2: qr[2]} N)rr order_based_on_typerr)rrr"valuevirtualphysicals rrzLayout.from_dict7sj8%**,, * *JC & : :3 F F GX")DIh !)DIg    * *rc~t|r6t|ttdfrt |}|}nut|r6t|ttdfrt |}|}n0t dt|dt|d||fS)zTdecides which one is physical/virtual based on the type. Returns (virtual, physical)Nz The map (z -> z7) has to be a (Bit -> integer) or the other way around.)r rrtypeintr )value1value2r)r(s rr&zLayout.order_based_on_typeZs  ZT 8K%L%L 6{{HGG 6 " " z&5$t**:M'N'N 6{{HGG,DLL,,d6ll,,,   rc||jvr |j|S||jvr |j|Std|d)Nz The item z does not exist in the Layout)rrKeyErrorritems r __getitem__zLayout.__getitem__jsN 49  9T? " 49  9T? "F4FFFGGGrc&||jvp||jvSN)rrr1s r __contains__zLayout.__contains__qsty 5DDI$55rcnt||\}}|||dSr5)r r&_set_type_checked_item)rr"r'r(r)s r __setitem__zLayout.__setitem__ts8"66sEBB ##GX66666rc|j|d}|j|d|j|d}|j|d||j|<| ||j|<dSdSr5)rpopr)rr(r)olds rr8zLayout._set_type_checked_itemxsimmGT** c4   immHd++ c4   % (  !)DIg     rc t|tr|j|j|=|j|=dSt|tr|j|j|=|j|=dSt dt |d)Nz>The key to remove should be of the form Qubit or integer) and z was provided)rr,rrrr r+)rr"s r __delitem__zLayout.__delitem__s c3    $)C.) # U # #  $)C.) #C*.s))CCC rc*t|jSr5)lenrrs r__len__zLayout.__len__s49~~rcpt|tr |j|jko|j|jkSdS)NF)rr rr)rothers r__eq__z Layout.__eq__s7 eV $ $ G9 *FtyEJ/F Furct|}|j|_|j|_|j|_|S)z$Returns a copy of a Layout instance.)r+rcopyrr)r layout_copys rrGz Layout.copysU d4jjll  JOO-- 9>>++ 9>>++ rc|St|jdkrd}n8t|j}t|D]}||jvr|}n|dz}|||<dS)aC Adds a map element between `bit` and `physical_bit`. If `physical_bit` is not defined, `bit` will be mapped to a new physical bit. Args: virtual_bit (tuple): A (qu)bit. For example, (QuantumRegister(3, 'qr'), 2). physical_bit (int): A physical bit. For example, 3. Nr)r@rmaxrange)r virtual_bit physical_bit max_physicalphysical_candidates raddz Layout.adds  49~~"" "49~~ */ *=*=44&)::'9 ; $0!#3L([rcv|j||D]}||vr||dS)zAdds at the end physical_qubits that map each bit in reg. Args: reg (Register): A (qu)bit Register. For example, QuantumRegister(3, 'qr'). N)rrrQ)rregbits r add_registerzLayout.add_registersL #  C$   rc*t|jS)z Returns the registers in the layout [QuantumRegister(2, 'qr0'), QuantumRegister(3, 'qr1')] Returns: Set: A set of Registers in the layout )setrrAs r get_registerszLayout.get_registerss 4:rc|jS)zz Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. )rrAs rget_virtual_bitszLayout.get_virtual_bits yrc|jS)zz Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. )rrAs rget_physical_bitszLayout.get_physical_bitsr[rct|t|urtd||}||||<|||<dS)aSwaps the map between left and right. Args: left (tuple or int): Item to swap with right. right (tuple or int): Item to swap with left. Raises: LayoutError: If left and right have not the same type. z:The method swap only works with elements of the same type.N)r+r )rleftrighttemps rswapz Layout.swapsM ::T%[[ ( (Z[[ [Dz%[T U rci}|jD](\}}||jvrtd||||<)|S)aCombines self and another_layout into an "edge map". For example:: self another_layout resulting edge map qr_1 -> 0 0 <- q_2 qr_1 -> q_2 qr_2 -> 2 2 <- q_1 qr_2 -> q_1 qr_3 -> 3 3 <- q_0 qr_3 -> q_0 The edge map is used to compose dags via, for example, compose. Args: another_layout (Layout): The other layout to combine. Returns: dict: A "edge map". Raises: LayoutError: another_layout can be bigger than self, but not smaller. Otherwise, raises. zfThe wire_map_from_layouts() method does not support when the other layout (another_layout) is smaller.)rrrr )ranother_layoutedge_mapr(r)s rcombine_into_edge_mapzLayout.combine_into_edge_mapsh(!%!2!2 9 9 GX~222!A!/x 8HW  rreturn list[int]cpdgt|z}t|D]\}}||}|||<|S)aGiven an ordered list of bits, reorder them according to this layout. The list of bits must exactly match the virtual bits in this layout. Args: bits (list[Bit]): the bits to reorder. Returns: List: ordered bits. r)r@ enumerate)rbitsorderivjs r reorder_bitszLayout.reorder_bits sIc$iidOO  DAqQAE!HH rct}|D]B}t|tr||-||C|S)aCreates a trivial ("one-to-one") Layout with the registers and qubits in `regs`. Args: *regs (Registers, Qubits): registers and qubits to include in the layout. Returns: Layout: A layout with all the `regs` in the given order. )r rrrUrQ)regslayoutrSs rgenerate_trivial_layoutzLayout.generate_trivial_layouts[  C#// ##C(((( 3 rc jtd|Dstdt|tt|krtdt d|D}t||kr&tdt|d|d|dt }d }|D]D}t |jD]}|||||<|d z }||E|t|kr||d D]}d ||<|S) aConverts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). Args: int_list (list): A list of integers. *qregs (QuantumRegisters): The quantum registers to apply the layout to. Returns: Layout: The corresponding Layout object. Raises: LayoutError: Invalid input layout. c34K|]}t|VdSr5r ).0rms r z&Layout.from_intlist..>s*66=##666666rzExpected a list of ints4Duplicate values not permitted; Layout is bijective.c3$K|] }|jV dSr5)size)rwrSs rrxz&Layout.from_intlist..Bs$33c333333rzInteger list length (z*) must equal number of qubits in circuit (z): .rrJN) allr r@rWsumr rLr{rU)int_listqregs num_qubitsoutmain_idxqregidxint_items r from_intlistzLayout.from_intlist/sz66X66666 9788 8 x==CH .. . .TUU U33U33333 x==J & &:H ::)::.6::: hh # #DTY''  !)(!3DIA    T " " " " s8}} $ $$XYY/ % % $H  rct}t|D]I\}}|t|tr||jvrt d|||<;t d|D]}|||S)a Populates a Layout from a list containing virtual qubits, Qubit or None. Args: qubit_list (list): e.g.: [qr[0], None, qr[2], qr[3]] *qregs (QuantumRegisters): The quantum registers to apply the layout to. Returns: Layout: the corresponding Layout object Raises: LayoutError: If the elements are not Qubit or None Nryz9The list should contain elements of the Bits or NoneTypes)r rjrrrr rU) qubit_listrrr)r(rs rfrom_qubit_listzLayout.from_qubit_listUs hh!*:!6!6 _ _ Hg'5)) _ch&&%&\]]]'G !"]^^^ # #D   T " " " " rrDqubits List[Qubit]c|tfd|jDS)a#Compose this layout with another layout. If this layout represents a mapping from the P-qubits to the positions of the Q-qubits, and the other layout represents a mapping from the Q-qubits to the positions of the R-qubits, then the composed layout represents a mapping from the P-qubits to the positions of the R-qubits. Args: other: The existing :class:`.Layout` to compose this :class:`.Layout` with. qubits: A list of :class:`.Qubit` objects over which ``other`` is defined, used to establish the correspondence between the positions of the ``other`` qubits and the actual qubits. Returns: A new layout object the represents this layout composed with the ``other`` layout. c4i|]\}}||Sr)rwvirtphys other_v2prs r z"Layout.compose..s(YYYttYvd|4YYYr)rZr rr)rrDrrs `@rcomposezLayout.composessI"**,, YYYYYtyGXGXYYYZZZr source_qubits target_qubitscdt|Dtfd|jDS)aMFinds the inverse of this layout. This is possible when the layout is a bijective mapping, however the input and the output qubits may be different (in particular, this layout may be the mapping from the extended-with-ancillas virtual qubits to physical qubits). Thus, if this layout represents a mapping from the P-qubits to the positions of the Q-qubits, the inverse layout represents a mapping from the Q-qubits to the positions of the P-qubits. Args: source_qubits: A list of :class:`.Qubit` objects representing the domain of the layout. target_qubits: A list of :class:`.Qubit` objects representing the image of the layout. Returns: A new layout object the represents the inverse of this layout. ci|]\}}|| Srr)rwpqs rrz"Layout.inverse..s#N#N#NTQAq#N#N#Nrc4i|]\}}||Srr)rwrpos_physsource_qubit_to_positionrs rrz"Layout.inverse..s:   "D(h')A$)G   r)rjr rr)rrrrs `@rinversezLayout.inversesl&$O#NY}5M5M#N#N#N      &*ioo&7&7      rczdgt|z}t|D]\}}|j|}|||<|S)a:Creates a permutation corresponding to this layout. This is possible when the layout is a bijective mapping with the same source and target qubits (for instance, a "final_layout" corresponds to a permutation of the physical circuit qubits). If this layout is a mapping from qubits to their new positions, the resulting permutation describes which qubits occupy the positions 0, 1, 2, etc. after applying the permutation. For example, suppose that the list of qubits is ``[qr_0, qr_1, qr_2]``, and the layout maps ``qr_0`` to ``2``, ``qr_1`` to ``0``, and ``qr_2`` to ``1``. In terms of positions in ``qubits``, this maps ``0`` to ``2``, ``1`` to ``0`` and ``2`` to ``1``, with the corresponding permutation being ``[1, 2, 0]``. N)r@rjr)rrpermrmrposs rto_permutationzLayout.to_permutationsL"vF #f%%  DAq)A,CDII rr5)rgrh)rDr rrrgr )rrrr)rr) __name__ __module__ __qualname____doc__ __slots__rr$r staticmethodr&r3r6r9r8r>rBrErGrQrUrXrZr]rbrfrprtrrrrrrrrr r s..)I ' ' ' ';;;!*!*!*F ! !\ !HHH666777***    ))))2      @(\ ##\#J\:[[[[(    6rr ceZdZUdZded<ded<dZded<dZd ed <dZd ed <dddZdddZ ddZ dddZ dddZ dS)TranspileLayoutaLayout attributes for the output circuit from transpiler. The :mod:`~qiskit.transpiler` is unitary-preserving up to the "initial layout" and "final layout" permutations. The initial layout permutation is caused by setting and applying the initial layout during the :ref:`transpiler-preset-stage-layout`. The final layout permutation is caused by :class:`~.SwapGate` insertion during the :ref:`transpiler-preset-stage-routing`. This class provides an interface to reason about these permutations using a variety of helper methods. During the layout stage, the transpiler can potentially remap the order of the qubits in the circuit as it fits the circuit to the target backend. For example, let the input circuit be: .. plot:: :alt: Circuit diagram output by the previous code. :include-source: from qiskit.circuit import QuantumCircuit, QuantumRegister qr = QuantumRegister(3, name="MyReg") qc = QuantumCircuit(qr) qc.h(0) qc.cx(0, 1) qc.cx(0, 2) qc.draw("mpl") Suppose that during the layout stage the transpiler reorders the qubits to be: .. plot:: :alt: Circuit diagram output by the previous code. :include-source: from qiskit import QuantumCircuit qc = QuantumCircuit(3) qc.h(2) qc.cx(2, 1) qc.cx(2, 0) qc.draw("mpl") Then the output of the :meth:`.initial_virtual_layout` method is equivalent to:: Layout({ qr[0]: 2, qr[1]: 1, qr[2]: 0, }) (it is also this attribute in the :meth:`.QuantumCircuit.draw` and :func:`.circuit_drawer` which is used to display the mapping of qubits to positions in circuit visualizations post-transpilation). Building on the above example, suppose that during the routing stage the transpiler needs to insert swap gates, and the output circuit becomes: .. plot:: :alt: Circuit diagram output by the previous code. :include-source: from qiskit import QuantumCircuit qc = QuantumCircuit(3) qc.h(2) qc.cx(2, 1) qc.swap(0, 1) qc.cx(2, 1) qc.draw("mpl") Then the output of the :meth:`routing_permutation` method is:: [1, 0, 2] which maps positions of qubits before routing to their final positions after routing. There are three public attributes associated with the class, however these are mostly provided for backwards compatibility and represent the internal state from the transpiler. They are defined as: * :attr:`initial_layout` - This attribute is used to model the permutation caused by the :ref:`transpiler-preset-stage-layout`. It is a :class:`~.Layout` object that maps the input :class:`~.QuantumCircuit`\s :class:`~.circuit.Qubit` objects to the position in the output :class:`.QuantumCircuit.qubits` list. * :attr:`input_qubit_mapping` - This attribute is used to retain input ordering of the original :class:`~.QuantumCircuit` object. It maps the virtual :class:`~.circuit.Qubit` object from the original circuit (and :attr:`initial_layout`) to its corresponding position in :attr:`.QuantumCircuit.qubits` in the original circuit. This is needed when computing the permutation of the :class:`Operator` of the circuit (and used by :meth:`.Operator.from_circuit`). * :attr:`final_layout` - This attribute is used to model the permutation caused by the :ref:`transpiler-preset-stage-routing`. It is a :class:`~.Layout` object that maps the output circuit's qubits from :class:`.QuantumCircuit.qubits` in the output circuit to their final positions after routing. Importantly, this only represents the permutation caused by inserting :class:`~.SwapGate`\s into the :class:`~.QuantumCircuit` during the :ref:`transpiler-preset-stage-routing`. It is **not** a mapping from the original input circuit's position to the final position at the end of the transpiled circuit. If you need this, you can use the :meth:`.final_index_layout` to generate this. If :attr:`final_layout` is set to ``None``, this indicates that routing was not run, and can be considered equivalent to a trivial layout with the qubits from the output circuit's :attr:`~.QuantumCircuit.qubits` list. r initial_layoutzdict[circuit.Qubit, int]input_qubit_mappingNz Layout | None final_layoutz int | None_input_qubit_countzList[Qubit] | None_output_qubit_listFfilter_ancillasboolrgc|sjStfdjDS)aReturn a :class:`.Layout` object for the initial layout. This returns a mapping of virtual :class:`~.circuit.Qubit` objects in the input circuit to the positions of the physical qubits selected during layout. This is analogous to the :attr:`.initial_layout` attribute. Args: filter_ancillas: If set to ``True`` only qubits in the input circuit will be in the returned layout. Any ancilla qubits added to the output circuit will be filtered from the returned object. Returns: A layout object mapping the input circuit's :class:`~.circuit.Qubit` objects to the positions of the selected physical qubits. cHi|]\}}j|jk||Sr)rr)rwkrnrs rrz:TranspileLayout.initial_virtual_layout..As?   Aq+A.1HHH1HHHr)rr rZr)rrs` rinitial_virtual_layoutz&TranspileLayout.initial_virtual_layout/si '& &     /@@BBHHJJ      r List[int]c|j}|r dg|jz}ndgt|z}t |D])\}\}}|r ||jkrn|j|}|||<*|S)a_Generate an initial layout as an array of integers. Args: filter_ancillas: If set to ``True`` any ancilla qubits added to the transpiler will not be included in the output. Return: A layout array that maps a position in the array to its new position in the output circuit. N)rrZrr@rjrr)rr virtual_mapoutputindexrrrs rinitial_index_layoutz$TranspileLayout.initial_index_layoutHs)::<<  /Vd55FFVc+...F#,[->->-@-@#A#A   Ez7TranspileLayout.routing_permutation..nsFFFd D!FFFr)rlistrLr@rrZ)rrs @rrouting_permutationz#TranspileLayout.routing_permutation`s`   $c$"9::;;<< <'88:: FFFFd.EFFFFrTc|jtd|jD}n|j}|j't |j}n|j}d|jD}g}|r|}nt|j}t|D]D}|j ||}|j|j||}| |E|S)aBGenerate the final layout as an array of integers. This method will generate an array of final positions for each qubit in the input circuit. For example, if you had an input circuit like:: qc = QuantumCircuit(3) qc.h(0) qc.cx(0, 1) qc.cx(0, 2) and the output from the transpiler was:: tqc = QuantumCircuit(3) tqc.h(2) tqc.cx(2, 1) tqc.swap(0, 1) tqc.cx(2, 1) then the :meth:`.final_index_layout` method returns:: [2, 0, 1] This can be seen as follows. Qubit 0 in the original circuit is mapped to qubit 2 in the output circuit during the layout stage, which is mapped to qubit 2 during the routing stage. Qubit 1 in the original circuit is mapped to qubit 1 in the output circuit during the layout stage, which is mapped to qubit 0 during the routing stage. Qubit 2 in the original circuit is mapped to qubit 0 in the output circuit during the layout stage, which is mapped to qubit 1 during the routing stage. The output list length will be as wide as the input circuit's number of qubits, as the output list from this method is for tracking the permutation of qubits in the original circuit caused by the transpiler. Args: filter_ancillas: If set to ``False`` any ancillas allocated in the output circuit will be included in the layout. Returns: A list of final positions for each input circuit qubit. NcZg|](}t|ddd&|)S) _registerancilla)getattr startswith)rwxs rrz6TranspileLayout.final_index_layout..sHq+r22==iHHrci|]\}}|| Srrrwrrns rrz6TranspileLayout.final_index_layout..III1q!IIIr) rr@rrrrrZrrLrr) rrnum_source_qubitscircuit_qubits pos_to_virt qubit_indicesrr qubit_idxs rfinal_index_layoutz"TranspileLayout.final_index_layoutps#P  " *!$!5!!  !% 7   " *!$"3"D"D"F"FGGNN!4NII(@(F(F(H(HIII   6*JJT455J:&& , ,E+K,>?I , -nY.GH   + + + +rc||}d|jDtfdt |DS)aGenerate the final layout as a :class:`.Layout` object. This method will generate an array of final positions for each qubit in the input circuit. For example, if you had an input circuit like:: qc = QuantumCircuit(3) qc.h(0) qc.cx(0, 1) qc.cx(0, 2) and the output from the transpiler was:: tqc = QuantumCircuit(3) tqc.h(2) tqc.cx(2, 1) tqc.swap(0, 1) tqc.cx(2, 1) then the return from this function would be a layout object:: Layout({ qc.qubits[0]: 2, qc.qubits[1]: 0, qc.qubits[2]: 1, }) This can be seen as follows. Qubit 0 in the original circuit is mapped to qubit 2 in the output circuit during the layout stage, which is mapped to qubit 2 during the routing stage. Qubit 1 in the original circuit is mapped to qubit 1 in the output circuit during the layout stage, which is mapped to qubit 0 during the routing stage. Qubit 2 in the original circuit is mapped to qubit 0 in the output circuit during the layout stage, which is mapped to qubit 1 during the routing stage. The output list length will be as wide as the input circuit's number of qubits, as the output list from this method is for tracking the permutation of qubits in the original circuit caused by the transpiler. Args: filter_ancillas: If set to ``False`` any ancillas allocated in the output circuit will be included in the layout. Returns: A layout object mapping to the final positions for each qubit. )rci|]\}}|| Srrrs rrz8TranspileLayout.final_virtual_layout..rrc(i|]\}}||Srr)rwrrrs rrz8TranspileLayout.final_virtual_layout..s$RRRKE4{5)4RRRr)rrrr rj)rrresrs @rfinal_virtual_layoutz$TranspileLayout.final_virtual_layoutsgX%%o%FFII(@(F(F(H(HIII RRRR9S>>RRRSSSr)F)rrrgr )rrrgr)rgr)T) rrrr__annotations__rrrrrrrrrrrrrskkZ1111"&L&&&&%)))))-11111     20GGGG DDDDDL.T.T.T.T.T.T.TrrN)r __future__rtypingr dataclassesrqiskitrqiskit.circuit.quantumregisterrrqiskit.transpiler.exceptionsr qiskit.convertersr r rrrrrs#"""""!!!!!!AAAAAAAA444444++++++YYYYYYYYx  iTiTiTiTiTiTiT iTiTiTr