Package org.apache.commons.rng.core.source32

Class IntProvider

java.lang.Object

org.apache.commons.rng.core.BaseProvider

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

All Implemented Interfaces:

RandomIntSource, org.apache.commons.rng.RestorableUniformRandomProvider, org.apache.commons.rng.UniformRandomProvider

Direct Known Subclasses:

AbstractWell, DotyHumphreySmallFastCounting32, ISAACRandom, JDKRandom, JenkinsSmallFast32, KISSRandom, L32X64Mix, MersenneTwister, MiddleSquareWeylSequence, MultiplyWithCarry256, PcgMcgXshRr32, PcgMcgXshRs32, PcgXshRr32, PcgXshRs32, Philox4x32, XoRoShiRo64Star, XoRoShiRo64StarStar, XoShiRo128Plus, XoShiRo128PlusPlus, XoShiRo128StarStar

public abstract class IntProvider
extends BaseProvider
implements RandomIntSource

Base class for all implementations that provide an int-based source randomness.

Constructor Summary

Constructors

Modifier	Constructor	Description
	IntProvider()	Creates a new instance.
protected	IntProvider(IntProvider source)	Creates a new instance copying the state from the source.

Method Summary

Modifier and Type	Method	Description
protected byte[]	getStateInternal()	Creates a snapshot of the RNG state.
boolean	nextBoolean()
void	nextBytes(byte[] bytes)
void	nextBytes(byte[] bytes, int start, int len)
double	nextDouble()
int	nextInt()
long	nextLong()
protected void	resetCachedState()	Reset the cached state used in the default implementation of nextBoolean().
protected void	setStateInternal(byte[] s)	Resets the RNG to the given state.

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

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

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.core.source32.RandomIntSource

next

Methods inherited from interface org.apache.commons.rng.UniformRandomProvider

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

Constructor Detail

IntProvider

public IntProvider()

Creates a new instance.

IntProvider

protected IntProvider(IntProvider source)

Creates a new instance copying the state from the source.

This provides base functionality to allow a generator to create a copy, for example for use in the JumpableUniformRandomProvider interface.

Parameters:

source - Source to copy.

Since:

1.3

Method Detail

resetCachedState

protected void resetCachedState()

Reset the cached state used in the default implementation of nextBoolean().

This should be used when the state is no longer valid, for example after a jump performed for the JumpableUniformRandomProvider interface.

Since:

1.3

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)

nextInt

public int nextInt()

Specified by:

nextInt in interface org.apache.commons.rng.UniformRandomProvider

nextBoolean

public boolean nextBoolean()

Specified by:

nextBoolean in interface org.apache.commons.rng.UniformRandomProvider

nextDouble

public double nextDouble()

Specified by:

nextDouble in interface org.apache.commons.rng.UniformRandomProvider

nextLong

public long nextLong()

Specified by:

nextLong in interface org.apache.commons.rng.UniformRandomProvider

nextBytes

public void nextBytes(byte[] bytes)

Specified by:

nextBytes in interface org.apache.commons.rng.UniformRandomProvider

nextBytes

public void nextBytes(byte[] bytes,
                      int start,
                      int len)

Specified by:

nextBytes in interface org.apache.commons.rng.UniformRandomProvider