Package com.github.kilianB.pcg.sync

Class PcgRS

  • All Implemented Interfaces:
    Pcg, java.io.Serializable
    public class PcgRS
extends RandomBaseSynchonized
    A 64 bit State PcgRNG with 32 bit output. PCG-XSH-RR

    The pcg family combines a linear congruential generators with a permutation output function resulting in high quality pseudo random numbers.

    The original concept was introduced by Melissa O’Neill please refer to pcg-random for more information.

    Opposed to RR this version performs a random shift rather than a random rotation. The RS instance permutates the output using the following function: 

     
 ((state >>> 22) ^ state) >>> ((state >>> 61) + 22)
    This implementation is thread safe utilizing method level synchronization.
    Author:
    Kilian
    See Also:
    www.pcg-random.org, PcgRR, Serialized Form

    • Constructor Detail

      • PcgRS

        public PcgRS()
        Create a synchronized PcgRS instance seeded with with 2 longs generated by xorshift*. The values chosen are very likely not used as seeds in any other non argument constructor of any of the classes provided in this library.

      • PcgRS

        public PcgRS​(long seed,
             long streamNumber)
        Create a random number generator with the given seed and stream number. The seed defines the current state in which the rng is in and corresponds to seeds usually found in other RNG implementations. RNGs with different seeds are able to catch up after they exhaust their period and produce the same numbers.

        Different stream numbers alter the increment of the rng and ensure distinct state sequences

        Only generators with the same seed AND stream numbers will produce identical values

        Parameters:
        seed - used to compute the starting state of the RNG
        streamNumber - used to compute the increment for the lcg.

      • PcgRS

        @Deprecated
public PcgRS​(long seed,
             long streamNumber,
             boolean dummy)
        Deprecated.
        Copy constructor. Has to be implemented in all inheriting instances. This will be invoked through reflection! when calling RandomBaseSynchonized.split() or RandomBaseSynchonized.splitDistinct() If no special behavior is desired simply pass though the values. This constructor should usually not be called manually as the seed and increment will just be set without performing any randomization.
        Parameters:
        seed - of the lcg. The value will be set and not altered.
        streamNumber - used in the lcg as increment constant. has to be odd
        dummy - unused. Resolve signature disambiguate

    • Method Detail

      • getInt

        protected int getInt​(long state)
        Description copied from class: RandomBase64
        Construct a 32bit int from the given 64bit state using a permutation function. The produced int will be used to construct all other datatypes returned by this RNG.
        Specified by:
        getInt in class RandomBase64
        Parameters:
        state - random int as produced by the internal lcg
        Returns:
        a random int with randomly set bits