adams.data.random
Class Uniform

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.random.AbstractRandomNumberGenerator<T>
              adams.data.random.AbstractSeededRandomNumberGenerator<Double>
                  adams.data.random.Uniform

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, Randomizable, ShallowCopySupporter<AbstractRandomNumberGenerator>, SizeOfHandler, Serializable

public class Uniform
extends AbstractSeededRandomNumberGenerator<Double>

Generates random numbers from a uniform random variable.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-seed <long> (property: seed)
    The seed value for the random number generator.
    default: 1
 

-min-value <double> (property: minValue)
    The smallest number that could be generated.
    default: 0.0
 

-max-value <double> (property: maxValue)
    The largest number that could be generated.
    default: 1.0
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Random.uniform(double, double), Serialized Form

Field Summary

protected double	m_MaxValue the maximum value for the numbers to generate.
protected double	m_MinValue the minimum value for the numbers to generate.
protected Random	m_Random the random number generator to use.

Fields inherited from class adams.data.random.AbstractSeededRandomNumberGenerator

m_Seed

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Uniform()

Method Summary

protected void	check() Performs optional checks.
void	defineOptions() Adds options to the internal list of options.
protected Double	doNext() Returns the next random number.
double	getMaxValue() Returns the maximum value of the numbers to generate.
double	getMinValue() Returns the minimum value of the numbers to generate.
String	globalInfo() Returns a string describing the object.
String	maxValueTipText() Returns the tip text for this property.
String	minValueTipText() Returns the tip text for this property.
void	reset() Resets the generator.
void	setMaxValue(double value) Sets the maximum value of the numbers to generate.
void	setMinValue(double value) Sets the minimum value of the numbers to generate.

Methods inherited from class adams.data.random.AbstractSeededRandomNumberGenerator

getSeed, seedTipText, setSeed

Methods inherited from class adams.data.random.AbstractRandomNumberGenerator

forCommandLine, forName, getGenerators, next, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

m_MinValue

protected double m_MinValue

the minimum value for the numbers to generate.

m_MaxValue

protected double m_MaxValue

the maximum value for the numbers to generate.

m_Random

protected Random m_Random

the random number generator to use.

Constructor Detail

Uniform

public Uniform()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractSeededRandomNumberGenerator<Double>

reset

public void reset()

Resets the generator.

Overrides:

reset in class AbstractRandomNumberGenerator<Double>

setMinValue

public void setMinValue(double value)

Sets the minimum value of the numbers to generate.

Parameters:

value - the minimum

getMinValue

public double getMinValue()

Returns the minimum value of the numbers to generate.

Returns:

the minimum

minValueTipText

public String minValueTipText()

Returns the tip text for this property.

Returns:

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

setMaxValue

public void setMaxValue(double value)

Sets the maximum value of the numbers to generate.

Parameters:

value - the maximum

getMaxValue

public double getMaxValue()

Returns the maximum value of the numbers to generate.

Returns:

the maximum

maxValueTipText

public String maxValueTipText()

Returns the tip text for this property.

Returns:

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

check

protected void check()

Performs optional checks.

Initializes the random number generator.

Overrides:

check in class AbstractRandomNumberGenerator<Double>

doNext

protected Double doNext()

Returns the next random number. Does the actual computation.

Specified by:

doNext in class AbstractRandomNumberGenerator<Double>

Returns:

the next number