[commons-rng] 01/02: Use better examples for the user guide

[ah...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git

commit 97a464190c6b38eb3bc2ef8cdb1b46742c8ba697
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Mon Sep 26 16:15:48 2022 +0100

    Use better examples for the user guide
    
    Remove use of generators that fail TestU01 BigCrush and/or PractRand.
    
    Use ZigguratSampler.NormalizedGaussian.
    
    Update CollectionSampler example.
---
 .../commons/rng/sampling/CollectionSamplerTest.java  |  5 ++---
 src/site/apt/userguide/rng.apt                       | 20 ++++++++++----------
 2 files changed, 12 insertions(+), 13 deletions(-)

diff --git a/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/CollectionSamplerTest.java b/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/CollectionSamplerTest.java
index 5e1b9868..3853cccf 100644
--- a/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/CollectionSamplerTest.java
+++ b/commons-rng-sampling/src/test/java/org/apache/commons/rng/sampling/CollectionSamplerTest.java
@@ -39,10 +39,9 @@ class CollectionSamplerTest {
         list.add("RNG");
 
         final CollectionSampler<String> sampler =
-            new CollectionSampler<>(RandomSource.MWC_256.create(),
-                                          list);
+            new CollectionSampler<>(RandomSource.MWC_256.create(), list);
         final String word = sampler.sample();
-        for (String w : list) {
+        for (final String w : list) {
             if (word.equals(w)) {
                 return;
             }
diff --git a/src/site/apt/userguide/rng.apt b/src/site/apt/userguide/rng.apt
index 1a07f9fb..f68d451d 100644
--- a/src/site/apt/userguide/rng.apt
+++ b/src/site/apt/userguide/rng.apt
@@ -328,7 +328,7 @@ UniformRandomProvider rng = RandomSource.TWO_CMRES_SELECT.create(seed, first, se
 import org.apache.commons.rng.RestorableUniformRandomProvider;
 import org.apache.commons.rng.RandomProviderState;
 
-RestorableUniformRandomProvider rng = RandomSource.WELL_512_A.create();
+RestorableUniformRandomProvider rng = RandomSource.XO_RO_SHI_RO_128_PP.create();
 RandomProviderState state = rng.saveState();
 double x = rng.nextDouble();
 rng.restoreState(state);
@@ -349,7 +349,7 @@ import org.apache.commons.rng.RestorableUniformRandomProvider;
 import org.apache.commons.rng.simple.RandomSource;
 import org.apache.commons.rng.core.RandomProviderDefaultState;
 
-RandomSource source = RandomSource.MT_64; // Known source identifier.
+RandomSource source = RandomSource.KISS; // Known source identifier.
 
 RestorableUniformRandomProvider rngOrig = source.create(); // Original RNG instance.
 
@@ -463,9 +463,9 @@ public void initialise(RandomSource source) {
 +--------------------------+
 import org.apache.commons.rng.sampling.distribution.ContinuousSampler;
 import org.apache.commons.rng.sampling.distribution.GaussianSampler;
-import org.apache.commons.rng.sampling.distribution.MarsagliaNormalizedGaussianSampler;
+import org.apache.commons.rng.sampling.distribution.ZigguratSampler;
 
-ContinuousSampler sampler = GaussianSampler.of(MarsagliaNormalizedGaussianSampler.of(RandomSource.MT_64.create()),
+ContinuousSampler sampler = GaussianSampler.of(ZigguratSampler.NormalizedGaussian.of(RandomSource.ISAAC.create()),
                                                45.6, 2.3);
 double random = sampler.sample();
 +--------------------------+
@@ -558,13 +558,13 @@ int[] combination = combinationSampler.sample();
 import java.util.HashSet;
 import org.apache.commons.rng.sampling.CollectionSampler;
 
-HashSet<String> list = new HashSet<String>();
-list.add("Apache");
-list.add("Commons");
-list.add("RNG");
+HashSet<String> elements = new HashSet<>();
+elements.add("Apache");
+elements.add("Commons");
+elements.add("RNG");
 
-CollectionSampler<String> sampler = new CollectionSampler<String>(RandomSource.MWC_256.create(),
-                                                                  list);
+CollectionSampler<String> sampler = new CollectionSampler<>(RandomSource.MWC_256.create(),
+                                                            elements);
 String word = sampler.sample();
 +--------------------------+