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	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	Description
protected byte[]	getStateInternal()	Creates a snapshot of the RNG state.
long	next()	Return the next random value.
static int	numberOfSubcycleGenerators()	Get the number of subcycle generators.
protected void	setStateInternal(byte[] s)	Resets the RNG to the given state.
String	toString()

Methods inherited from class LongProvider

nextBoolean, nextInt, nextLong, resetCachedState

Methods inherited from class BaseProvider

checkIndex, checkStateSize, composeStateInternal, extendSeed, extendSeed, fillState, fillState, restoreState, saveState, splitStateInternal

Methods inherited from class Object

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

Methods inherited from interface UniformRandomProvider

doubles, doubles, doubles, doubles, ints, ints, ints, ints, longs, longs, longs, longs, nextBytes, nextBytes, nextDouble, nextDouble, nextDouble, nextFloat, nextFloat, nextFloat, nextInt, nextInt, nextLong, nextLong

Constructor Details

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 Details

next

public long next()

Return the next random value.

Returns:

the next random value.

toString

public String toString()

Overrides:

toString in class BaseProvider

numberOfSubcycleGenerators

public static int numberOfSubcycleGenerators()

Get the number of subcycle generators.

Returns:

the number of subcycle generators.

getStateInternal

protected byte[] getStateInternal()

Creates a snapshot of the RNG state.

Overrides:

getStateInternal in class LongProvider

Returns:

the internal state.

setStateInternal

protected void setStateInternal(byte[] s)

Resets the RNG to the given state.

Overrides:

setStateInternal in class LongProvider

Parameters:

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

See Also:

• BaseProvider.checkStateSize(byte[],int)