Skip to content

qoolqit.register

register

Classes:

  • Register –

    The Register in QoolQit, representing a set of qubits with coordinates.

Register 

Register(qubits: dict)

The Register in QoolQit, representing a set of qubits with coordinates.

Parameters:

  • qubits (dict) –

    a dictionary of qubits and respective coordinates {q: (x, y), ...}.

Returned by: Used by:

Methods:

Attributes:

  • n_qubits (int) –

    Number of qubits in the Register.

  • qubits (dict) –

    Returns the dictionary of qubits and respective coordinates.

  • qubits_ids (list) –

    Returns the qubit keys.

Source code in qoolqit/register.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
def __init__(self, qubits: dict) -> None:
    """Default constructor for the Register.

    Arguments:
        qubits: a dictionary of qubits and respective coordinates {q: (x, y), ...}.
    """
    if not isinstance(qubits, dict):
        raise TypeError(
            "Register must be initialized with a dictionary of "
            "qubits and respective coordinates {q: (x, y), ...}."
        )

    self._qubits: dict = qubits

n_qubits property 

n_qubits: int

Number of qubits in the Register.

qubits property 

qubits: dict

Returns the dictionary of qubits and respective coordinates.

qubits_ids property 

qubits_ids: list

Returns the qubit keys.

distances 

distances() -> dict

Distance between each qubit pair.

Source code in qoolqit/register.py 
72
73
74
75
def distances(self) -> dict:
    """Distance between each qubit pair."""
    pairs = all_node_pairs(list(self.qubits.keys()))
    return distances(self.qubits, pairs)

draw 

draw(
    ax: Axes | None = None, marker_size: int = 100
) -> None

Draw the register.

Parameters:

  • ax (Axes | None, default: None ) –

    an optional matplotlib Axes instance to draw on. If None, a new Axes will be created.

  • marker_size (int, default: 100 ) –

    size of the qubit markers in points squared. Defaults to 100.

Source code in qoolqit/register.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
def draw(self, ax: Axes | None = None, marker_size: int = 100) -> None:
    """Draw the register.

    Args:
        ax: an optional matplotlib Axes instance to draw on.
            If None, a new Axes will be created.
        marker_size: size of the qubit markers in points squared. Defaults to 100.
    """
    if ax is None:
        _, ax = plt.subplots()

    marker_radius = marker_size**0.5 / 2  # in points
    annotation_offset = 1.5 * marker_radius  # place label just outside the marker

    x, y = zip(*self.qubits.values())
    ax.scatter(x, y, s=marker_size, color="green")

    for i, qubit_id in enumerate(self.qubits_ids):
        ax.annotate(
            qubit_id,
            xy=(x[i], y[i]),
            xytext=(annotation_offset, annotation_offset),
            textcoords="offset points",
            ha="center",
            va="center",
        )

    ax.grid(True, color="lightgray", linestyle="--", linewidth=0.7)
    ax.set_axisbelow(True)
    ax.set_xlabel("x")
    ax.set_ylabel("y")
    ax.margins(0.1)

from_coordinates classmethod 

from_coordinates(coords: list) -> Register

Initializes a Register from a list of coordinates.

Parameters:

  • coords (list) –

    a list of coordinates [(x, y), ...]

Source code in qoolqit/register.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
@classmethod
def from_coordinates(cls, coords: list) -> Register:
    """Initializes a Register from a list of coordinates.

    Arguments:
        coords: a list of coordinates [(x, y), ...]
    """
    if not isinstance(coords, list):
        raise TypeError(
            "Register must be initialized with a dictionary of qubit and coordinates."
        )
    coords_dict = {i: pos for i, pos in enumerate(coords)}
    return cls(coords_dict)

from_graph classmethod 

from_graph(graph: DataGraph) -> Register

Initializes a Register from a graph that has coordinates.

Parameters:

  • graph (DataGraph) –

    a DataGraph instance.

Source code in qoolqit/register.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
@classmethod
def from_graph(cls, graph: DataGraph) -> Register:
    """Initializes a Register from a graph that has coordinates.

    Arguments:
        graph: a DataGraph instance.
    """

    if not graph.has_coords:
        raise ValueError("Initializing a register from a graph requires node coordinates.")

    if len(graph.nodes) == 0:
        raise ValueError("Trying to initialize a register from an empty graph.")

    return cls(graph.coords)

interactions 

interactions() -> dict

Interaction 1/r^6 between each qubit pair.

Source code in qoolqit/register.py 
91
92
93
def interactions(self) -> dict:
    """Interaction 1/r^6 between each qubit pair."""
    return {p: 1.0 / (r**6) for p, r in self.distances().items()}

max_radial_distance 

max_radial_distance() -> float

Maximum radial distance between all qubits.

Source code in qoolqit/register.py 
86
87
88
89
def max_radial_distance(self) -> float:
    """Maximum radial distance between all qubits."""
    max_radial_distance: float = max(self.radial_distances().values())
    return max_radial_distance

min_distance 

min_distance() -> float

Minimum distance between all qubit pairs.

Source code in qoolqit/register.py 
77
78
79
80
def min_distance(self) -> float:
    """Minimum distance between all qubit pairs."""
    distance: float = min(self.distances().values())
    return distance

radial_distances 

radial_distances() -> dict

Radial distance of each qubit from the origin.

Source code in qoolqit/register.py 
82
83
84
def radial_distances(self) -> dict:
    """Radial distance of each qubit from the origin."""
    return radial_distances(self.qubits)