dev.nm.stat.random.rng.univariate.uniform

Class UniformRNG

java.lang.Object

dev.nm.stat.random.rng.univariate.uniform.UniformRNG

All Implemented Interfaces:

RandomLongGenerator, RandomNumberGenerator, Seedable

public class UniformRNG
extends Object
implements RandomLongGenerator

A pseudo uniform random number generator samples numbers from the unit interval, [0, 1], in such a way that there are equal probabilities of them falling in any same length sub-interval. Sampling from the unit interval is the most basic building block of most pseudo random number generation algorithms.

Reproducing a simulation

Set a seed before drawing values. Reproducibility requires the same algorithm, seed, and sequence of calls. Drawing advances generator state; use independent generators for independent streams. These generators are for numerical simulation, not cryptographic key generation.

Example

 import dev.nm.stat.random.rng.univariate.uniform.UniformRNG;

 UniformRNG first = new UniformRNG(UniformRNG.Method.MERSENNE_TWISTER);
 UniformRNG second = new UniformRNG(UniformRNG.Method.MERSENNE_TWISTER);
 first.seed(12345L);
 second.seed(12345L);
 for (int i = 0; i < 5; ++i) {
     assert first.nextDouble() == second.nextDouble();
 }
 

See Also:

Wikipedia: UniformRng distribution (continuous)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UniformRNG.Method the pseudo uniform random number generators available

Constructor Summary

Constructors

Constructor and Description
UniformRNG() Construct a pseudo uniform random number generator.
UniformRNG(long... seeds) Construct a seeded pseudo uniform random number generator.
UniformRNG(UniformRNG.Method method) Construct a pseudo uniform random number generator.

Method Summary

Modifier and Type	Method and Description
double	nextDouble() Get the next random double.
long	nextLong() Get the next random long.
void	seed(long... seeds) Seed the random number/vector/scenario generator to produce repeatable experiments.

Methods inherited from class java.lang.Object

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

Constructor Detail

UniformRNG

public UniformRNG(UniformRNG.Method method)

Construct a pseudo uniform random number generator.

Parameters:

method - the uniform random number generation algorithm to use

UniformRNG

public UniformRNG()

Construct a pseudo uniform random number generator.

UniformRNG

public UniformRNG(long... seeds)

Construct a seeded pseudo uniform random number generator.

Parameters:

seeds - the seed(s)

Method Detail

seed

public void seed(long... seeds)

Description copied from interface: Seedable

Seed the random number/vector/scenario generator to produce repeatable experiments.

Specified by:

seed in interface Seedable

Parameters:

seeds - the seeds

nextDouble

public double nextDouble()

Description copied from interface: RandomNumberGenerator

Get the next random double.

Specified by:

nextDouble in interface RandomNumberGenerator

Returns:

the next random number

nextLong

public long nextLong()

Description copied from interface: RandomLongGenerator

Get the next random long.

Specified by:

nextLong in interface RandomLongGenerator

Returns:

the next random long