Package 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TwoCmres.Cmres	Subcycle generator.

Field Summary

Fields

Modifier and Type	Field	Description
private static TwoCmres.Cmres.Factory	FACTORY	Factory of instances of this class.
private static java.lang.String	INTERNAL_ERROR_MSG	Error message.
private static byte	SEED_GUARD	A small positive integer.
private TwoCmres.Cmres	x	First subcycle generator.
private long	xx	State of first subcycle generator.
private TwoCmres.Cmres	y	Second subcycle generator.
private long	yy	State of second subcycle generator.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TwoCmres(int seed, TwoCmres.Cmres x, TwoCmres.Cmres y)	Creates a new instance.
	TwoCmres(java.lang.Integer seed)	Creates a new instance.
	TwoCmres(java.lang.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.
private void	setSeedInternal(int seed)
protected void	setStateInternal(byte[] s)	Resets the RNG to the given state.
java.lang.String	toString()

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

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.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

Field Detail

INTERNAL_ERROR_MSG

private static final java.lang.String INTERNAL_ERROR_MSG

Error message.

See Also:

Constant Field Values

SEED_GUARD

private static final byte SEED_GUARD

A small positive integer.

See Also:

Constant Field Values

FACTORY

private static final TwoCmres.Cmres.Factory FACTORY

Factory of instances of this class. Singleton.

x

private final TwoCmres.Cmres x

First subcycle generator.

y

private final TwoCmres.Cmres y

Second subcycle generator.

xx

private long xx

State of first subcycle generator.

yy

private long yy

State of second subcycle generator.

Constructor Detail

TwoCmres

private TwoCmres(int seed,
                 TwoCmres.Cmres x,
                 TwoCmres.Cmres y)

Creates a new instance.

Parameters:

seed - Initial seed.

x - First subcycle generator.

y - Second subcycle generator.

TwoCmres

public TwoCmres(java.lang.Integer seed)

Creates a new instance.

Parameters:

seed - Seed.

TwoCmres

public TwoCmres(java.lang.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:

java.lang.IllegalArgumentException - if i == j.

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

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

Method Detail

next

public long next()

Return the next random value.

Returns:

the next random value.

toString

public java.lang.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)

setSeedInternal

private void setSeedInternal(int seed)

Parameters:

seed - Seed.