Documentation API of the 'umontreal.iro.lecuyer.rng.RandomStream' Java class

Interface RandomStream

  • All Known Subinterfaces:
    CloneableRandomStream, PointSetIterator
    All Known Implementing Classes:
    AntitheticStream, BakerTransformedStream, CycleBasedPointSet.CycleBasedPointSetIterator, CycleBasedPointSetBase2.CycleBasedPointSetBase2Iterator, F2NL607, GenF2w32, LFSR113, LFSR258, MRG31k3p, MRG32k3a, MRG32k3aL, MT19937, RandMrg, RandomStreamBase, RandomStreamWithCache, RandRijndael, TruncatedRandomStream, WELL1024, WELL512, WELL607

    public interface RandomStream
    This interface defines the basic structures to handle multiple streams of uniform (pseudo)random numbers and convenient tools to move around within and across these streams. The actual random number generators (RNGs) are provided in classes that implement this RandomStream interface. Each stream of random numbers is an object of the class that implements this interface, and can be viewed as a virtual random number generator.

    For each type of base RNG (i.e., each implementation of the RandomStream interface), the full period of the generator is cut into adjacent streams (or segments) of length Z, and each of these streams is partitioned into V substreams of length W, where Z = VW. The values of V and W depend on the specific RNG, but are usually larger than 250. Thus, the distance Z between the starting points of two successive streams provided by an RNG usually exceeds 2100. The initial seed of the RNG is the starting point of the first stream. It has a default value for each type of RNG, but this initial value can be changed by calling setPackageSeed for the corresponding class. Each time a new RandomStream is created, its starting point (initial seed) is computed automatically, Z steps ahead of the starting point of the previously created stream of the same type, and its current state is set equal to this starting point.

    For each stream, one can advance by one step and generate one value, or go ahead to the beginning of the next substream within this stream, or go back to the beginning of the current substream, or to the beginning of the stream, or jump ahead or back by an arbitrary number of steps. Denote by Cg the current state of a stream g, Ig its initial state, Bg the state at the beginning of the current substream, and Ng the state at the beginning of the next substream. The form of the state of a stream depends on its type. For example, the state of a stream of class MRG32k3a is a vector of six 32-bit integers represented internally as floating-point numbers (in double).

    The methods for manipulating the streams and generating random numbers are implemented differently for each type of RNG. The methods whose formal parameter types do not depend on the RNG type are specified in the interface RandomStream. The others (e.g., for setting the seeds) are given only in the classes that implement the specific RNG types.

    Methods for generating random variates from non-uniform distributions are provided in the randvar package.

Warning: You cannot see the full API documentation of this class since the access to the DatMelt documentation for third-party Java classes is denied. Guests can only view jhplot Java API. To view the complete description of this class and its methods, please request the full DataMelt membership.

If you are already a full member, please login to the DataMelt member area before visiting this documentation.