Package org.apache.commons.math4.random

Class RngAdaptor

java.lang.Object

org.apache.commons.math4.random.RngAdaptor

All Implemented Interfaces:

java.io.Serializable, RandomGenerator

@Deprecated
public final class RngAdaptor
extends java.lang.Object
implements RandomGenerator, java.io.Serializable

Deprecated.

As of 4.0. This class is made available for testing the new RNG implementations in existing applications. It will be removed in the next major release.

Adaptor that delegates to a UniformRandomProvider instance.

It is provided for users who wish to test the new RNG implementations the current generators (up to version 3.6 of Commons Math) in codes that require the RandomGenerator interface.

Applications should upgrade to use the new generators ASAP. If problems are found that jeopardize the upgrade, please report them on the project's issue tracking system.

Notes:

• The setSeed(int), setSeed(int[]) and setSeed(long) methods of the RandomGenerator are not part of the new API.
• The new RNG implementations are not Serializable. Use RestorableUniformRandomProvider.saveState() instead.
• nextGaussian() is not part of the new API as it defines a "post-processing" of the output of a uniform RNG in order to follow a different distribution.

Since:

4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
RngAdaptor(RandomSource source)	Deprecated. Creates a new instance.
RngAdaptor(RandomSource source, java.lang.Object seed)	Deprecated. Creates a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	nextBoolean()	Deprecated. Returns the next pseudorandom, uniformly distributed boolean value from this random number generator's sequence.
void	nextBytes(byte[] bytes)	Deprecated. Generates random bytes and places them into a user-supplied byte array.
double	nextDouble()	Deprecated. Returns the next pseudorandom, uniformly distributed double value between 0.0 and 1.0 from this random number generator's sequence.
float	nextFloat()	Deprecated. Returns the next pseudorandom, uniformly distributed float value between 0.0 and 1.0 from this random number generator's sequence.
double	nextGaussian()	Deprecated. Returns the next pseudorandom, Gaussian ("normally") distributed double value with mean 0.0 and standard deviation 1.0 from this random number generator's sequence.
int	nextInt()	Deprecated. Returns the next pseudorandom, uniformly distributed int value from this random number generator's sequence.
int	nextInt(int n)	Deprecated. Returns a pseudorandom, uniformly distributed int value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.
long	nextLong()	Deprecated. Returns the next pseudorandom, uniformly distributed long value from this random number generator's sequence.
void	setSeed(int seed)	Deprecated. Sets the seed of the underlying random number generator using an int seed.
void	setSeed(int[] seed)	Deprecated. Sets the seed of the underlying random number generator using an int array seed.
void	setSeed(long seed)	Deprecated. Sets the seed of the underlying random number generator using a long seed.

Methods inherited from class java.lang.Object

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

Constructor Detail

RngAdaptor

public RngAdaptor(RandomSource source)

Deprecated.

Creates a new instance.

Parameters:

source - Source of randomness.

RngAdaptor

public RngAdaptor(RandomSource source,
                  java.lang.Object seed)

Deprecated.

Creates a new instance.

Parameters:

source - Source of randomness.

seed - Seed. Can be null.

Method Detail

setSeed

public void setSeed(int seed)

Deprecated.

Sets the seed of the underlying random number generator using an int seed.

Sequences of values generated starting with the same seeds should be identical.

Specified by:

setSeed in interface RandomGenerator

Parameters:

seed - the seed value

setSeed

public void setSeed(int[] seed)

Deprecated.

Sets the seed of the underlying random number generator using an int array seed.

Sequences of values generated starting with the same seeds should be identical.

Specified by:

setSeed in interface RandomGenerator

Parameters:

seed - the seed value

setSeed

public void setSeed(long seed)

Deprecated.

Sets the seed of the underlying random number generator using a long seed.

Sequences of values generated starting with the same seeds should be identical.

Specified by:

setSeed in interface RandomGenerator

Parameters:

seed - the seed value

nextBoolean

public boolean nextBoolean()

Deprecated.

Returns the next pseudorandom, uniformly distributed boolean value from this random number generator's sequence.

Specified by:

nextBoolean in interface RandomGenerator

Returns:

the next pseudorandom, uniformly distributed boolean value from this random number generator's sequence

nextBytes

public void nextBytes(byte[] bytes)

Deprecated.

Generates random bytes and places them into a user-supplied byte array. The number of random bytes produced is equal to the length of the byte array.

Specified by:

nextBytes in interface RandomGenerator

Parameters:

bytes - the non-null byte array in which to put the random bytes

nextDouble

public double nextDouble()

Deprecated.

Returns the next pseudorandom, uniformly distributed double value between 0.0 and 1.0 from this random number generator's sequence.

Specified by:

nextDouble in interface RandomGenerator

Returns:

the next pseudorandom, uniformly distributed double value between 0.0 and 1.0 from this random number generator's sequence

nextFloat

public float nextFloat()

Deprecated.

Returns the next pseudorandom, uniformly distributed float value between 0.0 and 1.0 from this random number generator's sequence.

Specified by:

nextFloat in interface RandomGenerator

Returns:

the next pseudorandom, uniformly distributed float value between 0.0 and 1.0 from this random number generator's sequence

nextGaussian

public double nextGaussian()

Deprecated.

Returns the next pseudorandom, Gaussian ("normally") distributed double value with mean 0.0 and standard deviation 1.0 from this random number generator's sequence.

Specified by:

nextGaussian in interface RandomGenerator

Returns:

the next pseudorandom, Gaussian ("normally") distributed double value with mean 0.0 and standard deviation 1.0 from this random number generator's sequence

nextInt

public int nextInt()

Deprecated.

Returns the next pseudorandom, uniformly distributed int value from this random number generator's sequence. All 2³² possible int values should be produced with (approximately) equal probability.

Specified by:

nextInt in interface RandomGenerator

Returns:

the next pseudorandom, uniformly distributed int value from this random number generator's sequence

nextInt

public int nextInt(int n)

Deprecated.

Returns a pseudorandom, uniformly distributed int value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.

Specified by:

nextInt in interface RandomGenerator

Parameters:

n - the bound on the random number to be returned. Must be positive.

Returns:

a pseudorandom, uniformly distributed int value between 0 (inclusive) and n (exclusive).

nextLong

public long nextLong()

Deprecated.

Returns the next pseudorandom, uniformly distributed long value from this random number generator's sequence. All 2⁶⁴ possible long values should be produced with (approximately) equal probability.

Specified by:

nextLong in interface RandomGenerator

Returns:

the next pseudorandom, uniformly distributed long value from this random number generator's sequence