Package org.apache.commons.rng.core.source32

Class XoShiRo128Plus

java.lang.Object

org.apache.commons.rng.core.BaseProvider

org.apache.commons.rng.core.source32.IntProvider

org.apache.commons.rng.core.source32.XoShiRo128Plus

All Implemented Interfaces:

RandomIntSource, RestorableUniformRandomProvider, UniformRandomProvider

public class XoShiRo128Plus
extends IntProvider

A fast 32-bit generator suitable for float generation. This is slightly faster than the all-purpose generator XoShiRo128StarStar.

This is a member of the Xor-Shift-Rotate family of generators. Memory footprint is 128 bits.

Since:

1.3

See Also:

Original source code, xorshiro / xoroshiro generators

Field Summary

Fields

Modifier and Type	Field	Description
protected int	state0	State 0 of the generator.
protected int	state1	State 1 of the generator.
protected int	state2	State 2 of the generator.
protected int	state3	State 3 of the generator.

Constructor Summary

Constructors

Constructor	Description
XoShiRo128Plus(int[] seed)	Creates a new instance.
XoShiRo128Plus(int seed0, int seed1, int seed2, int seed3)	Creates a new instance using a 4 element seed.

Method Summary

Modifier and Type	Method	Description
protected byte[]	getStateInternal()	Creates a snapshot of the RNG state.
int	next()
protected void	setStateInternal(byte[] s)	Resets the RNG to the given state.

Methods inherited from class org.apache.commons.rng.core.source32.IntProvider

nextBoolean, nextBytes, nextBytes, nextDouble, nextFloat, nextInt, nextLong

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

checkIndex, checkStateSize, composeStateInternal, fillState, fillState, nextInt, nextLong, restoreState, saveState, splitStateInternal, toString

Methods inherited from class java.lang.Object

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

Field Details

state0

protected int state0

State 0 of the generator.

state1

protected int state1

State 1 of the generator.

state2

protected int state2

State 2 of the generator.

state3

protected int state3

State 3 of the generator.

Constructor Details

XoShiRo128Plus

public XoShiRo128Plus(int[] seed)

Creates a new instance.

Parameters:

seed - Initial seed. If the length is larger than 4, only the first 4 elements will be used; if smaller, the remaining elements will be automatically set. A seed containing all zeros will create a non-functional generator.

XoShiRo128Plus

public XoShiRo128Plus(int seed0, int seed1, int seed2, int seed3)

Creates a new instance using a 4 element seed. A seed containing all zeros will create a non-functional generator.

Parameters:

seed0 - Initial seed element 0.

seed1 - Initial seed element 1.

seed2 - Initial seed element 2.

seed3 - Initial seed element 3.

Method Details

next

public int next()

Returns:

the next random value.

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:

BaseProvider.checkStateSize(byte[],int)