bump crate to 0.6.2

Signed-off-by: Stephen Waits <steve@waits.net>

.build.yml

@@ -14,11 +14,11 @@ tasks:
   - format: |
       rustup default stable
       cd vivaldi-nc/
-      cargo fmt --verbose --check
+      cargo fmt --verbose --check --all
   - lint: |
       rustup default stable
       cd vivaldi-nc/
-      cargo clippy --verbose
+      cargo clippy --verbose --all-targets --all-features
   - coverage: |
       rustup default stable
       cd vivaldi-nc/
@@ -26,18 +26,18 @@ tasks:
   - stable: |
       rustup default stable
       cd vivaldi-nc/
-      cargo build --verbose
+      cargo build --verbose --all-targets --all-features
       cargo test --verbose --all-features
   - nightly: |
       rustup default nightly
       cd vivaldi-nc/
-      cargo clippy --verbose ||:
+      cargo clippy --verbose --all-targets --all-features ||:
-      cargo build --verbose  ||:
+      cargo build --verbose --all-targets --all-features  ||:
-      cargo test --verbose --all-features ||:
+      cargo test --verbose --all-targets --all-features   ||:
   - bench: |
       rustup default stable
       cd vivaldi-nc/
-      cargo bench --verbose --all-features
+      cargo bench --verbose --all-targets --all-features
   - examples: |
       rustup default stable
       cd vivaldi-nc/

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vivaldi-nc"
-version = "0.6.1"
+version = "0.6.2"
 edition = "2021"
 authors = ["Stephen Waits <steve@waits.net>"]
 description = "Vivaldi network coordinates for fast, distributed latency estimates in multinode networks, with a clean and simple interface."
@@ -28,6 +28,7 @@ debug = true
 [dev-dependencies]
 assert_approx_eq = "1.1.0"
 criterion = "0.4.0"
+cargo-husky = { version = "1.5.0", features = ["run-for-all", "precommit-hook", "run-cargo-test", "run-cargo-check", "run-cargo-clippy", "run-cargo-fmt"] }
 proptest = "1.0.0"
 serde_json = "1.0.91"
 
@@ -37,6 +38,7 @@ harness = false
 
 [dependencies]
 array-init = "2.1.0"
+cfg-if = "1.0.0"
 num-traits = "0.2.15"
 rand = "0.8.5"
 serde = {version = "1.0.152", features = ["serde_derive"]}

README.md

@@ -192,6 +192,8 @@ This crate depends on:
   operations for the internal `Vector` so much nicer. Once we have
   `feature(array_zip)` stabilized, we could use that instead. Until then, this
   works well with zero performance impact.
+- [`cfg-if`](https://crates.io/crates/cfg-if): Compile-time only macro which
+  makes using `cfg` parameters much nicer in code.
 
 ## Design Goals & Alternatives
 

benches/million-updates.rs

@@ -1,4 +1,4 @@
-use std::time::Duration;
+use core::time::Duration;
 
 use criterion::{criterion_group, criterion_main, Criterion};
 use vivaldi_nc::{NetworkCoordinate2D, NetworkCoordinate3D};

src/height_vector.rs

@@ -53,13 +53,15 @@ use crate::vector::{self, Vector};
 // **** Features ****
 //
 
-/// `FloatType` is a type alias for either `f32` or `f64` depending on cargo features
+cfg_if::cfg_if! {
-#[cfg(feature = "f32")]
+    if #[cfg(feature = "f32")] {
-type FloatType = f32;
+        /// `FloatType` is a type alias for either `f32` or `f64` depending on cargo features
-
+        type FloatType = f32;
-/// `FloatType` is a type alias for either `f32` or `f64` depending on cargo features
+    } else {
-#[cfg(not(feature = "f32"))]
+        /// `FloatType` is a type alias for either `f32` or `f64` depending on cargo features
-type FloatType = f64;
+        type FloatType = f64;
+    }
+}
 
 //
 // **** Constants ****
@@ -240,26 +242,30 @@ mod tests {
     use assert_approx_eq::assert_approx_eq;
     use proptest::prelude::*;
 
+    fn approx_eq(a: FloatType, b: FloatType, margin: FloatType) -> bool {
+        (a - b).abs() <= margin
+    }
+
     proptest! {
         #[test]
         fn proptest_len(x: FloatType, y: FloatType, h: FloatType) {
             let len = x.hypot(y) + h.abs();
             let a = HeightVector::<2>::from(([x,y],h));
-            println!("a = {a:#?}");
             if x.is_nan() || x.is_infinite() || y.is_nan() || y.is_infinite() || h.is_nan() || h.is_infinite() || h < 0.0 {
                 // we should've gottne a random univ vector here
-                assert_approx_eq!(a.len(), 1.0);
+                prop_assert!(approx_eq(a.len(), 1.0, 0.0001));
             } else {
                 // `HeightVector` we created from proptest values should be valid and have a length
                 if len.is_nan() || len.is_infinite() {
-                    assert!(a.len().is_nan() || a.len().is_infinite());
+                    prop_assert!(a.len().is_nan() || a.len().is_infinite());
                 } else {
-                    assert_approx_eq!(a.len(), len);
+                    prop_assert!(approx_eq(a.len(), len, 0.0001));
                 }
             }
         }
 
         #[test]
+        #[allow(clippy::cast_lossless, clippy::cast_precision_loss)]
         fn proptest_add(x0 in -1_000_000_000..1_000_000_000i32, y0 in -1_000_000_000..1_000_000_000i32, h0 in 0..1_000_000_000i32, x1 in -1_000_000_000..1_000_000_000i32, y1 in -1_000_000_000..1_000_000_000i32, h1 in 0..1_000_000i32) {
             // convert our integer range inputs to FloatType
             let (fx0,fy0,fh0) = (x0 as FloatType / 1_000.0, y0 as FloatType / 1_000.0, h0 as FloatType / 1_000.0);
@@ -268,12 +274,13 @@ mod tests {
             let a = HeightVector::<2>::from(([fx0 ,fy0 ],fh0 ));
             let b = HeightVector::<2>::from(([fx1 ,fy1 ],fh1 ));
             let c = a+b;
-            assert_approx_eq!(c.position[0], fx0 + fx1);
+            prop_assert!(approx_eq(c.position[0], fx0 + fx1, 0.0001));
-            assert_approx_eq!(c.position[1], fy0 + fy1);
+            prop_assert!(approx_eq(c.position[1], fy0 + fy1, 0.0001));
-            assert_approx_eq!(c.height, fh0 + fh1);
+            prop_assert!(approx_eq(c.height, fh0 + fh1, 0.0001));
         }
 
         #[test]
+        #[allow(clippy::cast_lossless, clippy::cast_precision_loss)]
         fn proptest_sub(x0 in -1_000_000_000..1_000_000_000i32, y0 in -1_000_000_000..1_000_000_000i32, h0 in 0..1_000_000_000i32, x1 in -1_000_000_000..1_000_000_000i32, y1 in -1_000_000_000..1_000_000_000i32, h1 in 0..1_000_000i32) {
             // convert our integer range inputs to FloatType
             let (fx0,fy0,fh0) = (x0 as FloatType / 1_000.0, y0 as FloatType / 1_000.0, h0 as FloatType / 1_000.0);
@@ -282,12 +289,13 @@ mod tests {
             let a = HeightVector::<2>::from(([fx0 ,fy0 ],fh0 ));
             let b = HeightVector::<2>::from(([fx1 ,fy1 ],fh1 ));
             let c = a-b;
-            assert_approx_eq!(c.position[0], fx0 - fx1);
+            prop_assert!(approx_eq(c.position[0], fx0 - fx1, 0.0001));
-            assert_approx_eq!(c.position[1], fy0 - fy1);
+            prop_assert!(approx_eq(c.position[1], fy0 - fy1, 0.0001));
-            assert_approx_eq!(c.height, fh0 + fh1);
+            prop_assert!(approx_eq(c.height, fh0 + fh1, 0.0001));
         }
 
         #[test]
+        #[allow(clippy::cast_lossless, clippy::cast_precision_loss)]
         fn proptest_mul(x in -1_000_000_000..1_000_000_000i32, y in -1_000_000_000..1_000_000_000i32, h in 0..1_000_000_000i32, m in -1_000_000_000..1_000_000_000i32) {
             // convert our integer range inputs to FloatType
             let (fx,fy,fh,fm) = (x as FloatType / 1_000.0, y as FloatType / 1_000.0, h as FloatType / 1_000.0, m as FloatType / 1_000.0);
@@ -295,11 +303,11 @@ mod tests {
             let a = HeightVector::<2>::from(([fx, fy], fh));
             let b = a * fm;
             if fm < 0.0 {
-                assert_approx_eq!(b.len(), 1.0);
+                prop_assert!(approx_eq(b.len(), 1.0, 0.0001));
             } else {
-                assert_approx_eq!(b.position[0], fx * fm);
+                prop_assert!(approx_eq(b.position[0], fx * fm, 0.0001));
-                assert_approx_eq!(b.position[1], fy * fm);
+                prop_assert!(approx_eq(b.position[1], fy * fm, 0.0001));
-                assert_approx_eq!(b.height, fh * fm);
+                prop_assert!(approx_eq(b.height, fh * fm, 0.0001));
             }
         }
     }
@@ -364,14 +372,15 @@ mod tests {
     fn test_serde() {
         // start with JSON, deserialize it
         let s = "{\"position\":[1.0,2.0,3.0],\"height\":4.0}";
-        let a: HeightVector<3> = serde_json::from_str(s).unwrap();
+        let a: HeightVector<3> =
+            serde_json::from_str(s).expect("deserialization failed during test");
 
         // make sure it's the right length and works like we expect a normal NC
         assert_approx_eq!(a.len(), 7.741_657, 0.001);
 
         // serialize it into a new JSON string and make sure it matches the original
         let t = serde_json::to_string(&a);
-        assert_eq!(t.as_ref().unwrap(), s);
+        assert_eq!(t.as_ref().expect("serialization failed during test"), s);
     }
 
     #[test]

src/lib.rs

@@ -102,6 +102,7 @@
 #![deny(clippy::cargo)]
 #![deny(clippy::pedantic)]
 #![deny(clippy::nursery)]
+#![deny(clippy::unwrap_used)]
 #![allow(clippy::type_repetition_in_bounds)]
 #![allow(clippy::module_name_repetitions)]
 

src/network_coordinate.rs

@@ -2,7 +2,7 @@
 //!
 //! For usage explanation and examples, please see the main [`crate`] documentation.
 
-use std::time::Duration;
+use core::time::Duration;
 
 use serde::{Deserialize, Serialize};
 
@@ -124,11 +124,13 @@ impl<const N: usize> NetworkCoordinate<N> {
     #[must_use]
     pub fn estimated_rtt(&self, rhs: &Self) -> Duration {
         // estimated rss is euclidean distance between the two plus the sum of the heights
-        #[cfg(feature = "f32")]
+        cfg_if::cfg_if! {
-        return Duration::from_secs_f32((self.heightvec - rhs.heightvec).len() / 1000.0);
+            if #[cfg(feature = "f32")] {
-
+                Duration::from_secs_f32((self.heightvec - rhs.heightvec).len() / 1000.0)
-        #[cfg(not(feature = "f32"))]
+            } else {
-        return Duration::from_secs_f64((self.heightvec - rhs.heightvec).len() / 1000.0);
+                Duration::from_secs_f64((self.heightvec - rhs.heightvec).len() / 1000.0)
+            }
+        }
     }
 
     /// Given another Vivaldi [`NetworkCoordinate`], adjust our coordinateto better represent the actual round
@@ -146,7 +148,7 @@ impl<const N: usize> NetworkCoordinate<N> {
     /// # Example
     ///
     /// ```
-    /// use std::time::Duration;
+    /// use core::time::Duration;
     /// use vivaldi_nc::NetworkCoordinate;
     ///
     /// // We always have our own NC:
@@ -190,15 +192,15 @@ impl<const N: usize> NetworkCoordinate<N> {
     ///
     pub fn update(&mut self, rhs: &Self, rtt: Duration) -> &Self {
         // convert Durations into FloatType as fractional milliseconds for convenience
-        #[cfg(feature = "f32")]
+        cfg_if::cfg_if! {
-        let rtt_ms = rtt.as_secs_f32() * 1000.0;
+            if #[cfg(feature = "f32")] {
-        #[cfg(feature = "f32")]
+                let rtt_ms = rtt.as_secs_f32() * 1000.0;
-        let rtt_estimated_ms = self.estimated_rtt(rhs).as_secs_f32() * 1000.0;
+                let rtt_estimated_ms = self.estimated_rtt(rhs).as_secs_f32() * 1000.0;
-
+            } else {
-        #[cfg(not(feature = "f32"))]
+                let rtt_ms = rtt.as_secs_f64() * 1000.0;
-        let rtt_ms = rtt.as_secs_f64() * 1000.0;
+                let rtt_estimated_ms = self.estimated_rtt(rhs).as_secs_f64() * 1000.0;
-        #[cfg(not(feature = "f32"))]
+            }
-        let rtt_estimated_ms = self.estimated_rtt(rhs).as_secs_f64() * 1000.0;
+        }
 
         // rtt needs to be positive
         if rtt_ms < 0.0 {
@@ -352,7 +354,6 @@ mod tests {
 
         // compute and test the root mean squared error
         let error = slc.error + nyc.error + lax.error + mad.error;
-        println!("error = {error}");
         assert!(error < 5.0);
     }
 
@@ -360,7 +361,8 @@ mod tests {
     fn test_serde() {
         // start with JSON, deserialize it
         let s = "{\"position\":[1.5,0.5,2.0],\"height\":0.1,\"error\":1.0}";
-        let a: NetworkCoordinate<3> = serde_json::from_str(s).unwrap();
+        let a: NetworkCoordinate<3> =
+            serde_json::from_str(s).expect("deserialization failed during test");
 
         // make sure it's the right length and works like we expect a normal NC
         assert_approx_eq!(a.heightvec.len(), 2.649_509, 0.001);
@@ -369,16 +371,18 @@ mod tests {
 
         // serialize it into a new JSON string and make sure it matches the original
         let t = serde_json::to_string(&a);
-        assert_eq!(t.as_ref().unwrap(), s);
+        assert_eq!(t.as_ref().expect("serialization failed during test"), s);
     }
 
     #[test]
     fn test_estimated_rtt() {
         // start with JSON, deserialize it
         let s = "{\"position\":[1.5,0.5,2.0],\"height\":25.0,\"error\":1.0}";
-        let a: NetworkCoordinate<3> = serde_json::from_str(s).unwrap();
+        let a: NetworkCoordinate<3> =
+            serde_json::from_str(s).expect("deserialization failed during test");
         let s = "{\"position\":[-1.5,-0.5,-2.0],\"height\":50.0,\"error\":1.0}";
-        let b: NetworkCoordinate<3> = serde_json::from_str(s).unwrap();
+        let b: NetworkCoordinate<3> =
+            serde_json::from_str(s).expect("deserialization failed during test");
 
         let estimate = a.estimated_rtt(&b);
         assert_approx_eq!(estimate.as_secs_f32(), 0.080_099);
@@ -387,7 +391,8 @@ mod tests {
     #[test]
     fn test_error_getter() {
         let s = "{\"position\":[1.5,0.5,2.0],\"height\":25.0,\"error\":1.0}";
-        let a: NetworkCoordinate<3> = serde_json::from_str(s).unwrap();
+        let a: NetworkCoordinate<3> =
+            serde_json::from_str(s).expect("deserialization failed during test");
         assert_approx_eq!(a.error(), 1.0);
     }
 }

src/vector.rs

@@ -8,7 +8,7 @@ use num_traits::Float;
 use serde::{Deserialize, Serialize};
 use serde_with::serde_as;
 
-use std::ops::{Add, Div, Index, Mul, Sub};
+use core::ops::{Add, Div, Index, Mul, Sub};
 
 //
 // **** Structs ****
@@ -157,16 +157,20 @@ mod tests {
     use assert_approx_eq::assert_approx_eq;
     use proptest::prelude::*;
 
+    fn approx_eq(a: f32, b: f32, margin: f32) -> bool {
+        (a - b).abs() <= margin
+    }
+
     proptest! {
         #[test]
         fn proptest_new(x: f32, y: f32, z: f32){
             let v = Vector::<f32, 3>::from([x,y,z]);
-            assert_approx_eq!(v[0], x);
+            prop_assert!(approx_eq(v[0], x, 0.0001));
-            assert_approx_eq!(v[1], y);
+            prop_assert!(approx_eq(v[1], y, 0.0001));
-            assert_approx_eq!(v[2], z);
+            prop_assert!(approx_eq(v[2], z, 0.0001));
-            assert!(v[0].is_finite());
+            prop_assert!(v[0].is_finite());
-            assert!(v[1].is_finite());
+            prop_assert!(v[1].is_finite());
-            assert!(v[1].is_finite());
+            prop_assert!(v[1].is_finite());
         }
 
         #[test]
@@ -176,21 +180,21 @@ mod tests {
 
             let (x,y,z) = (v[0]*m, v[1]*m, v[2]*m);
             if x.is_nan() || x.is_infinite() {
-                assert!(w[0].is_nan() || w[0].is_infinite());
+                prop_assert!(w[0].is_nan() || w[0].is_infinite());
             } else {
-                assert_approx_eq!(w[0], x);
+                prop_assert!(approx_eq(w[0], x, 0.0001));
             }
 
             if y.is_nan() || y.is_infinite() {
-                assert!(w[1].is_nan() || w[1].is_infinite());
+                prop_assert!(w[1].is_nan() || w[1].is_infinite());
             } else {
-                assert_approx_eq!(w[1], y);
+                prop_assert!(approx_eq(w[1], y, 0.0001));
             }
 
             if z.is_nan() || z.is_infinite() {
-                assert!(w[2].is_nan() || w[2].is_infinite());
+                prop_assert!(w[2].is_nan() || w[2].is_infinite());
             } else {
-                assert_approx_eq!(w[2], z);
+                prop_assert!(approx_eq(w[2], z, 0.0001));
             }
         }
 
@@ -201,21 +205,21 @@ mod tests {
 
             let (x,y,z) = (v[0]/d, v[1]/d, v[2]/d);
             if x.is_nan() || x.is_infinite() {
-                assert!(w[0].is_nan() ||w[0].is_infinite());
+                prop_assert!(w[0].is_nan() ||w[0].is_infinite());
             } else {
-                assert_approx_eq!(w[0], x);
+                prop_assert!(approx_eq(w[0], x, 0.0001));
             }
 
             if y.is_nan() || y.is_infinite() {
-                assert!(w[1].is_nan() || w[1].is_infinite());
+                prop_assert!(w[1].is_nan() || w[1].is_infinite());
             } else {
-                assert_approx_eq!(w[1], y);
+                prop_assert!(approx_eq(w[1], y, 0.0001));
             }
 
             if z.is_nan() || z.is_infinite() {
-                assert!(w[2].is_nan() || w[2].is_infinite());
+                prop_assert!(w[2].is_nan() || w[2].is_infinite());
             } else {
-                assert_approx_eq!(w[2], z);
+                prop_assert!(approx_eq(w[2], z, 0.0001));
             }
         }
     }
@@ -281,7 +285,10 @@ mod tests {
     fn test_serde() {
         let a = Vector::<f32, 3>::from([1.0, 2.0, 3.0]);
         let s = serde_json::to_string(&a);
-        assert_eq!(s.as_ref().unwrap(), "{\"position\":[1.0,2.0,3.0]}");
+        assert_eq!(
+            s.as_ref().expect("serialization failed in test"),
+            "{\"position\":[1.0,2.0,3.0]}"
+        );
         assert!(s.is_ok());
     }
 }

tests/basic-usage.rs

@@ -0,0 +1,22 @@
+// This is just for basic interface and happy path testing. It doesn't do anything other than make
+// sure the expected public interface exists and works.
+
+use array_init::array_init;
+use core::time::Duration;
+use vivaldi_nc::NetworkCoordinate;
+
+const NUM_NODES: usize = 100;
+
+#[test]
+fn basic_usage() {
+    let mut nc: [NetworkCoordinate<2>; NUM_NODES] = array_init(|_| NetworkCoordinate::<2>::new());
+    for i in 0..NUM_NODES {
+        for j in 0..NUM_NODES {
+            if i == j {
+                continue;
+            }
+            let other = nc[j].clone();
+            nc[i].update(&other, Duration::from_millis(100));
+        }
+    }
+}