Package adams.data.random

Class Weibull

  • 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.DistributionBasedRandomNumberGenerator<Double>, adams.data.random.RandomNumberGenerator<Double>, adams.data.random.SeededRandomNumberGenerator<Double>, Serializable
    public class Weibull
extends adams.data.random.AbstractDistributionBasedRandomNumberGenerator<Double>
    Generates random numbers from a Weibull random variable with specified mean and standard deviation.

    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
 
    -mean <double> (property: mean)
    The mean to use for the distribution.
    default: 1.0
 
    -stdev <double> (property: stdev)
    The standard deviation to use for the distribution.
    default: 1.0
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Random.weibull(double, double), Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected Random m_Random
      the actual generator.

      • Fields inherited from class adams.data.random.AbstractDistributionBasedRandomNumberGenerator

        m_Mean, m_Stdev

      • 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
      Weibull()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void check()
      Performs optional checks.
      protected Double doNext()
      Returns the next random number.
      protected double getDefaultMean()
      Returns the default mean to use.
      String globalInfo()
      Returns a string describing the object.
      void reset()
      Resets the generator.

      • Methods inherited from class adams.data.random.AbstractDistributionBasedRandomNumberGenerator

        defineOptions, getDefaultStdev, getMean, getStdev, meanTipText, setMean, setStdev, stdevTipText

      • 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.data.random.SeededRandomNumberGenerator

        getSeed, seedTipText, setSeed

      • Methods inherited from interface adams.core.ShallowCopySupporter

        shallowCopy, shallowCopy

    • Field Detail

      • m_Random

        protected Random m_Random
        the actual generator.

    • Constructor Detail

      • Weibull

        public Weibull()

    • 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

      • 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>

      • getDefaultMean

        protected double getDefaultMean()
        Returns the default mean to use.
        Overrides:
        getDefaultMean in class adams.data.random.AbstractDistributionBasedRandomNumberGenerator<Double>
        Returns:
        the mean

      • 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