Add vector primitives

pyproject.toml

@@ -28,6 +28,7 @@ packages = [
 [tool.poetry.dependencies]
 python = ">=3.7,<4.0"
 importlib-metadata = {version = "^4.0", python = "<3.8"}
+numpy = ">=1.20.3"
 
 # Optional dependencies
 ansys-sphinx-theme = {version = "==0.5.2", optional = true}

src/ansys/geometry/core/primitives/__init__.py

@@ -2,5 +2,7 @@
 
 from ansys.geometry.core.primitives.direction import Direction
 from ansys.geometry.core.primitives.point3D import Point3D
+from ansys.geometry.core.primitives.vector3D import Vector3D
+from ansys.geometry.core.primitives.vectorUV import VectorUV
 
-__all__ = ["Direction", "Point3D"]
+__all__ = ["Direction", "Point3D", "Vector3D", "VectorUV"]

src/ansys/geometry/core/primitives/vector3D.py

@@ -0,0 +1,69 @@
+"""``Vector3D`` class module"""
+import numpy as np
+
+
+class Vector3D(np.ndarray):
+    """Provides 3D vector class.
+
+    Parameters
+    ----------
+    array_input : np.ndarray
+        One dimensional numpy.ndarray with shape(3,)
+    """
+
+    def __new__(cls, array_input):
+        """Constructor for Vector3D"""
+
+        vector = np.asarray(array_input).view(cls)
+
+        if len(vector) != 3:
+            raise ValueError("Vector3D must have three coordinates.")
+
+        if not np.issubdtype(vector.dtype, np.number) or not all(
+            isinstance(data, (int, float)) for data in vector.data
+        ):
+            raise ValueError("The parameters of 'array_inputs' should be integer or float.")
+
+        return vector
+
+    @property
+    def x(self) -> float:
+        """X coordinate of Vector3D"""
+        return self[0]
+
+    @x.setter
+    def x(self, value: float) -> None:
+        self[0] = value
+
+    @property
+    def y(self) -> float:
+        """Y coordinate of Vector3D"""
+        return self[1]
+
+    @y.setter
+    def y(self, value: float) -> None:
+        self[1] = value
+
+    @property
+    def z(self) -> float:
+        """Z coordinate of Vector3D"""
+        return self[2]
+
+    @z.setter
+    def z(self, value: float) -> None:
+        self[2] = value
+
+    @property
+    def norm(self):
+        norm = np.linalg.norm(self)
+        if norm == 0:
+            norm = np.finfo(self.dtype).eps
+        return norm
+
+    def normalize(self):
+        """Return a normalized version of the vector"""
+        return self / self.norm
+
+    def cross(self, v: "Vector3D") -> "Vector3D":
+        """Return cross product of vector"""
+        return Vector3D(np.cross(self, v))

src/ansys/geometry/core/primitives/vectorUV.py

@@ -0,0 +1,54 @@
+import numpy as np
+
+
+class VectorUV(np.ndarray):
+    """A two-dimensional vector with Cartesian coordinates.
+
+    Parameters
+    ----------
+    array_input : np.ndarray
+        One dimensional numpy.ndarray with shape(2,)
+    """
+
+    def __new__(cls, array_input):
+
+        vector = np.asarray(array_input).view(cls)
+
+        if len(vector) != 2:
+            raise ValueError("VectorUV must have two coordinates.")
+
+        if not np.issubdtype(vector.dtype, np.number) or not all(
+            isinstance(data, (int, float)) for data in vector.data
+        ):
+            raise ValueError("The parameters of 'array_input' should be integer or float.")
+
+        return vector
+
+    @property
+    def x(self) -> float:
+        """Returns X coordinate of VectorUV"""
+        return self[0]
+
+    @x.setter
+    def x(self, value: float) -> None:
+        self[0] = value
+
+    @property
+    def y(self) -> float:
+        """Returns Y coordinate of VectorUV"""
+        return self[1]
+
+    @y.setter
+    def y(self, value: float) -> None:
+        self[1] = value
+
+    @property
+    def norm(self):
+        norm = np.linalg.norm(self)
+        if norm == 0:
+            norm = np.finfo(self.dtype).eps
+        return norm
+
+    def normalize(self):
+        """Return a normalized version of the vector"""
+        return self / self.norm