Package org.hipparchus.random
Class Well44497a
- java.lang.Object
-
- org.hipparchus.random.AbstractWell
-
- org.hipparchus.random.Well44497a
-
- All Implemented Interfaces:
Serializable
,RandomGenerator
public class Well44497a extends AbstractWell
This class implements the WELL44497a pseudo-random number generator from François Panneton, Pierre L'Ecuyer and Makoto Matsumoto.This generator is described in a paper by François Panneton, Pierre L'Ecuyer and Makoto Matsumoto Improved Long-Period Generators Based on Linear Recurrences Modulo 2 ACM Transactions on Mathematical Software, 32, 1 (2006). The errata for the paper are in wellrng-errata.txt.
- See Also:
- WELL Random number generator, Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.hipparchus.random.AbstractWell
AbstractWell.IndexTable
-
-
Field Summary
-
Fields inherited from class org.hipparchus.random.AbstractWell
index, v
-
-
Constructor Summary
Constructors Constructor Description Well44497a()
Creates a new random number generator.Well44497a(int seed)
Creates a new random number generator using a single int seed.Well44497a(int[] seed)
Creates a new random number generator using an int array seed.Well44497a(long seed)
Creates a new random number generator using a single long seed.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
clearCache()
Clears the cache used by the default implementation ofnextGaussian
.boolean
nextBoolean()
Returns the next pseudorandom, uniformly distributedboolean
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 distributeddouble
value between0.0
and1.0
from this random number generator's sequence.float
nextFloat()
Returns the next pseudorandom, uniformly distributedfloat
value between0.0
and1.0
from this random number generator's sequence.double
nextGaussian()
Returns the next pseudorandom, Gaussian ("normally") distributeddouble
value with mean0.0
and standard deviation1.0
from this random number generator's sequence.int
nextInt()
Returns the next pseudorandom, uniformly distributedint
value from this random number generator's sequence.int
nextInt(int n)
Returns a pseudorandom, uniformly distributedint
value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.long
nextLong()
Returns the next pseudorandom, uniformly distributedlong
value from this random number generator's sequence.long
nextLong(long n)
Returns a pseudorandom, uniformly distributedint
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 anint
seed.void
setSeed(long seed)
Sets the seed of the underlying random number generator using along
seed.String
toString()
-
Methods inherited from class org.hipparchus.random.AbstractWell
setSeed
-
-
-
-
Constructor Detail
-
Well44497a
public Well44497a()
Creates a new random number generator.The instance is initialized using the current time as the seed.
-
Well44497a
public Well44497a(int seed)
Creates a new random number generator using a single int seed.- Parameters:
seed
- the initial seed (32 bits integer)
-
Well44497a
public Well44497a(int[] seed)
Creates a new random number generator using an int array seed.- Parameters:
seed
- the initial seed (32 bits integers array), if null the seed of the generator will be related to the current time
-
Well44497a
public Well44497a(long seed)
Creates a new random number generator using a single long seed.- Parameters:
seed
- the initial seed (64 bits integer)
-
-
Method Detail
-
nextInt
public int nextInt()
Returns the next pseudorandom, uniformly distributedint
value from this random number generator's sequence.All 232 possible
int
values should be produced with (approximately) equal probability.- Specified by:
nextInt
in interfaceRandomGenerator
- Returns:
- the next pseudorandom, uniformly distributed
int
value from this random number generator's sequence
-
nextBoolean
public boolean nextBoolean()
Returns the next pseudorandom, uniformly distributedboolean
value from this random number generator's sequence.- Returns:
- the next pseudorandom, uniformly distributed
boolean
value from this random number generator's sequence
-
nextDouble
public double nextDouble()
Returns the next pseudorandom, uniformly distributeddouble
value between0.0
and1.0
from this random number generator's sequence.- Returns:
- the next pseudorandom, uniformly distributed
double
value between0.0
and1.0
from this random number generator's sequence
-
nextFloat
public float nextFloat()
Returns the next pseudorandom, uniformly distributedfloat
value between0.0
and1.0
from this random number generator's sequence.- Returns:
- the next pseudorandom, uniformly distributed
float
value between0.0
and1.0
from this random number generator's sequence
-
nextLong
public long nextLong()
Returns the next pseudorandom, uniformly distributedlong
value from this random number generator's sequence. All 264 possiblelong
values should be produced with (approximately) equal probability.- Returns:
- the next pseudorandom, uniformly distributed
long
value from this random number generator's sequence
-
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.- Parameters:
bytes
- the non-null byte array in which to put the random bytes
-
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 bytesstart
- the starting index for inserting the generated bytes into the arraylen
- the number of bytes to generate
-
setSeed
public void setSeed(int seed)
Sets the seed of the underlying random number generator using anint
seed.Sequences of values generated starting with the same seeds should be identical.
- Specified by:
setSeed
in interfaceRandomGenerator
- Parameters:
seed
- the seed value
-
setSeed
public void setSeed(long seed)
Sets the seed of the underlying random number generator using along
seed.Sequences of values generated starting with the same seeds should be identical.
- Specified by:
setSeed
in interfaceRandomGenerator
- Parameters:
seed
- the seed value
-
nextInt
public int nextInt(int n) throws IllegalArgumentException
Returns a pseudorandom, uniformly distributedint
value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.- Specified by:
nextInt
in interfaceRandomGenerator
- 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). - Throws:
IllegalArgumentException
- if n is not positive.
-
nextLong
public long nextLong(long n)
Returns a pseudorandom, uniformly distributedint
value between 0 (inclusive) and the specified value (exclusive), drawn from this random number generator's sequence.- Specified by:
nextLong
in interfaceRandomGenerator
- 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).
-
nextGaussian
public double nextGaussian()
Returns the next pseudorandom, Gaussian ("normally") distributeddouble
value with mean0.0
and standard deviation1.0
from this random number generator's sequence.- Specified by:
nextGaussian
in interfaceRandomGenerator
- Returns:
- the next pseudorandom, Gaussian ("normally") distributed
double
value with mean0.0
and standard deviation1.0
from this random number generator's sequence
-
clearCache
protected void clearCache()
Clears the cache used by the default implementation ofnextGaussian
.
-
-