Skip to content

mapping

Mapping

A Mapping is a dictionary where
  • the keys are virtual qubit indices (from 0 to virtual_qubit_register_size-1), and
  • the values are physical qubit indices.

Parameters:

Name Type Description Default
physical_qubit_register list[int]

a list of physical qubit indices.

 required

Raises:

Type Description
ValueError

If the mapping is incorrect.
Source code in opensquirrel\mapper\mapping.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class Mapping:
    """A Mapping is a dictionary where:
       - the keys are virtual qubit indices (from 0 to virtual_qubit_register_size-1), and
       - the values are physical qubit indices.

    Args:
        physical_qubit_register: a list of physical qubit indices.

    Raises:
        ValueError: If the mapping is incorrect.
    """

    def __init__(self, physical_qubit_register: list[int]) -> None:
        self.data: dict[int, int] = dict(enumerate(physical_qubit_register))
        if (self.data.keys()) != set(self.data.values()):
            msg = "the mapping is incorrect"
            raise ValueError(msg)

    def __eq__(self, other: Any) -> bool:
        if not isinstance(other, Mapping):
            return False
        return self.data == other.data

    def __getitem__(self, key: int) -> int:
        return self.data[key]

    def __len__(self) -> int:
        return len(self.data)

    def size(self) -> int:
        return len(self.data)

    def items(self) -> list[tuple[int, int]]:
        return list(self.data.items())

    def keys(self) -> list[int]:
        return list(self.data.keys())

    def values(self) -> list[int]:
        return list(self.data.values())