Package adams.data.random

Class ChiSquare

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.Randomizable, adams.core.ShallowCopySupporter<adams.data.random.RandomNumberGenerator>, adams.core.SizeOfHandler, adams.data.random.RandomNumberGenerator<Double>, adams.data.random.SeededRandomNumberGenerator<Double>, Serializable
    public class ChiSquare
extends adams.data.random.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$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Random.chi2(int), Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      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_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      ChiSquare()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • 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

      • Methods inherited from interface adams.core.ShallowCopySupporter

        shallowCopy, shallowCopy

    • 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 interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.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 adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.data.random.AbstractSeededRandomNumberGenerator<Double>

      • reset

        public void reset()
        Resets the generator.
        Specified by:
        reset in interface adams.data.random.RandomNumberGenerator<Double>
        Overrides:
        reset in class adams.data.random.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 adams.data.random.AbstractRandomNumberGenerator<Double>

      • doNext

        protected Double doNext()
        Returns the next random number. Does the actual computation.
        Specified by:
        doNext in class adams.data.random.AbstractRandomNumberGenerator<Double>
        Returns:
        the next number