Class Exponential

  • 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.core.SizeOfHandler,<Double>,<Double>, Serializable

    public class Exponential
    Generates random numbers from an Exponential random variable (Mean = 1/lambda, variance = 1/lambda^2).

    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
    -lambda <double> (property: lambda)
        The lambda parameter for the exponential random variable.
        default: 1.0
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Random.exponential(double), Serialized Form
    • Field Summary

      Modifier and Type Field Description
      protected double m_Lambda
      the lambda parameter.
      protected Random m_Random
      the random number generator to use.
      • Fields inherited from class

      • Fields inherited from class adams.core.option.AbstractOptionHandler

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel
    • Constructor Summary

      Constructor Description
    • 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.
      protected Double doNext()
      Returns the next random number.
      double getLambda()
      Returns the first parameter for the beta random variable.
      String globalInfo()
      Returns a string describing the object.
      String lambdaTipText()
      Returns the tip text for this property.
      void reset()
      Resets the generator.
      void setLambda​(double value)
      Sets the first parameter for the beta random variable.
      • Methods inherited from class

        getSeed, seedTipText, setSeed
      • Methods inherited from class

        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

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine
      • Methods inherited from interface

      • Methods inherited from interface adams.core.ShallowCopySupporter

        shallowCopy, shallowCopy
    • Field Detail

      • m_Lambda

        protected double m_Lambda
        the lambda parameter.
      • m_Random

        protected Random m_Random
        the random number generator to use.
    • Constructor Detail

      • Exponential

        public Exponential()
    • 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
        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
        defineOptions in class<Double>
      • reset

        public void reset()
        Resets the generator.
        Specified by:
        reset in interface<Double>
        reset in class<Double>
      • setLambda

        public void setLambda​(double value)
        Sets the first parameter for the beta random variable.
        value - the first parameter
      • getLambda

        public double getLambda()
        Returns the first parameter for the beta random variable.
        the first parameter
      • lambdaTipText

        public String lambdaTipText()
        Returns the tip text for this property.
        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.
        check in class<Double>
      • doNext

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