swaits/vivaldi-nc
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: swaits/vivaldi-nc:b737e9b381f68583a5c586cb8ca6ff46a061064d
swaits/vivaldi-nc:main
swaits/vivaldi-nc:0.6.4 swaits/vivaldi-nc:0.6.3 swaits/vivaldi-nc:0.6.2 swaits/vivaldi-nc:0.6.1 swaits/vivaldi-nc:0.6.0 swaits/vivaldi-nc:0.5.4 swaits/vivaldi-nc:0.5.3 swaits/vivaldi-nc:0.5.2 swaits/vivaldi-nc:0.5.1 swaits/vivaldi-nc:0.5.0 swaits/vivaldi-nc:0.4.1 swaits/vivaldi-nc:0.4.0 swaits/vivaldi-nc:0.3.1
..
compare: swaits/vivaldi-nc:0.6.4
swaits/vivaldi-nc:main
swaits/vivaldi-nc:0.6.4 swaits/vivaldi-nc:0.6.3 swaits/vivaldi-nc:0.6.2 swaits/vivaldi-nc:0.6.1 swaits/vivaldi-nc:0.6.0 swaits/vivaldi-nc:0.5.4 swaits/vivaldi-nc:0.5.3 swaits/vivaldi-nc:0.5.2 swaits/vivaldi-nc:0.5.1 swaits/vivaldi-nc:0.5.0 swaits/vivaldi-nc:0.4.1 swaits/vivaldi-nc:0.4.0 swaits/vivaldi-nc:0.3.1
56 Commits
b737e9b381 .. 0.6.4
Author SHA1 Message Date
swaits 16e3691e2d bump crate to 0.6.4 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-26 10:05:59 -07:00
swaits 6ab8f0dca4 chore: upgrade dependencies 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-26 10:05:33 -07:00
swaits 1a6b3983b3 chore: add MSRV (1.60) 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-26 09:54:23 -07:00
swaits db38079dfc bump crate to 0.6.3 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-13 13:11:33 -07:00
swaits f88c1d4375 test: make accepted licenses explicit 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-13 12:50:36 -07:00
swaits 90a90f49df test: fix cargo audit advisory db location 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-13 12:45:43 -07:00
swaits b3dca0d8a9 test: add audit, deny, outdated, and udeps to CI 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-13 12:36:24 -07:00
swaits 8812bacfdd test: add (and fix) more deny lints 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-13 12:35:26 -07:00
swaits a64732fa97 style: move clippy allows to specific lines of code 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-13 11:40:12 -07:00
swaits 1b50b0c042 style: more Cargo.toml formatting 2023-02-13 11:13:33 -07:00
swaits f414bdc10d style: format Cargo.toml 2023-02-13 11:10:44 -07:00
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
swaits 7159c4b07a bump crate to 0.5.4 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-09 16:39:02 -07:00
swaits c07463122a perf: add benchmark, optimize 
Realized about a 10x speedup.

- add benches/million-updates.rs
- optimization: use rand instead of nanorand (because of thread_rng() initialization being muchf aster)
- update README

Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-09 16:36:24 -07:00
swaits 2e97c879e1 bump crate to 0.5.3 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-09 11:18:04 -07:00
swaits 64543a8729 doc: updates to NetworkCoordinate 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-09 11:17:27 -07:00
swaits 8d1eadb017 enable cargo fmt check in autobuild 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-09 11:02:03 -07:00
swaits cdab359b4e enable and fix stricter clippy linting 
- add clippy to .build.yml to run on sr.ht
- add missing docs
- use core:: instead of std:: where possible
- use hypot() and mul_add() for better numeric stability
- make all float tests use asser_approx_eq() and explicitly check for NaN/Inf
- add missing semicolons here and there
- add #[must_use] to ensure caller uses returned value
- add const fn where appropriate
- change visibility from pub(crate) to pub (in private modules)

Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-09 10:54:42 -07:00
swaits c3b3ff1e4d feat: f32/f64 cargo features added 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-08 17:01:19 -07:00
swaits 2addbc68b5 doc: minor updates re: type aliases, crate to 0.5.1 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-08 15:59:15 -07:00
swaits 6294d1e520 doc: udpate crate description 2023-02-08 15:48:46 -07:00
swaits 2f8769012b bump crate to 0.5.0 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-08 15:40:47 -07:00
swaits 57891ed230 feat: type aliases for 2D/3D NetworkCoordinates 
This just adds a few type aliases for convenience, and slightly better ergonomics for the most common usage (2D or 3D).

Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-08 15:40:23 -07:00
swaits fce4946369 feat: improve ergonomics for serialization format 
Goal: To make the serialization format more sensible instead of it being a reflection of our internal (ie private) data model.

- mostly handled with #[serde()] macros (renaming, flattening)
- renamed NetworkCoordinate::position to heightvec which is a better name, even if not seen in the published interface
- changed HeightVector from a tuple struct to a named struct so we can control serde on a field-by-field basis
- updated README, tests, and doc tests to match

Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-08 15:32:27 -07:00
swaits 7f41676795 fix: exclude examples from crate 
crates.io is limited to 10MB crates

Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-07 22:09:28 -07:00
swaits 634064161f bump crate version 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-07 21:44:47 -07:00
swaits 0d9b623f9d test: add test for NetworkCoordinate::estimate_rtt 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-07 21:43:35 -07:00
swaits 828efdda01 misc: formatting 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-07 21:37:29 -07:00
swaits 3cf2f27569 test: add property tests to HeightVector 
Which also helped me fix a bug (using is_sign_negative() when we actually are okay with -0.0).

Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-07 21:37:21 -07:00
swaits 2b8fc16537 feat: add PlanetLab example 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-07 20:40:06 -07:00
swaits 8f1100d64d fix: add numeric stability 
Made `HeightVector` numerically safe; while `Vector` remains numerically unsafe (i.e. it can divide by 0, NaN, Inf, etc).

When HeightVector runs into a problem, it just re-randomizes itself. Since the algorithm converges relatively quickly, this seems to work fine.

Also fixed a bug so that now height will always start as a positive number (and stay that way, else get re-randomized).

Added safety to `NetworkCoordinate` which now checks that its error didn’t pull a `HeightVector` into a negative height; in which case it also re-randomizes.

Clarified the `random` construction, tweaked the DEFAULT_ERROR constant, and updated tests accordingly.

Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-07 20:25:10 -07:00
swaits 973365a849 test: add proptest, make vec mul/div scalar safer 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-07 16:29:01 -07:00
swaits e2d14bcc0d doc: add link to ticket tracker 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-04 10:48:28 -07:00
swaits 25e0076c8d doc: add link to docs.rs in README 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-04 10:43:36 -07:00
swaits aba483c9e1 bump crate version 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-04 10:40:57 -07:00
swaits e9febc6faa clean up export, add module level docs 
- public NetworkCoordinate so it’s easer to just `use vivaldi_nc::NetworkCoordinate`
- add module level docs and examples in lib.rs
- cleanup README

Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-04 10:39:59 -07:00
swaits c83a4e654b update README, bump crate version 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-04 09:48:01 -07:00
swaits 2fad2e18b5 feat: add serde 
Adds serialization/deserialization support via serde and serde_with.

Also:

- remove `license-file` in Cargo.toml (superfluous)
- update README with Getting Started section
- add `serde` and `serde_with` dependencies to README
- add tests to `HeightVector`
- tweak assertion in `NetworkCoordinate`
- refactor `Vector` to be a struct witn an `inner` instead of a tuple struct so that we can use `serde_as` (from `serde_with`) to help us derive SerDe implementations for the const generic sized array
- moved trait requirements (which are getting long) into where clauses

Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-04 09:42:46 -07:00
swaits 3415347072 remove Cargo.lock and add to .gitignore 
Because this is a library, Cargo.lock should not be committed.

Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-04 09:37:40 -07:00
swaits 5611618126 prep Cargo.toml for publication, add badges 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-02 22:33:15 -07:00
swaits c2399c5b8f add build badge to readme 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-02 21:56:18 -07:00
swaits f35680738c Add build script for git.sr.ht 
Signed-off-by: Stephen Waits <steve@waits.net>
 2023-02-02 21:48:35 -07:00
3 changed files with 16 additions and 31 deletions
Expand all files Collapse all files

No files matched your search

.build.yml
+1 -1
View File
@@ -47,7 +47,7 @@ tasks:
- coverage: |
rustup default stable
cd vivaldi-nc/
cargo tarpaulin --verbose --all-features --out html
cargo tarpaulin --verbose --all-features --out Html
- stable: |
rustup default stable
cd vivaldi-nc/
Cargo.toml
+14 -14
View File
@@ -1,6 +1,6 @@
[package]
name = "vivaldi-nc"
version = "0.6.10"
version = "0.6.4"
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."
@@ -12,7 +12,7 @@ readme = "README.md"
homepage = "https://sr.ht/~swaits/vivaldi-nc/"
repository = "https://git.sr.ht/~swaits/vivaldi-nc"
exclude = ["examples/*"]
rust-version = "1.64"
rust-version = "1.60"
[features]
default = []
@@ -30,22 +30,22 @@ harness = false
[dev-dependencies]
assert_approx_eq = "1.1.0"
criterion = "0.5.1"
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",
"run-for-all",
"precommit-hook",
"run-cargo-test",
"run-cargo-check",
"run-cargo-clippy",
"run-cargo-fmt",
] }
proptest = "1.2.0"
serde_json = "1.0.107"
proptest = "1.1.0"
serde_json = "1.0.93"
[dependencies]
array-init = "2.1.0"
cfg-if = "1.0.0"
num-traits = "0.2.16"
num-traits = "0.2.15"
rand = "0.8.5"
serde = { version = "1.0.188", features = ["serde_derive"] }
serde_with = "3.3.0"
serde = { version = "1.0.152", features = ["serde_derive"] }
serde_with = "2.2.0"
README.md
+1 -16
View File
@@ -1,21 +1,6 @@
# vivaldi-nc - Vivaldi Network Coordinates
![Rust Version](https://img.shields.io/badge/rustc-1.60+-blue.svg) [![docs.rs](https://img.shields.io/docsrs/vivaldi-nc)](https://docs.rs/vivaldi-nc/) [![builds.sr.ht status](https://builds.sr.ht/~swaits/vivaldi-nc.svg)](https://builds.sr.ht/~swaits/vivaldi-nc?) [![Crates.io](https://img.shields.io/crates/v/vivaldi-nc)](https://crates.io/crates/vivaldi-nc) ![Crates.io](https://img.shields.io/crates/d/vivaldi-nc) ![Crates.io](https://img.shields.io/crates/l/vivaldi-nc)
<!--toc:start-->
- [Introduction](#introduction)
- [Addressing the Drawbacks](#addressing-the-drawbacks)
- [Usage](#usage)
- [Getting Started](#getting-started)
- [Cargo Features](#cargo-features)
- [Examples](#examples)
- [Dependencies](#dependencies)
- [Design Goals & Alternatives](#design-goals-alternatives)
- [Other Vivaldi NC Implementations](#other-vivaldi-nc-implementations)
- [Other NC Algorithms](#other-nc-algorithms)
- [Getting Help or Contributing](#getting-help-or-contributing)
- [License](#license)
<!--toc:end-->
[![docs.rs](https://img.shields.io/docsrs/vivaldi-nc)](https://docs.rs/vivaldi-nc/) [![builds.sr.ht status](https://builds.sr.ht/~swaits/vivaldi-nc.svg)](https://builds.sr.ht/~swaits/vivaldi-nc?) [![Crates.io](https://img.shields.io/crates/v/vivaldi-nc)](https://crates.io/crates/vivaldi-nc) ![Crates.io](https://img.shields.io/crates/d/vivaldi-nc) ![Crates.io](https://img.shields.io/crates/l/vivaldi-nc)
## Introduction