Move coarse_prof usage behind feature flag

Author: w1th0utnam3

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## Version 0.3.0
 
- - Move `vtkio` convenience trait implementations in `splashsurf_lib` behind a non-default feature flag (flag `vtk-extras`)
+ - Move `vtkio` convenience trait implementations in `splashsurf_lib` behind a non-default feature flag (flag `vtk-extras`). Flag is enabled in the CLI crate.
+ - Move `coarse_prof` usage in `splashsurf_lib` behind a non-default feature flag (flag `profiling`). Flag is enabled in the CLI crate.
 
 ## Version 0.2.0
 

splashsurf/Cargo.toml

@@ -13,7 +13,7 @@ homepage = "https://github.com/w1th0utnam3/splashsurf"
 repository = "https://github.com/w1th0utnam3/splashsurf"
 
 [dependencies]
-splashsurf_lib = { path = "../splashsurf_lib", version = "0.2", features = ["vtk_extras"] }
+splashsurf_lib = { path = "../splashsurf_lib", version = "0.2", features = ["vtk_extras", "profiling"] }
 structopt = "0.3"
 log = "0.4"
 fern = "0.6"

splashsurf_lib/Cargo.toml

@@ -21,14 +21,15 @@ exclude = [
 [features]
 default = []
 vtk_extras = ["vtkio"]
+profiling = ["coarse-prof"]
 
 [dependencies]
 log = "0.4"
 nalgebra = "0.23"
 num = "0.3"
 anyhow = "1.0"
 thiserror = "1.0"
-coarse-prof = "0.2"
+coarse-prof = { version = "0.2", optional = true }
 itertools = "0.9"
 rayon = "1.5"
 dashmap = "3.11"

splashsurf_lib/src/density_map.rs

@@ -1,4 +1,3 @@
-use coarse_prof::profile;
 use dashmap::ReadOnlyView as ReadDashMap;
 use log::{info, warn};
 use nalgebra::Vector3;

splashsurf_lib/src/lib.rs

@@ -5,6 +5,22 @@
 /// Re-export the version of nalgebra used by this crate
 pub use nalgebra;
 
+#[cfg(feature = "profiling")]
+/// Invokes coarse_prof::profile! with the given expression
+macro_rules! profile {
+    ($body:expr) => {
+        coarse_prof::profile!($body);
+    };
+}
+
+#[cfg(not(feature = "profiling"))]
+/// No-op macro if profiling is disabled
+macro_rules! profile {
+    ($body:expr) => {
+        $body
+    };
+}
+
 mod aabb;
 /// Computation of sparse density maps (evaluation of particle densities and mapping onto sparse grids)
 pub mod density_map;
@@ -27,7 +43,6 @@ pub use density_map::DensityMap;
 pub use numeric_types::{Index, Real, ThreadSafe};
 pub use uniform_grid::{GridConstructionError, UniformGrid};
 
-use coarse_prof::profile;
 use log::info;
 use mesh::TriMesh3d;
 use nalgebra::Vector3;
@@ -89,6 +104,7 @@ pub struct Parameters<R: Real> {
     pub enable_multi_threading: bool,
 }
 
+/// Macro version of Option::map that allows using e.g. using the ?-operator in the map expression
 macro_rules! map_option {
     ($some_optional:expr, $value_identifier:ident => $value_transformation:expr) => {
         match $some_optional {

splashsurf_lib/src/marching_cubes.rs

@@ -1,4 +1,3 @@
-use coarse_prof::profile;
 use log::info;
 use nalgebra::Vector3;
 

splashsurf_lib/src/neighborhood_search.rs

@@ -1,4 +1,3 @@
-use coarse_prof::profile;
 use nalgebra::Vector3;
 use rayon::prelude::*;