changed interface for AbstractInitialMapper

Author: ammareltigani

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

@@ -37,9 +37,12 @@ class AbstractInitialMapper(metaclass=abc.ABCMeta):
     """
 
     @abc.abstractmethod
-    def initial_mapping(self) -> Dict['cirq.Qid', 'cirq.Qid']:
+    def initial_mapping(self, circuit: 'cirq.AbstractCircuit') -> Dict['cirq.Qid', 'cirq.Qid']:
         """Maps the logical qubits of a circuit onto physical qubits on a device.
 
+        Args:
+            circuit: the input circuit with logical qubits.
+
         Returns:
           qubit_map: the initial mapping of logical qubits to physical qubits.
         """
@@ -52,9 +55,12 @@ class HardCodedInitialMapper(AbstractInitialMapper):
     def __init__(self, _map: Dict['cirq.Qid', 'cirq.Qid']) -> None:
         self._map = _map
 
-    def initial_mapping(self) -> Dict['cirq.Qid', 'cirq.Qid']:
+    def initial_mapping(self, circuit: 'cirq.AbstractCircuit') -> Dict['cirq.Qid', 'cirq.Qid']:
         """Returns the hard-coded initial mapping.
 
+        Args:
+            circuit: the input circuit with logical qubits.
+
         Returns:
             the hard-codded initial mapping.
         """

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

@@ -19,6 +19,6 @@ def test_identity_initial_mapper():
     input_map = {cirq.NamedQubit(str(i)): cirq.NamedQubit(str(-i)) for i in range(1, 6)}
     initial_mapper = cirq.HardCodedInitialMapper(input_map)
 
-    assert input_map == initial_mapper.initial_mapping()
+    assert input_map == initial_mapper.initial_mapping(cirq.Circuit())
     assert str(initial_mapper) == f'{input_map}'
     cirq.testing.assert_equivalent_repr(initial_mapper)