org.arl.fjage

Class AgentLocalRandom

java.lang.Object

java.util.Random

org.arl.fjage.AgentLocalRandom

All Implemented Interfaces:

java.io.Serializable

public class AgentLocalRandom
extends java.util.Random

Utility class for random number generation in simulations. This should be used in preference to java.util.Random to ensure that simulations are repeatable by setting a random number seed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AgentLocalRandom()

Method Summary

Modifier and Type	Method and Description
static AgentLocalRandom	current() Returns the current agent's AgentLocalRandom.
double	nextDouble(double min, double max) Generates a random double.
double	nextExp() Generates an exponentially distributed random number with unit mean.
double	nextExp(double lambda) Generates an exponentially distributed random number with mean 1/lambda.
double	nextGaussian(double mu, double sigma2) Generates a Gaussian distributed random number.
double	nextRayleigh(double sigma) Generates a Rayleigh distributed random number.
double	nextRician(double nu, double sigma) Generates a Rician distributed random number.
static void	setRootSeed(long seed) Sets root random number generator seed.

Methods inherited from class java.util.Random

doubles, doubles, doubles, doubles, ints, ints, ints, ints, longs, longs, longs, longs, next, nextBoolean, nextBytes, nextDouble, nextFloat, nextGaussian, nextInt, nextInt, nextLong, setSeed

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentLocalRandom

public AgentLocalRandom()

Method Detail

current

public static AgentLocalRandom current()

Returns the current agent's AgentLocalRandom.

Returns:

current agent's random number generator.

setRootSeed

public static void setRootSeed(long seed)

Sets root random number generator seed. This should be set once, at the start of the simulation if repeatable random number sequences are desired.

Parameters:

seed - random number seed.

nextDouble

public double nextDouble(double min,
                         double max)

Generates a random double.

Parameters:

min - minimum value to generate.

max - maximum value to generate.

Returns:

random number.

nextExp

public double nextExp(double lambda)

Generates an exponentially distributed random number with mean 1/lambda.

Parameters:

lambda - rate parameter.

Returns:

random number.

nextExp

public double nextExp()

Generates an exponentially distributed random number with unit mean.

Returns:

random number.

nextGaussian

public double nextGaussian(double mu,
                           double sigma2)

Generates a Gaussian distributed random number.

Parameters:

mu - mean of the distribution.

sigma2 - variance of the distribution.

Returns:

random number.

nextRayleigh

public double nextRayleigh(double sigma)

Generates a Rayleigh distributed random number.

Parameters:

sigma - scale parameter.

Returns:

random number.

nextRician

public double nextRician(double nu,
                         double sigma)

Generates a Rician distributed random number.

Parameters:

nu - location parameter.

sigma - scale parameter.

Returns:

random number.