Skip to content

common

are_matrices_equivalent_up_to_global_phase(matrix_a, matrix_b)

Checks whether two matrices are equivalent up to a global phase.

Parameters:

Name Type Description Default
matrix_a NDArray[complex128]

first matrix.

 required
matrix_b NDArray[complex128]

second matrix.

 required

Returns:

Type Description
bool

Whether two matrices are equivalent up to a global phase.
Source code in opensquirrel/common.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def are_matrices_equivalent_up_to_global_phase(
    matrix_a: NDArray[np.complex128], matrix_b: NDArray[np.complex128]
) -> bool:
    """Checks whether two matrices are equivalent up to a global phase.

    Args:
        matrix_a: first matrix.
        matrix_b: second matrix.

    Returns:
        Whether two matrices are equivalent up to a global phase.
    """
    first_non_zero = next(
        (i, j) for i in range(matrix_a.shape[0]) for j in range(matrix_a.shape[1]) if abs(matrix_a[i, j]) > ATOL
    )

    if abs(matrix_b[first_non_zero]) < ATOL:
        return False

    phase_difference = matrix_a[first_non_zero] / matrix_b[first_non_zero]

    return np.allclose(matrix_a, phase_difference * matrix_b, atol=ATOL)

is_identity_matrix_up_to_a_global_phase(matrix)

Checks whether matrix is an identity matrix up to a global phase.

Parameters:

Name Type Description Default
matrix NDArray[complex128]

matrix to check.

 required

Returns: Whether matrix is an identity matrix up to a global phase.

Source code in opensquirrel/common.py 
59
60
61
62
63
64
65
66
67
def is_identity_matrix_up_to_a_global_phase(matrix: NDArray[np.complex128]) -> bool:
    """Checks whether matrix is an identity matrix up to a global phase.

    Args:
        matrix: matrix to check.
    Returns:
        Whether matrix is an identity matrix up to a global phase.
    """
    return are_matrices_equivalent_up_to_global_phase(matrix, np.eye(matrix.shape[0], dtype=np.complex128))

normalize_angle(x)

Normalize the angle to be in between the range of \((-\pi, \pi]\).

Parameters:

Name Type Description Default
x SupportsFloat

value to normalize.

 required

Returns:

Type Description
float

The normalized angle.
Source code in opensquirrel/common.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def normalize_angle(x: SupportsFloat) -> float:
    r"""Normalize the angle to be in between the range of $(-\pi, \pi]$.

    Args:
        x: value to normalize.

    Returns:
        The normalized angle.
    """
    x = float(x)
    t = x - tau * (x // tau + 1)
    if t < -tau / 2 + ATOL:
        t += tau
    elif t > tau / 2:
        t -= tau
    return t

repr_round(value, decimals=REPR_DECIMALS)

Given a numerical value (of type float, Axis, or NDArray[np.complex128]): - rounds it to REPR_DECIMALS, - converts it to string, and - removes the newlines.

Returns:

Type Description
str

A single-line string representation of a numerical value.
Source code in opensquirrel/common.py 
70
71
72
73
74
75
76
77
78
79
80
def repr_round(value: float | Axis | NDArray[np.complex128], decimals: int = REPR_DECIMALS) -> str:
    """
    Given a numerical value (of type `float`, `Axis`, or `NDArray[np.complex128]`):
    - rounds it to `REPR_DECIMALS`,
    - converts it to string, and
    - removes the newlines.

    Returns:
        A single-line string representation of a numerical value.
    """
    return f"{np.round(value, decimals)}".replace("\n", "")