15 Commits
Author SHA1 Message Date
swaits b1c37b7b8f bump crate to 0.6.2
Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-13 10:58:18 -07:00
swaits bc043ad54b fix(test): allow clippy lints on specific tests 2023-02-13 10:51:28 -07:00
swaits 96f64f189c dev: add husky for pre-commit hook generation
Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-13 10:48:19 -07:00
swaits 609cc3e98c refactor: clean up by using cfg-if where possible
Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-13 10:41:49 -07:00
swaits d1bc523b67 misc cleanup
- move from std::ops to core::ops
- remove unnecessary println! calls in tests

Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-13 09:52:35 -07:00
swaits e6011b4548 refactor: change unwrap()s to expects() and deny in clippy
Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-13 09:30:00 -07:00
swaits c267d4b9b2 refactor: change std::time::Duration to std::core::Duration
One step closer to `no_std`.

Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-13 09:29:12 -07:00
swaits b76c6c9775 test: use prop_assert* macros where appropriate
The prop_assert* macros clean-up the assertion output by eliminating the extra panics while it’s reducing inputs.

Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-13 09:28:09 -07:00
swaits 794d6dffb1 bump crate to 0.6.1 2023-02-10 23:02:46 -05:00
swaits c3d210cf16 refactor: switch to array-init
- Use array-init for the lowest level vector operations. Makes them nicer and less bug-prone, with zero performance impact.
- Remove unnecessary/unused ::new() functions on Vector and HeightVector.
- Update README with new dependency.
- Fix typo in README.

Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-10 22:51:38 -05:00
swaits e79242118f bump crate to 0.6.0 2023-02-10 12:38:11 -07:00
swaits 0a62dc06b3 test sr.ht build manifest using package instead of cargo install
Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-10 12:31:57 -07:00
swaits 79c90cbd4f test: get to 100% coverage, clean up cargo features
- eliminated `f64` feature because Cargo doesn’t understand mutually exclusive features. So, we default to `f64`, and leave the `f32` feature there if people want to change to that.
- integrated tarpaulin for coverage
- added tests to get to 100% coverage
- fixed NetworkCoordinate Div impl safety checks (now acts like Add and Sub)
- update README to explain cargo feature change
- cleanup build script with the new simpler features model

Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-10 12:14:24 -07:00
swaits f829708e5a test: add examples to CI
Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-09 20:25:51 -07:00
swaits 1ce84b63ec test: add more stuff to CI
Signed-off-by: Stephen Waits <steve@waits.net>
2023-02-09 20:17:24 -07:00
11 changed files with 238 additions and 123 deletions

No files matched your search

+29 -7
View File
@@ -1,26 +1,48 @@
image: archlinux
packages:
- rustup
- cargo-tarpaulin
sources:
- https://git.sr.ht/~swaits/vivaldi-nc
artifacts:
- vivaldi-nc/tarpaulin-report.html
tasks:
- setup: |
rustup toolchain install nightly stable
cd vivaldi-nc/
rustup run stable cargo fetch
- format: |
rustup default stable
cd vivaldi-nc/
cargo fmt --verbose --check --all
- lint: |
rustup default stable
cd vivaldi-nc/
cargo clippy --verbose --all-targets --all-features
- coverage: |
rustup default stable
cd vivaldi-nc/
cargo tarpaulin --verbose --all-features --out Html
- stable: |
rustup default stable
cd vivaldi-nc/
cargo fmt --verbose --check
cargo clippy --verbose
cargo build --verbose
cargo test --verbose
cargo build --verbose --all-targets --all-features
cargo test --verbose --all-features
- nightly: |
rustup default nightly
cd vivaldi-nc/
cargo clippy --verbose ||:
cargo build --verbose ||:
cargo test --verbose ||:
cargo clippy --verbose --all-targets --all-features ||:
cargo build --verbose --all-targets --all-features ||:
cargo test --verbose --all-targets --all-features ||:
- bench: |
rustup default stable
cd vivaldi-nc/
cargo bench --verbose --all-targets --all-features
- examples: |
rustup default stable
cd vivaldi-nc/
cargo run --verbose --all-features --example planetlab
cargo run --verbose --all-features --example planetlab --release
- docs: |
cd vivaldi-nc/
rustup run stable cargo doc --no-deps
+1
View File
@@ -1,3 +1,4 @@
/flamegraph.svg
/target
Cargo.lock
/tarpaulin-report.html
+5 -3
View File
@@ -1,6 +1,6 @@
[package]
name = "vivaldi-nc"
version = "0.5.4"
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."
@@ -16,9 +16,8 @@ exclude = [
]
[features]
default = ["f32"]
default = []
f32 = []
f64 = []
[profile.bench]
debug = true
@@ -29,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 +37,8 @@ name = "million-updates"
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"]}
+13 -5
View File
@@ -112,18 +112,20 @@ usage examples.
### Cargo Features
By default, the internal data structures and operations all use `f32`. If you want to use `f64`, you can enable it as a cargo feature:
By default, the internal data structures and operations all use `f64`, which is
slightly faster on modern architectures. If you want to use `f32` instead, you
can enable it as a cargo feature:
```toml
[dependencies]
vivaldi-nc = { version = "0.5.2", features = ["f64"] }
vivaldi-nc = { version = "(version)", features = ["f32"] }
```
### Examples
The repository includes an example which loads a n-to-n latency sample from
PlanetLab and iterates on `NetworkCoordinate`s until some low-enough mean error
is reached. The output is a JSON array of elements which contain the NC's
The repository includes an example which loads a 490 node N-to-N latency sample
from PlanetLab and iterates on `NetworkCoordinate`s until some low-enough mean
error is reached. The output is a JSON array of elements which contain the NC's
position, its height (or stem latency estimate), and its estimation of error
(lower is better) that look like this:
@@ -186,6 +188,12 @@ This crate depends on:
- [`serde_with`](https://crates.io/crates/serde_with): Because the inner
`Vector<T,N>` uses a const generic length, we use this to help derive
`Deserialize`.
- [`array-init`](https://crates.io/crates/array-init): Makes the array
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
+1 -1
View File
@@ -1,4 +1,4 @@
use std::time::Duration;
use core::time::Duration;
use criterion::{criterion_group, criterion_main, Criterion};
use vivaldi_nc::{NetworkCoordinate2D, NetworkCoordinate3D};
+13 -1
View File
@@ -2,6 +2,18 @@
//
// for info on the format, see `NetLatency-Data/README.md`
//
// **** Features ****
//
/// `FloatType` is a type alias for either `f32` or `f64` depending on cargo features
#[cfg(feature = "f32")]
type FloatType = f32;
/// `FloatType` is a type alias for either `f32` or `f64` depending on cargo features
#[cfg(not(feature = "f32"))]
type FloatType = f64;
use std::{
fs::File,
io::{BufReader, Read},
@@ -85,7 +97,7 @@ fn main() {
nc[i_local].update(&nc_remote, rtt_measured);
// complete, now let's sum up the error
error = nc.iter().map(|n| n.error()).sum::<f32>() / NUM_NODES as f32;
error = nc.iter().map(|n| n.error()).sum::<FloatType>() / NUM_NODES as FloatType;
assert!(error.is_finite());
if error < 5.0 {
break;
+74 -37
View File
@@ -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(feature = "f32")]
type FloatType = f32;
/// `FloatType` is a type alias for either `f32` or `f64` depending on cargo features
#[cfg(feature = "f64")]
type FloatType = f64;
cfg_if::cfg_if! {
if #[cfg(feature = "f32")] {
/// `FloatType` is a type alias for either `f32` or `f64` depending on cargo features
type FloatType = f32;
} else {
/// `FloatType` is a type alias for either `f32` or `f64` depending on cargo features
type FloatType = f64;
}
}
//
// **** Constants ****
@@ -92,11 +94,6 @@ pub struct HeightVector<const N: usize> {
//
impl<const N: usize> HeightVector<N> {
/// A new height vector is a random unit vector
pub(crate) fn new() -> Self {
Self::random()
}
/// A new height vector is a random unit vector
pub(crate) fn random() -> Self {
let mut rng = rand::thread_rng();
@@ -122,15 +119,16 @@ impl<const N: usize> HeightVector<N> {
/// by the inveerse of its length.
pub(crate) fn normalized(&self) -> Self {
let len = self.len();
if len < FloatType::EPSILON {
// if we have a bad vector, generate a new random vector
Self::new()
// scale it by the inverse of its magnitude like any normal vector
let ret = Self {
position: self.position / len,
height: self.height / len,
};
if ret.is_valid() {
ret
} else {
// otherwise scale it by the inverse of its magnitude like any normal vector
Self {
position: self.position / len,
height: self.height / len,
}
// if we have a bad vector, generate a new random vector
Self::random()
}
}
@@ -244,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);
@@ -272,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);
assert_approx_eq!(c.position[1], fy0 + fy1);
assert_approx_eq!(c.height, fh0 + fh1);
prop_assert!(approx_eq(c.position[0], fx0 + fx1, 0.0001));
prop_assert!(approx_eq(c.position[1], fy0 + fy1, 0.0001));
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);
@@ -286,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);
assert_approx_eq!(c.position[1], fy0 - fy1);
assert_approx_eq!(c.height, fh0 + fh1);
prop_assert!(approx_eq(c.position[0], fx0 - fx1, 0.0001));
prop_assert!(approx_eq(c.position[1], fy0 - fy1, 0.0001));
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);
@@ -299,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);
assert_approx_eq!(b.position[1], fy * fm);
assert_approx_eq!(b.height, fh * fm);
prop_assert!(approx_eq(b.position[0], fx * fm, 0.0001));
prop_assert!(approx_eq(b.position[1], fy * fm, 0.0001));
prop_assert!(approx_eq(b.height, fh * fm, 0.0001));
}
}
}
@@ -317,7 +321,7 @@ mod tests {
#[test]
fn test_new() {
// new gives us a random unit length vec
let a = HeightVector::<3>::new();
let a = HeightVector::<3>::random();
assert_approx_eq!(a.len(), 1.0);
}
@@ -368,13 +372,46 @@ 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]
fn test_sub_invalid() {
let valid = HeightVector::<2>::from(([1.0, 2.0], 3.0));
let mut invalid = HeightVector::<2>::from(([1.0, 2.0], 3.0));
// force invalidity here - because `::from()` actually also catches this
invalid.height = 1.0 / 0.0;
let result = valid - invalid;
assert_approx_eq!(result.len(), 1.0);
}
#[test]
fn test_add_invalid() {
let valid = HeightVector::<2>::from(([1.0, 2.0], 3.0));
let mut invalid = HeightVector::<2>::from(([1.0 / 0.0, 2.0], 3.0));
// make sure `from()` caught and replaced the invalid vec
assert_approx_eq!(invalid.len(), 1.0);
// force invalidity here - because `::from()` actually also catches this
invalid.height = 1.0 / 0.0;
let result = valid + invalid;
assert_approx_eq!(result.len(), 1.0);
}
#[test]
fn test_zero_norm() {
let a = HeightVector::<2>::from(([0.0, 0.0], 0.0));
let b = a.normalized();
let len = b.len();
assert_approx_eq!(len, 1.0);
}
}
+1 -4
View File
@@ -102,16 +102,13 @@
#![deny(clippy::cargo)]
#![deny(clippy::pedantic)]
#![deny(clippy::nursery)]
#![deny(clippy::unwrap_used)]
#![allow(clippy::type_repetition_in_bounds)]
#![allow(clippy::module_name_repetitions)]
mod height_vector;
mod vector;
// make sure we don't have conflicting features
#[cfg(all(feature = "f32", feature = "f64"))]
compile_error!("feature \"f32\" and feature \"f64\" cannot be enabled at the same time");
// publish our interface
pub mod network_coordinate;
pub use network_coordinate::NetworkCoordinate;
+42 -23
View File
@@ -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};
@@ -14,7 +14,7 @@ use crate::height_vector::HeightVector;
#[cfg(feature = "f32")]
type FloatType = f32;
#[cfg(feature = "f64")]
#[cfg(not(feature = "f32"))]
type FloatType = f64;
//
@@ -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")]
return Duration::from_secs_f32((self.heightvec - rhs.heightvec).len() / 1000.0);
#[cfg(feature = "f64")]
return Duration::from_secs_f64((self.heightvec - rhs.heightvec).len() / 1000.0);
cfg_if::cfg_if! {
if #[cfg(feature = "f32")] {
Duration::from_secs_f32((self.heightvec - rhs.heightvec).len() / 1000.0)
} else {
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,19 +192,22 @@ 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")]
let rtt_ms = rtt.as_secs_f32() * 1000.0;
#[cfg(feature = "f32")]
let rtt_estimated_ms = self.estimated_rtt(rhs).as_secs_f32() * 1000.0;
#[cfg(feature = "f64")]
let rtt_ms = rtt.as_secs_f64() * 1000.0;
#[cfg(feature = "f64")]
let rtt_estimated_ms = self.estimated_rtt(rhs).as_secs_f64() * 1000.0;
cfg_if::cfg_if! {
if #[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;
} else {
let rtt_ms = rtt.as_secs_f64() * 1000.0;
let rtt_estimated_ms = self.estimated_rtt(rhs).as_secs_f64() * 1000.0;
}
}
// rtt needs to be positive
if rtt_ms < 0.0 {
return self;
// Note: `rtt` is guaranteed to be positive because `Duration` enforces it.
// If this panics, something changed where `Duration` now allows for negative
// values.
unreachable!();
}
// Sample weight balances local and remote error. (1)
@@ -233,6 +238,10 @@ impl<const N: usize> NetworkCoordinate<N> {
// error
if self.heightvec.is_invalid() {
*self = Self::new();
// We should never get here because the call to `normalized()` above should catch any
// invalid `heightvec`
unreachable!();
}
// return reference to updated self
@@ -345,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);
}
@@ -353,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);
@@ -362,18 +371,28 @@ 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);
}
#[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).expect("deserialization failed during test");
assert_approx_eq!(a.error(), 1.0);
}
}
+37 -42
View File
@@ -3,11 +3,12 @@
//! This is the simplest possible implementation of a vector to support the needs of a
//! Vivaldi `HeightVector`.
use array_init::array_init;
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 ****
@@ -37,11 +38,6 @@ impl<T, const N: usize> Vector<T, N>
where
T: Float + Serialize + for<'d> Deserialize<'d>,
{
/// Create a new Zero vector.
pub(crate) fn new() -> Self {
Self::default()
}
/// Compute magnitude of vector.
pub(crate) fn len(&self) -> T {
// use hypot() instead of sqrt() of sum of squares to avoid overflows
@@ -90,11 +86,9 @@ where
/// Vector+Vector addition.
fn add(self, rhs: Self) -> Self::Output {
let mut ret = [T::zero(); N]; //Self::Output::new();
for i in 0..N {
ret[i] = self[i] + rhs[i];
Self::Output {
inner: array_init(|i| self[i] + rhs[i]),
}
Self::Output::from(ret)
}
}
@@ -106,11 +100,9 @@ where
/// Vector-Vector subtraction.
fn sub(self, rhs: Self) -> Self::Output {
let mut ret = [T::zero(); N]; //Self::Output::new();
for i in 0..N {
ret[i] = self[i] - rhs[i];
Self::Output {
inner: array_init(|i| self[i] - rhs[i]),
}
Self::Output::from(ret)
}
}
@@ -122,11 +114,9 @@ where
/// Vector*scalar multiplication.
fn mul(self, rhs: T) -> Self::Output {
let mut ret = Self::Output::new();
for i in 0..N {
ret.inner[i] = self.inner[i] * rhs;
Self::Output {
inner: array_init(|i| self[i] * rhs),
}
ret
}
}
@@ -138,11 +128,9 @@ where
/// Vector/scalar division.
fn div(self, rhs: T) -> Self::Output {
let mut ret = Self::Output::new();
for i in 0..N {
ret.inner[i] = self.inner[i] / rhs;
Self::Output {
inner: array_init(|i| self[i] / rhs),
}
ret
}
}
@@ -169,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);
assert_approx_eq!(v[1], y);
assert_approx_eq!(v[2], z);
assert!(v[0].is_finite());
assert!(v[1].is_finite());
assert!(v[1].is_finite());
prop_assert!(approx_eq(v[0], x, 0.0001));
prop_assert!(approx_eq(v[1], y, 0.0001));
prop_assert!(approx_eq(v[2], z, 0.0001));
prop_assert!(v[0].is_finite());
prop_assert!(v[1].is_finite());
prop_assert!(v[1].is_finite());
}
#[test]
@@ -188,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));
}
}
@@ -213,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));
}
}
}
@@ -235,7 +227,7 @@ mod tests {
#[test]
fn test_default_new() {
let a = Vector::<f32, 3>::default();
let b = Vector::<f32, 3>::new();
let b = Vector::<f32, 3>::from([1.0; 3]) * 0.0;
let c = Vector::<f32, 3>::from([0.0; 3]);
assert_eq!(a, b);
assert_eq!(b, c);
@@ -293,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());
}
}
+22
View File
@@ -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));
}
}
}