qiskit_pytest_helper.assertions

Assertions comparing quantum states and operators with Qiskit's equality.

The comparisons are exact, global phase included, up to the default tolerances of Qiskit's Statevector and Operator equality, instead of tolerances chosen per test. Circuits are compared by what they do: the state they prepare from |0...0>, or their unitary.

Functions:

• assert_equal_states –

  Assert that two states are equal, including their global phase.

• assert_equal_operators –

  Assert that two operators are equal, including their global phase.

• assert_unitary –

  Assert that an operator, e.g. a matrix, is unitary.

assert_equal_states

assert_equal_states(actual: Any, expected: Any) -> None

Assert that two states are equal, including their global phase.

Parameters:

• actual (Any) –

  The state, as a Statevector, its amplitudes or a circuit preparing it from |0...0>.

• expected (Any) –

  The expected state, in any of the same forms.

Source code in packages-dev/qiskit-pytest-helper/src/qiskit_pytest_helper/assertions.py

def assert_equal_states(actual: Any, expected: Any) -> None:
    """Assert that two states are equal, including their global phase.

    Args:
        actual: The state, as a `Statevector`, its amplitudes or a circuit preparing
            it from `|0...0>`.
        expected: The expected state, in any of the same forms.
    """
    actual_state, expected_state = Statevector(actual), Statevector(expected)
    assert actual_state.dims() == expected_state.dims(), (
        f"The states have the dimensions {actual_state.dims()} and "
        f"{expected_state.dims()}."
    )
    assert actual_state == expected_state, (
        "The states differ: the largest amplitude deviation is "
        f"{_max_deviation(actual_state.data, expected_state.data)}, the fidelity is "
        f"{state_fidelity(actual_state, expected_state, validate=False)}.\n"
        f"actual:   {actual_state.data}\nexpected: {expected_state.data}"
    )

assert_equal_operators

assert_equal_operators(actual: Any, expected: Any) -> None

Assert that two operators are equal, including their global phase.

Parameters:

• actual (Any) –

  The operator, as an Operator, its matrix, a gate or a circuit.

• expected (Any) –

  The expected operator, in any of the same forms.

Source code in packages-dev/qiskit-pytest-helper/src/qiskit_pytest_helper/assertions.py

def assert_equal_operators(actual: Any, expected: Any) -> None:
    """Assert that two operators are equal, including their global phase.

    Args:
        actual: The operator, as an `Operator`, its matrix, a gate or a circuit.
        expected: The expected operator, in any of the same forms.
    """
    actual_operator, expected_operator = Operator(actual), Operator(expected)
    assert actual_operator.dim == expected_operator.dim, (
        f"The operators have the dimensions {actual_operator.dim} and "
        f"{expected_operator.dim}."
    )
    assert actual_operator == expected_operator, (
        "The operators differ: the largest entry deviation is "
        f"{_max_deviation(actual_operator.data, expected_operator.data)}; up to a "
        "global phase, they are "
        f"{'equal' if actual_operator.equiv(expected_operator) else 'different'}."
    )

assert_unitary

assert_unitary(operator: Any) -> None

Assert that an operator, e.g. a matrix, is unitary.

Source code in packages-dev/qiskit-pytest-helper/src/qiskit_pytest_helper/assertions.py

def assert_unitary(operator: Any) -> None:
    """Assert that an operator, e.g. a matrix, is unitary."""
    assert Operator(operator).is_unitary(), f"Not unitary:\n{Operator(operator).data}"