Source code for mitiq.interface.mitiq_qiskit.conversions

# Copyright (C) 2020 Unitary Fund
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <>.

"""Functions to convert between Mitiq's internal circuit representation and
Qiskit's circuit representation.
import copy
from typing import List, Optional, Tuple, Any, Set
import re

import numpy as np

import cirq
from cirq.contrib.qasm_import import circuit_from_qasm
import qiskit

from mitiq.utils import _simplify_circuit_exponents

QASMType = str

def _remove_qasm_barriers(qasm: QASMType) -> QASMType:
    """Returns a copy of the input QASM with all barriers removed.

        qasm: QASM to remove barriers from.

        According to the OpenQASM 2.X language specification
        (, "Statements are separated by
        semicolons. Whitespace is ignored. The language is case sensitive.
        Comments begin with a pair of forward slashes and end with a new line."
    quoted_re = r"(?:\"[^\"]*?\")"
    statement_re = r"((?:[^;{}\"]*?" + quoted_re + r"?)*[;{}])?"
    comment_re = r"(\n?//[^\n]*(?:\n|$))?"
    statements_comments = re.findall(statement_re + comment_re, qasm)
    lines = []
    for statement, comment in statements_comments:
        if re.match(r"^\s*barrier(?:(?:\s+)|(?:;))", statement) is None:
            lines.append(statement + comment)
    return "".join(lines)

def _map_bit_index(
    bit_index: int, new_register_sizes: List[int]
) -> Tuple[int, int]:
    """Returns the register index and (qu)bit index in this register for the
    mapped bit_index.

        bit_index: Index of (qu)bit in the original register.
        new_register_sizes: List of sizes of the new registers.

        bit_index = 3, new_register_sizes = [2, 3]
        returns (1, 0), meaning the mapped (qu)bit is in the 1st new register
        and has index 0 in this register.

        The bit_index is assumed to come from a circuit with 1 or n registers
        where n is the maximum bit_index.
    max_indices_in_registers = np.cumsum(new_register_sizes) - 1

    # Could be faster via bisection.
    register_index = None
    for i in range(len(max_indices_in_registers)):
        if bit_index <= max_indices_in_registers[i]:
            register_index = i
    assert register_index is not None

    if register_index == 0:
        return register_index, bit_index

    return (
        bit_index - max_indices_in_registers[register_index - 1] - 1,

def _map_qubits(
    qubits: List[qiskit.circuit.Qubit],
    new_register_sizes: List[int],
    new_registers: List[qiskit.QuantumRegister],
) -> List[qiskit.circuit.Qubit]:
    """Maps qubits to new registers.

        qubits: A list of qubits to map.
        new_register_sizes: The size(s) of the new registers to map to.
            Note: These can be determined from ``new_registers``, but this
            helper function is only called from ``_transform_registers`` where
            the sizes are already computed.
        new_registers: The new registers to map the ``qubits`` to.

        The input ``qubits`` mapped to the ``new_registers``.
    indices = [bit.index for bit in qubits]
    mapped_indices = [_map_bit_index(i, new_register_sizes) for i in indices]
    return [
        qiskit.circuit.Qubit(new_registers[i], j) for i, j in mapped_indices

def _add_identity_to_idle(
    circuit: qiskit.QuantumCircuit,
) -> Set[int]:
    """Adds identities to idle qubits in the circuit and returns the altered
    indices. Used to preserve idle qubits and indices in conversion.

        circuit: Qiskit circuit to have identities added to idle qubits

        An unordered set of the indices that were altered

    Note: An idle qubit is a qubit without any gates (including Qiskit
        barriers) acting on it.

    data = copy.deepcopy(circuit._data)
    bit_indices = set()
    idle_bit_indices = set()
    for op in data:
        gate, qubits, cbits = op
        bit_indices.update(set(bit.index for bit in qubits))
    for index in range(circuit.num_qubits):
        if index not in bit_indices:
    return idle_bit_indices

def _remove_identity_from_idle(
    circuit: qiskit.QuantumCircuit,
    idle_indices: Set[int],
) -> None:
    """Removes identities from the circuit corresponding to the set of indices.
    Used in conjunction with _add_identity_to_idle to preserve idle qubits and
    indices in conversion.

        circuit: Qiskit circuit to have identities removed
        idle_indices: Set of altered idle qubit indices
    index_list: List[int] = []
    data = copy.deepcopy(circuit._data)
    for target_index, op in enumerate(data):
        bit_indices = set()
        gate, qubits, cbits = op
        bit_indices.update(set(bit.index for bit in qubits))
        if == "id" and bit_indices.intersection(idle_indices):
            # Reverse index list order for data index preservation
            index_list.insert(0, target_index)
    # Traverse data from list end to preserve index
    for target_index in index_list:
        del data[target_index]
    circuit._data = data

def _measurement_order(
    circuit: qiskit.QuantumCircuit,
) -> List[Tuple[Any, ...]]:
    """Returns the left-to-right measurement order in the circuit.

    The "measurement order" is a list of tuples (qubit, bit) involved in
    measurements ordered as they appear going left-to-right through the circuit
    (i.e., iterating through The purpose of this is to be able
    to do

    >>> for (qubit, bit) in _measurement_order(circuit):
    >>>     other_circuit.measure(qubit, bit)

    which ensures ``other_circuit`` has the same measurement order as
    ``circuit``, assuming ``other_circuit`` has the same register(s) as

        circuit: Qiskit circuit to get the measurement order of.
    order = []
    for (gate, qubits, cbits) in
        if isinstance(gate, qiskit.circuit.Measure):
            if len(qubits) != 1 or len(cbits) != 1:
                raise ValueError(
                    f"Only measurements with one qubit and one bit are "
                    f"supported, but this measurement has {len(qubits)} "
                    f"qubit(s) and {len(cbits)} bit(s). If you think this "
                    f"should be supported and is a bug, please open an issue "
            order.append((*qubits, *cbits))
    return order

def _transform_registers(
    circuit: qiskit.QuantumCircuit,
    new_qregs: Optional[List[qiskit.QuantumRegister]] = None,
) -> None:
    """Transforms the registers in the circuit to the new registers.

        circuit: Qiskit circuit with at most one quantum register.
        new_qregs: The new quantum registers for the circuit.

            * If the input circuit has more than one quantum register.
            * If the number of qubits in the new quantum registers is
            greater than the number of qubits in the circuit.
    if new_qregs is None:

    if len(circuit.qregs) > 1:
        raise ValueError(
            "Input circuit is required to have <= 1 quantum register but has "
            f"{len(circuit.qregs)} quantum registers."

    qreg_sizes = [qreg.size for qreg in new_qregs]
    nqubits_in_circuit = circuit.num_qubits

    if len(qreg_sizes) and sum(qreg_sizes) < nqubits_in_circuit:
        raise ValueError(
            f"The circuit has {nqubits_in_circuit} qubit(s), but the provided "
            f"quantum registers have {sum(qreg_sizes)} qubit(s)."

    # Copy the circuit data.
    data = copy.deepcopy(circuit._data)

    # Remove the old qubits and add the new ones.
    circuit._qubits = []
    circuit._qubit_set = set()
    circuit.qregs = []
    circuit._data = []
    circuit._qubit_indices = {}

    # Map the qubits in operations to the new qubits.
    for op in data:
        gate, qubits, cbits = op
        new_qubits = _map_qubits(qubits, qreg_sizes, new_qregs)
        circuit.append(gate, new_qubits, cbits)

[docs]def to_qasm(circuit: cirq.Circuit) -> QASMType: """Returns a QASM string representing the input Mitiq circuit. Args: circuit: Mitiq circuit to convert to a QASM string. Returns: QASMType: QASM string equivalent to the input Mitiq circuit. """ # Simplify exponents of gates. For example, H**-1 is simplified to H. _simplify_circuit_exponents(circuit) return circuit.to_qasm()
[docs]def to_qiskit(circuit: cirq.Circuit) -> qiskit.QuantumCircuit: """Returns a Qiskit circuit equivalent to the input Mitiq circuit. Note that the output circuit registers may not match the input circuit registers. Args: circuit: Mitiq circuit to convert to a Qiskit circuit. Returns: Qiskit.QuantumCircuit object equivalent to the input Mitiq circuit. """ return qiskit.QuantumCircuit.from_qasm_str(to_qasm(circuit))
[docs]def from_qiskit(circuit: qiskit.QuantumCircuit) -> cirq.Circuit: """Returns a Mitiq circuit equivalent to the input Qiskit circuit. Args: circuit: Qiskit circuit to convert to a Mitiq circuit. Returns: Mitiq circuit representation equivalent to the input Qiskit circuit. """ return from_qasm(circuit.qasm())
[docs]def from_qasm(qasm: QASMType) -> cirq.Circuit: """Returns a Mitiq circuit equivalent to the input QASM string. Args: qasm: QASM string to convert to a Mitiq circuit. Returns: Mitiq circuit representation equivalent to the input QASM string. """ qasm = _remove_qasm_barriers(qasm) return circuit_from_qasm(qasm)