org.simbrain.util.randomizer

Class Randomizer

java.lang.Object

org.simbrain.util.randomizer.Randomizer

Direct Known Subclasses:

PolarizedRandomizer

public class Randomizer
extends java.lang.Object

Author:

Zach Tosi, Jeff Yoshimi Randomizer produces numbers drawn from a probability distribution according to a set of user-specified parameters.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	clipping Whether the Gaussian distribution should be clipped at upper / lower bound values.
static ProbDistribution	DEFAULT_DISTRIBUTION
protected double	lowerBound Lower bound of the random distribution.
protected double	param1 First parameter of the selected probability distribution.
protected double	param2 First parameter of the selected probability distribution.
protected ProbDistribution	pdf
protected double	upperBound Upper bound of the random distribution.

Constructor Summary

Constructors

Constructor and Description
Randomizer() Default constructor.
Randomizer(ProbDistribution pdf)
Randomizer(Randomizer dup) Copy constructor.

Method Summary

Modifier and Type	Method and Description
boolean	getClipping()
java.lang.String	getDistributionName() Returns the string name of the distribution.
double	getLowerBound()
double	getParam1() See the javadoc at param1.
double	getParam2() See the javadoc at param2.
ProbDistribution	getPdf()
double	getRandom() Returns a random number.
double	getUpperBound()
void	setClipping(boolean clipping)
void	setLowerBound(double lowerBound)
void	setParam1(double param1)
void	setParam1Consistent(java.lang.String p1Name, double param1)
void	setParam2(double param2)
void	setParam2Consistent(java.lang.String p2Name, double param2)
protected void	setParams(double param1, double param2)
void	setParamsConsistent(java.lang.String p1Name, double param1, java.lang.String p2Name, double param2)
void	setPdf(ProbDistribution pdf)
void	setUpperBound(double upperBound)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DISTRIBUTION

public static final ProbDistribution DEFAULT_DISTRIBUTION

pdf

protected ProbDistribution pdf

param1

protected double param1

First parameter of the selected probability distribution. To see what this signifies see ProbDistribution.getParam1Name().

param2

protected double param2

First parameter of the selected probability distribution. To see what this signifies see ProbDistribution.getParam2Name().

upperBound

protected double upperBound

Upper bound of the random distribution.

lowerBound

protected double lowerBound

Lower bound of the random distribution.

clipping

protected boolean clipping

Whether the Gaussian distribution should be clipped at upper / lower bound values.

Constructor Detail

Randomizer

public Randomizer()

Default constructor.

Randomizer

public Randomizer(ProbDistribution pdf)

Randomizer

public Randomizer(Randomizer dup)

Copy constructor.

Parameters:

dup - the RandomSource to duplicate.

Method Detail

getRandom

public double getRandom()

Returns a random number.

Returns:

the next random number

getClipping

public boolean getClipping()

Returns:

Returns the clipping.

setClipping

public void setClipping(boolean clipping)

Parameters:

clipping - The useBounds to set.

getDistributionName

public java.lang.String getDistributionName()

Returns the string name of the distribution.

Returns:

the distribution name.

getPdf

public ProbDistribution getPdf()

Returns:

the pdf

setPdf

public void setPdf(ProbDistribution pdf)

Parameters:

pdf - the pdf to set

getParam1

public double getParam1()

See the javadoc at param1.

Returns:

the param1

getParam2

public double getParam2()

See the javadoc at param2.

Returns:

the param2

setParams

protected void setParams(double param1,
                         double param2)

Parameters:

param1 -

param2 -

setParamsConsistent

public void setParamsConsistent(java.lang.String p1Name,
                                double param1,
                                java.lang.String p2Name,
                                double param2)

setParam1Consistent

public void setParam1Consistent(java.lang.String p1Name,
                                double param1)

setParam2Consistent

public void setParam2Consistent(java.lang.String p2Name,
                                double param2)

getUpperBound

public double getUpperBound()

Returns:

the upperBound

setUpperBound

public void setUpperBound(double upperBound)

Parameters:

upperBound - the upperBound to set

getLowerBound

public double getLowerBound()

Returns:

the lowerBound

setLowerBound

public void setLowerBound(double lowerBound)

Parameters:

lowerBound - the lowerBound to set

setParam1

public void setParam1(double param1)

Parameters:

param1 - the param1 to set

setParam2

public void setParam2(double param2)

Parameters:

param2 - the param2 to set