simudyne.core.rng

Class SeededRandom

java.lang.Object

simudyne.core.rng.SeededRandom

All Implemented Interfaces:

java.io.Serializable

public class SeededRandom
extends java.lang.Object
implements java.io.Serializable

Provides a wrapper around Apache Commons Math3 PRNG functions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
org.apache.commons.math3.random.RandomGenerator	generator

Constructor Summary

Constructors

Constructor and Description
SeededRandom(org.apache.commons.math3.random.RandomGenerator generator)

Method Summary

Modifier and Type	Method and Description
org.apache.commons.math3.distribution.BetaDistribution	beta(double alpha, double beta) Returns a generator for the Beta distribution with given parameters.
org.apache.commons.math3.distribution.BinomialDistribution	binomial(int n, double p) Returns a generator for the Binomial distribution with given parameters.
org.apache.commons.math3.distribution.CauchyDistribution	cauchy(double median, double scale) Returns a generator for the Cauchy distribution with given parameters.
org.apache.commons.math3.distribution.ChiSquaredDistribution	chiSquared(double degreesOfFreedom) Returns a generator for the Chi Squared distribution with given degrees of freedom.
static SeededRandom	create() Deprecated. use create(long seed) if wanting to directly create with seed (unadvised without due cause)
static SeededRandom	create(long seed)
static org.apache.commons.math3.random.RandomGenerator	createGenerator(long seed)
org.apache.commons.math3.distribution.UniformIntegerDistribution	discrete(int lower, int upper) Returns a generator of integer values in the range lower <= n <= upper
org.apache.commons.math3.random.EmpiricalDistribution	empiricalFromSource(Source dataSource) Returns a smoothed distribution based on source
org.apache.commons.math3.distribution.EnumeratedIntegerDistribution	enumeratedInteger(int[] ints, double[] ps) Returns a generator for the Enumerated Integer distribution, with given parameters.
org.apache.commons.math3.distribution.EnumeratedRealDistribution	enumeratedReal(double[] doubles, double[] ps) Returns a generator for the Enumerated Real distribution, with given parameters.
org.apache.commons.math3.distribution.ExponentialDistribution	exponential(double mean) Returns a generator for the Exponential distribution with given mean.
org.apache.commons.math3.distribution.FDistribution	f(double numeratorDegreesOfFreedom, double denominatorDegreesOfFreedom) Returns a generator for the F Distribution with given degrees of freedom.
org.apache.commons.math3.distribution.GammaDistribution	gamma(double shape, double scale) Returns a generator for the Gamma distribution with given parameters.
org.apache.commons.math3.distribution.NormalDistribution	gaussian(double mean, double standardDeviation) Returns a generator for the Gaussian (or Normal) distribution with given parameters.
org.apache.commons.math3.distribution.GeometricDistribution	geometric(double p) Returns a generator for the Geometric distribution with given parameter.
boolean	getNextBoolean()
boolean	getNextBoolean(double probability)
double	getNextDouble()
double	getNextDouble(double n)
float	getNextFloat()
float	getNextFloat(float n)
int	getNextInt()
int	getNextInt(int n)
java.util.Random	getRandom()
long	getSeed() Note: If you setSeed to the generator directly - you will override the value actually used in your random generation however when you get the value here it will be different.
org.apache.commons.math3.distribution.HypergeometricDistribution	hypergeometric(int populationSize, int numberOfSuccesses, int sampleSize) Returns a generator for the Hypergeometric Distribution, with given parameters.
org.apache.commons.math3.distribution.LevyDistribution	levy(double mu, double c) Returns a generator for the Levy Distribution, with given parameters.
org.apache.commons.math3.distribution.LogNormalDistribution	logNormal(double scale, double shape) Returns a generator for the Log Normal distribution with given parameters.
org.apache.commons.math3.distribution.MixtureMultivariateNormalDistribution	mixtureMultivariateNormal(double[] weights, double[][] means, double[][][] covariances) Returns a generator for the Mixture Multivariate Normal Distribution.
org.apache.commons.math3.distribution.MultivariateNormalDistribution	multivariateNormal(double[] means, double[][] covariances) Returns a generator for the Multivariate Normal Distribution
org.apache.commons.math3.distribution.NormalDistribution	normal(double mean, double standardDeviation)
org.apache.commons.math3.distribution.ParetoDistribution	pareto(double scale, double shape) Returns a generator for the Pareto distribution with given parameters.
org.apache.commons.math3.distribution.PascalDistribution	pascal(int r, double p) Returns a generator for the Pascal Distribution
org.apache.commons.math3.distribution.PoissonDistribution	poisson(double mean) Returns a generator for the Poisson distribution with given mean.
void	setSeed(long newSeed) Updates the random number generator with a new seed value.
org.apache.commons.math3.distribution.TDistribution	t(double degreesOfFreedom) Returns a generator for the Student's T Distribution, with given degrees of freedom.
org.apache.commons.math3.distribution.TriangularDistribution	triangular(double a, double c, double b) Returns a generator for the Triangular distribution, with given parameters.
org.apache.commons.math3.distribution.UniformRealDistribution	uniform(double lower, double upper) Returns a generator of floating point values in the range lower <= n < upper
org.apache.commons.math3.distribution.WeibullDistribution	weibull(double alpha, double beta) Returns a generator for the Weibull distribution, with given parameters.
org.apache.commons.math3.distribution.ZipfDistribution	zipf(int numberOfElements, double exponent) Returns a generator for the Zipf Distribution

Methods inherited from class java.lang.Object

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

Field Detail

generator

public final org.apache.commons.math3.random.RandomGenerator generator

Constructor Detail

SeededRandom

public SeededRandom(org.apache.commons.math3.random.RandomGenerator generator)

Method Detail

createGenerator

public static org.apache.commons.math3.random.RandomGenerator createGenerator(long seed)

create

@Deprecated
public static SeededRandom create()

Deprecated. use create(long seed) if wanting to directly create with seed (unadvised without due cause)

Creating a SeededRandom without an explicit seed does not aid model reproducibility. In order to use your models SeedRandom call one of the following.

ModelContextAccessor.map(model).getPrng if not within model. AgentBasedModel.getcontext.getPrng if already within a model.

create

public static SeededRandom create(long seed)

getRandom

public java.util.Random getRandom()

getNextBoolean

public boolean getNextBoolean()

getNextBoolean

public boolean getNextBoolean(double probability)

getNextInt

public int getNextInt()

getNextInt

public int getNextInt(int n)

getNextDouble

public double getNextDouble()

getNextDouble

public double getNextDouble(double n)

getNextFloat

public float getNextFloat()

getNextFloat

public float getNextFloat(float n)

getSeed

public long getSeed()

Note: If you setSeed to the generator directly - you will override the value actually used in your random generation however when you get the value here it will be different. Please use #SeededRandom.setSeed() instead

Returns:

seed value either from the create, 'simudyne.core.prng-seed', or via #SeededRandom.setSeed()

setSeed

public void setSeed(long newSeed)

Updates the random number generator with a new seed value.

Parameters:

newSeed -

beta

public org.apache.commons.math3.distribution.BetaDistribution beta(double alpha,
                                                                   double beta)

Returns a generator for the Beta distribution with given parameters.

https://en.wikipedia.org/wiki/Beta_distribution

Parameters:

alpha -

beta -

Returns:

BetaDistribution

binomial

public org.apache.commons.math3.distribution.BinomialDistribution binomial(int n,
                                                                           double p)

Returns a generator for the Binomial distribution with given parameters.

Parameters:

n - Number of trials

p - Probability of success

Returns:

BinomialDistribution

cauchy

public org.apache.commons.math3.distribution.CauchyDistribution cauchy(double median,
                                                                       double scale)

Returns a generator for the Cauchy distribution with given parameters.

Parameters:

median -

scale -

Returns:

CauchyDistribution

chiSquared

public org.apache.commons.math3.distribution.ChiSquaredDistribution chiSquared(double degreesOfFreedom)

Returns a generator for the Chi Squared distribution with given degrees of freedom.

Parameters:

degreesOfFreedom -

Returns:

ChiSquaresDistribution

discrete

public org.apache.commons.math3.distribution.UniformIntegerDistribution discrete(int lower,
                                                                                 int upper)

Returns a generator of integer values in the range lower <= n <= upper

Parameters:

lower -

upper -

Returns:

UniformIntegerDistribution

enumeratedInteger

public org.apache.commons.math3.distribution.EnumeratedIntegerDistribution enumeratedInteger(int[] ints,
                                                                                             double[] ps)

Returns a generator for the Enumerated Integer distribution, with given parameters.

Parameters:

ints - Random variable values

ps - Random variable probabilities

Returns:

EnumeratedIntegerDistribution

enumeratedReal

public org.apache.commons.math3.distribution.EnumeratedRealDistribution enumeratedReal(double[] doubles,
                                                                                       double[] ps)

Returns a generator for the Enumerated Real distribution, with given parameters.

Parameters:

doubles - Random variable values

ps - Random variable probabilities

Returns:

EnumeratedRealDistribution

exponential

public org.apache.commons.math3.distribution.ExponentialDistribution exponential(double mean)

Returns a generator for the Exponential distribution with given mean.

Parameters:

mean -

Returns:

ExponentialDistribution

f

public org.apache.commons.math3.distribution.FDistribution f(double numeratorDegreesOfFreedom,
                                                             double denominatorDegreesOfFreedom)

Returns a generator for the F Distribution with given degrees of freedom.

Parameters:

numeratorDegreesOfFreedom -

denominatorDegreesOfFreedom -

Returns:

FDistribution

gamma

public org.apache.commons.math3.distribution.GammaDistribution gamma(double shape,
                                                                     double scale)

Returns a generator for the Gamma distribution with given parameters.

Parameters:

shape -

scale -

Returns:

GammaDistribution

geometric

public org.apache.commons.math3.distribution.GeometricDistribution geometric(double p)

Returns a generator for the Geometric distribution with given parameter.

Parameters:

p -

Returns:

GeometricDistribution

gaussian

public org.apache.commons.math3.distribution.NormalDistribution gaussian(double mean,
                                                                         double standardDeviation)

Returns a generator for the Gaussian (or Normal) distribution with given parameters.

Parameters:

mean -

standardDeviation -

Returns:

NormalDistribution

normal

public org.apache.commons.math3.distribution.NormalDistribution normal(double mean,
                                                                       double standardDeviation)

hypergeometric

public org.apache.commons.math3.distribution.HypergeometricDistribution hypergeometric(int populationSize,
                                                                                       int numberOfSuccesses,
                                                                                       int sampleSize)

Returns a generator for the Hypergeometric Distribution, with given parameters.

Parameters:

populationSize -

numberOfSuccesses -

sampleSize -

Returns:

HypergeometricDistribution

levy

public org.apache.commons.math3.distribution.LevyDistribution levy(double mu,
                                                                   double c)

Returns a generator for the Levy Distribution, with given parameters.

Parameters:

mu -

c -

Returns:

LevyDistribution

logNormal

public org.apache.commons.math3.distribution.LogNormalDistribution logNormal(double scale,
                                                                             double shape)

Returns a generator for the Log Normal distribution with given parameters.

Parameters:

scale -

shape -

Returns:

LogNormalDistribution

mixtureMultivariateNormal

public org.apache.commons.math3.distribution.MixtureMultivariateNormalDistribution mixtureMultivariateNormal(double[] weights,
                                                                                                             double[][] means,
                                                                                                             double[][][] covariances)

Returns a generator for the Mixture Multivariate Normal Distribution.

Parameters:

weights -

means -

covariances -

Returns:

MixtureMultivariateNormalDistribution

multivariateNormal

public org.apache.commons.math3.distribution.MultivariateNormalDistribution multivariateNormal(double[] means,
                                                                                               double[][] covariances)

Returns a generator for the Multivariate Normal Distribution

Parameters:

means -

covariances -

Returns:

MultivariateNormalDistribution

pascal

public org.apache.commons.math3.distribution.PascalDistribution pascal(int r,
                                                                       double p)

Returns a generator for the Pascal Distribution

Parameters:

r -

p -

Returns:

PascalDistribution

pareto

public org.apache.commons.math3.distribution.ParetoDistribution pareto(double scale,
                                                                       double shape)

Returns a generator for the Pareto distribution with given parameters.

Parameters:

scale -

shape -

Returns:

ParetoDistribution

poisson

public org.apache.commons.math3.distribution.PoissonDistribution poisson(double mean)

Returns a generator for the Poisson distribution with given mean.

Parameters:

mean -

Returns:

PoissonDistribution

t

public org.apache.commons.math3.distribution.TDistribution t(double degreesOfFreedom)

Returns a generator for the Student's T Distribution, with given degrees of freedom.

Parameters:

degreesOfFreedom -

Returns:

TDistribution

triangular

public org.apache.commons.math3.distribution.TriangularDistribution triangular(double a,
                                                                               double c,
                                                                               double b)

Returns a generator for the Triangular distribution, with given parameters.

Parameters:

a - Minimum value

c - Peak value

b - Maximum value

Returns:

TriangularDistribution

uniform

public org.apache.commons.math3.distribution.UniformRealDistribution uniform(double lower,
                                                                             double upper)

Returns a generator of floating point values in the range lower <= n < upper

Parameters:

lower -

upper -

Returns:

UniformRealDistribution

weibull

public org.apache.commons.math3.distribution.WeibullDistribution weibull(double alpha,
                                                                         double beta)

Returns a generator for the Weibull distribution, with given parameters.

Parameters:

alpha -

beta -

Returns:

WeibullDistribution

zipf

public org.apache.commons.math3.distribution.ZipfDistribution zipf(int numberOfElements,
                                                                   double exponent)

Returns a generator for the Zipf Distribution

Parameters:

numberOfElements -

exponent -

Returns:

ZipfDistribution

empiricalFromSource

public org.apache.commons.math3.random.EmpiricalDistribution empiricalFromSource(Source dataSource)

Returns a smoothed distribution based on source

Parameters:

dataSource - Histogram representing a distribution

Returns:

EmpiricalDistribution