Merge pull request #9 from alecmocatta/serialize-zeroable

Make Zeroable (de)serializable

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "streaming_algorithms"
-version = "0.1.1"
+version = "0.1.2"
 license = "MIT OR Apache-2.0"
 authors = ["Alec Mocatta <alec@mocatta.net>"]
 categories = ["data-structures","algorithms","science"]
@@ -10,12 +10,12 @@ SIMD-accelerated implementations of various streaming algorithms, including Coun
 """
 repository = "https://github.com/alecmocatta/streaming_algorithms"
 homepage = "https://github.com/alecmocatta/streaming_algorithms"
-documentation = "https://docs.rs/streaming_algorithms/0.1.1"
+documentation = "https://docs.rs/streaming_algorithms/0.1.2"
 readme = "README.md"
 edition = "2018"
 
 [badges]
-azure-devops = { project = "alecmocatta/streaming_algorithms", pipeline = "tests" }
+azure-devops = { project = "alecmocatta/streaming_algorithms", pipeline = "tests", build = "16" }
 maintenance = { status = "actively-developed" }
 
 [dependencies]

README.md

@@ -2,9 +2,9 @@
 
 [![Crates.io](https://img.shields.io/crates/v/streaming_algorithms.svg?maxAge=86400)](https://crates.io/crates/streaming_algorithms)
 [![MIT / Apache 2.0 licensed](https://img.shields.io/crates/l/streaming_algorithms.svg?maxAge=2592000)](#License)
-[![Build Status](https://dev.azure.com/alecmocatta/streaming_algorithms/_apis/build/status/tests?branchName=master)](https://dev.azure.com/alecmocatta/streaming_algorithms/_build/latest?branchName=master)
+[![Build Status](https://dev.azure.com/alecmocatta/streaming_algorithms/_apis/build/status/tests?branchName=master)](https://dev.azure.com/alecmocatta/streaming_algorithms/_build?definitionId=16)
 
-[Docs](https://docs.rs/streaming_algorithms/0.1.1)
+[📖 Docs](https://docs.rs/streaming_algorithms/0.1.2) | [💬 Chat](https://constellation.zulipchat.com/#narrow/stream/213236-subprojects)
 
 SIMD-accelerated implementations of various [streaming algorithms](https://en.wikipedia.org/wiki/Streaming_algorithm).
 

azure-pipelines.yml

@@ -14,19 +14,19 @@ jobs:
     endpoint: alecmocatta
     default:
       rust_toolchain: nightly
-      rust_lint_toolchain: nightly-2019-07-19
+      rust_lint_toolchain: nightly-2020-06-09
       rust_flags: ''
       rust_features: ''
       rust_target_check: ''
       rust_target_build: ''
       rust_target_run: ''
     matrix:
       windows:
-        imageName: 'vs2017-win2016'
-        rust_target_run: 'x86_64-pc-windows-msvc i686-pc-windows-msvc' # currently broken building crate-type=lib: x86_64-pc-windows-gnu i686-pc-windows-gnu
+        imageName: 'windows-latest'
+        rust_target_run: 'x86_64-pc-windows-msvc i686-pc-windows-msvc x86_64-pc-windows-gnu'
       mac:
-        imageName: 'macos-10.13'
-        rust_target_run: 'x86_64-apple-darwin i686-apple-darwin'
+        imageName: 'macos-latest'
+        rust_target_run: 'x86_64-apple-darwin'
       linux:
-        imageName: 'ubuntu-16.04'
+        imageName: 'ubuntu-latest'
         rust_target_run: 'x86_64-unknown-linux-gnu i686-unknown-linux-gnu x86_64-unknown-linux-musl i686-unknown-linux-musl'

src/distinct.rs

@@ -54,7 +54,7 @@ use std::{
 use twox_hash::XxHash;
 
 mod consts;
-use self::consts::*;
+use self::consts::{BIAS_DATA, RAW_ESTIMATE_DATA, TRESHOLD_DATA};
 
 /// Like [`HyperLogLog`] but implements `Ord` and `Eq` by using the estimate of the cardinality.
 #[derive(Serialize, Deserialize)]
@@ -429,7 +429,7 @@ impl<V: ?Sized> IntersectPlusUnionIsPlus for HyperLogLog<V> {
 
 #[cfg(target_feature = "avx512bw")] // TODO
 mod simd_types {
-	use super::*;
+	use super::packed_simd;
 	pub type u8s = packed_simd::u8x64;
 	pub type u8s_sad_out = packed_simd::u64x8;
 	pub type f32s = packed_simd::f32x16;
@@ -439,7 +439,7 @@ mod simd_types {
 #[cfg(target_feature = "avx2")]
 mod simd_types {
 	#![allow(non_camel_case_types)]
-	use super::*;
+	use super::packed_simd;
 	pub type u8s = packed_simd::u8x32;
 	pub type u8s_sad_out = packed_simd::u64x4;
 	pub type f32s = packed_simd::f32x8;
@@ -449,7 +449,7 @@ mod simd_types {
 #[cfg(all(not(target_feature = "avx2"), target_feature = "sse2"))]
 mod simd_types {
 	#![allow(non_camel_case_types)]
-	use super::*;
+	use super::packed_simd;
 	pub type u8s = packed_simd::u8x16;
 	pub type u8s_sad_out = packed_simd::u64x2;
 	pub type f32s = packed_simd::f32x4;
@@ -459,14 +459,14 @@ mod simd_types {
 #[cfg(all(not(target_feature = "avx2"), not(target_feature = "sse2")))]
 mod simd_types {
 	#![allow(non_camel_case_types)]
-	use super::*;
+	use super::packed_simd;
 	pub type u8s = packed_simd::u8x8;
 	pub type u8s_sad_out = u64;
 	pub type f32s = packed_simd::f32x2;
 	pub type u32s = packed_simd::u32x2;
 	pub type u8sq = packed_simd::u8x2;
 }
-use self::simd_types::*;
+use self::simd_types::{f32s, u32s, u8s, u8s_sad_out, u8sq};
 
 struct Sad<X>(PhantomData<fn(X)>);
 #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]

src/lib.rs

@@ -1,6 +1,8 @@
 //! SIMD-accelerated implementations of various [streaming algorithms](https://en.wikipedia.org/wiki/Streaming_algorithm).
 //!
-//! **[Crates.io](https://crates.io/crates/streaming_algorithms) │ [Repo](https://github.com/alecmocatta/streaming_algorithms)**
+//! <p style="font-family: 'Fira Sans',sans-serif;padding:0.3em 0"><strong>
+//! <a href="https://crates.io/crates/streaming_algorithms">📦&nbsp;&nbsp;Crates.io</a>&nbsp;&nbsp;│&nbsp;&nbsp;<a href="https://github.com/alecmocatta/streaming_algorithms">📑&nbsp;&nbsp;GitHub</a>&nbsp;&nbsp;│&nbsp;&nbsp;<a href="https://constellation.zulipchat.com/#narrow/stream/213236-subprojects">💬&nbsp;&nbsp;Chat</a>
+//! </strong></p>
 //!
 //! This library is a work in progress. PRs are very welcome! Currently implemented algorithms include:
 //!
@@ -21,8 +23,8 @@
 //!
 //! As these implementations are often in hot code paths, unsafe is used, albeit only when necessary to a) achieve the asymptotically optimal algorithm or b) mitigate an observed bottleneck.
 
-#![doc(html_root_url = "https://docs.rs/streaming_algorithms/0.1.1")]
-#![feature(specialization, try_trait)]
+#![doc(html_root_url = "https://docs.rs/streaming_algorithms/0.1.2")]
+#![feature(specialization)]
 #![warn(
 	missing_copy_implementations,
 	missing_debug_implementations,
@@ -44,7 +46,10 @@
 	clippy::op_ref,
 	clippy::needless_pass_by_value,
 	clippy::suspicious_op_assign_impl,
-	clippy::float_cmp
+	clippy::float_cmp,
+	clippy::unsafe_derive_deserialize,
+	clippy::must_use_candidate,
+	clippy::unused_self
 )]
 
 mod count_min;

src/sample.rs

@@ -220,7 +220,6 @@ impl<T> ops::AddAssign for SampleUnstable<T> {
 #[cfg(test)]
 mod test {
 	use super::*;
-	use rand;
 	use std::collections::HashMap;
 
 	#[test]

src/top.rs

@@ -153,13 +153,14 @@ impl<'a, A: Hash + Eq + Clone + Debug, C: Ord + Debug + 'a> Debug for TopIter<'a
 }
 
 /// For the result of a `std::iter::sum()` when an additive identity (i.e. zero) can't be constructed (in the case where we're summing an empty iterator).
-#[derive(Copy, Clone, Debug)]
+#[derive(Copy, Clone, Serialize, Deserialize, Debug)]
 pub enum Zeroable<T> {
 	/// Zero
 	Zero,
 	/// Nonzero
 	Nonzero(T),
 }
+#[allow(clippy::missing_errors_doc)]
 impl<T> Zeroable<T> {
 	/// Transform to a `Result<T, E>`.
 	pub fn ok_or<E>(self, err: E) -> Result<T, E> {
@@ -184,25 +185,6 @@ impl<T> From<Option<T>> for Zeroable<T> {
 		}
 	}
 }
-impl<T> std::ops::Try for Zeroable<T> {
-	type Ok = T;
-	type Error = std::option::NoneError;
-
-	#[inline]
-	fn into_result(self) -> Result<T, std::option::NoneError> {
-		self.ok_or(std::option::NoneError)
-	}
-
-	#[inline]
-	fn from_ok(v: T) -> Self {
-		Zeroable::Nonzero(v)
-	}
-
-	#[inline]
-	fn from_error(_: std::option::NoneError) -> Self {
-		Zeroable::Zero
-	}
-}
 impl<T> iter::Sum for Zeroable<T>
 where
 	Self: iter::Sum<T>,
@@ -231,7 +213,11 @@ impl<
 	where
 		I: Iterator<Item = Top<A, C>>,
 	{
-		let mut total = iter.next()?;
+		let mut total = if let Some(total) = iter.next() {
+			total
+		} else {
+			return Zeroable::Zero;
+		};
 		for sample in iter {
 			total += sample;
 		}