org.simbrain.util.randomizer

Class PolarizedRandomizer

java.lang.Object

org.simbrain.util.randomizer.Randomizer

org.simbrain.util.randomizer.PolarizedRandomizer

public class PolarizedRandomizer
extends Randomizer

A tentative solution to some of the issues involving randomizers.... Creaties a randomizer that returns either positive or negative values exclusively depending on its polarity. It is meant to be the case that no parameters should ever be negative since they represent absolute values and the sign of the output is wholly determined by the polarity.

Author:

Zach Tosi

Field Summary

Fields

Modifier and Type	Field and Description
static SimbrainConstants.Polarity	DEFAULT_POLARITY
SimbrainConstants.Polarity	polarity

Fields inherited from class org.simbrain.util.randomizer.Randomizer

clipping, DEFAULT_DISTRIBUTION, lowerBound, param1, param2, pdf, upperBound

Constructor Summary

Constructors

Constructor and Description
PolarizedRandomizer() Default constructor.
PolarizedRandomizer(PolarizedRandomizer dup) Copy constructor.
PolarizedRandomizer(SimbrainConstants.Polarity polarity)
PolarizedRandomizer(SimbrainConstants.Polarity polarity, ProbDistribution pdf)

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkParamsNonNegative() Checks to make sure that there are no negative parameters.
boolean	getClipping()
java.lang.String	getDistributionName() Returns the string name of the distribution.
double	getParam1() See the javadoc at Randomizer.param1.
double	getParam2() See the javadoc at Randomizer.param2.
ProbDistribution	getPdf()
SimbrainConstants.Polarity	getPolarity()
double	getRandom() Returns a random number.
void	setClipping(boolean clipping)
void	setPolarity(SimbrainConstants.Polarity polarity)

Methods inherited from class org.simbrain.util.randomizer.Randomizer

getLowerBound, getUpperBound, setLowerBound, setParam1, setParam1Consistent, setParam2, setParam2Consistent, setParams, setParamsConsistent, setPdf, setUpperBound

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_POLARITY

public static final SimbrainConstants.Polarity DEFAULT_POLARITY

polarity

public SimbrainConstants.Polarity polarity

Constructor Detail

PolarizedRandomizer

public PolarizedRandomizer()

Default constructor.

PolarizedRandomizer

public PolarizedRandomizer(SimbrainConstants.Polarity polarity)

Parameters:

polarity -

PolarizedRandomizer

public PolarizedRandomizer(SimbrainConstants.Polarity polarity,
                           ProbDistribution pdf)

Parameters:

polarity -

pdf -

PolarizedRandomizer

public PolarizedRandomizer(PolarizedRandomizer dup)

Copy constructor.

Parameters:

dup - the RandomSource to duplicate.

Method Detail

checkParamsNonNegative

public java.lang.String checkParamsNonNegative()

Checks to make sure that there are no negative parameters.

Returns:

getRandom

public double getRandom()

Returns a random number.

Overrides:

getRandom in class Randomizer

Returns:

the next random number

getClipping

public boolean getClipping()

Overrides:

getClipping in class Randomizer

Returns:

Returns the clipping.

setClipping

public void setClipping(boolean clipping)

Overrides:

setClipping in class Randomizer

Parameters:

clipping - The useBounds to set.

getDistributionName

public java.lang.String getDistributionName()

Returns the string name of the distribution.

Overrides:

getDistributionName in class Randomizer

Returns:

the distribution name.

getPdf

public ProbDistribution getPdf()

Overrides:

getPdf in class Randomizer

Returns:

the pdf

getParam1

public double getParam1()

Description copied from class: Randomizer

See the javadoc at Randomizer.param1.

Overrides:

getParam1 in class Randomizer

Returns:

the param1

getParam2

public double getParam2()

Description copied from class: Randomizer

See the javadoc at Randomizer.param2.

Overrides:

getParam2 in class Randomizer

Returns:

the param2

getPolarity

public SimbrainConstants.Polarity getPolarity()

Returns:

the polarity

setPolarity

public void setPolarity(SimbrainConstants.Polarity polarity)

Parameters:

polarity - the polarity to set