1. class
  2. Random
  3. \
  4. Engine
  5. \
  6. PcgOneseq128XslRr64

PcgOneseq128XslRr64

Since: 8.2

final class PcgOneseq128XslRr64 implements Engine (View source)

Implements a Permuted congruential generator (PCG) with 128 bits of state, XSL and RR output transformations, and 64 bits of output.

Methods

__construct(string|int|null $seed = null)

Constructs a new PCG Oneseq 128 XSL RR 64 engine

string
generate()

Generate 64 bits of randomness

void
jump(int $advance)

Efficiently move the engine ahead multiple steps

array
__serialize()

Serializes the PcgOneseq128XslRr64 object

void
__unserialize(array $data)

Deserializes the data parameter into a PcgOneseq128XslRr64 object

array
__debugInfo()

Returns the internal state of the engine

Details

at line 191
__construct(string|int|null $seed = null)

Constructs a new PCG Oneseq 128 XSL RR 64 engine

Parameters

string|int|null $seed

How the internal 128 bit (16 byte) state consisting of one unsigned 128 bit integer is seeded depends on the type used as the seed. Type Description null Fills the state with 16 random bytes generated using the CSPRNG. int Fills the state by setting the state to 0, advancing the engine one step, adding the value of seed interpreted as an unsigned 64 bit integer, and advancing the engine another step. string Fills the state by interpreting a 16 byte string as a little-endian unsigned 128 bit integer.

Exceptions

ValueError

at line 198
string generate()

Generate 64 bits of randomness

Return Value

string

A non-empty string containing random bytes. The Random\Randomizer works with unsigned 64 bit integers internally. If the returned string contains more than 64 bit (8 byte) of randomness the exceeding bytes will be ignored. Other applications may be able to process more than 64 bit at once.

at line 211
void jump(int $advance)

Efficiently move the engine ahead multiple steps

Moves the algorithm’s state ahead by the number of steps given by advance, as if Random\Engine\PcgOneseq128XslRr64::generate was called that many times.

Parameters

int $advance

The number of steps to move ahead; must be 0 or greater.

Return Value

void

No value is returned.

Exceptions

ValueError

at line 218
array __serialize()

Serializes the PcgOneseq128XslRr64 object

Return Value

array

at line 226
void __unserialize(array $data)

Deserializes the data parameter into a PcgOneseq128XslRr64 object

Parameters

array $data

Return Value

void

No value is returned.

at line 233
array __debugInfo()

Returns the internal state of the engine

Return Value

array