Skip to content

general_mapper

This module contains generic mapping components.

Mapper

Base class for the Mapper pass.

Source code in opensquirrel\mapper\general_mapper.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
class Mapper:
    """Base class for the Mapper pass."""

    def __init__(self, qubit_register_size: int, mapping: Mapping | None = None) -> None:
        """Use ``IdentityMapper`` as the fallback case for ``Mapper``"""
        physical_qubit_register = list(range(qubit_register_size))
        self.mapping = mapping if mapping is not None else Mapping(physical_qubit_register)

        if qubit_register_size != self.mapping.size():
            msg = "qubit register size and mapping size differ"
            raise ValueError(msg)

    def get_mapping(self) -> Mapping:
        """Get mapping."""
        return self.mapping

__init__(qubit_register_size, mapping=None)

Use IdentityMapper as the fallback case for Mapper

Source code in opensquirrel\mapper\general_mapper.py 
11
12
13
14
15
16
17
18
def __init__(self, qubit_register_size: int, mapping: Mapping | None = None) -> None:
    """Use ``IdentityMapper`` as the fallback case for ``Mapper``"""
    physical_qubit_register = list(range(qubit_register_size))
    self.mapping = mapping if mapping is not None else Mapping(physical_qubit_register)

    if qubit_register_size != self.mapping.size():
        msg = "qubit register size and mapping size differ"
        raise ValueError(msg)

get_mapping()

Get mapping.

Source code in opensquirrel\mapper\general_mapper.py 
20
21
22
def get_mapping(self) -> Mapping:
    """Get mapping."""
    return self.mapping