org.apache.commons.rng.core.source32

Class MultiplyWithCarry256

java.lang.Object

org.apache.commons.rng.core.BaseProvider

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

org.apache.commons.rng.core.source32.MultiplyWithCarry256

All Implemented Interfaces:

RandomIntSource, RestorableUniformRandomProvider, UniformRandomProvider

public class MultiplyWithCarry256
extends IntProvider

Port from Marsaglia's "Multiply-With-Carry" algorithm.

Implementation is based on the (non-portable!) C code reproduced on that page.

Since:

1.0

See Also:

Multiply with carry (Wikipedia)

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class org.apache.commons.rng.core.source32.IntProvider

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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiplyWithCarry256

public MultiplyWithCarry256(int[] seed)

Creates a new instance.

Parameters:

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

Method Detail

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)

next

public int next()

Specified by:

next in interface RandomIntSource

Specified by:

next in class IntProvider

Returns:

the next random value.