qiskit 2.1.0rc1__cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

qiskit/transpiler/passes/optimization/template_matching/forward_match.py

@@ -0,0 +1,452 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2020.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""
+Template matching in the forward direction, it takes an initial
+match, a configuration of qubit and both circuit and template as inputs. The
+result is a list of match between the template and the circuit.
+
+
+**Reference:**
+
+[1] Iten, R., Moyard, R., Metger, T., Sutter, D. and Woerner, S., 2020.
+Exact and practical pattern matching for quantum circuit optimization.
+`arXiv:1909.05270 <https://arxiv.org/abs/1909.05270>`_
+
+"""
+
+from qiskit.circuit.controlledgate import ControlledGate
+
+
+class ForwardMatch:
+    """
+    Object to apply template matching in the forward direction.
+    """
+
+    def __init__(
+        self, circuit_dag_dep, template_dag_dep, node_id_c, node_id_t, qubits, clbits=None
+    ):
+        """
+        Create a ForwardMatch class with necessary arguments.
+        Args:
+            circuit_dag_dep (DAGDependency): circuit in the dag dependency form.
+            template_dag_dep (DAGDependency): template in the dag dependency form.
+            node_id_c (int): index of the first gate matched in the circuit.
+            node_id_t (int): index of the first gate matched in the template.
+            qubits (list): list of considered qubits in the circuit.
+            clbits (list): list of considered clbits in the circuit.
+        """
+
+        # The dag dependency representation of the circuit
+        self.circuit_dag_dep = circuit_dag_dep.copy()
+
+        # The dag dependency representation of the template
+        self.template_dag_dep = template_dag_dep.copy()
+
+        # List of qubit on which the node of the circuit is acting on
+        self.qubits = qubits
+
+        # List of qubit on which the node of the circuit is acting on
+        self.clbits = clbits if clbits is not None else []
+
+        # Id of the node in the circuit
+        self.node_id_c = node_id_c
+
+        # Id of the node in the template
+        self.node_id_t = node_id_t
+
+        # List of match
+        self.match = []
+
+        # List of candidates for the forward match
+        self.candidates = []
+
+        # List of nodes in circuit which are matched
+        self.matched_nodes_list = []
+
+        # Transformation of the qarg indices of the circuit to be adapted to the template indices
+        self.qarg_indices = []
+
+        # Transformation of the carg indices of the circuit to be adapted to the template indices
+        self.carg_indices = []
+
+    def _init_successors_to_visit(self):
+        """
+        Initialize the attribute list 'SuccessorsToVisit'
+        """
+        for i in range(0, self.circuit_dag_dep.size()):
+            if i == self.node_id_c:
+                self.circuit_dag_dep.get_node(i).successorstovisit = (
+                    self.circuit_dag_dep.direct_successors(i)
+                )
+
+    def _init_matched_with_circuit(self):
+        """
+        Initialize the attribute 'MatchedWith' in the template DAG dependency.
+        """
+        for i in range(0, self.circuit_dag_dep.size()):
+            if i == self.node_id_c:
+                self.circuit_dag_dep.get_node(i).matchedwith = [self.node_id_t]
+            else:
+                self.circuit_dag_dep.get_node(i).matchedwith = []
+
+    def _init_matched_with_template(self):
+        """
+        Initialize the attribute 'MatchedWith' in the circuit DAG dependency.
+        """
+        for i in range(0, self.template_dag_dep.size()):
+            if i == self.node_id_t:
+                self.template_dag_dep.get_node(i).matchedwith = [self.node_id_c]
+            else:
+                self.template_dag_dep.get_node(i).matchedwith = []
+
+    def _init_is_blocked_circuit(self):
+        """
+        Initialize the attribute 'IsBlocked' in the circuit DAG dependency.
+        """
+        for i in range(0, self.circuit_dag_dep.size()):
+            self.circuit_dag_dep.get_node(i).isblocked = False
+
+    def _init_is_blocked_template(self):
+        """
+        Initialize the attribute 'IsBlocked' in the template DAG dependency.
+        """
+        for i in range(0, self.template_dag_dep.size()):
+            self.template_dag_dep.get_node(i).isblocked = False
+
+    def _init_list_match(self):
+        """
+        Initialize the list of matched nodes between the circuit and the template
+        with the first match found.
+        """
+        self.match.append([self.node_id_t, self.node_id_c])
+
+    def _find_forward_candidates(self, node_id_t):
+        """
+        Find the candidate nodes to be matched in the template for a given node.
+        Args:
+            node_id_t (int): considered node id.
+        """
+        matches = []
+
+        for match in self.match:
+            matches.append(match[0])
+
+        pred = matches.copy()
+        if len(pred) > 1:
+            pred.sort()
+        pred.remove(node_id_t)
+
+        if self.template_dag_dep.direct_successors(node_id_t):
+            maximal_index = self.template_dag_dep.direct_successors(node_id_t)[-1]
+            pred = [elem for elem in pred if elem <= maximal_index]
+
+        block = []
+        for node_id in pred:
+            for dir_succ in self.template_dag_dep.direct_successors(node_id):
+                if dir_succ not in matches:
+                    succ = self.template_dag_dep.successors(dir_succ)
+                    block = block + succ
+        self.candidates = list(
+            set(self.template_dag_dep.direct_successors(node_id_t)) - set(matches) - set(block)
+        )
+
+    def _init_matched_nodes(self):
+        """
+        Initialize the list of current matched nodes.
+        """
+        self.matched_nodes_list.append(
+            [self.node_id_c, self.circuit_dag_dep.get_node(self.node_id_c)]
+        )
+
+    def _get_node_forward(self, list_id):
+        """
+        Return a node from the matched_node_list for a given list id.
+        Args:
+            list_id (int): considered list id of the desired node.
+
+        Returns:
+            DAGDepNode: DAGDepNode object corresponding to i-th node of the matched_node_list.
+        """
+        node = self.matched_nodes_list[list_id][1]
+        return node
+
+    def _remove_node_forward(self, list_id):
+        """
+        Remove a node of the current matched list for a given list id.
+        Args:
+            list_id (int): considered list id of the desired node.
+        """
+        self.matched_nodes_list.pop(list_id)
+
+    def _update_successor(self, node, successor_id):
+        """
+        Return a node with an updated attribute 'SuccessorToVisit'.
+        Args:
+            node (DAGDepNode): current node.
+            successor_id (int): successor id to remove.
+
+        Returns:
+            DAGOpNode or DAGOutNode: Node with updated attribute 'SuccessorToVisit'.
+        """
+        node_update = node
+        node_update.successorstovisit.pop(successor_id)
+        return node_update
+
+    def _get_successors_to_visit(self, node, list_id):
+        """
+        Return the successor for a given node and id.
+        Args:
+            node (DAGOpNode or DAGOutNode): current node.
+            list_id (int): id in the list for the successor to get.
+
+        Returns:
+            int: id of the successor to get.
+        """
+        successor_id = node.successorstovisit[list_id]
+        return successor_id
+
+    def _update_qarg_indices(self, qarg):
+        """
+        Change qubits indices of the current circuit node in order to
+        be comparable with the indices of the template qubits list.
+        Args:
+            qarg (list): list of qubits indices from the circuit for a given node.
+        """
+        self.qarg_indices = []
+        for q in qarg:
+            if q in self.qubits:
+                self.qarg_indices.append(self.qubits.index(q))
+        if len(qarg) != len(self.qarg_indices):
+            self.qarg_indices = []
+
+    def _update_carg_indices(self, carg):
+        """
+        Change clbits indices of the current circuit node in order to
+        be comparable with the indices of the template qubits list.
+        Args:
+            carg (list): list of clbits indices from the circuit for a given node.
+        """
+        self.carg_indices = []
+        if carg:
+            for q in carg:
+                if q in self.clbits:
+                    self.carg_indices.append(self.clbits.index(q))
+            if len(carg) != len(self.carg_indices):
+                self.carg_indices = []
+
+    def _is_same_op(self, node_circuit, node_template):
+        """
+        Check if two instructions are the same.
+        Args:
+            node_circuit (DAGDepNode): node in the circuit.
+            node_template (DAGDepNode): node in the template.
+        Returns:
+            bool: True if the same, False otherwise.
+        """
+        return node_circuit.op.soft_compare(node_template.op)
+
+    def _is_same_q_conf(self, node_circuit, node_template):
+        """
+        Check if the qubits configurations are compatible.
+        Args:
+            node_circuit (DAGDepNode): node in the circuit.
+            node_template (DAGDepNode): node in the template.
+        Returns:
+            bool: True if possible, False otherwise.
+        """
+
+        if isinstance(node_circuit.op, ControlledGate):
+
+            c_template = node_template.op.num_ctrl_qubits
+
+            if c_template == 1:
+                return self.qarg_indices == node_template.qindices
+
+            else:
+                control_qubits_template = node_template.qindices[:c_template]
+                control_qubits_circuit = self.qarg_indices[:c_template]
+
+                if set(control_qubits_circuit) == set(control_qubits_template):
+
+                    target_qubits_template = node_template.qindices[c_template::]
+                    target_qubits_circuit = self.qarg_indices[c_template::]
+
+                    if node_template.op.base_gate.name in [
+                        "rxx",
+                        "ryy",
+                        "rzz",
+                        "swap",
+                        "iswap",
+                        "ms",
+                    ]:
+                        return set(target_qubits_template) == set(target_qubits_circuit)
+                    else:
+                        return target_qubits_template == target_qubits_circuit
+                else:
+                    return False
+        else:
+            if node_template.op.name in ["rxx", "ryy", "rzz", "swap", "iswap", "ms"]:
+                return set(self.qarg_indices) == set(node_template.qindices)
+            else:
+                return self.qarg_indices == node_template.qindices
+
+    def _is_same_c_conf(self, node_circuit, node_template):
+        """
+        Check if the clbits configurations are compatible.
+        Args:
+            node_circuit (DAGDepNode): node in the circuit.
+            node_template (DAGDepNode): node in the template.
+        Returns:
+            bool: True if possible, False otherwise.
+        """
+        if (
+            node_circuit.type == "op"
+            and getattr(node_circuit.op, "_condition", None)
+            and node_template.type == "op"
+            and getattr(node_template.op, "_condition", None)
+        ):
+            if set(self.carg_indices) != set(node_template.cindices):
+                return False
+            if (
+                getattr(node_circuit.op, "_condition", None)[1]
+                != getattr(node_template.op, "_condition", None)[1]
+            ):
+                return False
+        return True
+
+    def run_forward_match(self):
+        """
+        Apply the forward match algorithm and returns the list of matches given an initial match
+        and a circuit qubits configuration.
+        """
+
+        # Initialize the new attributes of the DAGDepNodes of the DAGDependency object
+        self._init_successors_to_visit()
+
+        self._init_matched_with_circuit()
+        self._init_matched_with_template()
+
+        self._init_is_blocked_circuit()
+        self._init_is_blocked_template()
+
+        # Initialize the list of matches and the stack of matched nodes (circuit)
+        self._init_list_match()
+        self._init_matched_nodes()
+
+        # While the list of matched nodes is not empty
+        while self.matched_nodes_list:
+
+            # Return first element of the matched_nodes_list and removes it from the list
+            v_first = self._get_node_forward(0)
+            self._remove_node_forward(0)
+
+            # If there is no successors to visit go to the end
+            if not v_first.successorstovisit:
+                continue
+
+            # Get the label and the node of the first successor to visit
+            label = self._get_successors_to_visit(v_first, 0)
+            v = [label, self.circuit_dag_dep.get_node(label)]
+
+            # Update of the SuccessorsToVisit attribute
+            v_first = self._update_successor(v_first, 0)
+
+            # Update the matched_nodes_list with new attribute successor to visit and sort the list.
+            self.matched_nodes_list.append([v_first.node_id, v_first])
+            self.matched_nodes_list.sort(key=lambda x: x[1].successorstovisit)
+
+            # If the node is blocked and already matched go to the end
+            if v[1].isblocked | (v[1].matchedwith != []):
+                continue
+
+            # Search for potential candidates in the template
+            self._find_forward_candidates(v_first.matchedwith[0])
+
+            qarg1 = self.circuit_dag_dep.get_node(label).qindices
+            carg1 = self.circuit_dag_dep.get_node(label).cindices
+
+            # Update the indices for both qubits and clbits in order to be comparable with  the
+            # indices in the template circuit.
+            self._update_qarg_indices(qarg1)
+            self._update_carg_indices(carg1)
+
+            match = False
+
+            # For loop over the candidates (template) to find a match.
+            for i in self.candidates:
+
+                # Break the for loop if a match is found.
+                if match:
+                    break
+
+                # Compare the indices of qubits and the operation,
+                # if True; a match is found
+                node_circuit = self.circuit_dag_dep.get_node(label)
+                node_template = self.template_dag_dep.get_node(i)
+
+                # Necessary but not sufficient conditions for a match to happen.
+                if (
+                    len(self.qarg_indices) != len(node_template.qindices)
+                    or set(self.qarg_indices) != set(node_template.qindices)
+                    or node_circuit.name != node_template.name
+                ):
+                    continue
+
+                # Check if the qubit, clbit configuration are compatible for a match,
+                # also check if the operation are the same.
+                if (
+                    self._is_same_q_conf(node_circuit, node_template)
+                    and self._is_same_c_conf(node_circuit, node_template)
+                    and self._is_same_op(node_circuit, node_template)
+                ):
+
+                    v[1].matchedwith = [i]
+
+                    self.template_dag_dep.get_node(i).matchedwith = [label]
+
+                    # Append the new match to the list of matches.
+                    self.match.append([i, label])
+
+                    # Potential successors to visit (circuit) for a given match.
+                    potential = self.circuit_dag_dep.direct_successors(label)
+
+                    # If the potential successors to visit are blocked or match, it is removed.
+                    for potential_id in potential:
+                        if self.circuit_dag_dep.get_node(potential_id).isblocked | (
+                            self.circuit_dag_dep.get_node(potential_id).matchedwith != []
+                        ):
+                            potential.remove(potential_id)
+
+                    sorted_potential = sorted(potential)
+
+                    #  Update the successor to visit attribute
+                    v[1].successorstovisit = sorted_potential
+
+                    # Add the updated node to the stack.
+                    self.matched_nodes_list.append([v[0], v[1]])
+                    self.matched_nodes_list.sort(key=lambda x: x[1].successorstovisit)
+                    match = True
+                    continue
+
+            # If no match is found, block the node and all the successors.
+            if not match:
+                v[1].isblocked = True
+                for succ in v[1].successors:
+                    self.circuit_dag_dep.get_node(succ).isblocked = True
+                    if self.circuit_dag_dep.get_node(succ).matchedwith:
+                        self.match.remove(
+                            [self.circuit_dag_dep.get_node(succ).matchedwith[0], succ]
+                        )
+                        match_id = self.circuit_dag_dep.get_node(succ).matchedwith[0]
+                        self.template_dag_dep.get_node(match_id).matchedwith = []
+                        self.circuit_dag_dep.get_node(succ).matchedwith = []

qiskit/transpiler/passes/optimization/template_matching/maximal_matches.py

@@ -0,0 +1,77 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2020.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""
+It stores all maximal matches from the given matches obtained by the template
+matching algorithm.
+"""
+
+
+class Match:
+    """
+    Class Match is an object to store a list of match with its qubits and
+    clbits configuration.
+    """
+
+    def __init__(self, match, qubit, clbit):
+        """
+        Create a Match with necessary arguments.
+        Args:
+            match (list): list of a match.
+            qubit (list): list of qubits configuration.
+            clbit (list): list of clbits configuration.
+        """
+
+        self.match = match
+        self.qubit = qubit
+        self.clbit = clbit
+
+
+class MaximalMatches:
+    """
+    Class MaximalMatches allows to sort and store the maximal matches from the list
+    of matches obtained with the template matching algorithm.
+    """
+
+    def __init__(self, template_matches):
+        """
+        Initialize MaximalMatches with the necessary arguments.
+        Args:
+            template_matches (list): list of matches obtained from running the algorithm.
+        """
+        self.template_matches = template_matches
+
+        self.max_match_list = []
+
+    def run_maximal_matches(self):
+        """
+        Method that extracts and stores maximal matches in decreasing length order.
+        """
+
+        self.max_match_list = [
+            Match(
+                sorted(self.template_matches[0].match),
+                self.template_matches[0].qubit,
+                self.template_matches[0].clbit,
+            )
+        ]
+
+        for matches in self.template_matches[1::]:
+            present = False
+            for max_match in self.max_match_list:
+                for elem in matches.match:
+                    if elem in max_match.match and len(matches.match) <= len(max_match.match):
+                        present = True
+            if not present:
+                self.max_match_list.append(
+                    Match(sorted(matches.match), matches.qubit, matches.clbit)
+                )