Class XoShiRo128PlusPlus
- java.lang.Object
-
- org.apache.commons.rng.core.BaseProvider
-
- org.apache.commons.rng.core.source32.IntProvider
-
- org.apache.commons.rng.core.source32.XoShiRo128PlusPlus
-
- All Implemented Interfaces:
RandomIntSource
,JumpableUniformRandomProvider
,LongJumpableUniformRandomProvider
,RestorableUniformRandomProvider
,UniformRandomProvider
public class XoShiRo128PlusPlus extends IntProvider
A fast all-purpose 32-bit generator. For faster generation offloat
values try theXoShiRo128Plus
generator.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
-
-
Constructor Summary
Constructors Modifier Constructor Description XoShiRo128PlusPlus(int[] seed)
Creates a new instance.XoShiRo128PlusPlus(int seed0, int seed1, int seed2, int seed3)
Creates a new instance using a 4 element seed.protected
XoShiRo128PlusPlus(XoShiRo128PlusPlus source)
Creates a copy instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected XoShiRo128PlusPlus
copy()
Create a copy.protected byte[]
getStateInternal()
Creates a snapshot of the RNG state.UniformRandomProvider
jump()
JumpableUniformRandomProvider
longJump()
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 givenstate
.-
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.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
-
-
-
-
Constructor Detail
-
XoShiRo128PlusPlus
public XoShiRo128PlusPlus(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.
-
XoShiRo128PlusPlus
public XoShiRo128PlusPlus(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.
-
XoShiRo128PlusPlus
protected XoShiRo128PlusPlus(XoShiRo128PlusPlus source)
Creates a copy instance.- Parameters:
source
- Source to copy.
-
-
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 fromRandomIntSource.next()
before the current state is updated.- Returns:
- the next output
-
copy
protected XoShiRo128PlusPlus copy()
Create a copy.- Returns:
- the copy
-
getStateInternal
protected byte[] getStateInternal()
Creates a snapshot of the RNG state.- Overrides:
getStateInternal
in classIntProvider
- Returns:
- the internal state.
-
setStateInternal
protected void setStateInternal(byte[] s)
Resets the RNG to the givenstate
.- Overrides:
setStateInternal
in classIntProvider
- Parameters:
s
- State (previously obtained by a call toBaseProvider.getStateInternal()
).- See Also:
BaseProvider.checkStateSize(byte[],int)
-
next
public int next()
- Specified by:
next
in interfaceRandomIntSource
- Returns:
- the next random value.
-
jump
public UniformRandomProvider jump()
The jump size is the equivalent of 264 calls to
nextInt()
. It can provide up to 264 non-overlapping subsequences.- Specified by:
jump
in interfaceJumpableUniformRandomProvider
-
longJump
public JumpableUniformRandomProvider longJump()
The jump size is the equivalent of 296 calls to
nextLong()
. It can provide up to 232 non-overlapping subsequences of length 296; each subsequence can provide up to 232 non-overlapping subsequences of length 264 using theJumpableUniformRandomProvider.jump()
method.- Specified by:
longJump
in interfaceLongJumpableUniformRandomProvider
-
-