Class AbstractL64X128
- All Implemented Interfaces:
RandomLongSource
,JumpableUniformRandomProvider
,LongJumpableUniformRandomProvider
,RestorableUniformRandomProvider
,UniformRandomProvider
- Direct Known Subclasses:
L64X128Mix
,L64X128StarStar
- Since:
- 1.5
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final long
LCG multiplier.private static final int
Size of the seed vector.protected long
State 0 of the XBG.protected long
State 1 of the XBG.private static final int
Size of the XBG state vector.Fields inherited from class org.apache.commons.rng.core.source64.AbstractL64
la, ls
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractL64X128
(long[] seed) Creates a new instance.AbstractL64X128
(long seed0, long seed1, long seed2, long seed3) Creates a new instance using a 4 element seed.AbstractL64X128
(AbstractL64X128 source) Creates a copy instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected byte[]
Creates a snapshot of the RNG state.jump()
Creates a copy of the UniformRandomProvider and then retreats the state of the current instance.longJump()
Creates a copy of the UniformRandomProvider and then retreats the state of the current instance.protected void
setStateInternal
(byte[] s) Resets the RNG to the givenstate
.Methods inherited from class org.apache.commons.rng.core.source64.AbstractL64
copy
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.core.source64.RandomLongSource
next
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 Details
-
M
protected static final long MLCG multiplier.- See Also:
-
SEED_SIZE
private static final int SEED_SIZESize of the seed vector.- See Also:
-
XBG_STATE_SIZE
private static final int XBG_STATE_SIZESize of the XBG state vector.- See Also:
-
x0
protected long x0State 0 of the XBG. -
x1
protected long x1State 1 of the XBG.
-
-
Constructor Details
-
AbstractL64X128
AbstractL64X128(long[] 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 in the last two elements will create a non-functional XBG sub-generator and a low quality output with a period of 264.The 1st element is used to set the LCG increment; the least significant bit is set to odd to ensure a full period LCG. The 2nd element is used to set the LCG state.
-
AbstractL64X128
AbstractL64X128(long seed0, long seed1, long seed2, long seed3) Creates a new instance using a 4 element seed. A seed containing all zeros in the last two elements will create a non-functional XBG sub-generator and a low quality output with a period of 264.The 1st element is used to set the LCG increment; the least significant bit is set to odd to ensure a full period LCG. The 2nd element is used to set the LCG state.
- Parameters:
seed0
- Initial seed element 0.seed1
- Initial seed element 1.seed2
- Initial seed element 2.seed3
- Initial seed element 3.
-
AbstractL64X128
AbstractL64X128(AbstractL64X128 source) Creates a copy instance.- Parameters:
source
- Source to copy.
-
-
Method Details
-
getStateInternal
protected byte[] getStateInternal()Creates a snapshot of the RNG state.- Overrides:
getStateInternal
in classAbstractL64
- Returns:
- the internal state.
-
setStateInternal
protected void setStateInternal(byte[] s) Resets the RNG to the givenstate
.- Overrides:
setStateInternal
in classAbstractL64
- Parameters:
s
- State (previously obtained by a call toBaseProvider.getStateInternal()
).- See Also:
-
jump
Creates a copy of the UniformRandomProvider and then retreats the state of the current instance. The copy is returned.The jump is performed by advancing the state of the LCG sub-generator by 1 cycle. The XBG state is unchanged.
The jump size is the equivalent of moving the state backwards by (2128 - 1) positions. It can provide up to 264 non-overlapping subsequences.
- Specified by:
jump
in interfaceJumpableUniformRandomProvider
- Overrides:
jump
in classAbstractL64
- Returns:
- A copy of the current state.
-
longJump
Creates a copy of the UniformRandomProvider and then retreats the state of the current instance. The copy is returned.The jump is performed by advancing the state of the LCG sub-generator by 232 cycles. The XBG state is unchanged.
The jump size is the equivalent of moving the state backwards by 232 (2128 - 1) positions. It can provide up to 232 non-overlapping subsequences of length 232 (2128 - 1); each subsequence can provide up to 232 non-overlapping subsequences of length (2128 - 1) using the
jump()
method.- Specified by:
longJump
in interfaceLongJumpableUniformRandomProvider
- Overrides:
longJump
in classAbstractL64
- Returns:
- A copy of the current state.
-