Package jsl.utilities.random.rvariable

Class LognormalRV

java.lang.Object

jsl.utilities.random.rvariable.AbstractRVariable

jsl.utilities.random.rvariable.LognormalRV

All Implemented Interfaces:

java.util.function.DoubleSupplier, GetNameIfc, GetValueIfc, IdentityIfc, PreviousValueIfc, RandomIfc, GetRandomNumberStreamIfc, RNStreamControlIfc, SetRandomNumberStreamIfc, NewAntitheticInstanceIfc, RVariableIfc, SampleIfc

public final class LognormalRV
extends AbstractRVariable

Lognormal(mean, variance). The mean and variance are for the lognormal random variables

Nested Class Summary

Nested classes/interfaces inherited from interface jsl.utilities.random.rvariable.RVariableIfc

RVariableIfc.RVType

Field Summary

Fields inherited from class jsl.utilities.random.rvariable.AbstractRVariable

myRNStream

Constructor Summary

Constructors

Constructor	Description
LognormalRV(double mean, double variance)
LognormalRV(double mean, double variance, int streamNum)
LognormalRV(double mean, double variance, RNStreamIfc rng)

Method Summary

Modifier and Type	Method	Description
protected double	generate()
double	getMean()
double	getVariance()
static RVControls	makeControls()	The keys are "mean" with default value 1.0 and "variance" with default value 1.0
LognormalRV	newInstance(RNStreamIfc rng)
java.lang.String	toString()

Methods inherited from class jsl.utilities.random.rvariable.AbstractRVariable

advanceToNextSubstream, getAntitheticOption, getId, getName, getPreviousValue, getRandomNumberStream, getValue, newAntitheticInstance, newInstance, resetStartStream, resetStartSubstream, sample, setAntitheticOption, setName, setPreviousValue, setRandomNumberStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jsl.utilities.random.rng.GetRandomNumberStreamIfc

getStreamNumber

Methods inherited from interface jsl.utilities.random.rvariable.RVariableIfc

asDoubleStream, getAsDouble, getSumOfValues, newInstance

Methods inherited from interface jsl.utilities.random.SampleIfc

sample, sample

Methods inherited from interface jsl.utilities.random.rng.SetRandomNumberStreamIfc

setRandomNumberStream

Constructor Detail

LognormalRV

public LognormalRV(double mean,
                   double variance)

LognormalRV

public LognormalRV(double mean,
                   double variance,
                   int streamNum)

LognormalRV

public LognormalRV(double mean,
                   double variance,
                   RNStreamIfc rng)

Method Detail

newInstance

public LognormalRV newInstance(RNStreamIfc rng)

Parameters:

rng - the RngIfc to use

Returns:

a new instance with same parameter value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMean

public double getMean()

Returns:

mean of the random variable

getVariance

public double getVariance()

Returns:

variance of the random variable

generate

protected double generate()

Specified by:

generate in class AbstractRVariable

Returns:

the randomly generated variate

makeControls

public static RVControls makeControls()

The keys are "mean" with default value 1.0 and "variance" with default value 1.0

Returns:

a control for Lognormal random variables