Top Description Fields Constructors Methods
org.apache.commons.math3.random

public Class MersenneTwister

extends BitsStreamGenerator
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.Serializable, org.apache.commons.math3.util.FastMath

This class implements a powerful pseudo-random number generator developed by Makoto Matsumoto and Takuji Nishimura during 1996-1997.

This generator features an extremely long period (219937-1) and 623-dimensional equidistribution up to 32 bits accuracy. The home page for this generator is located at http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html.

This generator is described in a paper by Makoto Matsumoto and Takuji Nishimura in 1998: Mersenne Twister: A 623-Dimensionally Equidistributed Uniform Pseudo-Random Number Generator, ACM Transactions on Modeling and Computer Simulation, Vol. 8, No. 1, January 1998, pp 3--30

This class is mainly a Java port of the 2002-01-26 version of the generator written in C by Makoto Matsumoto and Takuji Nishimura. Here is their original copyright:

Copyright (C) 1997 - 2002, 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:
  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. 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.
  3. 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
2.0

Field Summary

Modifier and TypeField and Description
private static final int
M

Period second parameter.

private static final int[]
MAG01

X * MATRIX_A for X = {0, 1}.

private int[]
mt

Bytes pool.

private int
mti

Current index in the bytes pool.

private static final int
N

Size of the bytes pool.

private static final long

Constructor Summary

AccessConstructor and Description
public
MersenneTwister()

Creates a new random number generator.

public
MersenneTwister(int
the initial seed (32 bits integer)
seed
)

Creates a new random number generator using a single int seed.

public
MersenneTwister(int[]
the initial seed (32 bits integers array), if null the seed of the generator will be related to the current time
seed
)

Creates a new random number generator using an int array seed.

public
MersenneTwister(long
the initial seed (64 bits integer)
seed
)

Creates a new random number generator using a single long seed.

Method Summary

Modifier and TypeMethod and Description
protected int

Returns:

random bits generated
next
(int
number of random bits to produce
bits
)

Implements abstract org.apache.commons.math3.random.BitsStreamGenerator.next.

Generate next pseudorandom number.

public void
setSeed(int
the initial seed (32 bits integer)
seed
)

Implements abstract org.apache.commons.math3.random.BitsStreamGenerator.setSeed.

Implements org.apache.commons.math3.random.RandomGenerator.setSeed.

Reinitialize the generator as if just built with the given int seed.

public void
setSeed(int[]
the initial seed (32 bits integers array), if null the seed of the generator will be the current system time plus the system identity hash code of this instance
seed
)

Implements abstract org.apache.commons.math3.random.BitsStreamGenerator.setSeed.

Implements org.apache.commons.math3.random.RandomGenerator.setSeed.

Reinitialize the generator as if just built with the given int array seed.

public void
setSeed(long
the initial seed (64 bits integer)
seed
)

Implements abstract org.apache.commons.math3.random.BitsStreamGenerator.setSeed.

Implements org.apache.commons.math3.random.RandomGenerator.setSeed.

Reinitialize the generator as if just built with the given long seed.

Inherited from org.apache.commons.math3.random.BitsStreamGenerator:
clearnextBooleannextBytesnextBytesnextDoublenextFloatnextGaussiannextIntnextIntnextLongnextLong

Field Detail

Mback to summary
private static final int M

Period second parameter.

MAG01back to summary
private static final int[] MAG01

X * MATRIX_A for X = {0, 1}.

mtback to summary
private int[] mt

Bytes pool.

mtiback to summary
private int mti

Current index in the bytes pool.

Nback to summary
private static final int N

Size of the bytes pool.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides org.apache.commons.math3.random.BitsStreamGenerator.serialVersionUID.

Serializable version identifier.

Constructor Detail

MersenneTwisterback to summary
public MersenneTwister()

Creates a new random number generator.

The instance is initialized using the current time plus the system identity hash code of this instance as the seed.

MersenneTwisterback to summary
public MersenneTwister(int seed)

Creates a new random number generator using a single int seed.

Parameters
seed:int

the initial seed (32 bits integer)

MersenneTwisterback to summary
public MersenneTwister(int[] seed)

Creates a new random number generator using an int array seed.

Parameters
seed:int[]

the initial seed (32 bits integers array), if null the seed of the generator will be related to the current time

MersenneTwisterback to summary
public MersenneTwister(long seed)

Creates a new random number generator using a single long seed.

Parameters
seed:long

the initial seed (64 bits integer)

Method Detail

nextback to summary
protected int next(int bits)

Implements abstract org.apache.commons.math3.random.BitsStreamGenerator.next.

Generate next pseudorandom number.

This method is the core generation algorithm. It is used by all the public generation methods for the various primitive types nextBoolean(), nextBytes(byte[]), nextDouble(), nextFloat(), nextGaussian(), nextInt(), next(int) and nextLong().

Parameters
bits:int

number of random bits to produce

Returns:int

random bits generated

Annotations
@Override
setSeedback to summary
public void setSeed(int seed)

Implements abstract org.apache.commons.math3.random.BitsStreamGenerator.setSeed.

Implements org.apache.commons.math3.random.RandomGenerator.setSeed.

Reinitialize the generator as if just built with the given int seed.

The state of the generator is exactly the same as a new generator built with the same seed.

Parameters
seed:int

the initial seed (32 bits integer)

Annotations
@Override
setSeedback to summary
public void setSeed(int[] seed)

Implements abstract org.apache.commons.math3.random.BitsStreamGenerator.setSeed.

Implements org.apache.commons.math3.random.RandomGenerator.setSeed.

Reinitialize the generator as if just built with the given int array seed.

The state of the generator is exactly the same as a new generator built with the same seed.

Parameters
seed:int[]

the initial seed (32 bits integers array), if null the seed of the generator will be the current system time plus the system identity hash code of this instance

Annotations
@Override
setSeedback to summary
public void setSeed(long seed)

Implements abstract org.apache.commons.math3.random.BitsStreamGenerator.setSeed.

Implements org.apache.commons.math3.random.RandomGenerator.setSeed.

Reinitialize the generator as if just built with the given long seed.

The state of the generator is exactly the same as a new generator built with the same seed.

Parameters
seed:long

the initial seed (64 bits integer)

Annotations
@Override