Module quaternion_djs.tests.test_quaternion

The test suite & functions for testing the Quaternion class.

Functions

def unit_quaternion() ‑> dict[str, int]

Return a dict representing the unit quaternion, used for testing.

Returns

dict[str,int]

The dict with the corresponding x,i,j,k values (all equal to 1).

Classes

class TestQuaternion

The class containing all the tests for the Quaternion class.

Expand source code

class TestQuaternion:
    """The class containing all the tests for the Quaternion class."""

    @pytest.mark.parametrize("entry", ["x", "i", "j", "k"])
    def test_init_variable_type(self, entry: str):
        """
        Test that the class is initialized correctly.

        Parameters
        ----------
        entry : str
            The key to be changed to an incorrect type.
        """
        with pytest.raises(TypeError, match="must be"):
            vals = unit_quaternion()
            vals[entry] = dict()
            Quaternion(**vals)

    def test_init_norm(self):
        """Test the norm is calculated correctly."""
        # assert that the norm is as expected
        assert Quaternion(**unit_quaternion()).norm == 4

    def test__type_check(self):
        """Test that the internal type checking works correctly."""
        quaternion = Quaternion(**unit_quaternion())

        with pytest.raises(NotImplementedError, match="unsupported operation for: "):
            quaternion._type_check(dict())

        assert quaternion._type_check(Quaternion()) is None

    def test_eq(self):
        """Test that the equal method works."""
        # get two instances of the same quaternion
        quaternion_unit_1 = Quaternion(**unit_quaternion())
        quaternion_unit_2 = Quaternion(**unit_quaternion())

        # get a different quaternion
        quaternion_zero = Quaternion()

        # assert the two that the two that are the same work
        assert quaternion_unit_1 == quaternion_unit_2
        # assert that two different ones work
        assert quaternion_unit_1 != quaternion_zero

    def test_str(self):
        """Test that the str method works."""
        # assert that the str rep is as expected
        assert str(Quaternion(0, 0.2, -1, 1)) == "0+0.2i-1j+1k"

    def test_repr(self):
        """Test that the repr method works."""
        # assert that the repr rep is as expected
        assert repr(Quaternion(-12, 6, 24, 12)) == "Quaternion(x=-12, i=6, j=24, k=12)"

    def test_add(self):
        """Test that the add method works."""
        # init quaternions
        quaternion_1 = Quaternion(0, 1, -1, 0.2)
        quaternion_unit = Quaternion(**unit_quaternion())
        quaternion_2 = Quaternion(1, 2, 0, 1.2)

        # assert addition is correct
        assert (quaternion_1 + quaternion_unit) == quaternion_2
        assert (quaternion_1 + 1) == Quaternion(1, 1, -1, 0.2)
        # test addition with wrong type
        with pytest.raises(NotImplementedError):
            quaternion_1 + dict()

    def test_right_add(self):
        """Test that the __radd__ method works."""
        # init quaternions
        quaternion_1 = Quaternion(0, 1, -1, 0.2)

        # assert addition is correct
        assert (1 + quaternion_1) == Quaternion(1, 1, -1, 0.2)
        # test addition with wrong type
        with pytest.raises(NotImplementedError):
            dict() + quaternion_1

    def test_sub(self):
        """Test that the sub method works."""
        # init quaternions
        quaternion_1 = Quaternion(0, 1, -1, 0.2)
        quaternion_unit = Quaternion(**unit_quaternion())
        quaternion_2 = Quaternion(1, 2, 0, 1.2)

        # assert addition is correct
        assert (quaternion_2 - quaternion_unit) == quaternion_1
        assert (quaternion_1 - 1) == Quaternion(-1, 1, -1, 0.2)
        # test subtraction with wrong type
        with pytest.raises(NotImplementedError):
            quaternion_1 - dict()

    def test_rsub(self):
        """Test that the rsub method works."""
        # init quaternions
        quaternion_1 = Quaternion(0, 1, -1, 0.2)

        # assert addition is correct
        assert (1 - quaternion_1) == Quaternion(1, -1, 1, -0.2)
        # test subtraction with wrong type
        with pytest.raises(NotImplementedError):
            dict() - quaternion_1

    def test_mul(self):
        """Test that __mul__ works."""
        # init quaternions
        quaternion_1 = Quaternion(1, 2, 3, 4)
        quaternion_2 = Quaternion(4, 3, 2, 1)
        quaternion_3 = Quaternion(-12, 6, 24, 12)
        # assert correct output
        assert (quaternion_1 * quaternion_2) == quaternion_3
        # assert non commute
        assert (quaternion_1 * quaternion_2) != (quaternion_2 * quaternion_1)
        # assert correct scalar
        assert (quaternion_1 * 2) == Quaternion(2, 4, 6, 8)
        # test multiply with wrong type
        with pytest.raises(NotImplementedError):
            quaternion_1 * dict()

    def test_r_mul(self):
        """Test that the __rmul__ works."""
        # init test quaternions
        quaternion_unit = Quaternion(**unit_quaternion())
        quaternion_2 = Quaternion(2, 2, 2, 2)
        quaternion_3 = Quaternion(0.2, 0.2, 0.2, 0.2)

        # check correct multiplication
        assert (2 * quaternion_unit) == quaternion_2
        assert (0.2 * quaternion_unit) == quaternion_3

        # test multiply with wrong type
        with pytest.raises(NotImplementedError):
            dict() * quaternion_unit

    def test_conjugate(self):
        """Test that conjugation works correctly."""
        # assert correct conjugation
        assert Quaternion(**unit_quaternion()).conjugate() == Quaternion(1, -1, -1, -1)

    def test_inverse(self):
        """Test that the inverse works correctly."""
        # assert correct inverse
        assert Quaternion(**unit_quaternion()).inverse() == Quaternion(
            1 / 4, -1 / 4, -1 / 4, -1 / 4
        )

    def test_truediv(self):
        """Test that the __truediv__ works."""
        # check when being divided by an int or float
        assert Quaternion(**unit_quaternion()) / 2 == Quaternion(
            1 / 2,
            1 / 2,
            1 / 2,
            1 / 2,
        )
        # check when being divided by a quaternion
        assert (
            Quaternion(**unit_quaternion()) / Quaternion(**unit_quaternion())
        ) == Quaternion(1)

    def test_rtruediv(self):
        """Test that __rtruediv__ works."""
        # check div works out to the same
        assert (1 / Quaternion(**unit_quaternion())) == Quaternion(
            **unit_quaternion()
        ).inverse()
        # test div with wrong type
        with pytest.raises(NotImplementedError):
            dict() / Quaternion(**unit_quaternion())

    def test_trace(self):
        """Check that the trace works correctly."""
        # Check trace is correctly calculated
        assert Quaternion(**unit_quaternion()).trace == 2

    def test_pure(self):
        """Check that the pure attribute works correctly."""
        # check non pure
        assert not Quaternion(**unit_quaternion()).pure
        # check pure
        assert Quaternion(i=1, j=1, k=1).pure

    def test_unit(self):
        """Test that the unit attribute works correctly."""
        # check unit
        assert Quaternion(0, 1).unit
        # check not unit
        assert not Quaternion(1, 1).unit

Methods

def test__type_check(self)

Test that the internal type checking works correctly.

def test_add(self)

Test that the add method works.

def test_conjugate(self)

Test that conjugation works correctly.

def test_eq(self)

Test that the equal method works.

def test_init_norm(self)

Test the norm is calculated correctly.

def test_init_variable_type(self, entry: str)

Test that the class is initialized correctly.

Parameters

entry : str

The key to be changed to an incorrect type.

def test_inverse(self)

Test that the inverse works correctly.

def test_mul(self)

Test that mul works.

def test_pure(self)

Check that the pure attribute works correctly.

def test_r_mul(self)

Test that the rmul works.

def test_repr(self)

Test that the repr method works.

def test_right_add(self)

Test that the radd method works.

def test_rsub(self)

Test that the rsub method works.

def test_rtruediv(self)

Test that rtruediv works.

def test_str(self)

Test that the str method works.

def test_sub(self)

Test that the sub method works.

def test_trace(self)

Check that the trace works correctly.

def test_truediv(self)

Test that the truediv works.

def test_unit(self)

Test that the unit attribute works correctly.