ikr.simlib.random

Class IndependentRNGFactory

java.lang.Object

ikr.simlib.random.IndependentRNGFactory

public class IndependentRNGFactory
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndependentRNGFactory.FactoryNotInitializedException
static class	IndependentRNGFactory.UseIndependentRNGFactoryException
static class	IndependentRNGFactory.WarningRNG Wraps the SystemRNG, prints warnings

Constructor Summary

Constructors

Constructor and Description
IndependentRNGFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static void	disableSystemRNG() Use this method to mark the SystemRNG of the RandomNumberGenerator as invalid.
static RandomNumberGenerator	getNewRNG(java.lang.String seedString) Instantiates a new RandomNumberGenerator.
static void	initialize(int seedIndex, RandomNumberGeneratorFactory rngFactory) Use this method to set the seed index, which should be given on the command line.
static void	wrapSystemRNGWithWarnings() Use this method to mark the SystemRNG of the RandomNumberGenerator as deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndependentRNGFactory

public IndependentRNGFactory()

Method Detail

disableSystemRNG

public static void disableSystemRNG()

Use this method to mark the SystemRNG of the RandomNumberGenerator as invalid. After calling this method, all newly created Distributions throw a runtime exception, when not explicitly configured to use another RNG. This method does not influence the distributions that where instantiated before this method was called. Those will still use the SystemRNG.

wrapSystemRNGWithWarnings

public static void wrapSystemRNGWithWarnings()

Use this method to mark the SystemRNG of the RandomNumberGenerator as deprecated. After calling this method, all usage of the systemRNG results in warnings on stderr. This method does not influence the distributions that where instantiated before this method was called. Those will still use the SystemRNG.

initialize

public static void initialize(int seedIndex,
              RandomNumberGeneratorFactory rngFactory)

Use this method to set the seed index, which should be given on the command line.

Parameters:

seedIndex - seed index - must be >= 0

getNewRNG

public static RandomNumberGenerator getNewRNG(java.lang.String seedString)

Instantiates a new RandomNumberGenerator. Its seed is a combination of the globalSeedIndex and the parameter seedString. Calling this method twice with the same parameter and the same globalSeedIndex configured will return two RNGs which produce the same sequence of pseudo random numbers.

Parameters:

seedString - use this to create a seed depending on the module or class which uses this RNG

Returns:

a new instance of StdRandomNumberGenerator