src/java.base/share/classes/java/util/random/L128X1024MixRandom.java
branchJDK-8193209-branch
changeset 59088 da026c172c1e
equal deleted inserted replaced
59087:effb66aab08b 59088:da026c172c1e
       
     1 /*
       
     2  * Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.
       
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
       
     4  *
       
     5  * This code is free software; you can redistribute it and/or modify it
       
     6  * under the terms of the GNU General Public License version 2 only, as
       
     7  * published by the Free Software Foundation.  Oracle designates this
       
     8  * particular file as subject to the "Classpath" exception as provided
       
     9  * by Oracle in the LICENSE file that accompanied this code.
       
    10  *
       
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
       
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
       
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
       
    14  * version 2 for more details (a copy is included in the LICENSE file that
       
    15  * accompanied this code).
       
    16  *
       
    17  * You should have received a copy of the GNU General Public License version
       
    18  * 2 along with this work; if not, write to the Free Software Foundation,
       
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
       
    20  *
       
    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
       
    22  * or visit www.oracle.com if you need additional information or have any
       
    23  * questions.
       
    24  */
       
    25 
       
    26 package java.util.random;
       
    27 
       
    28 import java.math.BigInteger;
       
    29 import java.util.concurrent.atomic.AtomicLong;
       
    30 import java.util.random.RandomGenerator.SplittableGenerator;
       
    31 import java.util.random.RandomSupport.AbstractSplittableWithBrineGenerator;
       
    32 
       
    33 /**
       
    34  * A generator of uniform pseudorandom values applicable for use in
       
    35  * (among other contexts) isolated parallel computations that may
       
    36  * generate subtasks.  Class {@link L128X1024MixRandom} implements
       
    37  * interfaces {@link RandomGenerator} and {@link SplittableGenerator},
       
    38  * and therefore supports methods for producing pseudorandomly chosen
       
    39  * numbers of type {@code int}, {@code long}, {@code float}, and {@code double}
       
    40  * as well as creating new split-off {@link L128X1024MixRandom} objects,
       
    41  * with similar usages as for class {@link java.util.SplittableRandom}.
       
    42  * <p>
       
    43  * Series of generated values pass the TestU01 BigCrush and PractRand test suites
       
    44  * that measure independence and uniformity properties of random number generators.
       
    45  * (Most recently validated with
       
    46  * <a href="http://simul.iro.umontreal.ca/testu01/tu01.html">version 1.2.3 of TestU01</a>
       
    47  * and <a href="http://pracrand.sourceforge.net">version 0.90 of PractRand</a>.
       
    48  * Note that TestU01 BigCrush was used to test not only values produced by the {@code nextLong()}
       
    49  * method but also the result of bit-reversing each value produced by {@code nextLong()}.)
       
    50  * These tests validate only the methods for certain
       
    51  * types and ranges, but similar properties are expected to hold, at
       
    52  * least approximately, for others as well.
       
    53  * <p>
       
    54  * {@link L128X1024MixRandom} is a specific member of the LXM family of algorithms
       
    55  * for pseudorandom number generators.  Every LXM generator consists of two
       
    56  * subgenerators; one is an LCG (Linear Congruential Generator) and the other is
       
    57  * an Xorshift generator.  Each output of an LXM generator is the result of
       
    58  * combining state from the LCG with state from the Xorshift generator by
       
    59  * using a Mixing function (and then the state of the LCG and the state of the
       
    60  * Xorshift generator are advanced).
       
    61  * <p>
       
    62  * The LCG subgenerator for {@link L128X256MixRandom} has an update step of the
       
    63  * form {@code s = m * s + a}, where {@code s}, {@code m}, and {@code a} are all
       
    64  * 128-bit integers; {@code s} is the mutable state, the multiplier {@code m}
       
    65  * is fixed (the same for all instances of {@link L128X256MixRandom}) and the addend
       
    66  * {@code a} is a parameter (a final field of the instance).  The parameter
       
    67  * {@code a} is required to be odd (this allows the LCG to have the maximal
       
    68  * period, namely 2<sup>128</sup>); therefore there are 2<sup>127</sup> distinct choices
       
    69  * of parameter.
       
    70  * <p>
       
    71  * The Xorshift subgenerator for {@link L128X1024MixRandom} is the {@code xoroshiro1024}
       
    72  * algorithm (parameters 25, 27, and 36), without any final scrambler such as "+" or "**".
       
    73  * Its state consists of an array {@code x} of sixteen {@code long} values,
       
    74  * which can take on any values provided that they are not all zero.
       
    75  * The period of this subgenerator is 2<sup>1024</sup>-1.
       
    76  * <p>
       
    77  * The mixing function for {@link L128X1024MixRandom} is {@link RandomSupport.mixLea64}
       
    78  * applied to the argument {@code (sh + s0)}, where {@code sh} is the high half of {@code s}
       
    79  * and {@code s0} is the most recently computed element of {@code x}.
       
    80  * <p>
       
    81  * Because the periods 2<sup>128</sup> and 2<sup>1024</sup>-1 of the two subgenerators
       
    82  * are relatively prime, the <em>period</em> of any single {@link L128X1024MixRandom} object
       
    83  * (the length of the series of generated 64-bit values before it repeats) is the product
       
    84  * of the periods of the subgenerators, that is, 2<sup>128</sup>(2<sup>1024</sup>-1),
       
    85  * which is just slightly smaller than 2<sup>1152</sup>.  Moreover, if two distinct
       
    86  * {@link L128X1024MixRandom} objects have different {@code a} parameters, then their
       
    87  * cycles of produced values will be different.
       
    88  * <p>
       
    89  * The 64-bit values produced by the {@code nextLong()} method are exactly equidistributed.
       
    90  * For any specific instance of {@link L128X1024MixRandom}, over the course of its cycle each
       
    91  * of the 2<sup>64</sup> possible {@code long} values will be produced
       
    92  * 2<sup>64</sup>(2<sup>1024</sup>-1 times.  The values produced by the {@code nextInt()},
       
    93  * {@code nextFloat()}, and {@code nextDouble()} methods are likewise exactly equidistributed.
       
    94  * <p>
       
    95  * Moreover, 64-bit values produced by the {@code nextLong()} method are conjectured to be
       
    96  * "very nearly" 16-equidistributed: all possible 16-tuples of 64-bit values are generated,
       
    97  * and some pairs occur more often than others, but only very slightly more often.
       
    98  * However, this conjecture has not yet been proven mathematically.
       
    99  * If this conjecture is true, then the values produced by the {@code nextInt()}, {@code nextFloat()},
       
   100  * and {@code nextDouble()} methods are likewise approximately 16-equidistributed.
       
   101  * <p>
       
   102  * Method {@link #split} constructs and returns a new {@link L128X1024MixRandom}
       
   103  * instance that shares no mutable state with the current instance. However, with
       
   104  * very high probability, the values collectively generated by the two objects
       
   105  * have the same statistical properties as if the same quantity of values were
       
   106  * generated by a single thread using a single {@link L128X1024MixRandom} object.
       
   107  * This is because, with high probability, distinct {@link L128X1024MixRandom} objects
       
   108  * have distinct {@code a} parameters and therefore use distinct members of the
       
   109  * algorithmic family; and even if their {@code a} parameters are the same, with
       
   110  * very high probability they will traverse different parts of their common state
       
   111  * cycle.
       
   112  * <p>
       
   113  * As with {@link java.util.SplittableRandom}, instances of
       
   114  * {@link L128X1024MixRandom} are <em>not</em> thread-safe.
       
   115  * They are designed to be split, not shared, across threads. For
       
   116  * example, a {@link java.util.concurrent.ForkJoinTask} fork/join-style
       
   117  * computation using random numbers might include a construction
       
   118  * of the form {@code new Subtask(someL128X1024MixRandom.split()).fork()}.
       
   119  * <p>
       
   120  * This class provides additional methods for generating random
       
   121  * streams, that employ the above techniques when used in
       
   122  * {@code stream.parallel()} mode.
       
   123  * <p>
       
   124  * Instances of {@link L128X1024MixRandom} are not cryptographically
       
   125  * secure.  Consider instead using {@link java.security.SecureRandom}
       
   126  * in security-sensitive applications. Additionally,
       
   127  * default-constructed instances do not use a cryptographically random
       
   128  * seed unless the {@linkplain System#getProperty system property}
       
   129  * {@code java.util.secureRandomSeed} is set to {@code true}.
       
   130  *
       
   131  * @since 14
       
   132  */
       
   133 public final class L128X1024MixRandom extends AbstractSplittableWithBrineGenerator {
       
   134 
       
   135     /*
       
   136      * Implementation Overview.
       
   137      *
       
   138      * The 128-bit parameter `a` is represented as two long fields `ah` and `al`.
       
   139      * The 128-bit state variable `s` is represented as two long fields `sh` and `sl`.
       
   140      *
       
   141      * The split operation uses the current generator to choose 20
       
   142      * new 64-bit long values that are then used to initialize the
       
   143      * parameters `ah` and `al`, the state variables `sh`, `sl`,
       
   144      * and the array `x` for a newly constructed generator.
       
   145      *
       
   146      * With extremely high probability, no two generators so chosen
       
   147      * will have the same `a` parameter, and testing has indicated
       
   148      * that the values generated by two instances of {@link L128X1024MixRandom}
       
   149      * will be (approximately) independent if have different values for `a`.
       
   150      *
       
   151      * The default (no-argument) constructor, in essence, uses
       
   152      * "defaultGen" to generate 20 new 64-bit values for the same
       
   153      * purpose.  Multiple generators created in this way will certainly
       
   154      * differ in their `a` parameters.  The defaultGen state must be accessed
       
   155      * in a thread-safe manner, so we use an AtomicLong to represent
       
   156      * this state.  To bootstrap the defaultGen, we start off using a
       
   157      * seed based on current time unless the
       
   158      * java.util.secureRandomSeed property is set. This serves as a
       
   159      * slimmed-down (and insecure) variant of SecureRandom that also
       
   160      * avoids stalls that may occur when using /dev/random.
       
   161      *
       
   162      * File organization: First static fields, then instance
       
   163      * fields, then constructors, then instance methods.
       
   164      */
       
   165 
       
   166     /* ---------------- static fields ---------------- */
       
   167 
       
   168     /*
       
   169      * The length of the array x.
       
   170      */
       
   171 
       
   172     private static final int N = 16;
       
   173 
       
   174     /**
       
   175      * The seed generator for default constructors.
       
   176      */
       
   177     private static final AtomicLong defaultGen = new AtomicLong(RandomSupport.initialSeed());
       
   178 
       
   179     /*
       
   180      * The period of this generator, which is (2**1024 - 1) * 2**128.
       
   181      */
       
   182     private static final BigInteger PERIOD =
       
   183         BigInteger.ONE.shiftLeft(N*64).subtract(BigInteger.ONE).shiftLeft(128);
       
   184 
       
   185     /*
       
   186      * Low half of multiplier used in the LCG portion of the algorithm;
       
   187      * the overall multiplier is (2**64 + ML).
       
   188      * Chosen based on research by Sebastiano Vigna and Guy Steele (2019).
       
   189      * The spectral scores for dimensions 2 through 8 for the multiplier 0x1d605bbb58c8abbfdLL
       
   190      * are [0.991889, 0.907938, 0.830964, 0.837980, 0.780378, 0.797464, 0.761493].
       
   191      */
       
   192 
       
   193     private static final long ML = 0xd605bbb58c8abbfdL;
       
   194 
       
   195     /* ---------------- instance fields ---------------- */
       
   196 
       
   197     /**
       
   198      * The parameter that is used as an additive constant for the LCG.
       
   199      * Must be odd (therefore al must be odd).
       
   200      */
       
   201     private final long ah, al;
       
   202 
       
   203     /**
       
   204      * The per-instance state: sh and sl for the LCG; the array x for the xorshift;
       
   205      * p is the rotating pointer into the array x.
       
   206      * At least one of the 16 elements of the array x must be nonzero.
       
   207      */
       
   208     private long sh, sl;
       
   209     private final long[] x;
       
   210     private int p = N - 1;
       
   211 
       
   212     /* ---------------- constructors ---------------- */
       
   213 
       
   214     /**
       
   215      * Basic constructor that initializes all fields from parameters.
       
   216      * It then adjusts the field values if necessary to ensure that
       
   217      * all constraints on the values of fields are met.
       
   218      *
       
   219      * @param ah high half of the additive parameter for the LCG
       
   220      * @param al low half of the additive parameter for the LCG
       
   221      * @param sh high half of the initial state for the LCG
       
   222      * @param sl low half of the initial state for the LCG
       
   223      * @param x0 first word of the initial state for the xorshift generator
       
   224      * @param x1 second word of the initial state for the xorshift generator
       
   225      * @param x2 third word of the initial state for the xorshift generator
       
   226      * @param x3 fourth word of the initial state for the xorshift generator
       
   227      * @param x4 fifth word of the initial state for the xorshift generator
       
   228      * @param x5 sixth word of the initial state for the xorshift generator
       
   229      * @param x6 seventh word of the initial state for the xorshift generator
       
   230      * @param x7 eight word of the initial state for the xorshift generator
       
   231      * @param x8 ninth word of the initial state for the xorshift generator
       
   232      * @param x9 tenth word of the initial state for the xorshift generator
       
   233      * @param x10 eleventh word of the initial state for the xorshift generator
       
   234      * @param x11 twelfth word of the initial state for the xorshift generator
       
   235      * @param x12 thirteenth word of the initial state for the xorshift generator
       
   236      * @param x13 fourteenth word of the initial state for the xorshift generator
       
   237      * @param x14 fifteenth word of the initial state for the xorshift generator
       
   238      * @param x15 sixteenth word of the initial state for the xorshift generator
       
   239      */
       
   240     public L128X1024MixRandom(long ah, long al, long sh, long sl,
       
   241 			      long x0, long x1, long x2, long x3,
       
   242 			      long x4, long x5, long x6, long x7,
       
   243 			      long x8, long x9, long x10, long x11,
       
   244 			      long x12, long x13, long x14, long x15) {
       
   245         // Force a to be odd.
       
   246 	this.ah = ah;
       
   247         this.al = al | 1;
       
   248         this.sh = sh;
       
   249         this.sl = sl;
       
   250         this.x = new long[N];
       
   251         this.x[0] = x0;
       
   252         this.x[1] = x1;
       
   253         this.x[2] = x2;
       
   254         this.x[3] = x3;
       
   255         this.x[4] = x4;
       
   256         this.x[5] = x5;
       
   257         this.x[6] = x6;
       
   258         this.x[7] = x7;
       
   259         this.x[8] = x8;
       
   260         this.x[9] = x9;
       
   261         this.x[10] = x10;
       
   262         this.x[11] = x11;
       
   263         this.x[12] = x12;
       
   264         this.x[13] = x13;
       
   265         this.x[14] = x14;
       
   266         this.x[15] = x15;
       
   267         // If x0, x1, ..., x15 are all zero (very unlikely), we must choose nonzero values.
       
   268         if ((x0 | x1 | x2 | x3 | x4 | x5 | x6 | x7 | x8 | x9 | x10 | x11 | x12 | x13 | x14 | x15) == 0) {
       
   269 	    long v = sh;
       
   270             // At least fifteen of the sixteen values generated here will be nonzero.
       
   271             for (int j = 0; j < N; j++) {
       
   272                 this.x[j] = RandomSupport.mixStafford13(v += RandomSupport.GOLDEN_RATIO_64);
       
   273             }
       
   274         }
       
   275     }
       
   276 
       
   277     /**
       
   278      * Creates a new instance of {@link L128X1024MixRandom} using the
       
   279      * specified {@code long} value as the initial seed. Instances of
       
   280      * {@link L128X1024MixRandom} created with the same seed in the same
       
   281      * program execution generate identical sequences of values.
       
   282      *
       
   283      * @param seed the initial seed
       
   284      */
       
   285     public L128X1024MixRandom(long seed) {
       
   286         // Using a value with irregularly spaced 1-bits to xor the seed
       
   287         // argument tends to improve "pedestrian" seeds such as 0 or
       
   288         // other small integers.  We may as well use SILVER_RATIO_64.
       
   289         //
       
   290         // The seed is hashed by mixMurmur64 to produce the `a` parameter.
       
   291         // The seed is hashed by mixStafford13 to produce the initial `x[0]`,
       
   292         // which will then be used to produce the first generated value.
       
   293         // The other x values are filled in as if by a SplitMix PRNG with
       
   294         // GOLDEN_RATIO_64 as the gamma value and mixStafford13 as the mixer.
       
   295         this(RandomSupport.mixMurmur64(seed ^= RandomSupport.SILVER_RATIO_64),
       
   296              RandomSupport.mixMurmur64(seed += RandomSupport.GOLDEN_RATIO_64),
       
   297              0,
       
   298              1,
       
   299              RandomSupport.mixStafford13(seed),
       
   300              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   301              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   302              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   303              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   304              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   305              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   306              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   307              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   308              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   309              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   310              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   311              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   312              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   313              RandomSupport.mixStafford13(seed += RandomSupport.GOLDEN_RATIO_64),
       
   314              RandomSupport.mixStafford13(seed + RandomSupport.GOLDEN_RATIO_64));
       
   315     }
       
   316 
       
   317     /**
       
   318      * Creates a new instance of {@link L128X1024MixRandom} that is likely to
       
   319      * generate sequences of values that are statistically independent
       
   320      * of those of any other instances in the current program execution,
       
   321      * but may, and typically does, vary across program invocations.
       
   322      */
       
   323     public L128X1024MixRandom() {
       
   324         // Using GOLDEN_RATIO_64 here gives us a good Weyl sequence of values.
       
   325         this(defaultGen.getAndAdd(RandomSupport.GOLDEN_RATIO_64));
       
   326     }
       
   327 
       
   328     /**
       
   329      * Creates a new instance of {@link L128X1024MixRandom} using the specified array of
       
   330      * initial seed bytes. Instances of {@link L128X1024MixRandom} created with the same
       
   331      * seed array in the same program execution generate identical sequences of values.
       
   332      *
       
   333      * @param seed the initial seed
       
   334      */
       
   335     public L128X1024MixRandom(byte[] seed) {
       
   336         // Convert the seed to 20 long values, of which the last 16 are not all zero.
       
   337         long[] data = RandomSupport.convertSeedBytesToLongs(seed, 20, 16);
       
   338 	long ah = data[0], al = data[1], sh = data[2], sl = data[3];
       
   339         // Force a to be odd.
       
   340         this.ah = ah;
       
   341         this.al = al | 1;
       
   342         this.sh = sh;
       
   343         this.sl = sl;
       
   344         this.x = new long[N];
       
   345         for (int j = 0; j < N; j++) {
       
   346             this.x[j] = data[4+j];
       
   347         }
       
   348     }
       
   349 
       
   350     /* ---------------- public methods ---------------- */
       
   351     
       
   352     /**
       
   353      * Given 63 bits of "brine", constructs and returns a new instance of
       
   354      * {@code L128X1024MixRandom} that shares no mutable state with this instance.
       
   355      * However, with very high probability, the set of values collectively
       
   356      * generated by the two objects has the same statistical properties as if
       
   357      * same the quantity of values were generated by a single thread using
       
   358      * a single {@code L128X1024MixRandom} object.  Either or both of the two
       
   359      * objects may be further split using the {@code split} method,
       
   360      * and the same expected statistical properties apply to the
       
   361      * entire set of generators constructed by such recursive splitting.
       
   362      *
       
   363      * @param source a {@code SplittableGenerator} instance to be used instead
       
   364      *               of this one as a source of pseudorandom bits used to
       
   365      *               initialize the state of the new ones.
       
   366      * @param brine a long value, of which the low 63 bits are used to choose
       
   367      *              the {@code a} parameter for the new instance.
       
   368      * @return a new instance of {@code L128X1024MixRandom}
       
   369      */
       
   370     public SplittableGenerator split(SplittableGenerator source, long brine) {
       
   371 	// Pick a new instance "at random", but use the brine for (the low half of) `a`.
       
   372         return new L128X1024MixRandom(source.nextLong(), brine << 1,
       
   373 				      source.nextLong(), source.nextLong(),
       
   374 				      source.nextLong(), source.nextLong(),
       
   375 				      source.nextLong(), source.nextLong(),
       
   376 				      source.nextLong(), source.nextLong(),
       
   377 				      source.nextLong(), source.nextLong(),
       
   378 				      source.nextLong(), source.nextLong(),
       
   379 				      source.nextLong(), source.nextLong(),
       
   380 				      source.nextLong(), source.nextLong(),
       
   381 				      source.nextLong(), source.nextLong());
       
   382     }
       
   383 
       
   384     /**
       
   385      * Returns a pseudorandom {@code long} value.
       
   386      *
       
   387      * @return a pseudorandom {@code long} value
       
   388      */
       
   389     public long nextLong() {
       
   390         // First part of xoroshiro1024: fetch array data
       
   391         final int q = p;
       
   392         final long s0 = x[p = (p + 1) & (N - 1)];
       
   393         long s15 = x[q];
       
   394 
       
   395 	// Compute the result based on current state information
       
   396 	// (this allows the computation to be overlapped with state update).
       
   397         final long result = RandomSupport.mixLea64(sh + s0);
       
   398 
       
   399 	// Update the LCG subgenerator
       
   400         // The LCG is, in effect, s = ((1LL << 64) + ML) * s + a, if only we had 128-bit arithmetic.
       
   401         final long u = ML * sl;
       
   402 	// Note that Math.multiplyHigh computes the high half of the product of signed values,
       
   403 	// but what we need is the high half of the product of unsigned values; for this we use the
       
   404 	// formula "unsignedMultiplyHigh(a, b) = multiplyHigh(a, b) + ((a >> 63) & b) + ((b >> 63) & a)";
       
   405 	// in effect, each operand is added to the result iff the sign bit of the other operand is 1.
       
   406 	// (See Henry S. Warren, Jr., _Hacker's Delight_ (Second Edition), Addison-Wesley (2013),
       
   407 	// Section 8-3, p. 175; or see the First Edition, Addison-Wesley (2003), Section 8-3, p. 133.)
       
   408 	// If Math.unsignedMultiplyHigh(long, long) is ever implemented, the following line can become:
       
   409 	//         sh = (ML * sh) + Math.unsignedMultiplyHigh(ML, sl) + sl + ah;
       
   410 	// and this entire comment can be deleted.
       
   411         sh = (ML * sh) + (Math.multiplyHigh(ML, sl) + ((ML >> 63) & sl) + ((sl >> 63) & ML)) + sl + ah;
       
   412         sl = u + al;
       
   413         if (Long.compareUnsigned(sl, u) < 0) ++sh;  // Handle the carry propagation from low half to high half.
       
   414 
       
   415         // Second part of xoroshiro1024: update array data
       
   416         s15 ^= s0;
       
   417         x[q] = Long.rotateLeft(s0, 25) ^ s15 ^ (s15 << 27);
       
   418         x[p] = Long.rotateLeft(s15, 36);
       
   419 
       
   420         return result;
       
   421     }
       
   422 
       
   423     /**
       
   424      * Returns the period of this random generator.
       
   425      *
       
   426      * @return a {@link BigInteger} whose value is the number of distinct possible states of this
       
   427      *         {@link RandomGenerator} object (2<sup>128</sup>(2<sup>1024</sup>-1)).
       
   428      */
       
   429     public BigInteger period() {
       
   430         return PERIOD;
       
   431     }
       
   432 }