# Xorshift1024*φ¶

class randomgen.xorshift1024.Xorshift1024(seed=None, *, mode=None)

Container for the xorshift1024*φ pseudo-random number generator.

Parameters:
seed{None, int, array_like[uint64], SeedSequence}, optional

Entropy initializing the pseudo-random number generator. Can be an integer in [0, 2**64), array of integers in [0, 2**64), a SeedSequence instance or None (the default). If seed is None, then data is read from /dev/urandom (or the Windows analog) if available. If unavailable, a hash of the time and process ID is used.

mode{None, “sequence”, “legacy”}

The seeding mode to use. “legacy” uses the legacy SplitMix64-based initialization. “sequence” uses a SeedSequence to transforms the seed into an initial state. None defaults to “sequence”.

Notes

xorshift1024*φ is a 64-bit implementation of Saito and Matsumoto’s XSadd generator [1] (see also [2], [3], [4]). xorshift1024*φ has a period of $$2^{1024} - 1$$ and supports jumping the sequence in increments of $$2^{512}$$, which allows multiple non-overlapping sequences to be generated.

Xorshift1024 provides a capsule containing function pointers that produce doubles, and unsigned 32 and 64- bit integers. These are not directly consumable in Python and must be consumed by a Generator or similar object that supports low-level access.

See Xoroshiro128 for a faster bit generator that has a smaller period.

State and Seeding

The Xoroshiro128 state vector consists of a 16-element array of 64-bit unsigned integers.

Xoroshiro1024 is seeded using either a single 64-bit unsigned integer or a vector of 64-bit unsigned integers. In either case, the seed is used as an input for another simple random number generator, SplitMix64, and the output of this PRNG function is used as the initial state. Using a single 64-bit value for the seed can only initialize a small range of the possible initial state values.

Parallel Features

Xoroshiro1024 can be used in parallel applications by calling the method jump which advances the state as-if $$2^{512}$$ random numbers have been generated. This allows the original sequence to be split so that distinct segments can be used in each worker process. All generators should be initialized with the same seed to ensure that the segments come from the same sequence.

>>> from numpy.random import Generator
>>> from randomgen import Xorshift1024
>>> rg = [Generator(Xorshift1024(1234)) for _ in range(10)]
# Advance each Xorshift1024 instance by i jumps
>>> for i in range(10):
...     rg[i].bit_generator.jump(i)


Compatibility Guarantee

Xorshift1024 makes a guarantee that a fixed seed will always produce the same random integer stream.

References

[1]

“xorshift*/xorshift+ generators and the PRNG shootout”, https://prng.di.unimi.it/

[2]

Marsaglia, George. “Xorshift RNGs.” Journal of Statistical Software [Online], 8.14, pp. 1 - 6, 2003.

[3]

Sebastiano Vigna. “An experimental exploration of Marsaglia’s xorshift generators, scrambled.” CoRR, abs/1402.6246, 2014.

[4]

Sebastiano Vigna. “Further scramblings of Marsaglia’s xorshift generators.” CoRR, abs/1403.0930, 2014.

Examples

>>> from numpy.random import Generator
>>> from randomgen import Xorshift1024
>>> rg = Generator(Xorshift1024(1234))
>>> rg.standard_normal()
0.123  # random

Attributes:

Lock instance that is shared so that the same bit git generator can be used in multiple Generators without corrupting the state. Code that generates values from a bit generator should hold the bit generator’s lock.

seed_seq{None, SeedSequence}

The SeedSequence instance used to initialize the generator if mode is “sequence” or is seed is a SeedSequence. None if mode is “legacy”.

## Seeding and State¶

 seed([seed]) Seed the generator state Get or set the PRNG state

## Parallel generation¶

 jump([iter]) Jumps the state as-if 2**512 random numbers have been generated jumped([iter]) Returns a new bit generator with the state jumped

## Extending¶

 cffi CFFI interface ctypes ctypes interface

## Testing¶

 random_raw([size, output]) Return randoms as generated by the underlying BitGenerator