KSLCore/ksl.utilities.random.robj/DEmpiricalList

DEmpiricalList

class DEmpiricalList<T>(elements: List<T>, theCDF: DoubleArray, streamNum: Int = 0, streamProvider: RNStreamProviderIfc = KSLRandom.DefaultRNStreamProvider) : RElementIfc<T> , RElementInstanceIfc<T>

Randomly selects the elements in the list according to a supplied CDF across the items

Parameters

the type of elements in the list

elements

the list of elements must not be null

theCDF

an array holding the cumulative probabilities across the elements in the list

streamNum

the random number stream number, defaults to 0, which means the next stream

streamProvider

the provider of random number streams, defaults to KSLRandom.DefaultRNStreamProvider

Constructors

DEmpiricalList

constructor(elements: List<T>, theCDF: DoubleArray, streamNum: Int = 0, streamProvider: RNStreamProviderIfc = KSLRandom.DefaultRNStreamProvider)

Properties

advanceToNextSubStreamOption

open override var advanceToNextSubStreamOption: Boolean

If true, the stream will automatically participate in having its stream advanced to the next sub-stream via stream managers

antithetic

open override var antithetic: Boolean

Tells the stream to start producing antithetic variates

cdf

val cdf: DoubleArray

elements

val elements: List<T>

randomElement

open override val randomElement: T

Returns an element randomly selected from the list

resetStartStreamOption

open override var resetStartStreamOption: Boolean

If true, the stream will automatically participate in having its stream reset to its start stream via stream managers

streamNumber

open override val streamNumber: Int

Functions

advanceToNextSubStream

open override fun advanceToNextSubStream()

Positions the RNG at the beginning of its next substream

instance

open override fun instance(streamNum: Int, rnStreamProvider: RNStreamProviderIfc): DEmpiricalList<T>

resetStartStream

open override fun resetStartStream()

The resetStartStream method will position the RNG at the beginning of its stream. This is the same location in the stream as assigned when the RNG was created and initialized.

resetStartSubStream

open override fun resetStartSubStream()

Resets the position of the RNG at the start of the current substream

sample

open fun sample(): T

Returns an element randomly selected from the list

open fun sample(size: Int): List<T>

Returns sample of size from the list