Package org.apache.commons.rng.core.source64

Class XoRoShiRo128PlusPlus

java.lang.Object

org.apache.commons.rng.core.BaseProvider

org.apache.commons.rng.core.source64.LongProvider

org.apache.commons.rng.core.source64.XoRoShiRo128PlusPlus

All Implemented Interfaces:

RandomLongSource, JumpableUniformRandomProvider, LongJumpableUniformRandomProvider, RestorableUniformRandomProvider, UniformRandomProvider

public class XoRoShiRo128PlusPlus
extends LongProvider

A fast all-purpose 64-bit generator.

This is a member of the Xor-Shift-Rotate family of generators. Memory footprint is 128 bits and the period is 2¹²⁸-1. Speed is expected to be similar to XoShiRo256StarStar.

Since:

1.3

See Also:

Original source code, xorshiro / xoroshiro generators

Field Summary

Fields

Modifier and Type	Field	Description
protected long	state0	State 0 of the generator.
protected long	state1	State 1 of the generator.

Constructor Summary

Constructors

Modifier	Constructor	Description
	XoRoShiRo128PlusPlus(long[] seed)	Creates a new instance.
	XoRoShiRo128PlusPlus(long seed0, long seed1)	Creates a new instance using a 2 element seed.
protected	XoRoShiRo128PlusPlus(XoRoShiRo128PlusPlus source)	Creates a copy instance.

Method Summary

Modifier and Type	Method	Description
protected XoRoShiRo128PlusPlus	copy()	Create a copy.
protected byte[]	getStateInternal()	Creates a snapshot of the RNG state.
UniformRandomProvider	jump()	Creates a copy of the UniformRandomProvider and then advances the state of the current instance.
JumpableUniformRandomProvider	longJump()	Creates a copy of the JumpableUniformRandomProvider and then advances the state of the current instance.
long	next()	Return the next random value.
protected long	nextOutput()	Use the current state to compute the next output from the generator.
protected void	setStateInternal(byte[] s)	Resets the RNG to the given state.

Methods inherited from class org.apache.commons.rng.core.source64.LongProvider

nextBoolean, nextInt, nextLong, resetCachedState

Methods inherited from class org.apache.commons.rng.core.BaseProvider

checkIndex, checkStateSize, composeStateInternal, extendSeed, extendSeed, fillState, fillState, restoreState, saveState, splitStateInternal, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.rng.JumpableUniformRandomProvider

jumps, jumps

Methods inherited from interface org.apache.commons.rng.LongJumpableUniformRandomProvider

longJumps, longJumps

Methods inherited from interface org.apache.commons.rng.UniformRandomProvider

doubles, doubles, doubles, doubles, ints, ints, ints, ints, longs, longs, longs, longs, nextBoolean, nextBytes, nextBytes, nextDouble, nextDouble, nextDouble, nextFloat, nextFloat, nextFloat, nextInt, nextInt, nextInt, nextLong, nextLong, nextLong

Field Detail

state0

protected long state0

State 0 of the generator.

state1

protected long state1

State 1 of the generator.

Constructor Detail

XoRoShiRo128PlusPlus

public XoRoShiRo128PlusPlus(long[] 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.

XoRoShiRo128PlusPlus

public XoRoShiRo128PlusPlus(long seed0,
                            long 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.

XoRoShiRo128PlusPlus

protected XoRoShiRo128PlusPlus(XoRoShiRo128PlusPlus source)

Creates a copy instance.

Parameters:

source - Source to copy.

Method Detail

next

public long next()

Return the next random value.

Specified by:

next in interface RandomLongSource

Returns:

the next random value.

nextOutput

protected long 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 RandomLongSource.next() before the current state is updated.

Returns:

the next output

jump

public UniformRandomProvider jump()

Creates a copy of the UniformRandomProvider and then advances the state of the current instance. The copy is returned.

The current state will be advanced in a single operation by the equivalent of a number of sequential calls to a method that updates the state of the provider. The size of the jump is implementation dependent.

Repeat invocations of this method will create a series of generators that are uniformly spaced at intervals of the output sequence. Each generator provides non-overlapping output for the length of the jump for use in parallel computations.

The jump size is the equivalent of 2⁶⁴ calls to nextLong(). It can provide up to 2⁶⁴ non-overlapping subsequences.

Specified by:

jump in interface JumpableUniformRandomProvider

Returns:

A copy of the current state.

longJump

public JumpableUniformRandomProvider longJump()

Creates a copy of the JumpableUniformRandomProvider and then advances the state of the current instance. The copy is returned.

The current state will be advanced in a single operation by the equivalent of a number of sequential calls to a method that updates the state of the provider. The size of the long jump is implementation dependent.

Repeat invocations of this method will create a series of generators that are uniformly spaced at intervals of the output sequence. Each generator provides non-overlapping output for the length of the long jump for use in parallel computations.

The returned copy may be jumped m / n times before overlap with the current instance where m is the long jump length and n is the jump length of the JumpableUniformRandomProvider.jump() method.

The jump size is the equivalent of 2⁹⁶ calls to nextLong(). It can provide up to 2³² non-overlapping subsequences of length 2⁹⁶; each subsequence can provide up to 2³² non-overlapping subsequences of length 2⁶⁴ using the JumpableUniformRandomProvider.jump() method.

Specified by:

longJump in interface LongJumpableUniformRandomProvider

Returns:

A copy of the current state.

copy

protected XoRoShiRo128PlusPlus copy()

Create a copy.

Returns:

the copy

getStateInternal

protected byte[] getStateInternal()

Creates a snapshot of the RNG state.

Overrides:

getStateInternal in class LongProvider

Returns:

the internal state.

setStateInternal

protected void setStateInternal(byte[] s)

Resets the RNG to the given state.

Overrides:

setStateInternal in class LongProvider

Parameters:

s - State (previously obtained by a call to BaseProvider.getStateInternal()).

See Also:

BaseProvider.checkStateSize(byte[],int)