Class MersenneTwister64
- java.lang.Object
-
- org.apache.commons.rng.core.BaseProvider
-
- org.apache.commons.rng.core.source64.LongProvider
-
- org.apache.commons.rng.core.source64.MersenneTwister64
-
- All Implemented Interfaces:
RandomLongSource
,RestorableUniformRandomProvider
,UniformRandomProvider
public class MersenneTwister64 extends LongProvider
This class provides the 64-bits version of the originally 32-bitsMersenne Twister
.This class is mainly a Java port of the 2014/2/23 version of the generator written in C by Takuji Nishimura and Makoto Matsumoto.
Here is their original copyright:
Mersenne Twister licence Copyright (C) 2004, Makoto Matsumoto and Takuji Nishimura, All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- The names of its contributors may not be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - Since:
- 1.0
- See Also:
- Mersenne Twister (Wikipedia)
-
-
Field Summary
Fields Modifier and Type Field Description private static long
LM
Least significant 31 bits.private static long[]
MAG01
X * MATRIX_A for X = {0, 1}.private static int
MM
Period second parameter.private long[]
mt
Bytes pool.private int
mti
Current index in the bytes pool.private static int
NN
Size of the bytes pool.private static long
UM
Most significant 33 bits.
-
Constructor Summary
Constructors Constructor Description MersenneTwister64(long[] seed)
Creates a new random number generator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected byte[]
getStateInternal()
Creates a snapshot of the RNG state.private void
initState(long seed)
Initialize the internal state of this instance.long
next()
Return the next random value.private void
setSeedInternal(long[] inputSeed)
Initializes the generator with the given seed.protected void
setStateInternal(byte[] s)
Resets the RNG to the givenstate
.-
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
-
-
-
-
Field Detail
-
NN
private static final int NN
Size of the bytes pool.- See Also:
- Constant Field Values
-
MM
private static final int MM
Period second parameter.- See Also:
- Constant Field Values
-
MAG01
private static final long[] MAG01
X * MATRIX_A for X = {0, 1}.
-
UM
private static final long UM
Most significant 33 bits.- See Also:
- Constant Field Values
-
LM
private static final long LM
Least significant 31 bits.- See Also:
- Constant Field Values
-
mt
private final long[] mt
Bytes pool.
-
mti
private int mti
Current index in the bytes pool.
-
-
Method Detail
-
getStateInternal
protected byte[] getStateInternal()
Creates a snapshot of the RNG state.- Overrides:
getStateInternal
in classLongProvider
- Returns:
- the internal state.
-
setStateInternal
protected void setStateInternal(byte[] s)
Resets the RNG to the givenstate
.- Overrides:
setStateInternal
in classLongProvider
- Parameters:
s
- State (previously obtained by a call toBaseProvider.getStateInternal()
).- See Also:
BaseProvider.checkStateSize(byte[],int)
-
setSeedInternal
private void setSeedInternal(long[] inputSeed)
Initializes the generator with the given seed.- Parameters:
inputSeed
- Initial seed.
-
initState
private void initState(long seed)
Initialize the internal state of this instance.- Parameters:
seed
- Seed.
-
next
public long next()
Return the next random value.- Returns:
- the next random value.
-
-