Deprecate in favour of rand_distr::Zipf

jonhoo · jonhoo · commit d4531e648cba · 2025-02-08T21:45:52.000+01:00
It uses the same implementation, and is maintained by a larger group of people who also keep up with `rand`. Closes #12.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "zipf"
-version = "7.0.1"
+version = "7.0.2"
 readme = "./README.md"
 description = "A fast generator of discrete, bounded Zipf-distributed random numbers"
 authors = ["Jon Gjengset <jon@thesquareplanet.com>"]
diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
+> [!CAUTION]
+> This crate is deprecated. Prefer
+> [`rand_distr::Zipf`](https://docs.rs/rand_distr/latest/rand_distr/struct.Zipf.html).
+
+---
+
 # rust-zipf
 
 [![Crates.io](https://img.shields.io/crates/v/zipf.svg)](https://crates.io/crates/zipf)
diff --git a/src/lib.rs b/src/lib.rs
@@ -36,6 +36,7 @@ use rand::Rng;
 /// Random number generator that generates Zipf-distributed random numbers using rejection
 /// inversion.
 #[derive(Clone, Copy)]
+#[deprecated = "prefer rand_distr::Zipf"]
 pub struct ZipfDistribution {
     /// Number of elements
     num_elements: f64,
