Update Changelog, add Default trait bound to Index and Real

Author: w1th0utnam3

CHANGELOG.md

@@ -1,17 +1,20 @@
 ## Master
 
+ - Lib: Allow passing in an existing `SurfaceReconstruction` to reuse allocated memory (currently only memory for the resulting surface mesh is reused)
+ - Lib: Add `Default` trait bound to `Index` and `Real` types
+
 ## Version 0.3.0
 
- - Move `vtkio` convenience trait implementations in `splashsurf_lib` behind a non-default feature flag (flag `vtk-extras`). Flag is enabled in the CLI crate.
- - Re-export `vtkio` from lib if feature is enabled and use this from CLI 
- - Move `coarse_prof` usage in `splashsurf_lib` behind a non-default feature flag (flag `profiling`). Flag is enabled in the CLI crate.
+ - Lib: Move `vtkio` convenience trait implementations in `splashsurf_lib` behind a non-default feature flag (flag `vtk-extras`). Flag is enabled in the CLI crate.
+ - Lib: Move `coarse_prof` usage in `splashsurf_lib` behind a non-default feature flag (flag `profiling`). Flag is enabled in the CLI crate.
+ - Re-export `vtkio` from lib if feature is enabled and use this from CLI
  - Re-export `coarse_prof` from lib if feature is enabled and use this from CLI 
- - Instead of directly writing into a global density map (`dashmap`) in parallel, use thread local density maps (`HashMap`s) which are then merged in a second step (in parallel, into a `dashmap`). Improves performance of the test scene in the readme from 20 seconds to 12 seconds.
- - Fix bug which forced some parts in the library to divided work into 8 chunks, preventing use of more threads
+ - Lib: Instead of directly writing into a global density map (`dashmap`) in parallel, use thread local density maps (`HashMap`s) which are then merged in a second step (in parallel, into a `dashmap`). Improves performance of the test scene in the readme from 20 seconds to 12 seconds.
+ - Lib: Fix bug which forced some parts in the library to divided work into 8 chunks, preventing use of more threads
 
 ## Version 0.2.0
 
- - Add support for reading PLY files (https://github.com/w1th0utnam3/splashsurf/pull/1)
+ - CLI: Add support for reading PLY files (https://github.com/w1th0utnam3/splashsurf/pull/1)
  - Update dependencies
  - Re-export `nalgebra` from lib, use this from CLI
 

splashsurf_lib/src/lib.rs

@@ -152,13 +152,12 @@ pub struct SurfaceReconstruction<I: Index, R: Real> {
 }
 
 impl<I: Index, R: Real> Default for SurfaceReconstruction<I, R> {
+    /// Returns an empty [SurfaceReconstruction] to pass into the inplace surface reconstruction
     fn default() -> Self {
-        let grid = UniformGrid::new_zero();
-        let mesh = TriMesh3d::default();
         Self {
-            grid,
+            grid: UniformGrid::new_zero(),
             density_map: None,
-            mesh,
+            mesh: TriMesh3d::default(),
         }
     }
 }

splashsurf_lib/src/mesh.rs

@@ -5,23 +5,14 @@ use nalgebra::Vector3;
 use crate::Real;
 
 /// A triangle (surface) mesh in 3D
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, Default)]
 pub struct TriMesh3d<R: Real> {
     /// Coordinates of all vertices of the mesh
     pub vertices: Vec<Vector3<R>>,
     /// The triangles of the mesh identified by their vertex indices
     pub triangles: Vec<[usize; 3]>,
 }
 
-impl<R: Real> Default for TriMesh3d<R> {
-    fn default() -> Self {
-        Self {
-            vertices: Vec::new(),
-            triangles: Vec::new(),
-        }
-    }
-}
-
 /// A hexahedral (volumetric) mesh in 3D
 #[derive(Clone, Debug, Default)]
 pub struct HexMesh3d<R: Real> {

splashsurf_lib/src/numeric_types.rs

@@ -20,6 +20,7 @@ pub trait Index:
     + CheckedMul
     + FromPrimitive
     + ToPrimitive
+    + Default
     + Debug
     + Display
     + ThreadSafe
@@ -41,7 +42,7 @@ pub trait Index:
 }
 
 /// Trait that has to be implemented for types to be used as floating points values in the context of the library (e.g. for coordinates, density values)
-pub trait Real: RealField + FromPrimitive + ToPrimitive + Debug + ThreadSafe {
+pub trait Real: RealField + FromPrimitive + ToPrimitive + Debug + Default + ThreadSafe {
     fn try_convert<T: Real>(self) -> Option<T> {
         Some(T::from_f64(self.to_f64()?)?)
     }
@@ -92,9 +93,10 @@ impl<T> Index for T where
         + FromPrimitive
         + ToPrimitive
         + Debug
+        + Default
         + Display
         + ThreadSafe
 {
 }
 
-impl<T: RealField + FromPrimitive + ToPrimitive + Debug + ThreadSafe> Real for T {}
+impl<T: RealField + FromPrimitive + ToPrimitive + Debug + Default + ThreadSafe> Real for T {}

splashsurf_lib/src/uniform_grid.rs

@@ -200,7 +200,7 @@ impl<I: Index, R: Real> UniformCartesianCubeGrid3d<I, R> {
         })
     }
 
-    /// Create a new zeroed grid
+    /// Constructs a degenerate grid with zero extents, zero cells and zero points
     pub(crate) fn new_zero() -> Self {
         Self {
             aabb: AxisAlignedBoundingBox3d::new(Vector3::zeros(), Vector3::zeros()),