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

Class XoRoShiRo64StarStar

java.lang.Object

org.apache.commons.rng.core.BaseProvider

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

org.apache.commons.rng.core.source32.XoRoShiRo64StarStar

All Implemented Interfaces:

RandomIntSource, RestorableUniformRandomProvider, UniformRandomProvider

public class XoRoShiRo64StarStar
extends IntProvider

A fast all-purpose 32-bit generator. For faster generation of float values try the XoRoShiRo64Star generator.

This is a member of the Xor-Shift-Rotate family of generators. Memory footprint is 64 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.

Constructor Summary

Constructors

Constructor	Description
XoRoShiRo64StarStar(int[] seed)	Creates a new instance.
XoRoShiRo64StarStar(int seed0, int seed1)	Creates a new instance using a 2 element seed.

Method Summary

Modifier and Type	Method	Description
protected byte[]	getStateInternal()	Creates a snapshot of the RNG state.
int	next()
protected int	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.source32.IntProvider

nextBoolean, nextBytes, nextBytes, nextDouble, 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.UniformRandomProvider

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

Field Detail

state0

protected int state0

State 0 of the generator.

state1

protected int state1

State 1 of the generator.

Constructor Detail

XoRoShiRo64StarStar

public XoRoShiRo64StarStar(int[] 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.

XoRoShiRo64StarStar

public XoRoShiRo64StarStar(int seed0,
                           int 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.

Method Detail

nextOutput

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

Returns:

the next output

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)

next

public int next()

Returns:

the next random value.