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

Documentation update #322

Merged
merged 1 commit into from
May 31, 2024
Merged

Documentation update #322

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
15 changes: 9 additions & 6 deletions src/main/java/org/cicirello/math/rand/EnhancedRandomGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,8 +459,9 @@ public final double nextCauchy(double median, double scale) {
* the following report:
*
* <p>Vincent A. Cicirello. 2024. <a href="https://reports.cicirello.org/24/009/">Fast Gaussian
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. Technical
* Report ALG-24-009, Cicirello.org, May 2024. <a
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. arXiv:<a
* href="https://arxiv.org/abs/2405.19493">2405.19493</a>, May 2024. doi:<a
* href="https://doi.org/10.48550/arXiv.2405.19493">10.48550/arXiv.2405.19493</a>. <a
* href="https://reports.cicirello.org/24/009/ALG-24-009.pdf">[PDF]</a>
*
* @param stddev The standard deviation of the Gaussian.
Expand Down Expand Up @@ -1355,8 +1356,9 @@ public final Stream<IndexTriple> windowedTriples(long streamSize, int n, int win
* information as well as experimental comparison, see the following report:
*
* <p>Vincent A. Cicirello. 2024. <a href="https://reports.cicirello.org/24/009/">Fast Gaussian
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. Technical
* Report ALG-24-009, Cicirello.org, May 2024. <a
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. arXiv:<a
* href="https://arxiv.org/abs/2405.19493">2405.19493</a>, May 2024. doi:<a
* href="https://doi.org/10.48550/arXiv.2405.19493">10.48550/arXiv.2405.19493</a>. <a
* href="https://reports.cicirello.org/24/009/ALG-24-009.pdf">[PDF]</a>
*
* @return A random number from a Gaussian distribution with mean 0 and standard deviation 1.
Expand All @@ -1378,8 +1380,9 @@ public final double nextGaussian() {
* information as well as experimental comparison, see the following report:
*
* <p>Vincent A. Cicirello. 2024. <a href="https://reports.cicirello.org/24/009/">Fast Gaussian
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. Technical
* Report ALG-24-009, Cicirello.org, May 2024. <a
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. arXiv:<a
* href="https://arxiv.org/abs/2405.19493">2405.19493</a>, May 2024. doi:<a
* href="https://doi.org/10.48550/arXiv.2405.19493">10.48550/arXiv.2405.19493</a>. <a
* href="https://reports.cicirello.org/24/009/ALG-24-009.pdf">[PDF]</a>
*
* @param mean The mean of the Gaussian.
Expand Down
30 changes: 18 additions & 12 deletions src/main/java/org/cicirello/math/rand/RandomVariates.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,9 @@ public static double nextCauchy(double scale, RandomGenerator r) {
* implementation of McFarland's modified ziggurat algorithm, which is much faster.
*
* <p>Vincent A. Cicirello. 2024. <a href="https://reports.cicirello.org/24/009/">Fast Gaussian
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. Technical
* Report ALG-24-009, Cicirello.org, May 2024. <a
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. arXiv:<a
* href="https://arxiv.org/abs/2405.19493">2405.19493</a>, May 2024. doi:<a
* href="https://doi.org/10.48550/arXiv.2405.19493">10.48550/arXiv.2405.19493</a>. <a
* href="https://reports.cicirello.org/24/009/ALG-24-009.pdf">[PDF]</a>
*
* @param mu The mean of the Gaussian.
Expand All @@ -152,8 +153,9 @@ public static double nextGaussian(double mu, double sigma) {
* relevant experiments:
*
* <p>Vincent A. Cicirello. 2024. <a href="https://reports.cicirello.org/24/009/">Fast Gaussian
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. Technical
* Report ALG-24-009, Cicirello.org, May 2024. <a
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. arXiv:<a
* href="https://arxiv.org/abs/2405.19493">2405.19493</a>, May 2024. doi:<a
* href="https://doi.org/10.48550/arXiv.2405.19493">10.48550/arXiv.2405.19493</a>. <a
* href="https://reports.cicirello.org/24/009/ALG-24-009.pdf">[PDF]</a>
*
* @param mu The mean of the Gaussian.
Expand All @@ -177,8 +179,9 @@ public static double nextGaussian(double mu, double sigma, RandomGenerator r) {
* implementation of McFarland's modified ziggurat algorithm, which is much faster.
*
* <p>Vincent A. Cicirello. 2024. <a href="https://reports.cicirello.org/24/009/">Fast Gaussian
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. Technical
* Report ALG-24-009, Cicirello.org, May 2024. <a
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. arXiv:<a
* href="https://arxiv.org/abs/2405.19493">2405.19493</a>, May 2024. doi:<a
* href="https://doi.org/10.48550/arXiv.2405.19493">10.48550/arXiv.2405.19493</a>. <a
* href="https://reports.cicirello.org/24/009/ALG-24-009.pdf">[PDF]</a>
*
* @param sigma The standard deviation of the Gaussian.
Expand All @@ -199,8 +202,9 @@ public static double nextGaussian(double sigma) {
* relevant experiments:
*
* <p>Vincent A. Cicirello. 2024. <a href="https://reports.cicirello.org/24/009/">Fast Gaussian
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. Technical
* Report ALG-24-009, Cicirello.org, May 2024. <a
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. arXiv:<a
* href="https://arxiv.org/abs/2405.19493">2405.19493</a>, May 2024. doi:<a
* href="https://doi.org/10.48550/arXiv.2405.19493">10.48550/arXiv.2405.19493</a>. <a
* href="https://reports.cicirello.org/24/009/ALG-24-009.pdf">[PDF]</a>
*
* @param sigma The standard deviation of the Gaussian.
Expand All @@ -222,8 +226,9 @@ public static double nextGaussian(double sigma, RandomGenerator r) {
* implementation of McFarland's modified ziggurat algorithm, which is much faster.
*
* <p>Vincent A. Cicirello. 2024. <a href="https://reports.cicirello.org/24/009/">Fast Gaussian
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. Technical
* Report ALG-24-009, Cicirello.org, May 2024. <a
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. arXiv:<a
* href="https://arxiv.org/abs/2405.19493">2405.19493</a>, May 2024. doi:<a
* href="https://doi.org/10.48550/arXiv.2405.19493">10.48550/arXiv.2405.19493</a>. <a
* href="https://reports.cicirello.org/24/009/ALG-24-009.pdf">[PDF]</a>
*
* @return A random number from a Gaussian distribution with mean 0 and standard deviation 1.
Expand All @@ -242,8 +247,9 @@ public static double nextGaussian() {
* relevant experiments:
*
* <p>Vincent A. Cicirello. 2024. <a href="https://reports.cicirello.org/24/009/">Fast Gaussian
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. Technical
* Report ALG-24-009, Cicirello.org, May 2024. <a
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. arXiv:<a
* href="https://arxiv.org/abs/2405.19493">2405.19493</a>, May 2024. doi:<a
* href="https://doi.org/10.48550/arXiv.2405.19493">10.48550/arXiv.2405.19493</a>. <a
* href="https://reports.cicirello.org/24/009/ALG-24-009.pdf">[PDF]</a>
*
* @param r The pseudorandom number generator to use for the source of randomness.
Expand Down
10 changes: 6 additions & 4 deletions src/main/java/org/cicirello/math/rand/ZigguratGaussian.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,9 @@
*
* <ul>
* <li>Vincent A. Cicirello. 2024. <a href="https://reports.cicirello.org/24/009/">Fast Gaussian
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>.
* Technical Report ALG-24-009, Cicirello.org, May 2024. <a
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. arXiv:<a
* href="https://arxiv.org/abs/2405.19493">2405.19493</a>, May 2024. doi:<a
* href="https://doi.org/10.48550/arXiv.2405.19493">10.48550/arXiv.2405.19493</a>. <a
* href="https://reports.cicirello.org/24/009/ALG-24-009.pdf">[PDF]</a>
* </ul>
*
Expand Down Expand Up @@ -181,8 +182,9 @@ final class ZigguratGaussian {
* the relevant issues:
*
* Vincent A. Cicirello. 2024. <a href="https://reports.cicirello.org/24/009/">Fast Gaussian
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>.
* Technical Report ALG-24-009, Cicirello.org, May 2024. <a
* Distributed Pseudorandom Number Generation in Java via the Ziggurat Algorithm</a>. arXiv:<a
* href="https://arxiv.org/abs/2405.19493">2405.19493</a>, May 2024. doi:<a
* href="https://doi.org/10.48550/arXiv.2405.19493">10.48550/arXiv.2405.19493</a>. <a
* href="https://reports.cicirello.org/24/009/ALG-24-009.pdf">[PDF]</a>
*
* - Thus, as of 5/30/2024, we are stripping out all of the ThreadLocalRandom related
Expand Down