Package adams.data.random

Class AbstractDistributionBasedRandomNumberGenerator<T extends Number>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.random.AbstractRandomNumberGenerator<T>

adams.data.random.AbstractSeededRandomNumberGenerator<T>

adams.data.random.AbstractDistributionBasedRandomNumberGenerator<T>

Type Parameters:

T - the type of random number to return

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Randomizable, ShallowCopySupporter<RandomNumberGenerator>, SizeOfHandler, DistributionBasedRandomNumberGenerator<T>, RandomNumberGenerator<T>, SeededRandomNumberGenerator<T>, Serializable

public abstract class AbstractDistributionBasedRandomNumberGenerator<T extends Number>
extends AbstractSeededRandomNumberGenerator<T>
implements DistributionBasedRandomNumberGenerator<T>

Ancestor for distribution-based random number generators.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_Mean	the mean.
protected double	m_Stdev	the standard deviation.

Fields inherited from class adams.data.random.AbstractSeededRandomNumberGenerator

m_Seed

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractDistributionBasedRandomNumberGenerator()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected double	getDefaultMean()	Returns the default mean to use.
protected double	getDefaultStdev()	Returns the default standard deviation to use.
double	getMean()	Returns the mean to use.
double	getStdev()	Returns the stdev to use.
String	meanTipText()	Returns the tip text for this property.
void	setMean(double value)	Sets the mean to use.
void	setStdev(double value)	Sets the stdev to use.
String	stdevTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.random.AbstractSeededRandomNumberGenerator

getSeed, seedTipText, setSeed

Methods inherited from class adams.data.random.AbstractRandomNumberGenerator

check, doNext, forCommandLine, forName, getGenerators, next, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.data.random.RandomNumberGenerator

next, reset

Methods inherited from interface adams.data.random.SeededRandomNumberGenerator

getSeed, seedTipText, setSeed

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Field Detail

m_Mean

protected double m_Mean

the mean.

m_Stdev

protected double m_Stdev

the standard deviation.

Constructor Detail

AbstractDistributionBasedRandomNumberGenerator

public AbstractDistributionBasedRandomNumberGenerator()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractSeededRandomNumberGenerator<T extends Number>

getDefaultMean

protected double getDefaultMean()

Returns the default mean to use.

Returns:

the mean

getDefaultStdev

protected double getDefaultStdev()

Returns the default standard deviation to use.

Returns:

the stdev

setMean

public void setMean(double value)

Sets the mean to use.

Specified by:

setMean in interface DistributionBasedRandomNumberGenerator<T extends Number>

Parameters:

value - the mean

getMean

public double getMean()

Returns the mean to use.

Specified by:

getMean in interface DistributionBasedRandomNumberGenerator<T extends Number>

Returns:

the mean

meanTipText

public String meanTipText()

Returns the tip text for this property.

Specified by:

meanTipText in interface DistributionBasedRandomNumberGenerator<T extends Number>

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setStdev

public void setStdev(double value)

Sets the stdev to use.

Specified by:

setStdev in interface DistributionBasedRandomNumberGenerator<T extends Number>

Parameters:

value - the stdev

getStdev

public double getStdev()

Returns the stdev to use.

Specified by:

getStdev in interface DistributionBasedRandomNumberGenerator<T extends Number>

Returns:

the stdev

stdevTipText

public String stdevTipText()

Returns the tip text for this property.

Specified by:

stdevTipText in interface DistributionBasedRandomNumberGenerator<T extends Number>

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.