Class AbstractXoRoShiRo64

All Implemented Interfaces:
RandomIntSource, RestorableUniformRandomProvider, UniformRandomProvider
Direct Known Subclasses:
XoRoShiRo64Star, XoRoShiRo64StarStar

abstract class AbstractXoRoShiRo64 extends IntProvider
This abstract class is a base for algorithms from the Xor-Shift-Rotate family of 32-bit generators with 64-bits of state.
Since:
1.3
See Also:
  • Field Details

    • SEED_SIZE

      private static final int SEED_SIZE
      Size of the state vector.
      See Also:
    • state0

      protected int state0
      State 0 of the generator.
    • state1

      protected int state1
      State 1 of the generator.
  • Constructor Details

    • AbstractXoRoShiRo64

      AbstractXoRoShiRo64(int[] seed)
      Creates a new instance.
      Parameters:
      seed - Initial seed. If the length is larger than 2, only the first 2 elements will be used; if smaller, the remaining elements will be automatically set. A seed containing all zeros will create a non-functional generator.
    • AbstractXoRoShiRo64

      AbstractXoRoShiRo64(int seed0, int seed1)
      Creates a new instance using a 2 element seed. A seed containing all zeros will create a non-functional generator.
      Parameters:
      seed0 - Initial seed element 0.
      seed1 - Initial seed element 1.
  • Method Details

    • setState

      private void setState(int[] state)
      Copies the state from the array into the generator state.
      Parameters:
      state - the new state
    • getStateInternal

      protected byte[] getStateInternal()
      Creates a snapshot of the RNG state.
      Overrides:
      getStateInternal in class IntProvider
      Returns:
      the internal state.
    • setStateInternal

      protected void setStateInternal(byte[] s)
      Resets the RNG to the given state.
      Overrides:
      setStateInternal in class IntProvider
      Parameters:
      s - State (previously obtained by a call to BaseProvider.getStateInternal()).
      See Also:
    • next

      public int next()
      Returns:
      the next random value.
    • nextOutput

      protected abstract int nextOutput()
      Use the current state to compute the next output from the generator. The output function shall vary with respect to different generators. This method is called from next() before the current state is updated.
      Returns:
      the next output