Added __str__ and __repr__ for MappingManager and pushed name 'MappingMananger' to 'cirq' namespace

cirq-core/cirq/__init__.py

@@ -346,6 +346,7 @@
     eject_z,
     expand_composite,
     is_negligible_turn,
+    MappingManager,
     map_moments,
     map_operations,
     map_operations_and_unroll,

cirq-core/cirq/protocols/json_test_data/spec.py

@@ -83,6 +83,8 @@
         # Transformers
         'TransformerLogger',
         'TransformerContext',
+        # Routing classes
+        'MappingManager',
         # global objects
         'CONTROL_TAG',
         'PAULI_BASIS',

cirq-core/cirq/transformers/__init__.py

@@ -44,6 +44,8 @@
     two_qubit_gate_product_tabulation,
 )
 
+from cirq.transformers.routing import MappingManager
+
 from cirq.transformers.target_gatesets import (
     create_transformer_with_kwargs,
     CompilationTargetGateset,

cirq-core/cirq/transformers/routing/mapping_manager.py

@@ -19,11 +19,13 @@
 import networkx as nx
 
 from cirq import protocols
+from cirq.value import value_equality
 
 if TYPE_CHECKING:
     import cirq
 
 
+@value_equality
 class MappingManager:
     """Class that manages the mapping from logical to physical qubits.
 
@@ -41,6 +43,7 @@ def __init__(
             initial_mapping: the initial mapping of logical (keys) to physical qubits (values).
         """
         self.device_graph = device_graph
+        self.graph_adjacency = dict(self.device_graph.adjacency())
         self._map = initial_mapping.copy()
         self._inverse_map = {v: k for k, v in self._map.items()}
         self._induced_subgraph = nx.induced_subgraph(self.device_graph, self._map.values())
@@ -133,3 +136,12 @@ def shortest_path(self, lq1: 'cirq.Qid', lq2: 'cirq.Qid') -> Sequence['cirq.Qid'
     @cached_method
     def _physical_shortest_path(self, pq1: 'cirq.Qid', pq2: 'cirq.Qid') -> Sequence['cirq.Qid']:
         return nx.shortest_path(self._induced_subgraph, pq1, pq2)
+
+    def _value_equality_values_(self):
+        return self.graph_adjacency, self._map
+
+    def __str__(self) -> str:
+        return f'Device graph adjacency: {self.graph_adjacency}\nMap: {self._map}'
+
+    def __repr__(self) -> str:
+        return f'cirq.MappingManager(nx.Graph({self.graph_adjacency}), {self._map})'

cirq-core/cirq/transformers/routing/mapping_manager_test.py

@@ -41,7 +41,7 @@ def construct_device_graph_and_mapping():
 
 def test_induced_subgraph():
     device_graph, initial_mapping, _ = construct_device_graph_and_mapping()
-    mm = cirq.transformers.routing.MappingManager(device_graph, initial_mapping)
+    mm = cirq.MappingManager(device_graph, initial_mapping)
 
     expected_induced_subgraph = nx.Graph(
         [
@@ -55,7 +55,7 @@ def test_induced_subgraph():
 
 def test_mapped_op():
     device_graph, initial_mapping, q = construct_device_graph_and_mapping()
-    mm = cirq.transformers.routing.MappingManager(device_graph, initial_mapping)
+    mm = cirq.MappingManager(device_graph, initial_mapping)
 
     assert mm.mapped_op(cirq.CNOT(q[1], q[3])).qubits == (
         cirq.NamedQubit("a"),
@@ -82,7 +82,7 @@ def test_mapped_op():
 
 def test_distance_on_device_and_can_execute():
     device_graph, initial_mapping, q = construct_device_graph_and_mapping()
-    mm = cirq.transformers.routing.MappingManager(device_graph, initial_mapping)
+    mm = cirq.MappingManager(device_graph, initial_mapping)
 
     # adjacent qubits have distance 1 and are thus executable
     assert mm.dist_on_device(q[1], q[3]) == 1
@@ -108,7 +108,7 @@ def test_distance_on_device_and_can_execute():
 
 def test_apply_swap():
     device_graph, initial_mapping, q = construct_device_graph_and_mapping()
-    mm = cirq.transformers.routing.MappingManager(device_graph, initial_mapping)
+    mm = cirq.MappingManager(device_graph, initial_mapping)
 
     # swapping non-adjacent qubits raises error
     with pytest.raises(ValueError):
@@ -130,7 +130,7 @@ def test_apply_swap():
 
 def test_shortest_path():
     device_graph, initial_mapping, q = construct_device_graph_and_mapping()
-    mm = cirq.transformers.routing.MappingManager(device_graph, initial_mapping)
+    mm = cirq.MappingManager(device_graph, initial_mapping)
 
     one_to_four = [q[1], q[3], q[2], q[4]]
     assert mm.shortest_path(q[1], q[2]) == one_to_four[:3]
@@ -143,3 +143,18 @@ def test_shortest_path():
     one_to_four[1], one_to_four[2] = one_to_four[2], one_to_four[1]
     assert mm.shortest_path(q[1], q[4]) == one_to_four
     assert mm.shortest_path(q[1], q[2]) == [q[1], q[2]]
+
+
+def test_repr():
+    device_graph, initial_mapping, _ = construct_device_graph_and_mapping()
+    mm = cirq.MappingManager(device_graph, initial_mapping)
+    cirq.testing.assert_equivalent_repr(mm, setup_code='import cirq\nimport networkx as nx')
+
+
+def test_str():
+    device_graph, initial_mapping, _ = construct_device_graph_and_mapping()
+    mm = cirq.MappingManager(device_graph, initial_mapping)
+    assert (
+        str(mm)
+        == f'Device graph adjacency: {dict(device_graph.adjacency())}\nMap: {initial_mapping}'
+    )