src/java.base/share/classes/java/util/random/L128X256MixRandom.java.rej
author jlaskey
Thu, 14 Nov 2019 12:50:08 -0400
branchJDK-8193209-branch
changeset 59088 da026c172c1e
permissions -rw-r--r--
add missing files
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
59088
da026c172c1e add missing files
jlaskey
parents:
diff changeset
     1
***************
da026c172c1e add missing files
jlaskey
parents:
diff changeset
     2
*** 28,34 ****
da026c172c1e add missing files
jlaskey
parents:
diff changeset
     3
  import java.math.BigInteger;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
     4
  import java.util.concurrent.atomic.AtomicLong;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
     5
  import java.util.random.RandomGenerator.SplittableGenerator;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
     6
- import java.util.random.RandomSupport.AbstractSplittableGenerator;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
     7
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
     8
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
     9
  /**
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    10
--- 28,34 ----
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    11
  import java.math.BigInteger;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    12
  import java.util.concurrent.atomic.AtomicLong;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    13
  import java.util.random.RandomGenerator.SplittableGenerator;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    14
+ import java.util.random.RandomSupport.AbstractSplittableWithBrineGenerator;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    15
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    16
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    17
  /**
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    18
***************
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    19
*** 55,63 ****
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    20
   * {@link L128X256MixRandom} is a specific member of the LXM family of algorithms
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    21
   * for pseudorandom number generators.  Every LXM generator consists of two
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    22
   * subgenerators; one is an LCG (Linear Congruential Generator) and the other is
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    23
-  * an Xorshift generator.  Each output of an LXM generator is the sum of one
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    24
-  * output from each subgenerator, possibly processed by a final mixing function
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    25
-  * (and {@link L128X256MixRandom} does use a mixing function).
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    26
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    27
   * The LCG subgenerator for {@link L128X256MixRandom} has an update step of the
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    28
   * form {@code s = m * s + a}, where {@code s}, {@code m}, and {@code a} are all
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    29
--- 55,64 ----
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    30
   * {@link L128X256MixRandom} is a specific member of the LXM family of algorithms
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    31
   * for pseudorandom number generators.  Every LXM generator consists of two
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    32
   * subgenerators; one is an LCG (Linear Congruential Generator) and the other is
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    33
+  * an Xorshift generator.  Each output of an LXM generator is the result of
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    34
+  * combining state from the LCG with state from the Xorshift generator by
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    35
+  * using a Mixing function (and then the state of the LCG and the state of the
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    36
+  * Xorshift generator are advanced).
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    37
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    38
   * The LCG subgenerator for {@link L128X256MixRandom} has an update step of the
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    39
   * form {@code s = m * s + a}, where {@code s}, {@code m}, and {@code a} are all
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    40
***************
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    41
*** 74,80 ****
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    42
   * and {@code x3}, which can take on any values provided that they are not all zero.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    43
   * The period of this subgenerator is 2<sup>256</sup>-1.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    44
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    45
-  * The mixing function for {@link L128X256MixRandom} is the 64-bit MurmurHash3 finalizer.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    46
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    47
   * Because the periods 2<sup>128</sup> and 2<sup>256</sup>-1 of the two subgenerators
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    48
   * are relatively prime, the <em>period</em> of any single {@link L128X256MixRandom} object
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    49
--- 75,82 ----
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    50
   * and {@code x3}, which can take on any values provided that they are not all zero.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    51
   * The period of this subgenerator is 2<sup>256</sup>-1.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    52
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    53
+  * The mixing function for {@link L128X256MixRandom} is {@link RandomSupport.mixLea64}
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    54
+  * applied to the argument {@code (sh + x0)}, where {@code sh} is the high half of {@code s}.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    55
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    56
   * Because the periods 2<sup>128</sup> and 2<sup>256</sup>-1 of the two subgenerators
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    57
   * are relatively prime, the <em>period</em> of any single {@link L128X256MixRandom} object
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    58
***************
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    59
*** 86,119 ****
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    60
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    61
   * The 64-bit values produced by the {@code nextLong()} method are exactly equidistributed.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    62
   * For any specific instance of {@link L128X256MixRandom}, over the course of its cycle each
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    63
-  * of the 2<sup>64</sup> possible {@code long} values will be produced 2<sup>256</sup>-1 times.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    64
-  * The values produced by the {@code nextInt()}, {@code nextFloat()}, and {@code nextDouble()}
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    65
-  * methods are likewise exactly equidistributed.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    66
-  * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    67
-  * In fact, the 64-bit values produced by the {@code nextLong()} method are exactly
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    68
-  * 2-equidistributed.  For any specific instance of {@link L128X256MixRandom}, consider
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    69
-  * the (overlapping) length-2 subsequences of the cycle of 64-bit values produced by
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    70
-  * {@code nextLong()} (assuming no other methods are called that would affect the state).
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    71
-  * There are 2<sup>128</sup>(2<sup>256</sup>-1) such subsequences, and each subsequence,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    72
-  * which consists of 2 64-bit values, can have one of 2<sup>128</sup> values, and each
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    73
-  * such value occurs  2<sup>256</sup>-1 times.  The values produced by the {@code nextInt()},
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    74
-  * {@code nextFloat()}, and {@code nextDouble()} methods are likewise exactly 2-equidistributed.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    75
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    76
-  * Moreover, the 64-bit values produced by the {@code nextLong()} method are 4-equidistributed.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    77
-  * To be precise: for any specific instance of {@link L128X256MixRandom}, consider
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    78
-  * the (overlapping) length-4 subsequences of the cycle of 64-bit values produced by
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    79
-  * {@code nextLong()} (assuming no other methods are called that would affect the state).
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    80
-  * There are <sup>128</sup>(2<sup>256</sup>-1) such subsequences, and each subsequence,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    81
-  * which consists of 4 64-bit values, can have one of 2<sup>256</sup> values. Of those
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    82
-  * 2<sup>256</sup> subsequence values, nearly all of them (2<sup>256</sup>-2<sup>128</sup>)
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    83
-  * occur 2<sup>128</sup> times over the course of the entire cycle, and the other
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    84
-  * 2<sup>128</sup> subsequence values occur only 2<sup>128</sup>-1 times.  So the ratio
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    85
-  * of the probability of getting one of the less common subsequence values and the
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    86
-  * probability of getting one of the more common subsequence values is 1-2<sup>-128</sup>.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    87
-  * (Note that the set of 2<sup>128</sup> less-common subsequence values will differ from
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    88
-  * one instance of {@link L128X256MixRandom} to another, as a function of the additive
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    89
-  * parameter of the LCG.)  The values produced by the {@code nextInt()}, {@code nextFloat()},
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    90
-  * and {@code nextDouble()} methods are likewise 4-equidistributed.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    91
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    92
   * Method {@link #split} constructs and returns a new {@link L128X256MixRandom}
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    93
   * instance that shares no mutable state with the current instance. However, with
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    94
--- 88,103 ----
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    95
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    96
   * The 64-bit values produced by the {@code nextLong()} method are exactly equidistributed.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    97
   * For any specific instance of {@link L128X256MixRandom}, over the course of its cycle each
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    98
+  * of the 2<sup>64</sup> possible {@code long} values will be produced
da026c172c1e add missing files
jlaskey
parents:
diff changeset
    99
+  * 2<sup>64</sup>(2<sup>256</sup>-1) times.  The values produced by the {@code nextInt()},
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   100
+  * {@code nextFloat()}, and {@code nextDouble()} methods are likewise exactly equidistributed.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   101
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   102
+  * Moreover, 64-bit values produced by the {@code nextLong()} method are conjectured to be
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   103
+  * "very nearly" 4-equidistributed: all possible quadruples of 64-bit values are generated,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   104
+  * and some pairs occur more often than others, but only very slightly more often.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   105
+  * However, this conjecture has not yet been proven mathematically.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   106
+  * If this conjecture is true, then the values produced by the {@code nextInt()}, {@code nextFloat()},
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   107
+  * and {@code nextDouble()} methods are likewise approximately 4-equidistributed.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   108
   * <p>
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   109
   * Method {@link #split} constructs and returns a new {@link L128X256MixRandom}
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   110
   * instance that shares no mutable state with the current instance. However, with
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   111
***************
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   112
*** 146,152 ****
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   113
   *
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   114
   * @since 14
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   115
   */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   116
- public final class L128X256MixRandom extends AbstractSplittableGenerator {
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   117
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   118
      /*
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   119
       * Implementation Overview.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   120
--- 130,136 ----
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   121
   *
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   122
   * @since 14
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   123
   */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   124
+ public final class L128X256MixRandom extends AbstractSplittableWithBrineGenerator {
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   125
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   126
      /*
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   127
       * Implementation Overview.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   128
***************
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   129
*** 193,220 ****
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   130
          BigInteger.ONE.shiftLeft(256).subtract(BigInteger.ONE).shiftLeft(128);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   131
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   132
      /*
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   133
-      * The multiplier used in the LCG portion of the algorithm is 2**64 + m;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   134
-      * where m is taken from
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   135
-      * Pierre L'Ecuyer, Tables of linear congruential generators of
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   136
-      * different sizes and good lattice structure, <em>Mathematics of
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   137
-      * Computation</em> 68, 225 (January 1999), pages 249-260,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   138
-      * Table 4 (first multiplier for size 2<sup>64</sup>).
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   139
-      *
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   140
-      * This is almost certainly not the best possible 128-bit multiplier
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   141
-      * for an LCG, but it is sufficient for our purposes here; because
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   142
-      * is is larger than 2**64, the 64-bit values produced by nextLong()
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   143
-      * are exactly 2-equidistributed, and the fact that it is of the
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   144
-      * form (2**64 + m) simplifies the code, given that we have only
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   145
-      * 64-bit arithmetic to work with.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   146
       */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   147
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   148
-     private static final long M = 2862933555777941757L;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   149
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   150
      /* ---------------- instance fields ---------------- */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   151
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   152
      /**
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   153
       * The parameter that is used as an additive constant for the LCG.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   154
-      * Must be odd.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   155
       */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   156
      private final long ah, al;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   157
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   158
--- 177,196 ----
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   159
          BigInteger.ONE.shiftLeft(256).subtract(BigInteger.ONE).shiftLeft(128);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   160
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   161
      /*
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   162
+      * Low half of multiplier used in the LCG portion of the algorithm;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   163
+      * the overall multiplier is (2**64 + ML).
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   164
+      * Chosen based on research by Sebastiano Vigna and Guy Steele (2019).
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   165
+      * The spectral scores for dimensions 2 through 8 for the multiplier 0x1d605bbb58c8abbfdLL
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   166
+      * are [0.991889, 0.907938, 0.830964, 0.837980, 0.780378, 0.797464, 0.761493].
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   167
       */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   168
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   169
+     private static final long ML = 0xd605bbb58c8abbfdL;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   170
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   171
      /* ---------------- instance fields ---------------- */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   172
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   173
      /**
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   174
       * The parameter that is used as an additive constant for the LCG.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   175
+      * Must be odd (therefore al must be odd).
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   176
       */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   177
      private final long ah, al;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   178
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   179
***************
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   180
*** 252,262 ****
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   181
          this.x3 = x3;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   182
          // If x0, x1, x2, and x3 are all zero, we must choose nonzero values.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   183
          if ((x0 | x1 | x2 | x3) == 0) {
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   184
              // At least three of the four values generated here will be nonzero.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   185
-             this.x0 = RandomSupport.mixStafford13(sh += RandomSupport.GOLDEN_RATIO_64);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   186
-             this.x1 = RandomSupport.mixStafford13(sh += RandomSupport.GOLDEN_RATIO_64);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   187
-             this.x2 = RandomSupport.mixStafford13(sh += RandomSupport.GOLDEN_RATIO_64);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   188
-             this.x3 = RandomSupport.mixStafford13(sh + RandomSupport.GOLDEN_RATIO_64);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   189
          }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   190
      }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   191
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   192
--- 228,239 ----
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   193
          this.x3 = x3;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   194
          // If x0, x1, x2, and x3 are all zero, we must choose nonzero values.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   195
          if ((x0 | x1 | x2 | x3) == 0) {
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   196
+ 	    long v = sh;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   197
              // At least three of the four values generated here will be nonzero.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   198
+             this.x0 = RandomSupport.mixStafford13(v += RandomSupport.GOLDEN_RATIO_64);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   199
+             this.x1 = RandomSupport.mixStafford13(v += RandomSupport.GOLDEN_RATIO_64);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   200
+             this.x2 = RandomSupport.mixStafford13(v += RandomSupport.GOLDEN_RATIO_64);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   201
+             this.x3 = RandomSupport.mixStafford13(v + RandomSupport.GOLDEN_RATIO_64);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   202
          }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   203
      }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   204
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   205
***************
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   206
*** 277,283 ****
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   207
          // The seed is hashed by mixStafford13 to produce the initial `x0`,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   208
          // which will then be used to produce the first generated value.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   209
          // The other x values are filled in as if by a SplitMix PRNG with
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   210
-         // GOLDEN_RATIO_64 as the gamma value and Stafford13 as the mixer.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   211
          this(RandomSupport.mixMurmur64(seed ^= RandomSupport.SILVER_RATIO_64),
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   212
               RandomSupport.mixMurmur64(seed += RandomSupport.GOLDEN_RATIO_64),
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   213
               0,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   214
--- 254,260 ----
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   215
          // The seed is hashed by mixStafford13 to produce the initial `x0`,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   216
          // which will then be used to produce the first generated value.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   217
          // The other x values are filled in as if by a SplitMix PRNG with
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   218
+         // GOLDEN_RATIO_64 as the gamma value and mixStafford13 as the mixer.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   219
          this(RandomSupport.mixMurmur64(seed ^= RandomSupport.SILVER_RATIO_64),
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   220
               RandomSupport.mixMurmur64(seed += RandomSupport.GOLDEN_RATIO_64),
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   221
               0,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   222
***************
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   223
*** 323,351 ****
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   224
      }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   225
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   226
      /* ---------------- public methods ---------------- */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   227
- 
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   228
      /**
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   229
-      * Constructs and returns a new instance of {@link L128X256MixRandom}
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   230
-      * that shares no mutable state with this instance.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   231
       * However, with very high probability, the set of values collectively
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   232
       * generated by the two objects has the same statistical properties as if
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   233
       * same the quantity of values were generated by a single thread using
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   234
-      * a single {@link L128X256MixRandom} object.  Either or both of the two
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   235
       * objects may be further split using the {@code split} method,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   236
       * and the same expected statistical properties apply to the
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   237
       * entire set of generators constructed by such recursive splitting.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   238
       *
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   239
-      * @param source a {@link SplittableGenerator} instance to be used instead
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   240
       *               of this one as a source of pseudorandom bits used to
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   241
       *               initialize the state of the new ones.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   242
-      * @return a new instance of {@link L128X256MixRandom}
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   243
       */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   244
-     public L128X256MixRandom split(SplittableGenerator source) {
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   245
-         // Literally pick a new instance "at random".
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   246
-         return new L128X256MixRandom(source.nextLong(), source.nextLong(),
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   247
-                                      source.nextLong(), source.nextLong(),
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   248
-                                      source.nextLong(), source.nextLong(),
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   249
-                                      source.nextLong(), source.nextLong());
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   250
      }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   251
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   252
      /**
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   253
--- 300,330 ----
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   254
      }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   255
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   256
      /* ---------------- public methods ---------------- */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   257
+     
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   258
      /**
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   259
+      * Given 63 bits of "brine", constructs and returns a new instance of
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   260
+      * {@code L128X256MixRandom} that shares no mutable state with this instance.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   261
       * However, with very high probability, the set of values collectively
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   262
       * generated by the two objects has the same statistical properties as if
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   263
       * same the quantity of values were generated by a single thread using
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   264
+      * a single {@code L128X256MixRandom} object.  Either or both of the two
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   265
       * objects may be further split using the {@code split} method,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   266
       * and the same expected statistical properties apply to the
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   267
       * entire set of generators constructed by such recursive splitting.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   268
       *
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   269
+      * @param source a {@code SplittableGenerator} instance to be used instead
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   270
       *               of this one as a source of pseudorandom bits used to
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   271
       *               initialize the state of the new ones.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   272
+      * @param brine a long value, of which the low 63 bits are used to choose
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   273
+      *              the {@code a} parameter for the new instance.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   274
+      * @return a new instance of {@code L128X256MixRandom}
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   275
       */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   276
+     public SplittableGenerator split(SplittableGenerator source, long brine) {
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   277
+ 	// Pick a new instance "at random", but use the brine for (the low half of) `a`.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   278
+         return new L128X256MixRandom(source.nextLong(), brine << 1,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   279
+ 				     source.nextLong(), source.nextLong(),
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   280
+ 				     source.nextLong(), source.nextLong(),
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   281
+ 				     source.nextLong(), source.nextLong());
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   282
      }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   283
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   284
      /**
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   285
***************
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   286
*** 354,365 ****
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   287
       * @return a pseudorandom {@code long} value
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   288
       */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   289
      public long nextLong() {
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   290
-         final long z = sh + x0;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   291
-         // The LCG: in effect, s = ((1LL << 64) + M) * s + a, if only we had 128-bit arithmetic.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   292
-         final long u = M * sl;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   293
-         sh = (M * sh) + Math.multiplyHigh(M, sl) + sl + ah;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   294
          sl = u + al;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   295
          if (Long.compareUnsigned(sl, u) < 0) ++sh;  // Handle the carry propagation from low half to high half.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   296
          long q0 = x0, q1 = x1, q2 = x2, q3 = x3;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   297
          {   // xoshiro256 1.0
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   298
              long t = q1 << 17;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   299
--- 333,359 ----
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   300
       * @return a pseudorandom {@code long} value
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   301
       */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   302
      public long nextLong() {
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   303
+ 	// Compute the result based on current state information
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   304
+ 	// (this allows the computation to be overlapped with state update).
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   305
+         final long result = RandomSupport.mixLea64(sh + x0);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   306
+ 
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   307
+ 	// Update the LCG subgenerator
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   308
+         // The LCG is, in effect, s = ((1LL << 64) + ML) * s + a, if only we had 128-bit arithmetic.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   309
+         final long u = ML * sl;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   310
+ 	// Note that Math.multiplyHigh computes the high half of the product of signed values,
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   311
+ 	// but what we need is the high half of the product of unsigned values; for this we use the
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   312
+ 	// formula "unsignedMultiplyHigh(a, b) = multiplyHigh(a, b) + ((a >> 63) & b) + ((b >> 63) & a)";
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   313
+ 	// in effect, each operand is added to the result iff the sign bit of the other operand is 1.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   314
+ 	// (See Henry S. Warren, Jr., _Hacker's Delight_ (Second Edition), Addison-Wesley (2013),
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   315
+ 	// Section 8-3, p. 175; or see the First Edition, Addison-Wesley (2003), Section 8-3, p. 133.)
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   316
+ 	// If Math.unsignedMultiplyHigh(long, long) is ever implemented, the following line can become:
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   317
+ 	//         sh = (ML * sh) + Math.unsignedMultiplyHigh(ML, sl) + sl + ah;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   318
+ 	// and this entire comment can be deleted.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   319
+         sh = (ML * sh) + (Math.multiplyHigh(ML, sl) + ((ML >> 63) & sl) + ((sl >> 63) & ML)) + sl + ah;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   320
          sl = u + al;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   321
          if (Long.compareUnsigned(sl, u) < 0) ++sh;  // Handle the carry propagation from low half to high half.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   322
+ 
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   323
+ 	// Update the Xorshift subgenerator
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   324
          long q0 = x0, q1 = x1, q2 = x2, q3 = x3;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   325
          {   // xoshiro256 1.0
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   326
              long t = q1 << 17;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   327
***************
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   328
*** 371,379 ****
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   329
              q3 = Long.rotateLeft(q3, 45);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   330
          }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   331
          x0 = q0; x1 = q1; x2 = q2; x3 = q3;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   332
-         return RandomSupport.mixLea64(z);  // mixing function
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   333
      }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   334
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   335
      public BigInteger period() {
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   336
          return PERIOD;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   337
      }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   338
--- 365,379 ----
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   339
              q3 = Long.rotateLeft(q3, 45);
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   340
          }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   341
          x0 = q0; x1 = q1; x2 = q2; x3 = q3;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   342
+         return result;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   343
      }
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   344
  
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   345
+     /**
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   346
+      * Returns the period of this random generator.
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   347
+      *
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   348
+      * @return a {@link BigInteger} whose value is the number of distinct possible states of this
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   349
+      *         {@link RandomGenerator} object (2<sup>128</sup>(2<sup>256</sup>-1)).
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   350
+      */
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   351
      public BigInteger period() {
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   352
          return PERIOD;
da026c172c1e add missing files
jlaskey
parents:
diff changeset
   353
      }