Added noexcept flags to core package functions and methods.

Author: CnlPepper

dev/notes/building_a_release.txt

@@ -20,11 +20,11 @@ then a matrix of builds is performed.
 Move the sdist and wheels to a common folder and upload to pypi with twine. Twine needs an API key.
 Upload to the test repository first and confirm everything works as expected:
 
-    twine upload --repository testpypi wheelhouse/
+    twine upload --repository testpypi wheelhouse/*
 
 If happy, upload to the main pypi repository:
 
-    twine upload wheelhouse/
+    twine upload wheelhouse/*
 
 
 

raysect/core/acceleration/accelerator.pxd

@@ -36,6 +36,6 @@ from raysect.core.intersection cimport Intersection
 
 cdef class Accelerator:
 
-    cpdef build(self, list primitives)
+    cpdef object build(self, list primitives)
     cpdef Intersection hit(self, Ray ray)
     cpdef list contains(self, Point3D point)

raysect/core/acceleration/accelerator.pyx

@@ -31,7 +31,7 @@
 
 cdef class Accelerator:
 
-    cpdef build(self, list primitives):
+    cpdef object build(self, list primitives):
         pass
 
     cpdef Intersection hit(self, Ray ray):

raysect/core/acceleration/boundprimitive.pxd

@@ -44,4 +44,4 @@ cdef class BoundPrimitive:
 
     cdef Intersection hit(self, Ray ray)
     cdef Intersection next_intersection(self)
-    cdef bint contains(self, Point3D point)
+    cdef bint contains(self, Point3D point) noexcept

raysect/core/acceleration/boundprimitive.pyx

@@ -59,7 +59,7 @@ cdef class BoundPrimitive:
             return self.primitive.next_intersection()
         return None
 
-    cdef bint contains(self, Point3D point):
+    cdef bint contains(self, Point3D point) noexcept:
 
         if self.box.contains(point):
             return self.primitive.contains(point)

raysect/core/acceleration/kdtree.pyx

@@ -70,7 +70,7 @@ cdef class _PrimitiveKDTree(_KDTreeCore):
 
     @cython.boundscheck(False)
     @cython.wraparound(False)
-    cdef bint _trace_leaf(self, int32_t id, Ray ray, double max_range):
+    cdef bint _trace_leaf(self, int32_t id, Ray ray, double max_range) noexcept:
         """
         Tests each item in the kd-Tree leaf node to identify if an intersection occurs.
 
@@ -164,7 +164,7 @@ cdef class _PrimitiveKDTree(_KDTreeCore):
 
 cdef class KDTree(_Accelerator):
 
-    cpdef build(self, list primitives):
+    cpdef object build(self, list primitives):
         self._kdtree = _PrimitiveKDTree(primitives)
 
     cpdef Intersection hit(self, Ray ray):

raysect/core/acceleration/unaccelerated.pyx

@@ -45,7 +45,7 @@ cdef class Unaccelerated(Accelerator):
         self.primitives = []
         self.world_box = BoundingBox3D()
 
-    cpdef build(self, list primitives):
+    cpdef object build(self, list primitives):
 
         cdef:
             Primitive primitive

raysect/core/boundingbox.pxd

@@ -40,19 +40,19 @@ cdef class BoundingBox3D:
     cdef Point3D upper
 
     cdef Point3D get_centre(self)
-    cpdef bint hit(self, Ray ray)
+    cpdef bint hit(self, Ray ray) noexcept
     cpdef tuple full_intersection(self, Ray ray)
-    cdef bint intersect(self, Ray ray, double *front_intersection, double *back_intersection)
-    cdef void _slab(self, double origin, double direction, double lower, double upper, double *front_intersection, double *back_intersection) nogil
-    cpdef bint contains(self, Point3D point)
+    cdef bint intersect(self, Ray ray, double *front_intersection, double *back_intersection) noexcept
+    cdef void _slab(self, double origin, double direction, double lower, double upper, double *front_intersection, double *back_intersection) noexcept nogil
+    cpdef bint contains(self, Point3D point) noexcept
     cpdef object union(self, BoundingBox3D box)
     cpdef object extend(self, Point3D point, double padding=*)
-    cpdef double surface_area(self)
-    cpdef double volume(self)
+    cpdef double surface_area(self) noexcept
+    cpdef double volume(self) noexcept
     cpdef list vertices(self)
     cpdef double extent(self, int axis) except -1
-    cpdef int largest_axis(self)
-    cpdef double largest_extent(self)
+    cpdef int largest_axis(self) noexcept
+    cpdef double largest_extent(self) noexcept
     cpdef object pad(self, double padding)
     cpdef object pad_axis(self, int axis, double padding)
     cpdef BoundingSphere3D enclosing_sphere(self)
@@ -78,14 +78,14 @@ cdef class BoundingBox2D:
     cdef Point2D lower
     cdef Point2D upper
 
-    cpdef bint contains(self, Point2D point)
+    cpdef bint contains(self, Point2D point) noexcept
     cpdef object union(self, BoundingBox2D box)
     cpdef object extend(self, Point2D point, double padding=*)
-    cpdef double surface_area(self)
+    cpdef double surface_area(self) noexcept
     cpdef list vertices(self)
     cpdef double extent(self, int axis) except -1
-    cpdef int largest_axis(self)
-    cpdef double largest_extent(self)
+    cpdef int largest_axis(self) noexcept
+    cpdef double largest_extent(self) noexcept
     cpdef object pad(self, double padding)
     cpdef object pad_axis(self, int axis, double padding)
 

raysect/core/boundingbox.pyx

@@ -29,8 +29,6 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-# TODO: add docstrings
-
 cimport cython
 from libc.math cimport INFINITY
 from raysect.core.math cimport new_point3d, new_point2d
@@ -143,7 +141,7 @@ cdef class BoundingBox3D:
             0.5 * (self.lower.z + self.upper.z)
         )
 
-    cpdef bint hit(self, Ray ray):
+    cpdef bint hit(self, Ray ray) noexcept:
         """
         Returns true if the ray hits the bounding box.
 
@@ -177,7 +175,7 @@ cdef class BoundingBox3D:
 
         return hit, front_intersection, back_intersection
 
-    cdef bint intersect(self, Ray ray, double *front_intersection, double *back_intersection):
+    cdef bint intersect(self, Ray ray, double *front_intersection, double *back_intersection) noexcept:
 
         # set initial ray-slab intersection search range
         front_intersection[0] = -INFINITY
@@ -198,7 +196,7 @@ cdef class BoundingBox3D:
         return True
 
     @cython.cdivision(True)
-    cdef void _slab(self, double origin, double direction, double lower, double upper, double *front_intersection, double *back_intersection) nogil:
+    cdef void _slab(self, double origin, double direction, double lower, double upper, double *front_intersection, double *back_intersection) noexcept nogil:
 
         cdef double reciprocal, tmin, tmax
 
@@ -244,7 +242,7 @@ cdef class BoundingBox3D:
         if tmax < back_intersection[0]:
             back_intersection[0] = tmax
 
-    cpdef bint contains(self, Point3D point):
+    cpdef bint contains(self, Point3D point) noexcept:
         """
         Returns true if the given 3D point lies inside the bounding box.
 
@@ -299,7 +297,7 @@ cdef class BoundingBox3D:
         self.upper.y = max(self.upper.y, point.y + padding)
         self.upper.z = max(self.upper.z, point.z + padding)
 
-    cpdef double surface_area(self):
+    cpdef double surface_area(self) noexcept:
         """
         Returns the surface area of the bounding box.
 
@@ -314,7 +312,7 @@ cdef class BoundingBox3D:
 
         return 2 * (dx * dy + dx * dz + dy * dz)
 
-    cpdef double volume(self):
+    cpdef double volume(self) noexcept:
         """
         Returns the volume of the bounding box.
 
@@ -359,7 +357,7 @@ cdef class BoundingBox3D:
         else:
             raise ValueError("Axis must be in the range [0, 2].")
 
-    cpdef int largest_axis(self):
+    cpdef int largest_axis(self) noexcept:
         """
         Find the largest axis of this bounding box.
 
@@ -386,7 +384,7 @@ cdef class BoundingBox3D:
 
         return largest_axis
 
-    cpdef double largest_extent(self):
+    cpdef double largest_extent(self) noexcept:
         """
         Find the largest spatial extent across all axes.
 
@@ -478,7 +476,6 @@ cdef class BoundingBox2D:
             self.upper = upper
 
     def __repr__(self):
-
         return "BoundingBox2D({}, {})".format(self.lower, self.upper)
 
     def __getstate__(self):
@@ -517,7 +514,7 @@ cdef class BoundingBox2D:
     def upper(self, Point2D value not None):
         self.upper = value
 
-    cpdef bint contains(self, Point2D point):
+    cpdef bint contains(self, Point2D point) noexcept:
         """
         Returns true if the given 2D point lies inside the bounding box.
 
@@ -562,7 +559,7 @@ cdef class BoundingBox2D:
         self.upper.x = max(self.upper.x, point.x + padding)
         self.upper.y = max(self.upper.y, point.y + padding)
 
-    cpdef double surface_area(self):
+    cpdef double surface_area(self) noexcept:
         """
         Returns the surface area of the bounding box.
 
@@ -598,7 +595,7 @@ cdef class BoundingBox2D:
         else:
             raise ValueError("Axis must be in the range [0, 1].")
 
-    cpdef int largest_axis(self):
+    cpdef int largest_axis(self) noexcept:
         """
         Find the largest axis of this bounding box.
 
@@ -619,7 +616,7 @@ cdef class BoundingBox2D:
 
         return largest_axis
 
-    cpdef double largest_extent(self):
+    cpdef double largest_extent(self) noexcept:
         """
         Find the largest spatial extent across all axes.
 

raysect/core/boundingsphere.pxd

@@ -38,12 +38,12 @@ cdef class BoundingSphere3D:
         double radius
         Point3D centre
 
-    cpdef bint hit(self, Ray ray)
+    cpdef bint hit(self, Ray ray) noexcept
     cpdef tuple full_intersection(self, Ray ray)
-    cdef bint intersect(self, Ray ray, double *front_intersection, double *back_intersection)
-    cpdef bint contains(self, Point3D point)
+    cdef bint intersect(self, Ray ray, double *front_intersection, double *back_intersection) noexcept
+    cpdef bint contains(self, Point3D point) noexcept
     cpdef object union(self, BoundingSphere3D sphere)
     cpdef object extend(self, Point3D point, double padding=*)
-    cpdef double surface_area(self)
-    cpdef double volume(self)
+    cpdef double surface_area(self) noexcept
+    cpdef double volume(self) noexcept
     cpdef object pad(self, double padding)