Package org.hipparchus.random

Class JDKRandomGenerator

java.lang.Object

org.hipparchus.random.JDKRandomGenerator

All Implemented Interfaces:

Serializable, RandomGenerator

public class JDKRandomGenerator
extends Object
implements Serializable

A RandomGenerator adapter that delegates the random number generation to the standard Random class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
JDKRandomGenerator()	Creates an instance with an arbitrary seed.
JDKRandomGenerator(long seed)	Creates an instance with the given seed.
JDKRandomGenerator(Random random)	Creates an instance that wraps the given Random instance.

Method Summary

Modifier and Type	Method	Description
protected void	clearCache()	Clears the cache used by the default implementation of RandomGenerator.nextGaussian().
boolean	nextBoolean()	Returns the next pseudorandom, uniformly distributed boolean value from this random number generator's sequence.
void	nextBytes(byte[] bytes)	Generates random bytes and places them into a user-supplied byte array.
void	nextBytes(byte[] bytes, int start, int len)	Generates random bytes and places them into a user-supplied byte array.
double	nextDouble()	Returns the next pseudorandom, uniformly distributed double value between 0.0 and 1.0 from this random number generator's sequence.
float	nextFloat()	Returns the next pseudorandom, uniformly distributed float value between 0.0 and 1.0 from this random number generator's sequence.
double	nextGaussian()	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()	Returns the next pseudorandom, uniformly distributed int value from this random number generator's sequence.
int	nextInt(int n)	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()	Returns the next pseudorandom, uniformly distributed long value from this random number generator's sequence.
long	nextLong(long n)	Returns a pseudorandom, uniformly distributed int value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.
void	setSeed(int seed)	Sets the seed of the underlying random number generator using an int seed.
void	setSeed(int[] seed)	Sets the seed of the underlying random number generator using an int array seed.
void	setSeed(long seed)	Sets the seed of the underlying random number generator using a long seed.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JDKRandomGenerator

public JDKRandomGenerator()

Creates an instance with an arbitrary seed.

JDKRandomGenerator

public JDKRandomGenerator(long seed)

Creates an instance with the given seed.

Parameters:

seed - Initial seed.

JDKRandomGenerator

public JDKRandomGenerator(Random random)

Creates an instance that wraps the given Random instance.

Parameters:

random - JDK Random instance that will generate the the random data.

Throws:

MathIllegalArgumentException - if random is null

Method Detail

setSeed

public void setSeed(int seed)

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(long seed)

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

setSeed

public void setSeed(int[] seed)

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

nextBytes

public void nextBytes(byte[] bytes)

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

nextInt

public int nextInt()

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

nextLong

public long nextLong()

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

nextBoolean

public boolean nextBoolean()

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

nextFloat

public float nextFloat()

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

nextDouble

public double nextDouble()

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

nextGaussian

public double nextGaussian()

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(int n)

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

nextBytes

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

Generates random bytes and places them into a user-supplied byte array.

Parameters:

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

start - the starting index for inserting the generated bytes into the array

len - the number of bytes to generate

nextLong

public long nextLong(long n)

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:

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

clearCache

protected void clearCache()

Clears the cache used by the default implementation of RandomGenerator.nextGaussian().

toString

public String toString()

Overrides:

toString in class Object