Class AbstractXoRoShiRo64
java.lang.Object
org.apache.commons.rng.core.BaseProvider
org.apache.commons.rng.core.source32.IntProvider
org.apache.commons.rng.core.source32.AbstractXoRoShiRo64
- All Implemented Interfaces:
RandomIntSource
,RestorableUniformRandomProvider
,UniformRandomProvider
- Direct Known Subclasses:
XoRoShiRo64Star
,XoRoShiRo64StarStar
This abstract class is a base for algorithms from the Xor-Shift-Rotate family of 32-bit
generators with 64-bits of state.
- Since:
- 1.3
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionAbstractXoRoShiRo64
(int[] seed) Creates a new instance.AbstractXoRoShiRo64
(int seed0, int seed1) Creates a new instance using a 2 element seed. -
Method Summary
Modifier and TypeMethodDescriptionprotected byte[]
Creates a snapshot of the RNG state.int
next()
protected abstract int
Use the current state to compute the next output from the generator.private void
setState
(int[] state) Copies the state from the array into the generator state.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, nextBytesFill, 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
-
Field Details
-
SEED_SIZE
private static final int SEED_SIZESize of the state vector.- See Also:
-
state0
protected int state0State 0 of the generator. -
state1
protected int state1State 1 of the generator.
-
-
Constructor Details
-
AbstractXoRoShiRo64
AbstractXoRoShiRo64(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.
-
AbstractXoRoShiRo64
AbstractXoRoShiRo64(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 Details
-
setState
private void setState(int[] state) Copies the state from the array into the generator state.- Parameters:
state
- the new state
-
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:
-
next
public int next()- Returns:
- the next random value.
-
nextOutput
protected abstract 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 fromnext()
before the current state is updated.- Returns:
- the next output
-