common

are_matrices_equivalent_up_to_global_phase

are_matrices_equivalent_up_to_global_phase(
    matrix_a: NDArray[complex128],
    matrix_b: NDArray[complex128],
) -> bool

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	True if two matrices are equivalent up to a global phase, otherwise False.

Source code in opensquirrel/common.py

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 (NDArray[np.complex128]): first matrix.
        matrix_b (NDArray[np.complex128]): second matrix.

    Returns:
        True if two matrices are equivalent up to a global phase, otherwise False.

    """
    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

is_identity_matrix_up_to_a_global_phase(
    matrix: NDArray[complex128],
) -> bool

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:

Type	Description
bool	True if matrix is an identity matrix up to a global phase, otherwise False.

Source code in opensquirrel/common.py

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 (NDArray[np.complex128]): matrix to check.

    Returns:
        True if matrix is an identity matrix up to a global phase, otherwise False.

    """
    return are_matrices_equivalent_up_to_global_phase(matrix, np.eye(matrix.shape[0], dtype=np.complex128))

normalize_angle

normalize_angle(x: SupportsFloat) -> float

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

def normalize_angle(x: SupportsFloat) -> float:
    """Normalize the angle to be in between the range of $(-\\pi, \\pi]$.

    Args:
        x (SupportsFloat): 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

repr_round(
    value: float | BaseAxis | NDArray[complex128],
    decimals: int = REPR_DECIMALS,
) -> str

Given a numerical value:

• rounds it to REPR_DECIMALS,
• converts it to string, and
• removes any newlines.

Parameters:

Name	Type	Description	Default
value	float | BaseAxis | NDArray[complex128]	The numerical value to represent.	required
decimals	int	Number of decimals to round to. Default is REPR_DECIMALS.	REPR_DECIMALS

Returns:

Type	Description
str	A single-line string representation of a rounded numerical value.

Source code in opensquirrel/common.py

def repr_round(value: float | BaseAxis | NDArray[np.complex128], decimals: int = REPR_DECIMALS) -> str:
    """Given a numerical value:

    - rounds it to `REPR_DECIMALS`,
    - converts it to string, and
    - removes any newlines.

    Args:
        value (float | BaseAxis | NDArray[np.complex128]): The numerical value to represent.
        decimals (int): Number of decimals to round to. Default is `REPR_DECIMALS`.

    Returns:
        A single-line string representation of a rounded numerical value.

    """
    return f"{np.round(value, decimals)}".replace("\n", "")