src/java.base/share/classes/java/util/random/MRG32k3a.java
author jlaskey
Thu, 27 Jun 2019 18:30:27 -0300
branchJDK-8193209-branch
changeset 57437 f02ffcb61dce
parent 57436 b0c958c0e6c6
child 57547 56cbdc3ea079
permissions -rw-r--r--
Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
     1
/*
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
     2
 * Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
     4
 *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    10
 *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    15
 * accompanied this code).
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    16
 *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    20
 *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    23
 * questions.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    24
 */
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    25
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    26
package java.util.random;
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    27
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    28
import java.math.BigInteger;
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    29
import java.util.concurrent.atomic.AtomicLong;
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    30
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    31
/**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    32
 * A generator of uniform pseudorandom values applicable for use in
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    33
 * (among other contexts) isolated parallel computations that may
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    34
 * generate subtasks.  Class {@link MRG32k3a} implements
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    35
 * interfaces {@link RandomNumberGenerator} and {@link AbstractArbitrarilyJumpableRNG},
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    36
 * and therefore supports methods for producing pseudorandomly chosen
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    37
 * numbers of type {@code int}, {@code long}, {@code float}, and {@code double}
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    38
 * as well as creating new {@link Xoroshiro128PlusMRG32k3a} objects
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    39
 * by "jumping" or "leaping".
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    40
 * <p>
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    41
 * Instances {@link Xoroshiro128Plus} are <em>not</em> thread-safe.
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    42
 * They are designed to be used so that each thread as its own instance.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    43
 * The methods {@link #jump} and {@link #leap} and {@link #jumps} and {@link #leaps}
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    44
 * can be used to construct new instances of {@link Xoroshiro128Plus} that traverse
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    45
 * other parts of the state cycle.
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    46
 * <p>
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    47
 * Instances of {@link MRG32k3a} are not cryptographically
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    48
 * secure.  Consider instead using {@link java.security.SecureRandom}
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    49
 * in security-sensitive applications. Additionally,
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    50
 * default-constructed instances do not use a cryptographically random
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    51
 * seed unless the {@linkplain System#getProperty system property}
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    52
 * {@code java.util.secureRandomSeed} is set to {@code true}.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    53
 *
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    54
 * @since 14
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    55
 */
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    56
public final class MRG32k3a extends AbstractArbitrarilyJumpableRNG {
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    57
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    58
    /*
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    59
     * Implementation Overview.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    60
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    61
     * See http://simul.iro.umontreal.ca/rng/MRG32k3a.c .
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    62
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    63
     * File organization: First the non-public methods that constitute
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    64
     * the main algorithm, then the main public methods, followed by
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    65
     * some custom spliterator classes needed for stream methods.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    66
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    67
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    68
    private final static double NORM1 = 2.328306549295728e-10;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    69
    private final static double NORM2 = 2.328318824698632e-10;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    70
    private final static double M1 =   4294967087.0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    71
    private final static double M2 =   4294944443.0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    72
    private final static double A12 =     1403580.0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    73
    private final static double A13N =     810728.0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    74
    private final static double A21 =      527612.0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    75
    private final static double A23N =    1370589.0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    76
    private final static int M1_DEFICIT = 209;
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    77
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    78
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    79
     * The per-instance state.
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    80
     The seeds for s10, s11, s12 must be integers in [0, m1 - 1] and not all 0.
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    81
     The seeds for s20, s21, s22 must be integers in [0, m2 - 1] and not all 0.
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    82
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    83
    private double s10, s11, s12,
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    84
                   s20, s21, s22;
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    85
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    86
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    87
     * The seed generator for default constructors.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    88
     */
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    89
    private static final AtomicLong DEFAULT_GEN =
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    90
        new AtomicLong(RNGSupport.initialSeed());
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    91
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    92
    /*
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    93
      32-bits Random number generator U(0,1): MRG32k3a
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    94
      Author: Pierre L'Ecuyer,
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    95
      Source: Good Parameter Sets for Combined Multiple Recursive Random
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    96
           Number Generators,
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    97
           Shorter version in Operations Research,
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
    98
           47, 1 (1999), 159--164.
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
    99
           ---------------------------------------------------------
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   100
    */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   101
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   102
    private void nextState() {
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   103
        /* Component 1 */
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   104
        double p1 = A12 * s11 - A13N * s10;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   105
        double k1 = p1 / M1;   p1 -= k1 * M1;   if (p1 < 0.0) p1 += M1;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   106
        s10 = s11;   s11 = s12;   s12 = p1;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   107
        /* Component 2 */
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   108
        double p2 = A21 * s22 - A23N * s20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   109
        double k2 = p2 / M2;   p2 -= k2 * M2;   if (p2 < 0.0) p2 += M2;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   110
        s20 = s21;   s21 = s22;   s22 = p2;
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   111
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   112
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   113
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   114
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   115
     * The form of nextInt used by IntStream Spliterators.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   116
     * Exactly the same as long version, except for types.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   117
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   118
     * @param origin the least value, unless greater than bound
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   119
     * @param bound the upper bound (exclusive), must not equal origin
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   120
     *
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   121
     * @return a pseudorandom value
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   122
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   123
    private int internalNextInt(int origin, int bound) {
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   124
        if (origin < bound) {
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   125
            final int n = bound - origin;
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   126
            final int m = n - 1;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   127
            if (n > 0) {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   128
                int r;
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   129
                for (int u = (int)nextDouble() >>> 1;
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   130
                     u + m + ((M1_DEFICIT + 1) >>> 1) - (r = u % n) < 0;
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   131
                     u = (int)nextDouble() >>> 1)
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   132
                    ;
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   133
                return (r + origin);
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   134
            } else {
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   135
                return RNGSupport.boundedNextInt(this, origin, bound);
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   136
            }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   137
        } else {
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   138
            return nextInt();
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   139
        }
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   140
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   141
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   142
    private int internalNextInt(int bound) {
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   143
        // Specialize internalNextInt for origin == 0, bound > 0
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   144
        final int n = bound;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   145
        final int m = n - 1;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   146
        int r;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   147
        for (int u = (int)nextDouble() >>> 1;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   148
             u + m + ((M1_DEFICIT + 1) >>> 1) - (r = u % n) < 0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   149
             u = (int)nextDouble() >>> 1)
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   150
            ;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   151
        return r;
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   152
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   153
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   154
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   155
     * All arguments must be known to be nonnegative integral values
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   156
     * less than the appropriate modulus.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   157
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   158
    private MRG32k3a(double s10, double s11, double s12,
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   159
                     double s20, double s21, double s22) {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   160
        this.s10 = s10; this.s11 = s11; this.s12 = s12;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   161
        this.s20 = s20; this.s21 = s21; this.s22 = s22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   162
        if ((s10 == 0.0) && (s11 == 0.0) && (s12 == 0.0)) {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   163
            this.s10 = this.s11 = this.s12 = 12345.0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   164
        }
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   165
        if ((s20 == 0.0) && (s21 == 0.0) && (s22 == 0.0)) {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   166
            this.s20 = this.s21 = this.s21 = 12345.0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   167
        }
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   168
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   169
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   170
    /* ---------------- public methods ---------------- */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   171
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   172
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   173
     * Creates a new MRG32k3a instance using six specified {@code int}
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   174
     * initial seed values. MRG32k3a instances created with the same
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   175
     * seeds in the same program generate identical sequences of values.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   176
     * If all six seed values are zero, the generator is seeded to a
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   177
     * widely used initialization of MRG32k3a: all six state variables
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   178
     * are set to 12345.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   179
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   180
     * @param s10 the first seed value for the first subgenerator
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   181
     * @param s11 the second seed value for the first subgenerator
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   182
     * @param s12 the third seed value for the first subgenerator
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   183
     * @param s20 the first seed value for the second subgenerator
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   184
     * @param s21 the second seed value for the second subgenerator
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   185
     * @param s22 the third seed value for the second subgenerator
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   186
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   187
    public MRG32k3a(int s10, int s11, int s12,
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   188
                    int s20, int s21, int s22) {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   189
        this(((double)(((long)s10) & 0x00000000ffffffffL)) % M1,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   190
             ((double)(((long)s11) & 0x00000000ffffffffL)) % M1,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   191
             ((double)(((long)s12) & 0x00000000ffffffffL)) % M1,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   192
             ((double)(((long)s20) & 0x00000000ffffffffL)) % M2,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   193
             ((double)(((long)s21) & 0x00000000ffffffffL)) % M2,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   194
             ((double)(((long)s22) & 0x00000000ffffffffL)) % M2);
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   195
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   196
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   197
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   198
     * Creates a new MRG32k3a instance using the specified
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   199
     * initial seed. MRG32k3a instances created with the same
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   200
     * seed in the same program generate identical sequences of values.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   201
     * An argument of 0 seeds the generator to a widely used initialization
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   202
     * of MRG32k3a: all six state variables are set to 12345.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   203
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   204
     * @param seed the initial seed
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   205
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   206
    public MRG32k3a(long seed) {
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   207
        this((double)((seed & 0x7FF) + 12345),
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   208
             (double)(((seed >>> 11) & 0x7FF) + 12345),
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   209
             (double)(((seed >>> 22) & 0x7FF) + 12345),
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   210
             (double)(((seed >>> 33) & 0x7FF) + 12345),
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   211
             (double)(((seed >>> 44) & 0x7FF) + 12345),
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   212
             (double)((seed >>> 55) + 12345));
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   213
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   214
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   215
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   216
     * Creates a new MRG32k3a instance that is likely to
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   217
     * generate sequences of values that are statistically independent
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   218
     * of those of any other instances in the current program; and
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   219
     * may, and typically does, vary across program invocations.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   220
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   221
    public MRG32k3a() {
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   222
        this(DEFAULT_GEN.getAndAdd(RNGSupport.GOLDEN_RATIO_64));
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   223
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   224
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   225
    /**
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   226
     * Creates a new instance of {@link Xoshiro256StarStar} using the specified array of
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   227
     * initial seed bytes. Instances of {@link Xoshiro256StarStar} created with the same
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   228
     * seed array in the same program execution generate identical sequences of values.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   229
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   230
     * @param seed the initial seed
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   231
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   232
    public MRG32k3a(byte[] seed) {
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   233
        // Convert the seed to 6 int values.
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   234
        int[] data = RNGSupport.convertSeedBytesToInts(seed, 6, 0);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   235
        int s10 = data[0], s11 = data[1], s12 = data[2];
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   236
        int s20 = data[3], s21 = data[4], s22 = data[5];
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   237
        this.s10 = ((double)(((long)s10) & 0x00000000ffffffffL)) % M1;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   238
        this.s11 = ((double)(((long)s11) & 0x00000000ffffffffL)) % M1;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   239
        this.s12 = ((double)(((long)s12) & 0x00000000ffffffffL)) % M1;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   240
        this.s20 = ((double)(((long)s20) & 0x00000000ffffffffL)) % M2;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   241
        this.s21 = ((double)(((long)s21) & 0x00000000ffffffffL)) % M2;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   242
        this.s22 = ((double)(((long)s22) & 0x00000000ffffffffL)) % M2;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   243
        if ((s10 == 0.0) && (s11 == 0.0) && (s12 == 0.0)) {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   244
            this.s10 = this.s11 = this.s12 = 12345.0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   245
        }
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   246
        if ((s20 == 0.0) && (s21 == 0.0) && (s22 == 0.0)) {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   247
            this.s20 = this.s21 = this.s21 = 12345.0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   248
        }
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   249
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   250
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   251
    public MRG32k3a copy() {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   252
        return new MRG32k3a(s10, s11, s12, s20, s21, s22);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   253
    }
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   254
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   255
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   256
     * Returns a pseudorandom {@code double} value between zero
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   257
     * (exclusive) and one (exclusive).
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   258
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   259
     * @return a pseudorandom {@code double} value between zero
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   260
     *         (exclusive) and one (exclusive)
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   261
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   262
    public double nextOpenDouble() {
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   263
        nextState();
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   264
        double p1 = s12, p2 = s22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   265
        if (p1 <= p2)
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   266
            return ((p1 - p2 + M1) * NORM1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   267
        else
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   268
            return ((p1 - p2) * NORM1);
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   269
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   270
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   271
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   272
     * Returns a pseudorandom {@code double} value between zero
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   273
     * (inclusive) and one (exclusive).
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   274
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   275
     * @return a pseudorandom {@code double} value between zero
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   276
     *         (inclusive) and one (exclusive)
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   277
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   278
    public double nextDouble() {
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   279
        nextState();
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   280
        double p1 = s12, p2 = s22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   281
        final double p = p1 * NORM1 - p2 * NORM2;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   282
        if (p < 0.0) return (p + 1.0);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   283
        else return p;
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   284
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   285
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   286
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   287
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   288
     * Returns a pseudorandom {@code float} value between zero
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   289
     * (inclusive) and one (exclusive).
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   290
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   291
     * @return a pseudorandom {@code float} value between zero
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   292
     *         (inclusive) and one (exclusive)
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   293
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   294
    public float nextFloat() {
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   295
        return (float)nextDouble();
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   296
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   297
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   298
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   299
     * Returns a pseudorandom {@code int} value.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   300
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   301
     * @return a pseudorandom {@code int} value
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   302
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   303
    public int nextInt() {
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   304
        return (internalNextInt(0x10000) << 16) | internalNextInt(0x10000);
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   305
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   306
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   307
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   308
     * Returns a pseudorandom {@code long} value.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   309
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   310
     * @return a pseudorandom {@code long} value
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   311
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   312
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   313
    public long nextLong() {
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   314
         return (((long)internalNextInt(0x200000) << 43) |
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   315
                ((long)internalNextInt(0x200000) << 22) |
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   316
                ((long)internalNextInt(0x400000)));
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   317
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   318
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   319
    // Period is (m1**3 - 1)(m2**3 - 1)/2, or approximately 2**191.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   320
    static BigInteger calculateThePeriod() {
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   321
        BigInteger bigm1 = BigInteger.valueOf((long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   322
        BigInteger bigm2 = BigInteger.valueOf((long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   323
        BigInteger t1 = bigm1.multiply(bigm1).multiply(bigm1).subtract(BigInteger.ONE);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   324
        BigInteger t2 = bigm2.multiply(bigm2).multiply(bigm2).subtract(BigInteger.ONE);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   325
        return t1.shiftRight(1).multiply(t2);
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   326
    }
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   327
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   328
    static final BigInteger PERIOD = calculateThePeriod();
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   329
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   330
    public BigInteger period() {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   331
        return PERIOD;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   332
    }
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   333
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   334
    // Jump and leap distances recommended in Section 1.3 of this paper:
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   335
    // Pierre L'Ecuyer, Richard Simard, E. Jack Chen, and W. David Kelton.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   336
    // An Object-Oriented Random-Number Package with Many Long Streams and Substreams.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   337
    // Operations Research 50, 6 (Nov--Dec 2002), 1073--1075.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   338
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   339
    public double defaultJumpDistance() {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   340
        return 0x1.0p76;   // 2**76
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   341
    }
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   342
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   343
    public double defaultLeapDistance() {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   344
        return 0x1.0p127;   // 2**127
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   345
    }
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   346
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   347
    public void jump(double distance) {
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   348
        if (distance < 0.0 || Double.isInfinite(distance) || distance != Math.floor(distance))
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   349
            throw new IllegalArgumentException("jump distance must be a nonnegative finite integer");
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   350
            // We will compute a jump transformation (s => M s) for each LCG.
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   351
            // We initialize each transformation to the identity transformation.
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   352
            // Each will be turned into the d'th power of the corresponding base transformation.
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   353
        long m1_00 = 1, m1_01 = 0, m1_02 = 0,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   354
             m1_10 = 0, m1_11 = 1, m1_12 = 0,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   355
             m1_20 = 0, m1_21 = 0, m1_22 = 1;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   356
        long m2_00 = 1, m2_01 = 0, m2_02 = 0,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   357
             m2_10 = 0, m2_11 = 1, m2_12 = 0,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   358
             m2_20 = 0, m2_21 = 0, m2_22 = 1;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   359
        // These are the base transformations, which will be repeatedly squared,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   360
        // and composed with the computed transformations for each 1-bit in distance.
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   361
        long t1_00 = 0,           t1_01 = 1,         t1_02 = 0,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   362
             t1_10 = 0,           t1_11 = 0,         t1_12 = 1,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   363
             t1_20 = -(long)A13N, t1_21 = (long)A12, t1_22 = 0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   364
        long t2_00 = 0,           t2_01 = 1,         t2_02 = 0,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   365
             t2_10 = 0,           t2_11 = 0,         t2_12 = 1,
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   366
             t2_20 = -(long)A23N, t2_21 = (long)A21, t2_22 = 0;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   367
        while (distance > 0.0) {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   368
            final double dhalf = 0.5 * distance;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   369
            if (Math.floor(dhalf) != dhalf) {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   370
                // distance is odd: accumulate current squaring
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   371
                final long n1_00 = m1_00 * t1_00 + m1_01 * t1_10 + m1_02 * t1_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   372
                final long n1_01 = m1_00 * t1_01 + m1_01 * t1_11 + m1_02 * t1_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   373
                final long n1_02 = m1_00 * t1_02 + m1_01 * t1_12 + m1_02 * t1_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   374
                final long n1_10 = m1_10 * t1_00 + m1_11 * t1_10 + m1_12 * t1_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   375
                final long n1_11 = m1_10 * t1_01 + m1_11 * t1_11 + m1_12 * t1_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   376
                final long n1_12 = m1_10 * t1_02 + m1_11 * t1_12 + m1_12 * t1_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   377
                final long n1_20 = m1_20 * t1_00 + m1_21 * t1_10 + m1_22 * t1_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   378
                final long n1_21 = m1_20 * t1_01 + m1_21 * t1_11 + m1_22 * t1_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   379
                final long n1_22 = m1_20 * t1_02 + m1_21 * t1_12 + m1_22 * t1_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   380
                m1_00 = Math.floorMod(n1_00, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   381
                m1_01 = Math.floorMod(n1_01, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   382
                m1_02 = Math.floorMod(n1_02, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   383
                m1_10 = Math.floorMod(n1_10, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   384
                m1_11 = Math.floorMod(n1_11, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   385
                m1_12 = Math.floorMod(n1_12, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   386
                m1_20 = Math.floorMod(n1_20, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   387
                m1_21 = Math.floorMod(n1_21, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   388
                m1_22 = Math.floorMod(n1_22, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   389
                final long n2_00 = m2_00 * t2_00 + m2_01 * t2_10 + m2_02 * t2_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   390
                final long n2_01 = m2_00 * t2_01 + m2_01 * t2_11 + m2_02 * t2_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   391
                final long n2_02 = m2_00 * t2_02 + m2_01 * t2_12 + m2_02 * t2_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   392
                final long n2_10 = m2_10 * t2_00 + m2_11 * t2_10 + m2_12 * t2_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   393
                final long n2_11 = m2_10 * t2_01 + m2_11 * t2_11 + m2_12 * t2_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   394
                final long n2_12 = m2_10 * t2_02 + m2_11 * t2_12 + m2_12 * t2_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   395
                final long n2_20 = m2_20 * t2_00 + m2_21 * t2_10 + m2_22 * t2_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   396
                final long n2_21 = m2_20 * t2_01 + m2_21 * t2_11 + m2_22 * t2_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   397
                final long n2_22 = m2_20 * t2_02 + m2_21 * t2_12 + m2_22 * t2_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   398
                m2_00 = Math.floorMod(n2_00, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   399
                m2_01 = Math.floorMod(n2_01, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   400
                m2_02 = Math.floorMod(n2_02, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   401
                m2_10 = Math.floorMod(n2_10, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   402
                m2_11 = Math.floorMod(n2_11, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   403
                m2_12 = Math.floorMod(n2_12, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   404
                m2_20 = Math.floorMod(n2_20, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   405
                m2_21 = Math.floorMod(n2_21, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   406
                m2_22 = Math.floorMod(n2_22, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   407
            }
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   408
            // Square the base transformations.
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   409
            {
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   410
                final long z1_00 = m1_00 * m1_00 + m1_01 * m1_10 + m1_02 * m1_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   411
                final long z1_01 = m1_00 * m1_01 + m1_01 * m1_11 + m1_02 * m1_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   412
                final long z1_02 = m1_00 * m1_02 + m1_01 * m1_12 + m1_02 * m1_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   413
                final long z1_10 = m1_10 * m1_00 + m1_11 * m1_10 + m1_12 * m1_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   414
                final long z1_11 = m1_10 * m1_01 + m1_11 * m1_11 + m1_12 * m1_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   415
                final long z1_12 = m1_10 * m1_02 + m1_11 * m1_12 + m1_12 * m1_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   416
                final long z1_20 = m1_20 * m1_00 + m1_21 * m1_10 + m1_22 * m1_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   417
                final long z1_21 = m1_20 * m1_01 + m1_21 * m1_11 + m1_22 * m1_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   418
                final long z1_22 = m1_20 * m1_02 + m1_21 * m1_12 + m1_22 * m1_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   419
                m1_00 = Math.floorMod(z1_00, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   420
                m1_01 = Math.floorMod(z1_01, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   421
                m1_02 = Math.floorMod(z1_02, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   422
                m1_10 = Math.floorMod(z1_10, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   423
                m1_11 = Math.floorMod(z1_11, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   424
                m1_12 = Math.floorMod(z1_12, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   425
                m1_20 = Math.floorMod(z1_20, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   426
                m1_21 = Math.floorMod(z1_21, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   427
                m1_22 = Math.floorMod(z1_22, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   428
                final long z2_00 = m2_00 * m2_00 + m2_01 * m2_10 + m2_02 * m2_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   429
                final long z2_01 = m2_00 * m2_01 + m2_01 * m2_11 + m2_02 * m2_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   430
                final long z2_02 = m2_00 * m2_02 + m2_01 * m2_12 + m2_02 * m2_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   431
                final long z2_10 = m2_10 * m2_00 + m2_11 * m2_10 + m2_12 * m2_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   432
                final long z2_11 = m2_10 * m2_01 + m2_11 * m2_11 + m2_12 * m2_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   433
                final long z2_12 = m2_10 * m2_02 + m2_11 * m2_12 + m2_12 * m2_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   434
                final long z2_20 = m2_20 * m2_00 + m2_21 * m2_10 + m2_22 * m2_20;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   435
                final long z2_21 = m2_20 * m2_01 + m2_21 * m2_11 + m2_22 * m2_21;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   436
                final long z2_22 = m2_20 * m2_02 + m2_21 * m2_12 + m2_22 * m2_22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   437
                m2_00 = Math.floorMod(z2_00, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   438
                m2_01 = Math.floorMod(z2_01, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   439
                m2_02 = Math.floorMod(z2_02, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   440
                m2_10 = Math.floorMod(z2_10, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   441
                m2_11 = Math.floorMod(z2_11, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   442
                m2_12 = Math.floorMod(z2_12, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   443
                m2_20 = Math.floorMod(z2_20, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   444
                m2_21 = Math.floorMod(z2_21, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   445
                m2_22 = Math.floorMod(z2_22, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   446
            }
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   447
            // Divide distance by 2.
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   448
            distance = dhalf;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   449
        }
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   450
        final long w10 = m1_00 * (long)s10 + m1_01 * (long)s11 + m1_02 * (long)s12;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   451
        final long w11 = m1_10 * (long)s10 + m1_11 * (long)s11 + m1_12 * (long)s12;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   452
        final long w12 = m1_20 * (long)s10 + m1_21 * (long)s11 + m1_22 * (long)s12;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   453
        s10 = Math.floorMod(w10, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   454
        s11 = Math.floorMod(w11, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   455
        s12 = Math.floorMod(w12, (long)M1);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   456
        final long w20 = m2_00 * (long)s20 + m2_01 * (long)s21 + m2_02 * (long)s22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   457
        final long w21 = m2_10 * (long)s20 + m2_11 * (long)s21 + m2_12 * (long)s22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   458
        final long w22 = m2_20 * (long)s20 + m2_21 * (long)s21 + m2_22 * (long)s22;
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   459
        s20 = Math.floorMod(w20, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   460
        s21 = Math.floorMod(w21, (long)M2);
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   461
        s22 = Math.floorMod(w22, (long)M2);
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   462
    }
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   463
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   464
    /**
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   465
     * Alter the state of this pseudorandom number generator so as to
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   466
     * jump forward a distance equal to 2<sup>{@code logDistance}</sup>
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   467
     * within its state cycle.
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   468
     *
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   469
     * @param logDistance the base-2 logarithm of the distance to jump
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   470
     *        forward within the state cycle.  Must be non-negative and
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   471
     *        not greater than 192.
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   472
     *
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   473
     * @throws IllegalArgumentException if {@code logDistance} is
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   474
     *         less than zero or 2<sup>{@code logDistance}</sup> is
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   475
     *         greater than the period of this generator
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   476
     */
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   477
    public void jumpPowerOfTwo(int logDistance) {
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   478
        if (logDistance < 0 || logDistance > 192)
57437
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   479
            throw new IllegalArgumentException("logDistance must be non-negative and not greater than 192");
f02ffcb61dce Rename Rng.java to RandomNumberGenerator.java, clean up javadoc and misc code changes
jlaskey
parents: 57436
diff changeset
   480
        jump(Math.scalb(1.0, logDistance));
57388
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   481
    }
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   482
b1e6bc96af3d Initial commit of new RNG code from GLS
briangoetz
parents:
diff changeset
   483
}