adams.data.random
Class LogNormal

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

All Implemented Interfaces:

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

public class LogNormal
extends AbstractDistributionBasedRandomNumberGenerator<Double>

Generates random numbers from a log normal distribution 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: 0.0
 

-stdev <double> (property: stdev)
    The standard deviation to use for the distribution.
    default: 1.0
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Random.logNormal(double, double), Serialized Form

Field Summary

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_DebugLevel, m_OptionManager

Constructor Summary

LogNormal()

Method Summary

protected void	check() Performs optional checks.
protected Double	doNext() Returns the next random number.
String	globalInfo() Returns a string describing the object.
void	reset() Resets the generator.

Methods inherited from class adams.data.random.AbstractDistributionBasedRandomNumberGenerator

defineOptions, getDefaultMean, 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, 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

Methods inherited from interface adams.core.Randomizable

getSeed, seedTipText, setSeed

Field Detail

m_Random

protected Random m_Random

the actual generator.

Constructor Detail

LogNormal

public LogNormal()

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

reset

public void reset()

Resets the generator.

Overrides:

reset in class AbstractRandomNumberGenerator<Double>

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