diff --git a/Cargo.toml b/Cargo.toml index ae3317e6739..d8e9ea02dd8 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -27,10 +27,12 @@ simd_support = [] # enables SIMD support serde1 = ["serde", "serde_derive", "rand_core/serde1"] # enables serialization for PRNGs [workspace] -members = ["rand_core"] +members = ["rand_core", "rand_isaac"] [dependencies] rand_core = { path = "rand_core", version = "0.2", default-features = false } +# only for deprecations and benches: +rand_isaac = { path = "rand_isaac", version = "0.1", default-features = false } log = { version = "0.4", optional = true } serde = { version = "1", optional = true } serde_derive = { version = "1", optional = true } diff --git a/benches/generators.rs b/benches/generators.rs index 402a87baeed..d89afd0f61c 100644 --- a/benches/generators.rs +++ b/benches/generators.rs @@ -2,6 +2,7 @@ extern crate test; extern crate rand; +extern crate rand_isaac; const RAND_BENCH_N: u64 = 1000; const BYTES_LEN: usize = 1024; diff --git a/rand_isaac/CHANGELOG.md b/rand_isaac/CHANGELOG.md new file mode 100644 index 00000000000..e47d6e86532 --- /dev/null +++ b/rand_isaac/CHANGELOG.md @@ -0,0 +1,8 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [0.1.0] - 2018-07-16 +- Initial release diff --git a/rand_isaac/Cargo.toml b/rand_isaac/Cargo.toml new file mode 100644 index 00000000000..d2261e4bb34 --- /dev/null +++ b/rand_isaac/Cargo.toml @@ -0,0 +1,26 @@ +[package] +name = "rand_isaac" +version = "0.1.0" # NB: When modifying, also modify html_root_url in lib.rs +authors = ["The Rust Project Developers"] +license = "MIT/Apache-2.0" +readme = "README.md" +repository = "https://github.com/rust-lang-nursery/rand" +documentation = "https://docs.rs/rand_isaac" +homepage = "https://crates.io/crates/rand_isaac" +description = """ +ISAAC random number generator +""" +keywords = ["random", "rng", "isaac"] +categories = ["algorithms", "no-std"] + +[badges] +travis-ci = { repository = "rust-lang-nursery/rand" } +appveyor = { repository = "alexcrichton/rand" } + +[features] +serde1 = ["serde", "serde_derive"] # enables serde for BlockRng wrapper + +[dependencies] +rand_core = { path = "../rand_core", version = "0.2", default-features=false } +serde = { version = "1", optional = true } +serde_derive = { version = "^1.0.38", optional = true } diff --git a/rand_isaac/LICENSE-APACHE b/rand_isaac/LICENSE-APACHE new file mode 100644 index 00000000000..17d74680f8c --- /dev/null +++ b/rand_isaac/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/rand_isaac/LICENSE-MIT b/rand_isaac/LICENSE-MIT new file mode 100644 index 00000000000..39d4bdb5acd --- /dev/null +++ b/rand_isaac/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2014 The Rust Project Developers + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/rand_isaac/README.md b/rand_isaac/README.md new file mode 100644 index 00000000000..21339ada327 --- /dev/null +++ b/rand_isaac/README.md @@ -0,0 +1,53 @@ +# rand_isaac + +[![Build Status](https://travis-ci.org/rust-lang-nursery/rand.svg)](https://travis-ci.org/rust-lang-nursery/rand) +[![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang-nursery/rand?svg=true)](https://ci.appveyor.com/project/alexcrichton/rand) +[![Latest version](https://img.shields.io/crates/v/rand_isaac.svg)](https://crates.io/crates/rand_isaac) +[![Documentation](https://docs.rs/rand_isaac/badge.svg)](https://docs.rs/rand_isaac) +[![Minimum rustc version](https://img.shields.io/badge/rustc-1.22+-yellow.svg)](https://github.com/rust-lang-nursery/rand#rust-version-requirements) +[![License](https://img.shields.io/crates/l/rand_isaac.svg)](https://github.com/rust-lang-nursery/rand/tree/master/rand_isaac#license) + +Implements the ISAAC and ISAAC-64 random number generators. + +ISAAC stands for "Indirection, Shift, Accumulate, Add, and Count" which are +the principal bitwise operations employed. It is the most advanced of a +series of array based random number generator designed by Robert Jenkins +in 1996[^1][^2]. + +ISAAC is notably fast and produces excellent quality random numbers for +non-cryptographic applications. + +Documentation: +[master branch](https://rust-lang-nursery.github.io/rand/rand_isaac/index.html), +[by release](https://docs.rs/rand_isaac) + +[Changelog](CHANGELOG.md) + +[rand]: https://crates.io/crates/rand + +[^1]: Bob Jenkins, [*ISAAC: A fast cryptographic random number generator*](http://burtleburtle.net/bob/rand/isaacafa.html) +[^2]: Bob Jenkins, [*ISAAC and RC4*](http://burtleburtle.net/bob/rand/isaac.html) + + +## Crate Features + +`rand_isaac` supports `no_std` and `alloc`-only configurations, as well as full +`std` functionality. The differences between `no_std` and full `std` are small, +comprising `RngCore` support for `Box` types where `R: RngCore`, as well as +extensions to the `Error` type's functionality. + +Due to [rust-lang/cargo#1596](https://github.com/rust-lang/cargo/issues/1596), +`rand_isaac` is built without `std` support by default. Since features are +unioned across the whole dependency tree, any crate using `rand` with its +default features will also enable `std` support in `rand_isaac`. + +The `serde1` feature includes implementations of `Serialize` and `Deserialize` +for the included RNGs. + + +# License + +`rand_isaac` is distributed under the terms of both the MIT license and the +Apache License (Version 2.0). + +See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details. diff --git a/src/prng/isaac.rs b/rand_isaac/src/isaac.rs similarity index 98% rename from src/prng/isaac.rs rename to rand_isaac/src/isaac.rs index 4a9a1b63ecf..6a8121b8470 100644 --- a/src/prng/isaac.rs +++ b/rand_isaac/src/isaac.rs @@ -1,4 +1,4 @@ -// Copyright 2013 The Rust Project Developers. See the COPYRIGHT +// Copyright 2013-2018 The Rust Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // https://rust-lang.org/COPYRIGHT. // @@ -14,7 +14,7 @@ use core::{fmt, slice}; use core::num::Wrapping as w; use rand_core::{RngCore, SeedableRng, Error, le}; use rand_core::block::{BlockRngCore, BlockRng}; -use prng::isaac_array::IsaacArray; +use isaac_array::IsaacArray; #[allow(non_camel_case_types)] type w32 = w; @@ -87,9 +87,9 @@ const RAND_SIZE: usize = 1 << RAND_SIZE_LEN; /// [^3]: Jean-Philippe Aumasson, [*On the pseudo-random generator ISAAC*]( /// https://eprint.iacr.org/2006/438) /// -/// [`Hc128Rng`]: ../hc128/struct.Hc128Rng.html -/// [`BlockRng`]: ../../../rand_core/block/struct.BlockRng.html -/// [`RngCore`]: ../../trait.RngCore.html +/// [`Hc128Rng`]: ../../rand/prng//hc128/struct.Hc128Rng.html +/// [`BlockRng`]: ../../rand_core/block/struct.BlockRng.html +/// [`RngCore`]: ../../rand_core/trait.RngCore.html #[derive(Clone, Debug)] #[cfg_attr(feature="serde1", derive(Serialize, Deserialize))] pub struct IsaacRng(BlockRng); @@ -354,7 +354,7 @@ impl SeedableRng for IsaacCore { #[cfg(test)] mod test { - use {RngCore, SeedableRng}; + use rand_core::{RngCore, SeedableRng}; use super::IsaacRng; #[test] diff --git a/src/prng/isaac64.rs b/rand_isaac/src/isaac64.rs similarity index 98% rename from src/prng/isaac64.rs rename to rand_isaac/src/isaac64.rs index 2a749b66c46..b77f3bbec4d 100644 --- a/src/prng/isaac64.rs +++ b/rand_isaac/src/isaac64.rs @@ -1,4 +1,4 @@ -// Copyright 2013 The Rust Project Developers. See the COPYRIGHT +// Copyright 2013-2018 The Rust Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // https://rust-lang.org/COPYRIGHT. // @@ -14,7 +14,7 @@ use core::{fmt, slice}; use core::num::Wrapping as w; use rand_core::{RngCore, SeedableRng, Error, le}; use rand_core::block::{BlockRngCore, BlockRng64}; -use prng::isaac_array::IsaacArray; +use isaac_array::IsaacArray; #[allow(non_camel_case_types)] type w64 = w; @@ -77,9 +77,9 @@ const RAND_SIZE: usize = 1 << RAND_SIZE_LEN; /// http://burtleburtle.net/bob/rand/isaac.html) /// /// [`IsaacRng`]: ../isaac/struct.IsaacRng.html -/// [`Hc128Rng`]: ../hc128/struct.Hc128Rng.html -/// [`BlockRng64`]: ../../../rand_core/block/struct.BlockRng64.html -/// [`RngCore`]: ../../trait.RngCore.html +/// [`Hc128Rng`]: ../../rand/prng/hc128/struct.Hc128Rng.html +/// [`BlockRng64`]: ../../rand_core/block/struct.BlockRng64.html +/// [`RngCore`]: ../../rand_core/trait.RngCore.html #[derive(Clone, Debug)] #[cfg_attr(feature="serde1", derive(Serialize, Deserialize))] pub struct Isaac64Rng(BlockRng64); @@ -317,7 +317,7 @@ impl SeedableRng for Isaac64Core { #[cfg(test)] mod test { - use {RngCore, SeedableRng}; + use rand_core::{RngCore, SeedableRng}; use super::Isaac64Rng; #[test] diff --git a/src/prng/isaac_array.rs b/rand_isaac/src/isaac_array.rs similarity index 100% rename from src/prng/isaac_array.rs rename to rand_isaac/src/isaac_array.rs diff --git a/rand_isaac/src/lib.rs b/rand_isaac/src/lib.rs new file mode 100644 index 00000000000..4f5f1f8742b --- /dev/null +++ b/rand_isaac/src/lib.rs @@ -0,0 +1,35 @@ +// Copyright 2018 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// https://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +//! The ISAAC and ISAAC-64 random number generators. + +#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png", + html_favicon_url = "https://www.rust-lang.org/favicon.ico", + html_root_url = "https://docs.rs/rand_isaac/0.1.0")] + +#![deny(missing_docs)] +#![deny(missing_debug_implementations)] +#![doc(test(attr(allow(unused_variables), deny(warnings))))] + +#![no_std] + +extern crate rand_core; + +#[cfg(test)] #[cfg(feature="serde1")] extern crate bincode; +#[cfg(feature="serde1")] extern crate serde; +#[cfg(feature="serde1")] #[macro_use] extern crate serde_derive; + +pub mod isaac; +pub mod isaac64; + +mod isaac_array; + +pub use self::isaac::IsaacRng; +pub use self::isaac64::Isaac64Rng; diff --git a/src/deprecated.rs b/src/deprecated.rs index 5ad73527fea..693ce372747 100644 --- a/src/deprecated.rs +++ b/src/deprecated.rs @@ -15,14 +15,15 @@ use {prng, rngs}; use {RngCore, CryptoRng, SeedableRng, Error}; use rand_core::block::BlockRngCore; +use rand_isaac; #[cfg(feature="std")] use std::io::Read; #[derive(Clone, Debug)] #[deprecated(since="0.6.0", - note="import with rand::prng::IsaacRng instead, or use the newer Hc128Rng")] -pub struct IsaacRng(prng::IsaacRng); + note="import from rand_isaac crate instead, or use the newer Hc128Rng")] +pub struct IsaacRng(rand_isaac::IsaacRng); impl RngCore for IsaacRng { #[inline(always)] @@ -47,28 +48,28 @@ impl RngCore for IsaacRng { } impl SeedableRng for IsaacRng { - type Seed = ::Seed; + type Seed = ::Seed; fn from_seed(seed: Self::Seed) -> Self { - IsaacRng(prng::IsaacRng::from_seed(seed)) + IsaacRng(rand_isaac::IsaacRng::from_seed(seed)) } fn from_rng(rng: R) -> Result { - prng::IsaacRng::from_rng(rng).map(IsaacRng) + rand_isaac::IsaacRng::from_rng(rng).map(IsaacRng) } } impl IsaacRng { pub fn new_from_u64(seed: u64) -> Self { - IsaacRng(prng::IsaacRng::new_from_u64(seed)) + IsaacRng(rand_isaac::IsaacRng::new_from_u64(seed)) } } #[derive(Clone, Debug)] #[deprecated(since="0.6.0", - note="import with rand::prng::Isaac64Rng instead, or use newer Hc128Rng")] -pub struct Isaac64Rng(prng::Isaac64Rng); + note="import from rand_isaac crate instead, or use newer Hc128Rng")] +pub struct Isaac64Rng(rand_isaac::Isaac64Rng); impl RngCore for Isaac64Rng { #[inline(always)] @@ -93,20 +94,20 @@ impl RngCore for Isaac64Rng { } impl SeedableRng for Isaac64Rng { - type Seed = ::Seed; + type Seed = ::Seed; fn from_seed(seed: Self::Seed) -> Self { - Isaac64Rng(prng::Isaac64Rng::from_seed(seed)) + Isaac64Rng(rand_isaac::Isaac64Rng::from_seed(seed)) } fn from_rng(rng: R) -> Result { - prng::Isaac64Rng::from_rng(rng).map(Isaac64Rng) + rand_isaac::Isaac64Rng::from_rng(rng).map(Isaac64Rng) } } impl Isaac64Rng { pub fn new_from_u64(seed: u64) -> Self { - Isaac64Rng(prng::Isaac64Rng::new_from_u64(seed)) + Isaac64Rng(rand_isaac::Isaac64Rng::new_from_u64(seed)) } } diff --git a/src/lib.rs b/src/lib.rs index 695654ab002..92dd60aa16a 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -249,6 +249,7 @@ extern crate stdweb; extern crate wasm_bindgen; extern crate rand_core; +extern crate rand_isaac; // only for deprecations #[cfg(feature = "log")] #[macro_use] extern crate log; #[allow(unused)] diff --git a/src/prng/mod.rs b/src/prng/mod.rs index 240b6828b4f..126cf297db5 100644 --- a/src/prng/mod.rs +++ b/src/prng/mod.rs @@ -83,7 +83,8 @@ //! ciphers are basically a CSPRNG and a combining operation, usually XOR. This //! means that we can easily use any stream cipher as a CSPRNG. //! -//! Rand currently provides two trustworthy CSPRNGs and two CSPRNG-like PRNGs: +//! This crate currently provides two CSPRNGs. The sub-crate `rand_isaac` +//! provides two CSPRNG-like PRNGs: //! //! | name | full name | performance | initialization | memory | predictability | forward secrecy | //! |------|-----------|--------------|--------------|----------|----------------|-------------------------| @@ -301,8 +302,8 @@ //! [`XorShiftRng`]: struct.XorShiftRng.html //! [`ChaChaRng`]: chacha/struct.ChaChaRng.html //! [`Hc128Rng`]: hc128/struct.Hc128Rng.html -//! [`IsaacRng`]: isaac/struct.IsaacRng.html -//! [`Isaac64Rng`]: isaac64/struct.Isaac64Rng.html +//! [`IsaacRng`]: ../../rand_isaac/isaac/struct.IsaacRng.html +//! [`Isaac64Rng`]: ../../rand_isaac/isaac64/struct.Isaac64Rng.html //! [`ThreadRng`]: ../rngs/struct.ThreadRng.html //! [`FromEntropy`]: ../trait.FromEntropy.html //! [`EntropyRng`]: ../rngs/struct.EntropyRng.html @@ -317,14 +318,18 @@ pub mod chacha; pub mod hc128; -pub mod isaac; -pub mod isaac64; mod xorshift; -mod isaac_array; - pub use self::chacha::ChaChaRng; pub use self::hc128::Hc128Rng; -pub use self::isaac::IsaacRng; -pub use self::isaac64::Isaac64Rng; pub use self::xorshift::XorShiftRng; + +// Deprecations (to be removed in 0.7) +#[doc(hidden)] pub mod isaac { + // Note: we miss `IsaacCore` here but probably unimportant. + #[allow(deprecated)] pub use deprecated::IsaacRng; +} +#[doc(hidden)] pub mod isaac64 { + #[allow(deprecated)] pub use deprecated::Isaac64Rng; +} +#[doc(hidden)] #[allow(deprecated)] pub use deprecated::{IsaacRng, Isaac64Rng};