Feat/caching in all evaluation methods (#460)

Co-authored-by: Roberto Pastor Muela <[email protected]>
Co-authored-by: jonahrb <[email protected]>
Co-authored-by: Jonah Boling <[email protected]>

Author: 3 people

AUTHORS.md

@@ -15,3 +15,4 @@
 * [Alexander Kaszynski](https://github.com/akaszynski)
 * [Jorge Martínez](https://github.com/jorgepiloto)
 * [Alejandro Fernández](https://github.com/AlejandroFernandezLuces)
+* [Lance Lance](https://github.com/LanceX2214)

doc/source/examples/01_getting_started/01_math.mystnb

@@ -156,10 +156,10 @@ print(eval.parameter.v)
 
 ```{code-cell} ipython3
 print("Point on the sphere:")
-eval.position()
+eval.position
 ```
 
 ```{code-cell} ipython3
 print("Normal to the surface of the sphere at the evaluation position:")
-eval.normal()
+eval.normal
 ```

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

@@ -1,4 +1,5 @@
 """ Provides the ``Circle`` class."""
+from functools import cached_property
 
 from beartype import beartype as check_input_types
 from beartype.typing import Union
@@ -206,6 +207,7 @@ def parameter(self) -> Real:
         """The parameter that the evaluation is based upon."""
         return self._parameter
 
+    @cached_property
     def position(self) -> Point3D:
         """
         The position of the evaluation.
@@ -221,6 +223,7 @@ def position(self) -> Point3D:
             + ((self.circle.radius * np.sin(self.parameter)) * self.circle.dir_y).m
         )
 
+    @cached_property
     def tangent(self) -> UnitVector3D:
         """
         The tangent of the evaluation.
@@ -234,6 +237,7 @@ def tangent(self) -> UnitVector3D:
             np.cos(self.parameter) * self.circle.dir_y - np.sin(self.parameter) * self.circle.dir_x
         )
 
+    @cached_property
     def normal(self) -> UnitVector3D:
         """
         The normal to the circle.
@@ -247,6 +251,7 @@ def normal(self) -> UnitVector3D:
             np.cos(self.parameter) * self.circle.dir_x + np.sin(self.parameter) * self.circle.dir_y
         )
 
+    @cached_property
     def first_derivative(self) -> Vector3D:
         """
         The first derivative of the evaluation. The first derivative is in the direction of the
@@ -262,6 +267,7 @@ def first_derivative(self) -> Vector3D:
             np.cos(self.parameter) * self.circle.dir_y - np.sin(self.parameter) * self.circle.dir_x
         )
 
+    @cached_property
     def second_derivative(self) -> Vector3D:
         """
         The second derivative of the evaluation.
@@ -275,6 +281,7 @@ def second_derivative(self) -> Vector3D:
             np.cos(self.parameter) * self.circle.dir_x + np.sin(self.parameter) * self.circle.dir_y
         )
 
+    @cached_property
     def curvature(self) -> Real:
         """
         The curvature of the circle.

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

@@ -1,5 +1,6 @@
 """Provides the ``Cone`` class."""
 
+from functools import cached_property
 
 from beartype import beartype as check_input_types
 from beartype.typing import Union
@@ -169,7 +170,7 @@ def project_point(self, point: Point3D) -> "ConeEvaluation":
         v = line_eval.parameter
 
         cone_radius = self.radius.m + v * np.tan(self.half_angle.m)
-        point_radius = np.linalg.norm(point - line_eval.position())
+        point_radius = np.linalg.norm(point - line_eval.position)
         dist_to_cone = (point_radius - cone_radius) * np.cos(self.half_angle.m)
         v += dist_to_cone * np.sin(self.half_angle.m)
 
@@ -232,6 +233,7 @@ def parameter(self) -> ParamUV:
         """The parameter that the evaluation is based upon."""
         return self._parameter
 
+    @cached_property
     def position(self) -> Point3D:
         """
         The position of the evaluation.
@@ -244,9 +246,10 @@ def position(self) -> Point3D:
         return (
             self.cone.origin
             + self.parameter.v * self.cone.dir_z
-            + self.__radius_v() * self.__cone_normal()
+            + self.__radius_v * self.__cone_normal
         )
 
+    @cached_property
     def normal(self) -> UnitVector3D:
         """
         The normal to the surface.
@@ -257,26 +260,30 @@ def normal(self) -> UnitVector3D:
             The normal unit vector to the cone at this evaluation.
         """
         return UnitVector3D(
-            self.__cone_normal() * np.cos(self.cone.half_angle.m)
+            self.__cone_normal * np.cos(self.cone.half_angle.m)
             - self.cone.dir_z * np.sin(self.cone.half_angle.m)
         )
 
+    @cached_property
     def __radius_v(self) -> Real:
         """Private radius helper method."""
         return self.cone.radius.m + self.parameter.v * np.tan(self.cone.half_angle.m)
 
+    @cached_property
     def __cone_normal(self) -> Vector3D:
         """Private normal helper method."""
         return (
             np.cos(self.parameter.u) * self.cone.dir_x + np.sin(self.parameter.u) * self.cone.dir_y
         )
 
+    @cached_property
     def __cone_tangent(self) -> Vector3D:
         """Private tangent helper method."""
         return (
             -np.sin(self.parameter.u) * self.cone.dir_x + np.cos(self.parameter.u) * self.cone.dir_y
         )
 
+    @cached_property
     def u_derivative(self) -> Vector3D:
         """
         The first derivative with respect to u.
@@ -286,8 +293,9 @@ def u_derivative(self) -> Vector3D:
         Vector3D
             The first derivative with respect to u.
         """
-        return self.__radius_v() * self.__cone_tangent()
+        return self.__radius_v * self.__cone_tangent
 
+    @cached_property
     def v_derivative(self) -> Vector3D:
         """
         The first derivative with respect to v.
@@ -297,8 +305,9 @@ def v_derivative(self) -> Vector3D:
         Vector3D
             The first derivative with respect to v.
         """
-        return self.cone.dir_z + np.tan(self.cone.half_angle.m) * self.__cone_normal()
+        return self.cone.dir_z + np.tan(self.cone.half_angle.m) * self.__cone_normal
 
+    @cached_property
     def uu_derivative(self) -> Vector3D:
         """
         The second derivative with respect to u.
@@ -308,8 +317,9 @@ def uu_derivative(self) -> Vector3D:
         Vector3D
             The second derivative with respect to u.
         """
-        return -self.__radius_v() * self.__cone_normal()
+        return -self.__radius_v * self.__cone_normal
 
+    @cached_property
     def uv_derivative(self) -> Vector3D:
         """
         The second derivative with respect to u and v.
@@ -319,8 +329,9 @@ def uv_derivative(self) -> Vector3D:
         Vector3D
             The second derivative with respect to u and v.
         """
-        return np.tan(self.cone.half_angle.m) * self.__cone_tangent()
+        return np.tan(self.cone.half_angle.m) * self.__cone_tangent
 
+    @cached_property
     def vv_derivative(self) -> Vector3D:
         """
         The second derivative with respect to v.
@@ -332,6 +343,7 @@ def vv_derivative(self) -> Vector3D:
         """
         return Vector3D([0, 0, 0])
 
+    @cached_property
     def min_curvature(self) -> Real:
         """
         The minimum curvature of the cone.
@@ -343,6 +355,7 @@ def min_curvature(self) -> Real:
         """
         return 0
 
+    @cached_property
     def min_curvature_direction(self) -> UnitVector3D:
         """
         The minimum curvature direction.
@@ -352,8 +365,9 @@ def min_curvature_direction(self) -> UnitVector3D:
         UnitVector3D
             The minimum curvature direction.
         """
-        return UnitVector3D(self.v_derivative())
+        return UnitVector3D(self.v_derivative)
 
+    @cached_property
     def max_curvature(self) -> Real:
         """
         The maximum curvature of the cone.
@@ -363,8 +377,9 @@ def max_curvature(self) -> Real:
         Real
             The maximum curvature of the cone.
         """
-        return 1.0 / self.__radius_v()
+        return 1.0 / self.__radius_v
 
+    @cached_property
     def max_curvature_direction(self) -> UnitVector3D:
         """
         The maximum curvature direction.
@@ -374,4 +389,4 @@ def max_curvature_direction(self) -> UnitVector3D:
         UnitVector3D
             The maximum curvature direction.
         """
-        return UnitVector3D(self.u_derivative())
+        return UnitVector3D(self.u_derivative)

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

@@ -1,3 +1,5 @@
+from functools import cached_property
+
 from ansys.geometry.core.math import Point3D, Vector3D
 from ansys.geometry.core.typing import Real
 
@@ -17,18 +19,22 @@ def parameter(self) -> Real:
         """The parameter that the evaluation is based upon."""
         raise NotImplementedError("Each evaluation must provide the parameter definition.")
 
+    @cached_property
     def position(self) -> Point3D:
         """The position of the evaluation."""
         raise NotImplementedError("Each evaluation must provide the position definition.")
 
+    @cached_property
     def first_derivative(self) -> Vector3D:
         """The first derivative of the evaluation."""
         raise NotImplementedError("Each evaluation must provide the first_derivative definition.")
 
+    @cached_property
     def second_derivative(self) -> Vector3D:
         """The second derivative of the evaluation."""
         raise NotImplementedError("Each evaluation must provide the second_derivative definition.")
 
+    @cached_property
     def curvature(self) -> Real:
         """The curvature of the evaluation."""
         raise NotImplementedError("Each evaluation must provide the curvature definition.")

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

@@ -1,5 +1,7 @@
 """ Provides the ``Cylinder`` class."""
 
+from functools import cached_property
+
 from beartype import beartype as check_input_types
 from beartype.typing import Union
 import numpy as np
@@ -230,6 +232,7 @@ def parameter(self) -> ParamUV:
         """The parameter that the evaluation is based upon."""
         return self._parameter
 
+    @cached_property
     def position(self) -> Point3D:
         """
         The position of the evaluation.
@@ -241,10 +244,11 @@ def position(self) -> Point3D:
         """
         return (
             self.cylinder.origin
-            + self.cylinder.radius.m * self.__cylinder_normal()
+            + self.cylinder.radius.m * self.__cylinder_normal
             + self.parameter.v * self.cylinder.dir_z
         )
 
+    @cached_property
     def normal(self) -> UnitVector3D:
         """
         The normal to the surface.
@@ -254,8 +258,9 @@ def normal(self) -> UnitVector3D:
         UnitVector3D
             The normal unit vector to the cylinder at this evaluation.
         """
-        return UnitVector3D(self.__cylinder_normal())
+        return UnitVector3D(self.__cylinder_normal)
 
+    @cached_property
     def __cylinder_normal(self) -> Vector3D:
         """
         The normal to the surface.
@@ -270,13 +275,15 @@ def __cylinder_normal(self) -> Vector3D:
             + np.sin(self.parameter.u) * self.cylinder.dir_y
         )
 
+    @cached_property
     def __cylinder_tangent(self) -> Vector3D:
         """Private tangent helper method."""
         return (
             -np.sin(self.parameter.u) * self.cylinder.dir_x
             + np.cos(self.parameter.u) * self.cylinder.dir_y
         )
 
+    @cached_property
     def u_derivative(self) -> Vector3D:
         """
         The first derivative with respect to u.
@@ -286,8 +293,9 @@ def u_derivative(self) -> Vector3D:
         Vector3D
             The first derivative with respect to u.
         """
-        return self.cylinder.radius.m * self.__cylinder_tangent()
+        return self.cylinder.radius.m * self.__cylinder_tangent
 
+    @cached_property
     def v_derivative(self) -> Vector3D:
         """
         The first derivative with respect to v.
@@ -299,6 +307,7 @@ def v_derivative(self) -> Vector3D:
         """
         return self.cylinder.dir_z
 
+    @cached_property
     def uu_derivative(self) -> Vector3D:
         """
         The second derivative with respect to u.
@@ -308,8 +317,9 @@ def uu_derivative(self) -> Vector3D:
         Vector3D
             The second derivative with respect to u.
         """
-        return -self.cylinder.radius.m * self.__cylinder_normal()
+        return -self.cylinder.radius.m * self.__cylinder_normal
 
+    @cached_property
     def uv_derivative(self) -> Vector3D:
         """
         The second derivative with respect to u and v.
@@ -321,6 +331,7 @@ def uv_derivative(self) -> Vector3D:
         """
         return Vector3D([0, 0, 0])
 
+    @cached_property
     def vv_derivative(self) -> Vector3D:
         """
         The second derivative with respect to v.
@@ -332,6 +343,7 @@ def vv_derivative(self) -> Vector3D:
         """
         return Vector3D([0, 0, 0])
 
+    @cached_property
     def min_curvature(self) -> Real:
         """
         The minimum curvature of the cylinder.
@@ -343,6 +355,7 @@ def min_curvature(self) -> Real:
         """
         return 0
 
+    @cached_property
     def min_curvature_direction(self) -> UnitVector3D:
         """
         The minimum curvature direction.
@@ -354,6 +367,7 @@ def min_curvature_direction(self) -> UnitVector3D:
         """
         return UnitVector3D(self.cylinder.dir_z)
 
+    @cached_property
     def max_curvature(self) -> Real:
         """
         The maximum curvature of the cylinder.
@@ -365,6 +379,7 @@ def max_curvature(self) -> Real:
         """
         return 1.0 / self.cylinder.radius.m
 
+    @cached_property
     def max_curvature_direction(self) -> UnitVector3D:
         """
         The maximum curvature direction.
@@ -374,4 +389,4 @@ def max_curvature_direction(self) -> UnitVector3D:
         UnitVector3D
             The maximum curvature direction.
         """
-        return UnitVector3D(self.u_derivative())
+        return UnitVector3D(self.u_derivative)