Merge pull request #406 from QuTech-Delft/CQT-289-Avoid-creating-an-Axis-0-0-0

[CQT-289] Avoid creating an Axis (0, 0, 0)

Author: GuyPuts

opensquirrel/ir.py

@@ -214,7 +214,7 @@ def __init__(self, *axis: AxisLike) -> None:
         axis: An ``AxisLike`` to create the axis from.
         """
         axis_to_parse = axis[0] if len(axis) == 1 else cast(AxisLike, axis)
-        self._value = self._parse_and_validate_axislike(axis_to_parse)
+        self._value = self.normalize(self.parse(axis_to_parse))
 
     @property
     def value(self) -> NDArray[np.float64]:
@@ -228,10 +228,11 @@ def value(self, axis: AxisLike) -> None:
         Args:
             axis: An ``AxisLike`` to create the axis from.
         """
-        self._value = self._parse_and_validate_axislike(axis)
+        self._value = self.parse(axis)
+        self._value = self.normalize(self._value)
 
-    @classmethod
-    def _parse_and_validate_axislike(cls, axis: AxisLike) -> NDArray[np.float64]:
+    @staticmethod
+    def parse(axis: AxisLike) -> NDArray[np.float64]:
         """Parse and validate an ``AxisLike``.
 
         Check if the `axis` can be cast to a 1DArray of length 3, raise an error otherwise.
@@ -255,10 +256,13 @@ def _parse_and_validate_axislike(cls, axis: AxisLike) -> NDArray[np.float64]:
         if len(axis) != 3:
             msg = f"axis requires an ArrayLike of length 3, but received an ArrayLike of length {len(axis)}"
             raise ValueError(msg)
-        return cls._normalize_axis(axis)
+        if np.all(axis == 0):
+            msg = "axis requires at least one element to be non-zero"
+            raise ValueError(msg)
+        return axis
 
     @staticmethod
-    def _normalize_axis(axis: NDArray[np.float64]) -> NDArray[np.float64]:
+    def normalize(axis: NDArray[np.float64]) -> NDArray[np.float64]:
         """Normalize a NDArray.
 
         Args:

test/test_ir.py

@@ -6,12 +6,13 @@
 
 import numpy as np
 import pytest
-from numpy.typing import ArrayLike
+from numpy.typing import NDArray
 
 from opensquirrel import I
 from opensquirrel.common import ATOL
 from opensquirrel.ir import (
     Axis,
+    AxisLike,
     Bit,
     BlochSphereRotation,
     ControlledGate,
@@ -44,7 +45,7 @@ def test_axis_getter(self, axis: Axis) -> None:
             (Axis(0, 1, 0), [0, 1, 0]),
         ],
     )
-    def test_axis_setter_no_error(self, axis: Axis, new_axis: ArrayLike, expected_axis: ArrayLike) -> None:
+    def test_axis_setter_no_error(self, axis: Axis, new_axis: AxisLike, expected_axis: list[float]) -> None:
         axis.value = new_axis  # type: ignore[assignment]
         np.testing.assert_array_equal(axis, expected_axis)
 
@@ -59,6 +60,7 @@ def test_axis_setter_no_error(self, axis: Axis, new_axis: ArrayLike, expected_ax
                 ValueError,
                 "axis requires an ArrayLike of length 3, but received an ArrayLike of length 4",
             ),
+            ([0, 0, 0], ValueError, "axis requires at least one element to be non-zero"),
         ],
     )
     def test_axis_setter_with_error(
@@ -93,6 +95,63 @@ def test_eq_true(self, axis: Axis, other: Any) -> None:
     def test_eq_false(self, axis: Axis, other: Any) -> None:
         assert axis != other
 
+    @pytest.mark.parametrize(
+        ("axis", "expected"),
+        [
+            ([1, 0, 0], np.array([1, 0, 0], dtype=np.float64)),
+            ([0, 0, 0], ValueError),
+            ([1, 2], ValueError),
+            ([1, 2, 3, 4], ValueError),
+            ([0, 1, 0], np.array([0, 1, 0], dtype=np.float64)),
+            (["a", "b", "c"], TypeError),
+        ],
+    )
+    def test_constructor(self, axis: AxisLike, expected: Any) -> None:
+        if isinstance(expected, type) and issubclass(expected, Exception):
+            with pytest.raises(expected):
+                Axis(axis)
+        else:
+            assert isinstance(expected, np.ndarray)
+            obj = Axis(axis)
+            np.testing.assert_array_equal(obj.value, expected)
+
+    @pytest.mark.parametrize(
+        ("axis", "expected"),
+        [
+            ([1, 0, 0], np.array([1, 0, 0], dtype=np.float64)),
+            ([0, 0, 0], ValueError),
+            ([1, 2], ValueError),
+            ([1, 2, 3, 4], ValueError),
+            ([0, 1, 0], np.array([0, 1, 0], dtype=np.float64)),
+            (["a", "b", "c"], TypeError),
+        ],
+    )
+    def test_parse(self, axis: AxisLike, expected: Any) -> None:
+        if isinstance(expected, type) and issubclass(expected, Exception):
+            with pytest.raises(expected):
+                Axis.parse(axis)
+        else:
+            assert isinstance(expected, np.ndarray)
+            obj = Axis.parse(axis)
+            np.testing.assert_array_equal(obj, expected)
+
+    @pytest.mark.parametrize(
+        ("axis", "expected"),
+        [
+            (np.array([1, 0, 0], dtype=np.float64), np.array([1, 0, 0], dtype=np.float64)),
+            (np.array([0, 1, 0], dtype=np.float64), np.array([0, 1, 0], dtype=np.float64)),
+            (np.array([0, 0, 1], dtype=np.float64), np.array([0, 0, 1], dtype=np.float64)),
+            (
+                np.array([1, 1, 1], dtype=np.float64),
+                np.array([1 / np.sqrt(3), 1 / np.sqrt(3), 1 / np.sqrt(3)], dtype=np.float64),
+            ),
+        ],
+    )
+    def test_normalize(self, axis: AxisLike, expected: NDArray[np.float64]) -> None:
+        obj = Axis.normalize(np.array(axis, dtype=np.float64))
+        assert isinstance(expected, np.ndarray)
+        np.testing.assert_array_almost_equal(obj, expected)
+
 
 class TestIR:
     def test_cnot_equality(self) -> None: