org.apache.commons.rng.core.source64

Class TwoCmres

java.lang.Object

org.apache.commons.rng.core.BaseProvider

org.apache.commons.rng.core.source64.LongProvider

org.apache.commons.rng.core.source64.TwoCmres

All Implemented Interfaces:

RandomLongSource, RestorableUniformRandomProvider, UniformRandomProvider

public class TwoCmres
extends LongProvider

Random number generator designed by Mark D. Overton.

It is one of the many generators described by the author in the following article series:

• Part one
• Part two

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
TwoCmres(Integer seed) Creates a new instance.
TwoCmres(Integer seed, int i, int j) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected byte[]	getStateInternal() Creates a snapshot of the RNG state.
long	next()
static int	numberOfSubcycleGenerators()
protected void	setStateInternal(byte[] s) Resets the RNG to the given state.
String	toString()

Methods inherited from class org.apache.commons.rng.core.source64.LongProvider

nextBoolean, nextBytes, nextBytes, nextDouble, nextFloat, nextInt, nextLong

Methods inherited from class org.apache.commons.rng.core.BaseProvider

checkIndex, checkStateSize, fillState, fillState, nextInt, nextLong, restoreState, saveState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TwoCmres

public TwoCmres(Integer seed)

Creates a new instance.

Parameters:

seed - Seed.

TwoCmres

public TwoCmres(Integer seed,
                int i,
                int j)

Creates a new instance.

Parameters:

seed - Seed.

i - Table entry for first subcycle generator.

j - Table entry for second subcycle generator.

Throws:

IllegalArgumentException - if i == j.

IndexOutOfBoundsException - if i < 0 or i >= numberOfSubcycleGenerators().

IndexOutOfBoundsException - if j < 0 or j >= numberOfSubcycleGenerators().

Method Detail

next

public long next()

Specified by:

next in interface RandomLongSource

Specified by:

next in class LongProvider

Returns:

the next random value.

toString

public String toString()

Overrides:

toString in class BaseProvider

numberOfSubcycleGenerators

public static int numberOfSubcycleGenerators()

Returns:

the number of subcycle generators.

getStateInternal

protected byte[] getStateInternal()

Creates a snapshot of the RNG state.

Overrides:

getStateInternal in class BaseProvider

Returns:

the internal state.

setStateInternal

protected void setStateInternal(byte[] s)

Resets the RNG to the given state.

Overrides:

setStateInternal in class BaseProvider

Parameters:

s - State (previously obtained by a call to BaseProvider.getStateInternal()).

See Also:

BaseProvider.checkStateSize(byte[],int)