Package com.github.tommyettinger.random

Class OrbitalRandom

java.lang.Object
java.util.Random
com.github.tommyettinger.random.EnhancedRandom
com.github.tommyettinger.random.OrbitalRandom
All Implemented Interfaces:
Externalizable, Serializable, RandomGenerator
public class OrbitalRandom extends EnhancedRandom
A hash-on-counters RNG with a period of 2 to the 128. This is closely related to FlowRandom, but gives up the arbitrary EnhancedRandom.skip(long) feature and the various stream manipulation methods to have a much longer period and become 1-dimensionally equidistributed.
Uses the Moremur unary hash (the same one as DistinctRandom and FlowRandom), passing it a combination of the two different additive counters this has for its state. One counter is rotated before XORing with the other, which replaces a xorshift in the original. The first counter only adds the same large odd number at each step, but the second counter adds both a different large odd number and the result of BitConversion.countLeadingZeros(long) on the first state. This way of mixing the states means while the first counter on its own has a period of 2 to the 64, the second counter is very slightly offset from being in-sync with the first, and since it depends upon the first counter, its period is 2 to the 128.
This passes 64TB of PractRand without anomalies. In most regards, it should have similar statistical qualities to FlowRandom, except that it is guaranteed to produce each possible long value exactly (2 to the 64) times. Unlike DistinctRandom, it is not possible to figure out the current state given one output, and it would take an unknown amount of additional outputs to retrieve the current state exactly. It shares this quality with FlowRandom.
You would probably want to use this generator when you want a known, large period and to be reliably random from the first output regardless of the initial state. Using a Xoshiro256StarStarRandom gets the first (with a period of 2 to the 256, minus 1), but not the second. Using a Xoshiro256MX3Random gets you most of both (and a period of 2 to the 256, minus 1), but it can't be seeded with all 0 states, which could be a burden, and it's slower than this. Both of those generators offer 4-dimensional equidistribution, whereas this only offers 1-dimensional, and that might be a deciding factor.
See Also:

  • Field Details

    • stateA

      protected long stateA
      The first state; can be any long.

    • stateB

      protected long stateB
      The second state; can be any long.

  • Constructor Details

    • OrbitalRandom

      public OrbitalRandom()
      Creates a new OrbitalRandom with a random state.

    • OrbitalRandom

      public OrbitalRandom(long seed)
      Creates a new OrbitalRandom with the given seed; all long values are permitted. The seed will be passed to setSeed(long) to attempt to adequately distribute the seed randomly.
      Parameters:
      seed - any long value

    • OrbitalRandom

      public OrbitalRandom(long stateA, long stateB)
      Creates a new OrbitalRandom with the given two states; all long values are permitted for stateA and for stateB. These states are not changed during assignment.
      Parameters:
      stateA - any long value
      stateB - any long value

  • Method Details

    • getTag

      public String getTag()
      Description copied from class: EnhancedRandom
      Gets the tag used to identify this type of EnhancedRandom, as a String. This tag should be unique, and for uniformity purposes, all tags used in this library are 4 characters long. User-defined tags should have a different length.
      Specified by:
      getTag in class EnhancedRandom
      Returns:
      a unique String identifier for this type of EnhancedRandom; usually 4 chars long.

    • getStateCount

      public int getStateCount()
      This generator has 2 long states, so this returns 2.
      Overrides:
      getStateCount in class EnhancedRandom
      Returns:
      2 (two)

    • getSelectedState

      public long getSelectedState(int selection)
      Gets the state determined by selection, as-is. Selections 0 (or any even number) and 1 (or any odd number) refer to states A and B.
      Overrides:
      getSelectedState in class EnhancedRandom
      Parameters:
      selection - used to select which state variable to get; generally 0 or 1
      Returns:
      the value of the selected state

    • setSelectedState

      public void setSelectedState(int selection, long value)
      Sets one of the states, determined by selection, to value, as-is. Selections 0 (or any even number) and 1 (or any odd number) refer to states A and B.
      Overrides:
      setSelectedState in class EnhancedRandom
      Parameters:
      selection - used to select which state variable to set; generally 0 or 1
      value - the exact value to use for the selected state, if valid

    • setSeed

      public void setSeed(long seed)
      This initializes both states of the generator to different values; one is seed, the other is ~seed. (2 to the 64) possible initial generator states can be produced here. The initial states don't need to be randomized at all because of the structure of this generator (the hashing stage it does last is meant to make input patterns unrecognizable).
      Specified by:
      setSeed in class EnhancedRandom
      Parameters:
      seed - the initial seed; may be any long

    • getStateA

      public long getStateA()

    • setStateA

      public void setStateA(long stateA)
      Sets the first part of the state.
      Parameters:
      stateA - can be any long

    • getStateB

      public long getStateB()

    • setStateB

      public void setStateB(long stateB)
      Sets the second part of the state.
      Parameters:
      stateB - can be any long

    • setState

      public void setState(long stateA, long stateB)
      Sets the state completely to the given two state variables. This is the same as calling setStateA(long) and setStateB(long) as a group.
      Overrides:
      setState in class EnhancedRandom
      Parameters:
      stateA - the first state; can be any long
      stateB - the second state; can be any long

    • nextLong

      public long nextLong()
      Description copied from class: EnhancedRandom
      Returns the next pseudorandom, uniformly distributed long value from this random number generator's sequence. The general contract of nextLong is that one long value is pseudorandomly generated and returned.
      The only methods that need to be implemented by this interface are this and EnhancedRandom.copy(), though other methods can be implemented as appropriate for generators that, for instance, natively produce ints rather than longs.
      Specified by:
      nextLong in interface RandomGenerator
      Specified by:
      nextLong in class EnhancedRandom
      Returns:
      the next pseudorandom, uniformly distributed long value from this random number generator's sequence

    • previousLong

      public long previousLong()
      Description copied from class: EnhancedRandom
      Optional; moves the state to its previous value and returns the previous long that would have been produced by EnhancedRandom.nextLong(). This can be equivalent to calling EnhancedRandom.skip(long) with -1L, but not always; many generators can't efficiently skip long distances, but can step back by one value.
      Generators that natively generate int results typically produce long values by generating an int for the high 32 bits and an int for the low 32 bits. When producing the previous long, the order the high and low bits are generated, such as by EnhancedRandom.previousInt(), should be reversed. Generators that natively produce long values usually don't need to implement EnhancedRandom.previousInt(), but those that produce int usually should implement it, and may optionally call previousInt() twice in this method.
      If you know how to implement the reverse of a particular random number generator, it is recommended you do so here, rather than rely on skip(). This isn't always easy, but should always be possible for any decent PRNG (some historical PRNGs, such as the Middle-Square PRNG, cannot be reversed at all). If a generator cannot be reversed because multiple initial states can transition to the same subsequent state, it is known to have statistical problems that are not necessarily present in a generator that matches one initial state to one subsequent state.
      The public implementation calls EnhancedRandom.skip(long) with -1L, and if skip() has not been implemented differently, then it will throw an UnsupportedOperationException.
      Overrides:
      previousLong in class EnhancedRandom
      Returns:
      the previous number this would have produced with EnhancedRandom.nextLong()

    • next

      public int next(int bits)
      Description copied from class: EnhancedRandom
      Generates the next pseudorandom number with a specific maximum size in bits (not a max number). If you want to get a random number in a range, you should usually use EnhancedRandom.nextInt(int) instead. For some specific cases, this method is more efficient and less biased than EnhancedRandom.nextInt(int). For bits values between 1 and 30, this should be similar in effect to nextInt(1 << bits); though it won't typically produce the same values, they will have the correct range. If bits is 31, this can return any non-negative int; note that nextInt(1 << 31) won't behave this way because 1 << 31 is negative. If bits is 32 (or 0), this can return any int.

      The general contract of next is that it returns an int value and if the argument bits is between 1 and 32 (inclusive), then that many low-order bits of the returned value will be (approximately) independently chosen bit values, each of which is (approximately) equally likely to be 0 or 1.

      Note that you can give this values for bits that are outside its expected range of 1 to 32, but the value used, as long as bits is positive, will effectively be bits % 32. As stated before, a value of 0 for bits is the same as a value of 32.

      Overrides:
      next in class EnhancedRandom
      Parameters:
      bits - the amount of random bits to request, from 1 to 32
      Returns:
      the next pseudorandom value from this random number generator's sequence

    • copy

      public OrbitalRandom copy()
      Description copied from class: EnhancedRandom
      Creates a new EnhancedRandom with identical states to this one, so if the same EnhancedRandom methods are called on this object and its copy (in the same order), the same outputs will be produced. This is not guaranteed to copy the inherited state of any parent class, so if you call methods that are only implemented by a superclass (like Random) and not this one, the results may differ.
      Specified by:
      copy in class EnhancedRandom
      Returns:
      a deep copy of this EnhancedRandom.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object