Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Links: prefer docs.rs over rust-random.github.io #59

Merged
merged 1 commit into from
Mar 25, 2024
Merged

Links: prefer docs.rs over rust-random.github.io #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/crates-gen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ The following crates implement pseudo-random number generators
- [`rand_xorshift`] implements the basic Xorshift generator


[`rand_chacha`]: https://rust-random.github.io/rand/rand_chacha/index.html
[`rand_chacha`]: https://docs.rs/rand_chacha/
[`rand_hc`]: https://docs.rs/rand_hc/
[`rand_isaac`]: https://docs.rs/rand_isaac/
[`rand_pcg`]: https://rust-random.github.io/rand/rand_pcg/index.html
[`rand_pcg`]: https://docs.rs/rand_pcg/
[`rand_xoshiro`]: https://docs.rs/rand_xoshiro/
[`rand_xorshift`]: https://docs.rs/rand_xorshift/
[`rand_jitter`]: https://docs.rs/rand_jitter/
Expand Down
34 changes: 17 additions & 17 deletions src/crates-rand.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,20 +50,20 @@ number distributions: uniform and weighted sampling. For everything else,

[common feature flags]: crates.md#feature-flags

[`rand_core`]: https://rust-random.github.io/rand/rand_core/index.html
[`rand`]: https://rust-random.github.io/rand/rand/index.html
[`rand_distr`]: https://rust-random.github.io/rand/rand_distr/index.html
[`statrs`]: https://github.com/boxtown/statrs

[`RngCore`]: https://rust-random.github.io/rand/rand_core/trait.RngCore.html
[`SeedableRng`]: https://rust-random.github.io/rand/rand_core/trait.SeedableRng.html
[`CryptoRng`]: https://rust-random.github.io/rand/rand_core/trait.CryptoRng.html
[`Error`]: https://rust-random.github.io/rand/rand_core/struct.Error.html

[`rngs`]: https://rust-random.github.io/rand/rand/rngs/index.html
[`distributions`]: https://rust-random.github.io/rand/rand/distributions/index.html
[`seq`]: https://rust-random.github.io/rand/rand/seq/index.html
[`Rng`]: https://rust-random.github.io/rand/rand/trait.Rng.html
[`random`]: https://rust-random.github.io/rand/rand/fn.random.html

[`SmallRng`]: https://rust-random.github.io/rand/rand/rngs/struct.SmallRng.html
[`rand_core`]: https://docs.rs/rand_core/
[`rand`]: https://docs.rs/rand/
[`rand_distr`]: https://docs.rs/rand_distr/
[`statrs`]: https://docs.rs/statrs/

[`RngCore`]: https://docs.rs/rand_core/latest/rand_core/trait.RngCore.html
[`SeedableRng`]: https://docs.rs/rand_core/latest/rand_core/trait.SeedableRng.html
[`CryptoRng`]: https://docs.rs/rand_core/latest/rand_core/trait.CryptoRng.html
[`Error`]: https://docs.rs/rand_core/latest/rand_core/struct.Error.html

[`rngs`]: https://docs.rs/rand/latest/rand/rngs/
[`distributions`]: https://docs.rs/rand/latest/rand/distributions/
[`seq`]: https://docs.rs/rand/latest/rand/seq/
[`Rng`]: https://docs.rs/rand/latest/rand/trait.Rng.html
[`random`]: https://docs.rs/rand/latest/rand/fn.random.html

[`SmallRng`]: https://docs.rs/rand/latest/rand/rngs/struct.SmallRng.html
12 changes: 6 additions & 6 deletions src/crates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Some Rand crates can be built with support for the following third-party crates:

Note that cryptographic RNGs *do not* support serialisation since this could be
a security risk. If you need state-restore functionality on a cryptographic RNG,
the ChaCha generator supports [getting and setting the stream position](https://rust-random.github.io/rand/rand_chacha/struct.ChaCha20Rng.html#method.get_word_pos),
the ChaCha generator supports [getting and setting the stream position](https://docs.rs/rand_chacha/latest/rand_chacha/struct.ChaCha20Rng.html#method.get_word_pos),
which, together with the seed, can be used to reconstruct the generator's state.

## WASM support
Expand All @@ -58,12 +58,12 @@ to disable the `rand` crate's `getrandom` feature and seed the generator
manually.


[`rand_core`]: https://rust-random.github.io/rand/rand_core/index.html
[`rand`]: https://rust-random.github.io/rand/rand/index.html
[`rand_distr`]: https://rust-random.github.io/rand/rand_distr/index.html
[`statrs`]: https://github.com/boxtown/statrs
[`rand_core`]: https://docs.rs/rand_core/
[`rand`]: https://docs.rs/rand/
[`rand_distr`]: https://docs.rs/rand_distr/
[`statrs`]: https://docs.rs/statrs/
[`getrandom`]: https://docs.rs/getrandom/
[`rand_chacha`]: https://rust-random.github.io/rand/rand_chacha/index.html
[`rand_chacha`]: https://docs.rs/rand_chacha/
[`rand_xoshiro`]: https://docs.rs/rand_xoshiro/
[`log`]: https://docs.rs/log/
[`serde`]: https://serde.rs/
2 changes: 1 addition & 1 deletion src/guide-cargo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Cargo will normally install the latest matching version when the dependency is
first added. Dependencies may be updated later via `cargo update`, and in some
cases running `cargo update` can solve dependency problems.

For more on Cargo, see [The Cargo Book](https://doc.rust-lang.org/cargo/index.html).
For more on Cargo, see [The Cargo Book](https://doc.rust-lang.org/cargo/).

## Other crates

Expand Down
6 changes: 3 additions & 3 deletions src/guide-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,6 @@ often the other way around — algorithmic generators usually work with integers
internally, which are then converted to whichever form of random data is
required.)

[`RngCore::fill_bytes`]: ../rand/rand_core/trait.RngCore.html#tymethod.fill_bytes
[`RngCore::next_u32`]: ../rand/rand_core/trait.RngCore.html#tymethod.next_u32
[`RngCore::next_u64`]: ../rand/rand_core/trait.RngCore.html#tymethod.next_u64
[`RngCore::fill_bytes`]: https://docs.rs/rand_core/latest/rand_core/trait.RngCore.html#tymethod.fill_bytes
[`RngCore::next_u32`]: https://docs.rs/rand_core/latest/rand_core/trait.RngCore.html#tymethod.next_u32
[`RngCore::next_u64`]: https://docs.rs/rand_core/latest/rand_core/trait.RngCore.html#tymethod.next_u64
56 changes: 28 additions & 28 deletions src/guide-dist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,32 +173,32 @@ output values lie between 0 and 1. The [`Dirichlet`] distribution is a
generalisation to any positive number of parameters.

[Sequences]: guide-seq.html
[`Distribution`]: ../rand/rand/distributions/trait.Distribution.html
[`distributions`]: ../rand/rand/distributions/index.html
[`rand`]: ../rand/rand/index.html
[`rand_distr`]: ../rand/rand_distr/index.html
[`Rng::gen_range`]: ../rand/rand/trait.Rng.html#method.gen_range
[`random`]: ../rand/rand/fn.random.html
[`Rng::gen_bool`]: ../rand/rand/trait.Rng.html#method.gen_bool
[`Rng::gen_ratio`]: ../rand/rand/trait.Rng.html#method.gen_ratio
[`Rng::gen`]: ../rand/rand/trait.Rng.html#method.gen
[`Rng`]: ../rand/rand/trait.Rng.html
[`Standard`]: ../rand/rand/distributions/struct.Standard.html
[`Uniform`]: ../rand/rand/distributions/struct.Uniform.html
[`Uniform::sample_single`]: ../rand/rand/distributions/struct.Uniform.html#method.sample_single
[`Alphanumeric`]: ../rand/rand/distributions/struct.Alphanumeric.html
[`Open01`]: ../rand/rand/distributions/struct.Open01.html
[`OpenClosed01`]: ../rand/rand/distributions/struct.OpenClosed01.html
[`Bernoulli`]: ../rand/rand/distributions/struct.Bernoulli.html
[`Binomial`]: ../rand/rand_distr/struct.Binomial.html
[`Exp`]: ../rand/rand_distr/struct.Exp.html
[`Normal`]: ../rand/rand_distr/struct.Normal.html
[`LogNormal`]: ../rand/rand_distr/struct.LogNormal.html
[`UnitCircle`]: ../rand/rand_distr/struct.UnitCircle.html
[`UnitSphere`]: ../rand/rand_distr/struct.UnitSphere.html
[`Cauchy`]: ../rand/rand_distr/struct.Cauchy.html
[`Poisson`]: ../rand/rand_distr/struct.Poisson.html
[`Beta`]: ../rand/rand_distr/struct.Beta.html
[`Dirichlet`]: ../rand/rand_distr/struct.Dirichlet.html
[`Distribution`]: https://docs.rs/rand/latest/rand/distributions/trait.Distribution.html
[`distributions`]: https://docs.rs/rand/latest/rand/distributions/
[`rand`]: https://docs.rs/rand/
[`rand_distr`]: https://docs.rs/rand_distr/
[`Rng::gen_range`]: https://docs.rs/rand/latest/rand/trait.Rng.html#method.gen_range
[`random`]: https://docs.rs/rand/latest/rand/fn.random.html
[`Rng::gen_bool`]: https://docs.rs/rand/latest/rand/trait.Rng.html#method.gen_bool
[`Rng::gen_ratio`]: https://docs.rs/rand/latest/rand/trait.Rng.html#method.gen_ratio
[`Rng::gen`]: https://docs.rs/rand/latest/rand/trait.Rng.html#method.gen
[`Rng`]: https://docs.rs/rand/latest/rand/trait.Rng.html
[`Standard`]: https://docs.rs/rand/latest/rand/distributions/struct.Standard.html
[`Uniform`]: https://docs.rs/rand/latest/rand/distributions/struct.Uniform.html
[`Uniform::sample_single`]: https://docs.rs/rand/latest/rand/distributions/struct.Uniform.html#method.sample_single
[`Alphanumeric`]: https://docs.rs/rand/latest/rand/distributions/struct.Alphanumeric.html
[`Open01`]: https://docs.rs/rand/latest/rand/distributions/struct.Open01.html
[`OpenClosed01`]: https://docs.rs/rand/latest/rand/distributions/struct.OpenClosed01.html
[`Bernoulli`]: https://docs.rs/rand/latest/rand/distributions/struct.Bernoulli.html
[`Binomial`]: https://docs.rs/rand_distr/latest/rand_distr/struct.Binomial.html
[`Exp`]: https://docs.rs/rand_distr/latest/rand_distr/struct.Exp.html
[`Normal`]: https://docs.rs/rand_distr/latest/rand_distr/struct.Normal.html
[`LogNormal`]: https://docs.rs/rand_distr/latest/rand_distr/struct.LogNormal.html
[`UnitCircle`]: https://docs.rs/rand_distr/latest/rand_distr/struct.UnitCircle.html
[`UnitSphere`]: https://docs.rs/rand_distr/latest/rand_distr/struct.UnitSphere.html
[`Cauchy`]: https://docs.rs/rand_distr/latest/rand_distr/struct.Cauchy.html
[`Poisson`]: https://docs.rs/rand_distr/latest/rand_distr/struct.Poisson.html
[`Beta`]: https://docs.rs/rand_distr/latest/rand_distr/struct.Beta.html
[`Dirichlet`]: https://docs.rs/rand_distr/latest/rand_distr/struct.Dirichlet.html
[`statrs`]: https://github.com/statrs-dev/statrs/
[`WeightedIndex`]: ../rand/rand/distributions/struct.WeightedIndex.html
[`WeightedIndex`]: https://docs.rs/rand/latest/rand/distributions/struct.WeightedIndex.html
12 changes: 6 additions & 6 deletions src/guide-err.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ be forced to fail in this case:
likely) then the RNG continues without reseeding; a log message (warning)
is emitted if logging is enabled.

[`Rng::try_fill`]: ../rand/rand/trait.Rng.html#method.try_fill
[`RngCore::try_fill_bytes`]: ../rand/rand_core/trait.RngCore.html#tymethod.try_fill_bytes
[`SeedableRng::from_rng`]: ../rand/rand_core/trait.SeedableRng.html#method.from_rng
[`RngCore`]: ../rand/rand_core/trait.RngCore.html
[`thread_rng`]: ../rand/rand/fn.thread_rng.html
[`OsRng`]: ../rand/rand/rngs/struct.OsRng.html
[`Rng::try_fill`]: https://docs.rs/rand/latest/rand/trait.Rng.html#method.try_fill
[`RngCore::try_fill_bytes`]: https://docs.rs/rand_core/latest/rand_core/trait.RngCore.html#tymethod.try_fill_bytes
[`SeedableRng::from_rng`]: https://docs.rs/rand_core/latest/rand_core/trait.SeedableRng.html#method.from_rng
[`RngCore`]: https://docs.rs/rand_core/latest/rand_core/trait.RngCore.html
[`thread_rng`]: https://docs.rs/rand/latest/rand/fn.thread_rng.html
[`OsRng`]: https://docs.rs/rand/latest/rand/rngs/struct.OsRng.html
[`getrandom`]: https://docs.rs/getrandom/latest/getrandom/
2 changes: 1 addition & 1 deletion src/guide-gen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,5 +129,5 @@ HRNG (but using nanosecond resolution timers and conservatively assuming only a
couple of bits entropy is available per time-stamp, after running several tests
on the timer's quality).

[`RngCore`]: ../rand/rand_core/trait.RngCore.html
[`RngCore`]: https://docs.rs/rand_core/latest/rand_core/trait.RngCore.html
[`JitterRng`]: https://docs.rs/rand_jitter/latest/rand_jitter/struct.JitterRng.html
6 changes: 3 additions & 3 deletions src/guide-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ If you wish to implement step-wise sampling yourself, here are a few ideas:
may be adjusted to this application.


[`Distribution`]: ../rand/rand/distributions/trait.Distribution.html
[`IteratorRandom::choose_multiple`]: ../rand/rand/seq/trait.IteratorRandom.html#method.choose_multiple
[`SliceRandom::choose_multiple`]: ../rand/rand/seq/trait.SliceRandom.html#tymethod.choose_multiple
[`Distribution`]: https://docs.rs/rand/latest/rand/distributions/trait.Distribution.html
[`IteratorRandom::choose_multiple`]: https://docs.rs/rand/latest/rand/seq/trait.IteratorRandom.html#method.choose_multiple
[`SliceRandom::choose_multiple`]: https://docs.rs/rand/latest/rand/seq/trait.SliceRandom.html#tymethod.choose_multiple
[`src/seq/index.rs`]: https://github.com/rust-random/rand/blob/master/src/seq/index.rs
30 changes: 15 additions & 15 deletions src/guide-rngs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,29 +291,29 @@ https://web.archive.org/web/20160801142711/http://random.mat.sbg.ac.at/results/p
by P. Hellekalek.


[`rngs` module]: ../rand/rand/rngs/index.html
[`SmallRng`]: ../rand/rand/rngs/struct.SmallRng.html
[`StdRng`]: ../rand/rand/rngs/struct.StdRng.html
[`StepRng`]: ../rand/rand/rngs/mock/struct.StepRng.html
[`thread_rng`]: ../rand/rand/fn.thread_rng.html
[`rngs` module]: https://docs.rs/rand/latest/rand/rngs/
[`SmallRng`]: https://docs.rs/rand/latest/rand/rngs/struct.SmallRng.html
[`StdRng`]: https://docs.rs/rand/latest/rand/rngs/struct.StdRng.html
[`StepRng`]: https://docs.rs/rand/latest/rand/rngs/mock/struct.StepRng.html
[`thread_rng`]: https://docs.rs/rand/latest/rand/fn.thread_rng.html
[basic PRNGs]: #basic-pseudo-random-number-generators-prngs
[CSPRNGs]: #cryptographically-secure-pseudo-random-number-generators-csprngs
[`Pcg32`]: ../rand/rand_pcg/type.Pcg32.html
[`Pcg64`]: ../rand/rand_pcg/type.Pcg64.html
[`Pcg64Mcg`]: ../rand/rand_pcg/type.Pcg64Mcg.html
[`Pcg32`]: https://docs.rs/rand_pcg/latest/rand_pcg/type.Pcg32.html
[`Pcg64`]: https://docs.rs/rand_pcg/latest/rand_pcg/type.Pcg64.html
[`Pcg64Mcg`]: https://docs.rs/rand_pcg/latest/rand_pcg/type.Pcg64Mcg.html
[`XorShiftRng`]: https://docs.rs/rand_xorshift/latest/rand_xorshift/struct.XorShiftRng.html
[`Xoshiro256PlusPlus`]: https://docs.rs/rand_xoshiro/latest/rand_xoshiro/struct.Xoshiro256PlusPlus.html
[`Xoshiro256Plus`]: https://docs.rs/rand_xoshiro/latest/rand_xoshiro/struct.Xoshiro256Plus.html
[`SplitMix64`]: https://docs.rs/rand_xoshiro/latest/rand_xoshiro/struct.SplitMix64.html
[`ChaChaRng`]: ../rand/rand_chacha/type.ChaChaRng.html
[`ChaCha20Rng`]: ../rand/rand_chacha/struct.ChaCha20Rng.html
[`ChaCha8Rng`]: ../rand/rand_chacha/struct.ChaCha8Rng.html
[`ChaChaRng`]: https://docs.rs/rand_chacha/latest/rand_chacha/type.ChaChaRng.html
[`ChaCha20Rng`]: https://docs.rs/rand_chacha/latest/rand_chacha/struct.ChaCha20Rng.html
[`ChaCha8Rng`]: https://docs.rs/rand_chacha/latest/rand_chacha/struct.ChaCha8Rng.html
[`Hc128Rng`]: https://docs.rs/rand_hc/latest/rand_hc/struct.Hc128Rng.html
[`IsaacRng`]: https://docs.rs/rand_isaac/latest/rand_isaac/isaac/struct.IsaacRng.html
[`Isaac64Rng`]: https://docs.rs/rand_isaac/latest/rand_isaac/isaac64/struct.Isaac64Rng.html
[`ThreadRng`]: ../rand/rand/rngs/struct.ThreadRng.html
[`FromEntropy`]: ../rand/rand/trait.FromEntropy.html
[`EntropyRng`]: ../rand/rand/rngs/struct.EntropyRng.html
[`ThreadRng`]: https://docs.rs/rand/latest/rand/rngs/struct.ThreadRng.html
[`FromEntropy`]: https://docs.rs/rand/latest/rand/trait.FromEntropy.html
[`EntropyRng`]: https://docs.rs/rand/latest/rand/rngs/struct.EntropyRng.html
[TestU01]: http://simul.iro.umontreal.ca/testu01/tu01.html
[PractRand]: http://pracrand.sourceforge.net/
[pcg-random]: http://www.pcg-random.org/
Expand All @@ -326,4 +326,4 @@ by P. Hellekalek.
[NIST]: https://www.nist.gov/
[ECRYPT]: http://www.ecrypt.eu.org/
[`getrandom`]: https://docs.rs/getrandom/
[`SeedableRng::from_entropy`]: ../rand/rand/trait.SeedableRng.html#method.from_entropy
[`SeedableRng::from_entropy`]: https://docs.rs/rand/latest/rand/trait.SeedableRng.html#method.from_entropy
14 changes: 7 additions & 7 deletions src/guide-seeding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,12 +141,12 @@ It is **not a password hasher**, for such applications a key-derivation
function such as Argon2 must be used.


[`SeedableRng`]: ../rand/rand_core/trait.SeedableRng.html
[`Seed`]: ../rand/rand_core/trait.SeedableRng.html#type.Seed
[`SeedableRng::from_seed`]: ../rand/rand_core/trait.SeedableRng.html#tymethod.from_seed
[`SeedableRng::from_rng`]: ../rand/rand_core/trait.SeedableRng.html#method.from_rng
[`SeedableRng::seed_from_u64`]: ../rand/rand_core/trait.SeedableRng.html#method.seed_from_u64
[`SeedableRng::from_entropy`]: ../rand/rand_core/trait.SeedableRng.html#method.from_entropy
[`SeedableRng`]: https://docs.rs/rand_core/latest/rand_core/trait.SeedableRng.html
[`Seed`]: https://docs.rs/rand_core/latest/rand_core/trait.SeedableRng.html#type.Seed
[`SeedableRng::from_seed`]: https://docs.rs/rand_core/latest/rand_core/trait.SeedableRng.html#tymethod.from_seed
[`SeedableRng::from_rng`]: https://docs.rs/rand_core/latest/rand_core/trait.SeedableRng.html#method.from_rng
[`SeedableRng::seed_from_u64`]: https://docs.rs/rand_core/latest/rand_core/trait.SeedableRng.html#method.seed_from_u64
[`SeedableRng::from_entropy`]: https://docs.rs/rand_core/latest/rand_core/trait.SeedableRng.html#method.from_entropy
[`XorShiftRng`]: https://docs.rs/rand_xorshift/latest/rand_xorshift/struct.XorShiftRng.html
[`ChaCha8Rng`]: ../rand/rand_chacha/struct.ChaCha8Rng.html
[`ChaCha8Rng`]: https://docs.rs/rand_chacha/latest/rand_chacha/struct.ChaCha8Rng.html
[`rand_seeder`]: https://github.com/rust-random/seeder/
Loading
Loading