burlap.debugtools

Class RandomFactory

java.lang.Object

burlap.debugtools.RandomFactory

public class RandomFactory
extends java.lang.Object

Random factory that allows you to logically group various random generators. This is useful for if you have many classes that use stochastic processes but you want to have a fixed sequence across process execution for debug purposes. To synchronize, just seed either a mapped random generator or the default in the main method and use the get method to retrieve the random object for all other classes. To break the fixed sequence, just construct it without a seed

Author:

James MacGlashan

Constructor Summary

Constructors

Constructor and Description
RandomFactory() Initializes the map structures

Method Summary

Modifier and Type	Method and Description
static java.util.Random	getDefault() Returns the default random number generator.
static java.util.Random	getMapped(int id) Returns the random generator with the associated id or creates it if it does not yet exist
static java.util.Random	getMapped(java.lang.String id) Returns the random generator with the associated String id or creates it if it does not yet exist
static java.util.Random	getOrSeedDefault(long seed) Either return a the default random generator if it has already been created; or created it with the given seed if it has not been created.
static java.util.Random	getOrSeedMapped(int id, long seed) Either returns the random generator for the given id or creates if with the given seed it does not yet exit
static java.util.Random	getOrSeedMapped(java.lang.String id, long seed) Either returns the random generator for the given String id or creates if with the given seed it does not yet exit
java.util.Random	ingetDefault() Returns the default random number generator.
java.util.Random	ingetMapped(int id) Returns the random generator with the associated id or creates it if it does not yet exist
java.util.Random	ingetMapped(java.lang.String id) Returns the random generator with the associated String id or creates it if it does not yet exist
java.util.Random	ingetOrSeedDefault(long seed) Either return a the default random generator if it has already been created; or created it with the given seed if it has not been created.
java.util.Random	ingetOrSeedMapped(int id, long seed) Either returns the random generator for the given id or creates if with the given seed it does not yet exit
java.util.Random	ingetOrSeedMapped(java.lang.String id, long seed) Either returns the random generator for the given String id or creates if with the given seed it does not yet exit
java.util.Random	inseedDefault(long seed) Sets the seed of the default random number generator
java.util.Random	inseedMapped(int id, long seed) Seeds and returns the random generator with the associated id or creates it if it does not yet exist
java.util.Random	inseedMapped(java.lang.String id, long seed) Seeds and returns the random generator with the associated String id or creates it if it does not yet exist
static void	main(java.lang.String[] args) Example usage.
static java.util.Random	seedDefault(long seed) Sets the seed of the default random number generator
static java.util.Random	seedMapped(int id, long seed) Seeds and returns the random generator with the associated id or creates it if it does not yet exist
static java.util.Random	seedMapped(java.lang.String id, long seed) Seeds and returns the random generator with the associated String id or creates it if it does not yet exist

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomFactory

public RandomFactory()

Initializes the map structures

Method Detail

main

public static void main(java.lang.String[] args)

Example usage.

Parameters:

args - command line args

getDefault

public static java.util.Random getDefault()

Returns the default random number generator.

Returns:

the default random number generator.

seedDefault

public static java.util.Random seedDefault(long seed)

Sets the seed of the default random number generator

Parameters:

seed - the seed to use

Returns:

the default random number generator

getOrSeedDefault

public static java.util.Random getOrSeedDefault(long seed)

Either return a the default random generator if it has already been created; or created it with the given seed if it has not been created.

Parameters:

seed - the seed to use

Returns:

the default random generator

getMapped

public static java.util.Random getMapped(int id)

Returns the random generator with the associated id or creates it if it does not yet exist

Parameters:

id - the id of the random generator

Returns:

the random generator

seedMapped

public static java.util.Random seedMapped(int id,
                                          long seed)

Seeds and returns the random generator with the associated id or creates it if it does not yet exist

Parameters:

id - the id of the random generator

seed - the seed to use

Returns:

the random generator

getOrSeedMapped

public static java.util.Random getOrSeedMapped(int id,
                                               long seed)

Either returns the random generator for the given id or creates if with the given seed it does not yet exit

Parameters:

id - the id of the random generator

seed - the seed to use

Returns:

the random generator

getMapped

public static java.util.Random getMapped(java.lang.String id)

Returns the random generator with the associated String id or creates it if it does not yet exist

Parameters:

id - the id of the random generator

Returns:

the random generator

seedMapped

public static java.util.Random seedMapped(java.lang.String id,
                                          long seed)

Seeds and returns the random generator with the associated String id or creates it if it does not yet exist

Parameters:

id - the id of the random generator

seed - the seed to use

Returns:

the random generator

getOrSeedMapped

public static java.util.Random getOrSeedMapped(java.lang.String id,
                                               long seed)

Either returns the random generator for the given String id or creates if with the given seed it does not yet exit

Parameters:

id - the id of the random generator

seed - the seed to use

Returns:

the random generator

ingetDefault

public java.util.Random ingetDefault()

Returns the default random number generator.

Returns:

the default random number generator.

inseedDefault

public java.util.Random inseedDefault(long seed)

Sets the seed of the default random number generator

Parameters:

seed - the seed to use

Returns:

the default random number generator

ingetOrSeedDefault

public java.util.Random ingetOrSeedDefault(long seed)

Either return a the default random generator if it has already been created; or created it with the given seed if it has not been created.

Parameters:

seed - the seed to use

Returns:

the default random generator

ingetMapped

public java.util.Random ingetMapped(int id)

Returns the random generator with the associated id or creates it if it does not yet exist

Parameters:

id - the id of the random generator

Returns:

the random generator

inseedMapped

public java.util.Random inseedMapped(int id,
                                     long seed)

Seeds and returns the random generator with the associated id or creates it if it does not yet exist

Parameters:

id - the id of the random generator

seed - the seed to use

Returns:

the random generator

ingetOrSeedMapped

public java.util.Random ingetOrSeedMapped(int id,
                                          long seed)

Either returns the random generator for the given id or creates if with the given seed it does not yet exit

Parameters:

id - the id of the random generator

seed - the seed to use

Returns:

the random generator

ingetMapped

public java.util.Random ingetMapped(java.lang.String id)

Returns the random generator with the associated String id or creates it if it does not yet exist

Parameters:

id - the id of the random generator

Returns:

the random generator

inseedMapped

public java.util.Random inseedMapped(java.lang.String id,
                                     long seed)

Seeds and returns the random generator with the associated String id or creates it if it does not yet exist

Parameters:

id - the id of the random generator

seed - the seed to use

Returns:

the random generator

ingetOrSeedMapped

public java.util.Random ingetOrSeedMapped(java.lang.String id,
                                          long seed)

Either returns the random generator for the given String id or creates if with the given seed it does not yet exit

Parameters:

id - the id of the random generator

seed - the seed to use

Returns:

the random generator