Source code for bqskit.passes.mapping.setmodel

"""This module implements the SetModelPass class."""
from __future__ import annotations

import logging

from bqskit.compiler.basepass import BasePass
from bqskit.compiler.machine import MachineModel
from bqskit.compiler.passdata import PassData
from bqskit.ir.circuit import Circuit
from bqskit.qis.graph import CouplingGraph

_logger = logging.getLogger(__name__)




class SetModelPass(BasePass):
    """Sets a target machine model for future passes to target."""



    def __init__(self, model: MachineModel) -> None:
        """
        Construct a SetModelPass.

        Args:
            model (MachineModel | None): The machine model to encode
                into the compilation workflow.
        """
        if not isinstance(model, MachineModel):
            raise TypeError(f'Expected MachineModel, got: {type(model)}.')

        self.model = model




    async def run(self, circuit: Circuit, data: PassData) -> None:
        """Perform the pass's operation, see :class:`BasePass` for more."""
        if self.model.num_qudits < circuit.num_qudits:
            raise RuntimeError('Machine model is too small for circuit.')

        data.model = self.model  # Update Model
        data.placement = list(range(circuit.num_qudits))  # Reset placement






class ExtractModelConnectivityPass(BasePass):
    """
    Extracts and saves the current target machine model's connectivity.

    The model will remain unchanged except that it will be fully connected until
    the RestoreModelConnevtivityPass is executed.
    """

    key = '_ExtractModelConnectivityPass_connectivity'



    async def run(self, circuit: Circuit, data: PassData) -> None:
        """Perform the pass's operation, see :class:`BasePass` for more."""
        data[self.key] = data.model.coupling_graph
        data.model.coupling_graph = CouplingGraph.all_to_all(
            data.model.num_qudits,
        )






class RestoreModelConnevtivityPass(BasePass):
    """Restores the connectivity of the target machine model."""



    async def run(self, circuit: Circuit, data: PassData) -> None:
        """Perform the pass's operation, see :class:`BasePass` for more."""
        if ExtractModelConnectivityPass.key not in data:
            raise RuntimeError(
                'Cannot restore connectivity without first '
                'extracting it using ExtractModelConnectivityPass.',
            )

        data.model.coupling_graph = data[ExtractModelConnectivityPass.key]
        del data[ExtractModelConnectivityPass.key]