Package adams.data.random

Class AbstractSeededRandomNumberGenerator<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>

Type Parameters:

T - the type of random number to return

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDistributionBasedRandomNumberGenerator, JavaRandomByte, JavaRandomDouble, JavaRandomInt

public abstract class AbstractSeededRandomNumberGenerator<T extends Number>
extends AbstractRandomNumberGenerator<T>
implements SeededRandomNumberGenerator<T>

Ancestor for seeded 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 long	m_Seed	the seed value.

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
AbstractSeededRandomNumberGenerator()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
long	getSeed()	Returns the seed value.
String	seedTipText()	Returns the tip text for this property.
void	setSeed(long value)	Sets the seed value.

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.core.ShallowCopySupporter

shallowCopy, shallowCopy

Field Detail

m_Seed

protected long m_Seed

the seed value.

Constructor Detail

AbstractSeededRandomNumberGenerator

public AbstractSeededRandomNumberGenerator()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractRandomNumberGenerator<T extends Number>

setSeed

public void setSeed(long value)

Sets the seed value.

Specified by:

setSeed in interface Randomizable

Specified by:

setSeed in interface SeededRandomNumberGenerator<T extends Number>

Parameters:

value - the seed

getSeed

public long getSeed()

Returns the seed value.

Specified by:

getSeed in interface Randomizable

Specified by:

getSeed in interface SeededRandomNumberGenerator<T extends Number>

Returns:

the seed

seedTipText

public String seedTipText()

Returns the tip text for this property.

Specified by:

seedTipText in interface Randomizable

Specified by:

seedTipText in interface SeededRandomNumberGenerator<T extends Number>

Returns:

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