From 3a692b1ff1fcaf712a209e9ddb9526cb4364d916 Mon Sep 17 00:00:00 2001 From: alecmocatta Date: Wed, 15 Jul 2020 09:50:50 +0100 Subject: [PATCH] v0.3.0 --- Cargo.toml | 4 ++-- README.md | 6 +++--- src/lib.rs | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index d85cda8b..d076f2f7 100644 --- a/Cargo.toml +++ b/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 "] categories = ["data-structures","algorithms","science"] @@ -10,7 +10,7 @@ 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" diff --git a/README.md b/README.md index 58ddfa2f..3243b8da 100644 --- a/README.md +++ b/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). diff --git a/src/lib.rs b/src/lib.rs index acfcde3a..b918f0ea 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -13,17 +13,17 @@ //! //! 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). //! //! 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.2.0")] +#![doc(html_root_url = "https://docs.rs/streaming_algorithms/0.3.0")] #![warn( missing_copy_implementations, missing_debug_implementations,