gHXdZddlZddlmZddlZddlmZddlm Z GddZ dS)au Directed graph object for representing coupling between physical qubits. The nodes of the graph correspond to physical qubits (represented as integers) and the directed edges indicate which physical qubits are coupled and the permitted direction of CNOT gates. The object has a distance function that can be used to map quantum circuits onto a device with this coupling. N)List) graphviz_draw) CouplingErrorceZdZdZdZd#dZdZdZdZdZ d Z e d Z d Z d Ze d ZdZdZdZe dZdZdZd$dZed$d%dZed$d%dZed$d%dZed$d%dZed$d%dZed$d%dZed$d%dZdZde dfdZ!d Z"d!Z#d"Z$dS)& CouplingMapz Directed graph specifying fixed coupling. Nodes correspond to physical qubits (integers) and directed edges correspond to permitted CNOT gates, with source and destination corresponding to control and target qubits, respectively. ) descriptiongraph _dist_matrix _qubit_list_size _is_symmetricNc||_tj|_d|_d|_d|_d|_|&|jd|DdSdS)a Create coupling graph. By default, the generated coupling has no nodes. Args: couplinglist (list or None): An initial coupling graph, specified as an adjacency list containing couplings, e.g. [[0,1], [0,2], [1,2]]. It is required that nodes are contiguously indexed starting at 0. Missed nodes will be added as isolated nodes in the coupling map. description (str): A string to describe the coupling map. Nc,g|]}t|Stuple.0xs P/granary/edev/quantum/lib/python3.11/site-packages/qiskit/transpiler/coupling.py z(CouplingMap.__init__..Hs-M-M-M1eAhh-M-M-M) rrx PyDiGraphr r r r r extend_from_edge_list)self couplinglistrs r__init__zCouplingMap.__init__1sq'\^^   !  # J , ,-M-M -M-M-M N N N N N $ #rcP|jt|j|_|jS)z3Return the number of physical qubits in this graph.)r lenr rs rsizezCouplingMap.sizeJs! : TZDJzrc4|jS)z Gets the list of edges in the coupling graph. Returns: Tuple(int,int): Each edge is a pair of physical qubits. )r edge_listr!s r get_edgeszCouplingMap.get_edgesPsz##%%%rcNt|jS)N)iterr r$r!s r__iter__zCouplingMap.__iter__YsDJ((**+++rct|tstd||jvrtd|d|j|d|_d|_d|_dS)zAdd a physical qubit to the coupling graph as a node. physical_qubit (int): An integer representing a physical qubit. Raises: CouplingError: if trying to add duplicate qubit z#Physical qubits should be integers.zThe physical qubit z! is already in the coupling graphN) isinstanceintrphysical_qubitsr add_noder r r rphysical_qubits radd_physical_qubitzCouplingMap.add_physical_qubit\s.#.. G EFF F T1 1 1WnWWW  N+++  rc||jvr||||jvr|||j||dd|_d|_dS)z Add directed edge to coupling graph. src (int): source physical qubit dst (int): destination physical qubit N)r,r0r add_edger r )rsrcdsts rr2zCouplingMap.add_edgeosx d* * *  # #C ( ( ( d* * *  # #C ( ( ( Cd+++ !rcZ|j|j|_|jS)z(Returns a sorted list of physical_qubits)r r node_indexesr!s rr,zCouplingMap.physical_qubits~s,   ##z6688D rcb tj|jS#tj$rYdSwxYw)zd Test if the graph is connected. Return True if connected, False otherwise F)ris_weakly_connectedr NullGraphr!s r is_connectedzCouplingMap.is_connecteds>  )$*55 5|   55 s ..c6|j|S)zReturn the nearest neighbors of a physical qubit. Directionality matters, i.e. a neighbor must be reachable by going one hop in the direction of an edge. )r neighborsr.s rr<zCouplingMap.neighborss z##N333rc8||jS)zReturn the distance matrix for the coupling map. For any qubits where there isn't a path available between them the value in this position of the distance matrix will be ``math.inf``. )compute_distance_matrixr r!s rdistance_matrixzCouplingMap.distance_matrixs $$&&&  rcn|j-tj|jdtj|_dSdS)aCompute the full distance matrix on pairs of nodes. The distance map self._dist_matrix is computed from the graph using all_pairs_shortest_path_length. This is normally handled internally by the :attr:`~qiskit.transpiler.CouplingMap.distance_matrix` attribute or the :meth:`~qiskit.transpiler.CouplingMap.distance` method but can be called if you're accessing the distance matrix outside of those or want to pre-generate it. NT) as_undirected null_value)r rdigraph_distance_matrixr mathinfr!s rr>z#CouplingMap.compute_distance_matrixs@   $ " : $48!!!D    % $rcX||krt|d||krt|d||j||f}|tjkrtd|d|t |S)agReturns the undirected distance between physical_qubit1 and physical_qubit2. Args: physical_qubit1 (int): A physical qubit physical_qubit2 (int): Another physical qubit Returns: int: The undirected distance Raises: CouplingError: if the qubits do not exist in the CouplingMap z not in coupling graphz No path from z to )r"rr>r rDrEr+)rphysical_qubit1physical_qubit2ress rdistancezCouplingMap.distances diikk ) )? J J JKK K diikk ) )? J J JKK K $$&&& @A $(?? V V V_ V VWW W3xxrctj|j||d}|s0tdt |dt |d||S)aReturns the shortest undirected path between physical_qubit1 and physical_qubit2. Args: physical_qubit1 (int): A physical qubit physical_qubit2 (int): Another physical qubit Returns: List: The shortest undirected path Raises: CouplingError: When there is no path between physical_qubit1, physical_qubit2. T)sourcetargetrAzNodes z and z are not connected)rdigraph_dijkstra_shortest_pathsr rstr)rrGrHpathss rshortest_undirected_pathz$CouplingMap.shortest_undirected_pathsv2 JVZ    \_--\\C4H4H\\\ _%%rcP|j||_|jS)zd Test if the graph is symmetric. Return True if symmetric, False otherwise )r _check_symmetryr!s r is_symmetriczCouplingMap.is_symmetrics*   %!%!5!5!7!7D !!rc|}t|}|D]'\}}||f|vr|j||d(d|_d|_dS)zD Convert uni-directional edges into bi-directional. N)r%setr r2r r )redgesedge_setr3dests rmake_symmetriczCouplingMap.make_symmetricsq   u:: 5 5ICc{(** ##D#t444 !rc4|jS)zl Calculates symmetry Returns: Bool: True if symmetric, False otherwise )r rTr!s rrSzCouplingMap._check_symmetrysz&&(((rTc>dgt|dzz}t|D] \}}|||< g}|D]E}|d|vr9|d|vr/|||d||dgFt }t t |D]} |j| |j d|D|r#| std|S)aReturns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. Args: mapping (list): A mapping of reduced qubits to device qubits. check_if_connected (bool): if True, checks that the reduced coupling map is connected. Returns: CouplingMap: A reduced coupling_map for the selected qubits. Raises: CouplingError: Reduced coupling map must be connected. Nrc,g|]}t|Srrrs rrz&CouplingMap.reduce..s9Y9Y9Yq%((9Y9Y9Yrzcoupling_map must be connected.) max enumerater%appendrranger r r-rr:r) rmappingcheck_if_connectedinv_mapidxval reduced_cmapedgereduced_coupling_mapnodes rreducezCouplingMap.reducesF$&CLL1,-!'**  HCGCLL NN$$ J JDAw'!!d1g&8&8##WT!W%5wtAw7G$HIII +}}#g,,'' 6 6D & / / 5 5 5 5"889Y9YL9Y9Y9YZZZ  C&:&G&G&I&I C ABB B##rreturnc|d}|r%tj||_nWg}t |D]+}t |D]}|||f,|j||S)z2Return a fully connected coupling map on n qubits.fullr)r generatorsdirected_mesh_graphr rbrar)cls num_qubits bidirectionalcmapr$ijs r from_fullzCouplingMap.from_full&ssv&&&  8:::FFDJJI:&& - -q--A$$aV,,,,- J , ,Y 7 7 7 rcj|d}tj|||_|S)z6Return a coupling map of n qubits connected in a line.linerpru)rrqdirected_path_graphr rsrtrurvs r from_linezCouplingMap.from_line4s8sv&&&]66zQ^6__  rcj|d}tj|||_|S)zQReturn a coupling map of n qubits connected to each of their neighbors in a ring.ringrpr|)rrqdirected_cycle_graphr r~s r from_ringzCouplingMap.from_ring;s8sv&&&]77 R_7``  rcl|d}tj||||_|S)zNReturn a coupling map of qubits connected on a grid of num_rows x num_columns.gridrpr|)rrqdirected_grid_graphr )rsnum_rows num_columnsrurvs r from_gridzCouplingMap.from_gridBsBsv&&&]66 k7    rcj|d}tj|||_|S)a"Return a heavy hexagon graph coupling map. A heavy hexagon graph is described in: https://journals.aps.org/prx/abstract/10.1103/PhysRevX.10.011022 Args: distance (int): The code distance for the generated heavy hex graph. The value for distance can be any odd positive integer. The distance relates to the number of qubits by: :math:`n = \frac{5d^2 - 2d - 1}{2}` where :math:`n` is the number of qubits and :math:`d` is the ``distance`` parameter. bidirectional (bool): Whether the edges in the output coupling graph are bidirectional or not. By default this is set to ``True`` Returns: CouplingMap: A heavy hex coupling graph z heavy-hexrpr|)rrqdirected_heavy_hex_graphr rsrJrurvs rfrom_heavy_hexzCouplingMap.from_heavy_hexKs8(s{+++];;HTa;bb  rcj|d}tj|||_|S)aReturn a heavy square graph coupling map. A heavy square graph is described in: https://journals.aps.org/prx/abstract/10.1103/PhysRevX.10.011022 Args: distance (int): The code distance for the generated heavy square graph. The value for distance can be any odd positive integer. The distance relates to the number of qubits by: :math:`n = 3d^2 - 2d` where :math:`n` is the number of qubits and :math:`d` is the ``distance`` parameter. bidirectional (bool): Whether the edges in the output coupling graph are bidirectional or not. By default this is set to ``True`` Returns: CouplingMap: A heavy square coupling graph z heavy-squarerpr|)rrqdirected_heavy_square_graphr rs rfrom_heavy_squarezCouplingMap.from_heavy_squarecs@(s~...]>> M?    rcl|d}tj||||_|S)aReturn a hexagonal lattice graph coupling map. Args: rows (int): The number of rows to generate the graph with. cols (int): The number of columns to generate the graph with. bidirectional (bool): Whether the edges in the output coupling graph are bidirectional or not. By default this is set to ``True`` Returns: CouplingMap: A hexagonal lattice coupling graph zhexagonal-latticerpr|)rrq directed_hexagonal_lattice_graphr )rsrowscolsrurvs rfrom_hexagonal_latticez"CouplingMap.from_hexagonal_lattice}sDs2333]CC $mD    rc\ttj|jtS)z:Return a set of qubits in the largest connected component.)key)r_rweakly_connected_componentsr r r!s rlargest_connected_componentz'CouplingMap.largest_connected_components"21$*==3GGGGrc0|jD] }||j|< tj|j}g}|D]Q}t }|jt ||_||R|S)aASeparate a :Class:`~.CouplingMap` into subgraph :class:`~.CouplingMap` for each connected component. The connected components of a :class:`~.CouplingMap` are the subgraphs that are not part of any larger subgraph. For example, if you had a coupling map that looked like:: 0 --> 1 4 --> 5 ---> 6 --> 7 | | | | V V 2 --> 3 then the connected components of that graph are the subgraphs:: 0 --> 1 | | | | V V 2 --> 3 and:: 4 --> 5 ---> 6 --> 7 For a connected :class:`~.CouplingMap` object there is only a single connected component, the entire :class:`~.CouplingMap`. This method will return a list of :class:`~.CouplingMap` objects, one for each connected component in this :class:`~.CouplingMap`. The data payload of each node in the :attr:`~.CouplingMap.graph` attribute will contain the qubit number in the original graph. This will enables mapping the qubit index in a component subgraph to the original qubit in the combined :class:`~.CouplingMap`. For example:: from qiskit.transpiler import CouplingMap cmap = CouplingMap([[0, 1], [1, 2], [2, 0], [3, 4], [4, 5], [5, 3]]) component_cmaps = cmap.connected_components() print(component_cmaps[1].graph[0]) will print ``3`` as index ``0`` in the second component is qubit 3 in the original cmap. Returns: list: A list of :class:`~.CouplingMap` objects for each connected components. The order of this list is deterministic but implementation specific and shouldn't be relied upon as part of the API. )r node_indicesrrrsubgraphsortedra)rrk components output_list componentnew_cmaps rconnected_componentsz CouplingMap.connected_componentssdJ++-- $ $D#DJt  3DJ??  # ) )I"}}H!Z00 1B1BCCHN   x ( ( ( (rcd}|r>|dz }|dd|Dz }|dz }|S)z5Return a string representation of the coupling graph.[, c&g|]\}}d|d|dS)rr]r)rr3r4s rrz'CouplingMap.__str__..s0 V V VzS!2S!2!2C!2!2!2 V V Vrr)r%join)rstrings r__str__zCouplingMap.__str__s_ >>    cMF dii V VT^^EUEU V V VWW WF cMF rct|tsdSt|jt|jkS)afCheck if the graph in ``other`` has the same node labels and edges as the graph in ``self``. This function assumes that the graphs in :class:`.CouplingMap` instances are connected. Args: other (CouplingMap): The other coupling map. Returns: bool: Whether or not other is isomorphic to self. F)r*rrVr r$)rothers r__eq__zCouplingMap.__eq__sR%-- 54:''))**c%+2G2G2I2I.J.JJJrc.t|jdS)aDraws the coupling map. This function calls the :func:`~rustworkx.visualization.graphviz_draw` function from the ``rustworkx`` package to draw the :class:`CouplingMap` object. Returns: PIL.Image: Drawn coupling map. neato)method)rr r!s rdrawzCouplingMap.drawsTZ8888r)NN)T)rmr)%__name__ __module__ __qualname____doc__ __slots__rr"r%r(r0r2propertyr,r:r<r?r>rJrQrTrZrSrl classmethodryrrrrrrrrrrrrrrrrrsIOOOO2 &&&,,,& " " "  X   444!!X!   .&&&(""X" " " ")))&$&$&$&$P    [ [ [ [[.[2[$HHH:d=&9::::xKKK 9 9 9 9 9rr) rrDtypingr rustworkxrrustworkx.visualizationrqiskit.transpiler.exceptionsrrrrrrs 111111666666U9U9U9U9U9U9U9U9U9U9r