Merge pull request #11 from alecmocatta/stable

Working on stable

Author: alecmocatta

.editorconfig

@@ -0,0 +1,5 @@
+[*]
+tab_width = 4
+
+[.*]
+tab_width = 4

.mergify.yml

@@ -3,11 +3,10 @@ pull_request_rules:
     conditions:
       - base=master
       - status-success=tests
-      - label!=work-in-progress
+      - "label!=work in progress"
       - "#approved-reviews-by>=1"
       - "#review-requested=0"
       - "#changes-requested-reviews-by=0"
-      - "#commented-reviews-by=0"
     actions:
       merge:
         method: merge
@@ -17,11 +16,10 @@ pull_request_rules:
     conditions:
       - base=master
       - status-success=tests
-      - label!=work-in-progress
+      - "label!=work in progress"
       - author=alecmocatta # https://github.com/Mergifyio/mergify-engine/issues/451
       - "#review-requested=0"
       - "#changes-requested-reviews-by=0"
-      - "#commented-reviews-by=0"
     actions:
       merge:
         method: merge
@@ -36,10 +34,10 @@ pull_request_rules:
       - "title~=^WIP: .*"
     actions:
       label:
-        add: ["work-in-progress"]
+        add: ["work in progress"]
   - name: auto remove wip label
     conditions:
       - "-title~=^WIP: .*"
     actions:
       label:
-        remove: ["work-in-progress"]
+        remove: ["work in progress"]

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "streaming_algorithms"
-version = "0.2.0"
+version = "0.3.0"
 license = "MIT OR Apache-2.0"
 authors = ["Alec Mocatta <alec@mocatta.net>"]
 categories = ["data-structures","algorithms","science"]
@@ -10,16 +10,19 @@ 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.2.0"
+documentation = "https://docs.rs/streaming_algorithms"
 readme = "README.md"
 edition = "2018"
 
 [badges]
 azure-devops = { project = "alecmocatta/streaming_algorithms", pipeline = "tests", build = "16" }
 maintenance = { status = "actively-developed" }
 
+[features]
+nightly = ["packed_simd"]
+
 [dependencies]
 twox-hash = "1.1"
 serde = { version = "1.0", features = ["derive"] }
 rand = { version = "0.7", features = ["small_rng"] }
-packed_simd = { version = "0.3", features = ["into_bits"] }
+packed_simd = { version = "0.3", features = ["into_bits"], optional = true }

README.md

@@ -4,7 +4,7 @@
 [![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?definitionId=16)
 
-[📖 Docs](https://docs.rs/streaming_algorithms/0.2.0/streaming_algorithms/) | [💬 Chat](https://constellation.zulipchat.com/#narrow/stream/213236-subprojects)
+[📖 Docs](https://docs.rs/streaming_algorithms) | [💬 Chat](https://constellation.zulipchat.com/#narrow/stream/213236-subprojects)
 
 SIMD-accelerated implementations of various [streaming algorithms](https://en.wikipedia.org/wiki/Streaming_algorithm).
 
@@ -17,10 +17,10 @@ This library is a work in progress. PRs are very welcome! Currently implemented
 
 A goal of this library is to enable composition of these algorithms; for example Top k + HyperLogLog to enable an approximate version of something akin to `SELECT key FROM table GROUP BY key ORDER BY COUNT(DISTINCT value) DESC LIMIT k`.
 
-Run your application with `RUSTFLAGS="-C target-cpu=native"` to benefit from the SIMD-acceleration like so:
+Run your application with `RUSTFLAGS="-C target-cpu=native"` and the `nightly` feature to benefit from the SIMD-acceleration like so:
 
 ```bash
-RUSTFLAGS="-C target-cpu=native" cargo run --release
+RUSTFLAGS="-C target-cpu=native" cargo run --features "streaming_algorithms/nightly" --release
 ```
 
 See [this gist](https://gist.github.com/debasishg/8172796) for a good list of further algorithms to be implemented. Other resources are [Probabilistic data structures – Wikipedia](https://en.wikipedia.org/wiki/Category:Probabilistic_data_structures), [DataSketches – A similar Java library originating at Yahoo](https://datasketches.github.io/), and [Algebird  – A similar Java library originating at Twitter](https://github.com/twitter/algebird).

azure-pipelines.yml

@@ -1,5 +1,11 @@
 trigger: ["master"]
 pr: ["master"]
+schedules:
+  - cron: "0 1 * * 0"
+    displayName: "Sunday build"
+    branches:
+      include: ["master"]
+    always: true
 
 resources:
   repositories:
@@ -13,19 +19,26 @@ jobs:
   parameters:
     endpoint: alecmocatta
     default:
-      rust_toolchain: nightly-2020-06-10
-      rust_lint_toolchain: nightly-2020-06-10
+      rust_toolchain: stable nightly
+      rust_lint_toolchain: nightly-2020-07-12
       rust_flags: ''
       rust_features: ''
-      rust_target_check: ''
-      rust_target_build: ''
+      rust_target_check: 'aarch64-unknown-linux-gnu aarch64-unknown-linux-musl'
+      rust_target_build: 'x86_64-unknown-linux-musl i686-unknown-linux-musl'
       rust_target_run: ''
     matrix:
       windows:
         imageName: 'windows-latest'
         rust_target_run: 'x86_64-pc-windows-msvc i686-pc-windows-msvc x86_64-pc-windows-gnu'
-      mac:
+      mac0:
         imageName: 'macos-latest'
+        rust_target_build: 'x86_64-unknown-linux-musl i686-unknown-linux-musl aarch64-apple-ios'
+        rust_target_run: 'x86_64-apple-darwin'
+      mac1:
+        imageName: 'macos-latest'
+        rust_toolchain: nightly
+        rust_features: ';nightly'
+        rust_target_build: 'x86_64-unknown-linux-musl i686-unknown-linux-musl aarch64-apple-ios'
         rust_target_run: 'x86_64-apple-darwin'
       linux:
         imageName: 'ubuntu-latest'

src/count_min.rs

@@ -20,14 +20,15 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
-use super::f64_to_usize;
-use crate::traits::{Intersect, IntersectPlusUnionIsPlus, New, UnionAssign};
 use serde::{Deserialize, Serialize};
 use std::{
 	borrow::Borrow, cmp::max, convert::TryFrom, fmt, hash::{Hash, Hasher}, marker::PhantomData, ops
 };
 use twox_hash::XxHash;
 
+use super::f64_to_usize;
+use crate::traits::{Intersect, IntersectPlusUnionIsPlus, New, UnionAssign};
+
 /// An implementation of a [count-min sketch](https://en.wikipedia.org/wiki/Count–min_sketch) data structure with *conservative updating* for increased accuracy.
 ///
 /// This data structure is also known as a [counting Bloom filter](https://en.wikipedia.org/wiki/Bloom_filter#Counting_filters).
@@ -75,7 +76,7 @@ where
 	where
 		Q: Hash,
 		K: Borrow<Q>,
-		C: for<'a> ops::AddAssign<&'a V>,
+		C: for<'a> ops::AddAssign<&'a V> + IntersectPlusUnionIsPlus,
 	{
 		if !<C as IntersectPlusUnionIsPlus>::VAL {
 			let offsets = self.offsets(key);