adams.data.random
Class ChiSquare

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

All Implemented Interfaces:

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

public class ChiSquare
extends AbstractSeededRandomNumberGenerator<Double>

Random generator that generates random doubles (0-1) using Java's java.util.Random class.

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
 

-df <int> (property: degreesFreedom)
    The degrees of freedom to use.
    default: 2
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Random.chi2(int), Serialized Form

Field Summary

protected int	m_DegreesFreedom the degrees of freedom to use.
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

ChiSquare()

Method Summary

protected void	check() Performs optional checks.
void	defineOptions() Adds options to the internal list of options.
String	degreesFreedomTipText() Returns the tip text for this property.
protected Double	doNext() Returns the next random number.
int	getDegreesFreedom() Returns the degrees of freedom to use.
String	globalInfo() Returns a string describing the object.
void	reset() Resets the generator.
void	setDegreesFreedom(int value) Sets the degrees of freedom to use.

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_DegreesFreedom

protected int m_DegreesFreedom

the degrees of freedom to use.

m_Random

protected Random m_Random

the random number generator to use.

Constructor Detail

ChiSquare

public ChiSquare()

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>

setDegreesFreedom

public void setDegreesFreedom(int value)

Sets the degrees of freedom to use.

Parameters:

value - the df

getDegreesFreedom

public int getDegreesFreedom()

Returns the degrees of freedom to use.

Returns:

the df

degreesFreedomTipText

public String degreesFreedomTipText()

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