Skip to content

register_manager

BitRegister

Bases: Register

BitRegister manages a (virtual) bit register.

Source code in opensquirrel/register_manager.py 
66
67
68
69
70
71
72
class BitRegister(Register):
    """BitRegister manages a (virtual) bit register."""

    _default_name: str = DEFAULT_BIT_REGISTER_NAME

    def __init__(self, size: int, name: str = _default_name) -> None:
        super().__init__(size, name=name)

QubitRegister

Bases: Register

QubitRegister manages a (virtual) qubit register.

Source code in opensquirrel/register_manager.py 
57
58
59
60
61
62
63
class QubitRegister(Register):
    """QubitRegister manages a (virtual) qubit register."""

    _default_name: str = DEFAULT_QUBIT_REGISTER_NAME

    def __init__(self, size: int, name: str = _default_name) -> None:
        super().__init__(size, name=name)

Register

Register manages a (virtual) register.

Source code in opensquirrel/register_manager.py 
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
46
47
48
49
50
51
52
53
54
class Register:
    """Register manages a (virtual) register."""

    def __init__(
        self,
        size: int,
        name: str,
        virtual_zero_index: int = 0,
    ) -> None:
        self._size = size
        self._name = name
        self._virtual_zero_index = virtual_zero_index

    @property
    def name(self) -> str:
        return self._name

    @property
    def size(self) -> int:
        return self._size

    @property
    def virtual_zero_index(self) -> int:
        return self._virtual_zero_index

    @virtual_zero_index.setter
    def virtual_zero_index(self, value: int) -> None:
        self._virtual_zero_index = value

    def __getitem__(self, index: int) -> Any:
        if abs(index) > self._size:
            msg = f"Index {index} is out of range"
            raise IndexError(msg)
        size = self._size if index < 0 else 0
        return self._virtual_zero_index + index + size

    def __eq__(self, other: Any) -> bool:
        if not isinstance(other, Register):
            return False
        return (
            self.size == other.size and self.name == other.name and self.virtual_zero_index == other.virtual_zero_index
        )

    def __repr__(self) -> str:
        return f"{type(self)}: {self.name}, {self.size}"