Javadoc.
Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/f9e72000 Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/f9e72000 Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/f9e72000 Branch: refs/heads/master Commit: f9e72000a17eb9d524b38a9f2c982c037dd94891 Parents: ffae3bd Author: Gilles <er...@apache.org> Authored: Mon Dec 28 17:01:21 2015 +0100 Committer: Gilles <er...@apache.org> Committed: Mon Dec 28 17:01:21 2015 +0100 ---------------------------------------------------------------------- .../commons/math4/random/AbstractWell.java | 90 +++++++++++--------- .../commons/math4/random/MersenneTwister.java | 21 +++-- 2 files changed, 64 insertions(+), 47 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-math/blob/f9e72000/src/main/java/org/apache/commons/math4/random/AbstractWell.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/random/AbstractWell.java b/src/main/java/org/apache/commons/math4/random/AbstractWell.java index da222fd..a389d58 100644 --- a/src/main/java/org/apache/commons/math4/random/AbstractWell.java +++ b/src/main/java/org/apache/commons/math4/random/AbstractWell.java @@ -37,73 +37,82 @@ import org.apache.commons.math4.util.FastMath; public abstract class AbstractWell extends BaseRandomGenerator implements Serializable { - /** Serializable version identifier. */ private static final long serialVersionUID = 20150228L; - /** Current index in the bytes pool. */ protected int index; - /** Bytes pool. */ protected final int[] v; - /** Creates a new random number generator. + /** + * Creates a new random number generator. + * * <p>The instance is initialized using the current time plus the * system identity hash code of this instance as the seed.</p> - * @param k number of bits in the pool (not necessarily a multiple of 32) + * + * @param k number of bits in the pool (not necessarily a multiple of 32). */ protected AbstractWell(final int k) { this(k, null); } - /** Creates a new random number generator using a single int seed. - * @param k number of bits in the pool (not necessarily a multiple of 32) - * @param seed the initial seed (32 bits integer) + /** + * Creates a new random number generator using a single int seed. + * + * @param k number of bits in the pool (not necessarily a multiple of 32). + * @param seed the initial seed (32 bits integer). */ protected AbstractWell(final int k, final int seed) { this(k, new int[] { seed }); } - /** Creates a new random number generator using an int array seed. - * @param k number of bits in the pool (not necessarily a multiple of 32) + /** + * Creates a new random number generator using an int array seed. + * + * @param k number of bits in the pool (not necessarily a multiple of 32). * @param seed the initial seed (32 bits integers array), if null - * the seed of the generator will be related to the current time + * the seed of the generator will be related to the current time. */ protected AbstractWell(final int k, final int[] seed) { - final int r = calculateBlockCount(k); - this.v = new int[r]; - this.index = 0; + v = new int[r]; + index = 0; - // initialize the pool content + // Initialize the pool content. setSeed(seed); - } - /** Creates a new random number generator using a single long seed. - * @param k number of bits in the pool (not necessarily a multiple of 32) - * @param seed the initial seed (64 bits integer) + /** + * Creates a new random number generator using a single long seed. + * + * @param k number of bits in the pool (not necessarily a multiple of 32). + * @param seed the initial seed (64 bits integer). */ protected AbstractWell(final int k, final long seed) { this(k, new int[] { (int) (seed >>> 32), (int) (seed & 0xffffffffl) }); } - /** Reinitialize the generator as if just built with the given int seed. - * <p>The state of the generator is exactly the same as a new - * generator built with the same seed.</p> - * @param seed the initial seed (32 bits integer) + /** + * Reinitialize the generator as if just built with the given int seed. + * + * <p>The state of the generator is exactly the same as a new generator + * built with the same seed.</p> + * + * @param seed Seed (32 bits integer). */ @Override public void setSeed(final int seed) { setSeed(new int[] { seed }); } - /** Reinitialize the generator as if just built with the given int array seed. - * <p>The state of the generator is exactly the same as a new - * generator built with the same seed.</p> - * @param seed the initial seed (32 bits integers array). If null - * the seed of the generator will be the system time plus the system identity - * hash code of the instance. + /** + * Reinitialize the generator as if just built with the given int array seed. + * + * <p>The state of the generator is exactly the same as a new generator built + * with the same seed.</p> + * + * @param seed Seed (32 bits integers array). If null the seed of the generator + * will be the system time plus the system identity hash code of the instance. */ @Override public void setSeed(final int[] seed) { @@ -125,19 +134,24 @@ public abstract class AbstractWell clear(); // Clear normal deviate cache } - /** Reinitialize the generator as if just built with the given long seed. - * <p>The state of the generator is exactly the same as a new - * generator built with the same seed.</p> - * @param seed the initial seed (64 bits integer) + /** + * Reinitialize the generator as if just built with the given long seed. + * + * <p>The state of the generator is exactly the same as a new generator built + * with the same seed.</p> + * + * @param seed Seed (64 bits integer). */ @Override public void setSeed(final long seed) { setSeed(new int[] { (int) (seed >>> 32), (int) (seed & 0xffffffffl) }); } - /** Calculate the number of 32-bits blocks. - * @param k number of bits in the pool (not necessarily a multiple of 32) - * @return the number of 32-bits blocks + /** + * Calculate the number of 32-bits blocks. + * + * @param k Number of bits in the pool (not necessarily a multiple of 32). + * @return the number of 32-bits blocks. */ private static int calculateBlockCount(final int k) { // the bits pool contains k bits, k = r w - p where r is the number @@ -149,8 +163,8 @@ public abstract class AbstractWell } /** - * Inner class used to store the indirection index table which is fixed for a given type of WELL class - * of pseudo-random number generator. + * Inner class used to store the indirection index table which is fixed for a given + * type of WELL class of pseudo-random number generator. * * @since 4.0 */ http://git-wip-us.apache.org/repos/asf/commons-math/blob/f9e72000/src/main/java/org/apache/commons/math4/random/MersenneTwister.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/random/MersenneTwister.java b/src/main/java/org/apache/commons/math4/random/MersenneTwister.java index d8caaa7..709c343 100644 --- a/src/main/java/org/apache/commons/math4/random/MersenneTwister.java +++ b/src/main/java/org/apache/commons/math4/random/MersenneTwister.java @@ -222,21 +222,24 @@ public class MersenneTwister setSeed(new int[] { (int) (seed >>> 32), (int) (seed & 0xffffffffl) }); } - /** Generate next pseudorandom number. - * <p>This method is the core generation algorithm. It is used by all the - * public generation methods for the various primitive types {@link - * #nextBoolean()}, {@link #nextBytes(byte[])}, {@link #nextDouble()}, + /** + * Generates the next pseudorandom number. + * + * <p> + * This method is the core generation algorithm. It is used by all the + * public generation methods for the various primitive types + * {@link #nextBoolean()}, {@link #nextBytes(byte[])}, {@link #nextDouble()}, * {@link #nextFloat()}, {@link #nextGaussian()} and {@link #nextLong()}. * </p> - * @param bits number of random bits to produce - * @return random bits generated + * + * @param bits Number of random bits to produce. + * @return the random bits generated. */ @Override public int nextInt() { - int y; - if (mti >= N) { // generate N words at one time + if (mti >= N) { // Generate N words at one time. int mtNext = mt[0]; for (int k = 0; k < N - M; ++k) { int mtCurr = mtNext; @@ -258,7 +261,7 @@ public class MersenneTwister y = mt[mti++]; - // tempering + // Tempering. y ^= y >>> 11; y ^= (y << 7) & 0x9d2c5680; y ^= (y << 15) & 0xefc60000;
