Class KISSRandom

java.lang.Object

org.apache.commons.rng.core.BaseProvider

org.apache.commons.rng.core.source32.IntProvider

org.apache.commons.rng.core.source32.KISSRandom

All Implemented Interfaces:

RandomIntSource, RestorableUniformRandomProvider, UniformRandomProvider

public class KISSRandom
extends IntProvider

Port from Marsaglia's "KISS" algorithm. This version contains the correction referred to here in a reply to the original post.

Since:

1.0

See Also:

• KISS (Wikipedia)

Field Summary

Fields

Modifier and Type	Field	Description
private int	jcong	State variable.
private int	jsr	State variable.
private static final int	SEED_SIZE	Size of the seed.
private int	w	State variable.
private int	z	State variable.

Constructor Summary

Constructors

Constructor	Description
KISSRandom(int[] seed)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
private static int	computeNew(int mult, int previous)	Compute new value.
protected byte[]	getStateInternal()	Creates a snapshot of the RNG state.
int	next()	Return the next random value.
private void	setSeedInternal(int[] seed)	Seeds the RNG.
protected void	setStateInternal(byte[] s)	Resets the RNG to the given state.

Methods inherited from class IntProvider

nextBoolean, nextBytes, nextBytes, nextBytesFill, nextDouble, nextInt, nextLong, resetCachedState

Methods inherited from class BaseProvider

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

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, nextDouble, nextDouble, nextFloat, nextFloat, nextFloat, nextInt, nextInt, nextLong, nextLong

Field Details

SEED_SIZE

private static final int SEED_SIZE

Size of the seed.

See Also:

• Constant Field Values

z

private int z

State variable.

w

private int w

State variable.

jsr

private int jsr

State variable.

jcong

private int jcong

State variable.

Constructor Details

KISSRandom

public KISSRandom(int[] seed)

Creates a new instance.

Parameters:

seed - Seed. If the length is larger than 4, only the first 4 elements will be used; if smaller, the remaining elements will be automatically set.

Method Details

getStateInternal

protected byte[] getStateInternal()

Creates a snapshot of the RNG state.

Overrides:

getStateInternal in class IntProvider

Returns:

the internal state.

setStateInternal

protected void setStateInternal(byte[] s)

Resets the RNG to the given state.

Overrides:

setStateInternal in class IntProvider

Parameters:

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

See Also:

• BaseProvider.checkStateSize(byte[],int)

setSeedInternal

private void setSeedInternal(int[] seed)

Seeds the RNG.

Parameters:

seed - Seed.

next

public int next()

Return the next random value.

Returns:

the next random value.

computeNew

private static int computeNew(int mult,
 int previous)

Compute new value.

Parameters:

mult - Multiplier.

previous - Previous value.

Returns:

new value.